| version 1.40, 2010/02/17 19:31:00 |
version 1.89, 2010/07/27 08:48:21 |
|
|
| <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" SUMMARY="[frame]"> |
<TABLE CLASS="frame" SUMMARY="[frame]"> |
|
|
| <TR> |
<TR> |
| <TD VALIGN="top"> |
<TD VALIGN="top"> |
| <H1> |
<H1> |
| DESCRIPTION |
<A NAME="description">DESCRIPTION</A> |
| </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 <i>libmdoc</i> and <i>libman</i> |
<SPAN CLASS="nm">mdocml</SPAN> consists 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 compilers; and <A |
| be used for a variety of front-ends (terminal-based, CGI and so on). The primary front-end is <i> |
HREF="mandoc.1.html">mandoc</A>, which interfaces with the compiler libraries to format output for UNIX |
| mandoc</i>, which formats manuals for display on the terminal. |
terminals, XHTML, HTML, and PostScript. <SPAN CLASS="nm">mdocml</SPAN> is a <A CLASS="external" |
| |
HREF="http://bsd.lv/">BSD.lv</A> project. |
| </P> |
</P> |
| |
|
| <P> |
<P> |
| The <SPAN CLASS="nm">mdocml</SPAN> utility 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> |
| <TR> |
<TR> |
| <TD> |
<TD> |
| <H1> |
<H1> |
| SOURCES |
<A NAME="sources">SOURCES</A> |
| </H1> |
</H1> |
| |
|
| <P> |
<P> |
| Sources correctly build and install on DragonFly BSD, FreeBSD, OpenBSD, NetBSD, and GNU/Linux operating |
<SPAN CLASS="nm">mdocml</SPAN> is architecture- and system-neutral, written in plain-old C. The most |
| systems, tested variously on i386, AMD64, alpha, and others. The most current version is <SPAN |
current version is <SPAN CLASS="attn">@VERSION@</SPAN>, dated <SPAN class="attn">@VDATE@</SPAN>. A full |
| 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> |
|
|
| <TR> |
<TR> |
| <TD>Online source</TD> |
<TD>Online source</TD> |
| <TD> |
<TD> |
| <A CLASS="external" HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A> |
<A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A> |
| </TD> |
</TD> |
| </TR> |
</TR> |
| </TBODY> |
</TBODY> |
|
|
| <TR> |
<TR> |
| <TD> |
<TD> |
| <H1> |
<H1> |
| DOCUMENTATION |
<A NAME="documentation">DOCUMENTATION</A> |
| </H1> |
</H1> |
| |
|
| <P> |
<P> |
| These manuals are generated automatically and refer to the current snapshot. |
These manuals are generated automatically and refer to the current snapshot. |
| </P> |
</P> |
| |
|
| <TABLE WIDTH="100%" SUMMARY="Documentation"> |
<TABLE WIDTH="100%" SUMMARY="Documentation"> |
|
|
| <COL> |
<COL> |
| <TBODY> |
<TBODY> |
| <TR> |
<TR> |
| <TD><A HREF="mandoc.1.html">mandoc(1)</A> (<A HREF="mandoc.1.txt">text</A>)</TD> |
<TD VALIGN="top"><A HREF="man.3.html">man(3)</A></TD> |
| <TD>format and display UNIX manuals</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="mandoc_char.7.html">mandoc_char(7)</A> (<A HREF="mandoc_char.7.txt">text</A>)</TD> |
<TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD> |
| <TD>mandoc special characters</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="mdoc.7.html">mdoc(7)</A> (<A HREF="mdoc.7.txt">text</A>)</TD> |
<TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD> |
| <TD>mdoc language reference</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="man.7.html">man(7)</A> (<A HREF="man.7.txt">text</A>)</TD> |
<TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD> |
| <TD>man language reference</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="man.3.html">man(3)</A> (<A HREF="man.3.txt">text</A>)</TD> |
<TD VALIGN="top"><A HREF="roff.3.html">roff(3)</A></TD> |
| <TD>man macro compiler library</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> |
| |
<TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></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> |
| </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> |
| <TD> |
<TD> |
| <H1> |
<H1> |
| CONTACT |
<A NAME="contact">CONTACT</A> |
| </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> |
| 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 |
| subject of <I>subscribe mdocml</I> (or <I>unsubscribe mdocml</I>). |
moderated). An archive is not yet available on-line, although you may request one once |
| |
subscribed. |
| </P> |
</P> |
| </TD> |
|
| </TR> |
|
| <TR> |
|
| <TD> |
|
| <H1> |
|
| NEWS |
|
| </H1> |
|
| |
|
| <TABLE WIDTH="100%" CELLPADDING="2"> |
<TABLE WIDTH="100%" SUMMARY="Mailing Lists"> |
| <COL STYLE="width: 8em;"> |
<COL WIDTH="200"> |
| |
<COL> |
| <TBODY> |
<TBODY> |
| <TR> |
<TR> |
| <TD VALIGN="top"><SPAN CLASS="date">15-02-2010</SPAN></TD> |
<TD> |
| <TD VALIGN="top"> |
disc<A CLASS="external" TITLE="Reveal this e-mail address" |
| Moved to our new <A HREF="http://bsd.lv" CLASS="external">BSD.lv</A> home. |
HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv |
| Version <SPAN CLASS="rev">1.9.15</SPAN>. |
|
| </TD> |
</TD> |
| |
<TD>bug-reports, general questions, and announcements</TD> |
| </TR> |
</TR> |
| |
<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>patches and system 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> |
</TBODY> |
| </TABLE> |
</TABLE> |
| |
</TD> |
| |
</TR> |
| |
<TR> |
| |
<TD> |
| |
<H1> |
| |
<A NAME="news">NEWS</A> |
| |
</H1> |
| |
<DIV CLASS="news"> |
| |
<P> |
| |
<SPAN CLASS="date">27-07-2010</SPAN>: |
| |
version 1.10.5 |
| |
</P> |
| |
<P> |
| |
Primarily a bug-fix and polish release, but including <SPAN CLASS="flag">-Tpdf</SPAN> |
| |
support in <A HREF="mandoc.1.html">mandoc</A> by way of <A CLASS="external" |
| |
HREF="http://netbsd-soc.sourceforge.net/projects/mandoc_ps/">Summer of Code</A>. |
| |
Highlights: |
| |
</P> |
| |
<UL> |
| |
<LI>fix <Q>Sm</Q> and <Q>Bd</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> <SPAN CLASS="flag">-Tps</SPAN> 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> <SPAN CLASS="flag">-Tpdf</SPAN> 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> |
| |
<SPAN CLASS="flag">-Tps output</SPAN></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> |
</TD> |
| </TR> |
</TR> |
| <TR> |
<TR> |
![[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