[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.9

version 1.1, 2011/07/14 14:36:37 version 1.9, 2011/11/29 11:17:47
Line 22 
Line 22 
 .Nd index UNIX manuals  .Nd index UNIX manuals
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .Nm  .Nm
 .Op Fl ruv  .Op Fl av
 .Op Fl d Ar dir  .Op Ar dir ...
 .Ar  .Nm
   .Op Fl v
   .Fl d Ar dir
   .Op Ar
   .Nm
   .Op Fl v
   .Fl u Ar dir
   .Op 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
   .Sx Keyword Database
   and
   .Sx Index Database
   for fast retrieval.
   .Pp
   By default,
   .Nm
   creates databases in each
   .Ar dir
   using the files
   .Sm off
   .Sy man Ar section Li /
   .Op Ar arch Li /
   .Ar title . section
   .Sm on
   and
   .Sm off
   .Sy cat Ar section Li /
   .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
 The arguments are as follows:  The arguments are as follows:
 .Bl -tag -width Ds  .Bl -tag -width Ds
   .It Fl a
   Use all directories and files found below
   .Ar dir ... .
 .It Fl d Ar dir  .It Fl d Ar dir
 The directory into which to write the keyword and index databases.  Merge (remove and re-add)
 .It Ar  .Ar
 Read input from zero or more files in  to the database in
 .Xr mdoc 7  .Ar dir
 or  without truncating it.
 .Xr man 7  .It Fl u Ar dir
 .Ux  Remove
 manual format.  .Ar
 .It Fl r  from the database in
 Remove entries.  .Ar dir
 This will remove the index and keyword references.  without truncating it.
 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  .It Fl v
 Verbose output.  Verbose operation.
 If specified once, prints the name of each indexed file.  Use once to display all files added or removed and twice for keywords as
 If twice, prints keywords for each file.  well.
 .El  .El
 .Pp  .Pp
 By default,  If fatal parse errors are encountered while parsing, the offending file
 .Nm  is printed to stderr, omitted from the index, and the parse continues
 constructs a new  with the next input file.
 .Sx Index Database  
 and  
 .Sx Keyword Database  
 in the current working directory.  
 Existing databases are truncated.  
 .Pp  
 If fatal parse errors are encountered, 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 mandoc.index ,
Line 78  database with record values consisting of
Line 103  database with record values consisting of
 .Pp  .Pp
 .Bl -enum -compact  .Bl -enum -compact
 .It  .It
 a nil-terminated filename,  the string
   .Cm mdoc ,
   .Cm man ,
   or
   .Cm cat
   to indicate the file type
   .Po
   file in
   .Xr mdoc 7 ,
   .Xr man 7 ,
   and post-formatted, respectively
   .Pc ,
 .It  .It
 a nil-terminated manual section,  the filename,
 .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.
   .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.  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 mandoc.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 8-byte binary field consisting of the
 keyword type and source  keyword type and source
 .Sx Index Database  .Sx Index Database
 record number.  record number.
 The type, a 32-bit bit-mask in host order, consists of the following  The type, a 64-bit bit-mask in host order, consists of the following
 fields:  values mapping into
   .Xr mdoc 7
   macro identifiers:
 .Pp  .Pp
 .Bl -tag -width Ds -offset indent -compact  .Bl -column "x0x0000000000000001ULLx" "xLix" -offset indent -compact
 .It Li 0x01  .It Li 0x0000000000000001ULL Ta \&An
 The name of a manual page as given in the NAME section.  .It Li 0x0000000000000002ULL Ta \&Ar
 .It Li 0x02  .It Li 0x0000000000000004ULL Ta \&At
 A function prototype name as given in the SYNOPSIS section.  .It Li 0x0000000000000008ULL Ta \&Bsx
 .It Li 0x04  .It Li 0x0000000000000010ULL Ta \&Bx
 A utility name as given in the SYNOPSIS section.  .It Li 0x0000000000000020ULL Ta \&Cd
 .It Li 0x08  .It Li 0x0000000000000040ULL Ta \&Cm
 An include file as given in the SYNOPSIS section.  .It Li 0x0000000000000080ULL Ta \&Dv
 .It Li 0x10  .It Li 0x0000000000000100ULL Ta \&Dx
 A variable name as given in the SYNOPSIS section.  .It Li 0x0000000000000200ULL Ta \&Em
 .It Li 0x20  .It Li 0x0000000000000400ULL Ta \&Er
 A standard as given in the STANDARDS section.  .It Li 0x0000000000000800ULL Ta \&Ev
 .It Li 0x40  .It Li 0x0000000000001000ULL Ta \&Fa
 An author as given in the AUTHORS section.  .It Li 0x0000000000002000ULL Ta \&Fl
 .It Li 0x80  .It Li 0x0000000000004000ULL Ta \&Fn
 A configuration as given in the SYNOPSIS section.  .It Li 0x0000000000008000ULL Ta \&Ft
 .It Li 0x100  .It Li 0x0000000000010000ULL Ta \&Fx
 Free-form descriptive text as given in the NAME section.  .It Li 0x0000000000020000ULL Ta \&Ic
 .It Li 0x200  .It Li 0x0000000000040000ULL Ta \&In
 Cross-links between manuals.  .It Li 0x0000000000080000ULL Ta \&Lb
 Listed as the link name, then a period, then the link section.  .It Li 0x0000000000100000ULL Ta \&Li
 If the link has no section, the period terminates the string.  .It Li 0x0000000000200000ULL Ta \&Lk
 .It Li 0x400  .It Li 0x0000000000400000ULL Ta \&Ms
 Path reference as given in the FILES section.  .It Li 0x0000000000800000ULL Ta \&Mt
 .It Li 0x800  .It Li 0x0000000001000000ULL Ta \&Nd
 Environment variable as given in the ENVIRONMENT section.  .It Li 0x0000000002000000ULL Ta \&Nm
 .It Li 0x1000  .It Li 0x0000000004000000ULL Ta \&Nx
 Error codes as given in the ERRORS section.  .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  .El
 .Pp  .Pp
 The last four bytes are a host-ordered record number within the  The last four bytes are a host-ordered record number within the
 .Sx Index Database .  .Sx Index Database .
 .Pp  
 The  
 .Nm  
 utility is  
 .Ud  
 .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
Line 183  to exit at once, possibly in the middle of parsing or 
Line 231  to exit at once, possibly in the middle of parsing or 
 The output databases are corrupt and should be removed .  The output databases are corrupt and should be removed .
 .El  .El
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr mandoc 1  .Xr man 1 ,
   .Xr btree 3 ,
   .Xr recno 3
 .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.9
CVSweb