<!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="style.css" type="text/css" media="all">
- <title>mdocml.bsd.lv</title>
- </head>
- <body>
- <table width="600">
- <col width="100%">
- <tbody>
- <tr>
- <td>
- <div class="head">
- <b>mdocml</b> – mdoc macro compiler
- </div>
- </td>
- </tr>
- <tr>
- <td valign="top">
- <h1>
+<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>
DESCRIPTION
- </h1>
+ </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
+ <P>
+ <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 <Q>-man</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 roff implementation, for
displaying -mdoc pages whilst providing token support for -man.
- </p>
+ </P>
- <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>
- <p>
- The core of <span class="nm">mdocml</span> is composed of the <i>libmdoc</i> and <i>libman</i>
+ <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>
- INSTALLING SOURCES
- </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>.
- </p>
-
- <h2>
- Snapshot source
- </h2>
-
- <p>
- CVS sources are checkedout and snapshotted with version updates. These (and all historical snapshots)
- may be found in the <a href="/snapshots/">/snapshots/</a> directory. A full <a
- href="/snapshots/ChangeLog">ChangeLog</a> is written with each new snapshot.
- </p>
-
- <p class="boxed">
- % cd /tmp<br>
- % ftp -V -o- <a href="http://mdocml.bsd.lv/snapshots/mdocml.tar.gz">
- http://mdocml.bsd.lv/snapshots/mdocml.tar.gz</a> | tar -zvxf -<br>
- % cd mdocml<br>
- % make all<br>
- # make install
- </p>
-
- <h2>
- Snapshot port/pkgsrc
- </h2>
-
- <p>
- The source snapshot is automatically converted into OpenBSD, NetBSD and FreeBSD ports at <a
- href="/ports-openbsd/">/ports-openbsd/</a>, <a href="/ports-netbsd/">/ports-netbsd/</a> and <a
- href="/ports-freebsd/">/ports-freebsd/</a>, respectively. Please read the <a class="external"
- href="http://www.openbsd.org/faq/faq15.html">OpenBSD Ports FAQ</a>, the <a class="external"
- href="http://www.netbsd.org/docs/software/packages.html">NetBSD pkgsrc guide</a> or the <a
- class="external"
- href="http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ports-using.html">FreeBSD ports
- guide</a>, first.
- </p>
-
- <h3>
- OpenBSD port
- </h3>
-
- <p>
- Note: the <span class="nm">mdocml</span> utility is part of OpenBSD's base system at <a
- href="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/">usr.bin/mandoc</a>. Please use this
- instead of the provided port.
- </p>
-
- <p class="boxed">
- # pkg_delete mdocml<br>
- # cd /usr/ports/textproc/<br>
- # rm -rf mdocml<br>
- # ftp -V -o- <a href="http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz">
- http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz</a> | tar -zvxf -<br>
- # cd mdocml<br>
- # make build<br>
- # make install
- </p>
-
- <h3>
- NetBSD pkgsrc
- </h3>
-
- <p>
- Note: a pkgsrc port is maintained in-tree at <a
- href="http://cvsweb.netbsd.org/bsdweb.cgi/pkgsrc/textproc/mdocml/">textproc/mdocml</a>. Please use this
- instead of the provided pkgsrc.
- </p>
-
- <p class="boxed">
- # pkg_delete mdocml<br>
- # cd /usr/pkgsrc/textproc/<br>
- # rm -rf mdocml<br>
- # 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>
- FreeBSD port
- </h3>
-
- <p>
- Note: a port is maintained in-tree at <a
- href="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/">textproc/mdocml</a>. Please use
- this instead of the provided port.
- </p>
-
- <p class="boxed">
- # pkg_delete -x mdocml<br>
- # cd /tmp<br>
- # ftp -V -o- <a href="http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz">
- http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz</a> | tar -zvxf -<br>
- # cd mdocml<br>
- # make<br>
- # make install
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <h1>
+ </P>
+
+ <P>
+ The <SPAN CLASS="nm">mdocml</SPAN> utility is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv
+ Project</A> member.
+ </P>
+ </TD>
+ </TR>
+ <TR>
+ <TD>
+ <H1>
+ SOURCES
+ </H1>
+
+ <P>
+ Sources correctly build and install on DragonFly BSD, FreeBSD, OpenBSD, NetBSD, and GNU/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.html">ChangeLog</A> (<A HREF="ChangeLog.txt">txt</A>) is written with each release.
+ </P>
+
+ <H2>
+ Current
+ </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 CLASS="external" HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A>
+ </TD>
+ </TR>
+ </TBODY>
+ </TABLE>
+
+ <H2>
+ Downstream
+ </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%" 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>
DOCUMENTATION
- </h1>
-
- <table width="100%">
- <colgroup>
- <col>
- <col width="5">
- <col width="100%">
- </colgroup>
- <tr>
- <td><a href="mandoc.1.txt">mandoc(1)</a></td>
- <td></td>
- <td>format and display UNIX manuals</td>
- </tr>
- <tr>
- <td><a href="mandoc_char.7.txt">mandoc_char(7)</a></td>
- <td></td>
- <td>mandoc special characters</td>
- </tr>
- <tr>
- <td><a href="mdoc.7.txt">mdoc(7)</a></td>
- <td></td>
- <td>mdoc language reference</td>
- </tr>
- <tr>
- <td><a href="man.7.txt">man(7)</a></td>
- <td></td>
- <td>man language reference</td>
- </tr>
- <tr>
- <td><a href="manuals.7.txt">manuals(7)</a></td>
- <td></td>
- <td>a guide to writing UNIX manuals</td>
- </tr>
- <tr>
- <td><a href="mdoc.3.txt">mdoc(3)</a></td>
- <td></td>
- <td>mdoc macro compiler library</td>
- </tr>
- <tr>
- <td><a href="man.3.txt">man(3)</a></td>
- <td></td>
- <td>man macro compiler library</td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td>
- <h1>
+ </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><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, kris<a class="external"
- href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ=="
- onclick="window.open('http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ==',
- '', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=0,width=500,height=300'); return
- false;" title="Reveal this e-mail address">...</a>@kth.se.
- </p>
-
- <p>
- If you want to receive a semi-automated mail-out of new versions, then please write with a message
- subject of “subscribe mdocml” (or, symmetrically, “unsubscribe mdocml”).
- </p>
-
- <p>
- We don't offer anonymous CVS access. If you must have read-only access to the CVS tree (for down-stream
- maintenance and so on), then please contact Kristaps directly for a read-only CVS account. We strongly
- suggest using snapshots, instead.
- </p>
- </td>
- </tr>
- <tr>
- <td>
- <div class="foot">
- Copyright © 2008, 2009 Kristaps Džonsons, $Date: 2009/06/15 11:24:16 $
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </body>
-</html>
+ </H1>
+
+ <P>
+ For all issues related to <SPAN CLASS="nm">mdocml</SPAN>, contact Kristaps Dzonsons, kris<A
+ 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>
+ 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>
+ <H1>
+ NEWS
+ </H1>
+
+ <TABLE WIDTH="100%" CELLPADDING="2">
+ <COL CLASS="date">
+ <TBODY>
+ <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: 2010/03/31 08:42:40 $
+ </DIV>
+ </TD>
+ </TR>
+ </TBODY>
+ </TABLE>
+ </BODY>
+</HTML>
git.ckatri.com / mandoc.git / blobdiff