| version 1.119, 2011/05/19 16:02:01 |
version 1.121, 2011/05/26 20:23:01 |
|
|
| <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, 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="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 |
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, |
| |
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). |
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 |
|
|
| <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> |
|
|
| </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 |
|
|
| environment supports wide-character encoding (if it does not, <B>-Tascii</B> is used instead). |
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 |
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>. |
<B>-Tlocale</B> is always a synonym for <B>-Tascii</B>. |
| |
</P> |
| |
<P> |
| |
Furthermore, multibyte-encoded documents, such as those in UTF-8, may be on-the-fly recoded as <A |
| |
HREF="mandoc.1.html">mandoc</A> input by using the newly-added <A HREF="preconv.1.html">preconv</A> utility. |
| |
Note: in the future, this feature may be integrated into <A HREF="mandoc.1.html">mandoc</A>. |
| </P> |
</P> |
| |
|
| <P CLASS="news"> |
<P CLASS="news"> |
![[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