[BACK]Return to index.sgml CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/Attic/index.sgml between version 1.2 and 1.157

version 1.2, 2009/02/23 15:38:20 version 1.157, 2012/06/09 14:11:15
Line 1 
Line 1 
 <!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> &#8211; 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> &#8211; 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; and
                           <A HREF="apropos.1.html">apropos</A>, <A HREF="whatis.1.html">whatis</A>, and
                           <A HREF="man.cgi.7.html">man.cgi</A> for semantic search of manual content.
                           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>, <A
                           HREF="whatis.1.html">whatis</A>, <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 that compile &#8220;mdoc&#8221;, the roff macro                          <COL WIDTH="175">
                                         package of the BSD manual pages.  The mission of <span class="nm">mdocml</span> is to deprecate <a                          <COL>
                                         href="http://www.gnu.org/software/groff/" class="external">groff</a>, the GNU roff implementation, for                          <TBODY>
                                         displaying BSD mdoc pages.  groff amounts to over 60 000 lines of GPL C++ source, which is a                                  <TR>
                                         considerable encumbrance to BSD operating system.                                          <TD VALIGN="top"><A HREF="apropos.1.html">apropos(1)</A></TD>
                                         </p>                                          <TD VALIGN="top">
                                                   search the manual page database
                                         <p>                                                          (<A HREF="apropos.1.txt">text</A> |
                                         The core of <span class="nm">mdocml</span> is the libmdoc library, a validating scanner-parser producing                                                          <A HREF="apropos.1.xhtml">xhtml</A> |
                                         intermediate-form output from mdoc input.  libmdoc is a simple, fast library operating on memory buffers                                                          <A HREF="apropos.1.pdf">pdf</A> |
                                         of mdoc input.  Its intermediate output, an abstract syntax tree, is fully documented in the <span                                                          <A HREF="apropos.1.ps">ps</A>)
                                         class="man">mdoc(3)</span> reference manual.                                          </TD>
                                         </p>                                  </TR>
                                   <TR>
                                         <p>                                          <TD VALIGN="top"><A HREF="demandoc.1.html">demandoc(1)</A></TD>
                                         There are three utilities implementing <span class="man">mdoc(3)</span>:                                          <TD VALIGN="top">
                                         </p>                                                  emit only text of UNIX manuals
                                                           (<A HREF="demandoc.1.txt">text</A> |
                                         <ul>                                                          <A HREF="demandoc.1.xhtml">xhtml</A> |
                                         <li><span class="man">mdocterm(1)</span> &#8211; formats mdoc input for display on the terminal                                                          <A HREF="demandoc.1.pdf">pdf</A> |
                                         <li><span class="man">mdochtml(1)</span> &#8211; formats mdoc input as strict HTML (nascent)                                                          <A HREF="demandoc.1.ps">ps</A>)
                                         <li><span class="man">mdoclint(1)</span> &#8211; validates mdoc input                                          </TD>
                                         <li><span class="man">mdoctree(1)</span> &#8211; prints input abstract syntax tree                                  </TR>
                                         </ul>                                  <TR>
                                           <TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD>
                                         <p>                                          <TD VALIGN="top">
                                         The <span class="man">mdocterm(1)</span> utility is intended to deprecate usage of <a                                                  format and display UNIX manuals
                                         href="http://www.gnu.org/software/groff/" class="external">groff</a> for displaying BSD manuals to the                                                          (<A HREF="mandoc.1.txt">text</A> |
                                         terminal, either directly or cached as a &#8220;catman&#8221; page.                                                          <A HREF="mandoc.1.xhtml">xhtml</A> |
                                         </p>                                                          <A HREF="mandoc.1.pdf">pdf</A> |
                                                           <A HREF="mandoc.1.ps">ps</A>)
                                         <p>                                          </TD>
                                         <span class="attn">Please submit patches!</span> Although a significant implementation exists, work                                  </TR>
                                         remains for the backend library and especially the front-end utilities.  See the <a                                  <TR>
                                         href="#contact">contact</a> information below to submit patches and bug reports.                                          <TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD>
                                         </p>                                          <TD VALIGN="top">
                                 </td>                                                  recode multibyte UNIX manuals
                         </tr>                                                          (<A HREF="preconv.1.txt">text</A> |
                         <tr>                                                          <A HREF="preconv.1.xhtml">xhtml</A> |
                                 <td>                                                          <A HREF="preconv.1.pdf">pdf</A> |
                                         <h1>                                                          <A HREF="preconv.1.ps">ps</A>)
                                         INSTALLING SOURCES                                          </TD>
                                         </h1>                                  </TR>
                                   <TR>
                                         <p>                                          <TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD>
                                         Sources correctly build and install on OpenBSD, NetBSD and Linux operating systems, tested variously on                                          <TD VALIGN="top">
                                         i386, AMD64 and Alpha.                                                  mandoc macro compiler library
                                         </p>                                                          (<A HREF="mandoc.3.txt">text</A> |
                                                           <A HREF="mandoc.3.xhtml">xhtml</A> |
                                         <h2>                                                          <A HREF="mandoc.3.pdf">pdf</A> |
                                         nightly source                                                          <A HREF="mandoc.3.ps">ps</A>)
                                         </h2>                                          </TD>
                                   </TR>
                                         <p>                                  <TR>
                                         CVS sources are checkedout and snapshotted nightly.  These may be found in the <a                                          <TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD>
                                         href="/snapshots/">/snapshots/</a> directory.                                          <TD VALIGN="top">
                                         </p>                                                  man language reference
                                                           (<A HREF="man.7.txt">text</A> |
                                         <p class="boxed">                                                          <A HREF="man.7.xhtml">xhtml</A> |
                                         % cd /tmp<br>                                                          <A HREF="man.7.pdf">pdf</A> |
                                         % ftp -V -o- http://mdocml.bsd.lv/snapshots/mdocml.tgz | tar -zxf -<br>                                                          <A HREF="man.7.ps">ps</A>)
                                         % cd mdocml<br>                                          </TD>
                                         % make<br>                                  </TR>
                                         % make regress<br>                                  <TR>
                                         % make install                                          <TD VALIGN="top"><A HREF="man.cgi.7.html">man.cgi(7)</A></TD>
                                         </p>                                          <TD VALIGN="top">
                                                   cgi for manpage query and display
                                         <h2>                                                          (<A HREF="man.cgi.7.txt">text</A> |
                                         nightly port                                                          <A HREF="man.cgi.7.xhtml">xhtml</A> |
                                         </h2>                                                          <A HREF="man.cgi.7.pdf">pdf</A> |
                                                           <A HREF="man.cgi.7.ps">ps</A>)
                                         <p>                                          </TD>
                                         The nightly snapshot is automatically converted into an OpenBSD port (ports for other BSD systems not                                  </TR>
                                         yet available).  These may be found in the <a href="/ports-openbsd/">/ports-openbsd/</a> directory.                                  <TR>
                                         </p>                                          <TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD>
                                           <TD VALIGN="top">
                                         <p>                                                  eqn-mandoc language reference
                                         If installing for the first time:                                                          (<A HREF="eqn.7.txt">text</A> |
                                         </p>                                                          <A HREF="eqn.7.xhtml">xhtml</A> |
                                                           <A HREF="eqn.7.pdf">pdf</A> |
                                         <p class="boxed">                                                          <A HREF="eqn.7.ps">ps</A>)
                                         % ftp -V -o- http://mdocml.bsd.lv/ports-openbsd/mdocml.tgz | tar -zxf -<br>                                          </TD>
                                         % cd mdocml<br>                                  </TR>
                                         % sudo make<br>                                  <TR>
                                         % sudo make install                                          <TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD>
                                         </p>                                          <TD VALIGN="top">
                                                   mandoc special characters
                                         <p>                                                          (<A HREF="mandoc_char.7.txt">text</A> |
                                         Subsequent installations:                                                          <A HREF="mandoc_char.7.xhtml">xhtml</A> |
                                         </p>                                                          <A HREF="mandoc_char.7.pdf">pdf</A> |
                                                           <A HREF="mandoc_char.7.ps">ps</A>)
                                         <p class="boxed">                                          </TD>
                                         % sudo pkg_add -r mdocml                                  </TR>
                                         </p>                                  <TR>
                                 </td>                                          <TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD>
                         </tr>                                          <TD VALIGN="top">
                         <tr>                                                  mdoc language reference
                                 <td>                                                          (<A HREF="mdoc.7.txt">text</A> |
                                         <h1>                                                          <A HREF="mdoc.7.xhtml">xhtml</A> |
                                         CONTACT                                                          <A HREF="mdoc.7.pdf">pdf</A> |
                                         </h1>                                                          <A HREF="mdoc.7.ps">ps</A>)
                                           </TD>
                                         <p>                                  </TR>
                                         Please contact Kristaps, kris<a class="external"                                  <TR>
                                         href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&amp;c=sb5E6ulipc-eTnpTVqI-BQ=="                                          <TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD>
                                         onclick="window.open('http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&amp;c=sb5E6ulipc-eTnpTVqI-BQ==',                                          <TD VALIGN="top">
                                         '', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=0,width=500,height=300'); return                                                  roff-mandoc language reference
                                         false;" title="Reveal this e-mail address">...</a>@kth.se, with questions, bug reports, patches, and so on.                                                          (<A HREF="roff.7.txt">text</A> |
                                         </p>                                                          <A HREF="roff.7.xhtml">xhtml</A> |
                                                           <A HREF="roff.7.pdf">pdf</A> |
                                         <p>                                                          <A HREF="roff.7.ps">ps</A>)
                                         If you'd like to submit patches, please contact us beforehand in case larger changes are pending but not                                          </TD>
                                         checked in.  If making a bug report, please make sure it's repeatable on the most current snapshot.                                  </TR>
                                         </p>                                  <TR>
                                 </td>                                          <TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD>
                         </tr>                                          <TD VALIGN="top">
                         <tr>                                                  tbl-mandoc language reference
                                 <td>                                                          (<A HREF="tbl.7.txt">text</A> |
                                         <div class="foot">                                                          <A HREF="tbl.7.xhtml">xhtml</A> |
                                                 Copyright &#169; 2009 Kristaps D&#382;onsons, $Date$                                                          <A HREF="tbl.7.pdf">pdf</A> |
                                         </div>                                                          <A HREF="tbl.7.ps">ps</A>)
                                 </td>                                          </TD>
                         </tr>                                  </TR>
                 </tbody>                                  <TR>
         </table>                                          <TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD>
         </body>                                          <TD VALIGN="top">
 </html>                                                  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.  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==&amp;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==&amp;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==&amp;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==&amp;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 &#169; 2008&#8211;2011
                                   <A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>,
                                   $Date$
                           </SMALL>
                   </P>
           </BODY>
   </HTML>
Legend:
Removed from v.1.2  
changed lines
  Added in v.1.157
CVSweb