version 1.134, 2011/08/16 12:13:27 |
version 1.166, 2013/12/31 17:47:17 |
|
|
<HEAD> |
<HEAD> |
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8"> |
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8"> |
<LINK REL="stylesheet" HREF="index.css" TYPE="text/css" MEDIA="all"> |
<LINK REL="stylesheet" HREF="index.css" TYPE="text/css" MEDIA="all"> |
<TITLE>mdocml | mdoc macro compiler</TITLE> |
<TITLE>mdocml | UNIX manpage compiler</TITLE> |
</HEAD> |
</HEAD> |
<BODY> |
<BODY> |
<P CLASS="head"> |
<P CLASS="head"> |
<B>mdocml</B> – mdoc macro compiler |
<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> |
|
<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> |
<H1> |
<A NAME="description">Description</A> |
<A NAME="description">Description</A> |
</H1> |
</H1> |
<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="https://www.isc.org/downloads/software-support-policy/isc-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 all of which is GPL. 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; and <A |
We strive to support all interested free operating systems, in particular |
HREF="mandocdb.8.html">mandocdb</A>, for indexing manuals. |
<A CLASS="external" HREF="http://www.dragonflybsd.org/">DragonFly</A>, |
It is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project. |
<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> |
<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 ISO C99 and should build and run on any modern system; however, you'll need <A |
HREF="mandocdb.8.html">mandocdb</A> requires <A CLASS="external" |
HREF="http://www.sqlite.org">sqlite3</A> to build <A HREF="apropos.1.html">apropos</A> (links to whatis), |
HREF="http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html">Berkeley Database</A>, installed by |
<A HREF="man.cgi.7.html">man.cgi</A>, and <A HREF="mandocdb.8.html">mandocdb</A>. |
default on all BSD UNIX operating systems). |
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> |
</P> |
<P> |
|
To compile <SPAN CLASS="nm">mdocml</SPAN>, run <CODE>make</CODE>, then <CODE>make install</CODE> to install into |
|
<I>/usr/local</I>. Be aware: if you have an existing <A HREF="http://www.gnu.org/software/groff/" |
|
CLASS="external">groff</A> installation, this may overwrite its <B>preconv</B> binary. The <A |
|
HREF="mandocdb.8.html">mandocdb</A> utility is not yet linked to the build: you must run <CODE>make mandocdb</CODE> to |
|
build it (it does not install). |
|
</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 |
Downstream |
</H2> |
</H2> |
<TABLE WIDTH="100%" SUMMARY="Current Sources"> |
<P> |
<COL WIDTH="200"> |
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> |
<COL> |
<TBODY> |
<TBODY> |
<TR> |
<TR> |
<TD>Source archive</TD> |
<TD>DragonFly BSD</TD> |
<TD> |
<TD> |
<A HREF="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</A> |
<A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/contrib/mdocml" CLASS="external">contrib/mdocml</A> (1.12.3 sources) |
<SMALL>(<A HREF="/snapshots/mdocml.md5">md5</A>)</SMALL> |
<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> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD>Online source</TD> |
<TD>FreeBSD 10.0, -CURRENT</TD> |
<TD> |
<TD> |
<A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A> |
<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> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD>Win32 (i686) binary archive</TD> |
<TD>FreeBSD 9.x, 8.x</TD> |
<TD> |
<TD> |
<A HREF="/binaries/mdocml-win32.zip">/binaries/mdocml-win32.zip</A> |
<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> |
<TD>Win64 (x86_64) binary archive</TD> |
<TD>NetBSD</TD> |
<TD> |
<TD> |
<A HREF="/binaries/mdocml-win64.zip">/binaries/mdocml-win64.zip</A> |
<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> |
</TD> |
</TR> |
</TR> |
</TBODY> |
|
</TABLE> |
|
<H2> |
|
Downstream |
|
</H2> |
|
<TABLE WIDTH="100%" SUMMARY="Downstream Sources"> |
|
<COL WIDTH="200"> |
|
<COL> |
|
<TBODY> |
|
<TR> |
<TR> |
<TD>DragonFly BSD</TD> |
<TD>OpenBSD</TD> |
<TD> |
<TD> |
<A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc" |
<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) |
CLASS="external">usr.bin/mandoc</A> |
|
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD>FreeBSD</TD> |
<TD>pkgsrc</TD> |
<TD> |
<TD> |
<A HREF="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/" |
<A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/pkgsrc/textproc/mdocml/" CLASS="external">textproc/mdocml</A> (1.12.3 port) |
CLASS="external">ports/textproc/mdocml</A> |
|
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD>NetBSD</TD> |
<TD>Minix3</TD> |
<TD> |
<TD> |
<A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/" |
<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) |
CLASS="external">src/external/bsd/mdocml</A> |
|
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD>OpenBSD</TD> |
<TD>Alpine Linux</TD> |
<TD> |
<TD> |
<A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/" |
<A HREF="http://git.alpinelinux.org/cgit/aports/tree/main/mdocml" CLASS="external">aports/main/mdocml</A> (1.12.2 port) |
CLASS="external">src/usr.bin/mandoc</A> |
|
</TD> |
</TD> |
</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="apropos.1.html">apropos(1)</A></TD> |
<TD VALIGN="top"> |
<TD VALIGN="top"> |
format and display UNIX manuals |
search the manual page database |
<SMALL> |
|
(<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>) |
|
</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="mandocdb.8.txt">text</A> | |
|
<A HREF="mandocdb.8.xhtml">xhtml</A> | |
|
<A HREF="mandocdb.8.pdf">pdf</A> | |
|
<A HREF="mandocdb.8.ps">postscript</A>) |
|
</SMALL> |
|
</TD> |
</TD> |
</TR> |
</TR> |
<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"><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.xhtml">xhtml</A> | |
|
<A HREF="preconv.1.pdf">pdf</A> | |
|
<A HREF="preconv.1.ps">postscript</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.xhtml">xhtml</A> | |
|
<A HREF="mandoc.3.pdf">pdf</A> | |
|
<A HREF="mandoc.3.ps">postscript</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="tbl.3.html">tbl(3)</A></TD> |
<TD VALIGN="top"> |
<TD VALIGN="top"> |
man language reference |
roff table parser library for mandoc |
<SMALL> |
|
(<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>) |
|
</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.xhtml">xhtml</A> | |
|
<A HREF="eqn.7.pdf">pdf</A> | |
|
<A HREF="eqn.7.ps">postscript</A>) |
|
</SMALL> |
|
</TD> |
</TD> |
</TR> |
</TR> |
<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"><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.xhtml">xhtml</A> | |
|
<A HREF="mandoc_char.7.pdf">pdf</A> | |
|
<A HREF="mandoc_char.7.ps">postscript</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.xhtml">xhtml</A> | |
|
<A HREF="mdoc.7.pdf">pdf</A> | |
|
<A HREF="mdoc.7.ps">postscript</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.xhtml">xhtml</A> | |
|
<A HREF="roff.7.pdf">pdf</A> | |
|
<A HREF="roff.7.ps">postscript</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.xhtml">xhtml</A> | |
|
<A HREF="tbl.7.pdf">pdf</A> | |
|
<A HREF="tbl.7.ps">postscript</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 |
|
</TD> |
|
</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> |
<P> |
<P> |
Use the mailing lists for bug-reports, patches, questions, etc. (these require subscription). Please check the |
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 |
<A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues |
before posting. Beyond that, contact Kristaps at <A |
before posting. All lists are subscription-only: send a blank e-mail to the listed address to subscribe. Beyond that, |
HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal |
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. |
this e-mail address">kris...</A>@bsd.lv. Archives are available at <A HREF="http://gmane.org/" CLASS="external">Gmane</A>. |
</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> |
|
</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> |
|
</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> |
|
</TD> |
</TD> |
</TR> |
</TR> |
</TBODY> |
</TBODY> |
|
|
<A NAME="news">News</A> |
<A NAME="news">News</A> |
</H1> |
</H1> |
<P CLASS="news"> |
<P CLASS="news"> |
16-08-2011: version 1.11.6 |
xx-xx-2014: version 1.13.0 |
</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 |
The <A HREF="mandocdb.8.html">mandocdb</A> tools (<A HREF="mandocdb.8.html">mandocdb</A>, <A |
readable. Hyphenation is also now enabled in <A HREF="man.7.html">man</A> format documents. Many other general |
HREF="apropos.1.html">apropos</A> (absorbing whatis), and <A HREF="man.cgi.7.html">man.cgi</A>) have been re-written to |
improvements have been implemented, and a 64-bit Windows binary is now available at <A |
use <A CLASS="external" HREF="http://www.sqlite.org">sqlite3</A> as a database. |
HREF="/binaries/mdocml-win64.zip">/binaries/mdocml-win64.zip</A>. |
|
</P> |
</P> |
<P CLASS="news"> |
<P CLASS="news"> |
24-07-2011: version 1.11.5 |
31-12-2013: version 1.12.3 |
</P> |
</P> |
<P> |
<P> |
Significant <A HREF="eqn.7.html">eqn</A> improvements. <SPAN CLASS="nm">mdocml</SPAN> can now parse arbitrary eqn input |
In the <A HREF="mdoc.7.html">mdoc(7)</A> SYNOPSIS, line breaks and hanging indentation |
(although few GNU extensions are accepted, nor is mixing low-level roff with eqn). See the <A HREF="eqn.7.html">eqn</A> |
now work correctly for .Fo/.Fa/.Fc and .Fn blocks. |
manual for details. For the time being, equations are rendered as simple in-line text. The equation parser satisfies |
Thanks to Franco Fichtner for doing part of the work. |
the language specified in the <A CLASS="external" HREF="http://www.kohala.com/start/troff/v7man/eqn/eqn2e.ps">Second |
|
Edition User's Guide</A>. |
|
</P> |
</P> |
<P> |
<P> |
This is also the first release featuring a distributed Windows binary, available at <A |
The <A HREF="mdoc.7.html">mdoc(7)</A> .Bk macro got some addititonal bugfixes. |
HREF="/binaries/mdocml-win32.zip">/binaries/mdocml-win32.zip</A>. |
|
</P> |
</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"> |
12-07-2011: version 1.11.4 |
05-10-2013: version 1.12.2 |
</P> |
</P> |
<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 |
The <A HREF="mdoc.7.html">mdoc(7)</A> to <A HREF="man.7.html">man(7)</A> converter, |
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 |
to be called as <CODE>mandoc -Tman</CODE>, is now fully functional. |
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 |
The <A HREF="mandoc.1.html">mandoc(1)</A> utility now supports the <CODE>-Ios</CODE> (default operating system) |
historical notes. |
input option, and the <CODE>-Tutf8</CODE> output mode now actually works. |
</P> |
</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"> |
<P CLASS="foot"> |
<SMALL> |
<SMALL> |
Copyright © 2008–2011 |
Copyright © 2008–2011 |
<A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>, |
<A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>, |
|
© 2013 Ingo Schwarze, |
$Date$ |
$Date$ |
</SMALL> |
</SMALL> |
</P> |
</P> |