summaryrefslogtreecommitdiffstats
path: root/mandocdb.8
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@openbsd.org>2011-12-25 21:00:23 +0000
committerIngo Schwarze <schwarze@openbsd.org>2011-12-25 21:00:23 +0000
commitded221b99d048a37cdadaf7d919805c6219db29f (patch)
tree271c3f9f91ce7f37d8e6b6067b874f65bd055c8d /mandocdb.8
parent53e6d06c1bdbc06c38e2aedcad452d656cd4734c (diff)
downloadmandoc-ded221b99d048a37cdadaf7d919805c6219db29f.tar.gz
Update the whatis.db database format.
While here, reference apropos(1) from the description, inspired by the makewhatis(8) manual.
Diffstat (limited to 'mandocdb.8')
-rw-r--r--mandocdb.818
1 files changed, 11 insertions, 7 deletions
diff --git a/mandocdb.8 b/mandocdb.8
index 3c603047..99469d4a 100644
--- a/mandocdb.8
+++ b/mandocdb.8
@@ -46,7 +46,13 @@ manuals and indexes them in a
.Sx Keyword Database
and
.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
By default,
.Nm
@@ -159,10 +165,11 @@ The keyword database,
is a
.Xr btree 3
database of NUL-terminated keywords (record length is non-zero string
-length plus one) mapping to a 12-byte binary field consisting of the
-64-bit keyword type and 32-bit source
+length plus one) mapping to a 16-byte binary field consisting of the
+64-bit keyword type and the 64-bit
.Sx Index Database
record number, both in network-byte order.
+.Pp
The type bit-mask consists of the following
values mapping into
.Xr mdoc 7
@@ -208,9 +215,6 @@ macro identifiers:
.It Li 0x0000001000000000ULL Ta \&Vt
.It Li 0x0000002000000000ULL Ta \&Xr
.El
-.Pp
-The last four bytes are a host-ordered record number within the
-.Sx Index Database .
.Sh IMPLEMENTATION NOTES
The time to construct a new database pair grows linearly with the
number of keywords in the input files.
@@ -252,7 +256,7 @@ error accessing input files.
Such errors cause
.Nm
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
.Sh DIAGNOSTICS
If the following errors occur, the