diff options
Diffstat (limited to 'mandocdb.8')
| -rw-r--r-- | mandocdb.8 | 55 |
1 files changed, 22 insertions, 33 deletions
@@ -1,4 +1,4 @@ -.\" $Id: mandocdb.8,v 1.1 2011/07/14 14:36:37 schwarze Exp $ +.\" $Id: mandocdb.8,v 1.2 2011/07/15 10:15:24 kristaps Exp $ .\" .\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv> .\" @@ -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 14 2011 $ +.Dd $Mdocdate: July 15 2011 $ .Dt MANDOCDB 8 .Os .Sh NAME @@ -22,9 +22,7 @@ .Nd index UNIX manuals .Sh SYNOPSIS .Nm -.Op Fl ruv -.Op Fl d Ar dir -.Ar +.Ar dir... .Sh DESCRIPTION The .Nm @@ -33,42 +31,33 @@ utility extracts keywords from manuals and indexes them for fast retrieval. The arguments are as follows: .Bl -tag -width Ds -.It Fl d Ar dir -The directory into which to write the keyword and index databases. -.It Ar -Read input from zero or more files in +.It Ar dir... +Recursively scan for .Xr mdoc 7 -or +and .Xr man 7 .Ux -manual format. -.It Fl r -Remove entries. -This will remove the index and keyword references. -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 -Verbose output. -If specified once, prints the name of each indexed file. -If twice, prints keywords for each file. -.El -.Pp -By default, -.Nm -constructs a new +manual files in each +.Ar dir +directory. .Sx Index Database and .Sx Keyword Database -in the current working directory. +files are installed in each +.Ar dir +directory. Existing databases are truncated. +.El +.Pp +By default, +.Nm +does nothing: the +.Ar dir... +invocation must be used. .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. +If fatal parse errors are encountered while parsing, the offending file +is printed to stderr, omitted from the index, and the parse continues +with the next input file. .Ss Index Database The index database, .Pa mandoc.index , |