![[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">
1.28 kristaps 6: <link rel="stylesheet" href="index.css" type="text/css" media="all">
1.1 kristaps 7: <title>mdocml.bsd.lv</title>
8: </head>
9: <body>
1.37 kristaps 10: <table class="frame" summary="[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.33 kristaps 51: SOURCES
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.34 kristaps 58: href="ChangeLog.html">ChangeLog</a> (<a href="ChangeLog.txt">txt</a>) is written with each release.
1.7 kristaps 59: </p>
60:
1.1 kristaps 61: <h2>
1.26 kristaps 62: Current
1.1 kristaps 63: </h2>
64:
1.37 kristaps 65: <table width="100%" summary="Current Sources">
1.24 kristaps 66: <col width="200">
67: <col>
1.22 kristaps 68: <tbody>
69: <tr>
1.26 kristaps 70: <td>Source archive</td>
1.22 kristaps 71: <td>
1.26 kristaps 72: <a href="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</a>
73: (<a href="/snapshots/mdocml.md5">md5</a>)
1.22 kristaps 74: </td>
75: </tr>
1.33 kristaps 76: <tr>
77: <td>Online source</td>
78: <td>
79: <a class="external" href="http://bsd.lv/cgi-bin/cvsweb.cgi/?cvsroot=mdocml">cvsweb</a>
80: </td>
81: </tr>
1.22 kristaps 82: </tbody>
83: </table>
1.1 kristaps 84:
85: <h2>
1.26 kristaps 86: Downstream
1.1 kristaps 87: </h2>
88:
1.37 kristaps 89: <table width="100%" summary="Downstream Sources">
1.24 kristaps 90: <col width="200">
91: <col>
1.22 kristaps 92: <tbody>
93: <tr>
1.38 ! kristaps 94: <td>DragonFly BSD</td>
! 95: <td>
! 96: <a href="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc"
! 97: class="external">usr.bin/mandoc</a>
! 98: </td>
! 99: </tr>
! 100: <tr>
1.26 kristaps 101: <td>FreeBSD</td>
1.22 kristaps 102: <td>
1.26 kristaps 103: <a href="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/"
104: class="external">ports/textproc/mdocml</a>
1.22 kristaps 105: </td>
106: </tr>
107: <tr>
1.26 kristaps 108: <td>NetBSD</td>
1.22 kristaps 109: <td>
1.35 kristaps 110: <a href="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/"
1.36 kristaps 111: class="external">src/external/bsd/mdocml</a>
1.22 kristaps 112: </td>
113: </tr>
114: <tr>
1.26 kristaps 115: <td>OpenBSD</td>
1.22 kristaps 116: <td>
1.26 kristaps 117: <a href="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/"
118: class="external">src/usr.bin/mandoc</a>
1.22 kristaps 119: </td>
120: </tr>
121: </tbody>
122: </table>
1.1 kristaps 123:
1.22 kristaps 124: <h2>
125: Historical
126: </h2>
1.10 kristaps 127:
1.37 kristaps 128: <table width="100%" summary="Archived Sources">
1.24 kristaps 129: <col width="200">
130: <col>
1.22 kristaps 131: <tbody>
132: <tr>
133: <td>Source archive</td>
134: <td>
1.24 kristaps 135: <a href="/snapshots/">/snapshots/</a>
1.22 kristaps 136: </td>
137: </tr>
138: </tbody>
139: </table>
1.1 kristaps 140: </td>
141: </tr>
142: <tr>
143: <td>
144: <h1>
1.18 kristaps 145: DOCUMENTATION
146: </h1>
147:
1.24 kristaps 148: <p>
1.29 kristaps 149: These manuals are generated automatically (with <a href="mandoc.1.html">mandoc(1)</a> -Thtml) and refer to the
1.24 kristaps 150: current snapshot.
151: </p>
152:
1.37 kristaps 153: <table width="100%" summary="Documentation">
1.24 kristaps 154: <col width="200">
155: <col>
1.22 kristaps 156: <tbody>
1.18 kristaps 157: <tr>
1.34 kristaps 158: <td><a href="mandoc.1.html">mandoc(1)</a> (<a href="mandoc.1.txt">text</a>)</td>
1.18 kristaps 159: <td>format and display UNIX manuals</td>
160: </tr>
161: <tr>
1.34 kristaps 162: <td><a href="mandoc_char.7.html">mandoc_char(7)</a> (<a href="mandoc_char.7.txt">text</a>)</td>
1.18 kristaps 163: <td>mandoc special characters</td>
164: </tr>
165: <tr>
1.34 kristaps 166: <td><a href="mdoc.7.html">mdoc(7)</a> (<a href="mdoc.7.txt">text</a>)</td>
1.18 kristaps 167: <td>mdoc language reference</td>
168: </tr>
169: <tr>
1.34 kristaps 170: <td><a href="man.7.html">man(7)</a> (<a href="man.7.txt">text</a>)</td>
1.18 kristaps 171: <td>man language reference</td>
172: </tr>
173: <tr>
1.34 kristaps 174: <td><a href="manuals.7.html">manuals(7)</a> (<a href="manuals.7.txt">text</a>)</td>
1.18 kristaps 175: <td>a guide to writing UNIX manuals</td>
176: </tr>
177: <tr>
1.34 kristaps 178: <td><a href="mdoc.3.html">mdoc(3)</a> (<a href="mdoc.3.txt">text</a>)</td>
1.18 kristaps 179: <td>mdoc macro compiler library</td>
180: </tr>
181: <tr>
1.34 kristaps 182: <td><a href="man.3.html">man(3)</a> (<a href="man.3.txt">text</a>)</td>
1.18 kristaps 183: <td>man macro compiler library</td>
184: </tr>
1.22 kristaps 185: </tbody>
1.18 kristaps 186: </table>
187: </td>
188: </tr>
189: <tr>
190: <td>
191: <h1>
1.1 kristaps 192: CONTACT
193: </h1>
194:
195: <p>
1.22 kristaps 196: For all issues related to <span class="nm">mdocml</span>, contact Kristaps Džonsons, kris<a
197: class="external"
1.1 kristaps 198: href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ=="
1.24 kristaps 199: title="Reveal this e-mail address">...</a>@kth.se.
1.1 kristaps 200: </p>
1.18 kristaps 201:
202: <p>
1.24 kristaps 203: If you want to receive a semi-automated mail-out of new releases, then please write with a message
1.22 kristaps 204: subject of <i>subscribe mdocml</i> (or <i>unsubscribe mdocml</i>).
1.18 kristaps 205: </p>
1.1 kristaps 206: </td>
207: </tr>
208: <tr>
209: <td>
210: <div class="foot">
1.38 ! kristaps 211: Copyright © 2008, 2009 Kristaps Džonsons, $Date: 2009/10/28 08:08:53 $
1.1 kristaps 212: </div>
213: </td>
214: </tr>
215: </tbody>
216: </table>
217: </body>
218: </html>