<HTML>
<HEAD>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8">
- <META NAME="resource-type" CONTENT="document">
<LINK REL="stylesheet" HREF="index.css" TYPE="text/css" MEDIA="all">
- <TITLE>mdocml | mdoc macro compiler</TITLE>
+ <TITLE>mdocml | UNIX manpage compiler</TITLE>
</HEAD>
<BODY>
- <TABLE CLASS="frame" SUMMARY="[frame]">
- <COL WIDTH="100%">
- <TBODY>
- <TR>
- <TD>
- <DIV CLASS="head">
- <B>mdocml</B> – mdoc macro compiler
- </DIV>
- </TD>
- </TR>
- <TR>
- <TD VALIGN="top">
- <H1>
- <A NAME="description">DESCRIPTION</A>
- </H1>
+ <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@)
+ </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>)
+ </P>
+ <H1>
+ <A NAME="description">Description</A>
+ </H1>
+ <P>
+ <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
+ UNIX manuals.
+ 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>
+ The tool set features <A HREF="mandoc.1.html">mandoc</A>,
+ based on the <A HREF="mandoc.3.html">libmandoc</A> validating compiler,
+ 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>
+ <SPAN CLASS="nm">mdocml</SPAN> has predominantly been developed on OpenBSD
+ 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.
+ We strive to support all interested free operating systems, in particular
+ <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.minix3.org/">Minix 3</A>,
+ 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>
+ <I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, <Q>mandoc</Q>.
+ </P>
+ <H2>
+ <A NAME="sources">Sources</A>
+ </H2>
+ <P>
+ <SPAN CLASS="nm">mdocml</SPAN> is in ISO C99 and should build and run on any modern system; however, you'll need <A
+ HREF="http://www.sqlite.org">sqlite3</A> to build <A HREF="apropos.1.html">apropos</A> (links to whatis),
+ <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>.
+ Be careful: the <B>preconv</B>, <B>apropos</B>, and <B>whatis</B> binary names are usually taken by existing utilities.
+ </P>
+ <H2>
+ Downstream
+ </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>, so please <A HREF="#contact">contact us</A> if you plan on maintaining a downstream version!
+ </P>
+ <TABLE WIDTH="100%" SUMMARY="Downstream Sources">
+ <COL WIDTH="175">
+ <COL>
+ <TBODY>
+ <TR>
+ <TD>DragonFly BSD</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:/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)
+ </TD>
+ </TR>
+ <TR>
+ <TD>FreeBSD 10.0, -CURRENT</TD>
+ <TD>
+ <A HREF="http://svnweb.freebsd.org/base/head/contrib/mdocml/" CLASS="external">contrib/mdocml</A> (1.12.1 sources)
+ <A HREF="http://svnweb.freebsd.org/base/head/usr.bin/mandoc/" CLASS="external">usr.bin/mandoc</A> (build system)
+ </TD>
+ </TR>
+ <TR>
+ <TD>FreeBSD 9.x, 8.x</TD>
+ <TD>
+ <A HREF="http://svnweb.freebsd.org/ports/head/textproc/mdocml/" CLASS="external">ports/textproc/mdocml</A> (1.12.2 port)
+ </TD>
+ </TR>
+ <TR>
+ <TD>NetBSD</TD>
+ <TD>
+ <A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/" CLASS="external">src/external/bsd/mdocml</A> (1.12.1 sources plus patches and build system)
+ </TD>
+ </TR>
+ <TR>
+ <TD>OpenBSD</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)
+ </TD>
+ </TR>
+ <TR>
+ <TD>pkgsrc</TD>
+ <TD>
+ <A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/pkgsrc/textproc/mdocml/" CLASS="external">textproc/mdocml</A> (1.12.3 port)
+ </TD>
+ </TR>
+ <TR>
+ <TD>Minix3</TD>
+ <TD>
+ <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>
+ </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>
+ </TABLE>
+ <H1>
+ <A NAME="documentation">Documentation</A>
+ </H1>
+ <P>
+ 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>
- <SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <Q>-<A HREF="mdoc.7.html">mdoc</A></Q>, the
- roff macro package of choice for BSD manual pages, and <Q>-<A HREF="man.7.html">man</A></Q>, the
- predominant historical package for UNIX manuals. 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 troff
- implementation, for displaying -mdoc pages whilst providing token support for -man.
- </P>
-
- <P>
- Why? groff amounts to over 5 MB of source code, most 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, <A CLASS="external"
- HREF="http://www.isc.org/software/license">ISC</A>-licensed, fast and regular).
- </P>
-
- <P>
- <SPAN CLASS="nm">mdocml</SPAN> consists of the <A HREF="mdoc.3.html">libmdoc</A>, <A
- HREF="man.3.html">libman</A>, and <A HREF="roff.3.html">libroff</A> validating compilers; and <A
- HREF="mandoc.1.html">mandoc</A>, which interfaces with the compiler libraries to format output for UNIX
- terminals, XHTML, HTML, and PostScript. <SPAN CLASS="nm">mdocml</SPAN> is a <A CLASS="external"
- HREF="http://bsd.lv/">BSD.lv</A> project.
- </P>
-
- <P>
- <I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary,
- <Q>mandoc</Q>.
- </P>
- </TD>
- </TR>
- <TR>
- <TD>
- <H1>
- <A NAME="sources">SOURCES</A>
- </H1>
-
- <P>
- <SPAN CLASS="nm">mdocml</SPAN> is architecture- and system-neutral, written in plain-old C. The most
- current version is <SPAN CLASS="attn">@VERSION@</SPAN>, dated <SPAN class="attn">@VDATE@</SPAN>. A full
- <A HREF="ChangeLog.html">ChangeLog</A> (<A HREF="ChangeLog.txt">txt</A>) is written with each release.
- </P>
-
- <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>
- (<A HREF="/snapshots/mdocml.md5">md5</A>)
- </TD>
- </TR>
- <TR>
- <TD>Online source</TD>
- <TD>
- <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A>
- </TD>
- </TR>
- </TBODY>
- </TABLE>
-
- <H2>
- Downstream
- </H2>
-
- <TABLE WIDTH="100%" SUMMARY="Downstream Sources">
- <COL WIDTH="200">
- <COL>
- <TBODY>
- <TR>
- <TD>DragonFly BSD</TD>
- <TD>
- <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc"
- CLASS="external">usr.bin/mandoc</A>
- </TD>
- </TR>
- <TR>
- <TD>FreeBSD</TD>
- <TD>
- <A HREF="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/"
- CLASS="external">ports/textproc/mdocml</A>
- </TD>
- </TR>
- <TR>
- <TD>NetBSD</TD>
- <TD>
- <A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/"
- CLASS="external">src/external/bsd/mdocml</A>
- </TD>
- </TR>
- <TR>
- <TD>OpenBSD</TD>
- <TD>
- <A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/"
- CLASS="external">src/usr.bin/mandoc</A>
- </TD>
- </TR>
- </TBODY>
- </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>
- </TBODY>
- </TABLE>
- </TD>
- </TR>
- <TR>
- <TD>
- <H1>
- <A NAME="documentation">DOCUMENTATION</A>
- </H1>
-
- <P>
- These manuals are generated automatically and refer to the current snapshot.
- </P>
-
- <TABLE WIDTH="100%" SUMMARY="Documentation">
- <COL WIDTH="200">
- <COL>
- <TBODY>
- <TR>
- <TD VALIGN="top"><A HREF="man.3.html">man(3)</A></TD>
- <TD VALIGN="top">
- man macro compiler library
- <SPAN STYLE="font-size: smaller;">
- (<A HREF="man.3.txt">text</A> |
- <A HREF="man.3.xhtml">xhtml</A> |
- <A HREF="man.3.pdf">pdf</A> |
- <A HREF="man.3.ps">postscript</A>)
- </SPAN>
- </TD>
- </TR>
- <TR>
- <TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD>
- <TD VALIGN="top">
- man language reference
- <SPAN STYLE="font-size: smaller;">
- (<A HREF="man.7.txt">text</A> |
- <A HREF="man.7.xhtml">xhtml</A> |
- <A HREF="man.7.pdf">pdf</A> |
- <A HREF="man.7.ps">postscript</A>)
- </SPAN>
- </TD>
- </TR>
- <TR>
- <TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD>
- <TD VALIGN="top">
- format and display UNIX manuals
- <SPAN STYLE="font-size: smaller;">
- (<A HREF="mandoc.1.txt">text</A> |
- <A HREF="mandoc.1.xhtml">xhtml</A> |
- <A HREF="mandoc.1.pdf">pdf</A> |
- <A HREF="mandoc.1.ps">postscript</A>)
- </SPAN>
- </TD>
- </TR>
- <TR>
- <TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD>
- <TD VALIGN="top">
- mandoc special characters
- <SPAN STYLE="font-size: smaller;">
- (<A HREF="mandoc_char.7.txt">text</A> |
- <A HREF="mandoc_char.7.xhtml">xhtml</A> |
- <A HREF="mandoc_char.7.pdf">pdf</A> |
- <A HREF="mandoc_char.7.ps">postscript</A>)
- </SPAN>
- </TD>
- </TR>
- <TR>
- <TD VALIGN="top"><A HREF="mdoc.3.html">mdoc(3)</A></TD>
- <TD VALIGN="top">
- mdoc macro compiler library
- <SPAN STYLE="font-size: smaller;">
- (<A HREF="mdoc.3.txt">text</A> |
- <A HREF="mdoc.3.xhtml">xhtml</A> |
- <A HREF="mdoc.3.pdf">pdf</A> |
- <A HREF="mdoc.3.ps">postscript</A>)
- </SPAN>
- </TD>
- </TR>
- <TR>
- <TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD>
- <TD VALIGN="top">
- mdoc language reference
- <SPAN STYLE="font-size: smaller;">
- (<A HREF="mdoc.7.txt">text</A> |
- <A HREF="mdoc.7.xhtml">xhtml</A> |
- <A HREF="mdoc.7.pdf">pdf</A> |
- <A HREF="mdoc.7.ps">postscript</A>)
- </SPAN>
- </TD>
- </TR>
- <TR>
- <TD VALIGN="top"><A HREF="roff.3.html">roff(3)</A></TD>
- <TD VALIGN="top">
- roff macro compiler library
- <SPAN STYLE="font-size: smaller;">
- (<A HREF="roff.3.txt">text</A> |
- <A HREF="roff.3.xhtml">xhtml</A> |
- <A HREF="roff.3.pdf">pdf</A> |
- <A HREF="roff.3.ps">postscript</A>)
- </SPAN>
- </TD>
- </TR>
- <TR>
- <TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD>
- <TD VALIGN="top">
- roff-mandoc language reference
- <SPAN STYLE="font-size: smaller;">
- (<A HREF="roff.7.txt">text</A> |
- <A HREF="roff.7.xhtml">xhtml</A> |
- <A HREF="roff.7.pdf">pdf</A> |
- <A HREF="roff.7.ps">postscript</A>)
- </SPAN>
- </TD>
- </TR>
- </TBODY>
- </TABLE>
-
- <P>
- See <Q><A CLASS="external" HREF="http://manpages.bsd.lv">Writing UNIX Manual Pages</A></Q> for a general
- introduction to manpages and mdoc.
- </P>
- </TD>
- </TR>
- <TR>
- <TD>
- <H1>
- <A NAME="contact">CONTACT</A>
- </H1>
-
- <P>
- Please use the mailing lists for bug-reports, patches, questions, etc. Beyond that, contact
- Kristaps at <A
- HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q=="
- TITLE="Reveal this e-mail address">kris...</A>@bsd.lv.
- </P>
-
- <P>
- You may also subscribe to several mailing lists (these require subscription, which is
- moderated).
- </P>
-
- <TABLE WIDTH="100%" SUMMARY="Mailing Lists">
- <COL WIDTH="200">
- <COL>
- <TBODY>
- <TR>
- <TD>
- disc<A CLASS="external" TITLE="Reveal this e-mail address"
- HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv
- </TD>
- <TD>
- bug-reports, general questions, and announcements
- <SPAN STYLE="font-size: smaller;">(<A HREF="/archives/discuss/summary.html">archive</A>)</SPAN>
- </TD>
- </TR>
- <TR>
- <TD>
- tec<A CLASS="external" TITLE="Reveal this e-mail address"
- HREF="http://www.google.com/recaptcha/mailhide/d?k=01qDX_iV0RlUOarEvb6mR28g==&c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...</A>@mdocml.bsd.lv
- </TD>
- <TD>
- patches and system discussions
- <SPAN STYLE="font-size: smaller;">(<A HREF="/archives/tech/summary.html">archive</A>)</SPAN>
- </TD>
- </TR>
- <TR>
- <TD>
- sou<A CLASS="external" TITLE="Reveal this e-mail address"
- HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</A>@mdocml.bsd.lv
- </TD>
- <TD>
- source commit messages
- <SPAN STYLE="font-size: smaller;">(<A HREF="/archives/source/summary.html">archive</A>)</SPAN>
- </TD>
- </TR>
- </TBODY>
- </TABLE>
- </TD>
- </TR>
- <TR>
- <TD>
- <H1>
- <A NAME="news">NEWS</A>
- </H1>
- <DIV CLASS="news">
- <P>
- <SPAN CLASS="date">xx-12-2010</SPAN>:
- version 1.10.8
- </P>
- <P>
- Significant improvements merged from <A CLASS="external"
- HREF="http://www.openbsd.org">OpenBSD</A> downstream, including
- </P>
- <UL>
- <LI>many new <A HREF="roff.7.html">roff</A> components,</LI>
- <LI>in-line implementation of troff's soelim,</LI>
- <LI>broken-block handling,</LI>
- <LI>overhauled error classifications, and</LI>
- <LI>cleaned up handling of error conditions.</LI>
- </UL>
- <P>
- Also overhauled the <SPAN CLASS="flag">-Thtml</SPAN> and <SPAN
- CLASS="flag">-Txhtml</SPAN> output modes. They now display readable output in arbitrary
- browsers, including text-based ones like <A CLASS="external"
- HREF="http://lynx.isc.org">lynx</A>. <SPAN CLASS="attn">Available style-sheet classes
- have been considerably changed!</SPAN> See the <SPAN
- CLASS="file">example.style.css</SPAN> file for details. Lastly, <A
- HREF="mdoc.3.html">libmdoc</A> and <A HREF="man.3.html">libman</A> have been cleaned up
- and reduced in size and complexity.
- </P>
- </DIV>
- <DIV CLASS="news">
- <P>
- <SPAN CLASS="date">27-09-2010</SPAN>:
- version 1.10.6
- </P>
- <P>
- Calling conventions for <A HREF="mandoc.1.html">mandoc</A> have changed: <SPAN
- CLASS="flag">-W</SPAN> improved and <SPAN CLASS="flag">-f</SPAN> deprecated. Non-ASCII
- characters are also now uniformly discarded. Lots of documentation improvements. Many
- incremental fixes accomodating for groff's more interesting productions. Lastly, <A
- HREF="http://perldoc.perl.org/pod2man.html" CLASS="external">pod2man</A> preambles are
- now fully accepted after some considerable <A HREF="roff.7.html">roff</A> and special
- character support.
- </P>
- </DIV>
- <DIV CLASS="news">
- <P>
- <SPAN CLASS="date">27-07-2010</SPAN>:
- version 1.10.5
- </P>
- <P>
- Primarily a bug-fix and polish release, but including <SPAN CLASS="flag">-Tpdf</SPAN>
- support in <A HREF="mandoc.1.html">mandoc</A> by way of <A CLASS="external"
- HREF="http://netbsd-soc.sourceforge.net/projects/mandoc_ps/">Summer of Code</A>.
- Highlights:
- </P>
- <UL>
- <LI>fix <Q>Sm</Q> and <Q>Bd</Q> handling</LI>
- <LI>fix end-of-sentence handling for embedded sentences</LI>
- <LI>polish <A HREF="man.7.html">man</A> documentation</LI>
- <LI>document all <A HREF="mdoc.7.html">mdoc</A> macros</LI>
- <LI>polish <A HREF="mandoc.1.html">mandoc</A> <SPAN CLASS="flag">-Tps</SPAN> output</LI>
- <LI>lots of internal clean-ups in character escapes</LI>
- <LI>un-break literal contexts in <A HREF="man.7.html">man</A> documents</LI>
- <LI>improve <SPAN CLASS="flag">-Thtml</SPAN> output for <SPAN CLASS="flag">-man</SPAN></LI>
- <LI>add <A HREF="mandoc.1.html">mandoc</A> <SPAN CLASS="flag">-Tpdf</SPAN> support</LI>
- </UL>
- </DIV>
- <DIV CLASS="news">
- <P>
- <SPAN CLASS="date">12-07-2010</SPAN>:
- version 1.10.4
- </P>
- <P>
- Lots of features developed during both <A CLASS="external"
- HREF="http://netbsd-soc.sourceforge.net/projects/mandoc_ps/">Summer of Code</A> and the
- <A CLASS="external" HREF="http://www.openbsd.org">OpenBSD</A> c2k10 hackathon:
- </P>
- <UL>
- <LI>minimal <Q>ds</Q> <A HREF="roff.7.html">roff</A> symbols are supported</LI>
- <LI><Q>Bk</Q> <A HREF="mdoc.7.html">mdoc</A> support</LI>
- <LI>beautified SYNOPSIS section output</LI>
- <LI>variable font-width and paper-size support in <A HREF="mandoc.1.html">mandoc</A>
- <SPAN CLASS="flag">-Tps</SPAN> output</LI>
- <LI>acceptance of scope-block breakage in <A HREF="mdoc.7.html">mdoc</A></LI>
- <LI>clarify error message status</LI>
- <LI>many minor bug-fixes and formatting issues resolved</LI>
- </UL>
- </DIV>
- <DIV CLASS="news">
- <P>
- <SPAN CLASS="date">19-06-2010</SPAN>:
- version 1.10.2
- </P>
- <P>
- Small release featuring text-decoration in <SPAN CLASS="flag">-Tps</SPAN> output, a few
- minor relaxations of errors, and some optimisations.
- </P>
- </DIV>
- <DIV CLASS="news">
- <P>
- <SPAN CLASS="date">07-06-2010</SPAN>:
- version 1.10.1
- </P>
- <P>
- This primarily focusses on the <Q>Bl</Q> and <Q>It</Q> macros described in <A
- HREF="mdoc.7.html">mdoc</A>. Multi-line column support is now fully compatible with
- groff, as are implicit list entries for columns. Removed manuals.7 in favour of <A
- CLASS="external" HREF="http://manpages.bsd.lv">http://manpages.bsd.lv</A>. The way we
- handle the SYNOPSIS section (see the SYNOPSIS documentation in <A
- HREF="mdoc.7.html#x4d414e55414cx20x535452554354555245">MANUAL STRUCTURE</A>) has also
- been considerably simplified compared to groff's method. Furthermore, the <SPAN
- CLASS="flag">-Owidth=width</SPAN> output option has been added to <SPAN
- CLASS="flag">-Tascii</SPAN> (see <A HREF="mandoc.1.html">mandoc</A>). Lastly, initial
- PostScript output has been added with the <SPAN CLASS="flag">-Tps</SPAN> option to <A
- HREF="mandoc.1.html">mandoc</A>. It's brutally simple at the moment: fixed-font, with
- no font decorations.
- </P>
- </DIV>
- <DIV CLASS="news">
- <P>
- <SPAN CLASS="date">29-05-2010</SPAN>:
- version 1.10.0
- </P>
- <P>
- Release consisting of the results from the m2k10 hackathon and up-merge from OpenBSD.
- This requires a significant note of thanks to Ingo Schwarze (OpenBSD) and Joerg
- Sonnenberger (NetBSD) for their hard work, and again to Joerg for hosting m2k10.
- Highlights (mostly cribbed from Ingo's m2k10 report) follow in no particular order:
- </P>
- <UL>
- <LI>a <A HREF="roff.3.html">libroff</A> preprocessor in front of <A
- HREF="mdoc.3.html">libmdoc</A> and <A HREF="man.3.html">libman</A> stripping out
- <A HREF="roff.7.html">roff</A> instructions;</LI>
- <LI>end-of-sentence (EOS) detection in free-form and macro lines;</LI>
- <LI>correct handling of tab-separated columnar lists in <SPAN
- CLASS="flag">-mdoc</SPAN>;</LI>
- <LI>improved main calling routines to optionally use mmap() for better
- performance;</LI>
- <LI>cleaned up exiting when invoked as <SPAN CLASS="flag">-Tlint</SPAN> or over
- multiple files with <SPAN CLASS="flag">-fign-errors</SPAN>;</LI>
- <LI>error and warning message handling re-written to be unified for <A
- HREF="roff.3.html">libroff</A>, <A HREF="mdoc.3.html">libmdoc</A>, and <A
- HREF="man.3.html">libman</A>;</LI>
- <LI>handling of badly-nested explicit-scoped macros;</LI>
- <LI>improved free-form text parsing in <A HREF="man.3.html">libman</A> and <A
- HREF="mdoc.3.html">libmdoc</A>;</LI>
- <LI>significant GNU troff compatibility improvements in <SPAN
- CLASS="flag">-Tascii</SPAN>, largely in terms of spacing;</LI>
- <LI>a regression framework for making sure the many fragilities of GNU troff
- aren't trampled in subsequent work;</LI>
- <LI>support for <SPAN CLASS="flag">-Tascii</SPAN> breaking at hyphens
- encountered in free-form text;</LI>
- <LI>and many more minor fixes and improvements (no really, consult <A
- HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A> and see
- for yourself!).</LI>
- </UL>
- </DIV>
- <P>
- See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for
- historical notes.
- </P>
- </TD>
- </TR>
- <TR>
- <TD>
- <DIV CLASS="foot">
- Copyright © 2008–2010 Kristaps Dzonsons, $Date: 2010/12/22 11:58:02 $
- </DIV>
- </TD>
- </TR>
- </TBODY>
- </TABLE>
+ <TABLE WIDTH="100%" SUMMARY="Documentation">
+ <COL WIDTH="175">
+ <COL>
+ <TBODY>
+ <TR>
+ <TD VALIGN="top"><A HREF="apropos.1.html">apropos(1)</A></TD>
+ <TD VALIGN="top">
+ search the manual page database
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="demandoc.1.html">demandoc(1)</A></TD>
+ <TD VALIGN="top">
+ emit only text of UNIX manuals
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD>
+ <TD VALIGN="top">
+ format and display UNIX manuals
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD>
+ <TD VALIGN="top">
+ recode multibyte UNIX manuals
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD>
+ <TD VALIGN="top">
+ mandoc macro compiler library
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="tbl.3.html">tbl(3)</A></TD>
+ <TD VALIGN="top">
+ roff table parser library for mandoc
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD>
+ <TD VALIGN="top">
+ eqn-mandoc language reference
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD>
+ <TD VALIGN="top">
+ man language reference
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="man.cgi.7.html">man.cgi(7)</A></TD>
+ <TD VALIGN="top">
+ cgi for manpage query and display
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD>
+ <TD VALIGN="top">
+ mandoc special characters
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD>
+ <TD VALIGN="top">
+ mdoc language reference
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD>
+ <TD VALIGN="top">
+ roff-mandoc language reference
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD>
+ <TD VALIGN="top">
+ tbl-mandoc language reference
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD>
+ <TD VALIGN="top">
+ index UNIX manuals
+ </TD>
+ </TR>
+ </TBODY>
+ </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>
+ <A NAME="contact">Contact</A>
+ </H1>
+ <P>
+ Use the mailing lists for bug-reports, patches, questions, etc. Please check the
+ <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues
+ before posting. All lists are subscription-only: send a blank e-mail to the listed address to subscribe. Beyond that,
+ contact Kristaps at <A HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal
+ this e-mail address">kris...</A>@bsd.lv. Archives are available at <A HREF="http://gmane.org/" CLASS="external">Gmane</A>.
+ </P>
+ <TABLE WIDTH="100%" SUMMARY="Mailing Lists">
+ <COL WIDTH="175">
+ <COL>
+ <TBODY>
+ <TR>
+ <TD>
+ disc<A CLASS="external" TITLE="Reveal this e-mail address"
+ HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv
+ </TD>
+ <TD>
+ bug-reports, general questions, and announcements
+ </TD>
+ </TR>
+ <TR>
+ <TD>
+ tec<A CLASS="external" TITLE="Reveal this e-mail address"
+ HREF="http://www.google.com/recaptcha/mailhide/d?k=01qDX_iV0RlUOarEvb6mR28g==&c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...</A>@mdocml.bsd.lv
+ </TD>
+ <TD>
+ patches and system discussions
+ </TD>
+ </TR>
+ <TR>
+ <TD>
+ sou<A CLASS="external" TITLE="Reveal this e-mail address"
+ HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</A>@mdocml.bsd.lv
+ </TD>
+ <TD>
+ source commit messages
+ </TD>
+ </TR>
+ </TBODY>
+ </TABLE>
+ <H1>
+ <A NAME="news">News</A>
+ </H1>
+ <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
+ </P>
+ <P>
+ The <A HREF="mdoc.7.html">mdoc(7)</A> to <A HREF="man.7.html">man(7)</A> converter,
+ to be called as <CODE>mandoc -Tman</CODE>, is now fully functional.
+ </P>
+ <P>
+ The <A HREF="mandoc.1.html">mandoc(1)</A> utility now supports the <CODE>-Ios</CODE> (default operating system)
+ input option, and the <CODE>-Tutf8</CODE> output mode now actually works.
+ </P>
+ <P>
+ The <A HREF="mandocdb.8.html">mandocdb(8)</A> utility no longer truncates existing databases when starting to build new ones,
+ but only replaces them when the build actually succeeds.
+ </P>
+ <P>
+ The <A HREF="man.7.html">man(7)</A> parser now supports the <EM>PD</EM> macro (paragraph distance),
+ and (for GNU man-ext compatibility only) <EM>EX</EM> (example block) and <EM>EE</EM> (example end).
+ Plus several bugfixes regarding indentation, line breaks, and vertical spacing,
+ and regarding <EM>RS</EM> following <EM>TP</EM>.
+ </P>
+ <P>
+ The <A HREF="roff.7.html">roff(7)</A> parser now supports the <EM>\f(BI</EM> (bold+italic) font escape,
+ the <EM>\z</EM> (zero cursor advance) escape and the <EM>cc</EM> (change control character)
+ and <EM>it</EM> (input line trap) requests.
+ Plus bugfixes regarding the <EM>\t</EM> (tab) escape, nested escape sequences, and conditional requests.
+ </P>
+ <P>
+ In <A HREF="mdoc.7.html">mdoc(7)</A>, several bugs were fixed related to UTF-8 output of quoting enclosures,
+ delimiter handling, list indentation and horizontal and vertical spacing,
+ formatting of the <EM>Lk</EM>, <EM>%U</EM>, and <EM>%C</EM> macros,
+ plus some bugfixes related to the handling of syntax errors like badly nested font blocks,
+ stray <EM>Ta</EM> macros outside column lists, unterminated <EM>It Xo</EM> blocks,
+ and non-text children of <EM>Nm</EM> blocks.
+ </P>
+ <P>
+ In <A HREF="tbl.7.html">tbl(7)</A>, the width of horizontal spans and the vertical spacing around tables was corrected,
+ and in <A HREF="man.7.html">man(7)</A> files, a crash was fixed that was triggered by some particular unclosed <EM>T{</EM> macros.
+ </P>
+ <P>
+ 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.
+ </P>
+ <H2>
+ <A>History</A>
+ </H2>
+ <UL>
+ <LI>
+ <A HREF="NEWS">Release notes</A> going back to release 1.9.15, February 18, 2010.
+ Briefly explaining the most important changes in each release in relatively easy terms.
+ Very many changes are not mentioned here.
+ </LI>
+ <LI>
+ <A HREF="history.html">Development history</A> going back to the beginning of the project, November 22, 2008.
+ One-line entries for important commits, releases, merges, hackathons and talks.
+ Makes it easy to find out who did what, and when, and when it became available where.
+ However, this is still incomplete, mentioning only a small fraction of all commits,
+ and to keep the size down, the individual entries are extremely terse and technical.
+ Feel free to look up more details and longer explanations about individual entries
+ in the ChangeLog or in CVS.
+ </LI>
+ <LI>
+ <A HREF="ChangeLog">CVS ChangeLog</A> going back to the beginning of the project.
+ Very technical information of varying quality, strictly chronological.
+ All commits are mentioned, but some messages neglect to mention some changes.
+ Partly terse, partly detailed and verbose. In any case, the ChangeLog is very long -
+ more than 25,000 lines, more than 700 kB.
+ </LI>
+ <LI>
+ <A HREF="/cgi-bin/cvsweb/?cvsroot=mdocml">CVS</A> web interface, going back to the beginning of the project.
+ Source code, diffs and commit messages for each source file. The real thing.
+ </LI>
+ </UL>
+ <P CLASS="foot">
+ <SMALL>
+ Copyright © 2008–2011
+ <A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>,
+ © 2013 Ingo Schwarze,
+ $Date: 2013/12/31 17:47:17 $
+ </SMALL>
+ </P>
</BODY>
</HTML>
git.ckatri.com / mandoc.git / blobdiff