version 1.130, 2011/07/23 18:41:18 |
version 1.135, 2011/08/16 22:21:04 |
|
|
</HEAD> |
</HEAD> |
<BODY> |
<BODY> |
<P CLASS="head"> |
<P CLASS="head"> |
<B>mdocml</B> – mdoc macro compiler |
<B>mdocml</B> – mdoc macro compiler, |
|
current version <SPAN CLASS="attn">@VERSION@</SPAN> (<SPAN class="attn">@VDATE@</SPAN>) |
</P> |
</P> |
<H1> |
<H1> |
<A NAME="description">Description</A> |
<A NAME="description">Description</A> |
|
|
<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 modern system. |
HREF="mandocdb.8.html">mandocdb</A> requires <A CLASS="external" |
To build and install into <I>/usr/local/</I>, just run <CODE>make install</CODE>. |
HREF="http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html">Berkeley Database</A> (this is |
Be aware: if you have an existing groff installation, this may overwrite its <B>preconv</B> binary. |
installed by default on all BSD operating systems). |
The <A HREF="mandocdb.8.html">mandocdb</A> utility is not yet linked to the build; please <A HREF="#contact">contact |
To compile <SPAN CLASS="nm">mdocml</SPAN>, run <CODE>make</CODE>, then <CODE>make install</CODE> to install into |
us</A> if you plan to use it. |
<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="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> |
|
Current |
|
</H2> |
|
<TABLE WIDTH="100%" SUMMARY="Current Sources"> |
<TABLE WIDTH="100%" SUMMARY="Current Sources"> |
<COL WIDTH="175"> |
<COL WIDTH="200"> |
<COL> |
<COL> |
<TBODY> |
<TBODY> |
<TR> |
<TR> |
<TD>Source archive</TD> |
<TD>Current</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>Online source</TD> |
<TD>Archives</TD> |
<TD> |
<TD> |
|
<A HREF="/snapshots/">/snapshots/</A> |
|
</TD> |
|
</TR> |
|
<TR> |
|
<TD>Online Repository</TD> |
|
<TD> |
<A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A> |
<A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A> |
</TD> |
</TD> |
</TR> |
</TR> |
</TBODY> |
</TBODY> |
</TABLE> |
</TABLE> |
<H2> |
<H1> |
|
<A NAME="binaries">Binaries</A> |
|
</H1> |
|
<P> |
|
Binary archives consist of pre-compiled binaries, manuals, and other necessary files. |
|
Universal (Mac OS X) binaries are compiled for the PCC, i386, and x86_64 architectures. |
|
Windows binaries are compiled with <A CLASS="external" HREF="http://www.mingw.org">MingW</A> for the 32-bit (i686) and |
|
64-bit (x86_64) architectures. |
|
</P> |
|
<TABLE WIDTH="100%" SUMMARY="Current Binaries"> |
|
<COL WIDTH="200"> |
|
<COL> |
|
<TBODY> |
|
<TR> |
|
<TD>Windows 32-bit</TD> |
|
<TD> |
|
<A HREF="/binaries/mdocml-win32.zip">/binaries/mdocml-win32.zip</A> |
|
</TD> |
|
</TR> |
|
<TR> |
|
<TD>Windows 64-bit</TD> |
|
<TD> |
|
<A HREF="/binaries/mdocml-win64.zip">/binaries/mdocml-win64.zip</A> |
|
</TD> |
|
</TR> |
|
<TR> |
|
<TD>Mac OS X Universal Binary</TD> |
|
<TD> |
|
<A HREF="/binaries/mdocml-macosx.zip">/binaries/mdocml-macosx.zip</A> |
|
</TD> |
|
</TR> |
|
<TR> |
|
<TD>Archives</TD> |
|
<TD> |
|
<A HREF="/binaries/">/binaries/</A> |
|
</TD> |
|
</TR> |
|
</TBODY> |
|
</TABLE> |
|
<H1> |
Downstream |
Downstream |
</H2> |
</H1> |
|
<P> |
|
Several systems come bundled with <SPAN CLASS="nm">mdocml</SPAN> utilities. |
|
If your system does not appear below, the maintainers have not contacted me and it should not be considered |
|
<Q>official</Q>. |
|
Please <A HREF="#contact">contact us</A> if you plan on maintaining a downstream version! |
|
</P> |
<TABLE WIDTH="100%" SUMMARY="Downstream Sources"> |
<TABLE WIDTH="100%" SUMMARY="Downstream Sources"> |
<COL WIDTH="175"> |
<COL WIDTH="200"> |
<COL> |
<COL> |
<TBODY> |
<TBODY> |
<TR> |
<TR> |
|
|
</TR> |
</TR> |
</TBODY> |
</TBODY> |
</TABLE> |
</TABLE> |
<H2> |
|
Historical |
|
</H2> |
|
<TABLE WIDTH="100%" SUMMARY="Archived Sources"> |
|
<COL WIDTH="175"> |
|
<COL> |
|
<TBODY> |
|
<TR> |
|
<TD>Source archive</TD> |
|
<TD> |
|
<A HREF="/snapshots/">/snapshots/</A> |
|
</TD> |
|
</TR> |
|
</TBODY> |
|
</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 release. |
|
They are the authoritative documentation for the <SPAN CLASS="nm">mdocml</SPAN> system. |
</P> |
</P> |
|
|
<TABLE WIDTH="100%" SUMMARY="Documentation"> |
<TABLE WIDTH="100%" SUMMARY="Documentation"> |
<COL WIDTH="175"> |
<COL WIDTH="200"> |
<COL> |
<COL> |
<TBODY> |
<TBODY> |
<TR> |
<TR> |
|
|
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="200"> |
<COL> |
<COL> |
<TBODY> |
<TBODY> |
<TR> |
<TR> |
|
|
<A NAME="news">News</A> |
<A NAME="news">News</A> |
</H1> |
</H1> |
<P CLASS="news"> |
<P CLASS="news"> |
xx-07-2011: version 1.11.5 |
16-08-2011: version 1.11.6 |
</P> |
</P> |
<P> |
<P> |
|
Handling of <B>tr</B> macro in <A HREF="roff.7.html">roff</A> implemented. This makes Perl documentation much more |
|
readable. Hyphenation is also now enabled in <A HREF="man.7.html">man</A> format documents. Many other general |
|
improvements have been implemented. Furthermore, a 64-bit Windows binary is now available at <A |
|
HREF="/binaries/mdocml-win64.zip">mdocml-win64.zip</A> and a Mac OS X universal binary is available at <A |
|
HREF="/binaries/mdocml-macosx.zip">mdocml-macosx.zip</A>. |
|
</P> |
|
<P CLASS="news"> |
|
24-07-2011: version 1.11.5 |
|
</P> |
|
<P> |
Significant <A HREF="eqn.7.html">eqn</A> improvements. <SPAN CLASS="nm">mdocml</SPAN> can now parse arbitrary eqn input |
Significant <A HREF="eqn.7.html">eqn</A> improvements. <SPAN CLASS="nm">mdocml</SPAN> can now parse arbitrary eqn input |
(although few GNU extensions are accepted, nor is mixing low-level roff with eqn). See the <A HREF="eqn.7.html">eqn</A> |
(although few GNU extensions are accepted, nor is mixing low-level roff with eqn). See the <A HREF="eqn.7.html">eqn</A> |
manual for details. For the time being, equations are rendered as simple in-line text. The equation parser satisfies |
manual for details. For the time being, equations are rendered as simple in-line text. The equation parser satisfies |
the language specified in the <A CLASS="external" HREF="http://www.kohala.com/start/troff/v7man/eqn/eqn2e.ps">Second |
the language specified in the <A CLASS="external" HREF="http://www.kohala.com/start/troff/v7man/eqn/eqn2e.ps">Second |
Edition eqn User's Guide</A>. |
Edition User's Guide</A>. |
</P> |
</P> |
|
<P> |
|
This is also the first release featuring a distributed Windows binary, available at <A |
|
HREF="/binaries/mdocml-win32.zip">/binaries/mdocml-win32.zip</A>. |
|
</P> |
<P CLASS="news"> |
<P CLASS="news"> |
12-07-2011: version 1.11.4 |
12-07-2011: version 1.11.4 |
</P> |
</P> |
|
|
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 |
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 |
HREF="man.7.html">man</A> parser. This release was significantly assisted by participants in <A CLASS="external" |
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! |
HREF="http://www.openbsd.org">OpenBSD</A>'s c2k11. Thanks! |
</P> |
|
<P CLASS="news"> |
|
26-05-2011: version 1.11.3 |
|
</P> |
|
<P> |
|
Introduce locale-encoding of output with the <B>-Tlocale</B> output option and Unicode escaped-character input. |
|
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> |
|
Furthermore, multibyte-encoded documents, such as those in UTF-8, may be on-the-fly recoded into <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 CLASS="news"> |
|
12-05-2011: version 1.11.2 |
|
</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> |
<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 |