usr.bin/su/su.1

   1 .\" Copyright (c) 1988, 1990, 1993, 1994
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)su.1        8.2 (Berkeley) 4/18/94
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd April 18, 1994
  36 .Dt SU 1
  37 .Os
  38 .Sh NAME
  39 .Nm su
  40 .Nd substitute user identity
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Op Fl
  44 .Op Fl flm
  45 .Op Fl c Ar class
  46 .Op Ar login Op Ar args
  47 .Sh DESCRIPTION
  48 .Nm Su
  49 requests appropriate user credentials via PAM
  50 and switches to that user ID
  51 (the default user is the superuser).
  52 A shell is then executed.
  53 .Pp
  54 PAM is used to set all policy.
  55 .Pp
  56 By default, the environment is unmodified with the exception of
  57 .Ev USER ,
  58 .Ev HOME ,
  59 and
  60 .Ev SHELL .
  61 .Ev HOME
  62 and
  63 .Ev SHELL
  64 are set to the target login's default values.
  65 .Ev USER
  66 is set to the target login, unless the target login has a user ID of 0,
  67 in which case it is unmodified.
  68 The invoked shell is the one belonging to the target login.
  69 This is the traditional behavior of
  70 .Nm .
  71 Resource limits and session priority applicable to the original user's
  72 login class (See
  73 .Xr login.conf 5 )
  74 are also normally retained unless the target login as a user ID of 0.
  75 .Pp
  76 The options are as follows:
  77 .Bl -tag -width Ds
  78 .It Fl f
  79 If the invoked shell is
  80 .Xr csh 1 ,
  81 this option prevents it from reading the
  82 .Dq Pa .cshrc
  83 file.
  84 .It Fl l
  85 Simulate a full login.
  86 The environment is discarded except for
  87 .Ev HOME ,
  88 .Ev SHELL ,
  89 .Ev PATH ,
  90 .Ev TERM ,
  91 and
  92 .Ev USER .
  93 .Ev HOME
  94 and
  95 .Ev SHELL
  96 are modified as above.
  97 .Ev USER
  98 is set to the target login.
  99 .Ev PATH
 100 is set to
 101 .Dq Pa /bin:/usr/bin .
 102 .Ev TERM
 103 is imported from your current environment.
 104 Environment variables may be set or overridden from the login class
 105 capabilities database according to the class of the target login.
 106 The invoked shell is the target login's, and
 107 .Nm
 108 will change directory to the target login's home directory.
 109 Resource limits and session priority are modified to that for the
 110 target account's login class.
 111 .It Fl
 112 (no letter) The same as
 113 .Fl l .
 114 .It Fl m
 115 Leave the environment unmodified.
 116 The invoked shell is your login shell, and no directory changes are made.
 117 As a security precaution, if the target user's shell is a non-standard
 118 shell (as defined by
 119 .Xr getusershell 3 )
 120 and the caller's real uid is
 121 non-zero,
 122 .Nm
 123 will fail.
 124 .It Fl c Ar class
 125 Use the settings of the specified login class.
 126 Only allowed for the super-user.
 127 .El
 128 .Pp
 129 The
 130 .Fl l
 131 (or
 132 .Fl
 133 )
 134 and
 135 .Fl m
 136 options are mutually exclusive; the last one specified
 137 overrides any previous ones.
 138 .Pp
 139 If the optional
 140 .Ar args
 141 are provided on the command line, they are passed to the login shell of
 142 the target login.
 143 .Pp
 144 By default (unless the prompt is reset by a startup file) the super-user
 145 prompt is set to
 146 .Dq Sy \&#
 147 to remind one of its awesome power.
 148 .Sh FILES
 149 .Bl -tag -width /etc/pam.conf -compact
 150 .It Pa /etc/pam.conf
 151 .Nm
 152 is configured with PAM support; it uses
 153 .Pa /etc/pam.conf
 154 entries with service name
 155 .Dq su
 156 .El
 157 .Sh SEE ALSO
 158 .Xr csh 1 ,
 159 .Xr sh 1 ,
 160 .Xr group 5 ,
 161 .Xr login.conf 5 ,
 162 .Xr passwd 5 ,
 163 .Xr environ 7 ,
 164 .Xr pam 8
 165 .Sh ENVIRONMENT
 166 Environment variables used by
 167 .Nm :
 168 .Bl -tag -width HOME
 169 .It Ev HOME
 170 Default home directory of real user ID unless modified as
 171 specified above.
 172 .It Ev PATH
 173 Default search path of real user ID unless modified as specified above.
 174 .It Ev TERM
 175 Provides terminal type which may be retained for the substituted
 176 user ID.
 177 .It Ev USER
 178 The user ID is always the effective ID (the target user ID) after an
 179 .Nm
 180 unless the user ID is 0 (root).
 181 .El
 182 .Sh EXAMPLES
 183 .Bl -tag -width 5n -compact
 184 .It Li "su man -c catman"
 185 Runs the command
 186 .Li catman
 187 as user
 188 .Li man .
 189 You will be asked for man's password unless your real UID is 0.
 190 .It Li "su man -c 'catman /usr/share/man /usr/local/man /usr/X11R6/man'"
 191 Same as above, but the target command constitutes of more than a
 192 single word and hence is quoted for use with the
 193 .Fl c
 194 option being passed to the shell.  (Most shells expect the argument to
 195 .Fl c
 196 to be a single word).
 197 .It Li "su -c staff man -c 'catman /usr/share/man /usr/local/man /usr/X11R6/man'"
 198 Same as above, but the target command is run with the resource limits of
 199 the login class
 200 .Dq staff .
 201 Note: in this example, the first
 202 .Fl c
 203 option applies to
 204 .Nm
 205 while the second is an argument to the shell being invoked.
 206 .It Li "su -l foo"
 207 Simulate a login for user foo.
 208 .It Li "su - foo"
 209 Same as above.
 210 .It Li "su -  "
 211 Simulate a login for root.
 212 .El
 213 .Sh HISTORY
 214 A
 215 .Nm
 216 command appeared in
 217 .At v1 .