![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to index.sgml CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc|
Return to index.sgml CVS log | Up to [cvsweb.bsd.lv] / mandoc |
1.1 kristaps 1: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
2: <html>
3: <head>
4: <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
5: <meta name="resource-type" content="document">
6: <link rel="stylesheet" href="style.css" type="text/css" media="all">
7: <title>mdocml.bsd.lv</title>
8: </head>
9: <body>
10: <table width="600">
11: <col width="100%">
12: <tbody>
13: <tr>
14: <td>
15: <div class="head">
16: <b>mdocml</b> – mdoc macro compiler
17: </div>
18: </td>
19: </tr>
20: <tr>
21: <td valign="top">
22: <h1>
23: DESCRIPTION
24: </h1>
25:
26: <p>
1.16 kristaps 27: <span class="nm">mdocml</span> is a suite of tools compiling “-mdoc”, the roff macro package
28: of choice for BSD manual pages, and “-man”, the predominant historical package for UNIX
29: manuals. The mission of <span class="nm">mdocml</span> is to deprecate <a
30: href="http://www.gnu.org/software/groff/" class="external">groff</a>, the GNU roff implementation, for
1.18 kristaps 31: displaying -mdoc pages whilst providing token support for -man.
1.9 kristaps 32: </p>
33:
34: <p>
1.13 kristaps 35: Why? groff amounts to over 5 MB of source code, most of which is C++ and all of which is GPL. It runs
36: slowly, produces uncertain output, and varies in operation from system to system. mdocml strives to fix
37: this (respectively small, C, ISC-licensed, fast and regular).
1.1 kristaps 38: </p>
39:
40: <p>
1.19 kristaps 41: The core of <span class="nm">mdocml</span> is composed of the <i>libmdoc</i> and <i>libman</i>
42: validating compiler libraries. Both are simple, fast libraries operating on memory buffers, so they may
43: be used for a variety of front-ends (terminal-based, CGI and so on). The primary front-end is <i>
44: mandoc</i>, which formats manuals for display on the terminal.
1.1 kristaps 45: </p>
46: </td>
47: </tr>
48: <tr>
49: <td>
50: <h1>
51: INSTALLING SOURCES
52: </h1>
53:
1.2 kristaps 54: <p>
1.13 kristaps 55: Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested
1.18 kristaps 56: variously on i386, AMD64, alpha and others. The most current version is <span
57: class="attn">@VERSION@</span>, dated <span class="attn">@VDATE@</span>.
1.7 kristaps 58: </p>
59:
1.1 kristaps 60: <h2>
1.9 kristaps 61: Snapshot source
1.1 kristaps 62: </h2>
63:
64: <p>
1.18 kristaps 65: CVS sources are checkedout and snapshotted with version updates. These (and all historical snapshots)
66: may be found in the <a href="/snapshots/">/snapshots/</a> directory. A full <a
67: href="/snapshots/ChangeLog">ChangeLog</a> is written with each new snapshot.
1.1 kristaps 68: </p>
69:
70: <p class="boxed">
71: % cd /tmp<br>
1.16 kristaps 72: % ftp -V -o- <a href="http://mdocml.bsd.lv/snapshots/mdocml.tar.gz">
73: http://mdocml.bsd.lv/snapshots/mdocml.tar.gz</a> | tar -zvxf -<br>
1.1 kristaps 74: % cd mdocml<br>
1.6 kristaps 75: % make all<br>
76: # make install
1.1 kristaps 77: </p>
78:
79: <h2>
1.10 kristaps 80: Snapshot port/pkgsrc
1.1 kristaps 81: </h2>
82:
83: <p>
1.12 kristaps 84: The source snapshot is automatically converted into OpenBSD, NetBSD and FreeBSD ports at <a
85: href="/ports-openbsd/">/ports-openbsd/</a>, <a href="/ports-netbsd/">/ports-netbsd/</a> and <a
1.14 kristaps 86: href="/ports-freebsd/">/ports-freebsd/</a>, respectively. Please read the <a class="external"
87: href="http://www.openbsd.org/faq/faq15.html">OpenBSD Ports FAQ</a>, the <a class="external"
88: href="http://www.netbsd.org/docs/software/packages.html">NetBSD pkgsrc guide</a> or the <a
89: class="external"
90: href="http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ports-using.html">FreeBSD ports
91: guide</a>, first.
1.1 kristaps 92: </p>
93:
1.10 kristaps 94: <h3>
95: OpenBSD port
96: </h3>
97:
1.20 ! kristaps 98: <p>
! 99: Note: the <span class="nm">mdocml</span> utility is part of OpenBSD's base system at <a
! 100: href="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/">usr.bin/mandoc</a>. Please use this
! 101: instead of the provided port.
! 102: </p>
! 103:
1.1 kristaps 104: <p class="boxed">
1.6 kristaps 105: # pkg_delete mdocml<br>
1.11 kristaps 106: # cd /usr/ports/textproc/<br>
1.6 kristaps 107: # rm -rf mdocml<br>
1.16 kristaps 108: # ftp -V -o- <a href="http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz">
109: http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz</a> | tar -zvxf -<br>
1.6 kristaps 110: # cd mdocml<br>
111: # make build<br>
1.10 kristaps 112: # make install
113: </p>
114:
115: <h3>
116: NetBSD pkgsrc
117: </h3>
118:
1.20 ! kristaps 119: <p>
! 120: Note: a pkgsrc port is maintained in-tree at <a
! 121: href="http://cvsweb.netbsd.org/bsdweb.cgi/pkgsrc/textproc/mdocml/">textproc/mdocml</a>. Please use this
! 122: instead of the provided pkgsrc.
! 123: </p>
! 124:
1.10 kristaps 125: <p class="boxed">
126: # pkg_delete mdocml<br>
1.11 kristaps 127: # cd /usr/pkgsrc/textproc/<br>
1.10 kristaps 128: # rm -rf mdocml<br>
1.16 kristaps 129: # ftp -V -o- <a href="http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz">
130: http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz</a> | tar -zvxf -<br>
1.10 kristaps 131: # cd mdocml<br>
132: # make build<br>
1.6 kristaps 133: # make install
1.1 kristaps 134: </p>
1.12 kristaps 135:
136: <h3>
137: FreeBSD port
138: </h3>
139:
1.20 ! kristaps 140: <p>
! 141: Note: a port is maintained in-tree at <a
! 142: href="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/">textproc/mdocml</a>. Please use
! 143: this instead of the provided port.
! 144: </p>
! 145:
1.12 kristaps 146: <p class="boxed">
1.15 kristaps 147: # pkg_delete -x mdocml<br>
148: # cd /tmp<br>
1.16 kristaps 149: # ftp -V -o- <a href="http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz">
150: http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz</a> | tar -zvxf -<br>
1.12 kristaps 151: # cd mdocml<br>
1.15 kristaps 152: # make<br>
1.12 kristaps 153: # make install
154: </p>
1.1 kristaps 155: </td>
156: </tr>
157: <tr>
158: <td>
159: <h1>
1.18 kristaps 160: DOCUMENTATION
161: </h1>
162:
163: <table width="100%">
164: <colgroup>
165: <col>
166: <col width="5">
167: <col width="100%">
168: </colgroup>
169: <tr>
170: <td><a href="mandoc.1.txt">mandoc(1)</a></td>
171: <td></td>
172: <td>format and display UNIX manuals</td>
173: </tr>
174: <tr>
175: <td><a href="mandoc_char.7.txt">mandoc_char(7)</a></td>
176: <td></td>
177: <td>mandoc special characters</td>
178: </tr>
179: <tr>
180: <td><a href="mdoc.7.txt">mdoc(7)</a></td>
181: <td></td>
182: <td>mdoc language reference</td>
183: </tr>
184: <tr>
185: <td><a href="man.7.txt">man(7)</a></td>
186: <td></td>
187: <td>man language reference</td>
188: </tr>
189: <tr>
190: <td><a href="manuals.7.txt">manuals(7)</a></td>
191: <td></td>
192: <td>a guide to writing UNIX manuals</td>
193: </tr>
194: <tr>
195: <td><a href="mdoc.3.txt">mdoc(3)</a></td>
196: <td></td>
197: <td>mdoc macro compiler library</td>
198: </tr>
199: <tr>
200: <td><a href="man.3.txt">man(3)</a></td>
201: <td></td>
202: <td>man macro compiler library</td>
203: </tr>
204: </table>
205: </td>
206: </tr>
207: <tr>
208: <td>
209: <h1>
1.1 kristaps 210: CONTACT
211: </h1>
212:
213: <p>
1.18 kristaps 214: For all issues related to <span class="nm">mdocml</span>, contact Kristaps, kris<a class="external"
1.1 kristaps 215: href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ=="
216: onclick="window.open('http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ==',
217: '', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=0,width=500,height=300'); return
1.18 kristaps 218: false;" title="Reveal this e-mail address">...</a>@kth.se.
1.1 kristaps 219: </p>
1.18 kristaps 220:
221: <p>
222: If you want to receive a semi-automated mail-out of new versions, then please write with a message
223: subject of “subscribe mdocml” (or, symmetrically, “unsubscribe mdocml”).
224: </p>
225:
1.1 kristaps 226: <p>
1.20 ! kristaps 227: We don't offer anonymous CVS access. If you must have read-only access to the CVS tree (for down-stream
! 228: maintenance and so on), then please contact Kristaps directly for a read-only CVS account. We strongly
! 229: suggest using snapshots, instead.
1.1 kristaps 230: </p>
231: </td>
232: </tr>
233: <tr>
234: <td>
235: <div class="foot">
1.20 ! kristaps 236: Copyright © 2008, 2009 Kristaps Džonsons, $Date: 2009/06/13 18:48:21 $
1.1 kristaps 237: </div>
238: </td>
239: </tr>
240: </tbody>
241: </table>
242: </body>
243: </html>