From 2d1f74e6da69b10bb23fa1481c97a989cd32cadf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dag-Erling=20Sm=C3=B8rgrav?= Date: Wed, 2 Nov 2011 13:10:25 +0000 Subject: [PATCH] Add a man page, tweak the usage string, remove useless -h option. git-svn-id: svn+ssh://svn.openpam.org/svn/openpam/trunk@458 185d5e19-27fe-0310-9dcf-9bff6b9f3609 --- bin/su/Makefile.am | 2 ++ bin/su/su.1 | 62 ++++++++++++++++++++++++++++++++++++++++++++++ bin/su/su.c | 5 ++-- 3 files changed, 66 insertions(+), 3 deletions(-) create mode 100644 bin/su/su.1 diff --git a/bin/su/Makefile.am b/bin/su/Makefile.am index c93c2d6..11c3f16 100644 --- a/bin/su/Makefile.am +++ b/bin/su/Makefile.am @@ -5,3 +5,5 @@ INCLUDES = -I$(top_srcdir)/include bin_PROGRAMS = su su_SOURCES = su.c su_LDADD = $(top_builddir)/lib/libpam.la + +dist_man1_MANS = su.1 diff --git a/bin/su/su.1 b/bin/su/su.1 new file mode 100644 index 0000000..ec81fe6 --- /dev/null +++ b/bin/su/su.1 @@ -0,0 +1,62 @@ +.\"- +.\" Copyright (c) 2011 Dag-Erling Smørgrav +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $Id$ +.\" +.Dd November 2, 2011 +.Dt SU 1 +.Os +.Sh NAME +.Nm su +.Nd switch user identity +.Sh SYNOPSYS +.Nm +.Op Ar login Op Ar ... +.Sh DESCRIPTION +The +.Nm +utility starts a shell under the identity of the user specified by the +first argument on the command line. +If no user is specified, the default is +.Dq root . +.Pp +Any additional command-line arguments are passed as-is to the shell. +.Pp +The requesting user is authenticated using the +.Dq su +PAM policy. +.Sh IMPLEMENTATION NOTES +The +.Nm +utility is provided with the OpenPAM library as a sample application +and should not be used in production systems. +.Sh SEE ALSO +.Xr openpam 3 +.Xr pam 3 +.Sh AUTHORS +The +.Nm +utility and this manual page were written by +.An Dag-Erling Sm\(/orgrav Aq des@FreeBSD.org . diff --git a/bin/su/su.c b/bin/su/su.c index 93a689b..204b07e 100644 --- a/bin/su/su.c +++ b/bin/su/su.c @@ -63,7 +63,7 @@ static void usage(void) { - fprintf(stderr, "Usage: su [login [args]]\n"); + fprintf(stderr, "usage: su [login [args]]\n"); exit(1); } @@ -78,9 +78,8 @@ main(int argc, char *argv[]) int o, pam_err, status; pid_t pid; - while ((o = getopt(argc, argv, "h")) != -1) + while ((o = getopt(argc, argv, "")) != -1) switch (o) { - case 'h': default: usage(); }