<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="resource-type" content="document">
<link rel="stylesheet" href="style.css" type="text/css" media="all">
<title>mdocml.bsd.lv</title>
</head>
<body>
<table width="600">
<col width="100%">
<tbody>
<tr>
<td>
<div class="head">
<b>mdocml</b> – mdoc macro compiler
</div>
</td>
</tr>
<tr>
<td valign="top">
<h1>
DESCRIPTION
</h1>
<p>
<span class="nm">mdocml</span> is a suite of tools compiling “mdoc”, the roff macro
package for BSD manual pages. 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
displaying BSD mdoc pages.
</p>
<p>
Why? groff amounts to roughly 5,2 MB of source code (OpenBSD 4.2), some 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 this (respectively small, C, ISC-licensed, fast and regular).
</p>
<p>
The core of <span class="nm">mdocml</span> is the libmdoc library, a validating scanner-parser producing
intermediate-form output from mdoc input. libmdoc is a simple, fast library operating on memory buffers
of mdoc input. Its intermediate output, an abstract syntax tree, is fully documented in the <span
class="man">mdoc(3)</span> reference manual.
</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>
</tr>
<tr>
<td>
<h1>
INSTALLING SOURCES
</h1>
<p>
Sources correctly build and install on OpenBSD, NetBSD and Linux operating systems, tested variously on
i386, AMD64 and Alpha.
</p>
<p>
The most current version is <span class="attn">@VERSION@</span>, dated
<span class="attn">@VDATE@</span>.
</p>
<h2>
Snapshot source
</h2>
<p>
CVS sources are checkedout and snapshotted with version updates. These may be found in the <a
href="/snapshots/">/snapshots/</a> directory.
</p>
<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>
Snapshot port/pkgsrc
</h2>
<p>
The source snapshot is automatically converted into OpenBSD port and NetBSD pkgsrc forms at <a
href="/ports-openbsd/">/ports-openbsd/</a> and <a href="/ports-netbsd/">/ports-netbsd/</a>,
respectively. Please read the <a href="http://www.openbsd.org/faq/faq15.html">OpenBSD Ports FAQ</a> or
<a href="http://www.netbsd.org/docs/software/packages.html">NetBSD pkgsrc guide</a>, first.
</p>
<h3>
OpenBSD port
</h3>
<p class="boxed">
# pkg_delete mdocml<br>
# cd /usr/ports/textproc/<br>
# rm -rf mdocml<br>
# ftp -V -o- http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz | tar -zvxf -<br>
# cd mdocml<br>
# make build<br>
# make install
</p>
<h3>
NetBSD pkgsrc
</h3>
<p class="boxed">
# pkg_delete mdocml<br>
# cd /usr/pkgsrc/textproc/<br>
# rm -rf mdocml<br>
# ftp -V -o- http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz | tar -zvxf -<br>
# cd mdocml<br>
# make build<br>
# make install
</p>
</td>
</tr>
<tr>
<td>
<h1>
CONTACT
</h1>
<p>
Please contact Kristaps, kris<a class="external"
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==',
'', '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.
</p>
<p>
If you'd like to submit patches, please contact us beforehand in case larger changes are pending but not
checked in. If making a bug report, please make sure it's repeatable on the most current snapshot.
</p>
</td>
</tr>
<tr>
<td>
<div class="foot">
Copyright © 2009 Kristaps Džonsons, $Date$
</div>
</td>
</tr>
</tbody>
</table>
</body>
</html>
