util-linux.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Sami Kerola <kerolasa@iki.fi>
To: util-linux@vger.kernel.org
Cc: kerolasa@iki.fi
Subject: [PATCH 2/5] docs: clean up sulogin.8 manual
Date: Wed, 25 Jul 2012 21:15:42 +0200	[thread overview]
Message-ID: <1343243745-1172-25-git-send-email-kerolasa@iki.fi> (raw)
In-Reply-To: <1343243745-1172-1-git-send-email-kerolasa@iki.fi>

Align with Documentation/howto-man-page.txt

Signed-off-by: Sami Kerola <kerolasa@iki.fi>
---
 login-utils/sulogin.8 | 70 ++++++++++++++++++++++++++++++++-------------------
 1 file changed, 44 insertions(+), 26 deletions(-)

diff --git a/login-utils/sulogin.8 b/login-utils/sulogin.8
index 24c120d..b9dec16 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 .
-- 
1.7.11.3


  parent reply	other threads:[~2012-07-25 19:16 UTC|newest]

Thread overview: 37+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-07-25 19:15 [PATCH 0/27] preparation to release some time soon Sami Kerola
2012-07-25 19:15 ` [PATCH 1/3] tests: partx changed default output format Sami Kerola
2012-07-26 10:07   ` Karel Zak
2012-07-25 19:15 ` [PATCH 2/3] tests: look: add words file Sami Kerola
2012-07-26 10:08   ` Karel Zak
2012-07-25 19:15 ` [PATCH 3/3] tests: fdisk: change expected test output Sami Kerola
2012-07-26 10:32   ` Karel Zak
2012-07-25 19:15 ` [PATCH 01/19] mkswap: fix shadow declaration Sami Kerola
2012-07-26 10:32   ` Karel Zak
2012-07-25 19:15 ` [PATCH 02/19] libmount: " Sami Kerola
2012-07-26 10:33   ` Karel Zak
2012-07-25 19:15 ` [PATCH 03/19] sulogin: " Sami Kerola
2012-07-26 10:34   ` Karel Zak
2012-07-25 19:15 ` [PATCH 04/19] blkid: " Sami Kerola
2012-07-26 10:35   ` Karel Zak
2012-07-25 19:15 ` [PATCH 05/19] lslocks: " Sami Kerola
2012-07-25 19:15 ` [PATCH 06/19] whereis: " Sami Kerola
2012-07-25 19:15 ` [PATCH 07/19] eject: " Sami Kerola
2012-07-25 19:15 ` [PATCH 08/19] lscpu: " Sami Kerola
2012-07-25 19:15 ` [PATCH 09/19] setterm: " Sami Kerola
2012-07-25 19:15 ` [PATCH 10/19] more: " Sami Kerola
2012-07-25 19:15 ` [PATCH 11/19] ul: " Sami Kerola
2012-07-25 19:15 ` [PATCH 12/19] hexdump: " Sami Kerola
2012-07-25 19:15 ` [PATCH 13/19] include: define format to be constant in xasprintf() Sami Kerola
2012-07-25 19:15 ` [PATCH 14/19] fdisk: add noreturn function attribute Sami Kerola
2012-07-25 19:15 ` [PATCH 15/19] libblkid: " Sami Kerola
2012-07-25 19:15 ` [PATCH 16/19] libmount: " Sami Kerola
2012-07-25 19:15 ` [PATCH 17/19] vipw: " Sami Kerola
2012-07-25 19:15 ` [PATCH 18/19] script: add noreturn function attributes Sami Kerola
2012-07-25 19:15 ` [PATCH 19/19] more: add noreturn function attribute Sami Kerola
2012-07-25 19:15 ` [PATCH 1/5] ddate: russian manual missing from package Sami Kerola
2012-07-25 19:15 ` Sami Kerola [this message]
2012-07-25 19:15 ` [PATCH 3/5] wdctl: fix conflicting types on old systems Sami Kerola
2012-07-25 19:15 ` [PATCH 4/5] dmesg: inform user when klogctl() or read_buffer() fails Sami Kerola
2012-07-25 19:15 ` [PATCH 5/5] docs: tell about irc channel Sami Kerola
2012-07-26 10:07 ` [PATCH 0/27] preparation to release some time soon Karel Zak
2012-07-26 12:16 ` Karel Zak

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1343243745-1172-25-git-send-email-kerolasa@iki.fi \
    --to=kerolasa@iki.fi \
    --cc=util-linux@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).