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

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

version 1.5, 2009/02/24 12:20:52 version 1.17, 2009/06/11 13:34:14
Line 24 
Line 24 
                                         </h1>                                          </h1>
   
                                         <p>                                          <p>
                                         <span class="nm">mdocml</span> is a suite of tools that compile &#8220;mdoc&#8221;, the roff macro                                          <span class="nm">mdocml</span> is a suite of tools compiling &#8220;-mdoc&#8221;, the roff macro package
                                         package of the BSD manual pages.  The mission of <span class="nm">mdocml</span> is to deprecate <a                                          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
                                         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 BSD mdoc pages.  groff amounts to over 60 000 lines of GPL C++ source, which is a                                          displaying <a href="mdoc.7.txt" class="man">mdoc(7)</a> pages whilst providing token support for <a
                                         considerable encumbrance to BSD operating systems.                                          href="man.7.txt" class="man">man(7)</a>.
                                         </p>                                          </p>
   
                                         <p>                                          <p>
                                         The core of <span class="nm">mdocml</span> is the libmdoc library, a validating scanner-parser producing                                          What are UNIX manuals?  Read <a href="manuals.7.txt" class="man">manuals(7)</a> for an introduction.
                                         intermediate-form output from mdoc input.  libmdoc is a simple, fast library operating on memory buffers  
                                         of mdoc input.  Its intermediate output, an abstract syntax tree, is fully documented in the <span  
                                         class="man">mdoc(3)</span> reference manual.  
                                         </p>                                          </p>
   
                                         <p>                                          <p>
                                         There are three utilities implementing <span class="man">mdoc(3)</span>:                                          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>
   
                                         <ul>  
                                         <li><span class="man">mdocterm(1)</span> &#8211; formats mdoc input for display on the terminal  
                                         <li><span class="man">mdochtml(1)</span> &#8211; formats mdoc input as strict HTML (nascent)  
                                         <li><span class="man">mdoclint(1)</span> &#8211; validates mdoc input  
                                         <li><span class="man">mdoctree(1)</span> &#8211; prints input abstract syntax tree  
                                         </ul>  
   
                                         <p>                                          <p>
                                         The <span class="man">mdocterm(1)</span> utility is intended to deprecate usage of <a                                          The core of <span class="nm">mdocml</span> are the <a href="man.3.txt" class="man">man(3)</a> and <a
                                         href="http://www.gnu.org/software/groff/" class="external">groff</a> for displaying BSD manuals to the                                          href="mdoc.3.txt" class="man">mdoc(3)</a> libraries, validating compilers producing intermediate-form
                                         terminal, either directly or cached as a &#8220;catman&#8221; page.                                          output from -man or -mdoc input.  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).
                                         </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>                                          <p>
                                         <span class="attn">Please submit patches!</span> Although a significant implementation exists, work                                          <span class="attn">Please submit patches, bug reports and suggestions!</span> Although a significant
                                         remains for the backend library and especially the front-end utilities.  See the <a                                          implementation exists, work remains for the backend library and especially the front-end utilities.  See
                                         href="#contact">contact</a> information below to submit patches and bug reports.                                          the <a href="#contact">contact</a> information below for submissions.
                                         </p>                                          </p>
                                 </td>                                  </td>
                         </tr>                          </tr>
Line 69 
Line 69 
                                         </h1>                                          </h1>
   
                                         <p>                                          <p>
                                         Sources correctly build and install on OpenBSD, NetBSD and Linux operating systems, tested variously on                                          Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested
                                         i386, AMD64 and Alpha.                                          variously on i386, AMD64, alpha and others.
                                         </p>                                          </p>
   
                                           <p>
                                           The most current version is <span class="attn">@VERSION@</span>, dated
                                           <span class="attn">@VDATE@</span>.
                                           </p>
   
                                         <h2>                                          <h2>
                                         snapshotted source                                          Snapshot source
                                         </h2>                                          </h2>
   
                                         <p>                                          <p>
                                         CVS sources are checkedout and snapshotted with big updates.  These may be found in the <a                                          CVS sources are checkedout and snapshotted with version updates.  These may be found in the <a
                                         href="/snapshots/">/snapshots/</a> directory.                                          href="/snapshots/">/snapshots/</a> directory.  A full <a href="/snapshots/ChangeLog">ChangeLog</a> is
                                           written with each new snapshot.
                                         </p>                                          </p>
   
                                         <p class="boxed">                                          <p class="boxed">
                                         % cd /tmp<br>                                          % cd /tmp<br>
                                         % ftp -V -o- http://mdocml.bsd.lv/snapshots/mdocml.tar.gz | tar -zvxf -<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>                                          % cd mdocml<br>
                                         % make && make regress && make install                                          % make all<br>
                                           # make install
                                         </p>                                          </p>
   
                                         <h2>                                          <h2>
                                         nightly port                                          Snapshot port/pkgsrc
                                         </h2>                                          </h2>
   
                                         <p>                                          <p>
                                         The source snapshot is automatically converted into an OpenBSD port (ports for other BSD systems not                                          The source snapshot is automatically converted into OpenBSD, NetBSD and FreeBSD ports at <a
                                         yet available).  These may be found in the <a href="/ports-openbsd/">/ports-openbsd/</a> directory.                                          href="/ports-openbsd/">/ports-openbsd/</a>, <a href="/ports-netbsd/">/ports-netbsd/</a> and <a
                                         You <span class="emph">must</span> have the ports tree installed.                                          href="/ports-freebsd/">/ports-freebsd/</a>, respectively.  Please read the <a class="external"
                                           href="http://www.openbsd.org/faq/faq15.html">OpenBSD Ports FAQ</a>, the <a class="external"
                                           href="http://www.netbsd.org/docs/software/packages.html">NetBSD pkgsrc guide</a> or the <a
                                           class="external"
                                           href="http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ports-using.html">FreeBSD ports
                                           guide</a>, first.
                                         </p>                                          </p>
   
                                           <h3>
                                           OpenBSD port
                                           </h3>
   
                                         <p class="boxed">                                          <p class="boxed">
                                         % sudo pkg_delete mdocml<br>                                          # pkg_delete mdocml<br>
                                         % cd /usr/ports/devel/<br>                                          # cd /usr/ports/textproc/<br>
                                         % sudo rm -rf mdocml<br>                                          # rm -rf mdocml<br>
                                         % ftp -V -o- http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz | sudo tar -zvxf -<br>                                          # ftp -V -o- <a href="http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz">
                                         % cd mdocml<br>                                          http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz</a> | tar -zvxf -<br>
                                         % sudo make && sudo make regress && sudo make install                                          # cd mdocml<br>
                                           # make build<br>
                                           # make install
                                         </p>                                          </p>
   
                                           <h3>
                                           NetBSD pkgsrc
                                           </h3>
   
                                           <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>
   
                                           <h3>
                                           FreeBSD port
                                           </h3>
   
                                           <p class="boxed">
                                           # pkg_delete -x mdocml<br>
                                           # cd /tmp<br>
                                           # ftp -V -o- <a href="http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz">
                                           http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz</a> | tar -zvxf -<br>
                                           # cd mdocml<br>
                                           # make<br>
                                           # make install
                                           </p>
                                 </td>                                  </td>
                         </tr>                          </tr>
                         <tr>                          <tr>
Line 120 
Line 168 
                                         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==',                                          onclick="window.open('http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&amp;c=sb5E6ulipc-eTnpTVqI-BQ==',
                                         '', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=0,width=500,height=300'); return                                          '', '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.                                          false;" title="Reveal this e-mail address">...</a>@kth.se, with questions, bug reports, patches, and so
                                           on.
                                         </p>                                          </p>
   
                                         <p>                                          <p>
Line 132 
Line 181 
                         <tr>                          <tr>
                                 <td>                                  <td>
                                         <div class="foot">                                          <div class="foot">
                                                 Copyright &#169; 2009 Kristaps D&#382;onsons, $Date$                                                  Copyright &#169; 2008, 2009 Kristaps D&#382;onsons, $Date$
                                         </div>                                          </div>
                                 </td>                                  </td>
                         </tr>                          </tr>
Legend:
Removed from v.1.5  
changed lines
  Added in v.1.17
CVSweb