Subject: lib/3488: man pages missing #include synopsis, link flags, see-also refs
To: None <gnats-bugs@gnats.netbsd.org>
From: Jon Buller <jonb@metronet.com>
List: netbsd-bugs
Date: 04/13/1997 22:30:15
>Number: 3488
>Category: lib
>Synopsis: man pages missing #include synopsis, link flags, see-also refs
>Confidential: no
>Severity: non-critical
>Priority: low
>Responsible: lib-bug-people (Library Bug People)
>State: open
>Class: doc-bug
>Submitter-Id: net
>Arrival-Date: Sun Apr 13 20:20:02 1997
>Last-Modified:
>Originator: Jon Buller
>Organization:
>Release: NetBSD-current Mar 20, 1997
>Environment:
System: NetBSD bullbox.jb.heeia.hi.us 1.2C NetBSD 1.2C (BULLBOX) #9: Wed Feb 12 09:18:55 CST 1997 jonb@bullbox.jb.heeia.hi.us:/usr/src/sys/arch/pc532/compile/BULLBOX pc532
>Description:
The man page to crypt does not specify where to get the prototype
from (unistd.h) It also does not specify that -lcrypt must be
added to the cc command arguments...
Another known problem is isnan(3) and isinf(3) properly
referencing math(3) but math(3) making no mention of isnan(3)
or isinf(3).
I suspect many other man pages have these kinds of problems,
and if desired, I could work on making an initial list of
some of the needed changes.
>How-To-Repeat:
type man crypt
>Fix:
crypt(3) #include reference patch and math(3) isnan(3)
reference patch follows. I'm not sure how the -lcrypt flag
should be documented, as normally something like isnan(3)
would reference the library page math(3) to describe the
linkage requirements, but crypt(3) is both a function and
a library...
*** crypt.3.orig Sun Apr 13 21:51:43 1997
--- crypt.3 Sun Apr 13 21:52:15 1997
***************
*** 44,49 ****
--- 44,50 ----
.Nm des_cipher
.Nd DES encryption
.Sh SYNOPSIS
+ .Fd #include <unistd.h>
.Ft char
.Fn *crypt "const char *key" "const char *setting"
.Ft int
*** math.3.orig Sun Apr 13 22:22:35 1997
--- math.3 Sun Apr 13 22:26:50 1997
***************
*** 79,85 ****
floor floor.3 integer no greater than 0
hypot hypot.3 Euclidean distance 1
ilogb ieee.3 exponent extraction 0
! infnan infnan.3 signals exceptions
j0 j0.3 bessel function ???
j1 j0.3 bessel function ???
jn j0.3 bessel function ???
--- 79,86 ----
floor floor.3 integer no greater than 0
hypot hypot.3 Euclidean distance 1
ilogb ieee.3 exponent extraction 0
! isinf isinf.3 check exceptions
! isnan isnan.3 check exceptions
j0 j0.3 bessel function ???
j1 j0.3 bessel function ???
jn j0.3 bessel function ???
>Audit-Trail:
>Unformatted: