diff options
Diffstat (limited to 'mandocdb.8')
| -rw-r--r-- | mandocdb.8 | 66 |
1 files changed, 43 insertions, 23 deletions
@@ -22,38 +22,55 @@ .Nd index UNIX manuals .Sh SYNOPSIS .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 The .Nm utility extracts keywords from .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: .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... -Recursively scan for -.Xr mdoc 7 -and -.Xr man 7 -.Ux -manual files in each +Recursively add files rooted at each .Ar dir -directory. -.Sx Index Database -and -.Sx Keyword Database -files are installed in each -.Ar dir -directory. +to the databases in the respective +.Ar dir . 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 .Pp By default, .Nm -does nothing: the -.Ar dir... -invocation must be used. +creates databases in each +.Ar dir +using files rooted in that directory. .Pp If fatal parse errors are encountered while parsing, the offending file is printed to stderr, omitted from the index, and the parse continues @@ -79,7 +96,8 @@ a nil-terminated architecture and a nil-terminated description. .El .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. .Ss Keyword Database The keyword database, @@ -134,11 +152,11 @@ utility is .Ud .Sh IMPLEMENTATION NOTES 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 -.Fl r +.Fl u or -.Fl u , +.Fl d , respectively, grows as a multiple of the index length and input size. .Sh FILES .Bl -tag -width Ds @@ -172,7 +190,9 @@ to exit at once, possibly in the middle of parsing or formatting a file. The output databases are corrupt and should be removed . .El .Sh SEE ALSO -.Xr mandoc 1 +.Xr mandoc 1 , +.Xr btree 3 , +.Xr recno 3 .Sh AUTHORS The .Nm |