| version 1.32, 2009/10/18 11:13:39 |
version 1.76, 2010/05/30 10:36:10 |
|
|
| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
| <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"> |
<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.bsd.lv</title> |
<TITLE>mdocml | mdoc macro compiler</TITLE> |
| </head> |
</HEAD> |
| <body> |
<BODY> |
| <table class="frame"> |
<TABLE CLASS="frame" SUMMARY="[frame]"> |
| <col width="100%"> |
<COL WIDTH="100%"> |
| <tbody> |
<TBODY> |
| <tr> |
<TR> |
| <td> |
<TD> |
| <div class="head"> |
<DIV CLASS="head"> |
| <b>mdocml</b> – mdoc macro compiler |
<B>mdocml</B> – mdoc macro compiler |
| </div> |
</DIV> |
| </td> |
<DIV CLASS="subhead"> |
| </tr> |
<A HREF="#description">Description</A> | |
| <tr> |
<A HREF="#sources">Sources</A> | |
| <td valign="top"> |
<A HREF="#documentation">Documentation</A> | |
| <h1> |
<A HREF="#contact">Contact</A> | |
| DESCRIPTION |
<A HREF="#news">News</A> |
| </h1> |
</DIV> |
| |
</TD> |
| |
</TR> |
| |
<TR> |
| |
<TD VALIGN="top"> |
| |
<H1> |
| |
<A NAME="description">DESCRIPTION</A> |
| |
</H1> |
| |
|
| <p> |
<P> |
| <span class="nm">mdocml</span> is a suite of tools compiling “-mdoc”, the roff macro package |
<SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <Q>-mdoc</Q>, the roff macro package |
| of choice for BSD manual pages, and “-man”, the predominant historical package for UNIX |
of choice for BSD manual pages, and <Q>-man</Q>, the predominant historical package for UNIX |
| manuals. The mission of <span class="nm">mdocml</span> is to deprecate <a |
manuals. The mission of <SPAN CLASS="nm">mdocml</SPAN> is to deprecate <A |
| href="http://www.gnu.org/software/groff/" class="external">groff</a>, the GNU roff implementation, for |
HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU roff implementation, for |
| displaying -mdoc pages whilst providing token support for -man. |
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, ISC-licensed, fast and regular). |
| </p> |
</P> |
| |
|
| <p> |
<P> |
| The core of <span class="nm">mdocml</span> is composed of the <i>libmdoc</i> and <i>libman</i> |
The core of <SPAN CLASS="nm">mdocml</SPAN> is composed of the <A HREF="mdoc.3.html">libmdoc</A>, <A |
| validating compiler libraries. Both are simple, fast libraries operating on memory buffers, so they may |
HREF="man.3.html">libman</A>, and <A HREF="roff.3.html">libroff</A> validating compiler libraries. All |
| be used for a variety of front-ends (terminal-based, CGI and so on). The primary front-end is <i> |
are simple, fast libraries operating on memory buffers, so they may be used for a variety of front-ends |
| mandoc</i>, which formats manuals for display on the terminal. |
(terminal-based, CGI and so on). The front-end is <A HREF="mandoc.1.html">mandoc</A>, which formats |
| </p> |
manuals for display. |
| </td> |
</P> |
| </tr> |
|
| <tr> |
|
| <td> |
|
| <h1> |
|
| DOWNLOADS |
|
| </h1> |
|
| |
|
| <p> |
<P> |
| Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested |
The <SPAN CLASS="nm">mdocml</SPAN> suite is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv |
| variously on i386, AMD64, alpha, and others. The most current version is <span |
Project</A> member. |
| class="attn">@VERSION@</span>, dated <span class="attn">@VDATE@</span>. A full <a |
</P> |
| href="ChangeLog.html">ChangeLog</a> [<a href="ChangeLog.txt">txt</a>] is written with each release. |
</TD> |
| </p> |
</TR> |
| |
<TR> |
| |
<TD> |
| |
<H1> |
| |
<A NAME="sources">SOURCES</A> |
| |
</H1> |
| |
|
| <h2> |
<P> |
| |
Sources correctly build and install on DragonFly BSD, FreeBSD, OpenBSD, NetBSD, GNU/Linux, and many |
| |
other operating systems, tested variously on i386, AMD64, alpha, and others. The most current version |
| |
is <SPAN CLASS="attn">@VERSION@</SPAN>, dated <SPAN class="attn">@VDATE@</SPAN>. A full <A |
| |
HREF="ChangeLog.html">ChangeLog</A> (<A HREF="ChangeLog.txt">txt</A>) is written with each release. |
| |
</P> |
| |
|
| |
<H2> |
| Current |
Current |
| </h2> |
</H2> |
| |
|
| <table width="100%"> |
<TABLE WIDTH="100%" SUMMARY="Current Sources"> |
| <col width="200"> |
<COL WIDTH="200"> |
| <col> |
<COL> |
| <tbody> |
<TBODY> |
| <tr> |
<TR> |
| <td>Source archive</td> |
<TD>Source archive</TD> |
| <td> |
<TD> |
| <a href="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</a> |
<A HREF="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</A> |
| (<a href="/snapshots/mdocml.md5">md5</a>) |
(<A HREF="/snapshots/mdocml.md5">md5</A>) |
| </td> |
</TD> |
| </tr> |
</TR> |
| </tbody> |
<TR> |
| </table> |
<TD>Online source</TD> |
| |
<TD> |
| |
<A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A> |
| |
</TD> |
| |
</TR> |
| |
</TBODY> |
| |
</TABLE> |
| |
|
| <h2> |
<H2> |
| Downstream |
Downstream |
| </h2> |
</H2> |
| |
|
| <table width="100%"> |
<TABLE WIDTH="100%" SUMMARY="Downstream Sources"> |
| <col width="200"> |
<COL WIDTH="200"> |
| <col> |
<COL> |
| <tbody> |
<TBODY> |
| <tr> |
<TR> |
| <td>FreeBSD</td> |
<TD>DragonFly BSD</TD> |
| <td> |
<TD> |
| <a href="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/" |
<A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc" |
| class="external">ports/textproc/mdocml</a> |
CLASS="external">usr.bin/mandoc</A> |
| </td> |
</TD> |
| </tr> |
</TR> |
| <tr> |
<TR> |
| <td>NetBSD</td> |
<TD>FreeBSD</TD> |
| <td> |
<TD> |
| <a href="http://cvsweb.netbsd.org/bsdweb.cgi/pkgsrc/textproc/mdocml/" |
<A HREF="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/" |
| class="external">pkgsrc/textproc/mdocml</a> |
CLASS="external">ports/textproc/mdocml</A> |
| </td> |
</TD> |
| </tr> |
</TR> |
| <tr> |
<TR> |
| <td>OpenBSD</td> |
<TD>NetBSD</TD> |
| <td> |
<TD> |
| <a href="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/" |
<A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/" |
| class="external">src/usr.bin/mandoc</a> |
CLASS="external">src/external/bsd/mdocml</A> |
| </td> |
</TD> |
| </tr> |
</TR> |
| </tbody> |
<TR> |
| </table> |
<TD>OpenBSD</TD> |
| |
<TD> |
| |
<A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/" |
| |
CLASS="external">src/usr.bin/mandoc</A> |
| |
</TD> |
| |
</TR> |
| |
</TBODY> |
| |
</TABLE> |
| |
|
| <h2> |
<H2> |
| Historical |
Historical |
| </h2> |
</H2> |
| |
|
| <table width="100%"> |
<TABLE WIDTH="100%" SUMMARY="Archived Sources"> |
| <col width="200"> |
<COL WIDTH="200"> |
| <col> |
<COL> |
| <tbody> |
<TBODY> |
| <tr> |
<TR> |
| <td>Source archive</td> |
<TD>Source archive</TD> |
| <td> |
<TD> |
| <a href="/snapshots/">/snapshots/</a> |
<A HREF="/snapshots/">/snapshots/</A> |
| </td> |
</TD> |
| </tr> |
</TR> |
| </tbody> |
</TBODY> |
| </table> |
</TABLE> |
| </td> |
</TD> |
| </tr> |
</TR> |
| <tr> |
<TR> |
| <td> |
<TD> |
| <h1> |
<H1> |
| DOCUMENTATION |
<A NAME="documentation">DOCUMENTATION</A> |
| </h1> |
</H1> |
| |
|
| <p> |
<P> |
| These manuals are generated automatically (with <a href="mandoc.1.html">mandoc(1)</a> -Thtml) and refer to the |
These manuals are generated automatically and refer to the current snapshot. |
| current snapshot. |
</P> |
| </p> |
|
| |
|
| <table width="100%"> |
<TABLE WIDTH="100%" SUMMARY="Documentation"> |
| <col width="200"> |
<COL WIDTH="200"> |
| <col> |
<COL> |
| <tbody> |
<TBODY> |
| <tr> |
<TR> |
| <td><a href="mandoc.1.html">mandoc(1)</a> [<a href="mandoc.1.txt">text</a>]</td> |
<TD><A HREF="man.3.html">man(3)</A> (<A HREF="man.3.txt">text</A>)</TD> |
| <td>format and display UNIX manuals</td> |
<TD>man macro compiler library</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><A HREF="man.7.html">man(7)</A> (<A HREF="man.7.txt">text</A>)</TD> |
| <td>mandoc special characters</td> |
<TD>man language reference</TD> |
| </tr> |
</TR> |
| <tr> |
<TR> |
| <td><a href="mdoc.7.html">mdoc(7)</a> [<a href="mdoc.7.txt">text</a>]</td> |
<TD><A HREF="mandoc.1.html">mandoc(1)</A> (<A HREF="mandoc.1.txt">text</A>)</TD> |
| <td>mdoc language reference</td> |
<TD>format and display UNIX manuals</TD> |
| </tr> |
</TR> |
| <tr> |
<TR> |
| <td><a href="man.7.html">man(7)</a> [<a href="man.7.txt">text</a>]</td> |
<TD><A HREF="mandoc_char.7.html">mandoc_char(7)</A> (<A HREF="mandoc_char.7.txt">text</A>)</TD> |
| <td>man language reference</td> |
<TD>mandoc special characters</TD> |
| </tr> |
</TR> |
| <tr> |
<TR> |
| <td><a href="manuals.7.html">manuals(7)</a> [<a href="manuals.7.txt">text</a>]</td> |
<TD><A HREF="manuals.7.html">manuals(7)</A> (<A HREF="manuals.7.txt">text</A>)</TD> |
| <td>a guide to writing UNIX manuals</td> |
<TD>a guide to writing UNIX manuals</TD> |
| </tr> |
</TR> |
| <tr> |
<TR> |
| <td><a href="mdoc.3.html">mdoc(3)</a> [<a href="mdoc.3.txt">text</a>]</td> |
<TD><A HREF="mdoc.3.html">mdoc(3)</A> (<A HREF="mdoc.3.txt">text</A>)</TD> |
| <td>mdoc macro compiler library</td> |
<TD>mdoc macro compiler library</TD> |
| </tr> |
</TR> |
| <tr> |
<TR> |
| <td><a href="man.3.html">man(3)</a> [<a href="man.3.txt">text</a>]</td> |
<TD><A HREF="mdoc.7.html">mdoc(7)</A> (<A HREF="mdoc.7.txt">text</A>)</TD> |
| <td>man macro compiler library</td> |
<TD>mdoc language reference</TD> |
| </tr> |
</TR> |
| </tbody> |
<TR> |
| </table> |
<TD><A HREF="roff.3.html">roff(3)</A> (<A HREF="roff.3.txt">text</A>)</TD> |
| </td> |
<TD>roff macro compiler library</TD> |
| </tr> |
</TR> |
| <tr> |
<TR> |
| <td> |
<TD><A HREF="roff.7.html">roff(7)</A> (<A HREF="roff.7.txt">text</A>)</TD> |
| <h1> |
<TD>roff-mandoc language reference</TD> |
| CONTACT |
</TR> |
| </h1> |
</TBODY> |
| |
</TABLE> |
| |
</TD> |
| |
</TR> |
| |
<TR> |
| |
<TD> |
| |
<H1> |
| |
<A NAME="contact">CONTACT</A> |
| |
</H1> |
| |
|
| <p> |
<P> |
| For all issues related to <span class="nm">mdocml</span>, contact Kristaps Džonsons, kris<a |
For all issues related to <SPAN CLASS="nm">mdocml</SPAN>, contact Kristaps Dzonsons, kris<A |
| class="external" |
CLASS="external" |
| href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ==" |
HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" |
| title="Reveal this e-mail address">...</a>@kth.se. |
TITLE="Reveal this e-mail address">...</A>@bsd.lv. |
| </p> |
</P> |
| |
|
| <p> |
<P> |
| If you want to receive a semi-automated mail-out of new releases, then please write with a message |
You may also subscribe to several mailing lists (these require subscription, which is moderated). An |
| subject of <i>subscribe mdocml</i> (or <i>unsubscribe mdocml</i>). |
archive is not yet available on-line, although you may request one once subscribed. |
| </p> |
</P> |
| </td> |
|
| </tr> |
<TABLE WIDTH="100%" SUMMARY="Mailing Lists"> |
| <tr> |
<COL WIDTH="200"> |
| <td> |
<COL> |
| <div class="foot"> |
<TBODY> |
| Copyright © 2008, 2009 Kristaps Džonsons, $Date$ |
<TR> |
| </div> |
<TD> |
| </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 |
| </tbody> |
</TD> |
| </table> |
<TD>high-level discussions and version announcements</TD> |
| </body> |
</TR> |
| </html> |
<TR> |
| |
<TD> |
| |
tec<A CLASS="external" TITLE="Reveal this e-mail address" |
| |
HREF="http://www.google.com/recaptcha/mailhide/d?k=01qDX_iV0RlUOarEvb6mR28g==&c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...</A>@mdocml.bsd.lv |
| |
</TD> |
| |
<TD>low-level discussions</TD> |
| |
</TR> |
| |
<TR> |
| |
<TD> |
| |
sou<A CLASS="external" TITLE="Reveal this e-mail address" |
| |
HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</A>@mdocml.bsd.lv |
| |
</TD> |
| |
<TD>source commit messages</TD> |
| |
</TR> |
| |
</TBODY> |
| |
</TABLE> |
| |
</TD> |
| |
</TR> |
| |
<TR> |
| |
<TD> |
| |
<H1> |
| |
<A NAME="news">NEWS</A> |
| |
</H1> |
| |
|
| |
<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> |
| |
<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> |
| |
<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> |
| |
</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