X-Git-Url: https://git.cameronkatri.com/mandoc.git/blobdiff_plain/23c2f10aeb41ed048e0c9ad77efae70cd3089ec7..52a2d24a5977427830c9757b19fb36e1d1ac5307:/index.sgml diff --git a/index.sgml b/index.sgml index a91f2ca1..a7baa7f2 100644 --- a/index.sgml +++ b/index.sgml @@ -1,205 +1,403 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> -<html> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> - <meta name="resource-type" content="document"> - <link rel="stylesheet" href="index.css" type="text/css" media="all"> - <title>mdocml.bsd.lv</title> - </head> - <body> - <table class="frame"> - <col width="100%"> - <tbody> - <tr> - <td> - <div class="head"> - <b>mdocml</b> – mdoc macro compiler - </div> - </td> - </tr> - <tr> - <td valign="top"> - <h1> - DESCRIPTION - </h1> - - <p> - <span class="nm">mdocml</span> is a suite of tools compiling “-mdoc”, the roff macro package - of choice for BSD manual pages, and “-man”, the predominant historical package for UNIX - 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 - displaying -mdoc pages whilst providing token support for -man. - </p> - - <p> +<HTML> + <HEAD> + <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8"> + <META NAME="resource-type" CONTENT="document"> + <LINK REL="stylesheet" HREF="index.css" TYPE="text/css" MEDIA="all"> + <TITLE>mdocml | mdoc macro compiler</TITLE> + </HEAD> + <BODY> + <TABLE CLASS="frame" SUMMARY="[frame]"> + <COL WIDTH="100%"> + <TBODY> + <TR> + <TD> + <DIV CLASS="head"> + <B>mdocml</B> – mdoc macro compiler + </DIV> + </TD> + </TR> + <TR> + <TD VALIGN="top"> + <H1> + <A NAME="description">DESCRIPTION</A> + </H1> + + <P> + <SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <Q>-<A HREF="mdoc.7.html">mdoc</A></Q>, the + roff macro package of choice for BSD manual pages, and <Q>-<A HREF="man.7.html">man</A></Q>, the + predominant historical package for UNIX 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 troff + implementation, for displaying -mdoc pages whilst providing token support for -man. + </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 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). - </p> - - <p> - The core of <span class="nm">mdocml</span> is composed of the <i>libmdoc</i> and <i>libman</i> - 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> - </td> - </tr> - <tr> - <td> - <h1> - DOWNLOADS - </h1> - - <p> - Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested - variously on i386, AMD64, alpha, and others. The most current version is <span - class="attn">@VERSION@</span>, dated <span class="attn">@VDATE@</span>. A full <a - href="ChangeLog.txt">ChangeLog</a> is written with each release. - </p> - - <h2> + this (respectively small, C, <A CLASS="external" + HREF="http://www.isc.org/software/license">ISC</A>-licensed, fast and regular). + </P> + + <P> + <SPAN CLASS="nm">mdocml</SPAN> consists of the <A HREF="mdoc.3.html">libmdoc</A>, <A + HREF="man.3.html">libman</A>, and <A HREF="roff.3.html">libroff</A> validating compilers; and <A + HREF="mandoc.1.html">mandoc</A>, which interfaces with the compiler libraries to format output for UNIX + terminals, XHTML, HTML, and PostScript. <SPAN CLASS="nm">mdocml</SPAN> is a <A CLASS="external" + HREF="http://bsd.lv/">BSD.lv</A> project. + </P> + + <P> + <I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, + <Q>mandoc</Q>. + </P> + </TD> + </TR> + <TR> + <TD> + <H1> + <A NAME="sources">SOURCES</A> + </H1> + + <P> + <SPAN CLASS="nm">mdocml</SPAN> is architecture- and system-neutral, written in plain-old C. The most + current version 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> + + <H2> Current - </h2> - - <table width="100%"> - <col width="200"> - <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> - </tbody> - </table> - - <h2> + </H2> + + <TABLE WIDTH="100%" SUMMARY="Current Sources"> + <COL WIDTH="200"> + <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> + + <H2> Downstream - </h2> - - <table width="100%"> - <col width="200"> - <col> - <tbody> - <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/pkgsrc/textproc/mdocml/" - class="external">pkgsrc/textproc/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> + + <TABLE WIDTH="100%" SUMMARY="Downstream Sources"> + <COL WIDTH="200"> + <COL> + <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> Historical - </h2> - - <table width="100%"> - <col width="200"> - <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> - These manuals are generated automatically (with <a href="mandoc.1.html">mandoc(1)</a> -Thtml) and refer to the - current snapshot. - </p> - - <table width="100%"> - <col width="200"> - <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> - For all issues related to <span class="nm">mdocml</span>, contact Kristaps Džonsons, kris<a - class="external" - href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ==" - title="Reveal this e-mail address">...</a>@kth.se. - </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> - </tr> - <tr> - <td> - <div class="foot"> - Copyright © 2008, 2009 Kristaps Džonsons, $Date: 2009/09/25 14:07:51 $ - </div> - </td> - </tr> - </tbody> - </table> - </body> -</html> + </H2> + + <TABLE WIDTH="100%" SUMMARY="Archived Sources"> + <COL WIDTH="200"> + <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> + These manuals are generated automatically and refer to the current snapshot. + </P> + + <TABLE WIDTH="100%" SUMMARY="Documentation"> + <COL WIDTH="200"> + <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> + See <Q><A CLASS="external" HREF="http://manpages.bsd.lv">Writing UNIX Manual Pages</A></Q> for a general + introduction to manpages and mdoc. + </P> + </TD> + </TR> + <TR> + <TD> + <H1> + <A NAME="contact">CONTACT</A> + </H1> + + <P> + Please use the mailing lists for bug-reports, patches, questions, etc. 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> + + <P> + You may also subscribe to several mailing lists (these require subscription, which is + moderated). An archive is not yet available on-line, although you may request one once + subscribed. + </P> + + <TABLE WIDTH="100%" SUMMARY="Mailing Lists"> + <COL WIDTH="200"> + <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>bug-reports, general questions, and 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>patches and system 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">12-07-2010</SPAN>: + version 1.10.4 + </P> + <P> + Lots of features developed during both <A CLASS="external" + HREF="http://netbsd-soc.sourceforge.net/projects/mandoc_ps/">Summer of Code</A> and the + <A CLASS="external" HREF="http://www.openbsd.org">OpenBSD</A> c2k10 hackathon: + </P> + <UL> + <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: 2010/07/21 10:10:24 $ + </DIV> + </TD> + </TR> + </TBODY> + </TABLE> + </BODY> +</HTML>