===================================================================
RCS file: /cvs/mandoc/Attic/makewhatis.1,v
retrieving revision 1.1
retrieving revision 1.12
diff -u -p -r1.1 -r1.12
--- mandoc/Attic/makewhatis.1	2011/05/13 00:42:26	1.1
+++ mandoc/Attic/makewhatis.1	2011/07/11 09:44:07	1.12
@@ -1,4 +1,4 @@
-.\"	$Id: makewhatis.1,v 1.1 2011/05/13 00:42:26 kristaps Exp $
+.\"	$Id: makewhatis.1,v 1.12 2011/07/11 09:44:07 kristaps Exp $
 .\"
 .\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"
@@ -14,14 +14,15 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: May 13 2011 $
-.Dt MANDOC-DB 1
+.Dd $Mdocdate: July 11 2011 $
+.Dt MAKEWHATIS 1
 .Os
 .Sh NAME
 .Nm makewhatis
 .Nd index UNIX manuals
 .Sh SYNOPSIS
 .Nm
+.Op Fl v
 .Op Fl d Ar dir
 .Ar
 .Sh DESCRIPTION
@@ -41,6 +42,10 @@ or
 .Xr man 7
 .Ux
 manual format.
+.It Fl v
+Verbose output.
+If specified once, prints the name of each indexed file.
+If twice, prints keywords for each file.
 .El
 .Pp
 By default,
@@ -87,32 +92,41 @@ length plus one) mapping to a 8-byte binary field cons
 keyword type and source
 .Sx Index Database
 record number.
-The type, an unsigned 32-bit integer in host order, is one of the
-following:
+The type, a 32-bit bit-mask in host order, consists of the following
+fields:
 .Pp
 .Bl -tag -width Ds -offset indent -compact
 .It Li 0x01
 The name of a manual page as given in the NAME section.
 .It Li 0x02
 A function prototype name as given in the SYNOPSIS section.
-.It Li 0x03
-A utility name as given in the SYNOPSIS section.
 .It Li 0x04
+A utility name as given in the SYNOPSIS section.
+.It Li 0x08
 An include file as given in the SYNOPSIS section.
-.It Li 0x05
+.It Li 0x10
 A variable name as given in the SYNOPSIS section.
-.It Li 0x06
+.It Li 0x20
 A standard as given in the STANDARDS section.
-.It Li 0x07
+.It Li 0x40
 An author as given in the AUTHORS section.
-.It Li 0x08
+.It Li 0x80
 A configuration as given in the SYNOPSIS section.
+.It Li 0x100
+Free-form descriptive text as given in the NAME section.
+.It Li 0x200
+Cross-links between manuals.
+Listed as the link name, then a period, then the link section.
+If the link has no section, the period terminates the string.
+.It Li 0x400
+Path reference as given in the FILES section.
+.It Li 0x800
+Environment variable as given in the ENVIRONMENT section.
+.It Li 0x1000
+Error codes as given in the ERRORS section.
 .El
 .Pp
-If a value is encountered outside of this range, the database is
-corrupt.
-.Pp
-The latter four bytes are a host-ordered record number within the
+The last four bytes are a host-ordered record number within the
 .Sx Index Database .
 .Pp
 The
@@ -126,19 +140,30 @@ A
 .Xr btree 3
 keyword database mapping keywords to a type and file reference in
 .Pa mandoc.index .
-.It Pa mandoc.db~
-Working copy of
-.Pa mandoc.db .
 .It Pa mandoc.index
 A
 .Xr recno 3
 database of indexed file-names.
-.It Pa mandoc.index~
-Working copy of
-.Pa mandoc.index .
 .El
 .Sh EXIT STATUS
-.Ex -std
+The
+.Nm
+utility exits with one of the following values:
+.Pp
+.Bl -tag -width Ds -compact
+.It 0
+No errors occurred.
+.It 5
+Invalid command line arguments were specified.
+No input files have been read.
+.It 6
+An operating system error occurred, for example memory exhaustion or an
+error accessing input files.
+Such errors cause
+.Nm
+to exit at once, possibly in the middle of parsing or formatting a file.
+The output databases are corrupt and should be removed .
+.El
 .Sh SEE ALSO
 .Xr mandoc 1
 .Sh AUTHORS
@@ -146,7 +171,3 @@ The
 .Nm
 utility was written by
 .An Kristaps Dzonsons Aq kristaps@bsd.lv .
-.Sh CAVEATS
-Only
-.Xr mdoc 7
-manuals are processed.