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

Diff for /mandoc/Attic/index.sgml between version 1.12 and 1.15

version 1.12, 2009/03/23 21:46:04 version 1.15, 2009/03/24 20:05:43
Line 24 
Line 24 
                                         </h1>                                          </h1>
   
                                         <p>                                          <p>
                                         <span class="nm">mdocml</span> is a suite of tools compiling &#8220;mdoc&#8221;, the roff macro                                          <span class="nm">mdocml</span> is a suite of tools compiling &#8220;-mdoc&#8221;, the roff macro
                                         package for BSD manual pages.  The mission of <span class="nm">mdocml</span> is to deprecate <a                                          package of choice for BSD manual pages.  The mission of <span class="nm">mdocml</span> is to deprecate
                                         href="http://www.gnu.org/software/groff/" class="external">groff</a>, the GNU roff implementation, for                                          <a href="http://www.gnu.org/software/groff/" class="external">groff</a>, the GNU roff implementation,
                                         displaying BSD mdoc pages.                                          for displaying -mdoc pages.
                                         </p>                                          </p>
   
                                         <p>                                          <p>
                                         Why?  groff amounts to roughly 5,2 MB of source code (OpenBSD 4.2), some of which is C++ and all of                                          Why?  groff amounts to over 5 MB of source code, most of which is C++ and all of which is GPL.  It runs
                                         which is GPL.  It runs slowly, produces uncertain output, and varies in operation from system                                          slowly, produces uncertain output, and varies in operation from system to system.  mdocml strives to fix
                                         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> is the libmdoc library, a validating scanner-parser producing                                          The core of <span class="nm">mdocml</span> is the libmdoc library, a validating scanner-parser producing
                                         intermediate-form output from mdoc input.  libmdoc is a simple, fast library operating on memory buffers                                          intermediate-form output from -mdoc input.  libmdoc is a simple, fast library operating on memory
                                         of mdoc input.  Its intermediate output, an abstract syntax tree, is fully documented in the <span                                          buffers, so it can be used for a variety of front-ends (terminal-based, CGI and so on).
                                         class="man">mdoc(3)</span> reference manual.  
                                         </p>                                          </p>
   
                                         <p>                                          <p>
                                         There are three utilities implementing <span class="man">mdoc(3)</span>:                                          The primary front-end is <span class="man">mandoc(1)</span>, which formats -mdoc manuals for display on
                                           the terminal.  The <span class="man">mandoc(1)</span> utility is intended to deprecate usage of <a
                                           href="http://www.gnu.org/software/groff/" class="external">groff</a> for displaying mdoc manuals on the
                                           terminal.
                                         </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 HTML/CSS (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                                          <span class="attn">Please submit patches, bug reports and suggestions!</span> Although a significant
                                         href="http://www.gnu.org/software/groff/" class="external">groff</a> for displaying BSD manuals to the                                          implementation exists, work remains for the backend library and especially the front-end utilities.  See
                                         terminal, either directly or cached as a &#8220;catman&#8221; page.                                          the <a href="#contact">contact</a> information below for submissions.
                                         </p>                                          </p>
   
                                         <p>  
                                         <span class="attn">Please submit patches!</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 to submit patches and bug reports.  
                                         </p>  
                                 </td>                                  </td>
                         </tr>                          </tr>
                         <tr>                          <tr>
Line 74 
Line 63 
                                         </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>                                          <p>
Line 108 
Line 97 
                                         <p>                                          <p>
                                         The source snapshot is automatically converted into OpenBSD, NetBSD and FreeBSD ports at <a                                          The source snapshot is automatically converted into OpenBSD, NetBSD and FreeBSD ports at <a
                                         href="/ports-openbsd/">/ports-openbsd/</a>, <a href="/ports-netbsd/">/ports-netbsd/</a> and <a                                          href="/ports-openbsd/">/ports-openbsd/</a>, <a href="/ports-netbsd/">/ports-netbsd/</a> and <a
                                         href="/ports-freebsd/">/ports-freebsd/</a>, respectively.  Please read the <a                                          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>, <a                                          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 <a                                          href="http://www.netbsd.org/docs/software/packages.html">NetBSD pkgsrc guide</a> or the <a
                                         href="http://www.freebsd.org/ports/">FreeBSD Ports Guide</a> first.                                          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>                                          <h3>
Line 147 
Line 138 
                                         </h3>                                          </h3>
   
                                         <p class="boxed">                                          <p class="boxed">
                                         # pkg_delete mdocml<br>                                          # pkg_delete -x mdocml<br>
                                         # cd /usr/ports/textproc/<br>                                          # cd /tmp<br>
                                         # rm -rf mdocml<br>  
                                         # ftp -V -o- http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz | tar -zvxf -<br>                                          # ftp -V -o- http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz | tar -zvxf -<br>
                                         # cd mdocml<br>                                          # cd mdocml<br>
                                         # make build<br>                                          # make<br>
                                         # make install                                          # make install
                                         </p>                                          </p>
                                 </td>                                  </td>
Line 168 
Line 158 
                                         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 180 
Line 171 
                         <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.12  
changed lines
  Added in v.1.15
CVSweb