diff options
author | Ingo Schwarze <schwarze@cvs.openbsd.org> | 2011-12-25 20:57:59 +0000 |
---|---|---|
committer | Ingo Schwarze <schwarze@cvs.openbsd.org> | 2011-12-25 20:57:59 +0000 |
commit | 48f5daff7438a7ba19e273fd3585a4ae2f0960ea (patch) | |
tree | 46e1b696e393870142c4c07ca4243f9a40afdb5b /usr.bin | |
parent | e6c187bbcb4af9cb1c8da37ece01dede573d2e6e (diff) |
Update the whatis.db database format.
While here, reference apropos(1) from the description,
inspired by the makewhatis(8) manual.
Diffstat (limited to 'usr.bin')
-rw-r--r-- | usr.bin/mandoc/mandocdb.8 | 20 |
1 files changed, 12 insertions, 8 deletions
diff --git a/usr.bin/mandoc/mandocdb.8 b/usr.bin/mandoc/mandocdb.8 index 298117ea2b8..11205c61a94 100644 --- a/usr.bin/mandoc/mandocdb.8 +++ b/usr.bin/mandoc/mandocdb.8 @@ -1,4 +1,4 @@ -.\" $Id: mandocdb.8,v 1.15 2011/12/25 16:52:55 schwarze Exp $ +.\" $Id: mandocdb.8,v 1.16 2011/12/25 20:57:58 schwarze Exp $ .\" .\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv> .\" @@ -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 |