version 1.2, 2009/02/23 15:38:20 |
version 1.11, 2009/03/21 09:50:07 |
|
|
</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 of the 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. groff amounts to over 60 000 lines of GPL C++ source, which is a |
displaying BSD mdoc pages. |
considerable encumbrance to BSD operating system. |
|
</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 |
|
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 |
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 buffers |
of mdoc input. Its intermediate output, an abstract syntax tree, is fully documented in the <span |
of mdoc input. Its intermediate output, an abstract syntax tree, is fully documented in the <span |
|
|
|
|
<ul> |
<ul> |
<li><span class="man">mdocterm(1)</span> – formats mdoc input for display on the terminal |
<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">mdochtml(1)</span> – formats mdoc input as HTML/CSS (nascent) |
<li><span class="man">mdoclint(1)</span> – validates mdoc input |
<li><span class="man">mdoclint(1)</span> – validates mdoc input |
<li><span class="man">mdoctree(1)</span> – prints input abstract syntax tree |
<li><span class="man">mdoctree(1)</span> – prints input abstract syntax tree |
</ul> |
</ul> |
|
|
i386, AMD64 and Alpha. |
i386, AMD64 and Alpha. |
</p> |
</p> |
|
|
|
<p> |
|
The most current version is <span class="attn">@VERSION@</span>, dated |
|
<span class="attn">@VDATE@</span>. |
|
</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 may be found in the <a |
href="/snapshots/">/snapshots/</a> directory. |
href="/snapshots/">/snapshots/</a> directory. |
</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- http://mdocml.bsd.lv/snapshots/mdocml.tar.gz | tar -zvxf -<br> |
% cd mdocml<br> |
% cd mdocml<br> |
% make<br> |
% make all<br> |
% make regress<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 port and NetBSD pkgsrc forms at <a |
yet available). These may be found in the <a href="/ports-openbsd/">/ports-openbsd/</a> directory. |
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> |
</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- http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz | tar -zvxf -<br> |
|
# cd mdocml<br> |
|
# make build<br> |
|
# make install |
</p> |
</p> |
|
|
<p> |
<h3> |
Subsequent installations: |
NetBSD pkgsrc |
</p> |
</h3> |
|
|
<p class="boxed"> |
<p class="boxed"> |
% sudo pkg_add -r mdocml |
# 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> |
</p> |
</td> |
</td> |
</tr> |
</tr> |