[BACK]Return to mandocdb.8 CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/Attic/mandocdb.8 between version 1.9 and 1.16

version 1.9, 2011/11/29 11:17:47 version 1.16, 2011/12/25 16:53:51
Line 22 
Line 22 
 .Nd index UNIX manuals  .Nd index UNIX manuals
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .Nm  .Nm
 .Op Fl av  .Op Fl avW
 .Op Ar dir ...  .Op Fl C Ar file
 .Nm  .Nm
 .Op Fl v  .Op Fl avW
   .Ar dir ...
   .Nm
   .Op Fl vW
 .Fl d Ar dir  .Fl d Ar dir
 .Op Ar  .Op Ar
 .Nm  .Nm
 .Op Fl v  .Op Fl vW
 .Fl u Ar dir  .Fl u Ar dir
 .Op Ar  .Op Ar
   .Nm
   .Fl t Ar
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm  .Nm
Line 69  uses the default paths stipulated by
Line 74  uses the default paths stipulated by
 .Xr man 1 .  .Xr man 1 .
 .Pp  .Pp
 The arguments are as follows:  The arguments are as follows:
 .Bl -tag -width Ds  .Bl -tag -width "-C file"
 .It Fl a  .It Fl a
 Use all directories and files found below  Use all directories and files found below
 .Ar dir ... .  .Ar dir ... .
   .It Fl C Ar file
   Specify an alternative configuration
   .Ar file
   in
   .Xr man.conf 5
   format.
 .It Fl d Ar dir  .It Fl d Ar dir
 Merge (remove and re-add)  Merge (remove and re-add)
 .Ar  .Ar
 to the database in  to the database in
 .Ar dir  .Ar dir
 without truncating it.  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  .It Fl u Ar dir
 Remove  Remove
 .Ar  .Ar
Line 86  from the database in
Line 108  from the database in
 .Ar dir  .Ar dir
 without truncating it.  without truncating it.
 .It Fl v  .It Fl v
 Verbose operation.  Display all files added or removed to the index.
 Use once to display all files added or removed and twice for keywords as  .It Fl W
 well.  Print warnings about potential problems with manual pages
   to the standard error output.
 .El  .El
 .Pp  .Pp
 If fatal parse errors are encountered while parsing, the offending file  If fatal parse errors are encountered while parsing, the offending file
Line 96  is printed to stderr, omitted from the index, and the 
Line 119  is printed to stderr, omitted from the index, and the 
 with the next input file.  with the next input file.
 .Ss Index Database  .Ss Index Database
 The index database,  The index database,
 .Pa mandoc.index ,  .Pa whatis.index ,
 is a  is a
 .Xr recno 3  .Xr recno 3
 database with record values consisting of  database with record values consisting of
 .Pp  .Pp
 .Bl -enum -compact  .Bl -enum -compact
 .It  .It
 the string  the character
 .Cm mdoc ,  .Cm d ,
 .Cm man ,  .Cm a ,
 or  or
 .Cm cat  .Cm c
 to indicate the file type  to indicate the file type
 .Po  .Po
 file in  
 .Xr mdoc 7 ,  .Xr mdoc 7 ,
 .Xr man 7 ,  .Xr man 7 ,
 and post-formatted, respectively  and post-formatted, respectively
 .Pc ,  .Pc ,
 .It  .It
 the filename,  the filename relative to the databases' path,
 .It  .It
 the manual section,  the manual section,
 .It  .It
Line 130  and the description.
Line 152  and the description.
 .Pp  .Pp
 Each of the above is NUL-terminated.  Each of the above is NUL-terminated.
 .Pp  .Pp
 Both the manual section and description may be zero-length if the record  If the record value is zero-length, it is unassigned.
 is unassigned.  
 Entries are sequentially-numbered, but the filenames are unordered.  
 .Ss Keyword Database  .Ss Keyword Database
 The keyword database,  The keyword database,
 .Pa mandoc.db ,  .Pa whatis.db ,
 is a  is a
 .Xr btree 3  .Xr btree 3
 database of NUL-terminated keywords (record length is non-zero string  database of NUL-terminated keywords (record length is non-zero string
 length plus one) mapping to a 8-byte binary field consisting of the  length plus one) mapping to a 12-byte binary field consisting of the
 keyword type and source  64-bit keyword type and 32-bit source
 .Sx Index Database  .Sx Index Database
 record number.  record number, both in network-byte order.
 The type, a 64-bit bit-mask in host order, consists of the following  The type bit-mask consists of the following
 values mapping into  values mapping into
 .Xr mdoc 7  .Xr mdoc 7
 macro identifiers:  macro identifiers:
Line 201  or
Line 221  or
 respectively, grows as a multiple of the index length and input size.  respectively, grows as a multiple of the index length and input size.
 .Sh FILES  .Sh FILES
 .Bl -tag -width Ds  .Bl -tag -width Ds
 .It Pa mandoc.db  .It Pa whatis.db
 A  A
 .Xr btree 3  .Xr btree 3
 keyword database mapping keywords to a type and file reference in  keyword database mapping keywords to a type and file reference in
 .Pa mandoc.index .  .Pa whatis.index .
 .It Pa mandoc.index  .It Pa whatis.index
 A  A
 .Xr recno 3  .Xr recno 3
 database of indexed file-names.  database of indexed file-names.
   .It Pa /etc/man.conf
   The default
   .Xr man 1
   configuration file.
 .El  .El
 .Sh EXIT STATUS  .Sh EXIT STATUS
 The  The
Line 230  Such errors cause
Line 254  Such errors cause
 to exit at once, possibly in the middle of parsing or formatting a file.  to exit at once, possibly in the middle of parsing or formatting a file.
 The output databases are corrupt and should be removed .  The output databases are corrupt and should be removed .
 .El  .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  .Sh SEE ALSO
   .Xr apropos 1 ,
 .Xr man 1 ,  .Xr man 1 ,
   .Xr whatis 1 ,
 .Xr btree 3 ,  .Xr btree 3 ,
 .Xr recno 3  .Xr recno 3 ,
   .Xr man.conf 5
 .Sh AUTHORS  .Sh AUTHORS
 The  The
 .Nm  .Nm
Legend:
Removed from v.1.9  
changed lines
  Added in v.1.16
CVSweb