version 1.16, 2009/04/05 16:34:22 |
version 1.77, 2010/06/03 14:52:48 |
|
|
<!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> |
<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 <a href="mdoc.7.txt" class="man">mdoc(7)</a> pages whilst providing token support for <a |
displaying -mdoc pages whilst providing token support for -man. |
href="man.7.txt" class="man">man(7)</a>. |
</P> |
</p> |
|
|
|
<p> |
<P> |
What are UNIX manuals? Read <a href="manuals.7.txt" class="man">manuals(7)</a> for an introduction. |
|
</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> are the <a href="man.3.txt" class="man">man(3)</a> and <a |
The core of <SPAN CLASS="nm">mdocml</SPAN> is composed of the <A HREF="mdoc.3.html">libmdoc</A>, <A |
href="mdoc.3.txt" class="man">mdoc(3)</a> libraries, validating compilers producing intermediate-form |
HREF="man.3.html">libman</A>, and <A HREF="roff.3.html">libroff</A> validating compiler libraries. All |
output from -man or -mdoc input. Both are simple, fast libraries operating on memory buffers, so they |
are simple, fast libraries operating on memory buffers, so they may be used for a variety of front-ends |
may be used for a variety of front-ends (terminal-based, CGI and so on). |
(terminal-based, CGI and so on). The front-end is <A HREF="mandoc.1.html">mandoc</A>, which formats |
</p> |
manuals for display. |
|
</P> |
<p> |
|
The primary front-end is <a href="mandoc.1.txt" class="man">mandoc(1)</a>, which formats manuals for |
|
display on the terminal. Its purpose is to deprecate usage of groff for displaying -mdoc and, to a |
|
limited extent, -man manuals on the terminal. |
|
</p> |
|
|
|
<p> |
<P> |
<span class="attn">Please submit patches, bug reports and suggestions!</span> Although a significant |
The <SPAN CLASS="nm">mdocml</SPAN> suite is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv |
implementation exists, work remains for the backend library and especially the front-end utilities. See |
Project</A> member. |
the <a href="#contact">contact</a> information below for submissions. |
</P> |
</p> |
</TD> |
</td> |
</TR> |
</tr> |
<TR> |
<tr> |
<TD> |
<td> |
<H1> |
<h1> |
<A NAME="sources">SOURCES</A> |
INSTALLING SOURCES |
</H1> |
</h1> |
|
|
|
<p> |
<P> |
Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested |
Sources correctly build and install on DragonFly BSD, FreeBSD, OpenBSD, NetBSD, GNU/Linux, and many |
variously on i386, AMD64, alpha and others. |
other operating systems, tested variously on i386, AMD64, alpha, and others. The most current version |
</p> |
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> |
|
|
<p> |
<H2> |
The most current version is <span class="attn">@VERSION@</span>, dated |
Current |
<span class="attn">@VDATE@</span>. |
</H2> |
</p> |
|
|
|
<h2> |
<TABLE WIDTH="100%" SUMMARY="Current Sources"> |
Snapshot source |
<COL WIDTH="200"> |
</h2> |
<COL> |
|
<TBODY> |
|
<TR> |
|
<TD>Source archive</TD> |
|
<TD> |
|
<A HREF="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</A> |
|
(<A HREF="/snapshots/mdocml.md5">md5</A>) |
|
</TD> |
|
</TR> |
|
<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> |
CVS sources are checkedout and snapshotted with version updates. These may be found in the <a |
Downstream |
href="/snapshots/">/snapshots/</a> directory. |
</H2> |
</p> |
|
|
|
<p class="boxed"> |
<TABLE WIDTH="100%" SUMMARY="Downstream Sources"> |
% cd /tmp<br> |
<COL WIDTH="200"> |
% ftp -V -o- <a href="http://mdocml.bsd.lv/snapshots/mdocml.tar.gz"> |
<COL> |
http://mdocml.bsd.lv/snapshots/mdocml.tar.gz</a> | tar -zvxf -<br> |
<TBODY> |
% cd mdocml<br> |
<TR> |
% make all<br> |
<TD>DragonFly BSD</TD> |
% make regress<br> |
<TD> |
# make install |
<A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc" |
</p> |
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 port/pkgsrc |
Historical |
</h2> |
</H2> |
|
|
<p> |
<TABLE WIDTH="100%" SUMMARY="Archived Sources"> |
The source snapshot is automatically converted into OpenBSD, NetBSD and FreeBSD ports at <a |
<COL WIDTH="200"> |
href="/ports-openbsd/">/ports-openbsd/</a>, <a href="/ports-netbsd/">/ports-netbsd/</a> and <a |
<COL> |
href="/ports-freebsd/">/ports-freebsd/</a>, respectively. Please read the <a class="external" |
<TBODY> |
href="http://www.openbsd.org/faq/faq15.html">OpenBSD Ports FAQ</a>, the <a class="external" |
<TR> |
href="http://www.netbsd.org/docs/software/packages.html">NetBSD pkgsrc guide</a> or the <a |
<TD>Source archive</TD> |
class="external" |
<TD> |
href="http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ports-using.html">FreeBSD ports |
<A HREF="/snapshots/">/snapshots/</A> |
guide</a>, first. |
</TD> |
</p> |
</TR> |
|
</TBODY> |
|
</TABLE> |
|
</TD> |
|
</TR> |
|
<TR> |
|
<TD> |
|
<H1> |
|
<A NAME="documentation">DOCUMENTATION</A> |
|
</H1> |
|
|
<h3> |
<P> |
OpenBSD port |
These manuals are generated automatically and refer to the current snapshot. |
</h3> |
</P> |
|
|
<p class="boxed"> |
<TABLE WIDTH="100%" SUMMARY="Documentation"> |
# pkg_delete mdocml<br> |
<COL WIDTH="200"> |
# cd /usr/ports/textproc/<br> |
<COL> |
# rm -rf mdocml<br> |
<TBODY> |
# ftp -V -o- <a href="http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz"> |
<TR> |
http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz</a> | tar -zvxf -<br> |
<TD><A HREF="man.3.html">man(3)</A> (<A HREF="man.3.txt">text</A>)</TD> |
# cd mdocml<br> |
<TD>man macro compiler library</TD> |
# make build<br> |
</TR> |
# make install |
<TR> |
</p> |
<TD><A HREF="man.7.html">man(7)</A> (<A HREF="man.7.txt">text</A>)</TD> |
|
<TD>man language reference</TD> |
|
</TR> |
|
<TR> |
|
<TD><A HREF="mandoc.1.html">mandoc(1)</A> (<A HREF="mandoc.1.txt">text</A>)</TD> |
|
<TD>format and display UNIX manuals</TD> |
|
</TR> |
|
<TR> |
|
<TD><A HREF="mandoc_char.7.html">mandoc_char(7)</A> (<A HREF="mandoc_char.7.txt">text</A>)</TD> |
|
<TD>mandoc special characters</TD> |
|
</TR> |
|
<TR> |
|
<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> |
|
</TR> |
|
<TR> |
|
<TD><A HREF="mdoc.3.html">mdoc(3)</A> (<A HREF="mdoc.3.txt">text</A>)</TD> |
|
<TD>mdoc macro compiler library</TD> |
|
</TR> |
|
<TR> |
|
<TD><A HREF="mdoc.7.html">mdoc(7)</A> (<A HREF="mdoc.7.txt">text</A>)</TD> |
|
<TD>mdoc language reference</TD> |
|
</TR> |
|
<TR> |
|
<TD><A HREF="roff.3.html">roff(3)</A> (<A HREF="roff.3.txt">text</A>)</TD> |
|
<TD>roff macro compiler library</TD> |
|
</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> |
|
</TABLE> |
|
</TD> |
|
</TR> |
|
<TR> |
|
<TD> |
|
<H1> |
|
<A NAME="contact">CONTACT</A> |
|
</H1> |
|
|
<h3> |
<P> |
NetBSD pkgsrc |
For all issues related to <SPAN CLASS="nm">mdocml</SPAN>, contact Kristaps Dzonsons, kris<A |
</h3> |
CLASS="external" |
|
HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" |
|
TITLE="Reveal this e-mail address">...</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 moderated). An |
# cd /usr/pkgsrc/textproc/<br> |
archive is not yet available on-line, although you may request one once subscribed. |
# rm -rf mdocml<br> |
</P> |
# ftp -V -o- <a href="http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz"> |
|
http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz</a> | tar -zvxf -<br> |
|
# cd mdocml<br> |
|
# make build<br> |
|
# make install |
|
</p> |
|
|
|
<h3> |
<TABLE WIDTH="100%" SUMMARY="Mailing Lists"> |
FreeBSD port |
<COL WIDTH="200"> |
</h3> |
<COL> |
|
<TBODY> |
|
<TR> |
|
<TD> |
|
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 |
|
</TD> |
|
<TD>high-level discussions and version announcements</TD> |
|
</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>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">xx-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. |
|
</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> |
|
<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> |
|
|
<p class="boxed"> |
<DIV CLASS="news"> |
# pkg_delete -x mdocml<br> |
<P> |
# cd /tmp<br> |
<SPAN CLASS="date">07-04-2010</SPAN>: |
# ftp -V -o- <a href="http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz"> |
version 1.9.23 |
http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz</a> | tar -zvxf -<br> |
</P> |
# cd mdocml<br> |
<P> |
# make<br> |
<SPAN CLASS="nm">mdocml</SPAN> has been linked to the <A CLASS="external" |
# make install |
HREF="http://www.openbsd.org/faq/current.html#20100403">OpenBSD build</a>. This |
</p> |
version incorporates many small changes, mostly from patches by OpenBSD, |
</td> |
allowing crufty manuals to slip by with warnings instead of erroring-out. Some |
</tr> |
subtle semantic issues, such as punctuation scope, have also been fixed. |
<tr> |
Lastly, some issues with <SPAN CLASS="flag">-Thtml</SPAN> have been fixed, which |
<td> |
prompted an update to the <A HREF="mandoc.1.html">online</A> <A |
<h1> |
HREF="mandoc_char.7.html">manual</A> <A HREF="man.7.html">pages</A> style |
CONTACT |
layout. |
</h1> |
</P> |
|
</DIV> |
<p> |
<P> |
Please contact Kristaps, kris<a class="external" |
See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for |
href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ==" |
historical notes. |
onclick="window.open('http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ==', |
</P> |
'', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=0,width=500,height=300'); return |
</TD> |
false;" title="Reveal this e-mail address">...</a>@kth.se, with questions, bug reports, patches, and so |
</TR> |
on. |
<TR> |
</p> |
<TD> |
|
<DIV CLASS="foot"> |
<p> |
Copyright © 2008–2010 Kristaps Dzonsons, $Date$ |
If you'd like to submit patches, please contact us beforehand in case larger changes are pending but not |
</DIV> |
checked in. If making a bug report, please make sure it's repeatable on the most current snapshot. |
</TD> |
</p> |
</TR> |
</td> |
</TBODY> |
</tr> |
</TABLE> |
<tr> |
</BODY> |
<td> |
</HTML> |
<div class="foot"> |
|
Copyright © 2008, 2009 Kristaps Džonsons, $Date$ |
|
</div> |
|
</td> |
|
</tr> |
|
</tbody> |
|
</table> |
|
</body> |
|
</html> |
|