version 1.3, 2011/07/15 17:59:29 |
version 1.7, 2011/11/26 11:23:56 |
|
|
.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 |
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 |
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 ... . |
|
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 |
.It Fl d Ar dir |
Remove |
Merge (remove and re-add) |
.Ar |
.Ar |
from the databases in |
from the databases in |
.Ar dir . |
.Ar dir . |
.It Fl u Ar dir |
.It Fl u Ar dir |
Update (remove and re-add) |
Remove |
.Ar |
.Ar |
from the databases in |
from the databases in |
.Ar dir . |
.Ar dir . |
|
|
creates databases in each |
creates databases in each |
.Ar dir |
.Ar dir |
using files rooted in that directory. |
using files rooted in that directory. |
|
If |
|
.Ar dir |
|
is not provided, |
|
.Nm |
|
uses the default paths stipulated by |
|
.Xr man 1 . |
.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 190 to exit at once, possibly in the middle of parsing or |
|
Line 207 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 215 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 . |