]> git.ipfire.org Git - thirdparty/util-linux.git/blob - login-utils/sulogin.8.adoc
build-sys: release++ (v2.38.1)
[thirdparty/util-linux.git] / login-utils / sulogin.8.adoc
1 //po4a: entry man manual
2 ////
3 Copyright (C) 1998-2006 Miquel van Smoorenburg.
4 Copyright (C) 2012 Karel Zak <kzak@redhat.com>
5
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
10
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 ////
20 = sulogin(8)
21 :doctype: manpage
22 :man manual: System Administration
23 :man source: util-linux {release-version}
24 :page-layout: base
25 :command: sulogin
26 :asterisk: *
27
28 == NAME
29
30 sulogin - single-user login
31
32 == SYNOPSIS
33
34 *sulogin* [options] [_tty_]
35
36 == DESCRIPTION
37
38 *sulogin* is invoked by *init* when the system goes into single-user mode.
39
40 The user is prompted:
41
42 Give root password for system maintenance (or type Control-D for normal startup):
43
44 If the root account is locked and *--force* is specified, no password is required.
45
46 *sulogin* will be connected to the current terminal, or to the optional _tty_ device that can be specified on the command line (typically _/dev/console_).
47
48 When the user exits from the single-user shell, or presses control-D at the prompt, the system will continue to boot.
49
50 == OPTIONS
51
52 *-e*, *--force*::
53 If the default method of obtaining the root password from the system via *getpwnam*(3) fails, then examine _/etc/passwd_ and _/etc/shadow_ to get the password. If these files are damaged or nonexistent, or when root account is locked by '!' or '{asterisk}' at the begin of the password then *sulogin* will *start a root shell without asking for a password*.
54 //TRANSLATORS: Keep {asterisk} untranslated.
55 +
56 Only use the *-e* option if you are sure the console is physically protected against unauthorized access.
57
58 *-p*, *--login-shell*::
59 Specifying this option causes *sulogin* to start the shell process as a login shell.
60
61 *-t*, *--timeout* _seconds_::
62 Specify the maximum amount of time to wait for user input. By default, *sulogin* will wait forever.
63
64 include::man-common/help-version.adoc[]
65
66 == ENVIRONMENT
67
68 *sulogin* looks for the environment variable *SUSHELL* or *sushell* to determine what shell to start. If the environment variable is not set, it will try to execute root's shell from _/etc/passwd_. If that fails, it will fall back to _/bin/sh_.
69
70 == AUTHORS
71
72 *sulogin* was written by Miquel van Smoorenburg for sysvinit and later ported to util-linux by Dave Reisner and Karel Zak.
73
74 include::man-common/bugreports.adoc[]
75
76 include::man-common/footer.adoc[]
77
78 ifdef::translation[]
79 include::man-common/translation.adoc[]
80 endif::[]