X-Git-Url: https://git.cameronkatri.com/mandoc.git/blobdiff_plain/aa85d82aeaa92eb4f5ebff80f69420180ae71322..7065f8b98467bd2b3eb0b482f9cb152ebc43fbf6:/index.sgml diff --git a/index.sgml b/index.sgml index 280f401d..23269e80 100644 --- a/index.sgml +++ b/index.sgml @@ -2,284 +2,267 @@ <HTML> <HEAD> <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"> - <TITLE>mdocml | mdoc macro compiler</TITLE> + <TITLE>mdocml | UNIX manpage compiler</TITLE> </HEAD> <BODY> - <TABLE CLASS="frame" SUMMARY="[frame]"> - <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> + <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 compiling <Q>-mdoc</Q>, the roff macro package - of choice for BSD manual pages, and <Q>-man</Q>, 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 roff implementation, for - displaying -mdoc pages whilst providing token support for -man. - </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, ISC-licensed, fast and regular). - </P> - - <P> - The core of <SPAN CLASS="nm">mdocml</SPAN> is composed of the <i>libmdoc</i> and <i>libman</i> - validating compiler libraries. Both are simple, fast libraries operating on memory buffers, so they may - be used for a variety of front-ends (terminal-based, CGI and so on). The primary front-end is <i> - mandoc</i>, which formats manuals for display on the terminal. - </P> - - <P> - The <SPAN CLASS="nm">mdocml</SPAN> utility is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv - Project</A> member. - </P> - </TD> - </TR> - <TR> - <TD> - <H1> - SOURCES - </H1> - - <P> - Sources correctly build and install on DragonFly BSD, FreeBSD, OpenBSD, NetBSD, and GNU/Linux operating - systems, tested variously on i386, AMD64, alpha, and others. The most current version is <SPAN - CLASS="attn">@VERSION@</SPAN>, dated <SPAN class="attn">@VDATE@</SPAN>. A full <A - HREF="ChangeLog.html">ChangeLog</A> (<A HREF="ChangeLog.txt">txt</A>) is written with each release. - </P> - - <H2> - Current - </H2> - - <TABLE WIDTH="100%" SUMMARY="Current Sources"> - <COL WIDTH="200"> - <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 CLASS="external" HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A> - </TD> - </TR> - </TBODY> - </TABLE> - - <H2> - Downstream - </H2> - - <TABLE WIDTH="100%" SUMMARY="Downstream Sources"> - <COL WIDTH="200"> - <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> - </TBODY> - </TABLE> - - <H2> - Historical - </H2> - - <TABLE WIDTH="100%" SUMMARY="Archived Sources"> - <COL WIDTH="200"> - <COL> - <TBODY> - <TR> - <TD>Source archive</TD> - <TD> - <A HREF="/snapshots/">/snapshots/</A> - </TD> - </TR> - </TBODY> - </TABLE> - </TD> - </TR> - <TR> - <TD> - <H1> - DOCUMENTATION - </H1> - - <P> - These manuals are generated automatically and refer to the current snapshot. - </P> - - <TABLE WIDTH="100%" SUMMARY="Documentation"> - <COL WIDTH="200"> - <COL> - <TBODY> - <TR> - <TD><A HREF="mandoc.1.html">mandoc(1)</A> (<A HREF="mandoc.1.txt">text</A>)</TD> - <TD>format and display UNIX manuals</TD> - </TR> - <TR> - <TD><A HREF="mandoc_char.7.html">mandoc_char(7)</A> (<A HREF="mandoc_char.7.txt">text</A>)</TD> - <TD>mandoc special characters</TD> - </TR> - <TR> - <TD><A HREF="mdoc.7.html">mdoc(7)</A> (<A HREF="mdoc.7.txt">text</A>)</TD> - <TD>mdoc language reference</TD> - </TR> - <TR> - <TD><A HREF="man.7.html">man(7)</A> (<A HREF="man.7.txt">text</A>)</TD> - <TD>man language reference</TD> - </TR> - <TR> - <TD><A HREF="manuals.7.html">manuals(7)</A> (<A HREF="manuals.7.txt">text</A>)</TD> - <TD>a guide to writing UNIX manuals</TD> - </TR> - <TR> - <TD><A HREF="mdoc.3.html">mdoc(3)</A> (<A HREF="mdoc.3.txt">text</A>)</TD> - <TD>mdoc macro compiler library</TD> - </TR> - <TR> - <TD><A HREF="man.3.html">man(3)</A> (<A HREF="man.3.txt">text</A>)</TD> - <TD>man macro compiler library</TD> - </TR> - </TBODY> - </TABLE> - </TD> - </TR> - <TR> - <TD> - <H1> - CONTACT - </H1> - - <P> - For all issues related to <SPAN CLASS="nm">mdocml</SPAN>, contact Kristaps Dzonsons, kris<A - CLASS="external" - HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" - TITLE="Reveal this e-mail address">...</A>@bsd.lv. - </P> - - <P> - If you want to receive a semi-automated mail-out of new releases, then please write with a message - subject of <I>subscribe mdocml</I> (or <I>unsubscribe mdocml</I>). - </P> - </TD> - </TR> - <TR> - <TD> - <H1> - NEWS - </H1> - - <TABLE WIDTH="100%" CELLPADDING="2"> - <COL CLASS="date"> - <TBODY> - <TR> - <TD VALIGN="top"><SPAN CLASS="date">29-03-2010</SPAN></TD> - <TD VALIGN="top"> - Version <SPAN CLASS="rev">1.9.20</SPAN>: more efforts to get roff instructions - in -man documents under control. This seems to be working for all manuals I can - find. Please let me know if you find ill-formatted -man manuals. Note that - roff instructions embedded in line-scoped, next-line macros (e.g. <Q>B</Q>) are - not supported. - </TD> - </TR> - <TR> - <TD VALIGN="top"><SPAN CLASS="date">27-03-2010</SPAN></TD> - <TD VALIGN="top"> - Version <SPAN CLASS="rev">1.9.18</SPAN>: many fixes (largely pertaining to - scope) and improvements (e.g., handling of apostrophe-control macros, which - fixes the strange <Q>BR</Q> seen in some macro output) to handling roff - instructions in -man documents. - </TD> - </TR> - <TR> - <TD VALIGN="top"><SPAN CLASS="date">25-03-2010</SPAN></TD> - <TD VALIGN="top"> - Version <SPAN CLASS="rev">1.9.17</SPAN> highlights: accept <A - HREF="http://perldoc.perl.org/" CLASS="external">perlpod</A> standard preamble. - Also accept (and discard) <Q>de</Q>, <Q>dei</Q>, <Q>am</Q>, <Q>ami</Q>, and - <Q>ig</Q> roff macro blocks. - </TD> - </TR> - <TR> - <TD VALIGN="top"><SPAN CLASS="date">22-03-2010</SPAN></TD> - <TD VALIGN="top"> - Version <SPAN CLASS="rev">1.9.16</SPAN> highlights: inspired by patches and bug - reports by Ingo Schwarze, allowed <SPAN CLASS="flag">-man</SPAN> to accept - non-printing elements to be nested within next-line scopes, such as <Q>br</Q> - within <Q>B</Q> or <Q>TH</Q>, which is valid roff. Longsoon architecture also - noted and Makefile cleaned up. - </TD> - </TR> - <TR> - <TD VALIGN="top"><SPAN CLASS="date">18-02-2010</SPAN></TD> - <TD VALIGN="top"> - Moved to our new <A HREF="http://bsd.lv" CLASS="external">BSD.lv</A> home. - Version <SPAN CLASS="rev">1.9.15</SPAN> highlights: XHTML is now an acceptable - output mode for <A HREF="mandoc.1.html">mandoc(1)</A>; <Q>Xr</Q> made more - compatible with groff; <Q>Vt</Q> fixed when invoked in SYNOPSIS; <Q>\\</Q> - escape removed; end-of-line white-space detected for all lines; subtle bug - fixed in list display for some modes; compatibility layer checked in for - compilation in diverse UNIX systems; and column lengths handled correctly. - </TD> - </TR> - </TBODY> - </TABLE> - </TD> - </TR> - <TR> - <TD> - <DIV CLASS="foot"> - Copyright © 2008–2010 Kristaps Dzonsons, $Date: 2010/03/29 10:10:35 $ - </DIV> - </TD> - </TR> - </TBODY> - </TABLE> + <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>