version 1.15, 2009/03/24 20:05:43 |
version 1.16, 2009/04/05 16:34:22 |
|
|
</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 of choice for BSD manual pages. The mission of <span class="nm">mdocml</span> is to deprecate |
of choice for BSD manual pages, and “-man”, the predominant historical package for UNIX |
<a href="http://www.gnu.org/software/groff/" class="external">groff</a>, the GNU roff implementation, |
manuals. The mission of <span class="nm">mdocml</span> is to deprecate <a |
for displaying -mdoc pages. |
href="http://www.gnu.org/software/groff/" class="external">groff</a>, the GNU roff implementation, for |
|
displaying <a href="mdoc.7.txt" class="man">mdoc(7)</a> pages whilst providing token support for <a |
|
href="man.7.txt" class="man">man(7)</a>. |
</p> |
</p> |
|
|
<p> |
<p> |
|
What are UNIX manuals? Read <a href="manuals.7.txt" class="man">manuals(7)</a> for an introduction. |
|
</p> |
|
|
|
<p> |
Why? groff amounts to over 5 MB of source code, most of which is C++ and all of which is GPL. It runs |
Why? groff amounts to over 5 MB of source code, most 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 |
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). |
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> are the <a href="man.3.txt" class="man">man(3)</a> and <a |
intermediate-form output from -mdoc input. libmdoc is a simple, fast library operating on memory |
href="mdoc.3.txt" class="man">mdoc(3)</a> libraries, validating compilers producing intermediate-form |
buffers, so it can be used for a variety of front-ends (terminal-based, CGI and so on). |
output from -man or -mdoc input. Both are simple, fast libraries operating on memory buffers, so they |
|
may be used for a variety of front-ends (terminal-based, CGI and so on). |
</p> |
</p> |
|
|
<p> |
<p> |
The primary front-end is <span class="man">mandoc(1)</span>, which formats -mdoc manuals for display on |
The primary front-end is <a href="mandoc.1.txt" class="man">mandoc(1)</a>, which formats manuals for |
the terminal. The <span class="man">mandoc(1)</span> utility is intended to deprecate usage of <a |
display on the terminal. Its purpose is to deprecate usage of groff for displaying -mdoc and, to a |
href="http://www.gnu.org/software/groff/" class="external">groff</a> for displaying mdoc manuals on the |
limited extent, -man manuals on the terminal. |
terminal. |
|
</p> |
</p> |
|
|
<p> |
<p> |
|
|
|
|
<p class="boxed"> |
<p class="boxed"> |
% cd /tmp<br> |
% cd /tmp<br> |
% ftp -V -o- http://mdocml.bsd.lv/snapshots/mdocml.tar.gz | tar -zvxf -<br> |
% ftp -V -o- <a href="http://mdocml.bsd.lv/snapshots/mdocml.tar.gz"> |
|
http://mdocml.bsd.lv/snapshots/mdocml.tar.gz</a> | tar -zvxf -<br> |
% cd mdocml<br> |
% cd mdocml<br> |
% make all<br> |
% make all<br> |
% make regress<br> |
% make regress<br> |
|
|
# pkg_delete mdocml<br> |
# pkg_delete mdocml<br> |
# cd /usr/ports/textproc/<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- <a href="http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz"> |
|
http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz</a> | tar -zvxf -<br> |
# cd mdocml<br> |
# cd mdocml<br> |
# make build<br> |
# make build<br> |
# make install |
# make install |
|
|
# pkg_delete mdocml<br> |
# pkg_delete mdocml<br> |
# cd /usr/pkgsrc/textproc/<br> |
# cd /usr/pkgsrc/textproc/<br> |
# rm -rf mdocml<br> |
# rm -rf mdocml<br> |
# ftp -V -o- http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz | tar -zvxf -<br> |
# ftp -V -o- <a href="http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz"> |
|
http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz</a> | tar -zvxf -<br> |
# cd mdocml<br> |
# cd mdocml<br> |
# make build<br> |
# make build<br> |
# make install |
# make install |
|
|
<p class="boxed"> |
<p class="boxed"> |
# pkg_delete -x mdocml<br> |
# pkg_delete -x mdocml<br> |
# cd /tmp<br> |
# cd /tmp<br> |
# ftp -V -o- http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz | tar -zvxf -<br> |
# ftp -V -o- <a href="http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz"> |
|
http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz</a> | tar -zvxf -<br> |
# cd mdocml<br> |
# cd mdocml<br> |
# make<br> |
# make<br> |
# make install |
# make install |