index.sgml

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
   2 <HTML>
   3         <HEAD>
   4                 <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8">
   5                 <LINK REL="stylesheet" HREF="index.css" TYPE="text/css" MEDIA="all">
   6                 <TITLE>mdocml | UNIX manpage compiler</TITLE>
   7         </HEAD>
   8         <BODY>
   9                 <P CLASS="head">
  10                         <B>mdocml</B> &#8211; UNIX manpage compiler, current version @VERSION@ (@VDATE@)
  11                 </P>
  12                 <P CLASS="subhead">
  13                         Sources: <A HREF="/snapshots/mdocml.tar.gz">current</A>,
  14                         <A HREF="/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A>
  15                         (<A HREF="/snapshots/">archives</A>)
  16                 </P>
  17                 <H1>
  18                         <A NAME="description">Description</A>
  19                 </H1>
  20                 <P>
  21                         <SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <I><A HREF="mdoc.7.html">mdoc</A></I>, the roff macro
  22                         package of choice for BSD manual pages, and <I><A HREF="man.7.html">man</A></I>, the predominant historical package for
  23                         UNIX manuals.  The mission of <SPAN CLASS="nm">mdocml</SPAN> is to deprecate <A
  24                         HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU troff implementation, for displaying <I>mdoc</I>
  25                         pages whilst providing token support for <I>man</I>.
  26                 </P>
  27                 <P>
  28                         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
  29                         uncertain output, and varies in operation from system to system.  mdocml strives to fix this (respectively small, C, <A
  30                         CLASS="external" HREF="http://www.isc.org/software/license">ISC</A>-licensed, fast and regular).
  31                 </P>
  32                 <P>
  33                         <SPAN CLASS="nm">mdocml</SPAN> consists of the <A HREF="mandoc.3.html">libmandoc</A> validating compiler and <A
  34                         HREF="mandoc.1.html">mandoc</A>, which interfaces with the compiler library to format output for UNIX terminals (with
  35                         support for wide-character locales), XHTML, HTML, PostScript, and PDF.
  36                         It also includes <A HREF="preconv.1.html">preconv</A> for recoding multibyte manuals,
  37                         <A HREF="demandoc.1.html">demandoc</A> for emitting only text parts of manuals,
  38                         <A HREF="mandocdb.8.html">mandocdb</A> for indexing manuals,
  39                         <A HREF="apropos.1.html">apropos</A> (includes whatis mode) for indexed manual search, and
  40                         <A HREF="man.cgi.7.html">man.cgi</A> for indexed manual search online.
  41                         It is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project.
  42                 </P>
  43                 <P>
  44                         <I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, <Q>mandoc</Q>.
  45                 </P>
  46                 <H2>
  47                         <A NAME="sources">Sources</A>
  48                 </H2>
  49                 <P>
  50                         <SPAN CLASS="nm">mdocml</SPAN> is in ISO C99 and should build and run on any modern system; however, you'll need <A
  51                         HREF="http://www.sqlite.org">sqlite3</A> to build <A HREF="apropos.1.html">apropos</A> (links to whatis),
  52                         <A HREF="man.cgi.7.html">man.cgi</A>, and <A HREF="mandocdb.8.html">mandocdb</A>.
  53                         To build and install into <I>/usr/local/</I>, just run <CODE>make install</CODE>.
  54                         Be careful: the <B>preconv</B>, <B>apropos</B>, and <B>whatis</B> binary names are usually taken by existing utilities.
  55                 </P>
  56                 <H2>
  57                         Downstream
  58                 </H2>
  59                 <P>
  60                         Several systems come bundled with <SPAN CLASS="nm">mdocml</SPAN> utilities.
  61                         If your system does not appear below, the maintainers have not contacted me and it should not be considered
  62                         <Q>official</Q>.
  63                         Please <A HREF="#contact">contact us</A> if you plan on maintaining a downstream version!
  64                 </P>
  65                 <TABLE WIDTH="100%" SUMMARY="Downstream Sources">
  66                         <COL WIDTH="175">
  67                         <COL>
  68                         <TBODY>
  69                                 <TR>
  70                                         <TD>DragonFly BSD</TD>
  71                                         <TD>
  72                                         <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc" CLASS="external">usr.bin/mandoc</A>
  73                                         </TD>
  74                                 </TR>
  75                                 <TR>
  76                                         <TD>FreeBSD</TD>
  77                                         <TD>
  78                                         <A HREF="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/" CLASS="external">ports/textproc/mdocml</A>
  79                                         </TD>
  80                                 </TR>
  81                                 <TR>
  82                                         <TD>NetBSD</TD>
  83                                         <TD>
  84                                         <A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/" CLASS="external">src/external/bsd/mdocml</A>
  85                                         </TD>
  86                                 </TR>
  87                                 <TR>
  88                                         <TD>OpenBSD</TD>
  89                                         <TD>
  90                                         <A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/" CLASS="external">src/usr.bin/mandoc</A>
  91                                         </TD>
  92                                 </TR>
  93                                 <TR>
  94                                         <TD>pkgsrc</TD>
  95                                         <TD>
  96                                         <A HREF="http://pkgsrc.se/textproc/mdocml" CLASS="external">textproc/mdocml</A>
  97                                         </TD>
  98                                 </TR>
  99                                 <TR>
 100                                         <TD>Minix3</TD>
 101                                         <TD>
 102                                         <A HREF="http://git.minix3.org/?p=minix.git;a=tree;f=external/bsd/mdocml" CLASS="external">external/bsd/mdocml</A>
 103                                         </TD>
 104                                 </TR>
 105                         </TBODY>
 106                 </TABLE>
 107                 <H1>
 108                         <A NAME="documentation">Documentation</A>
 109                 </H1>
 110                 <P>
 111                         These manuals are generated automatically and refer to the current release.
 112                         They are the authoritative documentation for the <SPAN CLASS="nm">mdocml</SPAN> system.
 113                 </P>
 114
 115                 <TABLE WIDTH="100%" SUMMARY="Documentation">
 116                         <COL WIDTH="175">
 117                         <COL>
 118                         <TBODY>
 119                                 <TR>
 120                                         <TD VALIGN="top"><A HREF="apropos.1.html">apropos(1)</A></TD>
 121                                         <TD VALIGN="top">
 122                                                 search the manual page database
 123                                         </TD>
 124                                 </TR>
 125                                 <TR>
 126                                         <TD VALIGN="top"><A HREF="demandoc.1.html">demandoc(1)</A></TD>
 127                                         <TD VALIGN="top">
 128                                                 emit only text of UNIX manuals
 129                                         </TD>
 130                                 </TR>
 131                                 <TR>
 132                                         <TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD>
 133                                         <TD VALIGN="top">
 134                                                 format and display UNIX manuals
 135                                         </TD>
 136                                 </TR>
 137                                 <TR>
 138                                         <TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD>
 139                                         <TD VALIGN="top">
 140                                                 recode multibyte UNIX manuals
 141                                         </TD>
 142                                 </TR>
 143                                 <TR>
 144                                         <TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD>
 145                                         <TD VALIGN="top">
 146                                                 mandoc macro compiler library
 147                                         </TD>
 148                                 </TR>
 149                                 <TR>
 150                                         <TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD>
 151                                         <TD VALIGN="top">
 152                                                 man language reference
 153                                         </TD>
 154                                 </TR>
 155                                 <TR>
 156                                         <TD VALIGN="top"><A HREF="man.cgi.7.html">man.cgi(7)</A></TD>
 157                                         <TD VALIGN="top">
 158                                                 cgi for manpage query and display
 159                                         </TD>
 160                                 </TR>
 161                                 <TR>
 162                                         <TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD>
 163                                         <TD VALIGN="top">
 164                                                 eqn-mandoc language reference
 165                                         </TD>
 166                                 </TR>
 167                                 <TR>
 168                                         <TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD>
 169                                         <TD VALIGN="top">
 170                                                 mandoc special characters
 171                                         </TD>
 172                                 </TR>
 173                                 <TR>
 174                                         <TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD>
 175                                         <TD VALIGN="top">
 176                                                 mdoc language reference
 177                                         </TD>
 178                                 </TR>
 179                                 <TR>
 180                                         <TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD>
 181                                         <TD VALIGN="top">
 182                                                 roff-mandoc language reference
 183                                         </TD>
 184                                 </TR>
 185                                 <TR>
 186                                         <TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD>
 187                                         <TD VALIGN="top">
 188                                                 tbl-mandoc language reference
 189                                         </TD>
 190                                 </TR>
 191                                 <TR>
 192                                         <TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD>
 193                                         <TD VALIGN="top">
 194                                                 index UNIX manuals
 195                                         </TD>
 196                                 </TR>
 197                         </TBODY>
 198                 </TABLE>
 199                 <H1>
 200                         <A NAME="contact">Contact</A>
 201                 </H1>
 202                 <P>
 203                         Use the mailing lists for bug-reports, patches, questions, etc.  Please check the
 204                         <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues
 205                         before posting.  All lists are subscription-only: send a blank e-mail to the listed address to subscribe.  Beyond that,
 206                         contact Kristaps at <A HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&amp;c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal
 207                         this e-mail address">kris...</A>@bsd.lv.  Archives are available at <A HREF="http://gmane.org/" CLASS="external">Gmane</A>.
 208                 </P>
 209                 <TABLE WIDTH="100%" SUMMARY="Mailing Lists">
 210                         <COL WIDTH="175">
 211                         <COL>
 212                         <TBODY>
 213                                 <TR>
 214                                         <TD>
 215                                                 disc<A CLASS="external" TITLE="Reveal this e-mail address"
 216                                                 HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&amp;c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv
 217                                         </TD>
 218                                         <TD>
 219                                                 bug-reports, general questions, and announcements
 220                                         </TD>
 221                                 </TR>
 222                                 <TR>
 223                                         <TD>
 224                                                 tec<A CLASS="external" TITLE="Reveal this e-mail address"
 225                                                 HREF="http://www.google.com/recaptcha/mailhide/d?k=01qDX_iV0RlUOarEvb6mR28g==&amp;c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...</A>@mdocml.bsd.lv
 226                                         </TD>
 227                                         <TD>
 228                                                 patches and system discussions
 229                                         </TD>
 230                                 </TR>
 231                                 <TR>
 232                                         <TD>
 233                                                 sou<A CLASS="external" TITLE="Reveal this e-mail address"
 234                                                 HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&amp;c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</A>@mdocml.bsd.lv
 235                                         </TD>
 236                                         <TD>
 237                                                 source commit messages
 238                                         </TD>
 239                                 </TR>
 240                         </TBODY>
 241                 </TABLE>
 242                 <H1>
 243                         <A NAME="news">News</A>
 244                 </H1>
 245                 <P CLASS="news">
 246                         xx-xx-2012: version 1.12.4
 247                 </P>
 248                 <P>
 249                         <I>Ingo, can you summarise your changes here?</I>
 250                 </P>
 251                 <P>
 252                         The <A HREF="mandocdb.8.html">mandocdb</A> tools (<A HREF="mandocdb.8.html">mandocdb</A>, <A
 253                         HREF="apropos.1.html">apropos</A> (absorbing whatis), and <A HREF="man.cgi.7.html">man.cgi</A>) have been re-written to
 254                         use <A CLASS="external" HREF="http://www.sqlite.org">sqlite3</A> as a database.
 255                 </P>
 256                 <P>
 257                         See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for
 258                         historical notes.
 259                 </P>
 260                 <P CLASS="foot">
 261                         <SMALL>
 262                                 Copyright &#169; 2008&#8211;2011
 263                                 <A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>,
 264                                 $Date: 2012/06/09 14:19:55 $
 265                         </SMALL>
 266                 </P>
 267         </BODY>
 268 </HTML>