version 1.88, 2010/07/26 10:00:15 |
version 1.154.2.15, 2013/12/31 11:23:23 |
|
|
<HTML> |
<HTML> |
<HEAD> |
<HEAD> |
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8"> |
<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"> |
<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> |
<TABLE CLASS="frame" SUMMARY="[frame]"> |
<P CLASS="head"> |
<COL WIDTH="100%"> |
<A HREF="http://www.openbsd.org/"><IMG SRC="puffy.gif" ALT="Puffy" WIDTH="100" HEIGHT="91" STYLE="float: right"></A> |
<TBODY> |
<B>mdocml</B> – UNIX manpage compiler, current version @VERSION@ (@VDATE@) |
<TR> |
</P> |
<TD> |
<P CLASS="subhead"> |
<DIV CLASS="head"> |
Sources: <A HREF="/snapshots/mdocml.tar.gz">current</A>, |
<B>mdocml</B> – mdoc macro compiler |
<A HREF="/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A> |
</DIV> |
(<A HREF="/snapshots/">archives</A>) |
</TD> |
</P> |
</TR> |
<H1> |
<TR> |
<A NAME="description">Description</A> |
<TD VALIGN="top"> |
</H1> |
<H1> |
<P> |
<A NAME="description">DESCRIPTION</A> |
<SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <I><A HREF="mdoc.7.html">mdoc</A></I>, the roff macro |
</H1> |
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="http://www.isc.org/software/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> should build and run on any modern system with |
|
<A HREF="http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html">libdb</A> |
|
(this is installed by default on BSD UNIX systems — see the <I>Makefile</I> if you're running Linux). |
|
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 |
|
may be 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://pkgsrc.se/textproc/mdocml" CLASS="external">textproc/mdocml</A> (1.12.2 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> |
<TABLE WIDTH="100%" SUMMARY="Documentation"> |
<SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <Q>-<A HREF="mdoc.7.html">mdoc</A></Q>, the |
<COL WIDTH="175"> |
roff macro package of choice for BSD manual pages, and <Q>-<A HREF="man.7.html">man</A></Q>, the |
<COL> |
predominant historical package for UNIX manuals. The mission of <SPAN CLASS="nm">mdocml</SPAN> is to |
<TBODY> |
deprecate <A HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU troff |
<TR> |
implementation, for displaying -mdoc pages whilst providing token support for -man. |
<TD VALIGN="top"><A HREF="apropos.1.html">apropos(1)</A></TD> |
</P> |
<TD VALIGN="top"> |
|
search the manual page database |
<P> |
</TD> |
Why? groff amounts to over 5 MB of source code, most of which is C++ and all of which is GPL. It runs |
</TR> |
slowly, produces uncertain output, and varies in operation from system to system. mdocml strives to fix |
<TR> |
this (respectively small, C, <A CLASS="external" |
<TD VALIGN="top"><A HREF="demandoc.1.html">demandoc(1)</A></TD> |
HREF="http://www.isc.org/software/license">ISC</A>-licensed, fast and regular). |
<TD VALIGN="top"> |
</P> |
emit only text of UNIX manuals |
|
</TD> |
<P> |
</TR> |
<SPAN CLASS="nm">mdocml</SPAN> consists of the <A HREF="mdoc.3.html">libmdoc</A>, <A |
<TR> |
HREF="man.3.html">libman</A>, and <A HREF="roff.3.html">libroff</A> validating compilers; and <A |
<TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD> |
HREF="mandoc.1.html">mandoc</A>, which interfaces with the compiler libraries to format output for UNIX |
<TD VALIGN="top"> |
terminals, XHTML, HTML, and PostScript. <SPAN CLASS="nm">mdocml</SPAN> is a <A CLASS="external" |
format and display UNIX manuals |
HREF="http://bsd.lv/">BSD.lv</A> project. |
</TD> |
</P> |
</TR> |
|
<TR> |
<P> |
<TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD> |
<I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, |
<TD VALIGN="top"> |
<Q>mandoc</Q>. |
recode multibyte UNIX manuals |
</P> |
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD VALIGN="top"><A HREF="whatis.1.html">whatis(1)</A></TD> |
<TD> |
<TD VALIGN="top"> |
<H1> |
search the manual page database |
<A NAME="sources">SOURCES</A> |
</TD> |
</H1> |
</TR> |
|
<TR> |
<P> |
<TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD> |
<SPAN CLASS="nm">mdocml</SPAN> is architecture- and system-neutral, written in plain-old C. The most |
<TD VALIGN="top"> |
current version is <SPAN CLASS="attn">@VERSION@</SPAN>, dated <SPAN class="attn">@VDATE@</SPAN>. A full |
mandoc macro compiler library |
<A HREF="ChangeLog.html">ChangeLog</A> (<A HREF="ChangeLog.txt">txt</A>) is written with each release. |
</TD> |
</P> |
</TR> |
|
<TR> |
<H2> |
<TD VALIGN="top"><A HREF="tbl.3.html">tbl(3)</A></TD> |
Current |
<TD VALIGN="top"> |
</H2> |
roff table parser library for mandoc |
|
</TD> |
<TABLE WIDTH="100%" SUMMARY="Current Sources"> |
</TR> |
<COL WIDTH="200"> |
<TR> |
<COL> |
<TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD> |
<TBODY> |
<TD VALIGN="top"> |
<TR> |
eqn-mandoc language reference |
<TD>Source archive</TD> |
</TD> |
<TD> |
</TR> |
<A HREF="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</A> |
<TR> |
(<A HREF="/snapshots/mdocml.md5">md5</A>) |
<TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD> |
</TD> |
<TD VALIGN="top"> |
</TR> |
man language reference |
<TR> |
</TD> |
<TD>Online source</TD> |
</TR> |
<TD> |
<TR> |
<A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A> |
<TD VALIGN="top"><A HREF="man.cgi.7.html">man.cgi(7)</A></TD> |
</TD> |
<TD VALIGN="top"> |
</TR> |
cgi for manpage query and display |
</TBODY> |
</TD> |
</TABLE> |
</TR> |
|
<TR> |
<H2> |
<TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD> |
Downstream |
<TD VALIGN="top"> |
</H2> |
mandoc special characters |
|
</TD> |
<TABLE WIDTH="100%" SUMMARY="Downstream Sources"> |
</TR> |
<COL WIDTH="200"> |
<TR> |
<COL> |
<TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD> |
<TBODY> |
<TD VALIGN="top"> |
<TR> |
mdoc language reference |
<TD>DragonFly BSD</TD> |
</TD> |
<TD> |
</TR> |
<A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc" |
<TR> |
CLASS="external">usr.bin/mandoc</A> |
<TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD> |
</TD> |
<TD VALIGN="top"> |
</TR> |
roff-mandoc language reference |
<TR> |
</TD> |
<TD>FreeBSD</TD> |
</TR> |
<TD> |
<TR> |
<A HREF="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/" |
<TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD> |
CLASS="external">ports/textproc/mdocml</A> |
<TD VALIGN="top"> |
</TD> |
tbl-mandoc language reference |
</TR> |
</TD> |
<TR> |
</TR> |
<TD>NetBSD</TD> |
<TR> |
<TD> |
<TD VALIGN="top"><A HREF="catman.8.html">catman(8)</A></TD> |
<A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/" |
<TD VALIGN="top"> |
CLASS="external">src/external/bsd/mdocml</A> |
update a man.cgi manpage cache |
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD>OpenBSD</TD> |
<TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD> |
<TD> |
<TD VALIGN="top"> |
<A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/" |
index UNIX manuals |
CLASS="external">src/usr.bin/mandoc</A> |
</TD> |
</TD> |
</TR> |
</TR> |
</TBODY> |
</TBODY> |
</TABLE> |
</TABLE> |
<H2> |
|
<A NAME="links">Supplementary Information</A> |
<H2> |
</H2> |
Historical |
<UL> |
</H2> |
<LI> |
|
<A HREF="http://manpages.bsd.lv/">Practical UNIX Manuals</A>: mdoc tutorial by Kristaps Dzonsons |
<TABLE WIDTH="100%" SUMMARY="Archived Sources"> |
</LI> |
<COL WIDTH="200"> |
<LI> |
<COL> |
<A HREF="http://www.openbsd.org/faq/ports/specialtopics.html#Mandoc" CLASS="external">OpenBSD porting guide</A> |
<TBODY> |
chapter regarding manual pages |
<TR> |
</LI> |
<TD>Source archive</TD> |
<LI> |
<TD> |
<A HREF="press.html">Publications and media coverage</A> |
<A HREF="/snapshots/">/snapshots/</A> |
concerning mdocml and mandoc |
</TD> |
</LI> |
</TR> |
<LI> |
</TBODY> |
<A HREF="http://manpages.bsd.lv/history.html">History of UNIX Manpages</A>: a comprehensive overview by Kristaps Dzonsons |
</TABLE> |
</LI> |
</TD> |
</UL> |
</TR> |
<H1> |
<TR> |
<A NAME="contact">Contact</A> |
<TD> |
</H1> |
<H1> |
<P> |
<A NAME="documentation">DOCUMENTATION</A> |
Use the mailing lists for bug-reports, patches, questions, etc. Please check the |
</H1> |
<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, |
<P> |
contact Kristaps at <A HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal |
These manuals are generated automatically and refer to the current snapshot. |
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="Documentation"> |
<COL WIDTH="175"> |
<COL WIDTH="200"> |
<COL> |
<COL> |
<TBODY> |
<TBODY> |
<TR> |
<TR> |
<TD> |
<TD VALIGN="top"><A HREF="man.3.html">man(3)</A></TD> |
disc<A CLASS="external" TITLE="Reveal this e-mail address" |
<TD VALIGN="top"> |
HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv |
man macro compiler library |
</TD> |
<SPAN STYLE="font-size: smaller;"> |
<TD> |
(<A HREF="man.3.txt">text</A> | <A HREF="man.3.ps">postscript</A>) |
bug-reports, general questions, and announcements |
</SPAN> |
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD> |
<TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD> |
tec<A CLASS="external" TITLE="Reveal this e-mail address" |
<TD VALIGN="top"> |
HREF="http://www.google.com/recaptcha/mailhide/d?k=01qDX_iV0RlUOarEvb6mR28g==&c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...</A>@mdocml.bsd.lv |
man language reference |
</TD> |
<SPAN STYLE="font-size: smaller;"> |
<TD> |
(<A HREF="man.7.txt">text</A> | <A HREF="man.7.ps">postscript</A>) |
patches and system discussions |
</SPAN> |
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD> |
<TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD> |
sou<A CLASS="external" TITLE="Reveal this e-mail address" |
<TD VALIGN="top"> |
HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</A>@mdocml.bsd.lv |
format and display UNIX manuals |
</TD> |
<SPAN STYLE="font-size: smaller;"> |
<TD> |
(<A HREF="mandoc.1.txt">text</A> | <A HREF="mandoc.1.ps">postscript</A>) |
source commit messages |
</SPAN> |
</TD> |
</TD> |
</TR> |
</TR> |
</TBODY> |
<TR> |
</TABLE> |
<TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD> |
<H1> |
<TD VALIGN="top"> |
<A NAME="news">News</A> |
mandoc special characters |
</H1> |
<SPAN STYLE="font-size: smaller;"> |
<P CLASS="news"> |
(<A HREF="mandoc_char.7.txt">text</A> | <A |
31-12-2013: version 1.12.3 |
HREF="mandoc_char.7.ps">postscript</A>) |
</P> |
</SPAN> |
<P> |
</TD> |
In the <A HREF="mdoc.7.html">mdoc(7)</A> SYNOPSIS, line breaks and hanging indentation |
</TR> |
now work correctly for .Fo/.Fa/.Fc and .Fn blocks. |
<TR> |
Thanks to Franco Fichtner for doing part of the work. |
<TD VALIGN="top"><A HREF="mdoc.3.html">mdoc(3)</A></TD> |
</P> |
<TD VALIGN="top"> |
<P> |
mdoc macro compiler library |
The <A HREF="mdoc.7.html">mdoc(7)</A> .Bk macro got some addititonal bugfixes. |
<SPAN STYLE="font-size: smaller;"> |
</P> |
(<A HREF="mdoc.3.txt">text</A> | <A HREF="mdoc.3.ps">postscript</A>) |
<P> |
</SPAN> |
In <A HREF="mdoc.7.html">mdoc(7)</A> macro arguments, double quotes can now be quoted |
</TD> |
by doubling them, just like in <A HREF="man.7.html">man(7)</A>. |
</TR> |
Thanks to Tsugutomo ENAMI for the patch. |
<TR> |
</P> |
<TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD> |
<P> |
<TD VALIGN="top"> |
At the end of <A HREF="man.7.html">man(7)</A> macro lines, end-of-sentence spacing |
mdoc language reference |
now works. Thanks to Franco Fichtner for the patch. |
<SPAN STYLE="font-size: smaller;"> |
</P> |
(<A HREF="mdoc.7.txt">text</A> | <A HREF="mdoc.7.ps">postscript</A>) |
<P> |
</SPAN> |
For backward compatibility, the <A HREF="man.7.html">man(7)</A> parser now supports the |
</TD> |
man-ext .UR/.UE (uniform resource identifier) block macros. |
</TR> |
</P> |
<TR> |
<P> |
<TD VALIGN="top"><A HREF="roff.3.html">roff(3)</A></TD> |
The <A HREF="man.7.html">man(7)</A> parser now handles closing blocks that are not open |
<TD VALIGN="top"> |
more gracefully. |
roff macro compiler library |
</P> |
<SPAN STYLE="font-size: smaller;"> |
<P> |
(<A HREF="roff.3.txt">text</A> | <A HREF="roff.3.ps">postscript</A>) |
The <A HREF="man.7.html">man(7)</A> parser now ignores blank lines right after .SH and .SS. |
</SPAN> |
</P> |
</TD> |
<P> |
</TR> |
In the <A HREF="man.7.html">man(7)</A> formatter, reset indentation when leaving a block, |
<TR> |
not just when entering the next one. |
<TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD> |
</P> |
<TD VALIGN="top"> |
<P> |
roff-mandoc language reference |
The <A HREF="roff.7.html">roff(7)</A> .nr request now supports incrementing and decrementing |
<SPAN STYLE="font-size: smaller;"> |
number registers and stops parsing the number right before the first non-digit character. |
(<A HREF="roff.7.txt">text</A> | <A HREF="roff.7.ps">postscript</A>) |
</P> |
</SPAN> |
<P> |
</TD> |
The <A HREF="roff.7.html">roff(7)</A> parser now supports the alternative escape sequence |
</TR> |
syntax \C'uXXXX' for Unicode characters. |
</TBODY> |
</P> |
</TABLE> |
<P> |
|
The <A HREF="roff.7.html">roff(7)</A> parser now parses and ignores the .fam (font family) |
<P> |
and .hw (hyphenation points) requests and the \d and \u escape sequences. |
See <Q><A CLASS="external" HREF="http://manpages.bsd.lv">Writing UNIX Manual Pages</A></Q> for a general |
</P> |
introduction to manpages and mdoc. |
<P> |
</P> |
The <A HREF="roff.7.html">roff(7)</A> manual got a new ESCAPE SEQUENCE REFERENCE. |
</TD> |
</P> |
</TR> |
<P CLASS="news"> |
<TR> |
05-10-2013: version 1.12.2 |
<TD> |
</P> |
<H1> |
<P> |
<A NAME="contact">CONTACT</A> |
The <A HREF="mdoc.7.html">mdoc(7)</A> to <A HREF="man.7.html">man(7)</A> converter, |
</H1> |
to be called as <CODE>mandoc -Tman</CODE>, is now fully functional. |
|
</P> |
<P> |
<P> |
Please use the mailing lists for bug-reports, patches, questions, etc. Beyond that, contact |
The <A HREF="mandoc.1.html">mandoc(1)</A> utility now supports the <CODE>-Ios</CODE> (default operating system) |
Kristaps at <A |
input option, and the <CODE>-Tutf8</CODE> output mode now actually works. |
HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" |
</P> |
TITLE="Reveal this e-mail address">kris...</A>@bsd.lv. |
<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> |
You may also subscribe to several mailing lists (these require subscription, which is |
<P> |
moderated). An archive is not yet available on-line, although you may request one once |
The <A HREF="man.7.html">man(7)</A> parser now supports the <EM>PD</EM> macro (paragraph distance), |
subscribed. |
and (for GNU man-ext compatibility only) <EM>EX</EM> (example block) and <EM>EE</EM> (example end). |
</P> |
Plus several bugfixes regarding indentation, line breaks, and vertical spacing, |
|
and regarding <EM>RS</EM> following <EM>TP</EM>. |
<TABLE WIDTH="100%" SUMMARY="Mailing Lists"> |
</P> |
<COL WIDTH="200"> |
<P> |
<COL> |
The <A HREF="roff.7.html">roff(7)</A> parser now supports the <EM>\f(BI</EM> (bold+italic) font escape, |
<TBODY> |
the <EM>\z</EM> (zero cursor advance) escape and the <EM>cc</EM> (change control character) |
<TR> |
and <EM>it</EM> (input line trap) requests. |
<TD> |
Plus bugfixes regarding the <EM>\t</EM> (tab) escape, nested escape sequences, and conditional requests. |
disc<A CLASS="external" TITLE="Reveal this e-mail address" |
</P> |
HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv |
<P> |
</TD> |
In <A HREF="mdoc.7.html">mdoc(7)</A>, several bugs were fixed related to UTF-8 output of quoting enclosures, |
<TD>bug-reports, general questions, and announcements</TD> |
delimiter handling, list indentation and horizontal and vertical spacing, |
</TR> |
formatting of the <EM>Lk</EM>, <EM>%U</EM>, and <EM>%C</EM> macros, |
<TR> |
plus some bugfixes related to the handling of syntax errors like badly nested font blocks, |
<TD> |
stray <EM>Ta</EM> macros outside column lists, unterminated <EM>It Xo</EM> blocks, |
tec<A CLASS="external" TITLE="Reveal this e-mail address" |
and non-text children of <EM>Nm</EM> blocks. |
HREF="http://www.google.com/recaptcha/mailhide/d?k=01qDX_iV0RlUOarEvb6mR28g==&c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...</A>@mdocml.bsd.lv |
</P> |
</TD> |
<P> |
<TD>patches and system discussions</TD> |
In <A HREF="tbl.7.html">tbl(7)</A>, the width of horizontal spans and the vertical spacing around tables was corrected, |
</TR> |
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. |
<TR> |
</P> |
<TD> |
<P> |
sou<A CLASS="external" TITLE="Reveal this e-mail address" |
For mandoc developers, we now provide a <A HREF="tbl.3.html">tbl(3)</A> library manual and <CODE>gmdiff</CODE>, |
HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</A>@mdocml.bsd.lv |
a very small, very simplistic groff-versus-mandoc output comparison tool. |
</TD> |
</P> |
<TD>source commit messages</TD> |
<H2> |
</TR> |
<A>History</A> |
</TBODY> |
</H2> |
</TABLE> |
<UL> |
</TD> |
<LI> |
</TR> |
<A HREF="NEWS">Release notes</A> going back to release 1.9.15, February 18, 2010. |
<TR> |
Briefly explaining the most important changes in each release in relatively easy terms. |
<TD> |
Very many changes are not mentioned here. |
<H1> |
</LI> |
<A NAME="news">NEWS</A> |
<LI> |
</H1> |
<A HREF="history.html">Development history</A> going back to the beginning of the project, November 22, 2008. |
<DIV CLASS="news"> |
One-line entries for important commits, releases, merges, hackathons and talks. |
<P> |
Makes it easy to find out who did what, and when, and when it became available where. |
<SPAN CLASS="date">XX-07-2010</SPAN>: |
However, this is still incomplete, mentioning only a small fraction of all commits, |
version 1.10.5 |
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. |
Purely a bug-fix and polish release. Highlights: |
</LI> |
</P> |
<LI> |
<UL> |
<A HREF="ChangeLog">CVS ChangeLog</A> going back to the beginning of the project. |
<LI>fix <Q>Sm</Q> handling</LI> |
Very technical information of varying quality, strictly chronological. |
<LI>fix end-of-sentence handling for embedded sentences</LI> |
All commits are mentioned, but some messages neglect to mention some changes. |
<LI>polish <A HREF="man.7.html">man</A> documentation</LI> |
Partly terse, partly detailed and verbose. In any case, the ChangeLog is very long - |
<LI>document all <A HREF="mdoc.7.html">mdoc</A> macros</LI> |
more than 25,000 lines, more than 700 kB. |
<LI>polish <A HREF="mandoc.1.html">mandoc</A> -Tps output</LI> |
</LI> |
<LI>lots of internal clean-ups in character escapes</LI> |
<LI> |
<LI>un-break literal contexts in <A HREF="man.7.html">man</A> documents</LI> |
<A HREF="/cgi-bin/cvsweb/?cvsroot=mdocml">CVS</A> web interface, going back to the beginning of the project. |
<LI>improve -Thtml output for -man</LI> |
Source code, diffs and commit messages for each source file. The real thing. |
<LI>add <A HREF="mandoc.1.html">mandoc</A> -Tpdf support</LI> |
</LI> |
</UL> |
</UL> |
</DIV> |
<P CLASS="foot"> |
<DIV CLASS="news"> |
<SMALL> |
<P> |
Copyright © 2008–2011 |
<SPAN CLASS="date">12-07-2010</SPAN>: |
<A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>, |
version 1.10.4 |
© 2013 Ingo Schwarze, |
</P> |
$Date$ |
<P> |
</SMALL> |
Lots of features developed during both <A CLASS="external" |
</P> |
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> |
|
-Tps 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$ |
|
</DIV> |
|
</TD> |
|
</TR> |
|
</TBODY> |
|
</TABLE> |
|
</BODY> |
</BODY> |
</HTML> |
</HTML> |