version 1.16, 2011/12/25 16:53:51 |
version 1.17, 2011/12/25 21:00:23 |
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 159 The keyword database, |
|
Line 165 The keyword database, |
|
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. |
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 |