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

Diff for /mandoc/Attic/index.sgml between version 1.154.2.11 and 1.154.2.16

version 1.154.2.11, 2013/10/13 18:32:44 version 1.154.2.16, 2013/12/31 17:49:37
Line 7 
Line 7 
         </HEAD>          </HEAD>
         <BODY>          <BODY>
                 <P CLASS="head">                  <P CLASS="head">
                           <A HREF="http://www.openbsd.org/"><IMG SRC="puffy.gif" ALT="Puffy" WIDTH="100" HEIGHT="91" STYLE="float: right"></A>
                         <B>mdocml</B> &#8211; UNIX manpage compiler, current version @VERSION@ (@VDATE@)                          <B>mdocml</B> &#8211; UNIX manpage compiler, current version @VERSION@ (@VDATE@)
                 </P>                  </P>
                 <P CLASS="subhead">                  <P CLASS="subhead">
Line 20 
Line 21 
                 <P>                  <P>
                         <SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <I><A HREF="mdoc.7.html">mdoc</A></I>, the roff macro                          <SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <I><A HREF="mdoc.7.html">mdoc</A></I>, the roff macro
                         package of choice for BSD manual pages, and <I><A HREF="man.7.html">man</A></I>, the predominant historical package for                          package of choice for BSD manual pages, and <I><A HREF="man.7.html">man</A></I>, the predominant historical package for
                         UNIX manuals.  The mission of <SPAN CLASS="nm">mdocml</SPAN> is to deprecate <A                          UNIX manuals.
                         HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU troff implementation, for displaying <I>mdoc</I>                          It is small, ISO C, <A CLASS="external" HREF="https://www.isc.org/downloads/software-support-policy/isc-license/">ISC</A>-licensed, and quite fast.
                         pages whilst providing token support for <I>man</I>.  
                 </P>                  </P>
                 <P>                  <P>
                         Why?  groff amounts to over 5 MB of source code, most of which is C++ and GPL version 3.  It runs slowly, produces                          The tool set features <A HREF="mandoc.1.html">mandoc</A>,
                         uncertain output, and varies in operation from system to system.  mdocml strives to fix this (respectively small, C, <A                          based on the <A HREF="mandoc.3.html">libmandoc</A> validating compiler,
                         CLASS="external" HREF="http://www.isc.org/software/license">ISC</A>-licensed, fast and regular).                          to format output for UNIX terminals (with
                 </P>  
                 <P>  
                         <SPAN CLASS="nm">mdocml</SPAN> consists of the <A HREF="mandoc.3.html">libmandoc</A> validating compiler and <A  
                         HREF="mandoc.1.html">mandoc</A>, which interfaces with the compiler library to format output for UNIX terminals (with  
                         support for wide-character locales), XHTML, HTML, PostScript, and PDF.                          support for wide-character locales), XHTML, HTML, PostScript, and PDF.
                         It also includes <A HREF="preconv.1.html">preconv</A>, for recoding multibyte manuals;                          It also includes <A HREF="preconv.1.html">preconv</A>, for recoding multibyte manuals;
                         <A HREF="demandoc.1.html">demandoc</A>, for emitting only text parts of manuals;                          <A HREF="demandoc.1.html">demandoc</A>, for emitting only text parts of manuals;
                         <A HREF="mandocdb.8.html">mandocdb</A>, for indexing manuals; and                          <A HREF="mandocdb.8.html">mandocdb</A>, for indexing manuals; and
                         <A HREF="apropos.1.html">apropos</A>, <A HREF="whatis.1.html">whatis</A>, and                          <A HREF="apropos.1.html">apropos</A>, <A HREF="whatis.1.html">whatis</A>, and
                         <A HREF="man.cgi.7.html">man.cgi</A> (via <A HREF="catman.8.html">catman</A>) for semantic search of manual content.                          <A HREF="man.cgi.7.html">man.cgi</A> (via <A HREF="catman.8.html">catman</A>) for semantic search of manual content.
                         It is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project.  
                 </P>                  </P>
                 <P>                  <P>
                           <SPAN CLASS="nm">mdocml</SPAN> has predominantly been developed on OpenBSD
                           and is both an <A CLASS="external" HREF="http://www.openbsd.org/">OpenBSD</A>
                           and a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project.
                           We strive to support all interested free operating systems, in particular
                           <A CLASS="external" HREF="http://www.dragonflybsd.org/">DragonFly</A>,
                           <A CLASS="external" HREF="http://www.netbsd.org/">NetBSD</A>,
                           <A CLASS="external" HREF="http://www.freebsd.org/">FreeBSD</A>,
                           <A CLASS="external" HREF="http://www.minix3.org/">Minix 3</A>,
                           and <A CLASS="external" HREF="http://www.gnu.org/">GNU</A>/Linux,
                           as well as all systems running the <A CLASS="external" HREF="http://www.pkgsrc.org/">pkgsrc</A> portable package build system.
                           All of these projects have helped to make <SPAN CLASS="nm">mdocml</SPAN> better, by providing feedback and advice,
                           bug reports, and patches.
                   </P>
                   <P>
                         <I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, <Q>mandoc</Q>.                          <I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, <Q>mandoc</Q>.
                 </P>                  </P>
                 <H2>                  <H2>
                         <A NAME="sources">Sources</A>                          <A NAME="sources">Sources</A>
                 </H2>                  </H2>
                 <P>                  <P>
                         <SPAN CLASS="nm">mdocml</SPAN> is in plain-old ANSI C and should build and run on any modern system; however, you'll                          <SPAN CLASS="nm">mdocml</SPAN> should build and run on any modern system with
                         need <A HREF="http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html">libdb</A> to build <A                          <A HREF="http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html">libdb</A>
                         HREF="apropos.1.html">apropos</A>, <A HREF="whatis.1.html">whatis</A>, <A HREF="man.cgi.7.html">man.cgi</A>, <A                          (this is installed by default on BSD UNIX systems &mdash; see the <I>Makefile</I> if you're running Linux).
                         HREF="catman.8.html">catman</A>, and <A HREF="mandocdb.8.html">mandocdb</A> (this is installed by default on BSD UNIX                          To build and install into <I>/usr/local/</I>, just run <CODE>make install</CODE>.
                         systems &mdash; see the <I>Makefile</I> if you're running Linux).  To build and install into <I>/usr/local/</I>, just                          Be careful: the <B>preconv</B>, <B>apropos</B>, and <B>whatis</B> installed binary names
                         run <CODE>make install</CODE>.  Be careful: the <B>preconv</B>, <B>apropos</B>, and <B>whatis</B> binary names are                          may be taken by existing utilities.
                         usually taken by existing utilities.  
                 </P>                  </P>
                 <H2>                  <H2>
                         Downstream                          Downstream
Line 61 
Line 69 
                 <P>                  <P>
                         Several systems come bundled with <SPAN CLASS="nm">mdocml</SPAN> utilities.                          Several systems come bundled with <SPAN CLASS="nm">mdocml</SPAN> utilities.
                         If your system does not appear below, the maintainers have not contacted me and it should not be considered                          If your system does not appear below, the maintainers have not contacted me and it should not be considered
                         <Q>official</Q>.                          <Q>official</Q>, so please <A HREF="#contact">contact us</A> if you plan on maintaining a downstream version!
                         Please <A HREF="#contact">contact us</A> if you plan on maintaining a downstream version!  
                 </P>                  </P>
                 <TABLE WIDTH="100%" SUMMARY="Downstream Sources">                  <TABLE WIDTH="100%" SUMMARY="Downstream Sources">
                         <COL WIDTH="175">                          <COL WIDTH="175">
Line 71 
Line 78 
                                 <TR>                                  <TR>
                                         <TD>DragonFly BSD</TD>                                          <TD>DragonFly BSD</TD>
                                         <TD>                                          <TD>
                                         <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/contrib/mdocml" CLASS="external">contrib/mdocml</A> (1.12.2 sources)                                          <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/contrib/mdocml" CLASS="external">contrib/mdocml</A> (1.12.3 sources)
                                         <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/lib/libmandoc" CLASS="external">lib/libmandoc</A>                                          <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/lib/libmandoc" CLASS="external">lib/libmandoc</A>
                                         <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc" CLASS="external">usr.bin/mandoc</A> (build system)                                          <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc" CLASS="external">usr.bin/mandoc</A> (build system)
                                         </TD>                                          </TD>
Line 86 
Line 93 
                                 <TR>                                  <TR>
                                         <TD>FreeBSD 9.x, 8.x</TD>                                          <TD>FreeBSD 9.x, 8.x</TD>
                                         <TD>                                          <TD>
                                         <A HREF="http://svnweb.freebsd.org/ports/head/textproc/mdocml/" CLASS="external">ports/textproc/mdocml</A> (1.12.1 port)                                          <A HREF="http://svnweb.freebsd.org/ports/head/textproc/mdocml/" CLASS="external">ports/textproc/mdocml</A> (1.12.2 port)
                                         </TD>                                          </TD>
                                 </TR>                                  </TR>
                                 <TR>                                  <TR>
Line 98 
Line 105 
                                 <TR>                                  <TR>
                                         <TD>OpenBSD</TD>                                          <TD>OpenBSD</TD>
                                         <TD>                                          <TD>
                                         <A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/" CLASS="external">src/usr.bin/mandoc</A> (1.12.2 sources and build system)                                          <A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/" CLASS="external">src/usr.bin/mandoc</A> (1.12.3 sources under active development and build system)
                                         </TD>                                          </TD>
                                 </TR>                                  </TR>
                                 <TR>                                  <TR>
                                         <TD>pkgsrc</TD>                                          <TD>pkgsrc</TD>
                                         <TD>                                          <TD>
                                         <A HREF="http://pkgsrc.se/textproc/mdocml" CLASS="external">textproc/mdocml</A> (1.12.2 port)                                          <A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/pkgsrc/textproc/mdocml/" CLASS="external">textproc/mdocml</A> (1.12.3 port)
                                         </TD>                                          </TD>
                                 </TR>                                  </TR>
                                 <TR>                                  <TR>
Line 297 
Line 304 
                         <A NAME="news">News</A>                          <A NAME="news">News</A>
                 </H1>                  </H1>
                 <P CLASS="news">                  <P CLASS="news">
                           31-12-2013: version 1.12.3
                   </P>
                   <P>
                           In the <A HREF="mdoc.7.html">mdoc(7)</A> SYNOPSIS, line breaks and hanging indentation
                           now work correctly for .Fo/.Fa/.Fc and .Fn blocks.
                           Thanks to Franco Fichtner for doing part of the work.
                   </P>
                   <P>
                           The <A HREF="mdoc.7.html">mdoc(7)</A> .Bk macro got some addititonal bugfixes.
                   </P>
                   <P>
                           In <A HREF="mdoc.7.html">mdoc(7)</A> macro arguments, double quotes can now be quoted
                           by doubling them, just like in <A HREF="man.7.html">man(7)</A>.
                           Thanks to Tsugutomo ENAMI for the patch.
                   </P>
                   <P>
                           At the end of <A HREF="man.7.html">man(7)</A> macro lines, end-of-sentence spacing
                           now works.  Thanks to Franco Fichtner for the patch.
                   </P>
                   <P>
                           For backward compatibility, the <A HREF="man.7.html">man(7)</A> parser now supports the
                           man-ext .UR/.UE (uniform resource identifier) block macros.
                   </P>
                   <P>
                           The <A HREF="man.7.html">man(7)</A> parser now handles closing blocks that are not open
                           more gracefully.
                   </P>
                   <P>
                           The <A HREF="man.7.html">man(7)</A> parser now ignores blank lines right after .SH and .SS.
                   </P>
                   <P>
                           In the <A HREF="man.7.html">man(7)</A> formatter, reset indentation when leaving a block,
                           not just when entering the next one.
                   </P>
                   <P>
                           The <A HREF="roff.7.html">roff(7)</A> .nr request now supports incrementing and decrementing
                           number registers and stops parsing the number right before the first non-digit character.
                   </P>
                   <P>
                           The <A HREF="roff.7.html">roff(7)</A> parser now supports the alternative escape sequence
                           syntax \C'uXXXX' for Unicode characters.
                   </P>
                   <P>
                           The <A HREF="roff.7.html">roff(7)</A> parser now parses and ignores the .fam (font family)
                           and .hw (hyphenation points) requests and the \d and \u escape sequences.
                   </P>
                   <P>
                           The <A HREF="roff.7.html">roff(7)</A> manual got a new ESCAPE SEQUENCE REFERENCE.
                   </P>
                   <P CLASS="news">
                         05-10-2013: version 1.12.2                          05-10-2013: version 1.12.2
                 </P>                  </P>
                 <P>                  <P>
Line 338 
Line 395 
                 <P>                  <P>
                         For mandoc developers, we now provide a <A HREF="tbl.3.html">tbl(3)</A> library manual and <CODE>gmdiff</CODE>,                          For mandoc developers, we now provide a <A HREF="tbl.3.html">tbl(3)</A> library manual and <CODE>gmdiff</CODE>,
                         a very small, very simplistic groff-versus-mandoc output comparison tool.                          a very small, very simplistic groff-versus-mandoc output comparison tool.
                 </P>  
                 <P CLASS="news">  
                         23-03-2012: version 1.12.1  
                 </P>  
                 <P>  
                         Significant work on <A HREF="apropos.1.html">apropos</A> and <A HREF="mandocdb.8.html">mandocdb</A>.  These tools are  
                         now much more robust.  
                         A <A HREF="whatis.1.html">whatis</A> implementation is now handled as an <A HREF="apropos.1.html">apropos</A> mode.  
                         These tools are also able to minimally handle pre-formatted pages, that is, those already formatted by another utility  
                         such as GNU troff.  
                 </P>  
                 <P>  
                         The <A HREF="man.cgi.7.html">man.cgi</A> script is also now available for wider testing.  It interfaces with <A  
                         HREF="mandocdb.8.html">mandocdb</A> manuals cached by <A HREF="catman.8.html">catman</A>.  HTML output is generated  
                         on-the-fly by <A HREF="mandoc.3.html">libmandoc</A> or internal methods to convert pre-formatted pages.  
                 </P>  
                 <P>  
                         The mailing list archive for the discuss and tech lists are being hosted by <A CLASS="external"  
                         HREF="http://www.gmane.org">Gmane</A> at <A HREF="http://dir.gmane.org/gmane.comp.tools.mdocml.user"  
                         CLASS="external">gmane.comp.tools.mdocml.user</A> and <A HREF="http://dir.gmane.org/gmane.comp.tools.mdocml.devel"  
                         CLASS="external">gmane.comp.tools.mdocml.devel</A>, respectively.  
                 </P>  
                 <P>  
                         Lastly, I'm no longer providing binaries, as nobody has asked for them.  
                 </P>                  </P>
                 <H2>                  <H2>
                         <A>History</A>                          <A>History</A>
Legend:
Removed from v.1.154.2.11  
changed lines
  Added in v.1.154.2.16
CVSweb