version 1.13, 2011/12/16 08:04:34 |
version 1.17.2.2, 2014/03/17 09:04:52 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> |
|
.\" Copyright (c) 2011, 2012 Ingo Schwarze <schwarze@openbsd.org> |
.\" |
.\" |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" purpose with or without fee is hereby granted, provided that the above |
.\" purpose with or without fee is hereby granted, provided that the above |
|
|
.Nd index UNIX manuals |
.Nd index UNIX manuals |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm |
.Nm |
.Op Fl av |
.Op Fl avW |
.Op Fl C Ar file |
.Op Fl C Ar file |
.Nm |
.Nm |
.Op Fl av |
.Op Fl avW |
.Ar dir ... |
.Ar dir ... |
.Nm |
.Nm |
.Op Fl v |
.Op Fl vW |
.Fl d Ar dir |
.Fl d Ar dir |
.Op Ar |
.Op Ar |
.Nm |
.Nm |
.Op Fl v |
.Op Fl vW |
.Fl u Ar dir |
.Fl u Ar dir |
.Op Ar |
.Op Ar |
|
.Nm |
|
.Fl t Ar |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm |
.Nm |
Line 44 manuals and indexes them in a |
|
Line 47 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 |
|
|
.Op Ar arch Li / |
.Op Ar arch Li / |
.Ar title . Sy 0 |
.Ar title . Sy 0 |
.Sm on |
.Sm on |
in that directory; |
in that directory. |
existing databases are truncated. |
Existing databases are replaced. |
If |
If |
.Ar dir |
.Ar dir |
is not provided, |
is not provided, |
.Nm |
.Nm |
uses the default paths stipulated by |
uses the default paths stipulated by |
.Xr man 1 . |
.Xr manpath 1 , |
|
or |
|
.Xr man.conf 5 . |
.Pp |
.Pp |
The arguments are as follows: |
The arguments are as follows: |
.Bl -tag -width "-C file" |
.Bl -tag -width "-C file" |
Line 88 Merge (remove and re-add) |
|
Line 99 Merge (remove and re-add) |
|
to the database in |
to the database in |
.Ar dir |
.Ar dir |
without truncating it. |
without truncating it. |
|
.It Fl t Ar |
|
Check the given |
|
.Ar files |
|
for potential problems. |
|
No databases are modified. |
|
Implies |
|
.Fl a |
|
and |
|
.Fl W . |
|
All diagnostic messages are printed to the standard output; |
|
the standard error output is not used. |
.It Fl u Ar dir |
.It Fl u Ar dir |
Remove |
Remove |
.Ar |
.Ar |
Line 96 from the database in |
|
Line 118 from the database in |
|
without truncating it. |
without truncating it. |
.It Fl v |
.It Fl v |
Display all files added or removed to the index. |
Display all files added or removed to the index. |
|
.It Fl W |
|
Print warnings about potential problems with manual pages |
|
to the standard error output. |
.El |
.El |
.Pp |
.Pp |
If fatal parse errors are encountered while parsing, the offending file |
If fatal parse errors are encountered while parsing, the offending file |
Line 110 database with record values consisting of |
|
Line 135 database with record values consisting of |
|
.Pp |
.Pp |
.Bl -enum -compact |
.Bl -enum -compact |
.It |
.It |
the string |
the character |
.Cm mdoc , |
.Cm d , |
.Cm man , |
.Cm a , |
or |
or |
.Cm cat |
.Cm c |
to indicate the file type |
to indicate the file type |
.Po |
.Po |
file in |
|
.Xr mdoc 7 , |
.Xr mdoc 7 , |
.Xr man 7 , |
.Xr man 7 , |
and post-formatted, respectively |
and post-formatted, respectively |
Line 137 and the description. |
|
Line 161 and the description. |
|
.Pp |
.Pp |
Each of the above is NUL-terminated. |
Each of the above is NUL-terminated. |
.Pp |
.Pp |
Both the manual section and description may be zero-length if the record |
If the record value is zero-length, it is unassigned. |
is unassigned. |
|
Entries are sequentially-numbered, but the filenames are unordered. |
|
.Ss Keyword Database |
.Ss Keyword Database |
The keyword database, |
The keyword database, |
.Pa mandoc.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 195 macro identifiers: |
|
Line 218 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 239 error accessing input files. |
|
Line 259 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 . |
and |
|
.An Ingo Schwarze Aq Mt schwarze@openbsd.org . |