version 1.134, 2011/08/16 12:13:27 |
version 1.138, 2011/09/01 10:46:28 |
|
|
</HEAD> |
</HEAD> |
<BODY> |
<BODY> |
<P CLASS="head"> |
<P CLASS="head"> |
<B>mdocml</B> – mdoc macro compiler |
<B>mdocml</B> – mdoc macro compiler, current version @VERSION@ (@VDATE@) |
</P> |
</P> |
|
<P CLASS="subhead"> |
|
Sources: <A HREF="/snapshots/mdocml.tar.gz">current</A>, |
|
<A HREF="/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A> |
|
(<A HREF="/snapshots/">archives</A>) |
|
| |
|
Binaries: <A |
|
HREF="/binaries/mdocml-win32.zip">windows 32-bit</A>, <A |
|
HREF="/binaries/mdocml-win64.zip">windows 64-bit</A>, <A |
|
HREF="/binaries/mdocml-macosx.zip">mac os x</A> |
|
(<A HREF="/binaries/">archives</A>) |
|
</P> |
<H1> |
<H1> |
<A NAME="description">Description</A> |
<A NAME="description">Description</A> |
</H1> |
</H1> |
|
|
<SPAN CLASS="nm">mdocml</SPAN> consists of the <A HREF="mandoc.3.html">libmandoc</A> validating compiler and <A |
<SPAN CLASS="nm">mdocml</SPAN> consists of the <A HREF="mandoc.3.html">libmandoc</A> validating compiler and <A |
HREF="mandoc.1.html">mandoc</A>, which interfaces with the compiler library to format output for UNIX terminals (with |
HREF="mandoc.1.html">mandoc</A>, which interfaces with the compiler library to format output for UNIX terminals (with |
support for wide-character locales), XHTML, HTML, PostScript, and PDF. |
support for wide-character locales), XHTML, HTML, PostScript, and PDF. |
It also includes <A HREF="preconv.1.html">preconv</A>, for recoding multibyte manuals; and <A |
It also includes <A HREF="preconv.1.html">preconv</A>, for recoding multibyte manuals; |
HREF="mandocdb.8.html">mandocdb</A>, for indexing manuals. |
<A HREF="demandoc.1.html">demandoc</A>, for emitting only text parts of manuals; |
|
and <A HREF="mandocdb.8.html">mandocdb</A>, for indexing manuals. |
It is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project. |
It is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project. |
</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> |
<H1> |
<H2> |
<A NAME="sources">Sources</A> |
<A NAME="sources">Sources</A> |
</H1> |
</H2> |
<P> |
<P> |
<SPAN CLASS="nm">mdocml</SPAN> is in plain-old ANSI C and should build and run on any modern system (<A |
<SPAN CLASS="nm">mdocml</SPAN> is in plain-old ANSI C and should build and run on any modern system. |
HREF="mandocdb.8.html">mandocdb</A> requires <A CLASS="external" |
To build and install into <I>/usr/local/</I>, just run <CODE>make install</CODE>. |
HREF="http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html">Berkeley Database</A>, installed by |
Be aware: if you have an existing groff installation, this may overwrite its <B>preconv</B> binary. |
default on all BSD UNIX operating systems). |
The <A HREF="mandocdb.8.html">mandocdb</A> utility is not yet linked to the build; please <A HREF="#contact">contact |
|
us</A> if you plan to use it. |
</P> |
</P> |
|
<H2> |
|
<A NAME="binaries">Binaries</A> |
|
</H2> |
<P> |
<P> |
To compile <SPAN CLASS="nm">mdocml</SPAN>, run <CODE>make</CODE>, then <CODE>make install</CODE> to install into |
Binary archives consist of pre-compiled binaries, manuals, and other necessary files. |
<I>/usr/local</I>. Be aware: if you have an existing <A HREF="http://www.gnu.org/software/groff/" |
Universal (Mac OS X) binaries are compiled for the PCC, i386, and x86_64 architectures. |
CLASS="external">groff</A> installation, this may overwrite its <B>preconv</B> binary. The <A |
Windows binaries are compiled with <A CLASS="external" HREF="http://www.mingw.org">MingW</A> for the 32-bit (i686) and |
HREF="mandocdb.8.html">mandocdb</A> utility is not yet linked to the build: you must run <CODE>make mandocdb</CODE> to |
64-bit (x86_64) architectures. |
build it (it does not install). |
|
</P> |
</P> |
<P> |
|
The most current version of <SPAN CLASS="nm">mdocml</SPAN> is <SPAN CLASS="attn">@VERSION@</SPAN>, dated <SPAN |
|
class="attn">@VDATE@</SPAN>. |
|
</P> |
|
<H2> |
<H2> |
Current |
|
</H2> |
|
<TABLE WIDTH="100%" SUMMARY="Current Sources"> |
|
<COL WIDTH="200"> |
|
<COL> |
|
<TBODY> |
|
<TR> |
|
<TD>Source archive</TD> |
|
<TD> |
|
<A HREF="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</A> |
|
<SMALL>(<A HREF="/snapshots/mdocml.md5">md5</A>)</SMALL> |
|
</TD> |
|
</TR> |
|
<TR> |
|
<TD>Online source</TD> |
|
<TD> |
|
<A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A> |
|
</TD> |
|
</TR> |
|
<TR> |
|
<TD>Win32 (i686) binary archive</TD> |
|
<TD> |
|
<A HREF="/binaries/mdocml-win32.zip">/binaries/mdocml-win32.zip</A> |
|
</TD> |
|
</TR> |
|
<TR> |
|
<TD>Win64 (x86_64) binary archive</TD> |
|
<TD> |
|
<A HREF="/binaries/mdocml-win64.zip">/binaries/mdocml-win64.zip</A> |
|
</TD> |
|
</TR> |
|
</TBODY> |
|
</TABLE> |
|
<H2> |
|
Downstream |
Downstream |
</H2> |
</H2> |
|
<P> |
|
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 |
|
<Q>official</Q>. |
|
Please <A HREF="#contact">contact us</A> if you plan on maintaining a downstream version! |
|
</P> |
<TABLE WIDTH="100%" SUMMARY="Downstream Sources"> |
<TABLE WIDTH="100%" SUMMARY="Downstream Sources"> |
<COL WIDTH="200"> |
<COL WIDTH="175"> |
<COL> |
<COL> |
<TBODY> |
<TBODY> |
<TR> |
<TR> |
|
|
</TR> |
</TR> |
</TBODY> |
</TBODY> |
</TABLE> |
</TABLE> |
<H2> |
|
Historical |
|
</H2> |
|
<TABLE WIDTH="100%" SUMMARY="Archived Sources"> |
|
<COL WIDTH="200"> |
|
<COL> |
|
<TBODY> |
|
<TR> |
|
<TD>Source archive</TD> |
|
<TD> |
|
<A HREF="/snapshots/">/snapshots/</A> |
|
</TD> |
|
</TR> |
|
<TR> |
|
<TD>Binary archive</TD> |
|
<TD> |
|
<A HREF="/binaries/">/binaries/</A> |
|
</TD> |
|
</TR> |
|
</TBODY> |
|
</TABLE> |
|
<H1> |
<H1> |
<A NAME="documentation">Documentation</A> |
<A NAME="documentation">Documentation</A> |
</H1> |
</H1> |
<P> |
<P> |
These manuals are generated automatically and refer to the current snapshot. |
These manuals are generated automatically and refer to the current release. |
|
They are the authoritative documentation for the <SPAN CLASS="nm">mdocml</SPAN> system. |
</P> |
</P> |
|
|
<TABLE WIDTH="100%" SUMMARY="Documentation"> |
<TABLE WIDTH="100%" SUMMARY="Documentation"> |
<COL WIDTH="200"> |
<COL WIDTH="175"> |
<COL> |
<COL> |
<TBODY> |
<TBODY> |
<TR> |
<TR> |
<TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD> |
<TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD> |
<TD VALIGN="top"> |
<TD VALIGN="top"> |
format and display UNIX manuals |
format and display UNIX manuals |
<SMALL> |
|
(<A HREF="mandoc.1.txt">text</A> | |
(<A HREF="mandoc.1.txt">text</A> | |
<A HREF="mandoc.1.xhtml">xhtml</A> | |
<A HREF="mandoc.1.xhtml">xhtml</A> | |
<A HREF="mandoc.1.pdf">pdf</A> | |
<A HREF="mandoc.1.pdf">pdf</A> | |
<A HREF="mandoc.1.ps">postscript</A>) |
<A HREF="mandoc.1.ps">ps</A>) |
</SMALL> |
|
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD> |
<TD VALIGN="top"><A HREF="demandoc.1.html">demandoc(1)</A></TD> |
<TD VALIGN="top"> |
<TD VALIGN="top"> |
index UNIX manuals |
emit only text of UNIX manuals |
<SMALL> |
(<A HREF="demandoc.1.txt">text</A> | |
(<A HREF="mandocdb.8.txt">text</A> | |
<A HREF="demandoc.1.xhtml">xhtml</A> | |
<A HREF="mandocdb.8.xhtml">xhtml</A> | |
<A HREF="demandoc.1.pdf">pdf</A> | |
<A HREF="mandocdb.8.pdf">pdf</A> | |
<A HREF="demandoc.1.ps">ps</A>) |
<A HREF="mandocdb.8.ps">postscript</A>) |
|
</SMALL> |
|
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD> |
<TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD> |
<TD VALIGN="top"> |
<TD VALIGN="top"> |
recode multibyte UNIX manuals |
recode multibyte UNIX manuals |
<SMALL> |
|
(<A HREF="preconv.1.txt">text</A> | |
(<A HREF="preconv.1.txt">text</A> | |
<A HREF="preconv.1.xhtml">xhtml</A> | |
<A HREF="preconv.1.xhtml">xhtml</A> | |
<A HREF="preconv.1.pdf">pdf</A> | |
<A HREF="preconv.1.pdf">pdf</A> | |
<A HREF="preconv.1.ps">postscript</A>) |
<A HREF="preconv.1.ps">ps</A>) |
</SMALL> |
|
</TD> |
</TD> |
</TR> |
</TR> |
<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 |
<SMALL> |
|
(<A HREF="mandoc.3.txt">text</A> | |
(<A HREF="mandoc.3.txt">text</A> | |
<A HREF="mandoc.3.xhtml">xhtml</A> | |
<A HREF="mandoc.3.xhtml">xhtml</A> | |
<A HREF="mandoc.3.pdf">pdf</A> | |
<A HREF="mandoc.3.pdf">pdf</A> | |
<A HREF="mandoc.3.ps">postscript</A>) |
<A HREF="mandoc.3.ps">ps</A>) |
</SMALL> |
|
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD> |
<TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD> |
<TD VALIGN="top"> |
<TD VALIGN="top"> |
man language reference |
man language reference |
<SMALL> |
|
(<A HREF="man.7.txt">text</A> | |
(<A HREF="man.7.txt">text</A> | |
<A HREF="man.7.xhtml">xhtml</A> | |
<A HREF="man.7.xhtml">xhtml</A> | |
<A HREF="man.7.pdf">pdf</A> | |
<A HREF="man.7.pdf">pdf</A> | |
<A HREF="man.7.ps">postscript</A>) |
<A HREF="man.7.ps">ps</A>) |
</SMALL> |
|
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD> |
<TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD> |
<TD VALIGN="top"> |
<TD VALIGN="top"> |
eqn-mandoc language reference |
eqn-mandoc language reference |
<SMALL> |
|
(<A HREF="eqn.7.txt">text</A> | |
(<A HREF="eqn.7.txt">text</A> | |
<A HREF="eqn.7.xhtml">xhtml</A> | |
<A HREF="eqn.7.xhtml">xhtml</A> | |
<A HREF="eqn.7.pdf">pdf</A> | |
<A HREF="eqn.7.pdf">pdf</A> | |
<A HREF="eqn.7.ps">postscript</A>) |
<A HREF="eqn.7.ps">ps</A>) |
</SMALL> |
|
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD> |
<TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD> |
<TD VALIGN="top"> |
<TD VALIGN="top"> |
mandoc special characters |
mandoc special characters |
<SMALL> |
|
(<A HREF="mandoc_char.7.txt">text</A> | |
(<A HREF="mandoc_char.7.txt">text</A> | |
<A HREF="mandoc_char.7.xhtml">xhtml</A> | |
<A HREF="mandoc_char.7.xhtml">xhtml</A> | |
<A HREF="mandoc_char.7.pdf">pdf</A> | |
<A HREF="mandoc_char.7.pdf">pdf</A> | |
<A HREF="mandoc_char.7.ps">postscript</A>) |
<A HREF="mandoc_char.7.ps">ps</A>) |
</SMALL> |
|
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD> |
<TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD> |
<TD VALIGN="top"> |
<TD VALIGN="top"> |
mdoc language reference |
mdoc language reference |
<SMALL> |
|
(<A HREF="mdoc.7.txt">text</A> | |
(<A HREF="mdoc.7.txt">text</A> | |
<A HREF="mdoc.7.xhtml">xhtml</A> | |
<A HREF="mdoc.7.xhtml">xhtml</A> | |
<A HREF="mdoc.7.pdf">pdf</A> | |
<A HREF="mdoc.7.pdf">pdf</A> | |
<A HREF="mdoc.7.ps">postscript</A>) |
<A HREF="mdoc.7.ps">ps</A>) |
</SMALL> |
|
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD> |
<TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD> |
<TD VALIGN="top"> |
<TD VALIGN="top"> |
roff-mandoc language reference |
roff-mandoc language reference |
<SMALL> |
|
(<A HREF="roff.7.txt">text</A> | |
(<A HREF="roff.7.txt">text</A> | |
<A HREF="roff.7.xhtml">xhtml</A> | |
<A HREF="roff.7.xhtml">xhtml</A> | |
<A HREF="roff.7.pdf">pdf</A> | |
<A HREF="roff.7.pdf">pdf</A> | |
<A HREF="roff.7.ps">postscript</A>) |
<A HREF="roff.7.ps">ps</A>) |
</SMALL> |
|
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD> |
<TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD> |
<TD VALIGN="top"> |
<TD VALIGN="top"> |
tbl-mandoc language reference |
tbl-mandoc language reference |
<SMALL> |
|
(<A HREF="tbl.7.txt">text</A> | |
(<A HREF="tbl.7.txt">text</A> | |
<A HREF="tbl.7.xhtml">xhtml</A> | |
<A HREF="tbl.7.xhtml">xhtml</A> | |
<A HREF="tbl.7.pdf">pdf</A> | |
<A HREF="tbl.7.pdf">pdf</A> | |
<A HREF="tbl.7.ps">postscript</A>) |
<A HREF="tbl.7.ps">ps</A>) |
</SMALL> |
|
</TD> |
</TD> |
</TR> |
</TR> |
|
<TR> |
|
<TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD> |
|
<TD VALIGN="top"> |
|
index UNIX manuals |
|
(<A HREF="mandocdb.8.txt">text</A> | |
|
<A HREF="mandocdb.8.xhtml">xhtml</A> | |
|
<A HREF="mandocdb.8.pdf">pdf</A> | |
|
<A HREF="mandocdb.8.ps">ps</A>) |
|
</TD> |
|
</TR> |
</TBODY> |
</TBODY> |
</TABLE> |
</TABLE> |
<H1> |
<H1> |
|
|
this e-mail address">kris...</A>@bsd.lv. |
this e-mail address">kris...</A>@bsd.lv. |
</P> |
</P> |
<TABLE WIDTH="100%" SUMMARY="Mailing Lists"> |
<TABLE WIDTH="100%" SUMMARY="Mailing Lists"> |
<COL WIDTH="200"> |
<COL WIDTH="175"> |
<COL> |
<COL> |
<TBODY> |
<TBODY> |
<TR> |
<TR> |
|
|
</TD> |
</TD> |
<TD> |
<TD> |
bug-reports, general questions, and announcements |
bug-reports, general questions, and announcements |
<SMALL>(<A HREF="/archives/discuss/summary.html">archive</A>)</SMALL> |
(<A HREF="/archives/discuss/summary.html">archive</A>) |
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
|
|
</TD> |
</TD> |
<TD> |
<TD> |
patches and system discussions |
patches and system discussions |
<SMALL>(<A HREF="/archives/tech/summary.html">archive</A>)</SMALL> |
(<A HREF="/archives/tech/summary.html">archive</A>) |
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
|
|
</TD> |
</TD> |
<TD> |
<TD> |
source commit messages |
source commit messages |
<SMALL>(<A HREF="/archives/source/summary.html">archive</A>)</SMALL> |
(<A HREF="/archives/source/summary.html">archive</A>) |
</TD> |
</TD> |
</TR> |
</TR> |
</TBODY> |
</TBODY> |
|
|
<A NAME="news">News</A> |
<A NAME="news">News</A> |
</H1> |
</H1> |
<P CLASS="news"> |
<P CLASS="news"> |
|
xx-xx-2011: version 1.11.x |
|
</P> |
|
<P> |
|
Added <A HREF="demandoc.1.html">demandoc</A> utility for stripping away macros and escapes. This replaces the |
|
historical <CODE>deroff</CODE> utility. |
|
</P> |
|
<P CLASS="news"> |
16-08-2011: version 1.11.6 |
16-08-2011: version 1.11.6 |
</P> |
</P> |
<P> |
<P> |
Handling of <B>tr</B> macro in <A HREF="roff.7.html">roff</A> implemented. This makes Perl documentation much more |
Handling of <B>tr</B> macro in <A HREF="roff.7.html">roff</A> implemented. This makes Perl documentation much more |
readable. Hyphenation is also now enabled in <A HREF="man.7.html">man</A> format documents. Many other general |
readable. Hyphenation is also now enabled in <A HREF="man.7.html">man</A> format documents. Many other general |
improvements have been implemented, and a 64-bit Windows binary is now available at <A |
improvements have been implemented. Furthermore, a 64-bit Windows binary is now available at <A |
HREF="/binaries/mdocml-win64.zip">/binaries/mdocml-win64.zip</A>. |
HREF="/binaries/mdocml-win64.zip">mdocml-win64.zip</A> and a Mac OS X universal binary is available at <A |
|
HREF="/binaries/mdocml-macosx.zip">mdocml-macosx.zip</A>. |
</P> |
</P> |
<P CLASS="news"> |
<P CLASS="news"> |
24-07-2011: version 1.11.5 |
24-07-2011: version 1.11.5 |
|
|
<P> |
<P> |
This is also the first release featuring a distributed Windows binary, available at <A |
This is also the first release featuring a distributed Windows binary, available at <A |
HREF="/binaries/mdocml-win32.zip">/binaries/mdocml-win32.zip</A>. |
HREF="/binaries/mdocml-win32.zip">/binaries/mdocml-win32.zip</A>. |
</P> |
|
<P CLASS="news"> |
|
12-07-2011: version 1.11.4 |
|
</P> |
|
<P> |
|
Bug-fixes and clean-ups across all systems, especially in <INS><A HREF="mandocdb.8.html">mandocdb</A></INS> <DEL>makewhatis</DEL> (note: still not |
|
connected to the general build and must be compiled with <INS><CODE>make mandocdb</CODE></INS> <DEL><CODE>make makewhatis</CODE></DEL>) and the <A |
|
HREF="man.7.html">man</A> parser. This release was significantly assisted by participants in <A CLASS="external" |
|
HREF="http://www.openbsd.org">OpenBSD</A>'s c2k11. Thanks! |
|
</P> |
</P> |
<P> |
<P> |
See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for |
See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for |