| version 1.2, 2009/02/23 15:38:20 |
version 1.68, 2010/05/14 12:02:12 |
|
|
| <!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 |
DESCRIPTION |
| </h1> |
</H1> |
| |
|
| <p> |
<P> |
| <span class="nm">mdocml</span> is a suite of tools that compile “mdoc”, the roff macro |
<SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <Q>-mdoc</Q>, the roff macro package |
| package of the BSD manual pages. The mission of <span class="nm">mdocml</span> is to deprecate <a |
of choice for BSD manual pages, and <Q>-man</Q>, the predominant historical package for UNIX |
| href="http://www.gnu.org/software/groff/" class="external">groff</a>, the GNU roff implementation, for |
manuals. The mission of <SPAN CLASS="nm">mdocml</SPAN> is to deprecate <A |
| displaying BSD mdoc pages. groff amounts to over 60 000 lines of GPL C++ source, which is a |
HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU roff implementation, for |
| considerable encumbrance to BSD operating system. |
displaying -mdoc pages whilst providing token support for -man. |
| </p> |
</P> |
| |
|
| <p> |
<P> |
| The core of <span class="nm">mdocml</span> is the libmdoc library, a validating scanner-parser producing |
Why? groff amounts to over 5 MB of source code, most of which is C++ and all of which is GPL. It runs |
| intermediate-form output from mdoc input. libmdoc is a simple, fast library operating on memory buffers |
slowly, produces uncertain output, and varies in operation from system to system. mdocml strives to fix |
| of mdoc input. Its intermediate output, an abstract syntax tree, is fully documented in the <span |
this (respectively small, C, ISC-licensed, fast and regular). |
| class="man">mdoc(3)</span> reference manual. |
</P> |
| </p> |
|
| |
|
| <p> |
<P> |
| There are three utilities implementing <span class="man">mdoc(3)</span>: |
The core of <SPAN CLASS="nm">mdocml</SPAN> is composed of the <i>libmdoc</i> and <i>libman</i> |
| </p> |
validating compiler libraries. Both are simple, fast libraries operating on memory buffers, so they may |
| |
be used for a variety of front-ends (terminal-based, CGI and so on). The primary front-end is <i> |
| |
mandoc</i>, which formats manuals for display on the terminal. |
| |
</P> |
| |
|
| <ul> |
<P> |
| <li><span class="man">mdocterm(1)</span> – formats mdoc input for display on the terminal |
The <SPAN CLASS="nm">mdocml</SPAN> utility is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv |
| <li><span class="man">mdochtml(1)</span> – formats mdoc input as strict HTML (nascent) |
Project</A> member. |
| <li><span class="man">mdoclint(1)</span> – validates mdoc input |
</P> |
| <li><span class="man">mdoctree(1)</span> – prints input abstract syntax tree |
</TD> |
| </ul> |
</TR> |
| |
<TR> |
| |
<TD> |
| |
<H1> |
| |
SOURCES |
| |
</H1> |
| |
|
| <p> |
<P> |
| The <span class="man">mdocterm(1)</span> utility is intended to deprecate usage of <a |
Sources correctly build and install on DragonFly BSD, FreeBSD, OpenBSD, NetBSD, and GNU/Linux operating |
| href="http://www.gnu.org/software/groff/" class="external">groff</a> for displaying BSD manuals to the |
systems, tested variously on i386, AMD64, alpha, and others. The most current version is <SPAN |
| terminal, either directly or cached as a “catman” page. |
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. |
| |
</P> |
| |
|
| <p> |
<H2> |
| <span class="attn">Please submit patches!</span> Although a significant implementation exists, work |
Current |
| remains for the backend library and especially the front-end utilities. See the <a |
</H2> |
| href="#contact">contact</a> information below to submit patches and bug reports. |
|
| </p> |
|
| </td> |
|
| </tr> |
|
| <tr> |
|
| <td> |
|
| <h1> |
|
| INSTALLING SOURCES |
|
| </h1> |
|
| |
|
| <p> |
<TABLE WIDTH="100%" SUMMARY="Current Sources"> |
| Sources correctly build and install on OpenBSD, NetBSD and Linux operating systems, tested variously on |
<COL WIDTH="200"> |
| i386, AMD64 and Alpha. |
<COL> |
| </p> |
<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 CLASS="external" HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A> |
| |
</TD> |
| |
</TR> |
| |
</TBODY> |
| |
</TABLE> |
| |
|
| <h2> |
<H2> |
| nightly source |
Downstream |
| </h2> |
</H2> |
| |
|
| <p> |
<TABLE WIDTH="100%" SUMMARY="Downstream Sources"> |
| CVS sources are checkedout and snapshotted nightly. These may be found in the <a |
<COL WIDTH="200"> |
| href="/snapshots/">/snapshots/</a> directory. |
<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> |
| |
|
| <p class="boxed"> |
<H2> |
| % cd /tmp<br> |
Historical |
| % ftp -V -o- http://mdocml.bsd.lv/snapshots/mdocml.tgz | tar -zxf -<br> |
</H2> |
| % cd mdocml<br> |
|
| % make<br> |
|
| % make regress<br> |
|
| % make install |
|
| </p> |
|
| |
|
| <h2> |
<TABLE WIDTH="100%" SUMMARY="Archived Sources"> |
| nightly port |
<COL WIDTH="200"> |
| </h2> |
<COL> |
| |
<TBODY> |
| |
<TR> |
| |
<TD>Source archive</TD> |
| |
<TD> |
| |
<A HREF="/snapshots/">/snapshots/</A> |
| |
</TD> |
| |
</TR> |
| |
</TBODY> |
| |
</TABLE> |
| |
</TD> |
| |
</TR> |
| |
<TR> |
| |
<TD> |
| |
<H1> |
| |
DOCUMENTATION |
| |
</H1> |
| |
|
| <p> |
<P> |
| The nightly snapshot is automatically converted into an OpenBSD port (ports for other BSD systems not |
These manuals are generated automatically and refer to the current snapshot. |
| yet available). These may be found in the <a href="/ports-openbsd/">/ports-openbsd/</a> directory. |
</P> |
| </p> |
|
| |
|
| <p> |
<TABLE WIDTH="100%" SUMMARY="Documentation"> |
| If installing for the first time: |
<COL WIDTH="200"> |
| </p> |
<COL> |
| |
<TBODY> |
| |
<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="mdoc.7.html">mdoc(7)</A> (<A HREF="mdoc.7.txt">text</A>)</TD> |
| |
<TD>mdoc language reference</TD> |
| |
</TR> |
| |
<TR> |
| |
<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="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="man.3.html">man(3)</A> (<A HREF="man.3.txt">text</A>)</TD> |
| |
<TD>man macro compiler library</TD> |
| |
</TR> |
| |
</TBODY> |
| |
</TABLE> |
| |
</TD> |
| |
</TR> |
| |
<TR> |
| |
<TD> |
| |
<H1> |
| |
CONTACT |
| |
</H1> |
| |
|
| <p class="boxed"> |
<P> |
| % ftp -V -o- http://mdocml.bsd.lv/ports-openbsd/mdocml.tgz | tar -zxf -<br> |
For all issues related to <SPAN CLASS="nm">mdocml</SPAN>, contact Kristaps Dzonsons, kris<A |
| % cd mdocml<br> |
CLASS="external" |
| % sudo make<br> |
HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" |
| % sudo make install |
TITLE="Reveal this e-mail address">...</A>@bsd.lv. |
| </p> |
</P> |
| |
|
| <p> |
<P> |
| Subsequent installations: |
You may also subscribe to several mailing lists (these require subscription, which is moderated). An |
| </p> |
archive is not yet available. |
| |
</P> |
| |
|
| <p class="boxed"> |
<TABLE WIDTH="100%" SUMMARY="Mailing Lists"> |
| % sudo pkg_add -r mdocml |
<COL WIDTH="200"> |
| </p> |
<COL> |
| </td> |
<TBODY> |
| </tr> |
<TR> |
| <tr> |
<TD> |
| <td> |
disc<A CLASS="external" TITLE="Reveal this e-mail address" |
| <h1> |
HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</a>@mdocml.bsd.lv |
| CONTACT |
</TD> |
| </h1> |
<TD>discussions and announcements</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> |
| |
NEWS |
| |
</H1> |
| |
|
| <p> |
<TABLE WIDTH="100%" CELLPADDING="2"> |
| Please contact Kristaps, kris<a class="external" |
<COL CLASS="date"> |
| href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ==" |
<TBODY> |
| 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 |
<TD VALIGN="top"><SPAN CLASS="date">13-05-2010</SPAN></TD> |
| false;" title="Reveal this e-mail address">...</a>@kth.se, with questions, bug reports, patches, and so on. |
<TD VALIGN="top"> |
| </p> |
Fixed handling of <Q>\*(Ba</Q> escape. Backed out <SPAN |
| |
CLASS="flag">-fno-ign-chars</SPAN> (pointless complexity). Fixed erroneous |
| <p> |
breaking of literal lines. Fixed SYNOPSIS breaking lines before non-initial |
| If you'd like to submit patches, please contact us beforehand in case larger changes are pending but not |
macros. Changed default section ordering. Most importantly, the framework for |
| checked in. If making a bug report, please make sure it's repeatable on the most current snapshot. |
end-of-sentence double-spacing is in place, now implemented for the |
| </p> |
<Q>end-of-sentence, end-of-line</Q> rule. This is a stable roll-back point |
| </td> |
before the mandoc hackathon in Rostock! |
| </tr> |
Version: <SPAN CLASS="rev">1.9.25</SPAN>. |
| <tr> |
</TR> |
| <td> |
<TR> |
| <div class="foot"> |
<TD VALIGN="top"><SPAN CLASS="date">09-05-2010</SPAN></TD> |
| Copyright © 2009 Kristaps Džonsons, $Date$ |
<TD VALIGN="top"> |
| </div> |
Rolled back break-at-hyphen. <SPAN CLASS="flag">-DUGLY</SPAN> is now the |
| </td> |
default (no feature splits!). Free-form text is not de-chunked any more: lines |
| </tr> |
are passed whole-sale into the front-end, including whitespace. Added mailing |
| </tbody> |
lists. Lastly, <SPAN CLASS="nm">mdocml</SPAN> is the focus of two <A |
| </table> |
CLASS="external" HREF="http://socghop.appspot.com/">Google Summer of Code</A> |
| </body> |
projects this year: <Q><A CLASS="external" |
| </html> |
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). |
| |
Version: <SPAN CLASS="rev">1.9.24</SPAN>. |
| |
</TD> |
| |
</TR> |
| |
|
| |
<TR> |
| |
<TD VALIGN="top"><SPAN CLASS="date">07-04-2010</SPAN></TD> |
| |
<TD VALIGN="top"> |
| |
<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. Version: <SPAN CLASS="rev">1.9.23</SPAN>. |
| |
</TD> |
| |
</TR> |
| |
<TR> |
| |
<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> |
| |
</TR> |
| |
<TR> |
| |
<TD VALIGN="top"><SPAN CLASS="date">30-03-2010</SPAN></TD> |
| |
<TD VALIGN="top"> |
| |
Version <SPAN CLASS="rev">1.9.20</SPAN>: more efforts to get roff instructions |
| |
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> |
| |
</TR> |
| |
<TR> |
| |
<TD VALIGN="top"><SPAN CLASS="date">27-03-2010</SPAN></TD> |
| |
<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> |
| |
</TR> |
| |
<TR> |
| |
<TD VALIGN="top"><SPAN CLASS="date">25-03-2010</SPAN></TD> |
| |
<TD VALIGN="top"> |
| |
Version <SPAN CLASS="rev">1.9.17</SPAN> highlights: accept <A |
| |
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> |
| |
</TR> |
| |
<TR> |
| |
<TD VALIGN="top"><SPAN CLASS="date">22-03-2010</SPAN></TD> |
| |
<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> |
| |
</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> |
| |
</TABLE> |
| |
</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