=================================================================== RCS file: /cvs/mandoc/Attic/mandocdb.8,v retrieving revision 1.16 retrieving revision 1.17.2.1 diff -u -p -r1.16 -r1.17.2.1 --- mandoc/Attic/mandocdb.8 2011/12/25 16:53:51 1.16 +++ mandoc/Attic/mandocdb.8 2013/09/18 01:04:07 1.17.2.1 @@ -1,4 +1,4 @@ -.\" $Id: mandocdb.8,v 1.16 2011/12/25 16:53:51 schwarze Exp $ +.\" $Id: mandocdb.8,v 1.17.2.1 2013/09/18 01:04:07 schwarze Exp $ .\" .\" Copyright (c) 2011 Kristaps Dzonsons .\" @@ -14,7 +14,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: December 25 2011 $ +.Dd $Mdocdate: September 18 2013 $ .Dt MANDOCDB 8 .Os .Sh NAME @@ -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 @@ -119,7 +125,7 @@ is printed to stderr, omitted from the index, and the with the next input file. .Ss Index Database The index database, -.Pa whatis.index , +.Pa mandoc.index , is a .Xr recno 3 database with record values consisting of @@ -155,14 +161,15 @@ Each of the above is NUL-terminated. If the record value is zero-length, it is unassigned. .Ss Keyword Database The keyword database, -.Pa whatis.db , +.Pa mandoc.db , 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. @@ -221,12 +225,12 @@ or respectively, grows as a multiple of the index length and input size. .Sh FILES .Bl -tag -width Ds -.It Pa whatis.db +.It Pa mandoc.db A .Xr btree 3 keyword database mapping keywords to a type and file reference in -.Pa whatis.index . -.It Pa whatis.index +.Pa mandoc.index . +.It Pa mandoc.index A .Xr recno 3 database of indexed file-names. @@ -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 @@ -281,9 +285,40 @@ arguments. .Xr btree 3 , .Xr recno 3 , .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 +.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 -utility was written by -.An Kristaps Dzonsons , -.Mt kristaps@bsd.lv . +was written by +.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .