![[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>
1.24 ! kristaps 10: <table class="frame">
1.1 kristaps 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>
1.22 kristaps 51: DOWNLOADS
1.1 kristaps 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.24 ! kristaps 56: variously on i386, AMD64, alpha, and others. The most current version is <span
1.22 kristaps 57: class="attn">@VERSION@</span>, dated <span class="attn">@VDATE@</span>. A full <a
1.24 ! kristaps 58: href="/snapshots/ChangeLog">ChangeLog</a> is written with each release.
1.7 kristaps 59: </p>
60:
1.1 kristaps 61: <h2>
1.22 kristaps 62: Downstream
1.1 kristaps 63: </h2>
64:
1.24 ! kristaps 65: <table width="100%">
! 66: <col width="200">
! 67: <col>
1.22 kristaps 68: <tbody>
69: <tr>
1.23 kristaps 70: <td>FreeBSD</td>
1.22 kristaps 71: <td>
1.24 ! kristaps 72: <a href="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/"
! 73: class="external">ports/textproc/mdocml</a>
1.22 kristaps 74: </td>
75: </tr>
76: <tr>
1.23 kristaps 77: <td>NetBSD</td>
1.22 kristaps 78: <td>
79: <a href="http://cvsweb.netbsd.org/bsdweb.cgi/pkgsrc/textproc/mdocml/"
1.24 ! kristaps 80: class="external">pkgsrc/textproc/mdocml</a>
1.22 kristaps 81: </td>
82: </tr>
83: <tr>
1.23 kristaps 84: <td>OpenBSD</td>
1.22 kristaps 85: <td>
86: <a href="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/"
1.23 kristaps 87: class="external">src/usr.bin/mandoc</a>
1.22 kristaps 88: </td>
89: </tr>
90: </tbody>
91: </table>
1.1 kristaps 92:
93: <h2>
1.22 kristaps 94: Current
1.1 kristaps 95: </h2>
96:
1.24 ! kristaps 97: <table width="100%">
! 98: <col width="200">
! 99: <col>
1.22 kristaps 100: <tbody>
101: <tr>
102: <td>Source archive</td>
103: <td>
1.24 ! kristaps 104: <a href="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</a>
! 105: (<a href="/snapshots/mdocml.md5">md5</a>)
1.22 kristaps 106: </td>
107: </tr>
108: <tr>
1.23 kristaps 109: <td>FreeBSD port</td>
1.22 kristaps 110: <td>
1.24 ! kristaps 111: <a href="/ports-freebsd/mdocml.tar.gz">/ports-freebsd/mdocml.tar.gz</a>
! 112: (<a href="/ports-freebsd/mdocml.md5">md5</a>)
1.22 kristaps 113: </td>
114: </tr>
115: <tr>
1.23 kristaps 116: <td>NetBSD pkgsrc</td>
1.22 kristaps 117: <td>
1.24 ! kristaps 118: <a href="/ports-netbsd/mdocml.tar.gz">/ports-netbsd/mdocml.tar.gz</a>
! 119: (<a href="/ports-netbsd/mdocml.md5">md5</a>)
1.22 kristaps 120: </td>
121: </tr>
122: <tr>
1.23 kristaps 123: <td>OpenBSD port</td>
1.22 kristaps 124: <td>
1.24 ! kristaps 125: <a href="/ports-openbsd/mdocml.tar.gz">/ports-openbsd/mdocml.tar.gz</a>
! 126: (<a href="/ports-openbsd/mdocml.md5">md5</a>)
1.22 kristaps 127: </td>
128: </tr>
129: </tbody>
130: </table>
1.1 kristaps 131:
1.22 kristaps 132: <h2>
133: Historical
134: </h2>
1.10 kristaps 135:
1.24 ! kristaps 136: <table width="100%">
! 137: <col width="200">
! 138: <col>
1.22 kristaps 139: <tbody>
140: <tr>
141: <td>Source archive</td>
142: <td>
1.24 ! kristaps 143: <a href="/snapshots/">/snapshots/</a>
1.22 kristaps 144: </td>
145: </tr>
146: <tr>
1.23 kristaps 147: <td>FreeBSD port</td>
1.22 kristaps 148: <td>
1.24 ! kristaps 149: <a href="/ports-freebsd/">/ports-freebsd/</a>
1.22 kristaps 150: </td>
151: </tr>
152: <tr>
1.23 kristaps 153: <td>NetBSD pkgsrc</td>
1.22 kristaps 154: <td>
1.24 ! kristaps 155: <a href="/ports-netbsd/">/ports-netbsd/</a>
1.22 kristaps 156: </td>
157: </tr>
158: <tr>
1.23 kristaps 159: <td>OpenBSD port</td>
1.22 kristaps 160: <td>
1.24 ! kristaps 161: <a href="/ports-openbsd/">/ports-openbsd/</a>
1.22 kristaps 162: </td>
163: </tr>
164: </tbody>
165: </table>
1.1 kristaps 166: </td>
167: </tr>
168: <tr>
169: <td>
170: <h1>
1.18 kristaps 171: DOCUMENTATION
172: </h1>
173:
1.24 ! kristaps 174: <p>
! 175: These manuals are generated automatically (with <a href="mandoc.1.txt">mandoc(1)</a>) and refer to the
! 176: current snapshot.
! 177: </p>
! 178:
! 179: <table width="100%">
! 180: <col width="200">
! 181: <col>
1.22 kristaps 182: <tbody>
1.18 kristaps 183: <tr>
184: <td><a href="mandoc.1.txt">mandoc(1)</a></td>
185: <td>format and display UNIX manuals</td>
186: </tr>
187: <tr>
188: <td><a href="mandoc_char.7.txt">mandoc_char(7)</a></td>
189: <td>mandoc special characters</td>
190: </tr>
191: <tr>
192: <td><a href="mdoc.7.txt">mdoc(7)</a></td>
193: <td>mdoc language reference</td>
194: </tr>
195: <tr>
196: <td><a href="man.7.txt">man(7)</a></td>
197: <td>man language reference</td>
198: </tr>
199: <tr>
200: <td><a href="manuals.7.txt">manuals(7)</a></td>
201: <td>a guide to writing UNIX manuals</td>
202: </tr>
203: <tr>
204: <td><a href="mdoc.3.txt">mdoc(3)</a></td>
205: <td>mdoc macro compiler library</td>
206: </tr>
207: <tr>
208: <td><a href="man.3.txt">man(3)</a></td>
209: <td>man macro compiler library</td>
210: </tr>
1.22 kristaps 211: </tbody>
1.18 kristaps 212: </table>
213: </td>
214: </tr>
215: <tr>
216: <td>
217: <h1>
1.1 kristaps 218: CONTACT
219: </h1>
220:
221: <p>
1.22 kristaps 222: For all issues related to <span class="nm">mdocml</span>, contact Kristaps Džonsons, kris<a
223: class="external"
1.1 kristaps 224: href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ=="
1.24 ! kristaps 225: title="Reveal this e-mail address">...</a>@kth.se.
1.1 kristaps 226: </p>
1.18 kristaps 227:
228: <p>
1.24 ! kristaps 229: If you want to receive a semi-automated mail-out of new releases, then please write with a message
1.22 kristaps 230: subject of <i>subscribe mdocml</i> (or <i>unsubscribe mdocml</i>).
1.18 kristaps 231: </p>
1.1 kristaps 232: </td>
233: </tr>
234: <tr>
235: <td>
236: <div class="foot">
1.24 ! kristaps 237: Copyright © 2008, 2009 Kristaps Džonsons, $Date: 2009/06/25 10:52:56 $
1.1 kristaps 238: </div>
239: </td>
240: </tr>
241: </tbody>
242: </table>
243: </body>
244: </html>