[src/trunk]: src/usr.bin/su Give a general description what this command does...

[hubertf <hubertf%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/7d6c9601c58b
branches:  trunk
changeset: 586359:7d6c9601c58b
user:      hubertf <hubertf%NetBSD.org@localhost>
date:      Thu Dec 15 05:26:36 2005 +0000

description:
Give a general description what this command does before going into
all the details.

diffstat:

 usr.bin/su/su.1 |  20 +++++++++++++++-----
 1 files changed, 15 insertions(+), 5 deletions(-)

diffs (41 lines):

diff -r 30efbc0e519d -r 7d6c9601c58b usr.bin/su/su.1
--- a/usr.bin/su/su.1   Thu Dec 15 04:27:32 2005 +0000
+++ b/usr.bin/su/su.1   Thu Dec 15 05:26:36 2005 +0000
@@ -26,9 +26,9 @@
 .\" SUCH DAMAGE.
 .\"
 .\"    from: @(#)su.1  8.2 (Berkeley) 4/18/94
-.\"    $NetBSD: su.1,v 1.44 2005/07/05 20:15:13 kleink Exp $
+.\"    $NetBSD: su.1,v 1.45 2005/12/15 05:26:36 hubertf Exp $
 .\"
-.Dd July 5, 2005
+.Dd December 15, 2005
 .Dt SU 1
 .Os
 .Sh NAME
@@ -41,12 +41,22 @@
 .Op Ar login Op Ar "shell arguments"
 .Sh DESCRIPTION
 .Nm
-requests the Kerberos password for
+allows one user to become another user
+.Ar login
+without logging out and in as
+the new user. 
+.Pp
+When executed by a user, the 
+.Ar login 
+user's password is requested.
+When using Kerberos, the password for
 .Ar login
 (or for
 .Dq Ar login Ns .root ,
-if no login is provided), and switches to
-that user and group ID after obtaining a Kerberos ticket granting ticket.
+if no login is provided) is requested, and
+.Nm
+switches to that user and group ID after obtaining a Kerberos ticket
+granting ticket.
 A shell is then executed, and any additional
 .Ar "shell arguments"
 after the login name are passed to the shell.