version 1.16, 2011/12/25 16:53:51 |
version 1.17.2.1, 2013/09/18 01:04:07 |
Line 46 manuals and indexes them in a |
|
Line 46 manuals and indexes them in a |
|
.Sx Keyword Database |
.Sx Keyword Database |
and |
and |
.Sx Index Database |
.Sx Index Database |
for fast retrieval. |
for fast retrieval by |
|
.Xr apropos 1 , |
|
.Xr whatis 1 , |
|
and |
|
.Xr man 1 Ns 's |
|
.Fl k |
|
option. |
.Pp |
.Pp |
By default, |
By default, |
.Nm |
.Nm |
Line 119 is printed to stderr, omitted from the index, and the |
|
Line 125 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 whatis.index , |
.Pa mandoc.index , |
is a |
is a |
.Xr recno 3 |
.Xr recno 3 |
database with record values consisting of |
database with record values consisting of |
Line 155 Each of the above is NUL-terminated. |
|
Line 161 Each of the above is NUL-terminated. |
|
If the record value is zero-length, it is unassigned. |
If the record value is zero-length, it is unassigned. |
.Ss Keyword Database |
.Ss Keyword Database |
The keyword database, |
The keyword database, |
.Pa whatis.db , |
.Pa mandoc.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 |
length plus one) mapping to a 12-byte binary field consisting of the |
length plus one) mapping to a 16-byte binary field consisting of the |
64-bit keyword type and 32-bit source |
64-bit keyword type and the 64-bit |
.Sx Index Database |
.Sx Index Database |
record number, both in network-byte order. |
record number, both in network-byte order. |
|
.Pp |
The type bit-mask consists of the following |
The type bit-mask consists of the following |
values mapping into |
values mapping into |
.Xr mdoc 7 |
.Xr mdoc 7 |
Line 208 macro identifiers: |
|
Line 215 macro identifiers: |
|
.It Li 0x0000001000000000ULL Ta \&Vt |
.It Li 0x0000001000000000ULL Ta \&Vt |
.It Li 0x0000002000000000ULL Ta \&Xr |
.It Li 0x0000002000000000ULL Ta \&Xr |
.El |
.El |
.Pp |
|
The last four bytes are a host-ordered record number within the |
|
.Sx Index Database . |
|
.Sh IMPLEMENTATION NOTES |
.Sh IMPLEMENTATION NOTES |
The time to construct a new database pair grows linearly with the |
The time to construct a new database pair grows linearly with the |
number of keywords in the input files. |
number of keywords in the input files. |
|
|
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 whatis.db |
.It Pa mandoc.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 whatis.index . |
.Pa mandoc.index . |
.It Pa whatis.index |
.It Pa mandoc.index |
A |
A |
.Xr recno 3 |
.Xr recno 3 |
database of indexed file-names. |
database of indexed file-names. |
Line 252 error accessing input files. |
|
Line 256 error accessing input files. |
|
Such errors cause |
Such errors cause |
.Nm |
.Nm |
to exit at once, possibly in the middle of parsing or formatting a file. |
to exit at once, possibly in the middle of parsing or formatting a file. |
The output databases are corrupt and should be removed . |
The output databases are corrupt and should be removed. |
.El |
.El |
.Sh DIAGNOSTICS |
.Sh DIAGNOSTICS |
If the following errors occur, the |
If the following errors occur, the |
|
|
.Xr btree 3 , |
.Xr btree 3 , |
.Xr recno 3 , |
.Xr recno 3 , |
.Xr man.conf 5 |
.Xr man.conf 5 |
.Sh AUTHORS |
.Sh HISTORY |
|
A |
|
.Nm makewhatis |
|
utility first appeared in |
|
.Bx 2 . |
|
It was rewritten in |
|
.Xr perl 1 |
|
for |
|
.Ox 2.7 |
|
and in C for |
|
.Ox 5.1 . |
|
.Pp |
The |
The |
|
.Ar dir |
|
argument first appeared in |
|
.Nx 1.0 ; |
|
the options |
|
.Fl dtu |
|
in |
|
.Ox 2.7 ; |
|
and the options |
|
.Fl aCvW |
|
in |
|
.Ox 5.1 . |
|
.Sh AUTHORS |
|
.An -nosplit |
|
.An Bill Joy |
|
wrote the original |
|
.Bx |
|
.Nm makewhatis |
|
in February 1979, |
|
.An Marc Espie |
|
started the Perl version in 2000, |
|
and the current version of |
.Nm |
.Nm |
utility was written by |
was written by |
.An Kristaps Dzonsons , |
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv . |
.Mt kristaps@bsd.lv . |
|