version 1.9, 2011/11/29 11:17:47 |
version 1.18, 2012/06/08 10:43:01 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" |
.\" |
.\" 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 anvW |
.Op Ar dir ... |
.Op Fl C Ar file |
.Nm |
.Nm |
.Op Fl v |
.Op Fl anvW |
|
.Ar dir ... |
|
.Nm |
|
.Op Fl nvW |
.Fl d Ar dir |
.Fl d Ar dir |
.Op Ar |
.Op Ar |
.Nm |
.Nm |
.Op Fl v |
.Op Fl nvW |
.Fl u Ar dir |
.Fl u Ar dir |
.Op Ar |
.Op Ar |
|
.Nm |
|
.Fl t Ar |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm |
.Nm |
utility extracts keywords from |
utility extracts keywords from |
.Ux |
.Ux |
manuals and indexes them in a |
manuals and indexes them in a database for fast retrieval by |
.Sx Keyword Database |
.Xr apropos 1 , |
|
.Xr whatis 1 , |
and |
and |
.Sx Index Database |
.Xr man 1 . |
for fast retrieval. |
|
.Pp |
.Pp |
By default, |
By default, |
.Nm |
.Nm |
creates databases in each |
creates a database in each |
.Ar dir |
.Ar dir |
using the files |
using the files |
.Sm off |
.Sm off |
|
|
.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 Ds |
.Bl -tag -width "-C file" |
.It Fl a |
.It Fl a |
Use all directories and files found below |
Use all directories and files found below |
.Ar dir ... . |
.Ar dir ... . |
|
.It Fl C Ar file |
|
Specify an alternative configuration |
|
.Ar file |
|
in |
|
.Xr man.conf 5 |
|
format. |
.It Fl d Ar dir |
.It Fl d Ar dir |
Merge (remove and re-add) |
Merge (remove and re-add) |
.Ar |
.Ar |
to the database in |
to the database in |
.Ar dir |
.Ar dir . |
without truncating it. |
.It Fl n |
|
Do not create or modify any database; |
|
scan and parse only. |
|
.It Fl t Ar |
|
Check the given |
|
.Ar files |
|
for potential problems. |
|
Implies |
|
.Fl a , |
|
.Fl n , |
|
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 |
from the database in |
from the database in |
.Ar dir |
.Ar dir . |
without truncating it. |
|
.It Fl v |
.It Fl v |
Verbose operation. |
Display all files added or removed to the index. |
Use once to display all files added or removed and twice for keywords as |
.It Fl W |
well. |
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 |
is printed to stderr, omitted from the index, and the parse continues |
is printed to stderr, omitted from the index, and the parse continues |
with the next input file. |
with the next input file. |
.Ss Index Database |
|
The index database, |
|
.Pa mandoc.index , |
|
is a |
|
.Xr recno 3 |
|
database with record values consisting of |
|
.Pp |
|
.Bl -enum -compact |
|
.It |
|
the string |
|
.Cm mdoc , |
|
.Cm man , |
|
or |
|
.Cm cat |
|
to indicate the file type |
|
.Po |
|
file in |
|
.Xr mdoc 7 , |
|
.Xr man 7 , |
|
and post-formatted, respectively |
|
.Pc , |
|
.It |
|
the filename, |
|
.It |
|
the manual section, |
|
.It |
|
the manual title, |
|
.It |
|
the architecture |
|
.Pq often empty , |
|
.It |
|
and the description. |
|
.El |
|
.Pp |
|
Each of the above is NUL-terminated. |
|
.Pp |
|
Both the manual section and description may be zero-length if the record |
|
is unassigned. |
|
Entries are sequentially-numbered, but the filenames are unordered. |
|
.Ss Keyword Database |
|
The keyword database, |
|
.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 8-byte binary field consisting of the |
|
keyword type and source |
|
.Sx Index Database |
|
record number. |
|
The type, a 64-bit bit-mask in host order, consists of the following |
|
values mapping into |
|
.Xr mdoc 7 |
|
macro identifiers: |
|
.Pp |
|
.Bl -column "x0x0000000000000001ULLx" "xLix" -offset indent -compact |
|
.It Li 0x0000000000000001ULL Ta \&An |
|
.It Li 0x0000000000000002ULL Ta \&Ar |
|
.It Li 0x0000000000000004ULL Ta \&At |
|
.It Li 0x0000000000000008ULL Ta \&Bsx |
|
.It Li 0x0000000000000010ULL Ta \&Bx |
|
.It Li 0x0000000000000020ULL Ta \&Cd |
|
.It Li 0x0000000000000040ULL Ta \&Cm |
|
.It Li 0x0000000000000080ULL Ta \&Dv |
|
.It Li 0x0000000000000100ULL Ta \&Dx |
|
.It Li 0x0000000000000200ULL Ta \&Em |
|
.It Li 0x0000000000000400ULL Ta \&Er |
|
.It Li 0x0000000000000800ULL Ta \&Ev |
|
.It Li 0x0000000000001000ULL Ta \&Fa |
|
.It Li 0x0000000000002000ULL Ta \&Fl |
|
.It Li 0x0000000000004000ULL Ta \&Fn |
|
.It Li 0x0000000000008000ULL Ta \&Ft |
|
.It Li 0x0000000000010000ULL Ta \&Fx |
|
.It Li 0x0000000000020000ULL Ta \&Ic |
|
.It Li 0x0000000000040000ULL Ta \&In |
|
.It Li 0x0000000000080000ULL Ta \&Lb |
|
.It Li 0x0000000000100000ULL Ta \&Li |
|
.It Li 0x0000000000200000ULL Ta \&Lk |
|
.It Li 0x0000000000400000ULL Ta \&Ms |
|
.It Li 0x0000000000800000ULL Ta \&Mt |
|
.It Li 0x0000000001000000ULL Ta \&Nd |
|
.It Li 0x0000000002000000ULL Ta \&Nm |
|
.It Li 0x0000000004000000ULL Ta \&Nx |
|
.It Li 0x0000000008000000ULL Ta \&Ox |
|
.It Li 0x0000000010000000ULL Ta \&Pa |
|
.It Li 0x0000000020000000ULL Ta \&Rs |
|
.It Li 0x0000000040000000ULL Ta \&Sh |
|
.It Li 0x0000000080000000ULL Ta \&Ss |
|
.It Li 0x0000000100000000ULL Ta \&St |
|
.It Li 0x0000000200000000ULL Ta \&Sy |
|
.It Li 0x0000000400000000ULL Ta \&Tn |
|
.It Li 0x0000000800000000ULL Ta \&Va |
|
.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. |
|
However, removing or updating entries with |
|
.Fl u |
|
or |
|
.Fl d , |
|
respectively, grows as a multiple of the index length and input size. |
|
.Sh FILES |
.Sh FILES |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Pa mandoc.db |
.It Pa mandocdb.db |
A |
A database of manpages relative to the directory of the file. |
.Xr btree 3 |
This file is portable across architectures and systems, so long as the |
keyword database mapping keywords to a type and file reference in |
manpage hierarchy it indexes does not change. |
.Pa mandoc.index . |
.It Pa mandocdb.db~ |
.It Pa mandoc.index |
A temporary database used during scanning and parsing. |
A |
|
.Xr recno 3 |
|
database of indexed file-names. |
|
.El |
.El |
.Sh EXIT STATUS |
.Sh EXIT STATUS |
The |
.Ex -std |
.Nm |
|
utility exits with one of the following values: |
|
.Pp |
|
.Bl -tag -width Ds -compact |
|
.It 0 |
|
No errors occurred. |
|
.It 5 |
|
Invalid command line arguments were specified. |
|
No input files have been read. |
|
.It 6 |
|
An operating system error occurred, for example memory exhaustion or an |
|
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 . |
|
.El |
|
.Sh SEE ALSO |
.Sh SEE ALSO |
|
.Xr apropos 1 , |
.Xr man 1 , |
.Xr man 1 , |
.Xr btree 3 , |
.Xr whatis 1 , |
.Xr recno 3 |
.Xr man.conf 5 |
.Sh AUTHORS |
.Sh AUTHORS |
The |
The |
.Nm |
.Nm |
utility was written by |
utility was written by |
.An Kristaps Dzonsons , |
.An Kristaps Dzonsons , |
.Mt kristaps@bsd.lv . |
.Mt kristaps@bsd.lv , |
|
and |
|
.An Ingo Schwarze , |
|
.Mt schwarze@openbsd.org . |