===================================================================
RCS file: /cvs/mandoc/Attic/mandocdb.8,v
retrieving revision 1.11
retrieving revision 1.16
diff -u -p -r1.11 -r1.16
--- mandoc/Attic/mandocdb.8	2011/12/02 00:21:56	1.11
+++ mandoc/Attic/mandocdb.8	2011/12/25 16:53:51	1.16
@@ -1,4 +1,4 @@
-.\"	$Id: mandocdb.8,v 1.11 2011/12/02 00:21:56 kristaps Exp $
+.\"	$Id: mandocdb.8,v 1.16 2011/12/25 16:53:51 schwarze Exp $
 .\"
 .\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"
@@ -14,7 +14,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: December 2 2011 $
+.Dd $Mdocdate: December 25 2011 $
 .Dt MANDOCDB 8
 .Os
 .Sh NAME
@@ -22,16 +22,21 @@
 .Nd index UNIX manuals
 .Sh SYNOPSIS
 .Nm
-.Op Fl av
-.Op Ar dir ...
+.Op Fl avW
+.Op Fl C Ar file
 .Nm
-.Op Fl v
+.Op Fl avW
+.Ar dir ...
+.Nm
+.Op Fl vW
 .Fl d Ar dir
 .Op Ar
 .Nm
-.Op Fl v
+.Op Fl vW
 .Fl u Ar dir
 .Op Ar
+.Nm
+.Fl t Ar
 .Sh DESCRIPTION
 The
 .Nm
@@ -69,16 +74,33 @@ uses the default paths stipulated by
 .Xr man 1 .
 .Pp
 The arguments are as follows:
-.Bl -tag -width Ds
+.Bl -tag -width "-C file"
 .It Fl a
 Use all directories and files found below
 .Ar dir ... .
+.It Fl C Ar file
+Specify an alternative configuration
+.Ar file
+in
+.Xr man.conf 5
+format.
 .It Fl d Ar dir
 Merge (remove and re-add)
 .Ar
 to the database in
 .Ar dir
 without truncating it.
+.It Fl t Ar
+Check the given
+.Ar files
+for potential problems.
+No databases are modified.
+Implies
+.Fl a
+and
+.Fl W .
+All diagnostic messages are printed to the standard output;
+the standard error output is not used.
 .It Fl u Ar dir
 Remove
 .Ar
@@ -87,6 +109,9 @@ from the database in
 without truncating it.
 .It Fl v
 Display all files added or removed to the index.
+.It Fl W
+Print warnings about potential problems with manual pages
+to the standard error output.
 .El
 .Pp
 If fatal parse errors are encountered while parsing, the offending file
@@ -94,27 +119,26 @@ is printed to stderr, omitted from the index, and the 
 with the next input file.
 .Ss Index Database
 The index database,
-.Pa mandoc.index ,
+.Pa whatis.index ,
 is a
 .Xr recno 3
 database with record values consisting of
 .Pp
 .Bl -enum -compact
 .It
-the string
-.Cm mdoc ,
-.Cm man ,
+the character
+.Cm d ,
+.Cm a ,
 or
-.Cm cat
+.Cm c
 to indicate the file type
 .Po
-file in
 .Xr mdoc 7 ,
 .Xr man 7 ,
 and post-formatted, respectively
 .Pc ,
 .It
-the filename,
+the filename relative to the databases' path,
 .It
 the manual section,
 .It
@@ -128,12 +152,10 @@ and the description.
 .Pp
 Each of the above is NUL-terminated.
 .Pp
-Both the manual section and description may be zero-length if the record
-is unassigned.
-Entries are sequentially-numbered, but the filenames are unordered.
+If the record value is zero-length, it is unassigned.
 .Ss Keyword Database
 The keyword database,
-.Pa mandoc.db ,
+.Pa whatis.db ,
 is a
 .Xr btree 3
 database of NUL-terminated keywords (record length is non-zero string
@@ -141,7 +163,7 @@ length plus one) mapping to a 12-byte binary field con
 64-bit keyword type and 32-bit source
 .Sx Index Database
 record number, both in network-byte order.
-The typet bit-mask consists of the following
+The type bit-mask consists of the following
 values mapping into
 .Xr mdoc 7
 macro identifiers:
@@ -199,15 +221,19 @@ or
 respectively, grows as a multiple of the index length and input size.
 .Sh FILES
 .Bl -tag -width Ds
-.It Pa mandoc.db
+.It Pa whatis.db
 A
 .Xr btree 3
 keyword database mapping keywords to a type and file reference in
-.Pa mandoc.index .
-.It Pa mandoc.index
+.Pa whatis.index .
+.It Pa whatis.index
 A
 .Xr recno 3
 database of indexed file-names.
+.It Pa /etc/man.conf
+The default
+.Xr man 1
+configuration file.
 .El
 .Sh EXIT STATUS
 The
@@ -249,9 +275,12 @@ This usually indicates database corruption or invalid 
 arguments.
 .El
 .Sh SEE ALSO
+.Xr apropos 1 ,
 .Xr man 1 ,
+.Xr whatis 1 ,
 .Xr btree 3 ,
-.Xr recno 3
+.Xr recno 3 ,
+.Xr man.conf 5
 .Sh AUTHORS
 The
 .Nm