| version 1.17, 2009/06/11 13:34:14 |
version 1.20, 2009/06/15 11:24:16 |
|
|
| of choice for BSD manual pages, and “-man”, the predominant historical package for UNIX |
of choice for BSD manual pages, and “-man”, the predominant historical package for UNIX |
| manuals. The mission of <span class="nm">mdocml</span> is to deprecate <a |
manuals. The mission of <span class="nm">mdocml</span> is to deprecate <a |
| href="http://www.gnu.org/software/groff/" class="external">groff</a>, the GNU roff implementation, for |
href="http://www.gnu.org/software/groff/" class="external">groff</a>, the GNU roff implementation, for |
| displaying <a href="mdoc.7.txt" class="man">mdoc(7)</a> pages whilst providing token support for <a |
displaying -mdoc pages whilst providing token support for -man. |
| href="man.7.txt" class="man">man(7)</a>. |
|
| </p> |
</p> |
| |
|
| <p> |
<p> |
| What are UNIX manuals? Read <a href="manuals.7.txt" class="man">manuals(7)</a> for an introduction. |
|
| </p> |
|
| |
|
| <p> |
|
| Why? groff amounts to over 5 MB of source code, most of which is C++ and all of which is GPL. It runs |
Why? groff amounts to over 5 MB of source code, most of which is C++ and all of which is GPL. It runs |
| slowly, produces uncertain output, and varies in operation from system to system. mdocml strives to fix |
slowly, produces uncertain output, and varies in operation from system to system. mdocml strives to fix |
| this (respectively small, C, ISC-licensed, fast and regular). |
this (respectively small, C, ISC-licensed, fast and regular). |
| </p> |
</p> |
| |
|
| <p> |
<p> |
| The core of <span class="nm">mdocml</span> are the <a href="man.3.txt" class="man">man(3)</a> and <a |
The core of <span class="nm">mdocml</span> is composed of the <i>libmdoc</i> and <i>libman</i> |
| href="mdoc.3.txt" class="man">mdoc(3)</a> libraries, validating compilers producing intermediate-form |
validating compiler libraries. Both are simple, fast libraries operating on memory buffers, so they may |
| output from -man or -mdoc input. Both are simple, fast libraries operating on memory buffers, so they |
be used for a variety of front-ends (terminal-based, CGI and so on). The primary front-end is <i> |
| may be used for a variety of front-ends (terminal-based, CGI and so on). |
mandoc</i>, which formats manuals for display on the terminal. |
| </p> |
</p> |
| |
|
| <p> |
|
| The primary front-end is <a href="mandoc.1.txt" class="man">mandoc(1)</a>, which formats manuals for |
|
| display on the terminal. Its purpose is to deprecate usage of groff for displaying -mdoc and, to a |
|
| limited extent, -man manuals on the terminal. |
|
| </p> |
|
| |
|
| <p> |
|
| <span class="attn">Please submit patches, bug reports and suggestions!</span> Although a significant |
|
| implementation exists, work remains for the backend library and especially the front-end utilities. See |
|
| the <a href="#contact">contact</a> information below for submissions. |
|
| </p> |
|
| </td> |
</td> |
| </tr> |
</tr> |
| <tr> |
<tr> |
|
|
| |
|
| <p> |
<p> |
| Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested |
Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested |
| variously on i386, AMD64, alpha and others. |
variously on i386, AMD64, alpha and others. The most current version is <span |
| |
class="attn">@VERSION@</span>, dated <span class="attn">@VDATE@</span>. |
| </p> |
</p> |
| |
|
| <p> |
|
| The most current version is <span class="attn">@VERSION@</span>, dated |
|
| <span class="attn">@VDATE@</span>. |
|
| </p> |
|
| |
|
| <h2> |
<h2> |
| Snapshot source |
Snapshot source |
| </h2> |
</h2> |
| |
|
| <p> |
<p> |
| CVS sources are checkedout and snapshotted with version updates. These may be found in the <a |
CVS sources are checkedout and snapshotted with version updates. These (and all historical snapshots) |
| href="/snapshots/">/snapshots/</a> directory. A full <a href="/snapshots/ChangeLog">ChangeLog</a> is |
may be found in the <a href="/snapshots/">/snapshots/</a> directory. A full <a |
| written with each new snapshot. |
href="/snapshots/ChangeLog">ChangeLog</a> is written with each new snapshot. |
| </p> |
</p> |
| |
|
| <p class="boxed"> |
<p class="boxed"> |
|
|
| OpenBSD port |
OpenBSD port |
| </h3> |
</h3> |
| |
|
| |
<p> |
| |
Note: the <span class="nm">mdocml</span> utility is part of OpenBSD's base system at <a |
| |
href="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/">usr.bin/mandoc</a>. Please use this |
| |
instead of the provided port. |
| |
</p> |
| |
|
| <p class="boxed"> |
<p class="boxed"> |
| # pkg_delete mdocml<br> |
# pkg_delete mdocml<br> |
| # cd /usr/ports/textproc/<br> |
# cd /usr/ports/textproc/<br> |
|
|
| NetBSD pkgsrc |
NetBSD pkgsrc |
| </h3> |
</h3> |
| |
|
| |
<p> |
| |
Note: a pkgsrc port is maintained in-tree at <a |
| |
href="http://cvsweb.netbsd.org/bsdweb.cgi/pkgsrc/textproc/mdocml/">textproc/mdocml</a>. Please use this |
| |
instead of the provided pkgsrc. |
| |
</p> |
| |
|
| <p class="boxed"> |
<p class="boxed"> |
| # pkg_delete mdocml<br> |
# pkg_delete mdocml<br> |
| # cd /usr/pkgsrc/textproc/<br> |
# cd /usr/pkgsrc/textproc/<br> |
|
|
| FreeBSD port |
FreeBSD port |
| </h3> |
</h3> |
| |
|
| |
<p> |
| |
Note: a port is maintained in-tree at <a |
| |
href="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/">textproc/mdocml</a>. Please use |
| |
this instead of the provided port. |
| |
</p> |
| |
|
| <p class="boxed"> |
<p class="boxed"> |
| # pkg_delete -x mdocml<br> |
# pkg_delete -x mdocml<br> |
| # cd /tmp<br> |
# cd /tmp<br> |
|
|
| <tr> |
<tr> |
| <td> |
<td> |
| <h1> |
<h1> |
| |
DOCUMENTATION |
| |
</h1> |
| |
|
| |
<table width="100%"> |
| |
<colgroup> |
| |
<col> |
| |
<col width="5"> |
| |
<col width="100%"> |
| |
</colgroup> |
| |
<tr> |
| |
<td><a href="mandoc.1.txt">mandoc(1)</a></td> |
| |
<td></td> |
| |
<td>format and display UNIX manuals</td> |
| |
</tr> |
| |
<tr> |
| |
<td><a href="mandoc_char.7.txt">mandoc_char(7)</a></td> |
| |
<td></td> |
| |
<td>mandoc special characters</td> |
| |
</tr> |
| |
<tr> |
| |
<td><a href="mdoc.7.txt">mdoc(7)</a></td> |
| |
<td></td> |
| |
<td>mdoc language reference</td> |
| |
</tr> |
| |
<tr> |
| |
<td><a href="man.7.txt">man(7)</a></td> |
| |
<td></td> |
| |
<td>man language reference</td> |
| |
</tr> |
| |
<tr> |
| |
<td><a href="manuals.7.txt">manuals(7)</a></td> |
| |
<td></td> |
| |
<td>a guide to writing UNIX manuals</td> |
| |
</tr> |
| |
<tr> |
| |
<td><a href="mdoc.3.txt">mdoc(3)</a></td> |
| |
<td></td> |
| |
<td>mdoc macro compiler library</td> |
| |
</tr> |
| |
<tr> |
| |
<td><a href="man.3.txt">man(3)</a></td> |
| |
<td></td> |
| |
<td>man macro compiler library</td> |
| |
</tr> |
| |
</table> |
| |
</td> |
| |
</tr> |
| |
<tr> |
| |
<td> |
| |
<h1> |
| CONTACT |
CONTACT |
| </h1> |
</h1> |
| |
|
| <p> |
<p> |
| Please contact Kristaps, kris<a class="external" |
For all issues related to <span class="nm">mdocml</span>, contact Kristaps, kris<a class="external" |
| href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ==" |
href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ==" |
| onclick="window.open('http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ==', |
onclick="window.open('http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ==', |
| '', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=0,width=500,height=300'); return |
'', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=0,width=500,height=300'); return |
| false;" title="Reveal this e-mail address">...</a>@kth.se, with questions, bug reports, patches, and so |
false;" title="Reveal this e-mail address">...</a>@kth.se. |
| on. |
|
| </p> |
</p> |
| |
|
| <p> |
<p> |
| If you'd like to submit patches, please contact us beforehand in case larger changes are pending but not |
If you want to receive a semi-automated mail-out of new versions, then please write with a message |
| checked in. If making a bug report, please make sure it's repeatable on the most current snapshot. |
subject of “subscribe mdocml” (or, symmetrically, “unsubscribe mdocml”). |
| |
</p> |
| |
|
| |
<p> |
| |
We don't offer anonymous CVS access. If you must have read-only access to the CVS tree (for down-stream |
| |
maintenance and so on), then please contact Kristaps directly for a read-only CVS account. We strongly |
| |
suggest using snapshots, instead. |
| </p> |
</p> |
| </td> |
</td> |
| </tr> |
</tr> |
![[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