| version 1.11, 2009/03/21 09:50:07 |
version 1.17, 2009/06/11 13:34:14 |
|
|
| </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 for BSD manual pages. The mission of <span class="nm">mdocml</span> is to deprecate <a |
of choice for BSD manual pages, and “-man”, the predominant historical package for UNIX |
| |
manuals. 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 <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> |
| Why? groff amounts to roughly 5,2 MB of source code (OpenBSD 4.2), some of which is C++ and all of |
What are UNIX manuals? Read <a href="manuals.7.txt" class="man">manuals(7)</a> for an introduction. |
| 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> |
| |
|
| <p> |
<p> |
| The core of <span class="nm">mdocml</span> is the libmdoc library, a validating scanner-parser producing |
Why? groff amounts to over 5 MB of source code, most of which is C++ and all of which is GPL. It runs |
| intermediate-form output from mdoc input. libmdoc is a simple, fast library operating on memory buffers |
slowly, produces uncertain output, and varies in operation from system to system. mdocml strives to fix |
| of mdoc input. Its intermediate output, an abstract syntax tree, is fully documented in the <span |
this (respectively small, C, ISC-licensed, fast and regular). |
| class="man">mdoc(3)</span> reference manual. |
|
| </p> |
</p> |
| |
|
| <p> |
<p> |
| There are three utilities implementing <span class="man">mdoc(3)</span>: |
The core of <span class="nm">mdocml</span> are the <a href="man.3.txt" class="man">man(3)</a> and <a |
| |
href="mdoc.3.txt" class="man">mdoc(3)</a> libraries, validating compilers producing intermediate-form |
| |
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> |
| |
|
| <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 |
The primary front-end is <a href="mandoc.1.txt" class="man">mandoc(1)</a>, which formats manuals for |
| href="http://www.gnu.org/software/groff/" class="external">groff</a> for displaying BSD manuals to the |
display on the terminal. Its purpose is to deprecate usage of groff for displaying -mdoc and, to a |
| terminal, either directly or cached as a “catman” page. |
limited extent, -man manuals on the terminal. |
| </p> |
</p> |
| |
|
| <p> |
<p> |
| <span class="attn">Please submit patches!</span> Although a significant implementation exists, work |
<span class="attn">Please submit patches, bug reports and suggestions!</span> Although a significant |
| remains for the backend library and especially the front-end utilities. See the <a |
implementation exists, work remains for the backend library and especially the front-end utilities. See |
| href="#contact">contact</a> information below to submit patches and bug reports. |
the <a href="#contact">contact</a> information below for submissions. |
| </p> |
</p> |
| </td> |
</td> |
| </tr> |
</tr> |
|
|
| </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> |
| The most current version is <span class="attn">@VERSION@</span>, dated |
The most current version is <span class="attn">@VERSION@</span>, dated |
| <span class="attn">@VDATE@</span>. |
<span class="attn">@VDATE@</span>. |
| </p> |
</p> |
| |
|
| <h2> |
<h2> |
|
|
| |
|
| <p> |
<p> |
| CVS sources are checkedout and snapshotted with version updates. 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. A full <a href="/snapshots/ChangeLog">ChangeLog</a> is |
| |
written with each new snapshot. |
| </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 install |
# make install |
| </p> |
</p> |
| |
|
|
|
| </h2> |
</h2> |
| |
|
| <p> |
<p> |
| The source snapshot is automatically converted into OpenBSD port and NetBSD pkgsrc forms at <a |
The source snapshot is automatically converted into OpenBSD, NetBSD and FreeBSD ports at <a |
| href="/ports-openbsd/">/ports-openbsd/</a> and <a href="/ports-netbsd/">/ports-netbsd/</a>, |
href="/ports-openbsd/">/ports-openbsd/</a>, <a href="/ports-netbsd/">/ports-netbsd/</a> and <a |
| respectively. Please read the <a href="http://www.openbsd.org/faq/faq15.html">OpenBSD Ports FAQ</a> or |
href="/ports-freebsd/">/ports-freebsd/</a>, respectively. Please read the <a class="external" |
| <a href="http://www.netbsd.org/docs/software/packages.html">NetBSD pkgsrc guide</a>, first. |
href="http://www.openbsd.org/faq/faq15.html">OpenBSD Ports FAQ</a>, the <a class="external" |
| |
href="http://www.netbsd.org/docs/software/packages.html">NetBSD pkgsrc guide</a> or the <a |
| |
class="external" |
| |
href="http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ports-using.html">FreeBSD ports |
| |
guide</a>, first. |
| </p> |
</p> |
| |
|
| <h3> |
<h3> |
|
|
| # 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> |
</p> |
| |
|
| |
<h3> |
| |
FreeBSD port |
| |
</h3> |
| |
|
| |
<p class="boxed"> |
| |
# pkg_delete -x mdocml<br> |
| |
# cd /tmp<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> |
| |
# make<br> |
| |
# make install |
| |
</p> |
| </td> |
</td> |
| </tr> |
</tr> |
| <tr> |
<tr> |
|
|
| href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ==" |
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==', |
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 |
'', '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. |
false;" title="Reveal this e-mail address">...</a>@kth.se, with questions, bug reports, patches, and so |
| |
on. |
| </p> |
</p> |
| |
|
| <p> |
<p> |
|
|
| <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> |
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to index.sgml CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc