version 1.5, 2011/06/21 14:16:05 |
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 109 An author as given in the AUTHORS section. |
|
Line 114 An author as given in the AUTHORS section. |
|
A configuration as given in the SYNOPSIS section. |
A configuration as given in the SYNOPSIS section. |
.It Li 0x100 |
.It Li 0x100 |
Free-form descriptive text as given in the NAME section. |
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 |
The last four bytes are a host-ordered record number within the |
The last four bytes are a host-ordered record number within 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 |