This is a little gross: Linux and Apple need lots some cajoling to work

[mandoc.git] / mandocdb.8

diff --git a/mandocdb.8 b/mandocdb.8
index 48ae0d0ac4707265c4f6b0ffd7b92e3ad30764bd..e8e84ec80df4439a21d0e11c7e4c32a0c19ae164 100644 (file)
--- a/mandocdb.8
+++ b/mandocdb.8
@@ -1,4 +1,4 @@
-.\"    $Id: mandocdb.8,v 1.9 2011/11/29 11:17:47 kristaps Exp $
+.\"    $Id: mandocdb.8,v 1.11 2011/12/02 00:21:56 kristaps 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: November 29 2011 $
+.Dd $Mdocdate: December 2 2011 $
 .Dt MANDOCDB 8
 .Os
 .Sh NAME
@@ -86,9 +86,7 @@ from the database in
 .Ar dir
 without truncating it.
 .It Fl v
-Verbose operation.
-Use once to display all files added or removed and twice for keywords as
-well.
+Display all files added or removed to the index.
 .El
 .Pp
 If fatal parse errors are encountered while parsing, the offending file
@@ -139,11 +137,11 @@ The keyword database,
 is a
 .Xr btree 3
 database of NUL-terminated keywords (record length is non-zero string
-length plus one) mapping to a 8-byte binary field consisting of the
-keyword type and source
+length plus one) mapping to a 12-byte binary field consisting of the
+64-bit keyword type and 32-bit source
 .Sx Index Database
-record number.
-The type, a 64-bit bit-mask in host order, consists of the following
+record number, both in network-byte order.
+The typet bit-mask consists of the following
 values mapping into
 .Xr mdoc 7
 macro identifiers:
@@ -230,6 +228,26 @@ Such errors cause
 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 DIAGNOSTICS
+If the following errors occur, the
+.Nm
+databases should be rebuilt.
+.Bl -diag
+.It "%s: Corrupt database"
+The keyword database file indicated by
+.Pa %s
+is unreadable.
+.It "%s: Corrupt index"
+The index database file indicated by
+.Pa %s
+is unreadable.
+.It "%s: Path too long"
+The file
+.Pa %s
+is too long.
+This usually indicates database corruption or invalid command-line
+arguments.
+.El
 .Sh SEE ALSO
 .Xr man 1 ,
 .Xr btree 3 ,