1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
5 <meta name="resource-type" content="document">
6 <link rel="stylesheet" href="style.css" type="text/css" media="all">
7 <title>mdocml.bsd.lv</title>
16 <b>mdocml</b> – mdoc macro compiler
27 <span class="nm">mdocml</span> is a suite of tools that compile “mdoc”, the roff macro
28 package of the BSD manual pages. The mission of <span class="nm">mdocml</span> is to deprecate <a
29 href="http://www.gnu.org/software/groff/" class="external">groff</a>, the GNU roff implementation, for
30 displaying BSD mdoc pages. groff amounts to over 60 000 lines of GPL C++ source, which is a
31 considerable encumbrance to BSD operating systems.
35 The core of <span class="nm">mdocml</span> is the libmdoc library, a validating scanner-parser producing
36 intermediate-form output from mdoc input. libmdoc is a simple, fast library operating on memory buffers
37 of mdoc input. Its intermediate output, an abstract syntax tree, is fully documented in the <span
38 class="man">mdoc(3)</span> reference manual.
42 There are three utilities implementing <span class="man">mdoc(3)</span>:
46 <li><span class="man">mdocterm(1)</span> – formats mdoc input for display on the terminal
47 <li><span class="man">mdochtml(1)</span> – formats mdoc input as strict HTML (nascent)
48 <li><span class="man">mdoclint(1)</span> – validates mdoc input
49 <li><span class="man">mdoctree(1)</span> – prints input abstract syntax tree
53 The <span class="man">mdocterm(1)</span> utility is intended to deprecate usage of <a
54 href="http://www.gnu.org/software/groff/" class="external">groff</a> for displaying BSD manuals to the
55 terminal, either directly or cached as a “catman” page.
59 <span class="attn">Please submit patches!</span> Although a significant implementation exists, work
60 remains for the backend library and especially the front-end utilities. See the <a
61 href="#contact">contact</a> information below to submit patches and bug reports.
72 Sources correctly build and install on OpenBSD, NetBSD and Linux operating systems, tested variously on
73 i386, AMD64 and Alpha.
81 CVS sources are checkedout and snapshotted with big updates. These may be found in the <a
82 href="/snapshots/">/snapshots/</a> directory.
87 % ftp -V -o- http://mdocml.bsd.lv/snapshots/mdocml.tar.gz | tar -zvxf -<br>
99 The source snapshot is automatically converted into an OpenBSD port (ports for other BSD systems not
100 yet available). These may be found in the <a href="/ports-openbsd/">/ports-openbsd/</a> directory.
101 You <span class="emph">must</span> have the ports tree installed.
105 # pkg_delete mdocml<br>
106 # cd /usr/ports/devel/<br>
108 # ftp -V -o- http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz | tar -zvxf -<br>
123 Please contact Kristaps, kris<a class="external"
124 href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ=="
125 onclick="window.open('http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ==',
126 '', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=0,width=500,height=300'); return
127 false;" title="Reveal this e-mail address">...</a>@kth.se, with questions, bug reports, patches, and so on.
131 If you'd like to submit patches, please contact us beforehand in case larger changes are pending but not
132 checked in. If making a bug report, please make sure it's repeatable on the most current snapshot.
139 Copyright © 2009 Kristaps Džonsons, $Date: 2009/02/25 12:32:50 $