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                 <meta name="resource-type" content="document">
   6                 <link rel="stylesheet" href="style.css" type="text/css" media="all">
   7                 <title>mdocml.bsd.lv</title>
   8         </head>
   9         <body>
  10         <table class="frame">
  11                 <col width="100%">
  12                 <tbody>
  13                         <tr>
  14                                 <td>
  15                                         <div class="head">
  16                                                 <b>mdocml</b> &#8211; mdoc macro compiler
  17                                         </div>
  18                                 </td>
  19                         </tr>
  20                         <tr>
  21                                 <td valign="top">
  22                                         <h1>
  23                                         DESCRIPTION
  24                                         </h1>
  25
  26                                         <p>
  27                                         <span class="nm">mdocml</span> is a suite of tools compiling &#8220;-mdoc&#8221;, the roff macro package
  28                                         of choice for BSD manual pages, and &#8220;-man&#8221;, the predominant historical package for UNIX
  29                                         manuals.  The mission of <span class="nm">mdocml</span> is to deprecate <a
  30                                         href="http://www.gnu.org/software/groff/" class="external">groff</a>, the GNU roff implementation, for
  31                                         displaying -mdoc pages whilst providing token support for -man.
  32                                         </p>
  33
  34                                         <p>
  35                                         Why?  groff amounts to over 5 MB of source code, most of which is C++ and all of which is GPL.  It runs
  36                                         slowly, produces uncertain output, and varies in operation from system to system.  mdocml strives to fix
  37                                         this (respectively small, C, ISC-licensed, fast and regular).
  38                                         </p>
  39
  40                                         <p>
  41                                         The core of <span class="nm">mdocml</span> is composed of the <i>libmdoc</i> and <i>libman</i>
  42                                         validating compiler libraries.  Both are simple, fast libraries operating on memory buffers, so they may
  43                                         be used for a variety of front-ends (terminal-based, CGI and so on).  The primary front-end is <i>
  44                                         mandoc</i>, which formats manuals for display on the terminal.
  45                                         </p>
  46                                 </td>
  47                         </tr>
  48                         <tr>
  49                                 <td>
  50                                         <h1>
  51                                         DOWNLOADS
  52                                         </h1>
  53
  54                                         <p>
  55                                         Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested
  56                                         variously on i386, AMD64, alpha, and others.  The most current version is <span
  57                                         class="attn">@VERSION@</span>, dated <span class="attn">@VDATE@</span>.  A full <a
  58                                         href="ChangeLog.html">ChangeLog</a> is written with each release.
  59                                         </p>
  60
  61                                         <h2>
  62                                         Current
  63                                         </h2>
  64
  65                                         <table width="100%">
  66                                         <col width="200">
  67                                         <col>
  68                                         <tbody>
  69                                                 <tr>
  70                                                         <td>Source archive</td>
  71                                                         <td>
  72                                                         <a href="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</a>
  73                                                         (<a href="/snapshots/mdocml.md5">md5</a>)
  74                                                         </td>
  75                                                 </tr>
  76                                         </tbody>
  77                                         </table>
  78
  79                                         <h2>
  80                                         Downstream
  81                                         </h2>
  82
  83                                         <table width="100%">
  84                                         <col width="200">
  85                                         <col>
  86                                         <tbody>
  87                                                 <tr>
  88                                                         <td>FreeBSD</td>
  89                                                         <td>
  90                                                         <a href="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/"
  91                                                                 class="external">ports/textproc/mdocml</a>
  92                                                         </td>
  93                                                 </tr>
  94                                                 <tr>
  95                                                         <td>NetBSD</td>
  96                                                         <td>
  97                                                         <a href="http://cvsweb.netbsd.org/bsdweb.cgi/pkgsrc/textproc/mdocml/"
  98                                                                 class="external">pkgsrc/textproc/mdocml</a>
  99                                                         </td>
 100                                                 </tr>
 101                                                 <tr>
 102                                                         <td>OpenBSD</td>
 103                                                         <td>
 104                                                         <a href="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/"
 105                                                                 class="external">src/usr.bin/mandoc</a>
 106                                                         </td>
 107                                                 </tr>
 108                                         </tbody>
 109                                         </table>
 110
 111                                         <h2>
 112                                         Historical
 113                                         </h2>
 114
 115                                         <table width="100%">
 116                                         <col width="200">
 117                                         <col>
 118                                         <tbody>
 119                                                 <tr>
 120                                                         <td>Source archive</td>
 121                                                         <td>
 122                                                         <a href="/snapshots/">/snapshots/</a>
 123                                                         </td>
 124                                                 </tr>
 125                                                 <tr>
 126                                                         <td>FreeBSD port</td>
 127                                                         <td>
 128                                                         <a href="/ports-freebsd/">/ports-freebsd/</a>
 129                                                         </td>
 130                                                 </tr>
 131                                                 <tr>
 132                                                         <td>NetBSD pkgsrc</td>
 133                                                         <td>
 134                                                         <a href="/ports-netbsd/">/ports-netbsd/</a>
 135                                                         </td>
 136                                                 </tr>
 137                                                 <tr>
 138                                                         <td>OpenBSD port</td>
 139                                                         <td>
 140                                                         <a href="/ports-openbsd/">/ports-openbsd/</a>
 141                                                         </td>
 142                                                 </tr>
 143                                         </tbody>
 144                                         </table>
 145                                 </td>
 146                         </tr>
 147                         <tr>
 148                                 <td>
 149                                         <h1>
 150                                         DOCUMENTATION
 151                                         </h1>
 152
 153                                         <p>
 154                                         These manuals are generated automatically (with <a href="mandoc.1.txt">mandoc(1)</a>) and refer to the
 155                                         current snapshot.
 156                                         </p>
 157
 158                                         <table width="100%">
 159                                         <col width="200">
 160                                         <col>
 161                                         <tbody>
 162                                                 <tr>
 163                                                         <td><a href="mandoc.1.txt">mandoc(1)</a></td>
 164                                                         <td>format and display UNIX manuals</td>
 165                                                 </tr>
 166                                                 <tr>
 167                                                         <td><a href="mandoc_char.7.txt">mandoc_char(7)</a></td>
 168                                                         <td>mandoc special characters</td>
 169                                                 </tr>
 170                                                 <tr>
 171                                                         <td><a href="mdoc.7.txt">mdoc(7)</a></td>
 172                                                         <td>mdoc language reference</td>
 173                                                 </tr>
 174                                                 <tr>
 175                                                         <td><a href="man.7.txt">man(7)</a></td>
 176                                                         <td>man language reference</td>
 177                                                 </tr>
 178                                                 <tr>
 179                                                         <td><a href="manuals.7.txt">manuals(7)</a></td>
 180                                                         <td>a guide to writing UNIX manuals</td>
 181                                                 </tr>
 182                                                 <tr>
 183                                                         <td><a href="mdoc.3.txt">mdoc(3)</a></td>
 184                                                         <td>mdoc macro compiler library</td>
 185                                                 </tr>
 186                                                 <tr>
 187                                                         <td><a href="man.3.txt">man(3)</a></td>
 188                                                         <td>man macro compiler library</td>
 189                                                 </tr>
 190                                         </tbody>
 191                                         </table>
 192                                 </td>
 193                         </tr>
 194                         <tr>
 195                                 <td>
 196                                         <h1>
 197                                         CONTACT
 198                                         </h1>
 199
 200                                         <p>
 201                                         For all issues related to <span class="nm">mdocml</span>, contact Kristaps D&#382;onsons, kris<a
 202                                         class="external"
 203                                         href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&amp;c=sb5E6ulipc-eTnpTVqI-BQ=="
 204                                         title="Reveal this e-mail address">...</a>@kth.se.
 205                                         </p>
 206
 207                                         <p>
 208                                         If you want to receive a semi-automated mail-out of new releases, then please write with a message
 209                                         subject of <i>subscribe mdocml</i> (or <i>unsubscribe mdocml</i>).
 210                                         </p>
 211                                 </td>
 212                         </tr>
 213                         <tr>
 214                                 <td>
 215                                         <div class="foot">
 216                                                 Copyright &#169; 2008, 2009 Kristaps D&#382;onsons, $Date: 2009/07/17 13:23:26 $
 217                                         </div>
 218                                 </td>
 219                         </tr>
 220                 </tbody>
 221         </table>
 222         </body>
 223 </html>