=================================================================== RCS file: /cvs/mandoc/Attic/mandocdb.8,v retrieving revision 1.9 retrieving revision 1.12 diff -u -p -r1.9 -r1.12 --- mandoc/Attic/mandocdb.8 2011/11/29 11:17:47 1.9 +++ mandoc/Attic/mandocdb.8 2011/12/12 02:00:49 1.12 @@ -1,4 +1,4 @@ -.\" $Id: mandocdb.8,v 1.9 2011/11/29 11:17:47 kristaps Exp $ +.\" $Id: mandocdb.8,v 1.12 2011/12/12 02:00:49 schwarze Exp $ .\" .\" Copyright (c) 2011 Kristaps Dzonsons .\" @@ -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 12 2011 $ .Dt MANDOCDB 8 .Os .Sh NAME @@ -23,8 +23,11 @@ .Sh SYNOPSIS .Nm .Op Fl av -.Op Ar dir ... +.Op Fl C Ar file .Nm +.Op Fl av +.Ar dir ... +.Nm .Op Fl v .Fl d Ar dir .Op Ar @@ -69,10 +72,16 @@ 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 @@ -86,9 +95,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 +146,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 type bit-mask consists of the following values mapping into .Xr mdoc 7 macro identifiers: @@ -210,6 +217,10 @@ keyword database mapping keywords to a type and file r 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 @@ -230,10 +241,33 @@ 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 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