Subject: lib/703: manpages for libcompat don't indicate libcompat
To: None <gnats-admin@NetBSD.ORG>
From: None <jhawk@MIT.EDU>
List: netbsd-bugs
Date: 01/05/1995 10:20:05
>Number:         703
>Category:       lib
>Synopsis:       manpages for libcompat don't indicate libcompat
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    lib-bug-people (Library Bug People)
>State:          open
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Thu Jan  5 10:20:03 1995
>Originator:     John Hawkinson
>Organization:
MIT
>Release:        1.0
>Environment:
System: NetBSD lola-granola 1.0 NetBSD 1.0 (LOLA-DDB) #61: Mon Jan 2 22:01:10 EST 1995 root@lola-granola:/u1/usr/src/sys/arch/i386/compile/LOLA-DDB i386
Also present in -current (1/4/95).

>Description:

A number of functions in libcompat fail to indicate in their manpages that
they are from libcompat.

>How-To-Repeat:
>Fix:

Here are patches to the relevant manpages. These also fix some other
slight problems (no use of .Xr, consistent use of .Bf -symbolic, etc.).


*** 1.1	1995/01/05 09:28:20
--- 4.1/ftime.3	1995/01/05 09:30:12
***************
*** 45,51 ****
  .Fn ftime "struct timeb *tp"
  .Sh DESCRIPTION
  .Bf -symbolic
! This interface is obsoleted by gettimeofday(2).
  .Pp
  It is available from the compatibility library, libcompat.
  .Ef
--- 45,52 ----
  .Fn ftime "struct timeb *tp"
  .Sh DESCRIPTION
  .Bf -symbolic
! This interface is obsoleted by
! .Xr gettimeofday 2 .
  .Pp
  It is available from the compatibility library, libcompat.
  .Ef
*** 1.1	1995/01/05 09:31:10
--- 4.1/getpw.3	1995/01/05 09:32:16
***************
*** 42,49 ****
  .Fn getpw uid "char *buf"
  .Sh DESCRIPTION
  .Bf -symbolic
! The getpw function is made obsolete by getpwuid(3).
! .br
  It is available from the compatibility library, libcompat.
  .Ef
  .Pp
--- 42,50 ----
  .Fn getpw uid "char *buf"
  .Sh DESCRIPTION
  .Bf -symbolic
! The getpw function is made obsolete by
! .Xr getpwuid 3 .
! .Pp
  It is available from the compatibility library, libcompat.
  .Ef
  .Pp
*** 1.1	1995/01/05 09:32:53
--- 4.1/stty.3	1995/01/05 09:33:37
***************
*** 45,51 ****
  .Fn gtty "int fd" "struct sgttyb *buf"
  .Sh DESCRIPTION
  .Bf -symbolic
! These interfaces are obsoleted by ioctl(2).
  They are available from the compatibility library, libcompat.
  .Ef
  .Pp
--- 45,53 ----
  .Fn gtty "int fd" "struct sgttyb *buf"
  .Sh DESCRIPTION
  .Bf -symbolic
! These interfaces are obsoleted by
! .Xr ioctl 2 .
! .Pp
  They are available from the compatibility library, libcompat.
  .Ef
  .Pp
*** 1.1	1995/01/05 09:34:08
--- 4.1/vlimit.3	1995/01/05 09:35:02
***************
*** 43,49 ****
  .Fn vlimit resource value
  .Sh DESCRIPTION
  .Bf -symbolic
! This interface is obsoleted by getrlimit(2).
  It is available from the compatibility library, libcompat.
  .Ef
  .Pp
--- 43,51 ----
  .Fn vlimit resource value
  .Sh DESCRIPTION
  .Bf -symbolic
! This interface is obsoleted by
! .Xr getrlimit 2 .
! .Pp
  It is available from the compatibility library, libcompat.
  .Ef
  .Pp
*** 1.1	1995/01/05 09:35:37
--- 4.1/vtimes.3	1995/01/05 09:36:07
***************
*** 43,49 ****
  .Fn vtimes "struct vtimes *par_vm" "struct vtimes *ch_vm"
  .Sh DESCRIPTION
  .Bf -symbolic
! This interface is obsoleted by getrusage(2).
  It is available from the compatibility library, libcompat.
  .Ef
  .Pp
--- 43,51 ----
  .Fn vtimes "struct vtimes *par_vm" "struct vtimes *ch_vm"
  .Sh DESCRIPTION
  .Bf -symbolic
! This interface is obsoleted by
! .Xr getrusage 2 .
! .Pp
  It is available from the compatibility library, libcompat.
  .Ef
  .Pp
*** 1.1	1995/01/05 08:59:49
--- 4.3/insque.3	1995/01/05 09:25:28
***************
*** 26,32 ****
  .\"
  .\"	$NetBSD: insque.3,v 1.3 1994/03/12 01:28:56 jtc Exp $
  .\"
! .Dd August 12, 1993
  .Dt INSQUE 3
  .Sh NAME
  .Nm insque ,
--- 26,32 ----
  .\"
  .\"	$NetBSD: insque.3,v 1.3 1994/03/12 01:28:56 jtc Exp $
  .\"
! .Dd 5 January, 1995
  .Dt INSQUE 3
  .Sh NAME
  .Nm insque ,
***************
*** 50,55 ****
--- 50,62 ----
  .Ft void
  .Fn remque "struct qelem *elem"
  .Sh DESCRIPTION
+ .Bf -symbolic
+ This interface is obsoleted by
+ .Xr queue 3 .
+ .Pp
+ It is available from the compatibility library, libcompat.
+ .Ef
+ .Pp
  .Fn insque
  and
  .Fn remque
*** 1.1	1995/01/05 09:38:23
--- 4.3/lsearch.3	1995/01/05 09:38:52
***************
*** 47,52 ****
--- 47,53 ----
  .Sh DESCRIPTION
  .Bf -symbolic
  This interface was obsolete before it was written.
+ .Pp
  It is available from the compatibility library, libcompat.
  .Ef
  .Pp
*** 1.1	1995/01/05 09:39:35
--- 4.3/re_comp.3	1995/01/05 09:40:26
***************
*** 46,54 ****
--- 46,58 ----
  .Ft int
  .Fn re_exec "const char *s"
  .Sh DESCRIPTION
+ .Bf -symbolic
  This interface is made obsolete by
  .Xr regex 3 .
  .Pp
+ It is available from the compatibility library, libcompat.
+ .Ef
+ .Pp
  The
  .Fn re_comp
  function
*** 1.1	1995/01/05 09:41:02
--- 4.3/rexec.3	1995/01/05 09:41:38
***************
*** 43,49 ****
  .Fn rexec ahost "int inport" "char *user" "char *passwd" "char *cmd" "int *fd2p"
  .Sh DESCRIPTION
  .Bf -symbolic
! This interface is obsoleted by krcmd(3).
  It is available from the compatibility library, libcompat.
  .Ef
  .Pp
--- 43,51 ----
  .Fn rexec ahost "int inport" "char *user" "char *passwd" "char *cmd" "int *fd2p"
  .Sh DESCRIPTION
  .Bf -symbolic
! This interface is obsoleted by
! .Xr krcmd 3 .
! .Pp
  It is available from the compatibility library, libcompat.
  .Ef
  .Pp
*** 1.1	1995/01/05 09:06:00
--- 4.4/cuserid.3	1995/01/05 09:26:11
***************
*** 32,38 ****
  .\"     from: @(#)ctermid.3	5.2 (Berkeley) 4/19/91
  .\"	$NetBSD: cuserid.3,v 1.1 1994/05/19 06:20:26 jtc Exp $
  .\"
! .Dd November 28, 1993
  .Dt CUSERID 3
  .Os
  .Sh NAME
--- 32,38 ----
  .\"     from: @(#)ctermid.3	5.2 (Berkeley) 4/19/91
  .\"	$NetBSD: cuserid.3,v 1.1 1994/05/19 06:20:26 jtc Exp $
  .\"
! .Dd January 5, 1994
  .Dt CUSERID 3
  .Os
  .Sh NAME
***************
*** 43,48 ****
--- 43,55 ----
  .Ft char *
  .Fn cuserid "char *buf"
  .Sh DESCRIPTION
+ .Bf -symbolic
+ This interface is obsolete. Please see
+ .Sx BUGS .
+ .Pp
+ It is available from the compatability library, libcompat.
+ .Ef
+ .Pp
  The
  .Fn cuserid
  function returns a character string representation of the user name 
***************
*** 50,58 ****
--- 50,62 ----
  .Ft void
  .Fn regsub "const regexp *prog" "const char *source" "char *dest"
  .Sh DESCRIPTION
+ .Bf -symbolic
  This interface is made obsolete by
  .Xr regex 3 .
  .Pp
+ It is available from the compatibility library, libcompat.
+ .Ef
+ .Pp
  The
  .Fn regcomp ,
  .Fn regexec ,

>Audit-Trail:
>Unformatted: