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

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

version 1.2, 2011/07/15 10:15:24 version 1.3, 2011/07/15 17:59:29
Line 22 
Line 22 
 .Nd index UNIX manuals  .Nd index UNIX manuals
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .Nm  .Nm
 .Ar dir...  .Op Fl v
   .Op Ar dir...
   .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.
 The arguments are as follows:  The arguments are as follows:
 .Bl -tag -width Ds  .Bl -tag -width Ds
   .It Fl d Ar dir
   Remove
   .Ar
   from the databases in
   .Ar dir .
   .It Fl u Ar dir
   Update (remove and re-add)
   .Ar
   from the databases in
   .Ar dir .
 .It Ar dir...  .It Ar dir...
 Recursively scan for  Recursively add files rooted at each
 .Xr mdoc 7  
 and  
 .Xr man 7  
 .Ux  
 manual files in each  
 .Ar dir  .Ar dir
 directory.  to the databases in the respective
 .Sx Index Database  .Ar dir .
 and  
 .Sx Keyword Database  
 files are installed in each  
 .Ar dir  
 directory.  
 Existing databases are truncated.  Existing databases are truncated.
   .It Fl v
   Verbose operation.
   Use once to display all files added or removed and twice for keywords as
   well.
 .El  .El
 .Pp  .Pp
 By default,  By default,
 .Nm  .Nm
 does nothing: the  creates databases in each
 .Ar dir...  .Ar dir
 invocation must be used.  using files rooted in that directory.
 .Pp  .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
Line 79  a nil-terminated architecture
Line 96  a nil-terminated architecture
 and a nil-terminated description.  and a nil-terminated description.
 .El  .El
 .Pp  .Pp
 Both the manual section and description may be zero-length.  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,
Line 134  utility is
Line 152  utility is
 .Ud  .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 172  to exit at once, possibly in the middle of parsing or 
Line 190  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 mandoc 1 ,
   .Xr btree 3 ,
   .Xr recno 3
 .Sh AUTHORS  .Sh AUTHORS
 The  The
 .Nm  .Nm

Legend:
Removed from v.1.2  
changed lines
  Added in v.1.3

CVSweb