]> git.cameronkatri.com Git - mandoc.git/blobdiff - index.sgml
git.ckatri.com / mandoc.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Back out lorder, which doesn't seem necessary (?). I think this means all
[mandoc.git] / index.sgml
diff --git a/index.sgml b/index.sgml
index 94372d3fec44c0d4de70f78dfccb8e505d3ff3ad..a48311a9164d2ea40ba75a000a78aa76d159cff3 100644 (file)
--- a/index.sgml
+++ b/index.sgml
@@ -3,11 +3,11 @@
        <HEAD>
                <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8">
                <LINK REL="stylesheet" HREF="index.css" TYPE="text/css" MEDIA="all">
        <HEAD>
                <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8">
                <LINK REL="stylesheet" HREF="index.css" TYPE="text/css" MEDIA="all">
-               <TITLE>mdocml | mdoc macro compiler</TITLE>
+               <TITLE>mdocml | UNIX manpage compiler</TITLE>
        </HEAD>
        <BODY>
                <P CLASS="head">
        </HEAD>
        <BODY>
                <P CLASS="head">
-                       <B>mdocml</B> &#8211; mdoc macro compiler, current version @VERSION@ (@VDATE@)
+                       <B>mdocml</B> &#8211; UNIX manpage compiler, current version @VERSION@ (@VDATE@)
                </P>
                <P CLASS="subhead">
                        Sources: <A HREF="/snapshots/mdocml.tar.gz">current</A>,
                </P>
                <P CLASS="subhead">
                        Sources: <A HREF="/snapshots/mdocml.tar.gz">current</A>,
@@ -41,7 +41,8 @@
                        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;
                        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> and <A HREF="whatis.1.html">whatis</A>, for semantic search of manual content.
                        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>
@@ -51,11 +52,12 @@
                        <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.
-                       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>, <A HREF="whatis.1.html">whatis</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>
                </P>
                <H2>
                        <A NAME="binaries">Binaries</A>
@@ -107,6 +109,12 @@
                                                CLASS="external">src/usr.bin/mandoc</A> 
                                        </TD>
                                </TR>
                                                CLASS="external">src/usr.bin/mandoc</A> 
                                        </TD>
                                </TR>
+                               <TR>
+                                       <TD>pkgsrc</TD>
+                                       <TD>
+                                       <A HREF="http://pkgsrc.se/textproc/mdocml" CLASS="external">textproc/mdocml</A> 
+                                       </TD>
+                               </TR>
                        </TBODY>
                </TABLE>
                <H1>
                        </TBODY>
                </TABLE>
                <H1>
@@ -122,13 +130,13 @@
                        <COL>
                        <TBODY>
                                <TR>
                        <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">
                                        <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>
                                        </TD>
                                </TR>
                                <TR>
@@ -141,6 +149,16 @@
                                                        <A HREF="demandoc.1.ps">ps</A>)
                                        </TD>
                                </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">
                                <TR>
                                        <TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD>
                                        <TD VALIGN="top">
@@ -151,6 +169,16 @@
                                                        <A HREF="preconv.1.ps">ps</A>)
                                        </TD>
                                </TR>
                                                        <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">
                                <TR>
                                        <TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD>
                                        <TD VALIGN="top">
@@ -241,7 +269,7 @@
                        <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues
                        before posting.  All lists are subscription-only: send a blank e-mail to the listed address to subscribe.  Beyond that,
                        contact Kristaps at <A HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&amp;c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal
                        <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues
                        before posting.  All lists are subscription-only: send a blank e-mail to the listed address to subscribe.  Beyond that,
                        contact Kristaps at <A HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&amp;c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal
-                       this e-mail address">kris...</A>@bsd.lv.
+                       this e-mail address">kris...</A>@bsd.lv.  Archives are available at <A HREF="http://gmane.org/" CLASS="external">Gmane</A>.
                </P>
                <TABLE WIDTH="100%" SUMMARY="Mailing Lists">
                        <COL WIDTH="175">
                </P>
                <TABLE WIDTH="100%" SUMMARY="Mailing Lists">
                        <COL WIDTH="175">
@@ -254,7 +282,6 @@
                                        </TD>
                                        <TD>
                                                bug-reports, general questions, and announcements 
                                        </TD>
                                        <TD>
                                                bug-reports, general questions, and announcements 
-                                               (<A HREF="/archives/discuss/">archive</A>)
                                        </TD>
                                </TR>
                                <TR>
                                        </TD>
                                </TR>
                                <TR>
@@ -264,7 +291,6 @@
                                        </TD>
                                        <TD>
                                                patches and system discussions 
                                        </TD>
                                        <TD>
                                                patches and system discussions 
-                                               (<A HREF="/archives/tech/">archive</A>)
                                        </TD>
                                </TR>
                                <TR>
                                        </TD>
                                </TR>
                                <TR>
@@ -274,7 +300,6 @@
                                        </TD>
                                        <TD>
                                                source commit messages 
                                        </TD>
                                        <TD>
                                                source commit messages 
-                                               (<A HREF="/archives/source/">archive</A>)
                                        </TD>
                                </TR>
                        </TBODY>
                                        </TD>
                                </TR>
                        </TBODY>
@@ -283,56 +308,41 @@
                        <A NAME="news">News</A>
                </H1>
                <P CLASS="news">
                        <A NAME="news">News</A>
                </H1>
                <P CLASS="news">
-                       xx-xx-2011: version 1.11.8
+                       xx-xx-2011: version 1.12.1
                </P>
                <P>
                </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.
-               </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.
-               </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.
+                       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.
                </P>
                <P CLASS="news">
                </P>
                <P CLASS="news">
-                       02-09-2011: version 1.11.7
+                       08-10-2011: version 1.12.0
                </P>
                <P>
                </P>
                <P>
-                       Added <A HREF="demandoc.1.html">demandoc</A> utility for stripping away macros and escapes.  This replaces the
-                       historical <CODE>deroff</CODE> utility.  Also improved the <A HREF="mdoc.7.html">mdoc</A> and <A HREF="man.7.html">man</A> manuals.
-               </P>
-               <P CLASS="news">
-                       16-08-2011: version 1.11.6
+                       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>
                </P>
                <P>
-                       Handling of <B>tr</B> macro in <A HREF="roff.7.html">roff</A> implemented.  This makes Perl documentation much more
-                       readable.  Hyphenation is also now enabled in <A HREF="man.7.html">man</A> format documents.  Many other general
-                       improvements have been implemented.  Furthermore, a 64-bit Windows binary is now available at <A
-                       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
+                       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>
                </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>.
+                       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>
                </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>.
+                       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.
                </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
@@ -342,7 +352,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/10/02 18:37:25 $
+                               $Date: 2011/11/29 11:21:47 $
                        </SMALL>
                </P>
        </BODY>
                        </SMALL>
                </P>
        </BODY>
A git conversion mirror of mandoc.bsd.lv