In SYNOPSIS mode, .Ek doesn't end a keep.

[mandoc.git] / index.sgml

diff --git a/index.sgml b/index.sgml
index aade7e37661663ccfcac4db45f45f5b986909ee2..23269e801ffe90e8b7d95857131be658b5ef59f0 100644 (file)
--- a/index.sgml
+++ b/index.sgml
@@ -13,12 +13,6 @@
                        Sources: <A HREF="/snapshots/mdocml.tar.gz">current</A>,
                        <A HREF="/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A>
                        (<A HREF="/snapshots/">archives</A>)
                        Sources: <A HREF="/snapshots/mdocml.tar.gz">current</A>,
                        <A HREF="/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A>
                        (<A HREF="/snapshots/">archives</A>)

-                       |
-                       Binaries: <A
-                       HREF="/binaries/mdocml-win32.zip">windows 32-bit</A>, <A
-                       HREF="/binaries/mdocml-win64.zip">windows 64-bit</A>, <A
-                       HREF="/binaries/mdocml-macosx.zip">mac os x</A>
-                       (<A HREF="/binaries/">archives</A>)

                </P>
                <H1>
                        <A NAME="description">Description</A>
                </P>
                <H1>
                        <A NAME="description">Description</A>


@@ -39,11 +33,11 @@
                        <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.  
                        <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.  

-                       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="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="man.cgi.7.html">man.cgi</A> (via <A HREF="catman.8.html">catman</A>) for semantic search of manual content.
+                       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="mandocdb.8.html">mandocdb</A> for indexing manuals,
+                       <A HREF="apropos.1.html">apropos</A> (includes whatis mode) for indexed manual search, and
+                       <A HREF="man.cgi.7.html">man.cgi</A> for indexed manual search online.

                        It is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project.  
                </P>
                <P>
                        It is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project.  
                </P>
                <P>


@@ -53,22 +47,11 @@
                        <A NAME="sources">Sources</A>
                </H2>
                <P>
                        <A NAME="sources">Sources</A>
                </H2>
                <P>

-                       <SPAN CLASS="nm">mdocml</SPAN> is in plain-old ANSI C and should build and run on any modern system; however, you'll
-                       need <A HREF="http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html">libdb</A> to build <A
-                       HREF="apropos.1.html">apropos</A>, <A HREF="whatis.1.html">whatis</A>, <A HREF="man.cgi.7.html">man.cgi</A>, <A
-                       HREF="catman.8.html">catman</A>, and <A HREF="mandocdb.8.html">mandocdb</A> (this is installed by default on BSD UNIX
-                       systems &mdash; see the <I>Makefile</I> if you're running Linux).  To build and install into <I>/usr/local/</I>, just
-                       run <CODE>make install</CODE>.  Be careful: the <B>preconv</B>, <B>apropos</B>, and <B>whatis</B> binary names are
-                       usually taken by existing utilities.
-               </P>
-               <H2>
-                       <A NAME="binaries">Binaries</A>
-               </H2>
-               <P>
-                       Binary archives consist of pre-compiled binaries, manuals, and other necessary files.
-                       Universal (Mac OS X) binaries are compiled for the PCC, i386, and x86_64 architectures.
-                       Windows binaries are compiled with <A CLASS="external" HREF="http://www.mingw.org">MingW</A> for the 32-bit (i686) and
-                       64-bit (x86_64) architectures.
+                       <SPAN CLASS="nm">mdocml</SPAN> is in ISO C99 and should build and run on any modern system; however, you'll need <A
+                       HREF="http://www.sqlite.org">sqlite3</A> to build <A HREF="apropos.1.html">apropos</A> (links to whatis), 
+                       <A HREF="man.cgi.7.html">man.cgi</A>, and <A HREF="mandocdb.8.html">mandocdb</A>.  
+                       To build and install into <I>/usr/local/</I>, just run <CODE>make install</CODE>.  
+                       Be careful: the <B>preconv</B>, <B>apropos</B>, and <B>whatis</B> binary names are usually taken by existing utilities.

                </P>
                <H2>
                        Downstream
                </P>
                <H2>
                        Downstream


@@ -86,29 +69,25 @@
                                <TR>
                                        <TD>DragonFly BSD</TD>
                                        <TD>
                                <TR>
                                        <TD>DragonFly BSD</TD>
                                        <TD>

-                                       <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc"
-                                               CLASS="external">usr.bin/mandoc</A>
+                                       <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc" CLASS="external">usr.bin/mandoc</A>

                                        </TD>
                                </TR>
                                <TR>
                                        <TD>FreeBSD</TD>
                                        <TD>
                                        </TD>
                                </TR>
                                <TR>
                                        <TD>FreeBSD</TD>
                                        <TD>

-                                       <A HREF="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/" 
-                                               CLASS="external">ports/textproc/mdocml</A>
+                                       <A HREF="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/" CLASS="external">ports/textproc/mdocml</A>

                                        </TD>
                                </TR>
                                <TR>
                                        <TD>NetBSD</TD>
                                        <TD>
                                        </TD>
                                </TR>
                                <TR>
                                        <TD>NetBSD</TD>
                                        <TD>

-                                       <A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/"
-                                               CLASS="external">src/external/bsd/mdocml</A>
+                                       <A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/" CLASS="external">src/external/bsd/mdocml</A>

                                        </TD>
                                </TR>
                                <TR>
                                        <TD>OpenBSD</TD>
                                        <TD>
                                        </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> 
+                                       <A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/" CLASS="external">src/usr.bin/mandoc</A> 

                                        </TD>
                                </TR>
                                <TR>
                                        </TD>
                                </TR>
                                <TR>


@@ -117,6 +96,12 @@
                                        <A HREF="http://pkgsrc.se/textproc/mdocml" CLASS="external">textproc/mdocml</A> 
                                        </TD>
                                </TR>
                                        <A HREF="http://pkgsrc.se/textproc/mdocml" CLASS="external">textproc/mdocml</A> 
                                        </TD>
                                </TR>

+                               <TR>
+                                       <TD>Minix3</TD>
+                                       <TD>
+                                       <A HREF="http://git.minix3.org/?p=minix.git;a=tree;f=external/bsd/mdocml" CLASS="external">external/bsd/mdocml</A>
+                                       </TD>
+                               </TR>

                        </TBODY>
                </TABLE>
                <H1>
                        </TBODY>
                </TABLE>
                <H1>


@@ -135,150 +120,78 @@
                                        <TD VALIGN="top"><A HREF="apropos.1.html">apropos(1)</A></TD>
                                        <TD VALIGN="top">
                                                search the manual page database
                                        <TD VALIGN="top"><A HREF="apropos.1.html">apropos(1)</A></TD>
                                        <TD VALIGN="top">
                                                search the manual page database

-                                                       (<A HREF="apropos.1.txt">text</A> | 
-                                                       <A HREF="apropos.1.xhtml">xhtml</A> |
-                                                       <A HREF="apropos.1.pdf">pdf</A> |
-                                                       <A HREF="apropos.1.ps">ps</A>)

                                        </TD>
                                </TR>
                                <TR>
                                        <TD VALIGN="top"><A HREF="demandoc.1.html">demandoc(1)</A></TD>
                                        <TD VALIGN="top">
                                                emit only text of UNIX manuals
                                        </TD>
                                </TR>
                                <TR>
                                        <TD VALIGN="top"><A HREF="demandoc.1.html">demandoc(1)</A></TD>
                                        <TD VALIGN="top">
                                                emit only text of UNIX manuals

-                                                       (<A HREF="demandoc.1.txt">text</A> | 
-                                                       <A HREF="demandoc.1.xhtml">xhtml</A> |
-                                                       <A HREF="demandoc.1.pdf">pdf</A> |
-                                                       <A HREF="demandoc.1.ps">ps</A>)

                                        </TD>
                                </TR>
                                <TR>
                                        <TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD>
                                        <TD VALIGN="top">
                                                format and display UNIX manuals
                                        </TD>
                                </TR>
                                <TR>
                                        <TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD>
                                        <TD VALIGN="top">
                                                format and display UNIX manuals

-                                                       (<A HREF="mandoc.1.txt">text</A> | 
-                                                       <A HREF="mandoc.1.xhtml">xhtml</A> |
-                                                       <A HREF="mandoc.1.pdf">pdf</A> |
-                                                       <A HREF="mandoc.1.ps">ps</A>)

                                        </TD>
                                </TR>
                                <TR>
                                        <TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD>
                                        <TD VALIGN="top">
                                                recode multibyte UNIX manuals
                                        </TD>
                                </TR>
                                <TR>
                                        <TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD>
                                        <TD VALIGN="top">
                                                recode multibyte UNIX manuals

-                                                       (<A HREF="preconv.1.txt">text</A> | 
-                                                       <A HREF="preconv.1.xhtml">xhtml</A> |
-                                                       <A HREF="preconv.1.pdf">pdf</A> |
-                                                       <A HREF="preconv.1.ps">ps</A>)
-                                       </TD>
-                               </TR>
-                               <TR>
-                                       <TD VALIGN="top"><A HREF="whatis.1.html">whatis(1)</A></TD>
-                                       <TD VALIGN="top">
-                                               search the manual page database
-                                                       (<A HREF="whatis.1.txt">text</A> | 
-                                                       <A HREF="whatis.1.xhtml">xhtml</A> |
-                                                       <A HREF="whatis.1.pdf">pdf</A> |
-                                                       <A HREF="whatis.1.ps">ps</A>)

                                        </TD>
                                </TR>
                                <TR>
                                        <TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD>
                                        <TD VALIGN="top">
                                                mandoc macro compiler library
                                        </TD>
                                </TR>
                                <TR>
                                        <TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD>
                                        <TD VALIGN="top">
                                                mandoc macro compiler library

-                                                       (<A HREF="mandoc.3.txt">text</A> | 
-                                                       <A HREF="mandoc.3.xhtml">xhtml</A> |
-                                                       <A HREF="mandoc.3.pdf">pdf</A> |
-                                                       <A HREF="mandoc.3.ps">ps</A>)

                                        </TD>
                                </TR>
                                <TR>
                                        <TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD>
                                        <TD VALIGN="top">
                                                man language reference
                                        </TD>
                                </TR>
                                <TR>
                                        <TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD>
                                        <TD VALIGN="top">
                                                man language reference

-                                                       (<A HREF="man.7.txt">text</A> | 
-                                                       <A HREF="man.7.xhtml">xhtml</A> |
-                                                       <A HREF="man.7.pdf">pdf</A> |
-                                                       <A HREF="man.7.ps">ps</A>)

                                        </TD>
                                </TR>
                                <TR>
                                        <TD VALIGN="top"><A HREF="man.cgi.7.html">man.cgi(7)</A></TD>
                                        <TD VALIGN="top">
                                                cgi for manpage query and display
                                        </TD>
                                </TR>
                                <TR>
                                        <TD VALIGN="top"><A HREF="man.cgi.7.html">man.cgi(7)</A></TD>
                                        <TD VALIGN="top">
                                                cgi for manpage query and display

-                                                       (<A HREF="man.cgi.7.txt">text</A> | 
-                                                       <A HREF="man.cgi.7.xhtml">xhtml</A> |
-                                                       <A HREF="man.cgi.7.pdf">pdf</A> |
-                                                       <A HREF="man.cgi.7.ps">ps</A>)

                                        </TD>
                                </TR>
                                <TR>
                                        <TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD>
                                        <TD VALIGN="top">
                                                eqn-mandoc language reference
                                        </TD>
                                </TR>
                                <TR>
                                        <TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD>
                                        <TD VALIGN="top">
                                                eqn-mandoc language reference

-                                                       (<A HREF="eqn.7.txt">text</A> | 
-                                                       <A HREF="eqn.7.xhtml">xhtml</A> |
-                                                       <A HREF="eqn.7.pdf">pdf</A> |
-                                                       <A HREF="eqn.7.ps">ps</A>)

                                        </TD>
                                </TR>
                                <TR>
                                        <TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD>
                                        <TD VALIGN="top">
                                                mandoc special characters
                                        </TD>
                                </TR>
                                <TR>
                                        <TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD>
                                        <TD VALIGN="top">
                                                mandoc special characters

-                                                       (<A HREF="mandoc_char.7.txt">text</A> | 
-                                                       <A HREF="mandoc_char.7.xhtml">xhtml</A> |
-                                                       <A HREF="mandoc_char.7.pdf">pdf</A> |
-                                                       <A HREF="mandoc_char.7.ps">ps</A>)

                                        </TD>
                                </TR>
                                <TR>
                                        <TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD>
                                        <TD VALIGN="top">
                                                mdoc language reference
                                        </TD>
                                </TR>
                                <TR>
                                        <TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD>
                                        <TD VALIGN="top">
                                                mdoc language reference

-                                                       (<A HREF="mdoc.7.txt">text</A> | 
-                                                       <A HREF="mdoc.7.xhtml">xhtml</A> |
-                                                       <A HREF="mdoc.7.pdf">pdf</A> |
-                                                       <A HREF="mdoc.7.ps">ps</A>)

                                        </TD>
                                </TR>
                                <TR>
                                        <TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD>
                                        <TD VALIGN="top">
                                                roff-mandoc language reference
                                        </TD>
                                </TR>
                                <TR>
                                        <TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD>
                                        <TD VALIGN="top">
                                                roff-mandoc language reference

-                                                       (<A HREF="roff.7.txt">text</A> | 
-                                                       <A HREF="roff.7.xhtml">xhtml</A> |
-                                                       <A HREF="roff.7.pdf">pdf</A> |
-                                                       <A HREF="roff.7.ps">ps</A>)

                                        </TD>
                                </TR>
                                <TR>
                                        <TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD>
                                        <TD VALIGN="top">
                                                tbl-mandoc language reference
                                        </TD>
                                </TR>
                                <TR>
                                        <TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD>
                                        <TD VALIGN="top">
                                                tbl-mandoc language reference

-                                                       (<A HREF="tbl.7.txt">text</A> | 
-                                                       <A HREF="tbl.7.xhtml">xhtml</A> |
-                                                       <A HREF="tbl.7.pdf">pdf</A> |
-                                                       <A HREF="tbl.7.ps">ps</A>)
-                                       </TD>
-                               </TR>
-                               <TR>
-                                       <TD VALIGN="top"><A HREF="catman.8.html">catman(8)</A></TD>
-                                       <TD VALIGN="top">
-                                               update a man.cgi manpage cache
-                                                       (<A HREF="catman.8.txt">text</A> | 
-                                                       <A HREF="catman.8.xhtml">xhtml</A> |
-                                                       <A HREF="catman.8.pdf">pdf</A> |
-                                                       <A HREF="catman.8.ps">ps</A>)

                                        </TD>
                                </TR>
                                <TR>
                                        <TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD>
                                        <TD VALIGN="top">
                                                index UNIX manuals
                                        </TD>
                                </TR>
                                <TR>
                                        <TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD>
                                        <TD VALIGN="top">
                                                index UNIX manuals

-                                                       (<A HREF="mandocdb.8.txt">text</A> | 
-                                                       <A HREF="mandocdb.8.xhtml">xhtml</A> |
-                                                       <A HREF="mandocdb.8.pdf">pdf</A> |
-                                                       <A HREF="mandocdb.8.ps">ps</A>)

                                        </TD>
                                </TR>
                        </TBODY>
                                        </TD>
                                </TR>
                        </TBODY>


@@ -330,47 +243,15 @@
                        <A NAME="news">News</A>
                </H1>
                <P CLASS="news">
                        <A NAME="news">News</A>
                </H1>
                <P CLASS="news">

-                       xx-xx-2011: 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 and in line with other manpage systems.  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 CLASS="news">
-                       08-10-2011: version 1.12.0
-               </P>
-               <P>
-                       This version features a new, work-in-progress <A HREF="mandoc.1.html">mandoc</A> output mode: -<B>Tman</B>.  This mode
-                       allows a system maintainer to distribute <A HREF="man.7.html">man</A> media for older systems that may not natively
-                       support <A HREF="mdoc.7.html">mdoc</A>, such as old Solaris systems.
-                       The -<B>Ofragment</B> option was added to <A HREF="mandoc.1.html">mandoc</A>'s -<B>Thtml</B> and -<B>Txhtml</B> modes.
-               </P>
-               <P>
-                       While adding features, an <A HREF="apropos.1.html">apropos</A> utility has been merged from the mandoc-tools sandbox.
-                       This interfaces with <A HREF="mandocdb.8.html">mandocdb</A> for semantic search of manual content.  <A
-                       HREF="apropos.1.html">apropos</A> is different from the traditional <B>apropos</B> primarily in allowing keyword search
-                       (such as for functions, utilities, etc.) and regular expressions.
-                       Note that the calling syntax for <B>apropos</B> is likely to change as it settles down.
+                       xx-xx-2012: version 1.12.4

                </P>
                <P>
                </P>
                <P>

-                       In documentation news, the <A HREF="mdoc.7.html">mdoc</A> and <A HREF="man.7.html">man</A> manuals have been made
-                       considerably more readable by adding <I>MACRO OVERVIEW</I> sections, by moving the gory details of the <I>LANGUAGE
-                       SYNTAX</I> to the <A HREF="roff.7.html">roff</A> manual, and by moving the very technical <I>MACRO SYNTAX</I> sections
-                       down to the bottom of the page.
+                       <I>Ingo, can you summarise your changes here?</I>

                </P>
                <P>
                </P>
                <P>

-                       Furthermore, for <A HREF="tbl.7.html">tbl</A>, the -<B>Tascii</B> mode horizontal spacing of tables was rewritten
-                       completely.  It is now compatible with <A HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, both
-                       with and without frames and rulers.  Nesting of indented blocks is now supported in <A HREF="man.7.html">man</A>, and
-                       several bugs were fixed regarding indentation and alignment.  The page headers in <A HREF="mdoc.7.html">mdoc</A> are now
-                       nicer for very long titles.
+                       The <A HREF="mandocdb.8.html">mandocdb</A> tools (<A HREF="mandocdb.8.html">mandocdb</A>, <A
+                       HREF="apropos.1.html">apropos</A> (absorbing whatis), and <A HREF="man.cgi.7.html">man.cgi</A>) have been re-written to
+                       use <A CLASS="external" HREF="http://www.sqlite.org">sqlite3</A> as a database.

                </P>
                <P>
                        See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for
                </P>
                <P>
                        See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for


@@ -380,7 +261,7 @@
                        <SMALL>
                                Copyright &#169; 2008&#8211;2011 
                                <A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>, 
                        <SMALL>
                                Copyright &#169; 2008&#8211;2011 
                                <A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>, 

-                               $Date: 2011/12/10 23:44:42 $
+                               $Date: 2012/06/09 14:19:55 $

                        </SMALL>
                </P>
        </BODY>
                        </SMALL>
                </P>
        </BODY>