| version 1.8, 2009/02/25 12:46:27 |
version 1.12, 2009/03/23 21:46:04 |
|
|
| </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 systems. |
|
| </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> |
|
|
| </p> |
</p> |
| |
|
| <h2> |
<h2> |
| snapshotted source |
Snapshot source |
| </h2> |
</h2> |
| |
|
| <p> |
<p> |
| CVS sources are checkedout and snapshotted with big 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. |
| </p> |
</p> |
| |
|
|
|
| </p> |
</p> |
| |
|
| <h2> |
<h2> |
| nightly 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 |
| |
</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 |
# make install |
| </p> |
</p> |
| </td> |
</td> |
![[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