version 1.9, 2009/02/27 10:55:16 |
version 1.13, 2009/03/24 10:28: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 for BSD manual pages. The mission of <span class="nm">mdocml</span> is to deprecate <a |
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 |
href="http://www.gnu.org/software/groff/" class="external">groff</a>, the GNU roff implementation, for |
displaying BSD mdoc pages. |
displaying BSD mdoc pages. |
</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 the libmdoc library, a validating scanner-parser producing |
intermediate-form output from mdoc input. libmdoc is a simple, fast library operating on memory buffers |
intermediate-form output from -mdoc input. libmdoc is a simple, fast library operating on memory |
of mdoc input. Its intermediate output, an abstract syntax tree, is fully documented in the <span |
buffers, so it can be used for a variety of front-ends (terminal-based, CGI and so on). The primary |
class="man">mdoc(3)</span> reference manual. |
front-end is <span class="man">mandoc(1)</span>, which formats -mdoc manuals for display on the |
|
terminal. |
</p> |
</p> |
|
|
<p> |
<p> |
There are three utilities implementing <span class="man">mdoc(3)</span>: |
The <span class="man">mandoc(1)</span> utility is intended to deprecate usage of <a |
|
href="http://www.gnu.org/software/groff/" class="external">groff</a> for displaying mdoc manuals 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 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> |
<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 |
<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 |
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. |
href="#contact">contact</a> information below to submit patches and bug reports. |
|
|
</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. |
</p> |
</p> |
|
|
<p> |
<p> |
|
|
</p> |
</p> |
|
|
<h2> |
<h2> |
Snapshot port |
Snapshot port/pkgsrc |
</h2> |
</h2> |
|
|
<p> |
<p> |
The source 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 |
You <span class="emph">must</span> have the ports tree installed. |
href="/ports-freebsd/">/ports-freebsd/</a>, respectively. Please read the <a |
|
href="http://www.openbsd.org/faq/faq15.html">OpenBSD Ports FAQ</a>, <a |
|
href="http://www.netbsd.org/docs/software/packages.html">NetBSD pkgsrc guide</a> or <a |
|
href="http://www.freebsd.org/ports/">FreeBSD Ports Guide</a> first. |
</p> |
</p> |
|
|
|
<h3> |
|
OpenBSD port |
|
</h3> |
|
|
<p class="boxed"> |
<p class="boxed"> |
# pkg_delete mdocml<br> |
# pkg_delete mdocml<br> |
# cd /usr/ports/devel/<br> |
# cd /usr/ports/textproc/<br> |
# rm -rf mdocml<br> |
# rm -rf mdocml<br> |
# ftp -V -o- http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz | tar -zvxf -<br> |
# ftp -V -o- http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz | tar -zvxf -<br> |
# cd mdocml<br> |
# cd mdocml<br> |
# make build<br> |
# make build<br> |
# make regress<br> |
|
# make install |
# make install |
</p> |
</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> |
|
|
|
<h3> |
|
FreeBSD 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-freebsd/mdocml.tar.gz | tar -zvxf -<br> |
|
# cd mdocml<br> |
|
# make build<br> |
|
# make install |
|
</p> |
</td> |
</td> |
</tr> |
</tr> |
<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> |