contrib/openpam/bin/su/su.1

   1 .\"-
   2 .\" Copyright (c) 2011 Dag-Erling Smørgrav
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. The name of the author may not be used to endorse or promote
  14 .\"    products derived from this software without specific prior written
  15 .\"    permission.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  21 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27 .\" SUCH DAMAGE.
  28 .\"
  29 .\" $Id: su.1 610 2012-05-26 14:03:45Z des $
  30 .\"
  31 .Dd May 26, 2012
  32 .Dt SU 1
  33 .Os
  34 .Sh NAME
  35 .Nm su
  36 .Nd switch user identity
  37 .Sh SYNOPSYS
  38 .Nm
  39 .Op Ar login Op Ar ...
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 utility starts a shell under the identity of the user specified by the
  44 first argument on the command line.
  45 If no user is specified, the default is
  46 .Dq root .
  47 .Pp
  48 Any additional command-line arguments are passed as-is to the shell.
  49 .Pp
  50 The requesting user is authenticated using the
  51 .Dq su
  52 PAM policy.
  53 .Sh IMPLEMENTATION NOTES
  54 The
  55 .Nm
  56 utility is provided with the OpenPAM library as a sample application
  57 and should not be used in production systems.
  58 .Sh SEE ALSO
  59 .Xr openpam 3 ,
  60 .Xr pam 3
  61 .Sh AUTHORS
  62 The
  63 .Nm
  64 utility and this manual page were written by
  65 .An Dag-Erling Sm\(/orgrav Aq des@des.no .