version 1.17, 2009/06/11 13:34:14 |
version 1.158, 2012/06/09 14:19:55 |
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
<html> |
<HTML> |
<head> |
<HEAD> |
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8"> |
<meta name="resource-type" content="document"> |
<LINK REL="stylesheet" HREF="index.css" TYPE="text/css" MEDIA="all"> |
<link rel="stylesheet" href="style.css" type="text/css" media="all"> |
<TITLE>mdocml | UNIX manpage compiler</TITLE> |
<title>mdocml.bsd.lv</title> |
</HEAD> |
</head> |
<BODY> |
<body> |
<P CLASS="head"> |
<table width="600"> |
<B>mdocml</B> – UNIX manpage compiler, current version @VERSION@ (@VDATE@) |
<col width="100%"> |
</P> |
<tbody> |
<P CLASS="subhead"> |
<tr> |
Sources: <A HREF="/snapshots/mdocml.tar.gz">current</A>, |
<td> |
<A HREF="/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A> |
<div class="head"> |
(<A HREF="/snapshots/">archives</A>) |
<b>mdocml</b> – mdoc macro compiler |
</P> |
</div> |
<H1> |
</td> |
<A NAME="description">Description</A> |
</tr> |
</H1> |
<tr> |
<P> |
<td valign="top"> |
<SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <I><A HREF="mdoc.7.html">mdoc</A></I>, the roff macro |
<h1> |
package of choice for BSD manual pages, and <I><A HREF="man.7.html">man</A></I>, the predominant historical package for |
DESCRIPTION |
UNIX manuals. The mission of <SPAN CLASS="nm">mdocml</SPAN> is to deprecate <A |
</h1> |
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 (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> |
|
<H2> |
|
<A NAME="sources">Sources</A> |
|
</H2> |
|
<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> |
|
<TBODY> |
|
<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> |
|
</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> |
|
</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> |
|
</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> |
|
</TD> |
|
</TR> |
|
<TR> |
|
<TD>pkgsrc</TD> |
|
<TD> |
|
<A HREF="http://pkgsrc.se/textproc/mdocml" CLASS="external">textproc/mdocml</A> |
|
</TD> |
|
</TR> |
|
<TR> |
|
<TD>Minix3</TD> |
|
<TD> |
|
<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> |
|
</H1> |
|
<P> |
|
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"> |
<span class="nm">mdocml</span> is a suite of tools compiling “-mdoc”, the roff macro package |
<COL WIDTH="175"> |
of choice for BSD manual pages, and “-man”, the predominant historical package for UNIX |
<COL> |
manuals. The mission of <span class="nm">mdocml</span> is to deprecate <a |
<TBODY> |
href="http://www.gnu.org/software/groff/" class="external">groff</a>, the GNU roff implementation, for |
<TR> |
displaying <a href="mdoc.7.txt" class="man">mdoc(7)</a> pages whilst providing token support for <a |
<TD VALIGN="top"><A HREF="apropos.1.html">apropos(1)</A></TD> |
href="man.7.txt" class="man">man(7)</a>. |
<TD VALIGN="top"> |
</p> |
search the manual page database |
|
</TD> |
<p> |
</TR> |
What are UNIX manuals? Read <a href="manuals.7.txt" class="man">manuals(7)</a> for an introduction. |
<TR> |
</p> |
<TD VALIGN="top"><A HREF="demandoc.1.html">demandoc(1)</A></TD> |
|
<TD VALIGN="top"> |
<p> |
emit only text of UNIX manuals |
Why? groff amounts to over 5 MB of source code, most of which is C++ and all of which is GPL. It runs |
</TD> |
slowly, produces uncertain output, and varies in operation from system to system. mdocml strives to fix |
</TR> |
this (respectively small, C, ISC-licensed, fast and regular). |
<TR> |
</p> |
<TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD> |
|
<TD VALIGN="top"> |
<p> |
format and display UNIX manuals |
The core of <span class="nm">mdocml</span> are the <a href="man.3.txt" class="man">man(3)</a> and <a |
</TD> |
href="mdoc.3.txt" class="man">mdoc(3)</a> libraries, validating compilers producing intermediate-form |
</TR> |
output from -man or -mdoc input. Both are simple, fast libraries operating on memory buffers, so they |
<TR> |
may be used for a variety of front-ends (terminal-based, CGI and so on). |
<TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD> |
</p> |
<TD VALIGN="top"> |
|
recode multibyte UNIX manuals |
<p> |
</TD> |
The primary front-end is <a href="mandoc.1.txt" class="man">mandoc(1)</a>, which formats manuals for |
</TR> |
display on the terminal. Its purpose is to deprecate usage of groff for displaying -mdoc and, to a |
<TR> |
limited extent, -man manuals on the terminal. |
<TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD> |
</p> |
<TD VALIGN="top"> |
|
mandoc macro compiler library |
<p> |
</TD> |
<span class="attn">Please submit patches, bug reports and suggestions!</span> Although a significant |
</TR> |
implementation exists, work remains for the backend library and especially the front-end utilities. See |
<TR> |
the <a href="#contact">contact</a> information below for submissions. |
<TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD> |
</p> |
<TD VALIGN="top"> |
</td> |
man language reference |
</tr> |
</TD> |
<tr> |
</TR> |
<td> |
<TR> |
<h1> |
<TD VALIGN="top"><A HREF="man.cgi.7.html">man.cgi(7)</A></TD> |
INSTALLING SOURCES |
<TD VALIGN="top"> |
</h1> |
cgi for manpage query and display |
|
</TD> |
<p> |
</TR> |
Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested |
<TR> |
variously on i386, AMD64, alpha and others. |
<TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD> |
</p> |
<TD VALIGN="top"> |
|
eqn-mandoc language reference |
<p> |
</TD> |
The most current version is <span class="attn">@VERSION@</span>, dated |
</TR> |
<span class="attn">@VDATE@</span>. |
<TR> |
</p> |
<TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD> |
|
<TD VALIGN="top"> |
<h2> |
mandoc special characters |
Snapshot source |
</TD> |
</h2> |
</TR> |
|
<TR> |
<p> |
<TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD> |
CVS sources are checkedout and snapshotted with version updates. These may be found in the <a |
<TD VALIGN="top"> |
href="/snapshots/">/snapshots/</a> directory. A full <a href="/snapshots/ChangeLog">ChangeLog</a> is |
mdoc language reference |
written with each new snapshot. |
</TD> |
</p> |
</TR> |
|
<TR> |
<p class="boxed"> |
<TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD> |
% cd /tmp<br> |
<TD VALIGN="top"> |
% ftp -V -o- <a href="http://mdocml.bsd.lv/snapshots/mdocml.tar.gz"> |
roff-mandoc language reference |
http://mdocml.bsd.lv/snapshots/mdocml.tar.gz</a> | tar -zvxf -<br> |
</TD> |
% cd mdocml<br> |
</TR> |
% make all<br> |
<TR> |
# make install |
<TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD> |
</p> |
<TD VALIGN="top"> |
|
tbl-mandoc language reference |
<h2> |
</TD> |
Snapshot port/pkgsrc |
</TR> |
</h2> |
<TR> |
|
<TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD> |
<p> |
<TD VALIGN="top"> |
The source snapshot is automatically converted into OpenBSD, NetBSD and FreeBSD ports at <a |
index UNIX manuals |
href="/ports-openbsd/">/ports-openbsd/</a>, <a href="/ports-netbsd/">/ports-netbsd/</a> and <a |
</TD> |
href="/ports-freebsd/">/ports-freebsd/</a>, respectively. Please read the <a class="external" |
</TR> |
href="http://www.openbsd.org/faq/faq15.html">OpenBSD Ports FAQ</a>, the <a class="external" |
</TBODY> |
href="http://www.netbsd.org/docs/software/packages.html">NetBSD pkgsrc guide</a> or the <a |
</TABLE> |
class="external" |
<H1> |
href="http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ports-using.html">FreeBSD ports |
<A NAME="contact">Contact</A> |
guide</a>, first. |
</H1> |
</p> |
<P> |
|
Use the mailing lists for bug-reports, patches, questions, etc. Please check the |
<h3> |
<A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues |
OpenBSD port |
before posting. All lists are subscription-only: send a blank e-mail to the listed address to subscribe. Beyond that, |
</h3> |
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 class="boxed"> |
</P> |
# pkg_delete mdocml<br> |
<TABLE WIDTH="100%" SUMMARY="Mailing Lists"> |
# cd /usr/ports/textproc/<br> |
<COL WIDTH="175"> |
# rm -rf mdocml<br> |
<COL> |
# ftp -V -o- <a href="http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz"> |
<TBODY> |
http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz</a> | tar -zvxf -<br> |
<TR> |
# cd mdocml<br> |
<TD> |
# make build<br> |
disc<A CLASS="external" TITLE="Reveal this e-mail address" |
# make install |
HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv |
</p> |
</TD> |
|
<TD> |
<h3> |
bug-reports, general questions, and announcements |
NetBSD pkgsrc |
</TD> |
</h3> |
</TR> |
|
<TR> |
<p class="boxed"> |
<TD> |
# pkg_delete mdocml<br> |
tec<A CLASS="external" TITLE="Reveal this e-mail address" |
# cd /usr/pkgsrc/textproc/<br> |
HREF="http://www.google.com/recaptcha/mailhide/d?k=01qDX_iV0RlUOarEvb6mR28g==&c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...</A>@mdocml.bsd.lv |
# rm -rf mdocml<br> |
</TD> |
# ftp -V -o- <a href="http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz"> |
<TD> |
http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz</a> | tar -zvxf -<br> |
patches and system discussions |
# cd mdocml<br> |
</TD> |
# make build<br> |
</TR> |
# make install |
<TR> |
</p> |
<TD> |
|
sou<A CLASS="external" TITLE="Reveal this e-mail address" |
<h3> |
HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</A>@mdocml.bsd.lv |
FreeBSD port |
</TD> |
</h3> |
<TD> |
|
source commit messages |
<p class="boxed"> |
</TD> |
# pkg_delete -x mdocml<br> |
</TR> |
# cd /tmp<br> |
</TBODY> |
# ftp -V -o- <a href="http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz"> |
</TABLE> |
http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz</a> | tar -zvxf -<br> |
<H1> |
# cd mdocml<br> |
<A NAME="news">News</A> |
# make<br> |
</H1> |
# make install |
<P CLASS="news"> |
</p> |
xx-xx-2012: version 1.12.4 |
</td> |
</P> |
</tr> |
<P> |
<tr> |
<I>Ingo, can you summarise your changes here?</I> |
<td> |
</P> |
<h1> |
<P> |
CONTACT |
The <A HREF="mandocdb.8.html">mandocdb</A> tools (<A HREF="mandocdb.8.html">mandocdb</A>, <A |
</h1> |
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> |
Please contact Kristaps, kris<a class="external" |
<P> |
href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ==" |
See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for |
onclick="window.open('http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ==', |
historical notes. |
'', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=0,width=500,height=300'); return |
</P> |
false;" title="Reveal this e-mail address">...</a>@kth.se, with questions, bug reports, patches, and so |
<P CLASS="foot"> |
on. |
<SMALL> |
</p> |
Copyright © 2008–2011 |
|
<A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>, |
<p> |
$Date$ |
If you'd like to submit patches, please contact us beforehand in case larger changes are pending but not |
</SMALL> |
checked in. If making a bug report, please make sure it's repeatable on the most current snapshot. |
</P> |
</p> |
</BODY> |
</td> |
</HTML> |
</tr> |
|
<tr> |
|
<td> |
|
<div class="foot"> |
|
Copyright © 2008, 2009 Kristaps Džonsons, $Date$ |
|
</div> |
|
</td> |
|
</tr> |
|
</tbody> |
|
</table> |
|
</body> |
|
</html> |
|