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

Diff for /mandoc/Attic/index.sgml between version 1.17 and 1.27

version 1.17, 2009/06/11 13:34:14 version 1.27, 2009/07/20 20:09:49
Line 7 
Line 7 
                 <title>mdocml.bsd.lv</title>                  <title>mdocml.bsd.lv</title>
         </head>          </head>
         <body>          <body>
         <table width="600">          <table class="frame">
                 <col width="100%">                  <col width="100%">
                 <tbody>                  <tbody>
                         <tr>                          <tr>
Line 28 
Line 28 
                                         of choice for BSD manual pages, and &#8220;-man&#8221;, the predominant historical package for UNIX                                          of choice for BSD manual pages, and &#8220;-man&#8221;, the predominant historical package for UNIX
                                         manuals.  The mission of <span class="nm">mdocml</span> is to deprecate <a                                          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                                          href="http://www.gnu.org/software/groff/" class="external">groff</a>, the GNU roff implementation, for
                                         displaying <a href="mdoc.7.txt" class="man">mdoc(7)</a> pages whilst providing token support for <a                                          displaying -mdoc pages whilst providing token support for -man.
                                         href="man.7.txt" class="man">man(7)</a>.  
                                         </p>                                          </p>
   
                                         <p>                                          <p>
                                         What are UNIX manuals?  Read <a href="manuals.7.txt" class="man">manuals(7)</a> for an introduction.  
                                         </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                                          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                                          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).                                          this (respectively small, C, ISC-licensed, fast and regular).
                                         </p>                                          </p>
   
                                         <p>                                          <p>
                                         The core of <span class="nm">mdocml</span> are the <a href="man.3.txt" class="man">man(3)</a> and <a                                          The core of <span class="nm">mdocml</span> is composed of the <i>libmdoc</i> and <i>libman</i>
                                         href="mdoc.3.txt" class="man">mdoc(3)</a> libraries, validating compilers producing intermediate-form                                          validating compiler libraries.  Both are simple, fast libraries operating on memory buffers, so they may
                                         output from -man or -mdoc input.  Both are simple, fast libraries operating on memory buffers, so they                                          be used for a variety of front-ends (terminal-based, CGI and so on).  The primary front-end is <i>
                                         may be used for a variety of front-ends (terminal-based, CGI and so on).                                          mandoc</i>, which formats manuals for display on the terminal.
                                         </p>                                          </p>
   
                                         <p>  
                                         The primary front-end is <a href="mandoc.1.txt" class="man">mandoc(1)</a>, which formats manuals for  
                                         display on the terminal.  Its purpose is to deprecate usage of groff for displaying -mdoc and, to a  
                                         limited extent, -man manuals on the terminal.  
                                         </p>  
   
                                         <p>  
                                         <span class="attn">Please submit patches, bug reports and suggestions!</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 for submissions.  
                                         </p>  
                                 </td>                                  </td>
                         </tr>                          </tr>
                         <tr>                          <tr>
                                 <td>                                  <td>
                                         <h1>                                          <h1>
                                         INSTALLING SOURCES                                          DOWNLOADS
                                         </h1>                                          </h1>
   
                                         <p>                                          <p>
                                         Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested                                          Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested
                                         variously on i386, AMD64, alpha and others.                                          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> is written with each release.
                                         </p>                                          </p>
   
                                         <p>  
                                         The most current version is <span class="attn">@VERSION@</span>, dated  
                                         <span class="attn">@VDATE@</span>.  
                                         </p>  
   
                                         <h2>                                          <h2>
                                         Snapshot source                                          Current
                                         </h2>                                          </h2>
   
                                         <p>                                          <table width="100%">
                                         CVS sources are checkedout and snapshotted with version updates.  These may be found in the <a                                          <col width="200">
                                         href="/snapshots/">/snapshots/</a> directory.  A full <a href="/snapshots/ChangeLog">ChangeLog</a> is                                          <col>
                                         written with each new snapshot.                                          <tbody>
                                         </p>                                                  <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>
                                           </tbody>
                                           </table>
   
                                         <p class="boxed">  
                                         % cd /tmp<br>  
                                         % ftp -V -o- <a href="http://mdocml.bsd.lv/snapshots/mdocml.tar.gz">  
                                         http://mdocml.bsd.lv/snapshots/mdocml.tar.gz</a> | tar -zvxf -<br>  
                                         % cd mdocml<br>  
                                         % make all<br>  
                                         # make install  
                                         </p>  
   
                                         <h2>                                          <h2>
                                         Snapshot port/pkgsrc                                          Downstream
                                         </h2>                                          </h2>
   
                                         <p>                                          <table width="100%">
                                         The source snapshot is automatically converted into OpenBSD, NetBSD and FreeBSD ports at <a                                          <col width="200">
                                         href="/ports-openbsd/">/ports-openbsd/</a>, <a href="/ports-netbsd/">/ports-netbsd/</a> and <a                                          <col>
                                         href="/ports-freebsd/">/ports-freebsd/</a>, respectively.  Please read the <a class="external"                                          <tbody>
                                         href="http://www.openbsd.org/faq/faq15.html">OpenBSD Ports FAQ</a>, the <a class="external"                                                  <tr>
                                         href="http://www.netbsd.org/docs/software/packages.html">NetBSD pkgsrc guide</a> or the <a                                                          <td>FreeBSD</td>
                                         class="external"                                                          <td>
                                         href="http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ports-using.html">FreeBSD ports                                                          <a href="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/"
                                         guide</a>, first.                                                                  class="external">ports/textproc/mdocml</a>
                                         </p>                                                          </td>
                                                   </tr>
                                                   <tr>
                                                           <td>NetBSD</td>
                                                           <td>
                                                           <a href="http://cvsweb.netbsd.org/bsdweb.cgi/pkgsrc/textproc/mdocml/"
                                                                   class="external">pkgsrc/textproc/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>
   
                                         <h3>                                          <h2>
                                         OpenBSD port                                          Historical
                                         </h3>                                          </h2>
   
                                         <p class="boxed">                                          <table width="100%">
                                         # pkg_delete mdocml<br>                                          <col width="200">
                                         # cd /usr/ports/textproc/<br>                                          <col>
                                         # rm -rf mdocml<br>                                          <tbody>
                                         # ftp -V -o- <a href="http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz">                                                  <tr>
                                         http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz</a> | tar -zvxf -<br>                                                          <td>Source archive</td>
                                         # cd mdocml<br>                                                          <td>
                                         # make build<br>                                                          <a href="/snapshots/">/snapshots/</a>
                                         # make install                                                          </td>
                                         </p>                                                  </tr>
                                           </tbody>
                                           </table>
                                   </td>
                           </tr>
                           <tr>
                                   <td>
                                           <h1>
                                           DOCUMENTATION
                                           </h1>
   
                                         <h3>                                          <p>
                                         NetBSD pkgsrc                                          These manuals are generated automatically (with <a href="mandoc.1.txt">mandoc(1)</a>) and refer to the
                                         </h3>                                          current snapshot.
   
                                         <p class="boxed">  
                                         # pkg_delete mdocml<br>  
                                         # cd /usr/pkgsrc/textproc/<br>  
                                         # rm -rf mdocml<br>  
                                         # ftp -V -o- <a href="http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz">  
                                         http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz</a> | tar -zvxf -<br>  
                                         # cd mdocml<br>  
                                         # make build<br>  
                                         # make install  
                                         </p>                                          </p>
   
                                         <h3>                                          <table width="100%">
                                         FreeBSD port                                          <col width="200">
                                         </h3>                                          <col>
                                           <tbody>
                                         <p class="boxed">                                                  <tr>
                                         # pkg_delete -x mdocml<br>                                                          <td><a href="mandoc.1.txt">mandoc(1)</a></td>
                                         # cd /tmp<br>                                                          <td>format and display UNIX manuals</td>
                                         # ftp -V -o- <a href="http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz">                                                  </tr>
                                         http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz</a> | tar -zvxf -<br>                                                  <tr>
                                         # cd mdocml<br>                                                          <td><a href="mandoc_char.7.txt">mandoc_char(7)</a></td>
                                         # make<br>                                                          <td>mandoc special characters</td>
                                         # make install                                                  </tr>
                                         </p>                                                  <tr>
                                                           <td><a href="mdoc.7.txt">mdoc(7)</a></td>
                                                           <td>mdoc language reference</td>
                                                   </tr>
                                                   <tr>
                                                           <td><a href="man.7.txt">man(7)</a></td>
                                                           <td>man language reference</td>
                                                   </tr>
                                                   <tr>
                                                           <td><a href="manuals.7.txt">manuals(7)</a></td>
                                                           <td>a guide to writing UNIX manuals</td>
                                                   </tr>
                                                   <tr>
                                                           <td><a href="mdoc.3.txt">mdoc(3)</a></td>
                                                           <td>mdoc macro compiler library</td>
                                                   </tr>
                                                   <tr>
                                                           <td><a href="man.3.txt">man(3)</a></td>
                                                           <td>man macro compiler library</td>
                                                   </tr>
                                           </tbody>
                                           </table>
                                 </td>                                  </td>
                         </tr>                          </tr>
                         <tr>                          <tr>
Line 164 
Line 180 
                                         </h1>                                          </h1>
   
                                         <p>                                          <p>
                                         Please contact Kristaps, kris<a class="external"                                          For all issues related to <span class="nm">mdocml</span>, contact Kristaps D&#382;onsons, kris<a
                                           class="external"
                                         href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&amp;c=sb5E6ulipc-eTnpTVqI-BQ=="                                          href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&amp;c=sb5E6ulipc-eTnpTVqI-BQ=="
                                         onclick="window.open('http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&amp;c=sb5E6ulipc-eTnpTVqI-BQ==',                                          title="Reveal this e-mail address">...</a>@kth.se.
                                         '', '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>
   
                                         <p>                                          <p>
                                         If you'd like to submit patches, please contact us beforehand in case larger changes are pending but not                                          If you want to receive a semi-automated mail-out of new releases, then please write with a message
                                         checked in.  If making a bug report, please make sure it's repeatable on the most current snapshot.                                          subject of <i>subscribe mdocml</i> (or <i>unsubscribe mdocml</i>).
                                         </p>                                          </p>
                                 </td>                                  </td>
                         </tr>                          </tr>
Legend:
Removed from v.1.17  
changed lines
  Added in v.1.27
CVSweb