crypto/dist/heimdal/appl/su/su.1

   1 .\" Copyright (c) 2003 - 2006 Kungliga Tekniska Högskolan
   2 .\" (Royal Institute of Technology, Stockholm, Sweden).
   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 .\"
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\"
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" 3. Neither the name of the Institute 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 INSTITUTE 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 INSTITUTE 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 .\" $Heimdal: su.1 16528 2006-01-12 16:25:01Z joda $
  33 .\" $NetBSD$
  34 .\"
  35 .Dd January 12, 2006
  36 .Dt SU 1
  37 .Os
  38 .Sh NAME
  39 .Nm su
  40 .Nd substitute user identity
  41 .Sh SYNOPSIS
  42 .Nm su
  43 .Op Fl K | Fl -no-kerberos
  44 .Op Fl f
  45 .Op Fl l | Fl -full
  46 .Op Fl m
  47 .Oo Fl i Ar instance \*(Ba Xo
  48 .Fl -instance= Ns Ar instance
  49 .Xc
  50 .Oc
  51 .Oo Fl c Ar command \*(Ba Xo
  52 .Fl -command= Ns Ar command
  53 .Xc
  54 .Oc
  55 .Op Ar login Op Ar "shell arguments"
  56 .Sh DESCRIPTION
  57 .Nm su
  58 will use Kerberos authentication provided that an instance for the
  59 user wanting to change effective UID is present in a file named
  60 .Pa .k5login
  61 in the target user id's home directory
  62 .Pp
  63 A special case exists where
  64 .Ql root Ap s
  65 .Pa ~/.k5login
  66 needs to contain an entry for:
  67 .Ql user Ns / Ns Ao instance Ac Ns @ Ns REALM
  68 for
  69 .Nm su
  70 to succed (where
  71 .Aq instance
  72 is
  73 .Ql root
  74 unless changed with
  75 .Fl i ) .
  76 .Pp
  77 In the absence of either an entry for current user in said file or
  78 other problems like missing
  79 .Ql host/hostname@REALM
  80 keys in the system's
  81 keytab, or user typing the wrong password,
  82 .Nm su
  83 will fall back to traditional
  84 .Pa /etc/passwd
  85 authentication.
  86 .Pp
  87 When using
  88 .Pa /etc/passwd
  89 authentication,
  90 .Nm su
  91 allows
  92 .Ql root
  93 access only to members of the group
  94 .Ql wheel ,
  95 or to any user (with knowledge of the
  96 .Ql root
  97 password) if that group
  98 does not exist, or has no members.
  99 .Pp
 100 The options are as follows:
 101 .Bl -item -width Ds
 102 .It
 103 .Fl K ,
 104 .Fl -no-kerberos
 105 don't use Kerberos.
 106 .It
 107 .Fl f
 108 don't read .cshrc.
 109 .It
 110 .Fl l ,
 111 .Fl -full
 112 simulate full login.
 113 .It
 114 .Fl m
 115 leave environment unmodified.
 116 .It
 117 .Fl i Ar instance ,
 118 .Fl -instance= Ns Ar instance
 119 root instance to use.
 120 .It
 121 .Fl c Ar command ,
 122 .Fl -command= Ns Ar command
 123 command to execute.
 124 .El