version 1.12, 2011/07/11 09:44:07 |
version 1.13, 2011/07/11 21:56:06 |
|
|
.Nd index UNIX manuals |
.Nd index UNIX manuals |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm |
.Nm |
.Op Fl v |
.Op Fl ruv |
.Op Fl d Ar dir |
.Op Fl d Ar dir |
.Ar |
.Ar |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
|
|
.Xr man 7 |
.Xr man 7 |
.Ux |
.Ux |
manual format. |
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 |
.It Fl v |
Verbose output. |
Verbose output. |
If specified once, prints the name of each indexed file. |
If specified once, prints the name of each indexed file. |
Line 50 If twice, prints keywords for each file. |
|
Line 59 If twice, prints keywords for each file. |
|
.Pp |
.Pp |
By default, |
By default, |
.Nm |
.Nm |
constructs the |
constructs a new |
.Sx Index Database |
.Sx Index Database |
and |
and |
.Sx Keyword Database |
.Sx Keyword Database |
in the current working directory. |
in the current working directory. |
|
Existing databases are truncated. |
.Pp |
.Pp |
If fatal parse errors are encountered, the offending file is printed to |
If fatal parse errors are encountered, the offending file is printed to |
stderr, omitted from the index, and the parse continues with the next |
stderr, omitted from the index, and the parse continues with the next |
|
|
.Nm |
.Nm |
utility is |
utility is |
.Ud |
.Ud |
|
.Sh IMPLEMENTATION NOTES |
|
The time to construct a new database pair grows linearly with the |
|
number of keywords in the input. |
|
However, removing or updating entries with |
|
.Fl r |
|
or |
|
.Fl u , |
|
respectively, grows as a multiple of the index length and input size. |
.Sh FILES |
.Sh FILES |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Pa mandoc.db |
.It Pa mandoc.db |