Initial commit for Tizen
[profile/extras/shadow-utils.git] / man / sulogin.8
1 '\" t
2 .\"     Title: sulogin
3 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
5 .\"      Date: 02/16/2011
6 .\"    Manual: System Management Commands
7 .\"    Source: System Management Commands
8 .\"  Language: English
9 .\"
10 .TH "SULOGIN" "8" "02/16/2011" "System Management Commands" "System Management Commands"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el       .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 sulogin \- Single\-user login
32 .SH "SYNTAX"
33 .PP
34 \fBsulogin\fR
35 [\fItty\-device\fR]
36 .SH "DESCRIPTION"
37 .PP
38 The
39 \fBsulogin\fR
40 command is invoked by
41 \fBinit\fR
42 prior to allowing the user access to the system when in single user mode\&. This feature may only be available on certain systems where
43 \fBinit\fR
44 has been modified accordingly, or where the
45 /etc/inittab
46 has an entry for a single user login\&.
47 .PP
48 The user is prompted
49 .PP
50 Type control\-d to proceed with normal startup,
51 (or give root password for system maintenance):
52 .PP
53 Input and output will be performed with the standard file descriptors unless the optional device name argument is provided\&.
54 .PP
55 If the user enters the correct root password, a login session is initiated\&. When
56 \fIEOF\fR
57 is pressed instead, the system enters multi\-user mode\&.
58 .PP
59 After the user exits the single\-user shell, or presses
60 \fIEOF\fR, the system begins the initialization process required to enter multi\-user mode\&.
61 .SH "CAVEATS"
62 .PP
63 This command can only be used if
64 \fBinit\fR
65 has been modified to call
66 \fBsulogin\fR
67 instead of
68 /bin/sh, or if the user has set the
69 \fIinittab\fR
70 to support a single user login\&. For example, the line:
71 .PP
72 co:s:respawn:/etc/sulogin /dev/console
73 .PP
74 should execute the sulogin command in single user mode\&.
75 .PP
76 As complete an environment as possible is created\&. However, various devices may be unmounted or uninitialized and many of the user commands may be unavailable or nonfunctional as a result\&.
77 .SH "CONFIGURATION"
78 .PP
79 The following configuration variables in
80 /etc/login\&.defs
81 change the behavior of this tool:
82 .PP
83 \fBENV_HZ\fR (string)
84 .RS 4
85 If set, it will be used to define the HZ environment variable when a user login\&. The value must be preceded by
86 \fIHZ=\fR\&. A common value on Linux is
87 \fIHZ=100\fR\&.
88 .RE
89 .PP
90 \fBENV_TZ\fR (string)
91 .RS 4
92 If set, it will be used to define the TZ environment variable when a user login\&. The value can be the name of a timezone preceded by
93 \fITZ=\fR
94 (for example
95 \fITZ=CST6CDT\fR), or the full path to the file containing the timezone specification (for example
96 /etc/tzname)\&.
97 .sp
98 If a full path is specified but the file does not exist or cannot be read, the default is to use
99 \fITZ=CST6CDT\fR\&.
100 .RE
101 .SH "FILES"
102 .PP
103 /etc/passwd
104 .RS 4
105 User account information\&.
106 .RE
107 .PP
108 /etc/shadow
109 .RS 4
110 Secure user account information\&.
111 .RE
112 .SH "SEE ALSO"
113 .PP
114
115 \fBlogin\fR(1),
116 \fBsh\fR(1),
117 \fBinit\fR(8)\&.