version 1.11, 2009/03/21 09:50:07 |
version 1.85, 2010/07/21 10:10:24 |
|
|
<!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="style.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 width="600"> |
<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> |
</TD> |
</tr> |
</TR> |
<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 “mdoc”, the roff macro |
<SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <Q>-<A HREF="mdoc.7.html">mdoc</A></Q>, the |
package for BSD manual pages. The mission of <span class="nm">mdocml</span> is to deprecate <a |
roff macro package of choice for BSD manual pages, and <Q>-<A HREF="man.7.html">man</A></Q>, the |
href="http://www.gnu.org/software/groff/" class="external">groff</a>, the GNU roff implementation, for |
predominant historical package for UNIX manuals. The mission of <SPAN CLASS="nm">mdocml</SPAN> is to |
displaying BSD mdoc pages. |
deprecate <A HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU troff |
</p> |
implementation, for displaying -mdoc pages whilst providing token support for -man. |
|
</P> |
|
|
<p> |
<P> |
Why? groff amounts to roughly 5,2 MB of source code (OpenBSD 4.2), some of which is C++ and all of |
Why? groff amounts to over 5 MB of source code, most of which is C++ and all of which is GPL. It runs |
which is GPL. It runs slowly, produces uncertain output, and varies in operation from system |
slowly, produces uncertain output, and varies in operation from system to system. mdocml strives to fix |
to system. mdocml strives to fix this (respectively small, C, ISC-licensed, fast and regular). |
this (respectively small, C, <A CLASS="external" |
</p> |
HREF="http://www.isc.org/software/license">ISC</A>-licensed, fast and regular). |
|
</P> |
|
|
<p> |
<P> |
The core of <span class="nm">mdocml</span> is the libmdoc library, a validating scanner-parser producing |
<SPAN CLASS="nm">mdocml</SPAN> consists of the <A HREF="mdoc.3.html">libmdoc</A>, <A |
intermediate-form output from mdoc input. libmdoc is a simple, fast library operating on memory buffers |
HREF="man.3.html">libman</A>, and <A HREF="roff.3.html">libroff</A> validating compilers; and <A |
of mdoc input. Its intermediate output, an abstract syntax tree, is fully documented in the <span |
HREF="mandoc.1.html">mandoc</A>, which interfaces with the compiler libraries to format output for UNIX |
class="man">mdoc(3)</span> reference manual. |
terminals, XHTML, HTML, and PostScript. <SPAN CLASS="nm">mdocml</SPAN> is a <A CLASS="external" |
</p> |
HREF="http://bsd.lv/">BSD.lv</A> project. |
|
</P> |
|
|
<p> |
<P> |
There are three utilities implementing <span class="man">mdoc(3)</span>: |
<I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, |
</p> |
<Q>mandoc</Q>. |
|
</P> |
|
</TD> |
|
</TR> |
|
<TR> |
|
<TD> |
|
<H1> |
|
<A NAME="sources">SOURCES</A> |
|
</H1> |
|
|
<ul> |
<P> |
<li><span class="man">mdocterm(1)</span> – formats mdoc input for display on the terminal |
<SPAN CLASS="nm">mdocml</SPAN> is architecture- and system-neutral, written in plain-old C. The most |
<li><span class="man">mdochtml(1)</span> – formats mdoc input as HTML/CSS (nascent) |
current version is <SPAN CLASS="attn">@VERSION@</SPAN>, dated <SPAN class="attn">@VDATE@</SPAN>. A full |
<li><span class="man">mdoclint(1)</span> – validates mdoc input |
<A HREF="ChangeLog.html">ChangeLog</A> (<A HREF="ChangeLog.txt">txt</A>) is written with each release. |
<li><span class="man">mdoctree(1)</span> – prints input abstract syntax tree |
</P> |
</ul> |
|
|
|
<p> |
<H2> |
The <span class="man">mdocterm(1)</span> utility is intended to deprecate usage of <a |
Current |
href="http://www.gnu.org/software/groff/" class="external">groff</a> for displaying BSD manuals to the |
</H2> |
terminal, either directly or cached as a “catman” page. |
|
</p> |
|
|
|
<p> |
<TABLE WIDTH="100%" SUMMARY="Current Sources"> |
<span class="attn">Please submit patches!</span> Although a significant implementation exists, work |
<COL WIDTH="200"> |
remains for the backend library and especially the front-end utilities. See the <a |
<COL> |
href="#contact">contact</a> information below to submit patches and bug reports. |
<TBODY> |
</p> |
<TR> |
</td> |
<TD>Source archive</TD> |
</tr> |
<TD> |
<tr> |
<A HREF="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</A> |
<td> |
(<A HREF="/snapshots/mdocml.md5">md5</A>) |
<h1> |
</TD> |
INSTALLING SOURCES |
</TR> |
</h1> |
<TR> |
|
<TD>Online source</TD> |
|
<TD> |
|
<A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A> |
|
</TD> |
|
</TR> |
|
</TBODY> |
|
</TABLE> |
|
|
<p> |
<H2> |
Sources correctly build and install on OpenBSD, NetBSD and Linux operating systems, tested variously on |
Downstream |
i386, AMD64 and Alpha. |
</H2> |
</p> |
|
|
|
<p> |
<TABLE WIDTH="100%" SUMMARY="Downstream Sources"> |
The most current version is <span class="attn">@VERSION@</span>, dated |
<COL WIDTH="200"> |
<span class="attn">@VDATE@</span>. |
<COL> |
</p> |
<TBODY> |
|
<TR> |
|
<TD>DragonFly BSD</TD> |
|
<TD> |
|
<A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc" |
|
CLASS="external">usr.bin/mandoc</A> |
|
</TD> |
|
</TR> |
|
<TR> |
|
<TD>FreeBSD</TD> |
|
<TD> |
|
<A HREF="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/" |
|
CLASS="external">ports/textproc/mdocml</A> |
|
</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> |
|
</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> |
|
</TD> |
|
</TR> |
|
</TBODY> |
|
</TABLE> |
|
|
<h2> |
<H2> |
Snapshot source |
Historical |
</h2> |
</H2> |
|
|
<p> |
<TABLE WIDTH="100%" SUMMARY="Archived Sources"> |
CVS sources are checkedout and snapshotted with version updates. These may be found in the <a |
<COL WIDTH="200"> |
href="/snapshots/">/snapshots/</a> directory. |
<COL> |
</p> |
<TBODY> |
|
<TR> |
|
<TD>Source archive</TD> |
|
<TD> |
|
<A HREF="/snapshots/">/snapshots/</A> |
|
</TD> |
|
</TR> |
|
</TBODY> |
|
</TABLE> |
|
</TD> |
|
</TR> |
|
<TR> |
|
<TD> |
|
<H1> |
|
<A NAME="documentation">DOCUMENTATION</A> |
|
</H1> |
|
|
<p class="boxed"> |
<P> |
% cd /tmp<br> |
These manuals are generated automatically and refer to the current snapshot. |
% ftp -V -o- http://mdocml.bsd.lv/snapshots/mdocml.tar.gz | tar -zvxf -<br> |
</P> |
% cd mdocml<br> |
|
% make all<br> |
|
% make regress<br> |
|
# make install |
|
</p> |
|
|
|
<h2> |
<TABLE WIDTH="100%" SUMMARY="Documentation"> |
Snapshot port/pkgsrc |
<COL WIDTH="200"> |
</h2> |
<COL> |
|
<TBODY> |
|
<TR> |
|
<TD VALIGN="top"><A HREF="man.3.html">man(3)</A></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> |
|
<TD VALIGN="top"><A HREF="man.7.html">man(7)</A></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> |
|
<TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></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> |
|
<TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></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> |
|
<TD VALIGN="top"><A HREF="mdoc.3.html">mdoc(3)</A></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> |
|
<TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></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> |
|
<TD VALIGN="top"><A HREF="roff.3.html">roff(3)</A></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> |
|
<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> |
|
</TABLE> |
|
|
<p> |
<P> |
The source snapshot is automatically converted into OpenBSD port and NetBSD pkgsrc forms at <a |
See <Q><A CLASS="external" HREF="http://manpages.bsd.lv">Writing UNIX Manual Pages</A></Q> for a general |
href="/ports-openbsd/">/ports-openbsd/</a> and <a href="/ports-netbsd/">/ports-netbsd/</a>, |
introduction to manpages and mdoc. |
respectively. Please read the <a href="http://www.openbsd.org/faq/faq15.html">OpenBSD Ports FAQ</a> or |
</P> |
<a href="http://www.netbsd.org/docs/software/packages.html">NetBSD pkgsrc guide</a>, first. |
</TD> |
</p> |
</TR> |
|
<TR> |
|
<TD> |
|
<H1> |
|
<A NAME="contact">CONTACT</A> |
|
</H1> |
|
|
<h3> |
<P> |
OpenBSD port |
Please use the mailing lists for bug-reports, patches, questions, etc. Beyond that, contact |
</h3> |
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> |
|
|
<p class="boxed"> |
<P> |
# pkg_delete mdocml<br> |
You may also subscribe to several mailing lists (these require subscription, which is |
# cd /usr/ports/textproc/<br> |
moderated). An archive is not yet available on-line, although you may request one once |
# rm -rf mdocml<br> |
subscribed. |
# ftp -V -o- http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz | tar -zvxf -<br> |
</P> |
# cd mdocml<br> |
|
# make build<br> |
|
# make install |
|
</p> |
|
|
|
<h3> |
<TABLE WIDTH="100%" SUMMARY="Mailing Lists"> |
NetBSD pkgsrc |
<COL WIDTH="200"> |
</h3> |
<COL> |
|
<TBODY> |
<p class="boxed"> |
<TR> |
# pkg_delete mdocml<br> |
<TD> |
# cd /usr/pkgsrc/textproc/<br> |
disc<A CLASS="external" TITLE="Reveal this e-mail address" |
# rm -rf mdocml<br> |
HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv |
# ftp -V -o- http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz | tar -zvxf -<br> |
</TD> |
# cd mdocml<br> |
<TD>bug-reports, general questions, and announcements</TD> |
# make build<br> |
</TR> |
# make install |
<TR> |
</p> |
<TD> |
</td> |
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 |
<tr> |
</TD> |
<td> |
<TD>patches and system discussions</TD> |
<h1> |
</TR> |
CONTACT |
<TR> |
</h1> |
<TD> |
|
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 |
Please contact Kristaps, kris<a class="external" |
</TD> |
href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ==" |
<TD>source commit messages</TD> |
onclick="window.open('http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ==', |
</TR> |
'', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=0,width=500,height=300'); return |
</TBODY> |
false;" title="Reveal this e-mail address">...</a>@kth.se, with questions, bug reports, patches, and so on. |
</TABLE> |
</p> |
</TD> |
|
</TR> |
<p> |
<TR> |
If you'd like to submit patches, please contact us beforehand in case larger changes are pending but not |
<TD> |
checked in. If making a bug report, please make sure it's repeatable on the most current snapshot. |
<H1> |
</p> |
<A NAME="news">NEWS</A> |
</td> |
</H1> |
</tr> |
<DIV CLASS="news"> |
<tr> |
<P> |
<td> |
<SPAN CLASS="date">12-07-2010</SPAN>: |
<div class="foot"> |
version 1.10.4 |
Copyright © 2009 Kristaps Džonsons, $Date$ |
</P> |
</div> |
<P> |
</td> |
Lots of features developed during both <A CLASS="external" |
</tr> |
HREF="http://netbsd-soc.sourceforge.net/projects/mandoc_ps/">Summer of Code</A> and the |
</tbody> |
<A CLASS="external" HREF="http://www.openbsd.org">OpenBSD</A> c2k10 hackathon: |
</table> |
</P> |
</body> |
<UL> |
</html> |
<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 |
|
</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> |
|
</TR> |
|
<TR> |
|
<TD> |
|
<DIV CLASS="foot"> |
|
Copyright © 2008–2010 Kristaps Dzonsons, $Date$ |
|
</DIV> |
|
</TD> |
|
</TR> |
|
</TBODY> |
|
</TABLE> |
|
</BODY> |
|
</HTML> |