=================================================================== RCS file: /cvs/mandoc/Attic/mandocdb.8,v retrieving revision 1.10 retrieving revision 1.14 diff -u -p -r1.10 -r1.14 --- mandoc/Attic/mandocdb.8 2011/12/01 21:05:49 1.10 +++ mandoc/Attic/mandocdb.8 2011/12/16 12:06:35 1.14 @@ -1,4 +1,4 @@ -.\" $Id: mandocdb.8,v 1.10 2011/12/01 21:05:49 kristaps Exp $ +.\" $Id: mandocdb.8,v 1.14 2011/12/16 12:06:35 kristaps 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: December 1 2011 $ +.Dd $Mdocdate: December 16 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 @@ -101,20 +110,19 @@ 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,20 +136,18 @@ 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 , 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: @@ -208,6 +214,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 @@ -249,9 +259,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