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

Diff for /mandoc/Attic/mandocdb.8 between version 1.14 and 1.17

version 1.14, 2011/12/16 12:06:35 version 1.17, 2011/12/25 21:00:23
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 Fl C Ar file  .Op Fl C Ar file
 .Nm  .Nm
 .Op Fl av  .Op Fl avW
 .Ar dir ...  .Ar dir ...
 .Nm  .Nm
 .Op Fl v  .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 44  manuals and indexes them in a
Line 46  manuals and indexes them in a
 .Sx Keyword Database  .Sx Keyword Database
 and  and
 .Sx Index Database  .Sx Index Database
 for fast retrieval.  for fast retrieval by
   .Xr apropos 1 ,
   .Xr whatis 1 ,
   and
   .Xr man 1 Ns 's
   .Fl k
   option.
 .Pp  .Pp
 By default,  By default,
 .Nm  .Nm
Line 88  Merge (remove and re-add)
Line 96  Merge (remove and re-add)
 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 96  from the database in
Line 115  from the database in
 without truncating it.  without truncating it.
 .It Fl v  .It Fl v
 Display all files added or removed to the index.  Display all files added or removed to the index.
   .It Fl W
   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 103  is printed to stderr, omitted from the index, and the 
Line 125  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
Line 139  Each of the above is NUL-terminated.
Line 161  Each of the above is NUL-terminated.
 If the record value is zero-length, it is unassigned.  If the record value is zero-length, it is unassigned.
 .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 12-byte binary field consisting of the  length plus one) mapping to a 16-byte binary field consisting of the
 64-bit keyword type and 32-bit source  64-bit keyword type and the 64-bit
 .Sx Index Database  .Sx Index Database
 record number, both in network-byte order.  record number, both in network-byte order.
   .Pp
 The type bit-mask consists of the following  The type bit-mask consists of the following
 values mapping into  values mapping into
 .Xr mdoc 7  .Xr mdoc 7
Line 192  macro identifiers:
Line 215  macro identifiers:
 .It Li 0x0000001000000000ULL Ta \&Vt  .It Li 0x0000001000000000ULL Ta \&Vt
 .It Li 0x0000002000000000ULL Ta \&Xr  .It Li 0x0000002000000000ULL Ta \&Xr
 .El  .El
 .Pp  
 The last four bytes are a host-ordered record number within the  
 .Sx Index Database .  
 .Sh IMPLEMENTATION NOTES  .Sh IMPLEMENTATION NOTES
 The time to construct a new database pair grows linearly with the  The time to construct a new database pair grows linearly with the
 number of keywords in the input files.  number of keywords in the input files.
Line 205  or
Line 225  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.
Line 236  error accessing input files.
Line 256  error accessing input files.
 Such errors cause  Such errors cause
 .Nm  .Nm
 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  .Sh DIAGNOSTICS
 If the following errors occur, the  If the following errors occur, the

Legend:
Removed from v.1.14  
changed lines
  Added in v.1.17

CVSweb