version 1.154.2.15, 2013/12/31 11:23:23 |
version 1.159, 2013/10/02 06:45:43 |
|
|
</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. |
UNIX manuals. The mission of <SPAN CLASS="nm">mdocml</SPAN> is to deprecate <A |
It is small, ISO C, <A CLASS="external" HREF="http://www.isc.org/software/license">ISC</A>-licensed, and quite fast. |
HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU troff implementation, for displaying <I>mdoc</I> |
|
pages whilst providing token support for <I>man</I>. |
</P> |
</P> |
<P> |
<P> |
The tool set features <A HREF="mandoc.1.html">mandoc</A>, |
Why? groff amounts to over 5 MB of source code, most of which is C++ and GPL version 3. It runs slowly, produces |
based on the <A HREF="mandoc.3.html">libmandoc</A> validating compiler, |
uncertain output, and varies in operation from system to system. mdocml strives to fix this (respectively small, C, <A |
to format output for UNIX terminals (with |
CLASS="external" HREF="http://www.isc.org/software/license">ISC</A>-licensed, fast and regular). |
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> has predominantly been developed on OpenBSD |
<SPAN CLASS="nm">mdocml</SPAN> consists of the <A HREF="mandoc.3.html">libmandoc</A> validating compiler and <A |
and is both an <A CLASS="external" HREF="http://www.openbsd.org/">OpenBSD</A> |
HREF="mandoc.1.html">mandoc</A>, which interfaces with the compiler library to format output for UNIX terminals (with |
and a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project. |
support for wide-character locales), XHTML, HTML, PostScript, and PDF. |
We strive to support all interested free operating systems, in particular |
It also includes <A HREF="preconv.1.html">preconv</A> for recoding multibyte manuals, |
<A CLASS="external" HREF="http://www.dragonflybsd.org/">DragonFly</A>, |
<A HREF="demandoc.1.html">demandoc</A> for emitting only text parts of manuals, |
<A CLASS="external" HREF="http://www.netbsd.org/">NetBSD</A>, |
<A HREF="mandocdb.8.html">mandocdb</A> for indexing manuals, |
<A CLASS="external" HREF="http://www.freebsd.org/">FreeBSD</A>, |
<A HREF="apropos.1.html">apropos</A> (includes whatis mode) for indexed manual search, and |
<A CLASS="external" HREF="http://www.minix3.org/">Minix 3</A>, |
<A HREF="man.cgi.7.html">man.cgi</A> for indexed manual search online. |
and <A CLASS="external" HREF="http://www.gnu.org/">GNU</A>/Linux, |
It is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project. |
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>. |
|
|
<A NAME="sources">Sources</A> |
<A NAME="sources">Sources</A> |
</H2> |
</H2> |
<P> |
<P> |
<SPAN CLASS="nm">mdocml</SPAN> should build and run on any modern system with |
<SPAN CLASS="nm">mdocml</SPAN> is in ISO C99 and should build and run on any modern system; however, you'll need <A |
<A HREF="http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html">libdb</A> |
HREF="http://www.sqlite.org">sqlite3</A> to build <A HREF="apropos.1.html">apropos</A> (links to whatis), |
(this is installed by default on BSD UNIX systems — see the <I>Makefile</I> if you're running Linux). |
<A HREF="man.cgi.7.html">man.cgi</A>, and <A HREF="mandocdb.8.html">mandocdb</A>. |
To build and install into <I>/usr/local/</I>, just run <CODE>make install</CODE>. |
To build and install into <I>/usr/local/</I>, just run <CODE>make install</CODE>. |
Be careful: the <B>preconv</B>, <B>apropos</B>, and <B>whatis</B> installed binary names |
Be careful: the <B>preconv</B>, <B>apropos</B>, and <B>whatis</B> binary names are usually taken by existing utilities. |
may be taken by existing utilities. |
|
</P> |
</P> |
<H2> |
<H2> |
Downstream |
Downstream |
|
|
<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>, so please <A HREF="#contact">contact us</A> if you plan on maintaining a downstream version! |
<Q>official</Q>. |
|
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.3 sources) |
<A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/contrib/mdocml" CLASS="external">contrib/mdocml</A> (1.12.1 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.2 port) |
<A HREF="http://svnweb.freebsd.org/ports/textproc/mdocml/" CLASS="external">ports/textproc/mdocml</A> (1.12.1 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.3 sources under active development and build system) |
<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) |
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD>pkgsrc</TD> |
<TD>pkgsrc</TD> |
<TD> |
<TD> |
<A HREF="http://pkgsrc.se/textproc/mdocml" CLASS="external">textproc/mdocml</A> (1.12.2 port) |
<A HREF="http://pkgsrc.se/textproc/mdocml" CLASS="external">textproc/mdocml</A> (1.12.0 port) |
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
|
|
<A HREF="http://git.minix3.org/?p=minix.git;a=tree;f=external/bsd/mdocml" CLASS="external">external/bsd/mdocml</A> (1.10.9 sources and build system) |
<A HREF="http://git.minix3.org/?p=minix.git;a=tree;f=external/bsd/mdocml" CLASS="external">external/bsd/mdocml</A> (1.10.9 sources and build system) |
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
|
<TD>Alpine Linux</TD> |
|
<TD> |
|
<A HREF="http://git.alpinelinux.org/cgit/aports/tree/main/mdocml" CLASS="external">aports/main/mdocml</A> (1.12.2 port) |
|
</TD> |
|
</TR> |
|
</TBODY> |
</TBODY> |
</TABLE> |
</TABLE> |
<H1> |
<H1> |
|
|
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD VALIGN="top"><A HREF="whatis.1.html">whatis(1)</A></TD> |
|
<TD VALIGN="top"> |
|
search the manual page database |
|
</TD> |
|
</TR> |
|
<TR> |
|
<TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD> |
<TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD> |
<TD VALIGN="top"> |
<TD VALIGN="top"> |
mandoc macro compiler library |
mandoc macro compiler library |
|
|
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD VALIGN="top"><A HREF="catman.8.html">catman(8)</A></TD> |
|
<TD VALIGN="top"> |
|
update a man.cgi manpage cache |
|
</TD> |
|
</TR> |
|
<TR> |
|
<TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD> |
<TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD> |
<TD VALIGN="top"> |
<TD VALIGN="top"> |
index UNIX manuals |
index UNIX manuals |
|
|
</TR> |
</TR> |
</TBODY> |
</TBODY> |
</TABLE> |
</TABLE> |
<H2> |
|
<A NAME="links">Supplementary Information</A> |
|
</H2> |
|
<UL> |
|
<LI> |
|
<A HREF="http://manpages.bsd.lv/">Practical UNIX Manuals</A>: mdoc tutorial by Kristaps Dzonsons |
|
</LI> |
|
<LI> |
|
<A HREF="http://www.openbsd.org/faq/ports/specialtopics.html#Mandoc" CLASS="external">OpenBSD porting guide</A> |
|
chapter regarding manual pages |
|
</LI> |
|
<LI> |
|
<A HREF="press.html">Publications and media coverage</A> |
|
concerning mdocml and mandoc |
|
</LI> |
|
<LI> |
|
<A HREF="http://manpages.bsd.lv/history.html">History of UNIX Manpages</A>: a comprehensive overview by Kristaps Dzonsons |
|
</LI> |
|
</UL> |
|
<H1> |
<H1> |
<A NAME="contact">Contact</A> |
<A NAME="contact">Contact</A> |
</H1> |
</H1> |
|
|
<A NAME="news">News</A> |
<A NAME="news">News</A> |
</H1> |
</H1> |
<P CLASS="news"> |
<P CLASS="news"> |
31-12-2013: version 1.12.3 |
xx-xx-2013: version 1.13.0 |
</P> |
</P> |
<P> |
<P> |
In the <A HREF="mdoc.7.html">mdoc(7)</A> SYNOPSIS, line breaks and hanging indentation |
The <A HREF="mandocdb.8.html">mandocdb</A> tools (<A HREF="mandocdb.8.html">mandocdb</A>, <A |
now work correctly for .Fo/.Fa/.Fc and .Fn blocks. |
HREF="apropos.1.html">apropos</A> (absorbing whatis), and <A HREF="man.cgi.7.html">man.cgi</A>) have been re-written to |
Thanks to Franco Fichtner for doing part of the work. |
use <A CLASS="external" HREF="http://www.sqlite.org">sqlite3</A> as a database. |
</P> |
</P> |
<P> |
|
The <A HREF="mdoc.7.html">mdoc(7)</A> .Bk macro got some addititonal bugfixes. |
|
</P> |
|
<P> |
|
In <A HREF="mdoc.7.html">mdoc(7)</A> macro arguments, double quotes can now be quoted |
|
by doubling them, just like in <A HREF="man.7.html">man(7)</A>. |
|
Thanks to Tsugutomo ENAMI for the patch. |
|
</P> |
|
<P> |
|
At the end of <A HREF="man.7.html">man(7)</A> macro lines, end-of-sentence spacing |
|
now works. Thanks to Franco Fichtner for the patch. |
|
</P> |
|
<P> |
|
For backward compatibility, the <A HREF="man.7.html">man(7)</A> parser now supports the |
|
man-ext .UR/.UE (uniform resource identifier) block macros. |
|
</P> |
|
<P> |
|
The <A HREF="man.7.html">man(7)</A> parser now handles closing blocks that are not open |
|
more gracefully. |
|
</P> |
|
<P> |
|
The <A HREF="man.7.html">man(7)</A> parser now ignores blank lines right after .SH and .SS. |
|
</P> |
|
<P> |
|
In the <A HREF="man.7.html">man(7)</A> formatter, reset indentation when leaving a block, |
|
not just when entering the next one. |
|
</P> |
|
<P> |
|
The <A HREF="roff.7.html">roff(7)</A> .nr request now supports incrementing and decrementing |
|
number registers and stops parsing the number right before the first non-digit character. |
|
</P> |
|
<P> |
|
The <A HREF="roff.7.html">roff(7)</A> parser now supports the alternative escape sequence |
|
syntax \C'uXXXX' for Unicode characters. |
|
</P> |
|
<P> |
|
The <A HREF="roff.7.html">roff(7)</A> parser now parses and ignores the .fam (font family) |
|
and .hw (hyphenation points) requests and the \d and \u escape sequences. |
|
</P> |
|
<P> |
|
The <A HREF="roff.7.html">roff(7)</A> manual got a new ESCAPE SEQUENCE REFERENCE. |
|
</P> |
|
<P CLASS="news"> |
<P CLASS="news"> |
05-10-2013: version 1.12.2 |
01-10-2013: version 1.12.2 |
</P> |
</P> |
<P> |
<P> |
The <A HREF="mdoc.7.html">mdoc(7)</A> to <A HREF="man.7.html">man(7)</A> converter, |
The <A HREF="mdoc.7.html">mdoc(7)</A> to <A HREF="man.7.html">man(7)</A> converter, |
|
|
For mandoc developers, we now provide a <A HREF="tbl.3.html">tbl(3)</A> library manual and <CODE>gmdiff</CODE>, |
For mandoc developers, we now provide a <A HREF="tbl.3.html">tbl(3)</A> library manual and <CODE>gmdiff</CODE>, |
a very small, very simplistic groff-versus-mandoc output comparison tool. |
a very small, very simplistic groff-versus-mandoc output comparison tool. |
</P> |
</P> |
<H2> |
<P CLASS="news"> |
<A>History</A> |
23-03-2011: version 1.12.1 |
</H2> |
</P> |
<UL> |
<P> |
<LI> |
Significant work on <A HREF="apropos.1.html">apropos</A> and <A HREF="mandocdb.8.html">mandocdb</A>. These tools are |
<A HREF="NEWS">Release notes</A> going back to release 1.9.15, February 18, 2010. |
now much more robust. |
Briefly explaining the most important changes in each release in relatively easy terms. |
A <A HREF="whatis.1.html">whatis</A> implementation is now handled as an <A HREF="apropos.1.html">apropos</A> mode. |
Very many changes are not mentioned here. |
These tools are also able to minimally handle pre-formatted pages, that is, those already formatted by another utility |
</LI> |
such as GNU troff. |
<LI> |
</P> |
<A HREF="history.html">Development history</A> going back to the beginning of the project, November 22, 2008. |
<P> |
One-line entries for important commits, releases, merges, hackathons and talks. |
The <A HREF="man.cgi.7.html">man.cgi</A> script is also now available for wider testing. It interfaces with <A |
Makes it easy to find out who did what, and when, and when it became available where. |
HREF="mandocdb.8.html">mandocdb</A> manuals cached by <A HREF="catman.8.html">catman</A>. HTML output is generated |
However, this is still incomplete, mentioning only a small fraction of all commits, |
on-the-fly by <A HREF="mandoc.3.html">libmandoc</A> or internal methods to convert pre-formatted pages. |
and to keep the size down, the individual entries are extremely terse and technical. |
</P> |
Feel free to look up more details and longer explanations about individual entries |
<P> |
in the ChangeLog or in CVS. |
The mailing list archive for the discuss and tech lists are being hosted by <A CLASS="external" |
</LI> |
HREF="http://www.gmane.org">Gmane</A> at <A HREF="http://dir.gmane.org/gmane.comp.tools.mdocml.user" |
<LI> |
CLASS="external">gmane.comp.tools.mdocml.user</A> and <A HREF="http://dir.gmane.org/gmane.comp.tools.mdocml.devel" |
<A HREF="ChangeLog">CVS ChangeLog</A> going back to the beginning of the project. |
CLASS="external">gmane.comp.tools.mdocml.devel</A>, respectively. |
Very technical information of varying quality, strictly chronological. |
</P> |
All commits are mentioned, but some messages neglect to mention some changes. |
<P> |
Partly terse, partly detailed and verbose. In any case, the ChangeLog is very long - |
Lastly, I'm no longer providing binaries, as nobody has asked for them. |
more than 25,000 lines, more than 700 kB. |
</P> |
</LI> |
<P> |
<LI> |
See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for |
<A HREF="/cgi-bin/cvsweb/?cvsroot=mdocml">CVS</A> web interface, going back to the beginning of the project. |
historical notes. |
Source code, diffs and commit messages for each source file. The real thing. |
</P> |
</LI> |
|
</UL> |
|
<P CLASS="foot"> |
<P CLASS="foot"> |
<SMALL> |
<SMALL> |
Copyright © 2008–2011 |
Copyright © 2008–2011 |