version 1.77, 2010/06/03 14:52:48 |
version 1.88, 2010/07/26 10:00:15 |
|
|
<DIV CLASS="head"> |
<DIV CLASS="head"> |
<B>mdocml</B> – mdoc macro compiler |
<B>mdocml</B> – mdoc macro compiler |
</DIV> |
</DIV> |
<DIV CLASS="subhead"> |
|
<A HREF="#description">Description</A> | |
|
<A HREF="#sources">Sources</A> | |
|
<A HREF="#documentation">Documentation</A> | |
|
<A HREF="#contact">Contact</A> | |
|
<A HREF="#news">News</A> |
|
</DIV> |
|
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
|
|
</H1> |
</H1> |
|
|
<P> |
<P> |
<SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <Q>-mdoc</Q>, the roff macro package |
<SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <Q>-<A HREF="mdoc.7.html">mdoc</A></Q>, the |
of choice for BSD manual pages, and <Q>-man</Q>, the predominant historical package for UNIX |
roff macro package of choice for BSD manual pages, and <Q>-<A HREF="man.7.html">man</A></Q>, the |
manuals. The mission of <SPAN CLASS="nm">mdocml</SPAN> is to deprecate <A |
predominant historical package for UNIX manuals. The mission of <SPAN CLASS="nm">mdocml</SPAN> is to |
HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU roff implementation, for |
deprecate <A HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU troff |
displaying -mdoc pages whilst providing token support for -man. |
implementation, for displaying -mdoc pages whilst providing token support for -man. |
</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 |
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 |
slowly, produces uncertain output, and varies in operation from system to system. mdocml strives to fix |
this (respectively small, C, ISC-licensed, fast and regular). |
this (respectively small, C, <A CLASS="external" |
|
HREF="http://www.isc.org/software/license">ISC</A>-licensed, fast and regular). |
</P> |
</P> |
|
|
<P> |
<P> |
The core of <SPAN CLASS="nm">mdocml</SPAN> is composed of the <A HREF="mdoc.3.html">libmdoc</A>, <A |
<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 compiler libraries. All |
HREF="man.3.html">libman</A>, and <A HREF="roff.3.html">libroff</A> validating compilers; and <A |
are simple, fast libraries operating on memory buffers, so they may be used for a variety of front-ends |
HREF="mandoc.1.html">mandoc</A>, which interfaces with the compiler libraries to format output for UNIX |
(terminal-based, CGI and so on). The front-end is <A HREF="mandoc.1.html">mandoc</A>, which formats |
terminals, XHTML, HTML, and PostScript. <SPAN CLASS="nm">mdocml</SPAN> is a <A CLASS="external" |
manuals for display. |
HREF="http://bsd.lv/">BSD.lv</A> project. |
</P> |
</P> |
|
|
<P> |
<P> |
The <SPAN CLASS="nm">mdocml</SPAN> suite is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv |
<I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, |
Project</A> member. |
<Q>mandoc</Q>. |
</P> |
</P> |
</TD> |
</TD> |
</TR> |
</TR> |
|
|
</H1> |
</H1> |
|
|
<P> |
<P> |
Sources correctly build and install on DragonFly BSD, FreeBSD, OpenBSD, NetBSD, GNU/Linux, and many |
<SPAN CLASS="nm">mdocml</SPAN> is architecture- and system-neutral, written in plain-old C. The most |
other operating systems, tested variously on i386, AMD64, alpha, and others. The most current version |
current version is <SPAN CLASS="attn">@VERSION@</SPAN>, dated <SPAN class="attn">@VDATE@</SPAN>. A full |
is <SPAN CLASS="attn">@VERSION@</SPAN>, dated <SPAN class="attn">@VDATE@</SPAN>. A full <A |
<A HREF="ChangeLog.html">ChangeLog</A> (<A HREF="ChangeLog.txt">txt</A>) is written with each release. |
HREF="ChangeLog.html">ChangeLog</A> (<A HREF="ChangeLog.txt">txt</A>) is written with each release. |
|
</P> |
</P> |
|
|
<H2> |
<H2> |
|
|
</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 snapshot. |
</P> |
</P> |
|
|
<TABLE WIDTH="100%" SUMMARY="Documentation"> |
<TABLE WIDTH="100%" SUMMARY="Documentation"> |
|
|
<COL> |
<COL> |
<TBODY> |
<TBODY> |
<TR> |
<TR> |
<TD><A HREF="man.3.html">man(3)</A> (<A HREF="man.3.txt">text</A>)</TD> |
<TD VALIGN="top"><A HREF="man.3.html">man(3)</A></TD> |
<TD>man macro compiler library</TD> |
<TD VALIGN="top"> |
|
man macro compiler library |
|
<SPAN STYLE="font-size: smaller;"> |
|
(<A HREF="man.3.txt">text</A> | <A HREF="man.3.ps">postscript</A>) |
|
</SPAN> |
|
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD><A HREF="man.7.html">man(7)</A> (<A HREF="man.7.txt">text</A>)</TD> |
<TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD> |
<TD>man language reference</TD> |
<TD VALIGN="top"> |
|
man language reference |
|
<SPAN STYLE="font-size: smaller;"> |
|
(<A HREF="man.7.txt">text</A> | <A HREF="man.7.ps">postscript</A>) |
|
</SPAN> |
|
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD><A HREF="mandoc.1.html">mandoc(1)</A> (<A HREF="mandoc.1.txt">text</A>)</TD> |
<TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD> |
<TD>format and display UNIX manuals</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.ps">postscript</A>) |
|
</SPAN> |
|
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD><A HREF="mandoc_char.7.html">mandoc_char(7)</A> (<A HREF="mandoc_char.7.txt">text</A>)</TD> |
<TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD> |
<TD>mandoc special characters</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.ps">postscript</A>) |
|
</SPAN> |
|
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD><A HREF="manuals.7.html">manuals(7)</A> (<A HREF="manuals.7.txt">text</A>)</TD> |
<TD VALIGN="top"><A HREF="mdoc.3.html">mdoc(3)</A></TD> |
<TD>a guide to writing UNIX manuals</TD> |
<TD VALIGN="top"> |
|
mdoc macro compiler library |
|
<SPAN STYLE="font-size: smaller;"> |
|
(<A HREF="mdoc.3.txt">text</A> | <A HREF="mdoc.3.ps">postscript</A>) |
|
</SPAN> |
|
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD><A HREF="mdoc.3.html">mdoc(3)</A> (<A HREF="mdoc.3.txt">text</A>)</TD> |
<TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD> |
<TD>mdoc macro compiler library</TD> |
<TD VALIGN="top"> |
|
mdoc language reference |
|
<SPAN STYLE="font-size: smaller;"> |
|
(<A HREF="mdoc.7.txt">text</A> | <A HREF="mdoc.7.ps">postscript</A>) |
|
</SPAN> |
|
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD><A HREF="mdoc.7.html">mdoc(7)</A> (<A HREF="mdoc.7.txt">text</A>)</TD> |
<TD VALIGN="top"><A HREF="roff.3.html">roff(3)</A></TD> |
<TD>mdoc language reference</TD> |
<TD VALIGN="top"> |
|
roff macro compiler library |
|
<SPAN STYLE="font-size: smaller;"> |
|
(<A HREF="roff.3.txt">text</A> | <A HREF="roff.3.ps">postscript</A>) |
|
</SPAN> |
|
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD><A HREF="roff.3.html">roff(3)</A> (<A HREF="roff.3.txt">text</A>)</TD> |
<TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD> |
<TD>roff macro compiler library</TD> |
<TD VALIGN="top"> |
|
roff-mandoc language reference |
|
<SPAN STYLE="font-size: smaller;"> |
|
(<A HREF="roff.7.txt">text</A> | <A HREF="roff.7.ps">postscript</A>) |
|
</SPAN> |
|
</TD> |
</TR> |
</TR> |
<TR> |
|
<TD><A HREF="roff.7.html">roff(7)</A> (<A HREF="roff.7.txt">text</A>)</TD> |
|
<TD>roff-mandoc language reference</TD> |
|
</TR> |
|
</TBODY> |
</TBODY> |
</TABLE> |
</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> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
|
|
</H1> |
</H1> |
|
|
<P> |
<P> |
For all issues related to <SPAN CLASS="nm">mdocml</SPAN>, contact Kristaps Dzonsons, kris<A |
Please use the mailing lists for bug-reports, patches, questions, etc. Beyond that, contact |
CLASS="external" |
Kristaps at <A |
HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" |
HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" |
TITLE="Reveal this e-mail address">...</A>@bsd.lv. |
TITLE="Reveal this e-mail address">kris...</A>@bsd.lv. |
</P> |
</P> |
|
|
<P> |
<P> |
You may also subscribe to several mailing lists (these require subscription, which is moderated). An |
You may also subscribe to several mailing lists (these require subscription, which is |
archive is not yet available on-line, although you may request one once subscribed. |
moderated). An archive is not yet available on-line, although you may request one once |
|
subscribed. |
</P> |
</P> |
|
|
<TABLE WIDTH="100%" SUMMARY="Mailing Lists"> |
<TABLE WIDTH="100%" SUMMARY="Mailing Lists"> |
|
|
disc<A CLASS="external" TITLE="Reveal this e-mail address" |
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 |
HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv |
</TD> |
</TD> |
<TD>high-level discussions and version announcements</TD> |
<TD>bug-reports, general questions, and announcements</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD> |
<TD> |
tec<A CLASS="external" TITLE="Reveal this e-mail address" |
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 |
HREF="http://www.google.com/recaptcha/mailhide/d?k=01qDX_iV0RlUOarEvb6mR28g==&c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...</A>@mdocml.bsd.lv |
</TD> |
</TD> |
<TD>low-level discussions</TD> |
<TD>patches and system discussions</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD> |
<TD> |
|
|
</H1> |
</H1> |
<DIV CLASS="news"> |
<DIV CLASS="news"> |
<P> |
<P> |
<SPAN CLASS="date">xx-06-2010</SPAN>: |
<SPAN CLASS="date">XX-07-2010</SPAN>: |
|
version 1.10.5 |
|
</P> |
|
<P> |
|
Purely a bug-fix and polish release. Highlights: |
|
</P> |
|
<UL> |
|
<LI>fix <Q>Sm</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> -Tps 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 -Thtml output for -man</LI> |
|
<LI>add <A HREF="mandoc.1.html">mandoc</A> -Tpdf 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> |
|
-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 |
version 1.10.1 |
</P> |
</P> |
<P> |
<P> |
This primarily focusses on the <Q>Bl</Q> and <Q>It</Q> macros described in <A |
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 |
HREF="mdoc.7.html">mdoc</A>. Multi-line column support is now fully compatible with |
groff, as are implicit list entries for columns. |
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> |
</P> |
</DIV> |
</DIV> |
<DIV CLASS="news"> |
<DIV CLASS="news"> |
|
|
HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A> and see |
HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A> and see |
for yourself!).</LI> |
for yourself!).</LI> |
</UL> |
</UL> |
</DIV> |
|
<DIV CLASS="news"> |
|
<P> |
|
<SPAN CLASS="date">13-05-2010</SPAN>: |
|
version 1.9.25 |
|
</P> |
|
<P> |
|
Fixed handling of <Q>\*(Ba</Q> escape. Backed out <SPAN |
|
CLASS="flag">-fno-ign-chars</SPAN> (pointless complexity). Fixed erroneous |
|
breaking of literal lines. Fixed SYNOPSIS breaking lines before non-initial |
|
macros. Changed default section ordering. Most importantly, the framework for |
|
end-of-sentence double-spacing is in place, now implemented for the |
|
<Q>end-of-sentence, end-of-line</Q> rule. This is a stable roll-back point |
|
before the mandoc hackathon in Rostock! |
|
</P> |
|
</DIV> |
|
<DIV CLASS="news"> |
|
<P> |
|
<SPAN CLASS="date">09-05-2010</SPAN>: |
|
version 1.9.24 |
|
</P> |
|
<P> |
|
Rolled back break-at-hyphen. <SPAN CLASS="flag">-DUGLY</SPAN> is now the |
|
default (no feature splits!). Free-form text is not de-chunked any more: lines |
|
are passed whole-sale into the front-end, including whitespace. Added mailing |
|
lists. Lastly, <SPAN CLASS="nm">mdocml</SPAN> is the focus of two <A |
|
CLASS="external" HREF="http://socghop.appspot.com/">Google Summer of Code</A> |
|
projects this year: <Q><A CLASS="external" |
|
HREF="http://netbsd-soc.sourceforge.net/projects/mandoc_ps/">mandoc -Tps</A></Q> |
|
(NetBSD) and <Q><A CLASS="external" |
|
HREF="http://wiki.freebsd.org/SummerOfCode2010Projects">BSD-licensed |
|
Text-Processing Tools</A></Q> (FreeBSD). |
|
</P> |
|
</DIV> |
|
|
|
<DIV CLASS="news"> |
|
<P> |
|
<SPAN CLASS="date">07-04-2010</SPAN>: |
|
version 1.9.23 |
|
</P> |
|
<P> |
|
<SPAN CLASS="nm">mdocml</SPAN> has been linked to the <A CLASS="external" |
|
HREF="http://www.openbsd.org/faq/current.html#20100403">OpenBSD build</a>. This |
|
version incorporates many small changes, mostly from patches by OpenBSD, |
|
allowing crufty manuals to slip by with warnings instead of erroring-out. Some |
|
subtle semantic issues, such as punctuation scope, have also been fixed. |
|
Lastly, some issues with <SPAN CLASS="flag">-Thtml</SPAN> have been fixed, which |
|
prompted an update to the <A HREF="mandoc.1.html">online</A> <A |
|
HREF="mandoc_char.7.html">manual</A> <A HREF="man.7.html">pages</A> style |
|
layout. |
|
</P> |
|
</DIV> |
</DIV> |
<P> |
<P> |
See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for |
See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for |