From 9df5e26cc9ec4a115d594d793d6b818bc723b395 Mon Sep 17 00:00:00 2001 From: hubertf Date: Thu, 15 Dec 2005 05:26:36 +0000 Subject: [PATCH] Give a general description what this command does before going into all the details. --- usr.bin/su/su.1 | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/usr.bin/su/su.1 b/usr.bin/su/su.1 index fed1891e6800..54b2ae5d1359 100644 --- a/usr.bin/su/su.1 +++ b/usr.bin/su/su.1 @@ -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.