| version 1.72, 2010/05/17 23:50:05 |
version 1.154.2.16, 2013/12/31 17:49:37 |
|
|
| <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> |
| DESCRIPTION |
<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="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> 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://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> |
<TABLE WIDTH="100%" SUMMARY="Documentation"> |
| <SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <Q>-mdoc</Q>, the roff macro package |
<COL WIDTH="175"> |
| of choice for BSD manual pages, and <Q>-man</Q>, the predominant historical package for UNIX |
<COL> |
| manuals. The mission of <SPAN CLASS="nm">mdocml</SPAN> is to deprecate <A |
<TBODY> |
| HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU roff implementation, for |
<TR> |
| 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, ISC-licensed, fast and regular). |
<TD VALIGN="top"><A HREF="demandoc.1.html">demandoc(1)</A></TD> |
| </P> |
<TD VALIGN="top"> |
| |
emit only text of UNIX manuals |
| <P> |
</TD> |
| The core of <SPAN CLASS="nm">mdocml</SPAN> is composed of the <i>libmdoc</i> and <i>libman</i> |
</TR> |
| validating compiler libraries. Both are simple, fast libraries operating on memory buffers, so they may |
<TR> |
| be used for a variety of front-ends (terminal-based, CGI and so on). The primary front-end is <i> |
<TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD> |
| mandoc</i>, which formats manuals for display on the terminal. |
<TD VALIGN="top"> |
| </P> |
format and display UNIX manuals |
| |
</TD> |
| <P> |
</TR> |
| The <SPAN CLASS="nm">mdocml</SPAN> utility is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv |
<TR> |
| Project</A> member. |
<TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD> |
| </P> |
<TD VALIGN="top"> |
| </TD> |
recode multibyte UNIX manuals |
| </TR> |
</TD> |
| <TR> |
</TR> |
| <TD> |
<TR> |
| <H1> |
<TD VALIGN="top"><A HREF="whatis.1.html">whatis(1)</A></TD> |
| SOURCES |
<TD VALIGN="top"> |
| </H1> |
search the manual page database |
| |
</TD> |
| <P> |
</TR> |
| Sources correctly build and install on DragonFly BSD, FreeBSD, OpenBSD, NetBSD, and GNU/Linux operating |
<TR> |
| systems, tested variously on i386, AMD64, alpha, and others. The most current version is <SPAN |
<TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD> |
| CLASS="attn">@VERSION@</SPAN>, dated <SPAN class="attn">@VDATE@</SPAN>. A full <A |
<TD VALIGN="top"> |
| HREF="ChangeLog.html">ChangeLog</A> (<A HREF="ChangeLog.txt">txt</A>) is written with each release. |
mandoc macro compiler library |
| </P> |
</TD> |
| |
</TR> |
| <H2> |
<TR> |
| Current |
<TD VALIGN="top"><A HREF="tbl.3.html">tbl(3)</A></TD> |
| </H2> |
<TD VALIGN="top"> |
| |
roff table parser library for mandoc |
| <TABLE WIDTH="100%" SUMMARY="Current Sources"> |
</TD> |
| <COL WIDTH="200"> |
</TR> |
| <COL> |
<TR> |
| <TBODY> |
<TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD> |
| <TR> |
<TD VALIGN="top"> |
| <TD>Source archive</TD> |
eqn-mandoc language reference |
| <TD> |
</TD> |
| <A HREF="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</A> |
</TR> |
| (<A HREF="/snapshots/mdocml.md5">md5</A>) |
<TR> |
| </TD> |
<TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD> |
| </TR> |
<TD VALIGN="top"> |
| <TR> |
man language reference |
| <TD>Online source</TD> |
</TD> |
| <TD> |
</TR> |
| <A CLASS="external" HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A> |
<TR> |
| </TD> |
<TD VALIGN="top"><A HREF="man.cgi.7.html">man.cgi(7)</A></TD> |
| </TR> |
<TD VALIGN="top"> |
| </TBODY> |
cgi for manpage query and display |
| </TABLE> |
</TD> |
| |
</TR> |
| <H2> |
<TR> |
| Downstream |
<TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD> |
| </H2> |
<TD VALIGN="top"> |
| |
mandoc special characters |
| <TABLE WIDTH="100%" SUMMARY="Downstream Sources"> |
</TD> |
| <COL WIDTH="200"> |
</TR> |
| <COL> |
<TR> |
| <TBODY> |
<TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD> |
| <TR> |
<TD VALIGN="top"> |
| <TD>DragonFly BSD</TD> |
mdoc language reference |
| <TD> |
</TD> |
| <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc" |
</TR> |
| CLASS="external">usr.bin/mandoc</A> |
<TR> |
| </TD> |
<TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD> |
| </TR> |
<TD VALIGN="top"> |
| <TR> |
roff-mandoc language reference |
| <TD>FreeBSD</TD> |
</TD> |
| <TD> |
</TR> |
| <A HREF="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/" |
<TR> |
| CLASS="external">ports/textproc/mdocml</A> |
<TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD> |
| </TD> |
<TD VALIGN="top"> |
| </TR> |
tbl-mandoc language reference |
| <TR> |
</TD> |
| <TD>NetBSD</TD> |
</TR> |
| <TD> |
<TR> |
| <A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/" |
<TD VALIGN="top"><A HREF="catman.8.html">catman(8)</A></TD> |
| CLASS="external">src/external/bsd/mdocml</A> |
<TD VALIGN="top"> |
| </TD> |
update a man.cgi manpage cache |
| </TR> |
</TD> |
| <TR> |
</TR> |
| <TD>OpenBSD</TD> |
<TR> |
| <TD> |
<TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD> |
| <A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/" |
<TD VALIGN="top"> |
| CLASS="external">src/usr.bin/mandoc</A> |
index UNIX manuals |
| </TD> |
</TD> |
| </TR> |
</TR> |
| </TBODY> |
</TBODY> |
| </TABLE> |
</TABLE> |
| |
<H2> |
| <H2> |
<A NAME="links">Supplementary Information</A> |
| Historical |
</H2> |
| </H2> |
<UL> |
| |
<LI> |
| <TABLE WIDTH="100%" SUMMARY="Archived Sources"> |
<A HREF="http://manpages.bsd.lv/">Practical UNIX Manuals</A>: mdoc tutorial by Kristaps Dzonsons |
| <COL WIDTH="200"> |
</LI> |
| <COL> |
<LI> |
| <TBODY> |
<A HREF="http://www.openbsd.org/faq/ports/specialtopics.html#Mandoc" CLASS="external">OpenBSD porting guide</A> |
| <TR> |
chapter regarding manual pages |
| <TD>Source archive</TD> |
</LI> |
| <TD> |
<LI> |
| <A HREF="/snapshots/">/snapshots/</A> |
<A HREF="press.html">Publications and media coverage</A> |
| </TD> |
concerning mdocml and mandoc |
| </TR> |
</LI> |
| </TBODY> |
<LI> |
| </TABLE> |
<A HREF="http://manpages.bsd.lv/history.html">History of UNIX Manpages</A>: a comprehensive overview by Kristaps Dzonsons |
| </TD> |
</LI> |
| </TR> |
</UL> |
| <TR> |
<H1> |
| <TD> |
<A NAME="contact">Contact</A> |
| <H1> |
</H1> |
| DOCUMENTATION |
<P> |
| </H1> |
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 |
| <P> |
before posting. All lists are subscription-only: send a blank e-mail to the listed address to subscribe. Beyond that, |
| These manuals are generated automatically and refer to the current snapshot. |
contact Kristaps at <A HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal |
| </P> |
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="Documentation"> |
<TABLE WIDTH="100%" SUMMARY="Mailing Lists"> |
| <COL WIDTH="200"> |
<COL WIDTH="175"> |
| <COL> |
<COL> |
| <TBODY> |
<TBODY> |
| <TR> |
<TR> |
| <TD><A HREF="mandoc.1.html">mandoc(1)</A> (<A HREF="mandoc.1.txt">text</A>)</TD> |
<TD> |
| <TD>format and display UNIX manuals</TD> |
disc<A CLASS="external" TITLE="Reveal this e-mail address" |
| </TR> |
HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv |
| <TR> |
</TD> |
| <TD><A HREF="mandoc_char.7.html">mandoc_char(7)</A> (<A HREF="mandoc_char.7.txt">text</A>)</TD> |
<TD> |
| <TD>mandoc special characters</TD> |
bug-reports, general questions, and announcements |
| </TR> |
</TD> |
| <TR> |
</TR> |
| <TD><A HREF="mdoc.7.html">mdoc(7)</A> (<A HREF="mdoc.7.txt">text</A>)</TD> |
<TR> |
| <TD>mdoc language reference</TD> |
<TD> |
| </TR> |
tec<A CLASS="external" TITLE="Reveal this e-mail address" |
| <TR> |
HREF="http://www.google.com/recaptcha/mailhide/d?k=01qDX_iV0RlUOarEvb6mR28g==&c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...</A>@mdocml.bsd.lv |
| <TD><A HREF="man.7.html">man(7)</A> (<A HREF="man.7.txt">text</A>)</TD> |
</TD> |
| <TD>man language reference</TD> |
<TD> |
| </TR> |
patches and system discussions |
| <TR> |
</TD> |
| <TD><A HREF="manuals.7.html">manuals(7)</A> (<A HREF="manuals.7.txt">text</A>)</TD> |
</TR> |
| <TD>a guide to writing UNIX manuals</TD> |
<TR> |
| </TR> |
<TD> |
| <TR> |
sou<A CLASS="external" TITLE="Reveal this e-mail address" |
| <TD><A HREF="mdoc.3.html">mdoc(3)</A> (<A HREF="mdoc.3.txt">text</A>)</TD> |
HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</A>@mdocml.bsd.lv |
| <TD>mdoc macro compiler library</TD> |
</TD> |
| </TR> |
<TD> |
| <TR> |
source commit messages |
| <TD><A HREF="man.3.html">man(3)</A> (<A HREF="man.3.txt">text</A>)</TD> |
</TD> |
| <TD>man macro compiler library</TD> |
</TR> |
| </TR> |
</TBODY> |
| <TR> |
</TABLE> |
| <TD><A HREF="roff.7.html">roff(7)</A> (<A HREF="roff.7.txt">text</A>)</TD> |
<H1> |
| <TD>roff language reference</TD> |
<A NAME="news">News</A> |
| </TR> |
</H1> |
| </TBODY> |
<P CLASS="news"> |
| </TABLE> |
31-12-2013: version 1.12.3 |
| </TD> |
</P> |
| </TR> |
<P> |
| <TR> |
In the <A HREF="mdoc.7.html">mdoc(7)</A> SYNOPSIS, line breaks and hanging indentation |
| <TD> |
now work correctly for .Fo/.Fa/.Fc and .Fn blocks. |
| <H1> |
Thanks to Franco Fichtner for doing part of the work. |
| CONTACT |
</P> |
| </H1> |
<P> |
| |
The <A HREF="mdoc.7.html">mdoc(7)</A> .Bk macro got some addititonal bugfixes. |
| <P> |
</P> |
| For all issues related to <SPAN CLASS="nm">mdocml</SPAN>, contact Kristaps Dzonsons, kris<A |
<P> |
| CLASS="external" |
In <A HREF="mdoc.7.html">mdoc(7)</A> macro arguments, double quotes can now be quoted |
| HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" |
by doubling them, just like in <A HREF="man.7.html">man(7)</A>. |
| TITLE="Reveal this e-mail address">...</A>@bsd.lv. |
Thanks to Tsugutomo ENAMI for the patch. |
| </P> |
</P> |
| |
<P> |
| <P> |
At the end of <A HREF="man.7.html">man(7)</A> macro lines, end-of-sentence spacing |
| You may also subscribe to several mailing lists (these require subscription, which is moderated). An |
now works. Thanks to Franco Fichtner for the patch. |
| archive is not yet available. |
</P> |
| </P> |
<P> |
| |
For backward compatibility, the <A HREF="man.7.html">man(7)</A> parser now supports the |
| <TABLE WIDTH="100%" SUMMARY="Mailing Lists"> |
man-ext .UR/.UE (uniform resource identifier) block macros. |
| <COL WIDTH="200"> |
</P> |
| <COL> |
<P> |
| <TBODY> |
The <A HREF="man.7.html">man(7)</A> parser now handles closing blocks that are not open |
| <TR> |
more gracefully. |
| <TD> |
</P> |
| 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 |
The <A HREF="man.7.html">man(7)</A> parser now ignores blank lines right after .SH and .SS. |
| </TD> |
</P> |
| <TD>high-level discussions and version announcements</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> |
</P> |
| tec<A CLASS="external" TITLE="Reveal this e-mail address" |
<P> |
| HREF="http://www.google.com/recaptcha/mailhide/d?k=014mgcCKFE_qqo9NLETCAiEA==&c=-y6beh3b_SMDe6Iauc3PW-c1wlVbRqYJdj1RETN9WMs=">...</a>@mdocml.bsd.lv |
The <A HREF="roff.7.html">roff(7)</A> .nr request now supports incrementing and decrementing |
| </TD> |
number registers and stops parsing the number right before the first non-digit character. |
| <TD>low-level discussions</TD> |
</P> |
| </TR> |
<P> |
| <TR> |
The <A HREF="roff.7.html">roff(7)</A> parser now supports the alternative escape sequence |
| <TD> |
syntax \C'uXXXX' for Unicode characters. |
| sou<A CLASS="external" TITLE="Reveal this e-mail address" |
</P> |
| HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</a>@mdocml.bsd.lv |
<P> |
| </TD> |
The <A HREF="roff.7.html">roff(7)</A> parser now parses and ignores the .fam (font family) |
| <TD>source commit messages</TD> |
and .hw (hyphenation points) requests and the \d and \u escape sequences. |
| </TR> |
</P> |
| </TBODY> |
<P> |
| </TABLE> |
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> |
| NEWS |
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> |
| <TABLE WIDTH="100%" CELLPADDING="2"> |
<P> |
| <COL CLASS="date"> |
The <A HREF="mandoc.1.html">mandoc(1)</A> utility now supports the <CODE>-Ios</CODE> (default operating system) |
| <TBODY> |
input option, and the <CODE>-Tutf8</CODE> output mode now actually works. |
| <TR> |
</P> |
| <TD VALIGN="top"><SPAN CLASS="date">xx-05-2010</SPAN></TD> |
<P> |
| Day 1 of Rostock hackathon: proper handling of quotations in tab-separated |
The <A HREF="mandocdb.8.html">mandocdb(8)</A> utility no longer truncates existing databases when starting to build new ones, |
| column lists, finished patching of SYNOPSIS breaking (1.9.25), fixed pre-comment |
but only replaces them when the build actually succeeds. |
| white-space stripping, added end-of-sentence spacing to black partial-implicit |
</P> |
| macros, relaxed column warnings, relaxed acceptence of bad standards arguments, |
<P> |
| significant documentation of lists in <A HREF="mdoc.7.html">mdoc(7)</A>. |
The <A HREF="man.7.html">man(7)</A> parser now supports the <EM>PD</EM> macro (paragraph distance), |
| Version: <SPAN CLASS="rev">1.9.26</SPAN>. |
and (for GNU man-ext compatibility only) <EM>EX</EM> (example block) and <EM>EE</EM> (example end). |
| <TD VALIGN="top"> |
Plus several bugfixes regarding indentation, line breaks, and vertical spacing, |
| </TR> |
and regarding <EM>RS</EM> following <EM>TP</EM>. |
| <TR> |
</P> |
| <TD VALIGN="top"><SPAN CLASS="date">13-05-2010</SPAN></TD> |
<P> |
| <TD VALIGN="top"> |
The <A HREF="roff.7.html">roff(7)</A> parser now supports the <EM>\f(BI</EM> (bold+italic) font escape, |
| Fixed handling of <Q>\*(Ba</Q> escape. Backed out <SPAN |
the <EM>\z</EM> (zero cursor advance) escape and the <EM>cc</EM> (change control character) |
| CLASS="flag">-fno-ign-chars</SPAN> (pointless complexity). Fixed erroneous |
and <EM>it</EM> (input line trap) requests. |
| breaking of literal lines. Fixed SYNOPSIS breaking lines before non-initial |
Plus bugfixes regarding the <EM>\t</EM> (tab) escape, nested escape sequences, and conditional requests. |
| macros. Changed default section ordering. Most importantly, the framework for |
</P> |
| end-of-sentence double-spacing is in place, now implemented for the |
<P> |
| <Q>end-of-sentence, end-of-line</Q> rule. This is a stable roll-back point |
In <A HREF="mdoc.7.html">mdoc(7)</A>, several bugs were fixed related to UTF-8 output of quoting enclosures, |
| before the mandoc hackathon in Rostock! |
delimiter handling, list indentation and horizontal and vertical spacing, |
| Version: <SPAN CLASS="rev">1.9.25</SPAN>. |
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, |
| <TR> |
stray <EM>Ta</EM> macros outside column lists, unterminated <EM>It Xo</EM> blocks, |
| <TD VALIGN="top"><SPAN CLASS="date">09-05-2010</SPAN></TD> |
and non-text children of <EM>Nm</EM> blocks. |
| <TD VALIGN="top"> |
</P> |
| Rolled back break-at-hyphen. <SPAN CLASS="flag">-DUGLY</SPAN> is now the |
<P> |
| default (no feature splits!). Free-form text is not de-chunked any more: lines |
In <A HREF="tbl.7.html">tbl(7)</A>, the width of horizontal spans and the vertical spacing around tables was corrected, |
| are passed whole-sale into the front-end, including whitespace. Added mailing |
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. |
| lists. Lastly, <SPAN CLASS="nm">mdocml</SPAN> is the focus of two <A |
</P> |
| CLASS="external" HREF="http://socghop.appspot.com/">Google Summer of Code</A> |
<P> |
| projects this year: <Q><A CLASS="external" |
For mandoc developers, we now provide a <A HREF="tbl.3.html">tbl(3)</A> library manual and <CODE>gmdiff</CODE>, |
| HREF="http://netbsd-soc.sourceforge.net/projects/mandoc_ps/">mandoc -Tps</A></Q> |
a very small, very simplistic groff-versus-mandoc output comparison tool. |
| (NetBSD) and <Q><A CLASS="external" |
</P> |
| HREF="http://wiki.freebsd.org/SummerOfCode2010Projects">BSD-licensed |
<H2> |
| Text-Processing Tools</A></Q> (FreeBSD). |
<A>History</A> |
| Version: <SPAN CLASS="rev">1.9.24</SPAN>. |
</H2> |
| </TD> |
<UL> |
| </TR> |
<LI> |
| |
<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 VALIGN="top"><SPAN CLASS="date">07-04-2010</SPAN></TD> |
Very many changes are not mentioned here. |
| <TD VALIGN="top"> |
</LI> |
| <SPAN CLASS="nm">mdocml</SPAN> has been linked to the <A CLASS="external" |
<LI> |
| HREF="http://www.openbsd.org/faq/current.html#20100403">OpenBSD build</a>. This |
<A HREF="history.html">Development history</A> going back to the beginning of the project, November 22, 2008. |
| version incorporates many small changes, mostly from patches by OpenBSD, |
One-line entries for important commits, releases, merges, hackathons and talks. |
| allowing crufty manuals to slip by with warnings instead of erroring-out. Some |
Makes it easy to find out who did what, and when, and when it became available where. |
| subtle semantic issues, such as punctuation scope, have also been fixed. |
However, this is still incomplete, mentioning only a small fraction of all commits, |
| Lastly, some issues with <SPAN CLASS="flag">-Thtml</SPAN> have been fixed, which |
and to keep the size down, the individual entries are extremely terse and technical. |
| prompted an update to the <A HREF="mandoc.1.html">online</A> <A |
Feel free to look up more details and longer explanations about individual entries |
| HREF="mandoc_char.7.html">manual</A> <A HREF="man.7.html">pages</A> style |
in the ChangeLog or in CVS. |
| layout. Version: <SPAN CLASS="rev">1.9.23</SPAN>. |
</LI> |
| </TD> |
<LI> |
| </TR> |
<A HREF="ChangeLog">CVS ChangeLog</A> going back to the beginning of the project. |
| <TR> |
Very technical information of varying quality, strictly chronological. |
| <TD VALIGN="top"><SPAN CLASS="date">31-03-2010</SPAN></TD> |
All commits are mentioned, but some messages neglect to mention some changes. |
| <TD VALIGN="top"> |
Partly terse, partly detailed and verbose. In any case, the ChangeLog is very long - |
| Version <SPAN CLASS="rev">1.9.22</SPAN>: adjusted merge of the significant work |
more than 25,000 lines, more than 700 kB. |
| by Ingo Schwarze in getting <Q>Xo</Q> blocks (block full implicit, e.g., |
</LI> |
| <Q>It</Q> for non-columnar lists) to work properly. This isn't enabled by |
<LI> |
| default: you must specify <SPAN CLASS="flag">-DUGLY</SPAN> as a compiler flag |
<A HREF="/cgi-bin/cvsweb/?cvsroot=mdocml">CVS</A> web interface, going back to the beginning of the project. |
| (see the Makefile for details). |
Source code, diffs and commit messages for each source file. The real thing. |
| </TD> |
</LI> |
| </TR> |
</UL> |
| <TR> |
<P CLASS="foot"> |
| <TD VALIGN="top"><SPAN CLASS="date">30-03-2010</SPAN></TD> |
<SMALL> |
| <TD VALIGN="top"> |
Copyright © 2008–2011 |
| Version <SPAN CLASS="rev">1.9.20</SPAN>: more efforts to get roff instructions |
<A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>, |
| in -man documents under control. Note that roff instructions embedded in |
© 2013 Ingo Schwarze, |
| line-scoped, next-line macros (e.g. <Q>B</Q>) are not supported. Leading |
$Date$ |
| punctuation for -mdoc macros, such as <Q>Fl ( ( a</Q>, are now correctly |
</SMALL> |
| handled. |
</P> |
| </TD> |
|
| </TR> |
|
| <TR> |
|
| <TD VALIGN="top"><SPAN CLASS="date">27-03-2010</SPAN></TD> |
|
| <TD VALIGN="top"> |
|
| Version <SPAN CLASS="rev">1.9.18</SPAN>: many fixes (largely pertaining to |
|
| scope) and improvements (e.g., handling of apostrophe-control macros, which |
|
| fixes the strange <Q>BR</Q> seen in some macro output) to handling roff |
|
| instructions in -man documents. |
|
| </TD> |
|
| </TR> |
|
| <TR> |
|
| <TD VALIGN="top"><SPAN CLASS="date">25-03-2010</SPAN></TD> |
|
| <TD VALIGN="top"> |
|
| Version <SPAN CLASS="rev">1.9.17</SPAN> highlights: accept <A |
|
| HREF="http://perldoc.perl.org/" CLASS="external">perlpod</A> standard preamble. |
|
| Also accept (and discard) <Q>de</Q>, <Q>dei</Q>, <Q>am</Q>, <Q>ami</Q>, and |
|
| <Q>ig</Q> roff macro blocks. |
|
| </TD> |
|
| </TR> |
|
| <TR> |
|
| <TD VALIGN="top"><SPAN CLASS="date">22-03-2010</SPAN></TD> |
|
| <TD VALIGN="top"> |
|
| Version <SPAN CLASS="rev">1.9.16</SPAN> highlights: inspired by patches and bug |
|
| reports by Ingo Schwarze, allowed <SPAN CLASS="flag">-man</SPAN> to accept |
|
| non-printing elements to be nested within next-line scopes, such as <Q>br</Q> |
|
| within <Q>B</Q> or <Q>TH</Q>, which is valid roff. Longsoon architecture also |
|
| noted and Makefile cleaned up. |
|
| </TD> |
|
| </TR> |
|
| <TR> |
|
| <TD VALIGN="top"><SPAN CLASS="date">18-02-2010</SPAN></TD> |
|
| <TD VALIGN="top"> |
|
| Moved to our new <A HREF="http://bsd.lv" CLASS="external">BSD.lv</A> home. |
|
| Version <SPAN CLASS="rev">1.9.15</SPAN> highlights: XHTML is now an acceptable |
|
| output mode for <A HREF="mandoc.1.html">mandoc(1)</A>; <Q>Xr</Q> made more |
|
| compatible with groff; <Q>Vt</Q> fixed when invoked in SYNOPSIS; <Q>\\</Q> |
|
| escape removed; end-of-line white-space detected for all lines; subtle bug |
|
| fixed in list display for some modes; compatibility layer checked in for |
|
| compilation in diverse UNIX systems; and column lengths handled correctly. |
|
| </TD> |
|
| </TR> |
|
| </TBODY> |
|
| </TABLE> |
|
| </TD> |
|
| </TR> |
|
| <TR> |
|
| <TD> |
|
| <DIV CLASS="foot"> |
|
| Copyright © 2008–2010 Kristaps Dzonsons, $Date$ |
|
| </DIV> |
|
| </TD> |
|
| </TR> |
|
| </TBODY> |
|
| </TABLE> |
|
| </BODY> |
</BODY> |
| </HTML> |
</HTML> |
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to index.sgml CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc