version 1.163, 2013/10/13 18:34:51 |
version 1.164, 2013/12/26 14:39:35 |
|
|
</HEAD> |
</HEAD> |
<BODY> |
<BODY> |
<P CLASS="head"> |
<P CLASS="head"> |
|
<A HREF="http://www.openbsd.org/"><IMG SRC="puffy.gif" ALT="Puffy" WIDTH="100" HEIGHT="91" STYLE="float: right"></A> |
<B>mdocml</B> – UNIX manpage compiler, current version @VERSION@ (@VDATE@) |
<B>mdocml</B> – UNIX manpage compiler, current version @VERSION@ (@VDATE@) |
</P> |
</P> |
<P CLASS="subhead"> |
<P CLASS="subhead"> |
|
|
<P> |
<P> |
<SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <I><A HREF="mdoc.7.html">mdoc</A></I>, the roff macro |
<SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <I><A HREF="mdoc.7.html">mdoc</A></I>, the roff macro |
package of choice for BSD manual pages, and <I><A HREF="man.7.html">man</A></I>, the predominant historical package for |
package of choice for BSD manual pages, and <I><A HREF="man.7.html">man</A></I>, the predominant historical package for |
UNIX manuals. The mission of <SPAN CLASS="nm">mdocml</SPAN> is to deprecate <A |
UNIX manuals. |
HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU troff implementation, for displaying <I>mdoc</I> |
It is small, ISO C, <A CLASS="external" HREF="http://www.isc.org/software/license">ISC</A>-licensed, and quite fast. |
pages whilst providing token support for <I>man</I>. |
|
</P> |
</P> |
<P> |
<P> |
Why? groff amounts to over 5 MB of source code, most of which is C++ and GPL version 3. It runs slowly, produces |
The tool set features <A HREF="mandoc.1.html">mandoc</A>, |
uncertain output, and varies in operation from system to system. mdocml strives to fix this (respectively small, C, <A |
based on the <A HREF="mandoc.3.html">libmandoc</A> validating compiler, |
CLASS="external" HREF="http://www.isc.org/software/license">ISC</A>-licensed, fast and regular). |
to format output for UNIX terminals (with |
|
support for wide-character locales), XHTML, HTML, PostScript, and PDF. |
|
It also includes <A HREF="preconv.1.html">preconv</A>, for recoding multibyte manuals; |
|
<A HREF="demandoc.1.html">demandoc</A>, for emitting only text parts of manuals; |
|
<A HREF="mandocdb.8.html">mandocdb</A>, for indexing manuals; and |
|
<A HREF="apropos.1.html">apropos</A>, <A HREF="whatis.1.html">whatis</A>, and |
|
<A HREF="man.cgi.7.html">man.cgi</A> (via <A HREF="catman.8.html">catman</A>) for semantic search of manual content. |
</P> |
</P> |
<P> |
<P> |
<SPAN CLASS="nm">mdocml</SPAN> consists of the <A HREF="mandoc.3.html">libmandoc</A> validating compiler and <A |
<SPAN CLASS="nm">mdocml</SPAN> has predominantly been developed on OpenBSD |
HREF="mandoc.1.html">mandoc</A>, which interfaces with the compiler library to format output for UNIX terminals (with |
and is both an <A CLASS="external" HREF="http://www.openbsd.org/">OpenBSD</A> |
support for wide-character locales), XHTML, HTML, PostScript, and PDF. |
and a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project. |
It also includes <A HREF="preconv.1.html">preconv</A> for recoding multibyte manuals, |
We strive to support all interested free operating systems, in particular |
<A HREF="demandoc.1.html">demandoc</A> for emitting only text parts of manuals, |
<A CLASS="external" HREF="http://www.dragonflybsd.org/">DragonFly</A>, |
<A HREF="mandocdb.8.html">mandocdb</A> for indexing manuals, |
<A CLASS="external" HREF="http://www.netbsd.org/">NetBSD</A>, |
<A HREF="apropos.1.html">apropos</A> (includes whatis mode) for indexed manual search, and |
<A CLASS="external" HREF="http://www.freebsd.org/">FreeBSD</A>, |
<A HREF="man.cgi.7.html">man.cgi</A> for indexed manual search online. |
<A CLASS="external" HREF="http://www.minix3.org/">Minix 3</A>, |
It is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project. |
and <A CLASS="external" HREF="http://www.gnu.org/">GNU</A>/Linux, |
|
as well as all systems running the <A CLASS="external" HREF="http://www.pkgsrc.org/">pkgsrc</A> portable package build system. |
|
All of these projects have helped to make <SPAN CLASS="nm">mdocml</SPAN> better, by providing feedback and advice, |
|
bug reports, and patches. |
</P> |
</P> |
<P> |
<P> |
<I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, <Q>mandoc</Q>. |
<I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, <Q>mandoc</Q>. |
|
|
<P> |
<P> |
Several systems come bundled with <SPAN CLASS="nm">mdocml</SPAN> utilities. |
Several systems come bundled with <SPAN CLASS="nm">mdocml</SPAN> utilities. |
If your system does not appear below, the maintainers have not contacted me and it should not be considered |
If your system does not appear below, the maintainers have not contacted me and it should not be considered |
<Q>official</Q>. |
<Q>official</Q>, so please <A HREF="#contact">contact us</A> if you plan on maintaining a downstream version! |
Please <A HREF="#contact">contact us</A> if you plan on maintaining a downstream version! |
|
</P> |
</P> |
<TABLE WIDTH="100%" SUMMARY="Downstream Sources"> |
<TABLE WIDTH="100%" SUMMARY="Downstream Sources"> |
<COL WIDTH="175"> |
<COL WIDTH="175"> |
|
|
<TR> |
<TR> |
<TD>DragonFly BSD</TD> |
<TD>DragonFly BSD</TD> |
<TD> |
<TD> |
<A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/contrib/mdocml" CLASS="external">contrib/mdocml</A> (1.12.2 sources) |
<A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/contrib/mdocml" CLASS="external">contrib/mdocml</A> (post-1.12.2 sources) |
<A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/lib/libmandoc" CLASS="external">lib/libmandoc</A> |
<A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/lib/libmandoc" CLASS="external">lib/libmandoc</A> |
<A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc" CLASS="external">usr.bin/mandoc</A> (build system) |
<A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc" CLASS="external">usr.bin/mandoc</A> (build system) |
</TD> |
</TD> |
|
|
<TR> |
<TR> |
<TD>FreeBSD 9.x, 8.x</TD> |
<TD>FreeBSD 9.x, 8.x</TD> |
<TD> |
<TD> |
<A HREF="http://svnweb.freebsd.org/ports/head/textproc/mdocml/" CLASS="external">ports/textproc/mdocml</A> (1.12.1 port) |
<A HREF="http://svnweb.freebsd.org/ports/head/textproc/mdocml/" CLASS="external">ports/textproc/mdocml</A> (1.12.2 port) |
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
|
|
<TR> |
<TR> |
<TD>OpenBSD</TD> |
<TD>OpenBSD</TD> |
<TD> |
<TD> |
<A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/" CLASS="external">src/usr.bin/mandoc</A> (1.12.2 sources and build system) |
<A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/" CLASS="external">src/usr.bin/mandoc</A> (post-1.12.2 sources under active development and build system) |
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |