<HEAD>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8">
<LINK REL="stylesheet" HREF="index.css" TYPE="text/css" MEDIA="all">
- <TITLE>mdocml | mdoc macro compiler</TITLE>
+ <TITLE>mdocml | UNIX manpage compiler</TITLE>
</HEAD>
<BODY>
<P CLASS="head">
- <B>mdocml</B> – mdoc macro compiler
+ <B>mdocml</B> – UNIX manpage 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>)
</P>
-
<H1>
- <A NAME="description">DESCRIPTION</A>
+ <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,
+ <A HREF="mandocdb.8.html">mandocdb</A> for indexing manuals,
+ <A HREF="apropos.1.html">apropos</A> (includes whatis mode) for indexed manual search, and
+ <A HREF="man.cgi.7.html">man.cgi</A> for indexed manual search online.
+ 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. The most current
- version is <SPAN CLASS="attn">@VERSION@</SPAN>, dated <SPAN class="attn">@VDATE@</SPAN>.
- </P>
-
<H2>
- Current
+ <A NAME="sources">Sources</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>
+ <SPAN CLASS="nm">mdocml</SPAN> is in ISO C99 and should build and run on any modern system; however, you'll need <A
+ HREF="http://www.sqlite.org">sqlite3</A> to build <A HREF="apropos.1.html">apropos</A> (links to whatis),
+ <A HREF="man.cgi.7.html">man.cgi</A>, and <A HREF="mandocdb.8.html">mandocdb</A>.
+ To build and install into <I>/usr/local/</I>, just run <CODE>make install</CODE>.
+ Be careful: the <B>preconv</B>, <B>apropos</B>, and <B>whatis</B> binary names are usually taken by existing utilities.
+ </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>
<TD>DragonFly BSD</TD>
<TD>
- <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc"
- CLASS="external">usr.bin/mandoc</A>
+ <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc" CLASS="external">usr.bin/mandoc</A>
</TD>
</TR>
<TR>
<TD>FreeBSD</TD>
<TD>
- <A HREF="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/"
- CLASS="external">ports/textproc/mdocml</A>
+ <A HREF="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/" CLASS="external">ports/textproc/mdocml</A>
</TD>
</TR>
<TR>
<TD>NetBSD</TD>
<TD>
- <A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/"
- CLASS="external">src/external/bsd/mdocml</A>
+ <A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/" CLASS="external">src/external/bsd/mdocml</A>
</TD>
</TR>
<TR>
<TD>OpenBSD</TD>
<TD>
- <A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/"
- CLASS="external">src/usr.bin/mandoc</A>
+ <A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/" CLASS="external">src/usr.bin/mandoc</A>
+ </TD>
+ </TR>
+ <TR>
+ <TD>pkgsrc</TD>
+ <TD>
+ <A HREF="http://pkgsrc.se/textproc/mdocml" CLASS="external">textproc/mdocml</A>
</TD>
</TR>
- </TBODY>
- </TABLE>
-
- <H2>
- Historical
- </H2>
-
- <TABLE WIDTH="100%" SUMMARY="Archived Sources">
- <COL WIDTH="175">
- <COL>
- <TBODY>
<TR>
- <TD>Source archive</TD>
+ <TD>Minix3</TD>
<TD>
- <A HREF="/snapshots/">/snapshots/</A>
+ <A HREF="http://git.minix3.org/?p=minix.git;a=tree;f=external/bsd/mdocml" CLASS="external">external/bsd/mdocml</A>
</TD>
</TR>
</TBODY>
</TABLE>
-
<H1>
- <A NAME="documentation">DOCUMENTATION</A>
+ <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">
<COL WIDTH="175">
<COL>
<TBODY>
+ <TR>
+ <TD VALIGN="top"><A HREF="apropos.1.html">apropos(1)</A></TD>
+ <TD VALIGN="top">
+ search the manual page database
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="demandoc.1.html">demandoc(1)</A></TD>
+ <TD VALIGN="top">
+ emit only text of UNIX manuals
+ </TD>
+ </TR>
<TR>
<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>
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD>
+ <TD VALIGN="top">
+ recode multibyte UNIX manuals
</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>
</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>
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="man.cgi.7.html">man.cgi(7)</A></TD>
+ <TD VALIGN="top">
+ cgi for manpage query and display
</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>
</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>
</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>
</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>
</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>
+ </TD>
+ </TR>
+ <TR>
+ <TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD>
+ <TD VALIGN="top">
+ index UNIX manuals
</TD>
</TR>
</TBODY>
</TABLE>
-
<H1>
- <A NAME="contact">CONTACT</A>
+ <A NAME="contact">Contact</A>
</H1>
-
<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. Please check the
<A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues
- before posting. Beyond that, contact Kristaps at <A
- HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal
- this e-mail address">kris...</A>@bsd.lv.
+ before posting. All lists are subscription-only: send a blank e-mail to the listed address to subscribe. Beyond that,
+ contact Kristaps at <A HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal
+ this e-mail address">kris...</A>@bsd.lv. Archives are available at <A HREF="http://gmane.org/" CLASS="external">Gmane</A>.
</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>
</TD>
</TR>
<TR>
</TD>
<TD>
patches and system discussions
- <SMALL>(<A HREF="/archives/tech/summary.html">archive</A>)</SMALL>
</TD>
</TR>
<TR>
</TD>
<TD>
source commit messages
- <SMALL>(<A HREF="/archives/source/summary.html">archive</A>)</SMALL>
</TD>
</TR>
</TBODY>
</TABLE>
-
<H1>
- <A NAME="news">NEWS</A>
+ <A NAME="news">News</A>
</H1>
-
- <P CLASS="news">
- 04-04-2011: version 1.11.1
- </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).
- </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.
- </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 CLASS="news">
- 07-01-2011: version 1.10.9
+ xx-xx-2012: version 1.12.4
</P>
<P>
- Many back-end fixes have been implemented: argument handling (quoting), <A
- HREF="man.7.html">man</A> improvements, error/warning classes, and many more.
+ <I>Ingo, can you summarise your changes here?</I>
</P>
<P>
- Initial <A HREF="tbl.7.html">tbl</A> functionality (see the <Q>TS</Q>, <Q>TE</Q>, and
- <Q>T&</Q> macros in the <A HREF="roff.7.html#x5c265453">roff</A> manual) has been
- merged from <A CLASS="external" HREF="http://tbl.bsd.lv">tbl.bsd.lv</A>. Output is
- still minimal, especially for <SPAN CLASS="flag">-Thtml</SPAN> and <SPAN
- CLASS="flag">-Txhtml</SPAN>, but manages to at least display data. This means that <A
- HREF="mandoc.1.html">mandoc</A> now has built-in support for two troff preprocessors via
- <DEL>libroff</DEL>: soelim and tbl.
- </P>
-
- <P CLASS="news">
- 24-12-2010: version 1.10.8
+ The <A HREF="mandocdb.8.html">mandocdb</A> tools (<A HREF="mandocdb.8.html">mandocdb</A>, <A
+ HREF="apropos.1.html">apropos</A> (absorbing whatis), and <A HREF="man.cgi.7.html">man.cgi</A>) have been re-written to
+ use <A CLASS="external" HREF="http://www.sqlite.org">sqlite3</A> as a database.
</P>
- <P>
- Significant improvements merged from <A CLASS="external"
- HREF="http://www.openbsd.org">OpenBSD</A> downstream, including
- </P>
- <UL>
- <LI>many new <A HREF="roff.7.html">roff</A> components,</LI>
- <LI>in-line implementation of troff's soelim,</LI>
- <LI>broken-block handling,</LI>
- <LI>overhauled error classifications, and</LI>
- <LI>cleaned up handling of error conditions.</LI>
- </UL>
- <P>
- Also overhauled the <SPAN CLASS="flag">-Thtml</SPAN> and <SPAN
- CLASS="flag">-Txhtml</SPAN> output modes. They now display readable output in arbitrary
- browsers, including text-based ones like <A CLASS="external"
- HREF="http://lynx.isc.org">lynx</A>. See HTML and XHTML manuals in the <A
- HREF="#documentation">DOCUMENTATION</A> section for examples. <SPAN
- CLASS="attn">Attention: available style-sheet classes have been considerably
- changed!</SPAN> See the <SPAN CLASS="file">example.style.css</SPAN> file for details.
- Lastly, <DEL>libmdoc</DEL> and <DEL>libman</DEL> have been
- cleaned up and reduced in size and complexity.
- </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">
- Copyright © 2008–2011
- <A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>,
- $Date: 2011/04/30 10:18:24 $
+ <SMALL>
+ Copyright © 2008–2011
+ <A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>,
+ $Date: 2012/06/09 14:19:55 $
+ </SMALL>
</P>
</BODY>
</HTML>
git.ckatri.com / mandoc.git / blobdiff