version 1.2, 2011/05/14 23:43:03 |
version 1.11, 2011/07/11 09:40:49 |
|
|
.Nd index UNIX manuals |
.Nd index UNIX manuals |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm |
.Nm |
|
.Op Fl v |
.Op Fl d Ar dir |
.Op Fl d Ar dir |
.Ar |
.Ar |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
|
|
.Xr man 7 |
.Xr man 7 |
.Ux |
.Ux |
manual format. |
manual format. |
|
.It Fl v |
|
Verbose output. |
|
If specified once, prints the name of each indexed file. |
|
If twice, prints keywords for each file. |
.El |
.El |
.Pp |
.Pp |
By default, |
By default, |
Line 87 length plus one) mapping to a 8-byte binary field cons |
|
Line 92 length plus one) mapping to a 8-byte binary field cons |
|
keyword type and source |
keyword type and source |
.Sx Index Database |
.Sx Index Database |
record number. |
record number. |
The type, an unsigned 32-bit integer in host order, is one of the |
The type, a 32-bit bit-mask in host order, consists of the following |
following: |
fields: |
.Pp |
.Pp |
.Bl -tag -width Ds -offset indent -compact |
.Bl -tag -width Ds -offset indent -compact |
.It Li 0x01 |
.It Li 0x01 |
The name of a manual page as given in the NAME section. |
The name of a manual page as given in the NAME section. |
.It Li 0x02 |
.It Li 0x02 |
A function prototype name as given in the SYNOPSIS section. |
A function prototype name as given in the SYNOPSIS section. |
.It Li 0x03 |
|
A utility name as given in the SYNOPSIS section. |
|
.It Li 0x04 |
.It Li 0x04 |
|
A utility name as given in the SYNOPSIS section. |
|
.It Li 0x08 |
An include file as given in the SYNOPSIS section. |
An include file as given in the SYNOPSIS section. |
.It Li 0x05 |
.It Li 0x10 |
A variable name as given in the SYNOPSIS section. |
A variable name as given in the SYNOPSIS section. |
.It Li 0x06 |
.It Li 0x20 |
A standard as given in the STANDARDS section. |
A standard as given in the STANDARDS section. |
.It Li 0x07 |
.It Li 0x40 |
An author as given in the AUTHORS section. |
An author as given in the AUTHORS section. |
.It Li 0x08 |
.It Li 0x80 |
A configuration as given in the SYNOPSIS section. |
A configuration as given in the SYNOPSIS section. |
|
.It Li 0x100 |
|
Free-form descriptive text as given in the NAME section. |
|
.It Li 0x200 |
|
Cross-links between manuals. |
|
Listed as the link name, then a period, then the link section. |
|
If the link has no section, the period terminates the string. |
|
.It Li 0x400 |
|
Path reference as given in the FILES section. |
|
.It Li 0x800 |
|
Environment variable as given in the ENVIRONMENT section. |
|
.It Li 0x1000 |
|
Error codes as given in the ERRORS section. |
.El |
.El |
.Pp |
.Pp |
If a value is encountered outside of this range, the database is |
The last four bytes are a host-ordered record number within the |
corrupt. |
|
.Pp |
|
The latter four bytes are a host-ordered record number within the |
|
.Sx Index Database . |
.Sx Index Database . |
.Pp |
.Pp |
The |
The |
|
|
.Xr btree 3 |
.Xr btree 3 |
keyword database mapping keywords to a type and file reference in |
keyword database mapping keywords to a type and file reference in |
.Pa mandoc.index . |
.Pa mandoc.index . |
.It Pa mandoc.db~ |
|
Working copy of |
|
.Pa mandoc.db . |
|
.It Pa mandoc.index |
.It Pa mandoc.index |
A |
A |
.Xr recno 3 |
.Xr recno 3 |
database of indexed file-names. |
database of indexed file-names. |
.It Pa mandoc.index~ |
|
Working copy of |
|
.Pa mandoc.index . |
|
.El |
.El |
.Sh EXIT STATUS |
.Sh EXIT STATUS |
.Ex -std |
.Ex -std |
|
|
.Nm |
.Nm |
utility was written by |
utility was written by |
.An Kristaps Dzonsons Aq kristaps@bsd.lv . |
.An Kristaps Dzonsons Aq kristaps@bsd.lv . |
.Sh CAVEATS |
|
Only |
|
.Xr mdoc 7 |
|
manuals are processed. |
|