=================================================================== RCS file: /cvs/mandoc/Attic/makewhatis.1,v retrieving revision 1.5 retrieving revision 1.12 diff -u -p -r1.5 -r1.12 --- mandoc/Attic/makewhatis.1 2011/06/21 14:16:05 1.5 +++ mandoc/Attic/makewhatis.1 2011/07/11 09:44:07 1.12 @@ -1,4 +1,4 @@ -.\" $Id: makewhatis.1,v 1.5 2011/06/21 14:16:05 kristaps Exp $ +.\" $Id: makewhatis.1,v 1.12 2011/07/11 09:44:07 kristaps 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: June 21 2011 $ +.Dd $Mdocdate: July 11 2011 $ .Dt MAKEWHATIS 1 .Os .Sh NAME @@ -22,6 +22,7 @@ .Nd index UNIX manuals .Sh SYNOPSIS .Nm +.Op Fl v .Op Fl d Ar dir .Ar .Sh DESCRIPTION @@ -41,6 +42,10 @@ or .Xr man 7 .Ux 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 .Pp By default, @@ -109,6 +114,16 @@ An author as given in the AUTHORS 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 .Pp The last four bytes are a host-ordered record number within the @@ -125,19 +140,30 @@ A .Xr btree 3 keyword database mapping keywords to a type and file reference in .Pa mandoc.index . -.It Pa mandoc.db~ -Working copy of -.Pa mandoc.db . .It Pa mandoc.index A .Xr recno 3 database of indexed file-names. -.It Pa mandoc.index~ -Working copy of -.Pa mandoc.index . .El .Sh EXIT STATUS -.Ex -std +The +.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 .Xr mandoc 1 .Sh AUTHORS