X-Git-Url: https://git.cameronkatri.com/mandoc.git/blobdiff_plain/2f13c0b874bb645b2553d4fb4fdd299d0d6e237b..7065f8b98467bd2b3eb0b482f9cb152ebc43fbf6:/index.sgml diff --git a/index.sgml b/index.sgml index 5dc2974f..23269e80 100644 --- a/index.sgml +++ b/index.sgml @@ -1,142 +1,268 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> -<html> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> - <meta name="resource-type" content="document"> - <link rel="stylesheet" href="style.css" type="text/css" media="all"> - <title>mdocml.bsd.lv</title> - </head> - <body> - <table width="600"> - <col width="100%"> - <tbody> - <tr> - <td> - <div class="head"> - <b>mdocml</b> – mdoc macro compiler - </div> - </td> - </tr> - <tr> - <td valign="top"> - <h1> - DESCRIPTION - </h1> +<HTML> + <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 | UNIX manpage compiler</TITLE> + </HEAD> + <BODY> + <P CLASS="head"> + <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> + </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 + UNIX manuals. The mission of <SPAN CLASS="nm">mdocml</SPAN> is to deprecate <A + 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> - <span class="nm">mdocml</span> is a suite of tools that compile “mdoc”, the roff macro - package of the BSD manual pages. The mission of <span class="nm">mdocml</span> is to deprecate <a - href="http://www.gnu.org/software/groff/" class="external">groff</a>, the GNU roff implementation, for - displaying BSD mdoc pages. groff amounts to over 60 000 lines of GPL C++ source, which is a - considerable encumbrance to BSD operating system. - </p> - - <p> - The core of <span class="nm">mdocml</span> is the libmdoc library, a validating scanner-parser producing - intermediate-form output from mdoc input. libmdoc is a simple, fast library operating on memory buffers - of mdoc input. Its intermediate output, an abstract syntax tree, is fully documented in the <span - class="man">mdoc(3)</span> reference manual. - </p> - - <p> - There are three utilities implementing <span class="man">mdoc(3)</span>: - </p> - - <ul> - <li><span class="man">mdocterm(1)</span> – formats mdoc input for display on the terminal - <li><span class="man">mdochtml(1)</span> – formats mdoc input as strict HTML (nascent) - <li><span class="man">mdoclint(1)</span> – validates mdoc input - <li><span class="man">mdoctree(1)</span> – prints input abstract syntax tree - </ul> - - <p> - The <span class="man">mdocterm(1)</span> utility is intended to deprecate usage of <a - href="http://www.gnu.org/software/groff/" class="external">groff</a> for displaying BSD manuals to the - terminal, either directly or cached as a “catman” page. - </p> - - <p> - <span class="attn">Please submit patches!</span> Although a significant implementation exists, work - remains for the backend library and especially the front-end utilities. See the <a - href="#contact">contact</a> information below to submit patches and bug reports. - </p> - </td> - </tr> - <tr> - <td> - <h1> - INSTALLING SOURCES - </h1> - - <p> - Sources correctly build and install on OpenBSD, NetBSD and Linux operating systems, tested variously on - i386, AMD64 and Alpha. - </p> - - <h2> - snapshotted source - </h2> - - <p> - CVS sources are checkedout and snapshotted with big updates. These may be found in the <a - href="/snapshots/">/snapshots/</a> directory. - </p> - - <p class="boxed"> - % cd /tmp<br> - % ftp -V -o- http://mdocml.bsd.lv/snapshots/mdocml.tar.gz | tar -zvxf -<br> - % cd mdocml<br> - % make && make regress && make install - </p> - - <h2> - nightly port - </h2> - - <p> - The source snapshot is automatically converted into an OpenBSD port (ports for other BSD systems not - yet available). These may be found in the <a href="/ports-openbsd/">/ports-openbsd/</a> directory. - You <span class="emph">must</span> have the ports tree installed. - </p> - - <p class="boxed"> - % sudo pkg_delete mdocml<br> - % cd /usr/ports/devel/<br> - % sudo rm -rf mdocml<br> - % ftp -V -o- http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz | sudo tar -zvxf -<br> - % cd mdocml<br> - % sudo make && sudo make regress && sudo make install - </p> - </td> - </tr> - <tr> - <td> - <h1> - CONTACT - </h1> - - <p> - Please contact Kristaps, kris<a class="external" - href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ==" - onclick="window.open('http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ==', - '', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=0,width=500,height=300'); return - false;" title="Reveal this e-mail address">...</a>@kth.se, with questions, bug reports, patches, and so on. - </p> - - <p> - If you'd like to submit patches, please contact us beforehand in case larger changes are pending but not - checked in. If making a bug report, please make sure it's repeatable on the most current snapshot. - </p> - </td> - </tr> - <tr> - <td> - <div class="foot"> - Copyright © 2009 Kristaps Džonsons, $Date: 2009/02/23 20:55:56 $ - </div> - </td> - </tr> - </tbody> - </table> - </body> -</html> + <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 + </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 + </TD> + </TR> + <TR> + <TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD> + <TD VALIGN="top"> + man language reference + </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 + </TD> + </TR> + <TR> + <TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD> + <TD VALIGN="top"> + mandoc special characters + </TD> + </TR> + <TR> + <TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD> + <TD VALIGN="top"> + mdoc language reference + </TD> + </TR> + <TR> + <TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD> + <TD VALIGN="top"> + roff-mandoc language reference + </TD> + </TR> + <TR> + <TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD> + <TD VALIGN="top"> + tbl-mandoc language reference + </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> + </H1> + <P> + 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. 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> + <TBODY> + <TR> + <TD> + disc<A CLASS="external" TITLE="Reveal this e-mail address" + HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv + </TD> + <TD> + bug-reports, general questions, and announcements + </TD> + </TR> + <TR> + <TD> + tec<A CLASS="external" TITLE="Reveal this e-mail address" + HREF="http://www.google.com/recaptcha/mailhide/d?k=01qDX_iV0RlUOarEvb6mR28g==&c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...</A>@mdocml.bsd.lv + </TD> + <TD> + patches and system discussions + </TD> + </TR> + <TR> + <TD> + sou<A CLASS="external" TITLE="Reveal this e-mail address" + HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</A>@mdocml.bsd.lv + </TD> + <TD> + source commit messages + </TD> + </TR> + </TBODY> + </TABLE> + <H1> + <A NAME="news">News</A> + </H1> + <P CLASS="news"> + xx-xx-2012: version 1.12.4 + </P> + <P> + <I>Ingo, can you summarise your changes here?</I> + </P> + <P> + 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> + 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: 2012/06/09 14:19:55 $ + </SMALL> + </P> + </BODY> +</HTML>