version 1.112, 2011/04/09 16:43:30 |
version 1.124, 2011/07/01 10:20:26 |
|
|
<P CLASS="head"> |
<P CLASS="head"> |
<B>mdocml</B> – mdoc macro compiler |
<B>mdocml</B> – mdoc macro compiler |
</P> |
</P> |
|
|
<H1> |
<H1> |
<A NAME="description">DESCRIPTION</A> |
<A NAME="description">Description</A> |
</H1> |
</H1> |
|
|
<P> |
<P> |
<SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <I><A HREF="mdoc.7.html">mdoc</A></I>, the roff macro |
<SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <I><A HREF="mdoc.7.html">mdoc</A></I>, the roff macro |
package of choice for BSD manual pages, and <I><A HREF="man.7.html">man</A></I>, the predominant historical package for |
package of choice for BSD manual pages, and <I><A HREF="man.7.html">man</A></I>, the predominant historical package for |
|
|
HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU troff implementation, for displaying <I>mdoc</I> |
HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU troff implementation, for displaying <I>mdoc</I> |
pages whilst providing token support for <I>man</I>. |
pages whilst providing token support for <I>man</I>. |
</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 |
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, <A |
uncertain output, and varies in operation from system to system. mdocml strives to fix this (respectively small, C, <A |
CLASS="external" HREF="http://www.isc.org/software/license">ISC</A>-licensed, fast and regular). |
CLASS="external" HREF="http://www.isc.org/software/license">ISC</A>-licensed, fast and regular). |
</P> |
</P> |
|
|
<P> |
<P> |
<SPAN CLASS="nm">mdocml</SPAN> consists of the <A HREF="mandoc.3.html">libmandoc</A> validating compiler and <A |
<SPAN CLASS="nm">mdocml</SPAN> consists of the <A HREF="mandoc.3.html">libmandoc</A> validating compiler and <A |
HREF="mandoc.1.html">mandoc</A>, which interfaces with the compiler library to format output for UNIX terminals, XHTML, |
HREF="mandoc.1.html">mandoc</A>, which interfaces with the compiler library to format output for UNIX terminals (with |
HTML, PostScript, and PDF. It is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project. |
support for wide-character locales), XHTML, HTML, PostScript, and PDF. |
|
It also includes <A HREF="preconv.1.html">preconv</A>, for recoding multibyte manuals; and <A |
|
HREF="makewhatis.1.html">makewhatis</A>, for indexing manuals. |
|
It is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project. |
</P> |
</P> |
|
|
<P> |
<P> |
<I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, <Q>mandoc</Q>. |
<I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, <Q>mandoc</Q>. |
</P> |
</P> |
|
|
<H1> |
<H1> |
<A NAME="sources">SOURCES</A> |
<A NAME="sources">Sources</A> |
</H1> |
</H1> |
|
|
<P> |
<P> |
<SPAN CLASS="nm">mdocml</SPAN> is in plain-old ANSI C and should build and run on any UNIX system. The most current |
<SPAN CLASS="nm">mdocml</SPAN> is in plain-old ANSI C and should build and run on any UNIX system, although <A |
version is <SPAN CLASS="attn">@VERSION@</SPAN>, dated <SPAN class="attn">@VDATE@</SPAN>. |
HREF="makewhatis.1.html">makewhatis</A> requires <A CLASS="external" |
|
HREF="http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html">Berkeley Database</A> (this is |
|
installed by default on all BSD operating systems). |
|
To compile <SPAN CLASS="nm">mdocml</SPAN>, run <CODE>make</CODE>, then <CODE>make install</CODE> to install into |
|
<I>/usr/local</I>. |
|
Be aware: if you have an existing <A HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A> installation, |
|
this may overwrite its <B>preconv</B> binary. |
|
The <A HREF="makewhatis.1.html">makewhatis</A> utility is not yet linked to the build. You must run <CODE>make |
|
makewhatis</CODE> to build it (it does not install). |
</P> |
</P> |
|
<P> |
|
The most current version of <SPAN CLASS="nm">mdocml</SPAN> is <SPAN CLASS="attn">@VERSION@</SPAN>, dated <SPAN |
|
class="attn">@VDATE@</SPAN>. |
|
</P> |
<H2> |
<H2> |
Current |
Current |
</H2> |
</H2> |
|
|
<TABLE WIDTH="100%" SUMMARY="Current Sources"> |
<TABLE WIDTH="100%" SUMMARY="Current Sources"> |
<COL WIDTH="175"> |
<COL WIDTH="175"> |
<COL> |
<COL> |
|
|
<TD>Source archive</TD> |
<TD>Source archive</TD> |
<TD> |
<TD> |
<A HREF="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</A> |
<A HREF="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</A> |
(<A HREF="/snapshots/mdocml.md5">md5</A>) |
<SMALL>(<A HREF="/snapshots/mdocml.md5">md5</A>)</SMALL> |
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
|
|
</TR> |
</TR> |
</TBODY> |
</TBODY> |
</TABLE> |
</TABLE> |
|
|
<H2> |
<H2> |
Downstream |
Downstream |
</H2> |
</H2> |
|
|
<TABLE WIDTH="100%" SUMMARY="Downstream Sources"> |
<TABLE WIDTH="100%" SUMMARY="Downstream Sources"> |
<COL WIDTH="175"> |
<COL WIDTH="175"> |
<COL> |
<COL> |
|
|
</TR> |
</TR> |
</TBODY> |
</TBODY> |
</TABLE> |
</TABLE> |
|
|
<H2> |
<H2> |
Historical |
Historical |
</H2> |
</H2> |
|
|
<TABLE WIDTH="100%" SUMMARY="Archived Sources"> |
<TABLE WIDTH="100%" SUMMARY="Archived Sources"> |
<COL WIDTH="175"> |
<COL WIDTH="175"> |
<COL> |
<COL> |
|
|
</TR> |
</TR> |
</TBODY> |
</TBODY> |
</TABLE> |
</TABLE> |
|
|
<H1> |
<H1> |
<A NAME="documentation">DOCUMENTATION</A> |
<A NAME="documentation">Documentation</A> |
</H1> |
</H1> |
|
|
<P> |
<P> |
These manuals are generated automatically and refer to the current snapshot. |
These manuals are generated automatically and refer to the current snapshot. |
</P> |
</P> |
|
|
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
|
<TD VALIGN="top"><A HREF="makewhatis.1.html">makewhatis(1)</A></TD> |
|
<TD VALIGN="top"> |
|
index UNIX manuals |
|
<SMALL> |
|
(<A HREF="makewhatis.1.txt">text</A> | |
|
<A HREF="makewhatis.1.xhtml">xhtml</A> | |
|
<A HREF="makewhatis.1.pdf">pdf</A> | |
|
<A HREF="makewhatis.1.ps">postscript</A>) |
|
</SMALL> |
|
</TD> |
|
</TR> |
|
<TR> |
|
<TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD> |
|
<TD VALIGN="top"> |
|
recode multibyte UNIX manuals |
|
<SMALL> |
|
(<A HREF="preconv.1.txt">text</A> | |
|
<A HREF="preconv.1.xhtml">xhtml</A> | |
|
<A HREF="preconv.1.pdf">pdf</A> | |
|
<A HREF="preconv.1.ps">postscript</A>) |
|
</SMALL> |
|
</TD> |
|
</TR> |
|
<TR> |
<TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD> |
<TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD> |
<TD VALIGN="top"> |
<TD VALIGN="top"> |
mandoc macro compiler library |
mandoc macro compiler library |
|
|
</TR> |
</TR> |
</TBODY> |
</TBODY> |
</TABLE> |
</TABLE> |
|
|
<H1> |
<H1> |
<A NAME="contact">CONTACT</A> |
<A NAME="contact">Contact</A> |
</H1> |
</H1> |
|
|
<P> |
<P> |
Use the mailing lists for bug-reports, patches, questions, etc. (these require subscription). Please check the |
Use the mailing lists for bug-reports, patches, questions, etc. (these require subscription). Please check the |
<A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues |
<A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues |
|
|
HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal |
HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal |
this e-mail address">kris...</A>@bsd.lv. |
this e-mail address">kris...</A>@bsd.lv. |
</P> |
</P> |
|
|
<TABLE WIDTH="100%" SUMMARY="Mailing Lists"> |
<TABLE WIDTH="100%" SUMMARY="Mailing Lists"> |
<COL WIDTH="175"> |
<COL WIDTH="175"> |
<COL> |
<COL> |
|
|
</TR> |
</TR> |
</TBODY> |
</TBODY> |
</TABLE> |
</TABLE> |
|
|
<H1> |
<H1> |
<A NAME="news">NEWS</A> |
<A NAME="news">News</A> |
</H1> |
</H1> |
|
|
<P CLASS="news"> |
<P CLASS="news"> |
04-04-2011: version 1.11.1 |
xx-06-2011: version 1.11.4 |
</P> |
</P> |
<P> |
<P> |
The earlier <I>libroff</I>, <I>libmdoc</I>, and <I>libman</I> soup have been merged into |
Bug-fixes and clean-ups across all systems, especially in <A HREF="makewhatis.1.html">makewhatis</A> (note: still not |
a single library, <A HREF="mandoc.3.html">libmandoc</A>, which manages all aspects of |
connected to the general build and must be compiled with <CODE>make makewhatis</CODE>). |
parsing real manuals (from line-handling to <A HREF="tbl.7.html">tbl</A> parsing). |
|
</P> |
</P> |
<P> |
<P> |
Beyond this structural change, initial <A HREF="eqn.7.html">eqn</A> functionality is in |
The output for <A HREF="makewhatis.1.html">makewhatis</A> is used by several tools in the <A CLASS="external" |
place. For the time being, this is limited to the recognition of equation blocks; |
HREF="http://mdocml.bsd.lv/mandoc-tools">mandoc-tools</A> package. In time these may be merged into <SPAN |
future version of <SPAN CLASS="nm">mdocml</SPAN> will expand upon this framework. |
CLASS="nm">mdocml</SPAN>, but for the time being their development is separate. |
</P> |
</P> |
<P> |
|
As usual, many general fixes and improvements have also occured. In particular, a great |
|
deal of redundancy and superfluous code has been removed with the merging of the backend |
|
libraries. |
|
</P> |
|
|
|
<P CLASS="news"> |
<P CLASS="news"> |
07-01-2011: version 1.10.9 |
26-05-2011: version 1.11.3 |
</P> |
</P> |
<P> |
<P> |
Many back-end fixes have been implemented: argument handling (quoting), <A |
Introduce locale-encoding of output with the <B>-Tlocale</B> output option and Unicode escaped-character input. |
HREF="man.7.html">man</A> improvements, error/warning classes, and many more. |
See <A HREF="mandoc.1.html">mandoc</A> and <A HREF="mandoc_char.7.html">mandoc_char</A>, respectively, for details. |
|
This allows for non-ASCII characters (e.g., <I>\[u5000]</I>) to be rendered in the locale's encoding, if said |
|
environment supports wide-character encoding (if it does not, <B>-Tascii</B> is used instead). |
|
Locale support can be turned off at compile time by removing <I>-DUSE_WCHAR</I> in the <I>Makefile</I>, in which case |
|
<B>-Tlocale</B> is always a synonym for <B>-Tascii</B>. |
</P> |
</P> |
<P> |
<P> |
Initial <A HREF="tbl.7.html">tbl</A> functionality (see the <Q>TS</Q>, <Q>TE</Q>, and |
Furthermore, multibyte-encoded documents, such as those in UTF-8, may be on-the-fly recoded into <A |
<Q>T&</Q> macros in the <A HREF="roff.7.html#x5c265453">roff</A> manual) has been |
HREF="mandoc.1.html">mandoc</A> input by using the newly-added <A HREF="preconv.1.html">preconv</A> utility. |
merged from <A CLASS="external" HREF="http://tbl.bsd.lv">tbl.bsd.lv</A>. Output is |
Note: in the future, this feature may be integrated into <A HREF="mandoc.1.html">mandoc</A>. |
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> |
</P> |
|
|
<P CLASS="news"> |
<P CLASS="news"> |
24-12-2010: version 1.10.8 |
12-05-2011: version 1.11.2 |
</P> |
</P> |
<P> |
<P> |
Significant improvements merged from <A CLASS="external" |
Corrected some installation issues in version 1.11.1. |
HREF="http://www.openbsd.org">OpenBSD</A> downstream, including |
Further migration to <A HREF="mandoc.3.html">libmandoc</A>. |
|
Initial public release (this utility is very much under development) of <A HREF="makewhatis.1.html">makewhatis</A>, |
|
initially named mandoc-db. |
|
This utility produces keyword databases of manual content |
|
<STRIKE>mandoc-cgi</STRIKE>, |
|
<A HREF="http://mdocml.bsd.lv/mandoc-tools/index.html">mandoc-tools</A>, |
|
which features semantic querying of manual content. |
</P> |
</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> |
<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> |
|
|
|
<P> |
|
See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for |
See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for |
historical notes. |
historical notes. |
</P> |
</P> |
|
|
<P CLASS="foot"> |
<P CLASS="foot"> |
Copyright © 2008–2011 |
<SMALL> |
<A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>, |
Copyright © 2008–2011 |
$Date$ |
<A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>, |
|
$Date$ |
|
</SMALL> |
</P> |
</P> |
</BODY> |
</BODY> |
</HTML> |
</HTML> |