← Back to branch summary

~ubuntu-branches/ubuntu/raring/shadow/raring-proposed

« back to all changes in this revision

Viewing changes to man/su.1

  • Committer: Bazaar Package Importer
  • Author(s): Oliver Grawert
  • Date: 2010-11-24 13:42:42 UTC
  • mfrom: (1.1.9 upstream) (18.1.4 sid)
  • Revision ID: james.westby@ubuntu.com-20101124134242-832f4tew5s81ntj7
Tags: 1:4.1.4.2+svn3283-2ubuntu1
* Merge from debian unstable.  Remaining changes:
  - Ubuntu specific:
    + debian/login.defs: use SHA512 by default for password crypt routine.
  - debian/{source_shadow.py,rules}: Add apport hook
  - debian/rules: fix FTBFS from newer libtools
  - debian/patches/495_stdout-encrypted-password: chpasswd can report
    password hashes on stdout (Debian bug 505640).
  - Rework 495_stdout-encrypted-password to cope with chpasswd using PAM.

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/su.1
1
1
'\" t
2
2
.\"     Title: su
3
3
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4
 
.\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/>
5
 
.\"      Date: 07/24/2009
 
4
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
 
5
.\"      Date: 09/05/2010
6
6
.\"    Manual: User Commands
7
7
.\"    Source: User Commands
8
8
.\"  Language: English
9
9
.\"
10
 
.TH "SU" "1" "07/24/2009" "User Commands" "User Commands"
 
10
.TH "SU" "1" "09/05/2010" "User Commands" "User Commands"
11
11
.\" -----------------------------------------------------------------
12
12
.\" * set default formatting
13
13
.\" -----------------------------------------------------------------
34
34
\fB\-\fR
35
35
may be used to provide an environment similar to what the user would expect had the user logged in directly\&.
36
36
.PP
37
 
Additional arguments may be provided after the username, in which case they are supplied to the user\'s login shell\&. In particular, an argument of
 
37
Additional arguments may be provided after the username, in which case they are supplied to the user\*(Aqs login shell\&. In particular, an argument of
38
38
\fB\-c\fR
39
39
will cause the next argument to be treated as a command by most command interpreters\&. The command will be executed by the shell specified in
40
40
/etc/passwd
116
116
if a shell could not be found by any above method\&.
117
117
.RE
118
118
.sp
119
 
If the target user has a restricted shell (i\&.e\&. the shell field of this user\'s entry in
 
119
If the target user has a restricted shell (i\&.e\&. the shell field of this user\*(Aqs entry in
120
120
/etc/passwd
121
121
is not listed in
122
122
/etc/shell), then the
123
123
\fB\-\-shell\fR
124
124
option or the
125
125
\fB$SHELL\fR
126
 
environment variable won\'t be taken into account, unless
 
126
environment variable won\*(Aqt be taken into account, unless
127
127
\fBsu\fR
128
128
is called by root\&.
129
129
.RE
231
231
.PP
232
232
\fBCONSOLE_GROUPS\fR (string)
233
233
.RS 4
234
 
List of groups to add to the user\'s supplementary groups set when logging in on the console (as determined by the CONSOLE setting)\&. Default is none\&.
 
234
List of groups to add to the user\*(Aqs supplementary groups set when logging in on the console (as determined by the CONSOLE setting)\&. Default is none\&.
235
235
 
236
236
Use with caution \- it is possible for users to gain permanent access to these groups, even when not logged in on the console\&.
237
237
.RE
238
238
.PP
239
239
\fBDEFAULT_HOME\fR (boolean)
240
240
.RS 4
241
 
Indicate if login is allowed if we can\'t cd to the home directory\&. Default in no\&.
 
241
Indicate if login is allowed if we can\*(Aqt cd to the home directory\&. Default in no\&.
242
242
.sp
243
243
If set to
244
244
\fIyes\fR, the user will login in the root (/) directory if it is not possible to cd to her home directory\&.
271
271
If set, it will be used to define the PATH environment variable when the superuser login\&. The value can be preceded by
272
272
\fIPATH=\fR, or a colon separated list of paths (for example
273
273
\fI/sbin:/bin:/usr/sbin:/usr/bin\fR)\&. The default value is
274
 
\fIPATH=/bin:/usr/bin\fR\&.
 
274
\fIPATH=/sbin:/bin:/usr/sbin:/usr/bin\fR\&.
275
275
.RE
276
276
.PP
277
277
\fBENV_TZ\fR (string)
291
291
The string used for prompting a password\&. The default is to use "Password: ", or a translation of that string\&. If you set this variable, the prompt will no be translated\&.
292
292
.sp
293
293
If the string contains
294
 
\fI%s\fR, this will be replaced by the user\'s name\&.
 
294
\fI%s\fR, this will be replaced by the user\*(Aqs name\&.
295
295
.RE
296
296
.PP
297
297
\fBMAIL_CHECK_ENAB\fR (boolean)
319
319
\fBuseradd\fR,
320
320
\fBusermod\fR, and
321
321
\fBuserdel\fR
322
 
to create, move, or delete the user\'s mail spool\&.
 
322
to create, move, or delete the user\*(Aqs mail spool\&.
323
323
.PP
324
324
If
325
325
\fBMAIL_CHECK_ENAB\fR
352
352
\fIroot\fR
353
353
on most Linux systems) to be able to
354
354
\fBsu\fR
355
 
to uid 0 accounts\&. If the group doesn\'t exist or is empty, no one will be able to
 
355
to uid 0 accounts\&. If the group doesn\*(Aqt exist or is empty, no one will be able to
356
356
\fBsu\fR
357
357
to uid 0\&.
358
358
.RE
371
371
If set to
372
372
\fIyes\fR,
373
373
\fBuserdel\fR
374
 
will remove the user\'s group if it contains no more members, and
 
374
will remove the user\*(Aqs group if it contains no more members, and
375
375
\fBuseradd\fR
376
376
will create by default a group with the name of the user\&.
377
377
.RE
391
391
.RS 4
392
392
Shadow password suite configuration\&.
393
393
.RE
 
394
.SH "EXIT VALUES"
 
395
.PP
 
396
On success,
 
397
\fBsu\fR
 
398
returns the exit value of the command it executed\&.
 
399
.PP
 
400
If this command was terminated by a signal,
 
401
\fBsu\fR
 
402
returns the number of this signal plus 128\&.
 
403
.PP
 
404
If su has to kill the command (because it was asked to terminate, and the command did not terminate in time),
 
405
\fBsu\fR
 
406
returns 255\&.
 
407
.PP
 
408
Some exit values from
 
409
\fBsu\fR
 
410
are independent from the executed command:
 
411
.PP
 
412
\fI0\fR
 
413
.RS 4
 
414
success (\fB\-\-help\fR
 
415
only)
 
416
.RE
 
417
.PP
 
418
\fI1\fR
 
419
.RS 4
 
420
System or authentication failure
 
421
.RE
 
422
.PP
 
423
\fI126\fR
 
424
.RS 4
 
425
The requested command was not found
 
426
.RE
 
427
.PP
 
428
\fI127\fR
 
429
.RS 4
 
430
The requested command could not be executed
 
431
.RE
394
432
.SH "SEE ALSO"
395
433
.PP
396
434
\fBlogin\fR(1),