version 1.13, 2011/12/16 08:04:34 |
version 1.16, 2011/12/25 16:53:51 |
|
|
.Nd index UNIX manuals |
.Nd index UNIX manuals |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm |
.Nm |
.Op Fl av |
.Op Fl avW |
.Op Fl C Ar file |
.Op Fl C Ar file |
.Nm |
.Nm |
.Op Fl av |
.Op Fl avW |
.Ar dir ... |
.Ar dir ... |
.Nm |
.Nm |
.Op Fl v |
.Op Fl vW |
.Fl d Ar dir |
.Fl d Ar dir |
.Op Ar |
.Op Ar |
.Nm |
.Nm |
.Op Fl v |
.Op Fl vW |
.Fl u Ar dir |
.Fl u Ar dir |
.Op Ar |
.Op Ar |
|
.Nm |
|
.Fl t Ar |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm |
.Nm |
Line 88 Merge (remove and re-add) |
|
Line 90 Merge (remove and re-add) |
|
to the database in |
to the database in |
.Ar dir |
.Ar dir |
without truncating it. |
without truncating it. |
|
.It Fl t Ar |
|
Check the given |
|
.Ar files |
|
for potential problems. |
|
No databases are modified. |
|
Implies |
|
.Fl a |
|
and |
|
.Fl W . |
|
All diagnostic messages are printed to the standard output; |
|
the standard error output is not used. |
.It Fl u Ar dir |
.It Fl u Ar dir |
Remove |
Remove |
.Ar |
.Ar |
Line 96 from the database in |
|
Line 109 from the database in |
|
without truncating it. |
without truncating it. |
.It Fl v |
.It Fl v |
Display all files added or removed to the index. |
Display all files added or removed to the index. |
|
.It Fl W |
|
Print warnings about potential problems with manual pages |
|
to the standard error output. |
.El |
.El |
.Pp |
.Pp |
If fatal parse errors are encountered while parsing, the offending file |
If fatal parse errors are encountered while parsing, the offending file |
Line 103 is printed to stderr, omitted from the index, and the |
|
Line 119 is printed to stderr, omitted from the index, and the |
|
with the next input file. |
with the next input file. |
.Ss Index Database |
.Ss Index Database |
The index database, |
The index database, |
.Pa mandoc.index , |
.Pa whatis.index , |
is a |
is a |
.Xr recno 3 |
.Xr recno 3 |
database with record values consisting of |
database with record values consisting of |
.Pp |
.Pp |
.Bl -enum -compact |
.Bl -enum -compact |
.It |
.It |
the string |
the character |
.Cm mdoc , |
.Cm d , |
.Cm man , |
.Cm a , |
or |
or |
.Cm cat |
.Cm c |
to indicate the file type |
to indicate the file type |
.Po |
.Po |
file in |
|
.Xr mdoc 7 , |
.Xr mdoc 7 , |
.Xr man 7 , |
.Xr man 7 , |
and post-formatted, respectively |
and post-formatted, respectively |
Line 137 and the description. |
|
Line 152 and the description. |
|
.Pp |
.Pp |
Each of the above is NUL-terminated. |
Each of the above is NUL-terminated. |
.Pp |
.Pp |
Both the manual section and description may be zero-length if the record |
If the record value is zero-length, it is unassigned. |
is unassigned. |
|
Entries are sequentially-numbered, but the filenames are unordered. |
|
.Ss Keyword Database |
.Ss Keyword Database |
The keyword database, |
The keyword database, |
.Pa mandoc.db , |
.Pa whatis.db , |
is a |
is a |
.Xr btree 3 |
.Xr btree 3 |
database of NUL-terminated keywords (record length is non-zero string |
database of NUL-terminated keywords (record length is non-zero string |
|
|
respectively, grows as a multiple of the index length and input size. |
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 whatis.db |
A |
A |
.Xr btree 3 |
.Xr btree 3 |
keyword database mapping keywords to a type and file reference in |
keyword database mapping keywords to a type and file reference in |
.Pa mandoc.index . |
.Pa whatis.index . |
.It Pa mandoc.index |
.It Pa whatis.index |
A |
A |
.Xr recno 3 |
.Xr recno 3 |
database of indexed file-names. |
database of indexed file-names. |