version 1.154.2.13, 2013/11/07 22:09:54 |
version 1.166, 2013/12/31 17:47:17 |
|
|
<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. |
It is small, ISO C, <A CLASS="external" HREF="http://www.isc.org/software/license">ISC</A>-licensed, and quite fast. |
It is small, ISO C, <A CLASS="external" HREF="https://www.isc.org/downloads/software-support-policy/isc-license/">ISC</A>-licensed, and quite fast. |
</P> |
</P> |
<P> |
<P> |
The tool set features <A HREF="mandoc.1.html">mandoc</A>, |
The tool set features <A HREF="mandoc.1.html">mandoc</A>, |
|
|
and is both an <A CLASS="external" HREF="http://www.openbsd.org/">OpenBSD</A> |
and is both an <A CLASS="external" HREF="http://www.openbsd.org/">OpenBSD</A> |
and a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project. |
and a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project. |
We strive to support all interested free operating systems, in particular |
We strive to support all interested free operating systems, in particular |
<A CLASS="external" HREF="http://www.netbsd.org/">NetBSD</A>, |
|
<A CLASS="external" HREF="http://www.dragonflybsd.org/">DragonFly</A>, |
<A CLASS="external" HREF="http://www.dragonflybsd.org/">DragonFly</A>, |
|
<A CLASS="external" HREF="http://www.netbsd.org/">NetBSD</A>, |
<A CLASS="external" HREF="http://www.freebsd.org/">FreeBSD</A>, |
<A CLASS="external" HREF="http://www.freebsd.org/">FreeBSD</A>, |
<A CLASS="external" HREF="http://www.minix3.org/">Minix 3</A>, |
<A CLASS="external" HREF="http://www.minix3.org/">Minix 3</A>, |
and <A CLASS="external" HREF="http://www.gnu.org/">GNU</A>/Linux, |
and <A CLASS="external" HREF="http://www.gnu.org/">GNU</A>/Linux, |
|
|
<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 |
|
|
<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> (1.12.3 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> (1.12.3 sources under active development 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://cvsweb.netbsd.org/bsdweb.cgi/pkgsrc/textproc/mdocml/" CLASS="external">textproc/mdocml</A> (1.12.3 port) |
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
|
|
</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 |
|
|
<A NAME="news">News</A> |
<A NAME="news">News</A> |
</H1> |
</H1> |
<P CLASS="news"> |
<P CLASS="news"> |
|
xx-xx-2014: version 1.13.0 |
|
</P> |
|
<P> |
|
The <A HREF="mandocdb.8.html">mandocdb</A> tools (<A HREF="mandocdb.8.html">mandocdb</A>, <A |
|
HREF="apropos.1.html">apropos</A> (absorbing whatis), and <A HREF="man.cgi.7.html">man.cgi</A>) have been re-written to |
|
use <A CLASS="external" HREF="http://www.sqlite.org">sqlite3</A> as a database. |
|
</P> |
|
<P CLASS="news"> |
|
31-12-2013: version 1.12.3 |
|
</P> |
|
<P> |
|
In the <A HREF="mdoc.7.html">mdoc(7)</A> SYNOPSIS, line breaks and hanging indentation |
|
now work correctly for .Fo/.Fa/.Fc and .Fn blocks. |
|
Thanks to Franco Fichtner for doing part of the work. |
|
</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"> |
05-10-2013: version 1.12.2 |
05-10-2013: version 1.12.2 |
</P> |
</P> |
<P> |
<P> |
|
|
<P> |
<P> |
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 CLASS="news"> |
|
23-03-2012: version 1.12.1 |
|
</P> |
|
<P> |
|
Significant work on <A HREF="apropos.1.html">apropos</A> and <A HREF="mandocdb.8.html">mandocdb</A>. These tools are |
|
now much more robust. |
|
A <A HREF="whatis.1.html">whatis</A> implementation is now handled as an <A HREF="apropos.1.html">apropos</A> mode. |
|
These tools are also able to minimally handle pre-formatted pages, that is, those already formatted by another utility |
|
such as GNU troff. |
|
</P> |
|
<P> |
|
The <A HREF="man.cgi.7.html">man.cgi</A> script is also now available for wider testing. It interfaces with <A |
|
HREF="mandocdb.8.html">mandocdb</A> manuals cached by <A HREF="catman.8.html">catman</A>. HTML output is generated |
|
on-the-fly by <A HREF="mandoc.3.html">libmandoc</A> or internal methods to convert pre-formatted pages. |
|
</P> |
|
<P> |
|
The mailing list archive for the discuss and tech lists are being hosted by <A CLASS="external" |
|
HREF="http://www.gmane.org">Gmane</A> at <A HREF="http://dir.gmane.org/gmane.comp.tools.mdocml.user" |
|
CLASS="external">gmane.comp.tools.mdocml.user</A> and <A HREF="http://dir.gmane.org/gmane.comp.tools.mdocml.devel" |
|
CLASS="external">gmane.comp.tools.mdocml.devel</A>, respectively. |
|
</P> |
|
<P> |
|
Lastly, I'm no longer providing binaries, as nobody has asked for them. |
|
</P> |
</P> |
<H2> |
<H2> |
<A>History</A> |
<A>History</A> |