![[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>
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.18 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
! 58: href="/snapshots/ChangeLog">ChangeLog</a> is written with each new version.
1.7 kristaps 59: </p>
60:
1.1 kristaps 61: <h2>
1.22 ! kristaps 62: Downstream
1.1 kristaps 63: </h2>
64:
1.22 ! kristaps 65: <table width="100%" style="padding-left: 10px;">
! 66: <col width="40%">
! 67: <col width="60%">
! 68: <tbody>
! 69: <tr>
! 70: <td>FreeBSD (ports)</td>
! 71: <td>
! 72: <a href="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/"
! 73: class="external">/textproc/mandoc</a>
! 74: </td>
! 75: </tr>
! 76: <tr>
! 77: <td>NetBSD (pkgsrc)</td>
! 78: <td>
! 79: <a href="http://cvsweb.netbsd.org/bsdweb.cgi/pkgsrc/textproc/mdocml/"
! 80: class="external">/textproc/mandoc</a>
! 81: </td>
! 82: </tr>
! 83: <tr>
! 84: <td>OpenBSD (base system)</td>
! 85: <td>
! 86: <a href="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/"
! 87: class="external">/usr.bin/mandoc</a>
! 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.22 ! kristaps 97: <table width="100%" style="padding-left: 10px;">
! 98: <col width="40%">
! 99: <col width="60%">
! 100: <tbody>
! 101: <tr>
! 102: <td>Source archive</td>
! 103: <td>
! 104: <a href="http://mdocml.bsd.lv/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</a>
! 105: (<a href="http://mdocml.bsd.lv/snapshots/mdocml.md5">md5</a>)
! 106: </td>
! 107: </tr>
! 108: <tr>
! 109: <td>OpenBSD port</td>
! 110: <td>
! 111: <a href="http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz">/ports-openbsd/mdocml.tar.gz</a>
! 112: (<a href="http://mdocml.bsd.lv/ports-openbsd/mdocml.md5">md5</a>)
! 113: </td>
! 114: </tr>
! 115: <tr>
! 116: <td>FreeBSD port</td>
! 117: <td>
! 118: <a href="http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz">/ports-freebsd/mdocml.tar.gz</a>
! 119: (<a href="http://mdocml.bsd.lv/snapshots/mdocml.md5">md5</a>)
! 120: </td>
! 121: </tr>
! 122: <tr>
! 123: <td>NetBSD pkgsrc</td>
! 124: <td>
! 125: <a href="http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz">/ports-netbsd/mdocml.tar.gz</a>
! 126: (<a href="http://mdocml.bsd.lv/snapshots/mdocml.md5">md5</a>)
! 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.22 ! kristaps 136: <table width="100%" style="padding-left: 10px;">
! 137: <col width="40%">
! 138: <col width="60%">
! 139: <tbody>
! 140: <tr>
! 141: <td>Source archive</td>
! 142: <td>
! 143: <a href="http://mdocml.bsd.lv/snapshots/">/snapshots/</a>
! 144: </td>
! 145: </tr>
! 146: <tr>
! 147: <td>OpenBSD port</td>
! 148: <td>
! 149: <a href="http://mdocml.bsd.lv/ports-openbsd/">/ports-openbsd/</a>
! 150: </td>
! 151: </tr>
! 152: <tr>
! 153: <td>FreeBSD port</td>
! 154: <td>
! 155: <a href="http://mdocml.bsd.lv/ports-freebsd/">/ports-freebsd/</a>
! 156: </td>
! 157: </tr>
! 158: <tr>
! 159: <td>NetBSD pkgsrc</td>
! 160: <td>
! 161: <a href="http://mdocml.bsd.lv/ports-netbsd/">/ports-netbsd/</a>
! 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.22 ! kristaps 174: <table width="100%" style="padding-left: 10px;">
! 175: <col width="40%">
! 176: <col width="60%">
! 177: <tbody>
1.18 kristaps 178: <tr>
179: <td><a href="mandoc.1.txt">mandoc(1)</a></td>
180: <td>format and display UNIX manuals</td>
181: </tr>
182: <tr>
183: <td><a href="mandoc_char.7.txt">mandoc_char(7)</a></td>
184: <td>mandoc special characters</td>
185: </tr>
186: <tr>
187: <td><a href="mdoc.7.txt">mdoc(7)</a></td>
188: <td>mdoc language reference</td>
189: </tr>
190: <tr>
191: <td><a href="man.7.txt">man(7)</a></td>
192: <td>man language reference</td>
193: </tr>
194: <tr>
195: <td><a href="manuals.7.txt">manuals(7)</a></td>
196: <td>a guide to writing UNIX manuals</td>
197: </tr>
198: <tr>
199: <td><a href="mdoc.3.txt">mdoc(3)</a></td>
200: <td>mdoc macro compiler library</td>
201: </tr>
202: <tr>
203: <td><a href="man.3.txt">man(3)</a></td>
204: <td>man macro compiler library</td>
205: </tr>
1.22 ! kristaps 206: </tbody>
1.18 kristaps 207: </table>
208: </td>
209: </tr>
210: <tr>
211: <td>
212: <h1>
1.1 kristaps 213: CONTACT
214: </h1>
215:
216: <p>
1.22 ! kristaps 217: For all issues related to <span class="nm">mdocml</span>, contact Kristaps Džonsons, kris<a
! 218: class="external"
1.1 kristaps 219: href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ=="
220: onclick="window.open('http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ==',
221: '', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=0,width=500,height=300'); return
1.18 kristaps 222: false;" title="Reveal this e-mail address">...</a>@kth.se.
1.1 kristaps 223: </p>
1.18 kristaps 224:
225: <p>
226: If you want to receive a semi-automated mail-out of new versions, then please write with a message
1.22 ! kristaps 227: subject of <i>subscribe mdocml</i> (or <i>unsubscribe mdocml</i>).
1.18 kristaps 228: </p>
1.1 kristaps 229: </td>
230: </tr>
231: <tr>
232: <td>
233: <div class="foot">
1.22 ! kristaps 234: Copyright © 2008, 2009 Kristaps Džonsons, $Date: 2009/06/17 19:12:03 $
1.1 kristaps 235: </div>
236: </td>
237: </tr>
238: </tbody>
239: </table>
240: </body>
241: </html>