From: Sami Kerola <kerolasa@iki.fi>
Date: Wed, 25 Jul 2012 19:15:42 +0000 (+0200)
Subject: docs: clean up sulogin.8 manual
X-Git-Tag: v2.22-rc1~37
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=ba816e7d5b172205be75b54c5c6b22decd10443c;p=thirdparty%2Futil-linux.git

docs: clean up sulogin.8 manual

Align with Documentation/howto-man-page.txt

Signed-off-by: Sami Kerola <kerolasa@iki.fi>
---

diff --git a/login-utils/sulogin.8 b/login-utils/sulogin.8
index 24c120db87..b9dec165c4 100644
--- a/login-utils/sulogin.8
+++ b/login-utils/sulogin.8
@@ -16,7 +16,7 @@
 .\" 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" "Jul 2012" "util-linux" "System Administration"
 .SH NAME
 sulogin \- Single-user login
 .SH SYNOPSIS
@@ -25,7 +25,9 @@ sulogin \- Single-user login
 .RB [ tty ]
 .SH DESCRIPTION
 .I sulogin
-is invoked by \fBinit\fP when the system goes into single user mode.
+is invoked by
+.B init
+when the system goes into single user mode.
 .PP
 The user is prompted:
 .IP "" .5i
@@ -33,40 +35,56 @@ 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).
+.I sulogin
+will be connected to the current terminal, or to the optional tty device that
+can be specified on the command line (typically
+.BR /dev/console ).
 .PP
 After the user exits 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,
+.IP "\fB\-e\fR, \fB\-\-force\fP"
+If the default method of obtaining the root password via
+.BR getpwnam (3)
+from the system fails, manually examine
+.I /etc/passwd
+and
+.I /etc/shadow
+to get the password.  If they are damaged or nonexistent, sulogin will start
+a root shell without asking for a password.
+.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 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,
 sulogin will wait forever.
-.IP "\fB\-V, \-\-version\fP"
+.IP "\fB\-h\fR, \fB\-\-help\fP"
+Print a help message.
+.IP "\fB\-V\fR, \fB\-\-version\fP"
 Output version.
 .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.
+.I 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 ftp://\:ftp.kernel.org\:/pub\:/linux\:/utils\:/util-linux/
+Linux Kernel Archive
+.UE .