version 1.51, 2010/04/07 11:25:56 |
version 1.104, 2011/01/07 13:10:03 |
|
|
<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, PostScript, and PDF. It 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> |
|
|
</H2> |
</H2> |
|
|
<TABLE WIDTH="100%" SUMMARY="Current Sources"> |
<TABLE WIDTH="100%" SUMMARY="Current Sources"> |
<COL WIDTH="200"> |
<COL WIDTH="175"> |
<COL> |
<COL> |
<TBODY> |
<TBODY> |
<TR> |
<TR> |
|
|
<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> |
|
|
</H2> |
</H2> |
|
|
<TABLE WIDTH="100%" SUMMARY="Downstream Sources"> |
<TABLE WIDTH="100%" SUMMARY="Downstream Sources"> |
<COL WIDTH="200"> |
<COL WIDTH="175"> |
<COL> |
<COL> |
<TBODY> |
<TBODY> |
<TR> |
<TR> |
|
|
</H2> |
</H2> |
|
|
<TABLE WIDTH="100%" SUMMARY="Archived Sources"> |
<TABLE WIDTH="100%" SUMMARY="Archived Sources"> |
<COL WIDTH="200"> |
<COL WIDTH="175"> |
<COL> |
<COL> |
<TBODY> |
<TBODY> |
<TR> |
<TR> |
|
|
<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 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 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.xhtml">xhtml</A> | |
|
<A HREF="mandoc.1.pdf">pdf</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="man.3.html">man(3)</A></TD> |
<TD>mandoc special characters</TD> |
<TD VALIGN="top"> |
|
man macro compiler library |
|
<SPAN STYLE="font-size: smaller;"> |
|
(<A HREF="man.3.txt">text</A> | |
|
<A HREF="man.3.xhtml">xhtml</A> | |
|
<A HREF="man.3.pdf">pdf</A> | |
|
<A HREF="man.3.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="mdoc.3.html">mdoc(3)</A></TD> |
<TD>mdoc language reference</TD> |
<TD VALIGN="top"> |
|
mdoc macro compiler library |
|
<SPAN STYLE="font-size: smaller;"> |
|
(<A HREF="mdoc.3.txt">text</A> | |
|
<A HREF="mdoc.3.xhtml">xhtml</A> | |
|
<A HREF="mdoc.3.pdf">pdf</A> | |
|
<A HREF="mdoc.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="roff.3.html">roff(3)</A></TD> |
<TD>man 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.xhtml">xhtml</A> | |
|
<A HREF="roff.3.pdf">pdf</A> | |
|
<A HREF="roff.3.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="man.7.html">man(7)</A></TD> |
<TD>a guide to writing UNIX manuals</TD> |
<TD VALIGN="top"> |
|
man language reference |
|
<SPAN STYLE="font-size: smaller;"> |
|
(<A HREF="man.7.txt">text</A> | |
|
<A HREF="man.7.xhtml">xhtml</A> | |
|
<A HREF="man.7.pdf">pdf</A> | |
|
<A HREF="man.7.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="mandoc_char.7.html">mandoc_char(7)</A></TD> |
<TD>mdoc macro compiler library</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.xhtml">xhtml</A> | |
|
<A HREF="mandoc_char.7.pdf">pdf</A> | |
|
<A HREF="mandoc_char.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="mdoc.7.html">mdoc(7)</A></TD> |
<TD>man 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.xhtml">xhtml</A> | |
|
<A HREF="mdoc.7.pdf">pdf</A> | |
|
<A HREF="mdoc.7.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.xhtml">xhtml</A> | |
|
<A HREF="roff.7.pdf">pdf</A> | |
|
<A HREF="roff.7.ps">postscript</A>) |
|
</SPAN> |
|
</TD> |
|
</TR> |
|
<TR> |
|
<TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD> |
|
<TD VALIGN="top"> |
|
tbl-mandoc language reference |
|
<SPAN STYLE="font-size: smaller;"> |
|
(<A HREF="tbl.7.txt">text</A> | |
|
<A HREF="tbl.7.xhtml">xhtml</A> | |
|
<A HREF="tbl.7.pdf">pdf</A> | |
|
<A HREF="tbl.7.ps">postscript</A>) |
|
</SPAN> |
|
</TD> |
|
</TR> |
</TBODY> |
</TBODY> |
</TABLE> |
</TABLE> |
</TD> |
|
</TR> |
|
<TR> |
|
<TD> |
|
<H1> |
|
CONTACT |
|
</H1> |
|
|
|
<P> |
<P> |
For all issues related to <SPAN CLASS="nm">mdocml</SPAN>, contact Kristaps Dzonsons, kris<A |
See <Q><A CLASS="external" HREF="http://manpages.bsd.lv">Writing UNIX Manual Pages</A></Q> for a general |
CLASS="external" |
introduction to manpages and mdoc. |
HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" |
|
TITLE="Reveal this e-mail address">...</A>@bsd.lv. |
|
</P> |
</P> |
|
|
<P> |
|
If you want to receive a semi-automated mail-out of new releases, then please write with a message |
|
subject of <I>subscribe mdocml</I> (or <I>unsubscribe mdocml</I>). |
|
</P> |
|
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD> |
<TD> |
<H1> |
<H1> |
NEWS |
<A NAME="contact">CONTACT</A> |
</H1> |
</H1> |
|
|
<TABLE WIDTH="100%" CELLPADDING="2"> |
<P> |
<COL CLASS="date"> |
Please use the mailing lists for bug-reports, patches, questions, etc. (these require |
|
subscription). Beyond that, contact Kristaps at <A |
|
HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" |
|
TITLE="Reveal this e-mail address">kris...</A>@bsd.lv. |
|
</P> |
|
|
|
<TABLE WIDTH="100%" SUMMARY="Mailing Lists"> |
|
<COL WIDTH="175"> |
|
<COL> |
<TBODY> |
<TBODY> |
<TR> |
<TR> |
<TD VALIGN="top"><SPAN CLASS="date">07-04-2010</SPAN></TD> |
<TD> |
<TD VALIGN="top"> |
disc<A CLASS="external" TITLE="Reveal this e-mail address" |
<SPAN CLASS="nm">mdocml</SPAN> has been linked to the <A CLASS="external" |
HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv |
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. |
|
</TD> |
</TD> |
</TR> |
<TD> |
|
bug-reports, general questions, and announcements |
<TR> |
<SPAN STYLE="font-size: smaller;">(<A HREF="/archives/discuss/summary.html">archive</A>)</SPAN> |
<TD VALIGN="top"><SPAN CLASS="date">31-03-2010</SPAN></TD> |
|
<TD VALIGN="top"> |
|
Version <SPAN CLASS="rev">1.9.22</SPAN>: adjusted merge of the significant work |
|
by Ingo Schwarze in getting <Q>Xo</Q> blocks (block full implicit, e.g., |
|
<Q>It</Q> for non-columnar lists) to work properly. This isn't enabled by |
|
default: you must specify <SPAN CLASS="flag">-DUGLY</SPAN> as a compiler flag |
|
(see the Makefile for details). |
|
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD VALIGN="top"><SPAN CLASS="date">30-03-2010</SPAN></TD> |
<TD> |
<TD VALIGN="top"> |
tec<A CLASS="external" TITLE="Reveal this e-mail address" |
Version <SPAN CLASS="rev">1.9.20</SPAN>: more efforts to get roff instructions |
HREF="http://www.google.com/recaptcha/mailhide/d?k=01qDX_iV0RlUOarEvb6mR28g==&c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...</A>@mdocml.bsd.lv |
in -man documents under control. Note that roff instructions embedded in |
|
line-scoped, next-line macros (e.g. <Q>B</Q>) are not supported. Leading |
|
punctuation for -mdoc macros, such as <Q>Fl ( ( a</Q>, are now correctly |
|
handled. |
|
</TD> |
</TD> |
</TR> |
<TD> |
<TR> |
patches and system discussions |
<TD VALIGN="top"><SPAN CLASS="date">27-03-2010</SPAN></TD> |
<SPAN STYLE="font-size: smaller;">(<A HREF="/archives/tech/summary.html">archive</A>)</SPAN> |
<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> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD VALIGN="top"><SPAN CLASS="date">25-03-2010</SPAN></TD> |
<TD> |
<TD VALIGN="top"> |
sou<A CLASS="external" TITLE="Reveal this e-mail address" |
Version <SPAN CLASS="rev">1.9.17</SPAN> highlights: accept <A |
HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</A>@mdocml.bsd.lv |
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> |
</TD> |
</TR> |
<TD> |
<TR> |
source commit messages |
<TD VALIGN="top"><SPAN CLASS="date">22-03-2010</SPAN></TD> |
<SPAN STYLE="font-size: smaller;">(<A HREF="/archives/source/summary.html">archive</A>)</SPAN> |
<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> |
</TD> |
</TR> |
</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> |
</TBODY> |
</TABLE> |
</TABLE> |
|
</TD> |
|
</TR> |
|
<TR> |
|
<TD> |
|
<H1> |
|
<A NAME="news">NEWS</A> |
|
</H1> |
|
<DIV CLASS="news"> |
|
<P> |
|
<SPAN CLASS="date">07-01-2011</SPAN>: |
|
version 1.10.9 |
|
</P> |
|
<P> |
|
Many back-end fixes have been implemented: argument handling (quoting), <A |
|
HREF="man.7.html">man</A> improvements, error/warning classes, and many more. |
|
</P> |
|
<P> |
|
Initial <A HREF="tbl.7.html">tbl</A> functionality (see the <Q>TS</Q>, <Q>TE</Q>, and |
|
<Q>T&</Q> macros in the <A HREF="roff.7.html#x5c265453">roff</A> manual) has been |
|
merged from <A CLASS="external" HREF="http://tbl.bsd.lv">tbl.bsd.lv</A>. Output is |
|
still minimal, especially for <SPAN CLASS="flag">-Thtml</SPAN> and <SPAN |
|
CLASS="flag">-Txhtml</SPAN>, but manages to at least display data. This means that <A |
|
HREF="mandoc.1.html">mandoc</A> now has built-in support for two troff preprocessors via |
|
<A HREF="roff.3.html">libroff</A>: soelim and tbl. |
|
</P> |
|
</DIV> |
|
<DIV CLASS="news"> |
|
<P> |
|
<SPAN CLASS="date">24-12-2010</SPAN>: |
|
version 1.10.8 |
|
</P> |
|
<P> |
|
Significant improvements merged from <A CLASS="external" |
|
HREF="http://www.openbsd.org">OpenBSD</A> downstream, including |
|
</P> |
|
<UL> |
|
<LI>many new <A HREF="roff.7.html">roff</A> components,</LI> |
|
<LI>in-line implementation of troff's soelim,</LI> |
|
<LI>broken-block handling,</LI> |
|
<LI>overhauled error classifications, and</LI> |
|
<LI>cleaned up handling of error conditions.</LI> |
|
</UL> |
|
<P> |
|
Also overhauled the <SPAN CLASS="flag">-Thtml</SPAN> and <SPAN |
|
CLASS="flag">-Txhtml</SPAN> output modes. They now display readable output in arbitrary |
|
browsers, including text-based ones like <A CLASS="external" |
|
HREF="http://lynx.isc.org">lynx</A>. See HTML and XHTML manuals in the <A |
|
HREF="#documentation">DOCUMENTATION</A> section for examples. <SPAN |
|
CLASS="attn">Attention: available style-sheet classes have been considerably |
|
changed!</SPAN> See the <SPAN CLASS="file">example.style.css</SPAN> file for details. |
|
Lastly, <A HREF="mdoc.3.html">libmdoc</A> and <A HREF="man.3.html">libman</A> have been |
|
cleaned up and reduced in size and complexity. |
|
</P> |
|
</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> |