]> git.cameronkatri.com Git - mandoc.git/blobdiff - index.sgml
Update historical record to be historical and not made-up. Data from
[mandoc.git] / index.sgml
index 94372d3fec44c0d4de70f78dfccb8e505d3ff3ad..de2d4744883c607b3b8cf85077d9f8710772e3f4 100644 (file)
@@ -41,7 +41,9 @@
                        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;
-                       and <A HREF="mandocdb.8.html">mandocdb</A>, for indexing manuals.
+                       <A HREF="mandocdb.8.html">mandocdb</A>, for indexing manuals; and
+                       <A HREF="apropos.1.html">apropos</A>, for semantic search of manual content (both <B>mandocdb</B> and <B>apropos</B> are
+                       still experimental).
                        It is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project.  
                </P>
                <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.
-                       To build and install into <I>/usr/local/</I>, just run <CODE>make install</CODE>.
-                       Be aware: if you have an existing groff installation, this may overwrite its <B>preconv</B> binary.  
-                       The <A HREF="mandocdb.8.html">mandocdb</A> utility is not yet linked to the build; please <A HREF="#contact">contact
-                       us</A> if you plan to use it.
+                       <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> 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> and <B>apropos</B> binary names are usually taken by
+                       existing utilities.
                </P>
                <H2>
                        <A NAME="binaries">Binaries</A>
                        <COL>
                        <TBODY>
                                <TR>
-                                       <TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD>
+                                       <TD VALIGN="top"><A HREF="apropos.1.html">apropos(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>)
+                                               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>
                                                        <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
+                                                       (<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">
                        <A NAME="news">News</A>
                </H1>
                <P CLASS="news">
-                       xx-xx-2011: version 1.11.8
+                       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>
-                       This version features a new, work-in-progress 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.
+                       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.
                </P>
                <P>
-                       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.
+                       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.
                </P>
                <P>
                        Furthermore, for <A HREF="tbl.7.html">tbl</A>, the -<B>Tascii</B> mode horizontal spacing of tables was rewritten
                        HREF="/binaries/mdocml-win64.zip">mdocml-win64.zip</A> and a Mac OS X universal binary is available at <A
                        HREF="/binaries/mdocml-macosx.zip">mdocml-macosx.zip</A>.
                </P>
-               <P CLASS="news">
-                       24-07-2011: version 1.11.5
-               </P>
-               <P>
-                       Significant <A HREF="eqn.7.html">eqn</A> improvements.  <SPAN CLASS="nm">mdocml</SPAN> can now parse arbitrary eqn input
-                       (although few GNU extensions are accepted, nor is mixing low-level roff with eqn).  See the <A HREF="eqn.7.html">eqn</A>
-                       manual for details.  For the time being, equations are rendered as simple in-line text.  The equation parser satisfies
-                       the language specified in the <A CLASS="external" HREF="http://www.kohala.com/start/troff/v7man/eqn/eqn2e.ps">Second
-                       Edition User's Guide</A>.
-               </P>
-               <P>
-                       This is also the first release featuring a distributed Windows binary, available at <A
-                       HREF="/binaries/mdocml-win32.zip">/binaries/mdocml-win32.zip</A>.
-               </P>
                <P>
                        See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for
                        historical notes.
                        <SMALL>
                                Copyright &#169; 2008&#8211;2011 
                                <A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>, 
-                               $Date: 2011/10/02 18:37:25 $
+                               $Date: 2011/10/08 13:01:44 $
                        </SMALL>
                </P>
        </BODY>