=================================================================== RCS file: /cvs/mandoc/Attic/makewhatis.1,v retrieving revision 1.3 retrieving revision 1.8 diff -u -p -r1.3 -r1.8 --- mandoc/Attic/makewhatis.1 2011/05/26 23:01:26 1.3 +++ mandoc/Attic/makewhatis.1 2011/07/01 09:11:35 1.8 @@ -1,4 +1,4 @@ -.\" $Id: makewhatis.1,v 1.3 2011/05/26 23:01:26 kristaps Exp $ +.\" $Id: makewhatis.1,v 1.8 2011/07/01 09:11:35 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: May 26 2011 $ +.Dd $Mdocdate: July 1 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, @@ -87,32 +92,37 @@ length plus one) mapping to a 8-byte binary field cons keyword type and source .Sx Index Database record number. -The type, an unsigned 32-bit integer in host order, is one of the -following: +The type, a 32-bit bit-mask in host order, consists of the following +fields: .Pp .Bl -tag -width Ds -offset indent -compact .It Li 0x01 The name of a manual page as given in the NAME section. .It Li 0x02 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 +A utility name as given in the SYNOPSIS section. +.It Li 0x08 An include file as given in the SYNOPSIS section. -.It Li 0x05 +.It Li 0x10 A variable name as given in the SYNOPSIS section. -.It Li 0x06 +.It Li 0x20 A standard as given in the STANDARDS section. -.It Li 0x07 +.It Li 0x40 An author as given in the AUTHORS section. -.It Li 0x08 +.It Li 0x80 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. .El .Pp -If a value is encountered outside of this range, the database is -corrupt. -.Pp -The latter four bytes are a host-ordered record number within the +The last four bytes are a host-ordered record number within the .Sx Index Database . .Pp The