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

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

version 1.1, 2011/07/14 14:36:37 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 ruv  .Op Fl avW
 .Op Fl d Ar dir  .Op Fl C Ar file
 .Ar  .Nm
   .Op Fl avW
   .Ar dir ...
   .Nm
   .Op Fl vW
   .Fl d Ar dir
   .Op Ar
   .Nm
   .Op Fl vW
   .Fl u Ar dir
   .Op Ar
   .Nm
   .Fl t Ar
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm  .Nm
 utility extracts keywords from  utility extracts keywords from
 .Ux  .Ux
 manuals and indexes them for fast retrieval.  manuals and indexes them in a
 The arguments are as follows:  .Sx Keyword Database
 .Bl -tag -width Ds  and
 .It Fl d Ar dir  .Sx Index Database
 The directory into which to write the keyword and index databases.  for fast retrieval by
 .It Ar  .Xr apropos 1 ,
 Read input from zero or more files in  .Xr whatis 1 ,
 .Xr mdoc 7  and
 or  .Xr man 1 Ns 's
 .Xr man 7  .Fl k
 .Ux  option.
 manual format.  
 .It Fl r  
 Remove entries.  
 This will remove the index and keyword references.  
 If the record is not found, it is ignored.  
 .It Fl u  
 Update the record.  
 This will first remove the record (as in  
 .Fl r )  
 then re-add it.  
 .It Fl v  
 Verbose output.  
 If specified once, prints the name of each indexed file.  
 If twice, prints keywords for each file.  
 .El  
 .Pp  .Pp
 By default,  By default,
 .Nm  .Nm
 constructs a new  creates databases in each
 .Sx Index Database  .Ar dir
   using the files
   .Sm off
   .Sy man Ar section Li /
   .Op Ar arch Li /
   .Ar title . section
   .Sm on
 and  and
 .Sx Keyword Database  .Sm off
 in the current working directory.  .Sy cat Ar section Li /
 Existing databases are truncated.  .Op Ar arch Li /
   .Ar title . Sy 0
   .Sm on
   in that directory;
   existing databases are truncated.
   If
   .Ar dir
   is not provided,
   .Nm
   uses the default paths stipulated by
   .Xr man 1 .
 .Pp  .Pp
 If fatal parse errors are encountered, the offending file is printed to  The arguments are as follows:
 stderr, omitted from the index, and the parse continues with the next  .Bl -tag -width "-C file"
 input 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
   to the database in
   .Ar dir
   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
   Remove
   .Ar
   from the database in
   .Ar dir
   without truncating it.
   .It Fl v
   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
   .Pp
   If fatal parse errors are encountered while parsing, the offending file
   is printed to stderr, omitted from the index, and the parse continues
   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
 a nil-terminated filename,  the character
   .Cm d ,
   .Cm a ,
   or
   .Cm c
   to indicate the file type
   .Po
   .Xr mdoc 7 ,
   .Xr man 7 ,
   and post-formatted, respectively
   .Pc ,
 .It  .It
 a nil-terminated manual section,  the filename relative to the databases' path,
 .It  .It
 a nil-terminated manual title,  the manual section,
 .It  .It
 a nil-terminated architecture  the manual title,
 .Pq this is not often available  
 .It  .It
 and a nil-terminated description.  the architecture
   .Pq often empty ,
   .It
   and the description.
 .El  .El
 .Pp  .Pp
 Both the manual section and description may be zero-length.  Each of the above is NUL-terminated.
 Entries are sequentially-numbered, but the filenames are unordered.  .Pp
   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 nil-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 16-byte binary field consisting of the
 keyword type and source  64-bit keyword type and the 64-bit
 .Sx Index Database  .Sx Index Database
 record number.  record number, both in network-byte order.
 The type, a 32-bit bit-mask in host order, consists of the following  
 fields:  
 .Pp  .Pp
 .Bl -tag -width Ds -offset indent -compact  The type bit-mask consists of the following
 .It Li 0x01  values mapping into
 The name of a manual page as given in the NAME section.  .Xr mdoc 7
 .It Li 0x02  macro identifiers:
 A function prototype name as given in the SYNOPSIS section.  
 .It Li 0x04  
 A utility name as given in the SYNOPSIS section.  
 .It Li 0x08  
 An include file as given in the SYNOPSIS section.  
 .It Li 0x10  
 A variable name as given in the SYNOPSIS section.  
 .It Li 0x20  
 A standard as given in the STANDARDS section.  
 .It Li 0x40  
 An author as given in the AUTHORS section.  
 .It Li 0x80  
 A configuration as given in the SYNOPSIS section.  
 .It Li 0x100  
 Free-form descriptive text as given in the NAME section.  
 .It Li 0x200  
 Cross-links between manuals.  
 Listed as the link name, then a period, then the link section.  
 If the link has no section, the period terminates the string.  
 .It Li 0x400  
 Path reference as given in the FILES section.  
 .It Li 0x800  
 Environment variable as given in the ENVIRONMENT section.  
 .It Li 0x1000  
 Error codes as given in the ERRORS section.  
 .El  
 .Pp  .Pp
 The last four bytes are a host-ordered record number within the  .Bl -column "x0x0000000000000001ULLx" "xLix" -offset indent -compact
 .Sx Index Database .  .It Li 0x0000000000000001ULL Ta \&An
 .Pp  .It Li 0x0000000000000002ULL Ta \&Ar
 The  .It Li 0x0000000000000004ULL Ta \&At
 .Nm  .It Li 0x0000000000000008ULL Ta \&Bsx
 utility is  .It Li 0x0000000000000010ULL Ta \&Bx
 .Ud  .It Li 0x0000000000000020ULL Ta \&Cd
   .It Li 0x0000000000000040ULL Ta \&Cm
   .It Li 0x0000000000000080ULL Ta \&Dv
   .It Li 0x0000000000000100ULL Ta \&Dx
   .It Li 0x0000000000000200ULL Ta \&Em
   .It Li 0x0000000000000400ULL Ta \&Er
   .It Li 0x0000000000000800ULL Ta \&Ev
   .It Li 0x0000000000001000ULL Ta \&Fa
   .It Li 0x0000000000002000ULL Ta \&Fl
   .It Li 0x0000000000004000ULL Ta \&Fn
   .It Li 0x0000000000008000ULL Ta \&Ft
   .It Li 0x0000000000010000ULL Ta \&Fx
   .It Li 0x0000000000020000ULL Ta \&Ic
   .It Li 0x0000000000040000ULL Ta \&In
   .It Li 0x0000000000080000ULL Ta \&Lb
   .It Li 0x0000000000100000ULL Ta \&Li
   .It Li 0x0000000000200000ULL Ta \&Lk
   .It Li 0x0000000000400000ULL Ta \&Ms
   .It Li 0x0000000000800000ULL Ta \&Mt
   .It Li 0x0000000001000000ULL Ta \&Nd
   .It Li 0x0000000002000000ULL Ta \&Nm
   .It Li 0x0000000004000000ULL Ta \&Nx
   .It Li 0x0000000008000000ULL Ta \&Ox
   .It Li 0x0000000010000000ULL Ta \&Pa
   .It Li 0x0000000020000000ULL Ta \&Rs
   .It Li 0x0000000040000000ULL Ta \&Sh
   .It Li 0x0000000080000000ULL Ta \&Ss
   .It Li 0x0000000100000000ULL Ta \&St
   .It Li 0x0000000200000000ULL Ta \&Sy
   .It Li 0x0000000400000000ULL Ta \&Tn
   .It Li 0x0000000800000000ULL Ta \&Va
   .It Li 0x0000001000000000ULL Ta \&Vt
   .It Li 0x0000002000000000ULL Ta \&Xr
   .El
 .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.  number of keywords in the input files.
 However, removing or updating entries with  However, removing or updating entries with
 .Fl r  .Fl u
 or  or
 .Fl u ,  .Fl d ,
 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 180  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
   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 mandoc 1  .Xr apropos 1 ,
   .Xr man 1 ,
   .Xr whatis 1 ,
   .Xr btree 3 ,
   .Xr recno 3 ,
   .Xr man.conf 5
 .Sh AUTHORS  .Sh AUTHORS
 The  The
 .Nm  .Nm
 utility was written by  utility was written by
 .An Kristaps Dzonsons Aq kristaps@bsd.lv .  .An Kristaps Dzonsons ,
   .Mt kristaps@bsd.lv .
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.17
CVSweb