scriptreplay: cleanup usage()

[thirdparty/util-linux.git] / login-utils / sulogin.8

diff --git a/login-utils/sulogin.8 b/login-utils/sulogin.8
index 24c120db872cf712fea5a05e29eff51082649010..7998b4acacfd106d17bf4493d820ee9848af85f5 100644 (file)
--- a/login-utils/sulogin.8
+++ b/login-utils/sulogin.8
@@ -1,4 +1,3 @@
-'\" -*- coding: UTF-8 -*-
 .\" Copyright (C) 1998-2006 Miquel van Smoorenburg.
 .\" Copyright (C) 2012 Karel Zak <kzak@redhat.com>
 .\"
@@ -16,16 +15,17 @@
 .\" along with this program; if not, write to the Free Software
 .\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 .\"
-.TH SULOGIN 8 "Mar 2012" "" "Linux System Administrator's Manual"
+.TH SULOGIN "8" "July 2014" "util-linux" "System Administration"
 .SH NAME
-sulogin \- Single-user login
+sulogin \- single-user login
 .SH SYNOPSIS
-.B sulogin
-.RB [ options ]
-.RB [ tty ]
+.BR sulogin " [options]"
+.RI [ tty ]
 .SH DESCRIPTION
-.I sulogin
-is invoked by \fBinit\fP when the system goes into single user mode.
+.B sulogin
+is invoked by
+.B init
+when the system goes into single-user mode.
 .PP
 The user is prompted:
 .IP "" .5i
@@ -33,40 +33,63 @@ Give root password for system maintenance
 .br
 (or type Control\-D for normal startup):
 .PP
-\fIsulogin\fP will be connected to the current terminal, or to the
-optional tty device that can be specified on the command line
-(typically \fB/dev/console\fP).
+If the root account is locked and --force is specified, no password is required.
 .PP
-After the user exits the single-user shell or presses control\-D at the
+.B sulogin
+will be connected to the current terminal, or to the optional \fItty\fR device that
+can be specified on the command line (typically
+.IR /dev/console ).
+.PP
+When the user exits from the single-user shell, or presses control\-D at the
 prompt, the system will continue to boot.
 .SH OPTIONS
-.IP "\fB\-e, \-\-force\fP"
-If the default method of obtaining the root password via \fBgetpwnam\fP(3) from
-the system fails, manually examine /etc/passwd and /etc/shadow to get the
-password. If they are damaged or nonexistent, sulogin will start a root shell
-without asking for a password.
-
-Only use the \fB\-e\fP option if you are sure the console is physically
-protected against unauthorized access.
-.IP "\fB\-h, \-\-help\fP"
-Print a help message.
-.IP "\fB\-p, \-\-login\-shell\fP"
-Specifying this option causes sulogin to start the shell process as a
-login shell.
-.IP "\fB\-t, \-\-timeout \fIseconds\fP"
-Specify the maximum amount of time to wait for user input. By default,
-sulogin will wait forever.
-.IP "\fB\-V, \-\-version\fP"
-Output version.
+.IP "\fB\-e\fR, \fB\-\-force\fP"
+If the default method of obtaining the root password from the system via
+.BR getpwnam (3)
+fails, then examine
+.I /etc/passwd
+and
+.I /etc/shadow
+to get the password.  If these files are damaged or nonexistent, or when
+root account is locked by '!' or '*' at the begin of the password then
+.B sulogin
+will \fBstart a root shell without asking for a password\fP.
+.PP
+.IP
+Only use the
+.B \-e
+option if you are sure the console is physically protected against
+unauthorized access.
+.IP "\fB\-p\fR, \fB\-\-login\-shell\fP"
+Specifying this option causes
+.B sulogin
+to start the shell process as a login shell.
+.IP "\fB\-t\fR, \fB\-\-timeout \fIseconds\fP"
+Specify the maximum amount of time to wait for user input.  By default,
+.B sulogin
+will wait forever.
+.IP "\fB\-h\fR, \fB\-\-help\fP"
+Display help text and exit.
+.IP "\fB\-V\fR, \fB\-\-version\fP"
+Display version information and exit.
 .SH ENVIRONMENT VARIABLES
-\fIsulogin\fP looks for the environment variable \fBSUSHELL\fP or
-\fBsushell\fP 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 \fB/bin/sh\fP.
+.B sulogin
+looks for the environment variable
+.B SUSHELL
+or
+.B sushell
+to determine what shell to start.  If the environment variable is not set, it
+will try to execute root's shell from
+.IR /etc/passwd .
+If that fails, it
+will fall back to
+.IR /bin/sh .
 .SH AUTHOR
 .B sulogin
 was written by Miquel van Smoorenburg for sysvinit and later ported
 to util-linux by Dave Reisner and Karel Zak.
 .SH AVAILABILITY
 The sulogin command is part of the util-linux package and is available from
-ftp://ftp.kernel.org/pub/linux/utils/util-linux/.
+.UR https://\:www.kernel.org\:/pub\:/linux\:/utils\:/util-linux/
+Linux Kernel Archive
+.UE .