diff options
| author | Kristaps Dzonsons <kristaps@bsd.lv> | 2011-06-21 13:09:19 +0000 |
|---|---|---|
| committer | Kristaps Dzonsons <kristaps@bsd.lv> | 2011-06-21 13:09:19 +0000 |
| commit | def18ef5006a69910ed1dcf005645809052c2b1e (patch) | |
| tree | dc85cf987bc57ffbc6d7067120bfcd4ec90201ec /makewhatis.1 | |
| parent | a24a74d92491ea940f04d83e445e929d67f5d72a (diff) | |
| download | mandoc-def18ef5006a69910ed1dcf005645809052c2b1e.tar.gz | |
Make sure makewhatis.1 is documenting the correct bit-fields.
Diffstat (limited to 'makewhatis.1')
| -rw-r--r-- | makewhatis.1 | 21 |
1 files changed, 9 insertions, 12 deletions
diff --git a/makewhatis.1 b/makewhatis.1 index 0b0febd5..73aab84d 100644 --- a/makewhatis.1 +++ b/makewhatis.1 @@ -87,32 +87,29 @@ length plus one) mapping to a 8-byte binary field consisting of the 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. .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 |