docs/70616: incompleteness and error in su(1) man page

[Jilles Tjoelker]

>Number:         70616
>Category:       docs
>Synopsis:       incompleteness and error in su(1) man page
>Confidential:   no
>Severity:       serious
>Priority:       medium
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed Aug 18 14:20:19 GMT 2004
>Closed-Date:
>Last-Modified:
>Originator:     Jilles Tjoelker
>Release:        FreeBSD 5.2.1-RELEASE-p8 i386
>Organization:
MCGV Stack
>Environment:
System: FreeBSD turtle.stack.nl 5.2.1-RELEASE-p8 FreeBSD 5.2.1-RELEASE-p8 #28: Wed May 26 18:25:55 CEST 2004 marcolz at turtle.stack.nl:/usr/obj/usr/src/sys/TURTLE i386
Also in 5-CURRENT
>Description:
1. The su man page doesn't mention that by default users must be in group
   wheel to su to root. While it is mentioned in other documentation, it
   should be in the man page as well. The 4.x man page mentioned it.
   (This confuses new users.)
2. The su man page says the PAM configuration for su is in /etc/pam.conf, but
   it is in /etc/pam.d/su now.
>How-To-Repeat:
man su
>Fix:
Patch included
--- su.1.diff begins here ---
--- su.1.orig	Wed Aug 18 15:58:47 2004
+++ su.1	Wed Aug 18 16:05:16 2004
@@ -52,7 +52,10 @@
 (the default user is the superuser).
 A shell is then executed.
 .Pp
-PAM is used to set all policy.
+PAM is used to set all policy. In particular, by default only users in group
+``wheel'' may use
+.Nm
+to switch to UID 0 (``root'').
 .Pp
 By default, the environment is unmodified with the exception of
 .Ev USER ,
@@ -159,13 +162,10 @@
 .Dq Sy \&#
 to remind one of its awesome power.
 .Sh FILES
-.Bl -tag -width /etc/pam.conf -compact
-.It Pa /etc/pam.conf
+.Bl -tag -width /etc/pam.d/su -compact
+.It Pa /etc/pam.d/su
 .Nm
-is configured with PAM support; it uses
-.Pa /etc/pam.conf
-entries with service name
-.Dq su
+is configured with PAM support
 .El
 .Sh SEE ALSO
 .Xr csh 1 ,
--- su.1.diff ends here ---


>Release-Note:
>Audit-Trail:
>Unformatted: