version 1.10, 2009/02/28 10:13:45 |
version 1.22, 2009/06/25 08:42:06 |
|
|
</h1> |
</h1> |
|
|
<p> |
<p> |
<span class="nm">mdocml</span> is a suite of tools compiling “mdoc”, the roff macro |
<span class="nm">mdocml</span> is a suite of tools compiling “-mdoc”, the roff macro package |
package for 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. |
displaying -mdoc pages whilst providing token support for -man. |
</p> |
</p> |
|
|
<p> |
<p> |
Why? groff amounts to roughly 5,2 MB of source code (OpenBSD 4.2), some of which is C++ and all of |
Why? groff amounts to over 5 MB of source code, most of which is C++ and all of which is GPL. It runs |
which is GPL. It runs slowly, produces uncertain output, and varies in operation from system |
slowly, produces uncertain output, and varies in operation from system to system. mdocml strives to fix |
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> is the libmdoc library, a validating scanner-parser producing |
The core of <span class="nm">mdocml</span> is composed of the <i>libmdoc</i> and <i>libman</i> |
intermediate-form output from mdoc input. libmdoc is a simple, fast library operating on memory buffers |
validating compiler libraries. Both are simple, fast libraries operating on memory buffers, so they may |
of mdoc input. Its intermediate output, an abstract syntax tree, is fully documented in the <span |
be used for a variety of front-ends (terminal-based, CGI and so on). The primary front-end is <i> |
class="man">mdoc(3)</span> reference manual. |
mandoc</i>, which formats manuals for display on the terminal. |
</p> |
</p> |
|
|
<p> |
|
There are three utilities implementing <span class="man">mdoc(3)</span>: |
|
</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 HTML/CSS (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> |
<td> |
<td> |
<h1> |
<h1> |
INSTALLING SOURCES |
DOWNLOADS |
</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>. A full <a |
|
href="/snapshots/ChangeLog">ChangeLog</a> is written with each new version. |
</p> |
</p> |
|
|
<p> |
|
The most current version is <span class="attn">@VERSION@</span>, dated |
|
<span class="attn">@VDATE@</span>. |
|
</p> |
|
|
|
<h2> |
<h2> |
Snapshot source |
Downstream |
</h2> |
</h2> |
|
|
<p> |
<table width="100%" style="padding-left: 10px;"> |
CVS sources are checkedout and snapshotted with version updates. These may be found in the <a |
<col width="40%"> |
href="/snapshots/">/snapshots/</a> directory. |
<col width="60%"> |
</p> |
<tbody> |
|
<tr> |
|
<td>FreeBSD (ports)</td> |
|
<td> |
|
<a href="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/" |
|
class="external">/textproc/mandoc</a> |
|
</td> |
|
</tr> |
|
<tr> |
|
<td>NetBSD (pkgsrc)</td> |
|
<td> |
|
<a href="http://cvsweb.netbsd.org/bsdweb.cgi/pkgsrc/textproc/mdocml/" |
|
class="external">/textproc/mandoc</a> |
|
</td> |
|
</tr> |
|
<tr> |
|
<td>OpenBSD (base system)</td> |
|
<td> |
|
<a href="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/" |
|
class="external">/usr.bin/mandoc</a> |
|
</td> |
|
</tr> |
|
</tbody> |
|
</table> |
|
|
<p class="boxed"> |
|
% cd /tmp<br> |
|
% ftp -V -o- http://mdocml.bsd.lv/snapshots/mdocml.tar.gz | tar -zvxf -<br> |
|
% cd mdocml<br> |
|
% make all<br> |
|
% make regress<br> |
|
# make install |
|
</p> |
|
|
|
<h2> |
<h2> |
Snapshot port/pkgsrc |
Current |
</h2> |
</h2> |
|
|
<p> |
<table width="100%" style="padding-left: 10px;"> |
The source snapshot is automatically converted into OpenBSD port and NetBSD pkgsrc forms at <a |
<col width="40%"> |
href="/ports-openbsd/">/ports-openbsd/</a> and <a href="/ports-netbsd/">/ports-netbsd/</a>, |
<col width="60%"> |
respectively. Please read the <a href="http://www.openbsd.org/faq/faq15.html">OpenBSD Ports FAQ</a> or |
<tbody> |
<a href="http://www.netbsd.org/docs/software/packages.html">NetBSD pkgsrc guide</a>, first. |
<tr> |
</p> |
<td>Source archive</td> |
|
<td> |
|
<a href="http://mdocml.bsd.lv/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</a> |
|
(<a href="http://mdocml.bsd.lv/snapshots/mdocml.md5">md5</a>) |
|
</td> |
|
</tr> |
|
<tr> |
|
<td>OpenBSD port</td> |
|
<td> |
|
<a href="http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz">/ports-openbsd/mdocml.tar.gz</a> |
|
(<a href="http://mdocml.bsd.lv/ports-openbsd/mdocml.md5">md5</a>) |
|
</td> |
|
</tr> |
|
<tr> |
|
<td>FreeBSD port</td> |
|
<td> |
|
<a href="http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz">/ports-freebsd/mdocml.tar.gz</a> |
|
(<a href="http://mdocml.bsd.lv/snapshots/mdocml.md5">md5</a>) |
|
</td> |
|
</tr> |
|
<tr> |
|
<td>NetBSD pkgsrc</td> |
|
<td> |
|
<a href="http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz">/ports-netbsd/mdocml.tar.gz</a> |
|
(<a href="http://mdocml.bsd.lv/snapshots/mdocml.md5">md5</a>) |
|
</td> |
|
</tr> |
|
</tbody> |
|
</table> |
|
|
<h3> |
<h2> |
OpenBSD port |
Historical |
</h3> |
</h2> |
|
|
<p class="boxed"> |
<table width="100%" style="padding-left: 10px;"> |
# pkg_delete mdocml<br> |
<col width="40%"> |
# cd /usr/ports/devel/<br> |
<col width="60%"> |
# rm -rf mdocml<br> |
<tbody> |
# ftp -V -o- http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz | tar -zvxf -<br> |
<tr> |
# cd mdocml<br> |
<td>Source archive</td> |
# make build<br> |
<td> |
# make install |
<a href="http://mdocml.bsd.lv/snapshots/">/snapshots/</a> |
</p> |
</td> |
|
</tr> |
|
<tr> |
|
<td>OpenBSD port</td> |
|
<td> |
|
<a href="http://mdocml.bsd.lv/ports-openbsd/">/ports-openbsd/</a> |
|
</td> |
|
</tr> |
|
<tr> |
|
<td>FreeBSD port</td> |
|
<td> |
|
<a href="http://mdocml.bsd.lv/ports-freebsd/">/ports-freebsd/</a> |
|
</td> |
|
</tr> |
|
<tr> |
|
<td>NetBSD pkgsrc</td> |
|
<td> |
|
<a href="http://mdocml.bsd.lv/ports-netbsd/">/ports-netbsd/</a> |
|
</td> |
|
</tr> |
|
</tbody> |
|
</table> |
|
</td> |
|
</tr> |
|
<tr> |
|
<td> |
|
<h1> |
|
DOCUMENTATION |
|
</h1> |
|
|
<h3> |
<table width="100%" style="padding-left: 10px;"> |
NetBSD pkgsrc |
<col width="40%"> |
</h3> |
<col width="60%"> |
|
<tbody> |
<p class="boxed"> |
<tr> |
# pkg_delete mdocml<br> |
<td><a href="mandoc.1.txt">mandoc(1)</a></td> |
# cd /usr/pkgsrc/devel/<br> |
<td>format and display UNIX manuals</td> |
# rm -rf mdocml<br> |
</tr> |
# ftp -V -o- http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz | tar -zvxf -<br> |
<tr> |
# cd mdocml<br> |
<td><a href="mandoc_char.7.txt">mandoc_char(7)</a></td> |
# make build<br> |
<td>mandoc special characters</td> |
# make install |
</tr> |
</p> |
<tr> |
|
<td><a href="mdoc.7.txt">mdoc(7)</a></td> |
|
<td>mdoc language reference</td> |
|
</tr> |
|
<tr> |
|
<td><a href="man.7.txt">man(7)</a></td> |
|
<td>man language reference</td> |
|
</tr> |
|
<tr> |
|
<td><a href="manuals.7.txt">manuals(7)</a></td> |
|
<td>a guide to writing UNIX manuals</td> |
|
</tr> |
|
<tr> |
|
<td><a href="mdoc.3.txt">mdoc(3)</a></td> |
|
<td>mdoc macro compiler library</td> |
|
</tr> |
|
<tr> |
|
<td><a href="man.3.txt">man(3)</a></td> |
|
<td>man macro compiler library</td> |
|
</tr> |
|
</tbody> |
|
</table> |
</td> |
</td> |
</tr> |
</tr> |
<tr> |
<tr> |
|
|
</h1> |
</h1> |
|
|
<p> |
<p> |
Please contact Kristaps, kris<a class="external" |
For all issues related to <span class="nm">mdocml</span>, contact Kristaps Džonsons, 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 <i>subscribe mdocml</i> (or <i>unsubscribe mdocml</i>). |
</p> |
</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> |