=================================================================== RCS file: /cvs/mandoc/Attic/mandocdb.8,v retrieving revision 1.2 retrieving revision 1.7 diff -u -p -r1.2 -r1.7 --- mandoc/Attic/mandocdb.8 2011/07/15 10:15:24 1.2 +++ mandoc/Attic/mandocdb.8 2011/11/26 11:23:56 1.7 @@ -1,4 +1,4 @@ -.\" $Id: mandocdb.8,v 1.2 2011/07/15 10:15:24 kristaps Exp $ +.\" $Id: mandocdb.8,v 1.7 2011/11/26 11:23:56 schwarze Exp $ .\" .\" Copyright (c) 2011 Kristaps Dzonsons .\" @@ -14,7 +14,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: July 15 2011 $ +.Dd $Mdocdate: November 26 2011 $ .Dt MANDOCDB 8 .Os .Sh NAME @@ -22,38 +22,72 @@ .Nd index UNIX manuals .Sh SYNOPSIS .Nm -.Ar dir... +.Op Fl av +.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. +.Pp The arguments are as follows: .Bl -tag -width Ds +.It Fl a +Use all directories and files found below +.Ar dir ... . +By default, only files matching +.Sm off +.Sy man Ar section Li / +.Op Ar arch Li / +.Ar title . section +.Sm on +will be used. +.It Fl d Ar dir +Merge (remove and re-add) +.Ar +from the databases in +.Ar dir . +.It Fl u Ar dir +Remove +.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. +If +.Ar dir +is not provided, +.Nm +uses the default paths stipulated by +.Xr man 1 . .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 +113,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 +169,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,9 +207,13 @@ to exit at once, possibly in the middle of parsing or The output databases are corrupt and should be removed . .El .Sh SEE ALSO -.Xr mandoc 1 +.Xr man 1 , +.Xr mandoc 1 , +.Xr btree 3 , +.Xr recno 3 .Sh AUTHORS The .Nm utility was written by -.An Kristaps Dzonsons Aq kristaps@bsd.lv . +.An Kristaps Dzonsons , +.Mt kristaps@bsd.lv .