</HEAD>
<BODY>
<P CLASS="head">
- <B>mdocml</B> – mdoc macro compiler
+ <B>mdocml</B> – mdoc macro compiler, current version @VERSION@ (@VDATE@)
+ </P>
+ <P CLASS="subhead">
+ Sources: <A HREF="/snapshots/mdocml.tar.gz">current</A>,
+ <A HREF="/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A>
+ (<A HREF="/snapshots/">archives</A>)
+ |
+ Binaries: <A
+ HREF="/binaries/mdocml-win32.zip">windows 32-bit</A>, <A
+ HREF="/binaries/mdocml-win64.zip">windows 64-bit</A>, <A
+ HREF="/binaries/mdocml-macosx.zip">mac os x</A>
+ (<A HREF="/binaries/">archives</A>)
</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
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;
+ <A HREF="demandoc.1.html">demandoc</A>, for emitting only text parts of 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>
<I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, <Q>mandoc</Q>.
</P>
-
- <H1>
+ <H2>
<A NAME="sources">Sources</A>
- </H1>
-
+ </H2>
<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
- makewhatis</CODE> to build it (it does not install).
+ <SPAN CLASS="nm">mdocml</SPAN> is in plain-old ANSI C and should build and run on any modern system.
+ To build and install into <I>/usr/local/</I>, just run <CODE>make install</CODE>.
+ Be aware: if you have an existing groff 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; please <A HREF="#contact">contact
+ us</A> if you plan to use it.
</P>
-
<H2>
- Current
+ <A NAME="binaries">Binaries</A>
</H2>
-
- <TABLE WIDTH="100%" SUMMARY="Current Sources">
- <COL WIDTH="175">
- <COL>
- <TBODY>
- <TR>
- <TD>Source archive</TD>
- <TD>
- <A HREF="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</A>
- (<A HREF="/snapshots/mdocml.md5">md5</A>)
- </TD>
- </TR>
- <TR>
- <TD>Online source</TD>
- <TD>
- <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A>
- </TD>
- </TR>
- </TBODY>
- </TABLE>
-
+ <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>
<H2>
Downstream
</H2>
-
+ <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">
<COL WIDTH="175">
<COL>
</TR>
</TBODY>
</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>
<A NAME="documentation">Documentation</A>
</H1>
-
<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>
<TABLE WIDTH="100%" SUMMARY="Documentation">
<TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD>
<TD VALIGN="top">
format and display UNIX manuals
- <SMALL>
(<A HREF="mandoc.1.txt">text</A> |
<A HREF="mandoc.1.xhtml">xhtml</A> |
<A HREF="mandoc.1.pdf">pdf</A> |
- <A HREF="mandoc.1.ps">postscript</A>)
- </SMALL>
+ <A HREF="mandoc.1.ps">ps</A>)
</TD>
</TR>
<TR>
- <TD VALIGN="top"><A HREF="makewhatis.1.html">makewhatis(1)</A></TD>
+ <TD VALIGN="top"><A HREF="demandoc.1.html">demandoc(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>
+ emit only text of UNIX manuals
+ (<A HREF="demandoc.1.txt">text</A> |
+ <A HREF="demandoc.1.xhtml">xhtml</A> |
+ <A HREF="demandoc.1.pdf">pdf</A> |
+ <A HREF="demandoc.1.ps">ps</A>)
</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>
+ <A HREF="preconv.1.ps">ps</A>)
</TD>
</TR>
<TR>
<TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD>
<TD VALIGN="top">
mandoc macro compiler library
- <SMALL>
(<A HREF="mandoc.3.txt">text</A> |
<A HREF="mandoc.3.xhtml">xhtml</A> |
<A HREF="mandoc.3.pdf">pdf</A> |
- <A HREF="mandoc.3.ps">postscript</A>)
- </SMALL>
+ <A HREF="mandoc.3.ps">ps</A>)
</TD>
</TR>
<TR>
<TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD>
<TD VALIGN="top">
man language reference
- <SMALL>
(<A HREF="man.7.txt">text</A> |
<A HREF="man.7.xhtml">xhtml</A> |
<A HREF="man.7.pdf">pdf</A> |
- <A HREF="man.7.ps">postscript</A>)
- </SMALL>
+ <A HREF="man.7.ps">ps</A>)
</TD>
</TR>
<TR>
<TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD>
<TD VALIGN="top">
eqn-mandoc language reference
- <SMALL>
(<A HREF="eqn.7.txt">text</A> |
<A HREF="eqn.7.xhtml">xhtml</A> |
<A HREF="eqn.7.pdf">pdf</A> |
- <A HREF="eqn.7.ps">postscript</A>)
- </SMALL>
+ <A HREF="eqn.7.ps">ps</A>)
</TD>
</TR>
<TR>
<TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD>
<TD VALIGN="top">
mandoc special characters
- <SMALL>
(<A HREF="mandoc_char.7.txt">text</A> |
<A HREF="mandoc_char.7.xhtml">xhtml</A> |
<A HREF="mandoc_char.7.pdf">pdf</A> |
- <A HREF="mandoc_char.7.ps">postscript</A>)
- </SMALL>
+ <A HREF="mandoc_char.7.ps">ps</A>)
</TD>
</TR>
<TR>
<TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD>
<TD VALIGN="top">
mdoc language reference
- <SMALL>
(<A HREF="mdoc.7.txt">text</A> |
<A HREF="mdoc.7.xhtml">xhtml</A> |
<A HREF="mdoc.7.pdf">pdf</A> |
- <A HREF="mdoc.7.ps">postscript</A>)
- </SMALL>
+ <A HREF="mdoc.7.ps">ps</A>)
</TD>
</TR>
<TR>
<TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD>
<TD VALIGN="top">
roff-mandoc language reference
- <SMALL>
(<A HREF="roff.7.txt">text</A> |
<A HREF="roff.7.xhtml">xhtml</A> |
<A HREF="roff.7.pdf">pdf</A> |
- <A HREF="roff.7.ps">postscript</A>)
- </SMALL>
+ <A HREF="roff.7.ps">ps</A>)
</TD>
</TR>
<TR>
<TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD>
<TD VALIGN="top">
tbl-mandoc language reference
- <SMALL>
(<A HREF="tbl.7.txt">text</A> |
<A HREF="tbl.7.xhtml">xhtml</A> |
<A HREF="tbl.7.pdf">pdf</A> |
- <A HREF="tbl.7.ps">postscript</A>)
- </SMALL>
+ <A HREF="tbl.7.ps">ps</A>)
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD>
+ <TD VALIGN="top">
+ index UNIX manuals
+ (<A HREF="mandocdb.8.txt">text</A> |
+ <A HREF="mandocdb.8.xhtml">xhtml</A> |
+ <A HREF="mandocdb.8.pdf">pdf</A> |
+ <A HREF="mandocdb.8.ps">ps</A>)
</TD>
</TR>
</TBODY>
</TABLE>
-
<H1>
<A NAME="contact">Contact</A>
</H1>
-
<P>
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
HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal
this e-mail address">kris...</A>@bsd.lv.
</P>
-
<TABLE WIDTH="100%" SUMMARY="Mailing Lists">
<COL WIDTH="175">
<COL>
</TD>
<TD>
bug-reports, general questions, and announcements
- <SMALL>(<A HREF="/archives/discuss/summary.html">archive</A>)</SMALL>
+ (<A HREF="/archives/discuss/summary.html">archive</A>)
</TD>
</TR>
<TR>
</TD>
<TD>
patches and system discussions
- <SMALL>(<A HREF="/archives/tech/summary.html">archive</A>)</SMALL>
+ (<A HREF="/archives/tech/summary.html">archive</A>)
</TD>
</TR>
<TR>
</TD>
<TD>
source commit messages
- <SMALL>(<A HREF="/archives/source/summary.html">archive</A>)</SMALL>
+ (<A HREF="/archives/source/summary.html">archive</A>)
</TD>
</TR>
</TBODY>
</TABLE>
-
<H1>
<A NAME="news">News</A>
</H1>
-
<P CLASS="news">
- 19-05-2011: version 1.11.3
+ xx-xx-2011: version 1.11.x
</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>.
+ Added <A HREF="demandoc.1.html">demandoc</A> utility for stripping away macros and escapes. This replaces the
+ historical <CODE>deroff</CODE> utility.
</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.
- </P>
-
<P CLASS="news">
- 12-05-2011: version 1.11.2
+ 16-08-2011: version 1.11.6
</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 <A HREF="makewhatis.1.html">makewhatis</A>,
- 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.
+ 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">
- 04-04-2011: version 1.11.1
+ 24-07-2011: version 1.11.5
</P>
<P>
- The earlier <I>libroff</I>, <I>libmdoc</I>, and <I>libman</I> soup have been merged into
- a single library, <A HREF="mandoc.3.html">libmandoc</A>, which manages all aspects of
- parsing real manuals (from line-handling to <A HREF="tbl.7.html">tbl</A> parsing).
+ 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>
+ 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
+ Edition User's Guide</A>.
</P>
<P>
- Beyond this structural change, initial <A HREF="eqn.7.html">eqn</A> functionality is in
- place. For the time being, this is limited to the recognition of equation blocks;
- future version of <SPAN CLASS="nm">mdocml</SPAN> will expand upon this framework.
+ 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>
- As usual, many general fixes and improvements have also occurred. In particular, a great
- deal of redundancy and superfluous code has been removed with the merging of the backend
- libraries.
- </P>
-
<P>
See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for
historical notes.
</P>
-
<P CLASS="foot">
<SMALL>
Copyright © 2008–2011
<A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>,
- $Date: 2011/05/26 12:14:46 $
+ $Date: 2011/09/01 10:46:28 $
</SMALL>
</P>
</BODY>
git.ckatri.com / mandoc.git / blobdiff