diff options
| -rw-r--r-- | index.sgml | 31 |
1 files changed, 17 insertions, 14 deletions
@@ -9,11 +9,9 @@ <P CLASS="head"> <B>mdocml</B> – mdoc macro compiler </P> - <H1> <A NAME="description">Description</A> </H1> - <P> <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 @@ -21,37 +19,41 @@ 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>. </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, <A CLASS="external" HREF="http://www.isc.org/software/license">ISC</A>-licensed, fast and regular). </P> - <P> <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, - HTML, PostScript, and PDF. It is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project. + HREF="mandoc.1.html">mandoc</A>, which interfaces with the compiler library to format output for UNIX terminals (with + 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> <I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, <Q>mandoc</Q>. </P> - <H1> <A NAME="sources">Sources</A> </H1> - <P> <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="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>, - dated <SPAN class="attn">@VDATE@</SPAN>. If your system doesn't come with <SPAN CLASS="nm">mdocml</SPAN> (see - <Q>Downstream</Q>), run <CODE>make</CODE> to compile and <CODE>make install</CODE> to install into <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 + 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> + 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 @@ -65,7 +67,7 @@ <TD>Source archive</TD> <TD> <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> </TR> <TR> @@ -335,6 +337,7 @@ <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 CLASS="news"> |