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 | c3e574a1addab4c2ae74e07c8eefd5c7afb65454 (patch) | |
| tree | 347284e7f1c3ad7364df89ecde1df518037f297d /makewhatis.1 | |
| parent | 3d6aff2685eed490d41db9d6fbe72d679cb60492 (diff) | |
| download | mandoc-c3e574a1addab4c2ae74e07c8eefd5c7afb65454.tar.gz mandoc-c3e574a1addab4c2ae74e07c8eefd5c7afb65454.tar.zst mandoc-c3e574a1addab4c2ae74e07c8eefd5c7afb65454.zip | |
Make sure makewhatis.1 is documenting the correct bit-fields.
Diffstat (limited to 'makewhatis.1')
| -rw-r--r-- | makewhatis.1 | 25 |
1 files changed, 11 insertions, 14 deletions
diff --git a/makewhatis.1 b/makewhatis.1 index eae3cc21..e556b4c4 100644 --- a/makewhatis.1 +++ b/makewhatis.1 @@ -1,4 +1,4 @@ -.\" $Id: makewhatis.1,v 1.3 2011/05/26 23:01:26 kristaps Exp $ +.\" $Id: makewhatis.1,v 1.4 2011/06/21 13:09:19 kristaps Exp $ .\" .\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv> .\" @@ -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: June 21 2011 $ .Dt MAKEWHATIS 1 .Os .Sh NAME @@ -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 |