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

Diff for /mandoc/Attic/mandocdb.8 between version 1.3 and 1.8

version 1.3, 2011/07/15 17:59:29 version 1.8, 2011/11/28 01:37:34
Line 22 
Line 22 
 .Nd index UNIX manuals  .Nd index UNIX manuals
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .Nm  .Nm
 .Op Fl v  .Op Fl av
 .Op Ar dir...  .Op Ar dir ...
 .Nm  .Nm
 .Op Fl v  .Op Fl v
 .Fl d Ar dir  .Fl d Ar dir
Line 42  manuals and indexes them in a
Line 42  manuals and indexes them in a
 and  and
 .Sx Index Database  .Sx Index Database
 for fast retrieval.  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
 Remove  Merge (remove and re-add)
 .Ar  .Ar
 from the databases in  to the database in
 .Ar dir .  .Ar dir
   without truncating it.
 .It Fl u Ar dir  .It Fl u Ar dir
 Update (remove and re-add)  Remove
 .Ar  .Ar
 from the databases in  from the database in
 .Ar dir .  
 .It Ar dir...  
 Recursively add files rooted at each  
 .Ar dir  .Ar dir
 to the databases in the respective  without truncating it.
 .Ar dir .  
 Existing databases are truncated.  
 .It Fl v  .It Fl v
 Verbose operation.  Verbose operation.
 Use once to display all files added or removed and twice for keywords as  Use once to display all files added or removed and twice for keywords as
 well.  well.
 .El  .El
 .Pp  .Pp
 By default,  
 .Nm  
 creates databases in each  
 .Ar dir  
 using files rooted in that directory.  
 .Pp  
 If fatal parse errors are encountered while parsing, the offending file  If fatal parse errors are encountered while parsing, the offending file
 is printed to stderr, omitted from the index, and the parse continues  is printed to stderr, omitted from the index, and the parse continues
 with the next input file.  with the next input file.
Line 84  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,
 .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
   Each of the above is NUL-terminated.
   .Pp
 Both the manual section and description may be zero-length if the record  Both the manual section and description may be zero-length if the record
 is unassigned.  is unassigned.
 Entries are sequentially-numbered, but the filenames are unordered.  Entries are sequentially-numbered, but the filenames are unordered.
Line 104  The keyword database,
Line 132  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
Line 190  to exit at once, possibly in the middle of parsing or 
Line 218  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 man 1 ,
 .Xr mandoc 1 ,  .Xr mandoc 1 ,
 .Xr btree 3 ,  .Xr btree 3 ,
 .Xr recno 3  .Xr recno 3
Line 197  The output databases are corrupt and should be removed
Line 226  The output databases are corrupt and should be removed
 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.3  
changed lines
  Added in v.1.8

CVSweb