| version 1.118, 2011/05/14 23:41:50 |
version 1.129, 2011/07/23 09:47:25 |
|
|
| <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="mandocdb.8.html">mandocdb</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, although <A |
<SPAN CLASS="nm">mdocml</SPAN> is in plain-old ANSI C and should build and run on any UNIX system, although <A |
| HREF="makewhatis.1.html">makewhatis</A> requires <A CLASS="external" |
HREF="mandocdb.8.html">mandocdb</A> requires <A CLASS="external" |
| HREF="http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html">Berkeley Database</A> (this is |
HREF="http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html">Berkeley Database</A> (this is |
| installed by default on all BSD operating systems). The most current version is <SPAN CLASS="attn">@VERSION@</SPAN>, |
installed by default on all BSD operating systems). |
| dated <SPAN class="attn">@VDATE@</SPAN>. If your system doesn't come with <SPAN CLASS="nm">mdocml</SPAN> (see |
To compile <SPAN CLASS="nm">mdocml</SPAN>, run <CODE>make</CODE>, then <CODE>make install</CODE> to install into |
| <Q>Downstream</Q>), run <CODE>make</CODE> to compile and <CODE>make install</CODE> to install into <I>/usr/local</I>. |
<I>/usr/local</I>. |
| Note that <A HREF="makewhatis.1.html">makewhatis</A> is not yet linked to the build. You must run <CODE>make |
Be aware: if you have an existing <A HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A> installation, |
| makewhatis</CODE> to build it (it does not install). |
this may overwrite its <B>preconv</B> binary. |
| |
The <A HREF="mandocdb.8.html">mandocdb</A> utility is not yet linked to the build. You must run <CODE>make |
| |
mandocdb</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"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD> |
| <TD VALIGN="top"> |
<TD VALIGN="top"> |
| index UNIX manuals |
index UNIX manuals |
| <SMALL> |
<SMALL> |
| (<A HREF="makewhatis.1.txt">text</A> | |
(<A HREF="mandocdb.8.txt">text</A> | |
| <A HREF="makewhatis.1.xhtml">xhtml</A> | |
<A HREF="mandocdb.8.xhtml">xhtml</A> | |
| <A HREF="makewhatis.1.pdf">pdf</A> | |
<A HREF="mandocdb.8.pdf">pdf</A> | |
| <A HREF="makewhatis.1.ps">postscript</A>) |
<A HREF="mandocdb.8.ps">postscript</A>) |
| </SMALL> |
</SMALL> |
| </TD> |
</TD> |
| </TR> |
</TR> |
| <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"> |
| 12-05-2011: version 1.11.2 |
xx-07-2011: version 1.11.5 |
| </P> |
</P> |
| <P> |
<P> |
| Corrected some installation issues in version 1.11.1. |
Significant <A HREF="eqn.7.html">eqn</A> improvements. <SPAN CLASS="nm">mdocml</SPAN> can now parse arbitrary equations |
| Further migration to <A HREF="mandoc.3.html">libmandoc</A>. |
(although few GNU troff extensions are accepted, nor is mixing low-level roff with eqn). See the <A |
| Initial public release (this utility is very much under development) of <A HREF="makewhatis.1.html">makewhatis</A>, |
HREF="eqn.7.html">eqn</A> manual for details. For the time being, equations are rendered as simple in-line text. |
| initially named mandoc-db. |
|
| This utility produces keyword databases of manual content |
|
| <A HREF="http://mdocml.bsd.lv/mandoc-cgi/index.html">mandoc-cgi</A>, which features semantic querying of manual content. |
|
| </P> |
</P> |
| |
|
| <P CLASS="news"> |
<P CLASS="news"> |
| 04-04-2011: version 1.11.1 |
12-07-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 <INS><A HREF="mandocdb.8.html">mandocdb</A></INS> <DEL>makewhatis</DEL> (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 <INS><CODE>make mandocdb</CODE></INS> <DEL><CODE>make makewhatis</CODE></DEL>) and the <A |
| parsing real manuals (from line-handling to <A HREF="tbl.7.html">tbl</A> parsing). |
HREF="man.7.html">man</A> parser. This release was significantly assisted by participants in <A CLASS="external" |
| |
HREF="http://www.openbsd.org">OpenBSD</A>'s c2k11. Thanks! |
| </P> |
</P> |
| |
<P CLASS="news"> |
| |
26-05-2011: version 1.11.3 |
| |
</P> |
| <P> |
<P> |
| Beyond this structural change, initial <A HREF="eqn.7.html">eqn</A> functionality is in |
Introduce locale-encoding of output with the <B>-Tlocale</B> output option and Unicode escaped-character input. |
| place. For the time being, this is limited to the recognition of equation blocks; |
See <A HREF="mandoc.1.html">mandoc</A> and <A HREF="mandoc_char.7.html">mandoc_char</A>, respectively, for details. |
| future version of <SPAN CLASS="nm">mdocml</SPAN> will expand upon this framework. |
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> |
| As usual, many general fixes and improvements have also occurred. In particular, a great |
Furthermore, multibyte-encoded documents, such as those in UTF-8, may be on-the-fly recoded into <A |
| deal of redundancy and superfluous code has been removed with the merging of the backend |
HREF="mandoc.1.html">mandoc</A> input by using the newly-added <A HREF="preconv.1.html">preconv</A> utility. |
| libraries. |
Note: in the future, this feature may be integrated into <A HREF="mandoc.1.html">mandoc</A>. |
| </P> |
</P> |
| |
<P CLASS="news"> |
| |
12-05-2011: version 1.11.2 |
| |
</P> |
| <P> |
<P> |
| |
Corrected some installation issues in version 1.11.1. |
| |
Further migration to <A HREF="mandoc.3.html">libmandoc</A>. |
| |
Initial public release (this utility is very much under development) of <INS><A HREF="mandocdb.8.html">mandocdb</A></INS><DEL>makewhatis</DEL>, |
| |
initially named mandoc-db. |
| |
This utility produces keyword databases of manual content |
| |
<DEL>mandoc-cgi</DEL>, |
| |
<A HREF="http://mdocml.bsd.lv/mandoc-tools/index.html">mandoc-tools</A>, |
| |
which features semantic querying of manual content. |
| |
</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"> |
| <SMALL> |
<SMALL> |
| Copyright © 2008–2011 |
Copyright © 2008–2011 |
![[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