| version 1.4, 2009/02/23 20:55:56 |
version 1.106, 2011/03/22 10:02:50 |
|
|
| <!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 that compile “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 of the 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. groff amounts to over 60 000 lines of GPL C++ source, which is a |
deprecate <A HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU troff |
| considerable encumbrance to BSD operating system. |
implementation, for 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, <A CLASS="external" |
| class="man">mdoc(3)</span> reference manual. |
HREF="http://www.isc.org/software/license">ISC</A>-licensed, fast and regular). |
| </p> |
</P> |
| |
|
| <p> |
<P> |
| There are three utilities implementing <span class="man">mdoc(3)</span>: |
<SPAN CLASS="nm">mdocml</SPAN> consists of the <A HREF="mandoc.3.html">libmandoc</A> validating |
| </p> |
compilers and <A HREF="mandoc.1.html">mandoc</A>, which interfaces with the compiler library to format |
| |
output for UNIX terminals, XHTML, HTML, PostScript, and PDF. It is a <A CLASS="external" |
| |
HREF="http://bsd.lv/">BSD.lv</A> project. |
| |
</P> |
| |
|
| <ul> |
<P> |
| <li><span class="man">mdocterm(1)</span> – formats mdoc input for display on the terminal |
<I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, |
| <li><span class="man">mdochtml(1)</span> – formats mdoc input as strict HTML (nascent) |
<Q>mandoc</Q>. |
| <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> |
| |
<A NAME="sources">SOURCES</A> |
| |
</H1> |
| |
|
| <p> |
<P> |
| The <span class="man">mdocterm(1)</span> utility is intended to deprecate usage of <a |
<SPAN CLASS="nm">mdocml</SPAN> is architecture- and system-neutral, written in plain-old C. The most |
| href="http://www.gnu.org/software/groff/" class="external">groff</a> for displaying BSD manuals to the |
current version is <SPAN CLASS="attn">@VERSION@</SPAN>, dated <SPAN class="attn">@VDATE@</SPAN>. |
| terminal, either directly or cached as a “catman” page. |
</P> |
| </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="175"> |
| 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 HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A> |
| |
</TD> |
| |
</TR> |
| |
</TBODY> |
| |
</TABLE> |
| |
|
| <h2> |
<H2> |
| snapshotted source |
Downstream |
| </h2> |
</H2> |
| |
|
| <p> |
<TABLE WIDTH="100%" SUMMARY="Downstream Sources"> |
| CVS sources are checkedout and snapshotted with big updates. These may be found in the <a |
<COL WIDTH="175"> |
| 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.tar.gz | tar -zvxf -<br> |
</H2> |
| % cd mdocml<br> |
|
| % make && make regress && make install |
|
| </p> |
|
| |
|
| <h2> |
<TABLE WIDTH="100%" SUMMARY="Archived Sources"> |
| nightly port |
<COL WIDTH="175"> |
| </h2> |
<COL> |
| |
<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> |
<P> |
| The source 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> |
| You <span class="emph">must</span> have the ports tree installed. |
|
| </p> |
|
| |
|
| <p class="boxed"> |
<TABLE WIDTH="100%" SUMMARY="Documentation"> |
| % sudo pkg_delete mdocml<br> |
<COL WIDTH="175"> |
| % cd /usr/ports/devel/<br> |
<COL> |
| % sudo rm -rf mdocml<br> |
<TBODY> |
| % ftp -V -o- http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz | sudo tar -zvxf -<br> |
<TR> |
| % cd mdocml<br> |
<TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD> |
| % sudo make && sudo make regress && sudo make install |
<TD VALIGN="top"> |
| </p> |
format and display UNIX manuals |
| </td> |
<SPAN STYLE="font-size: smaller;"> |
| </tr> |
(<A HREF="mandoc.1.txt">text</A> | |
| <tr> |
<A HREF="mandoc.1.xhtml">xhtml</A> | |
| <td> |
<A HREF="mandoc.1.pdf">pdf</A> | |
| <h1> |
<A HREF="mandoc.1.ps">postscript</A>) |
| CONTACT |
</SPAN> |
| </h1> |
</TD> |
| |
</TR> |
| |
<TR> |
| |
<TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD> |
| |
<TD VALIGN="top"> |
| |
mandoc macro compiler library |
| |
<SPAN STYLE="font-size: smaller;"> |
| |
(<A HREF="mandoc.3.txt">text</A> | |
| |
<A HREF="mandoc.3.xhtml">xhtml</A> | |
| |
<A HREF="mandoc.3.pdf">pdf</A> | |
| |
<A HREF="mandoc.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.xhtml">xhtml</A> | |
| |
<A HREF="man.7.pdf">pdf</A> | |
| |
<A HREF="man.7.ps">postscript</A>) |
| |
</SPAN> |
| |
</TD> |
| |
</TR> |
| |
<TR> |
| |
<TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD> |
| |
<TD VALIGN="top"> |
| |
eqn-mandoc language reference |
| |
<SPAN STYLE="font-size: smaller;"> |
| |
(<A HREF="eqn.7.txt">text</A> | |
| |
<A HREF="eqn.7.xhtml">xhtml</A> | |
| |
<A HREF="eqn.7.pdf">pdf</A> | |
| |
<A HREF="eqn.7.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.xhtml">xhtml</A> | |
| |
<A HREF="mandoc_char.7.pdf">pdf</A> | |
| |
<A HREF="mandoc_char.7.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.xhtml">xhtml</A> | |
| |
<A HREF="mdoc.7.pdf">pdf</A> | |
| |
<A HREF="mdoc.7.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.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> |
| |
</TABLE> |
| |
|
| <p> |
<P> |
| Please contact Kristaps, kris<a class="external" |
See <Q><A CLASS="external" HREF="http://manpages.bsd.lv">Writing UNIX Manual Pages</A></Q> for a general |
| href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ==" |
introduction to manpages and mdoc. |
| 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 on. |
</TR> |
| </p> |
<TR> |
| |
<TD> |
| <p> |
<H1> |
| If you'd like to submit patches, please contact us beforehand in case larger changes are pending but not |
<A NAME="contact">CONTACT</A> |
| checked in. If making a bug report, please make sure it's repeatable on the most current snapshot. |
</H1> |
| </p> |
|
| </td> |
<P> |
| </tr> |
Please use the mailing lists for bug-reports, patches, questions, etc. (these require |
| <tr> |
subscription). Beyond that, contact Kristaps at <A |
| <td> |
HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" |
| <div class="foot"> |
TITLE="Reveal this e-mail address">kris...</A>@bsd.lv. |
| Copyright © 2009 Kristaps Džonsons, $Date$ |
</P> |
| </div> |
|
| </td> |
<TABLE WIDTH="100%" SUMMARY="Mailing Lists"> |
| </tr> |
<COL WIDTH="175"> |
| </tbody> |
<COL> |
| </table> |
<TBODY> |
| </body> |
<TR> |
| </html> |
<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> |
| |
bug-reports, general questions, and announcements |
| |
<SPAN STYLE="font-size: smaller;">(<A HREF="/archives/discuss/summary.html">archive</A>)</SPAN> |
| |
</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> |
| |
patches and system discussions |
| |
<SPAN STYLE="font-size: smaller;">(<A HREF="/archives/tech/summary.html">archive</A>)</SPAN> |
| |
</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 |
| |
<SPAN STYLE="font-size: smaller;">(<A HREF="/archives/source/summary.html">archive</A>)</SPAN> |
| |
</TD> |
| |
</TR> |
| |
</TBODY> |
| |
</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 |
| |
<DEL>libroff</DEL>: 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, <DEL>libmdoc</DEL> and <DEL>libman</DEL> 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> |
| |
</TR> |
| |
<TR> |
| |
<TD> |
| |
<DIV CLASS="foot"> |
| |
Copyright © 2008–2011 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