| version 1.2, 2009/02/23 15:38:20 |
version 1.19, 2009/06/13 18:48:21 |
|
|
| </h1> |
</h1> |
| |
|
| <p> |
<p> |
| <span class="nm">mdocml</span> is a suite of tools that compile “mdoc”, the roff macro |
<span class="nm">mdocml</span> is a suite of tools compiling “-mdoc”, the roff macro package |
| package of the BSD manual pages. The mission of <span class="nm">mdocml</span> is to deprecate <a |
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 |
| 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 BSD mdoc pages. groff amounts to over 60 000 lines of GPL C++ source, which is a |
displaying -mdoc pages whilst providing token support for -man. |
| considerable encumbrance to BSD operating system. |
|
| </p> |
</p> |
| |
|
| <p> |
<p> |
| The core of <span class="nm">mdocml</span> is the libmdoc library, a validating scanner-parser producing |
Why? groff amounts to over 5 MB of source code, most of which is C++ and all of which is GPL. It runs |
| intermediate-form output from mdoc input. libmdoc is a simple, fast library operating on memory buffers |
slowly, produces uncertain output, and varies in operation from system to system. mdocml strives to fix |
| of mdoc input. Its intermediate output, an abstract syntax tree, is fully documented in the <span |
this (respectively small, C, ISC-licensed, fast and regular). |
| class="man">mdoc(3)</span> reference manual. |
|
| </p> |
</p> |
| |
|
| <p> |
<p> |
| There are three utilities implementing <span class="man">mdoc(3)</span>: |
The core of <span class="nm">mdocml</span> is composed of the <i>libmdoc</i> and <i>libman</i> |
| |
validating compiler libraries. Both are simple, fast libraries operating on memory buffers, so they may |
| |
be used for a variety of front-ends (terminal-based, CGI and so on). The primary front-end is <i> |
| |
mandoc</i>, which formats manuals for display on the terminal. |
| </p> |
</p> |
| |
|
| <ul> |
|
| <li><span class="man">mdocterm(1)</span> – formats mdoc input for display on the terminal |
|
| <li><span class="man">mdochtml(1)</span> – formats mdoc input as strict HTML (nascent) |
|
| <li><span class="man">mdoclint(1)</span> – validates mdoc input |
|
| <li><span class="man">mdoctree(1)</span> – prints input abstract syntax tree |
|
| </ul> |
|
| |
|
| <p> |
|
| The <span class="man">mdocterm(1)</span> utility is intended to deprecate usage of <a |
|
| href="http://www.gnu.org/software/groff/" class="external">groff</a> for displaying BSD manuals to the |
|
| terminal, either directly or cached as a “catman” page. |
|
| </p> |
|
| |
|
| <p> |
|
| <span class="attn">Please submit patches!</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 to submit patches and bug reports. |
|
| </p> |
|
| </td> |
</td> |
| </tr> |
</tr> |
| <tr> |
<tr> |
|
|
| </h1> |
</h1> |
| |
|
| <p> |
<p> |
| Sources correctly build and install on OpenBSD, NetBSD and Linux operating systems, tested variously on |
Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested |
| i386, AMD64 and Alpha. |
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> |
| |
|
| <h2> |
<h2> |
| nightly source |
Snapshot source |
| </h2> |
</h2> |
| |
|
| <p> |
<p> |
| CVS sources are checkedout and snapshotted nightly. 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. |
may be found in the <a href="/snapshots/">/snapshots/</a> directory. A full <a |
| |
href="/snapshots/ChangeLog">ChangeLog</a> is written with each new snapshot. |
| </p> |
</p> |
| |
|
| <p class="boxed"> |
<p class="boxed"> |
| % cd /tmp<br> |
% cd /tmp<br> |
| % ftp -V -o- http://mdocml.bsd.lv/snapshots/mdocml.tgz | tar -zxf -<br> |
% ftp -V -o- <a href="http://mdocml.bsd.lv/snapshots/mdocml.tar.gz"> |
| |
http://mdocml.bsd.lv/snapshots/mdocml.tar.gz</a> | tar -zvxf -<br> |
| % cd mdocml<br> |
% cd mdocml<br> |
| % make<br> |
% make all<br> |
| % make regress<br> |
# make install |
| % make install |
|
| </p> |
</p> |
| |
|
| <h2> |
<h2> |
| nightly port |
Snapshot port/pkgsrc |
| </h2> |
</h2> |
| |
|
| <p> |
<p> |
| The nightly snapshot is automatically converted into an OpenBSD port (ports for other BSD systems not |
The source snapshot is automatically converted into OpenBSD, NetBSD and FreeBSD ports at <a |
| yet available). These may be found in the <a href="/ports-openbsd/">/ports-openbsd/</a> directory. |
href="/ports-openbsd/">/ports-openbsd/</a>, <a href="/ports-netbsd/">/ports-netbsd/</a> and <a |
| |
href="/ports-freebsd/">/ports-freebsd/</a>, respectively. Please read the <a class="external" |
| |
href="http://www.openbsd.org/faq/faq15.html">OpenBSD Ports FAQ</a>, the <a class="external" |
| |
href="http://www.netbsd.org/docs/software/packages.html">NetBSD pkgsrc guide</a> or the <a |
| |
class="external" |
| |
href="http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ports-using.html">FreeBSD ports |
| |
guide</a>, first. |
| </p> |
</p> |
| |
|
| <p> |
<h3> |
| If installing for the first time: |
OpenBSD port |
| </p> |
</h3> |
| |
|
| <p class="boxed"> |
<p class="boxed"> |
| % ftp -V -o- http://mdocml.bsd.lv/ports-openbsd/mdocml.tgz | tar -zxf -<br> |
# pkg_delete mdocml<br> |
| % cd mdocml<br> |
# cd /usr/ports/textproc/<br> |
| % sudo make<br> |
# rm -rf mdocml<br> |
| % sudo make install |
# ftp -V -o- <a href="http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz"> |
| |
http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz</a> | tar -zvxf -<br> |
| |
# cd mdocml<br> |
| |
# make build<br> |
| |
# make install |
| </p> |
</p> |
| |
|
| <p> |
<h3> |
| Subsequent installations: |
NetBSD pkgsrc |
| |
</h3> |
| |
|
| |
<p class="boxed"> |
| |
# pkg_delete mdocml<br> |
| |
# cd /usr/pkgsrc/textproc/<br> |
| |
# rm -rf mdocml<br> |
| |
# ftp -V -o- <a href="http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz"> |
| |
http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz</a> | tar -zvxf -<br> |
| |
# cd mdocml<br> |
| |
# make build<br> |
| |
# make install |
| </p> |
</p> |
| |
|
| |
<h3> |
| |
FreeBSD port |
| |
</h3> |
| |
|
| <p class="boxed"> |
<p class="boxed"> |
| % sudo pkg_add -r mdocml |
# pkg_delete -x mdocml<br> |
| |
# cd /tmp<br> |
| |
# ftp -V -o- <a href="http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz"> |
| |
http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz</a> | tar -zvxf -<br> |
| |
# cd mdocml<br> |
| |
# make<br> |
| |
# make install |
| </p> |
</p> |
| </td> |
</td> |
| </tr> |
</tr> |
| <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 on. |
false;" title="Reveal this e-mail address">...</a>@kth.se. |
| </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> |
| |
|
| |
<p> |
| |
We don'yet 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> |
| </td> |
</td> |
| </tr> |
</tr> |
| <tr> |
<tr> |
| <td> |
<td> |
| <div class="foot"> |
<div class="foot"> |
| Copyright © 2009 Kristaps Džonsons, $Date$ |
Copyright © 2008, 2009 Kristaps Džonsons, $Date$ |
| </div> |
</div> |
| </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