[PATCH 00/10] Man page corrections v1.0

[PATCH 00/10] Man page corrections v1.0

[Ondrej Oprala]

Just some minor man page corrections.

Ondrej Oprala (10):
  last: fix minor typos in the man page
  runuser: fix minor typos in the man page
  su: fix minor typos in the man page
  sulogin: minor man page improvements
  utmpdump: minor man page improvements
  nologin: minor man page improvements
  vipw: minor man page improvements
  addpart: minor man page improvements
  cfdisk: minor man page improvements
  delpart: minor man page improvements

 disk-utils/addpart.8   |  8 ++++----
 disk-utils/cfdisk.8    | 24 ++++++++++++------------
 disk-utils/delpart.8   |  2 +-
 login-utils/last.1     | 32 ++++++++++++++++----------------
 login-utils/nologin.8  | 10 +++++-----
 login-utils/runuser.1  | 28 ++++++++++++++--------------
 login-utils/su.1       | 20 ++++++++++----------
 login-utils/sulogin.8  |  2 +-
 login-utils/utmpdump.1 | 24 ++++++++++++------------
 login-utils/vipw.8     |  2 +-
 10 files changed, 76 insertions(+), 76 deletions(-)

-- 
1.8.5.1

[PATCH 01/10] last: fix minor typos in the man page

[Ondrej Oprala]

Signed-off-by: Ondrej Oprala <ooprala@redhat.com>
---
 login-utils/last.1 | 32 ++++++++++++++++----------------
 1 file changed, 16 insertions(+), 16 deletions(-)

diff --git a/login-utils/last.1 b/login-utils/last.1
index d0b9744..edaddd1 100644
--- a/login-utils/last.1
+++ b/login-utils/last.1
@@ -16,7 +16,7 @@
 .\"
 .TH "LAST, LASTB" "1" "October 2013" "util-linux" "User Commands"
 .SH NAME
-last, lastb \- show listing of last logged in users
+last, lastb \- show a listing of last logged in users
 .SH SYNOPSIS
 .B last
 .RI [ options ]
@@ -29,9 +29,9 @@ last, lastb \- show listing of last logged in users
 .RI [ tty ...]
 .SH DESCRIPTION
 .B last
-searches back through the file
+searches back through the
 .B /var/log/wtmp
-(or the file designated by the
+file (or the file designated by the
 .B \-f
 option) and displays a list of all users logged in (and out) since that
 file was created.  One or more
@@ -57,14 +57,14 @@ The pseudo user
 .B reboot
 logs in each time the system is rebooted.  Thus
 .B last reboot
-will show a log of all reboots since the log file was created.
+will show a log of all the reboots since the log file was created.
 .PP
 .B lastb
 is the same as
 .BR last ,
-except that by default it shows a log of the file
-.BR /var/log/btmp ,
-which contains all the bad login attempts.
+except that by default it shows a log of the
+.BR /var/log/btmp
+file, which contains all the bad login attempts.
 .SH OPTIONS
 .TP
 .BR \-a , " \-\-hostlast"
@@ -74,7 +74,7 @@ option.
 .TP
 .BR \-d , " \-\-dns"
 For non-local logins, Linux stores not only the host name of the remote
-host but its IP number as well.  This option translates the IP number
+host, but its IP number as well.  This option translates the IP number
 back into a hostname.
 .TP
 .BR \-f , " \-\-file " \fIfile\fR
@@ -92,29 +92,29 @@ Print full login and logout times and dates.
 .TP
 .BR \-i , " \-\-ip"
 Like
-.B \-\-dns
-but displays the host's IP number instead of name.
+.B \-\-dns ,
+but displays the host's IP number instead of the name.
 .TP
 .BI \- number
 .TQ
 .BR \-n , " -\-limit " \fInumber\fR
-This is a count telling
+Tell
 .B last
 how many lines to show.
 .TP
 .BR \-p , " \-\-present " \fItime\fR
 Display the users who were present at the specified time.  This is
 like using the options
+.BR \-\-since " and " \-\-until
+together with the same \fItime\fR.
 .TP
 .BR \-R , " \-\-nohostname"
 Suppresses the display of the hostname field.
-.BR \-\-since " and " \-\-until
-together with the same \fItime\fR.
 .TP
 .BR \-s , " \-\-since " \fItime\fR
-Display the state of logins since specified
+Display the state of logins since the specified
 .IR time .
-This is useful, e.g., to determine easily who was logged in at a
+This is useful, e.g., to easily determine who was logged in at a
 particular time.  The option is often combined with
 .BR \-\-until .
 .TP
@@ -133,7 +133,7 @@ or
 .IR iso .
 The
 .I notime
-variant will not print any timestamp at all,
+variant will not print any timestamps at all,
 .I short
 is the default, and
 .I full
-- 
1.8.5.1

[PATCH 02/10] runuser: fix minor typos in the man page

[Ondrej Oprala]

Signed-off-by: Ondrej Oprala <ooprala@redhat.com>
---
 login-utils/runuser.1 | 28 ++++++++++++++--------------
 1 file changed, 14 insertions(+), 14 deletions(-)

diff --git a/login-utils/runuser.1 b/login-utils/runuser.1
index 7201ff0..34cc84d 100644
--- a/login-utils/runuser.1
+++ b/login-utils/runuser.1
@@ -15,22 +15,22 @@ runuser \- run a command with substitute user and group ID
 .SH DESCRIPTION
 .B runuser
 allows to run commands with substitute user and group ID.
-If the option \fB\-u\fR not given, fallback to
+If the option \fB\-u\fR is not given, falls back to
 .B su
-compatible semantic and shell is executed.
+compatible semantics and a shell is executed.
 The difference between the commands
 .B runuser
 and
 .B su
 is that
 .B runuser
-does not ask for password (because it may be executed by root user only) and
+does not ask for a password (because it may be executed by the root user only) and
 it uses a different PAM configuration.
 The command
 .B runuser
 does not have to be installed with suid permissions.
 .PP
-When called without arguments
+When called without arguments,
 .B runuser
 defaults to running an interactive shell as
 .IR root .
@@ -63,28 +63,28 @@ option.
 .TP
 \fB\-\-session\-command\fR=\fIcommand\fR
 Same as
-.B \-c
+.B \-c ,
 but do not create a new session (discouraged).
 .TP
 \fB\-f\fR, \fB\-\-fast\fR
 Pass
 .B \-f
-to the shell which may or may not be useful depending on the
+to the shell, which may or may not be useful depending on the
 shell.
 .TP
 \fB\-g\fR, \fB\-\-group\fR=\fIgroup\fR\fR
-specify the primary group, this option is allowed for root user only
+specify the primary group, this option is allowed to the root user only
 .TP
 \fB\-G\fR, \fB\-\-supp-group\fR=\fIgroup\fR\fR
-specify a supplemental group, this option is allowed for root user only
+specify a supplemental group, this option is allowed to the root user only
 .TP
 \fB\-\fR, \fB\-l\fR, \fB\-\-login\fR
-Starts the shell as login shell with an environment similar to a real
+Starts the shell as a login shell with an environment similar to a real
 login:
 .RS 10
 .TP
 o
-clears all environment variables except for
+clears all the environment variables except for
 .B TERM
 .TP
 o
@@ -105,7 +105,7 @@ in order to make the shell a login shell
 .RE
 .TP
 \fB\-m\fR, \fB\-p\fR, \fB\-\-preserve-environment\fR
-Preserves the whole environment, ie does not set
+Preserves the entire environment, i.e. does not set
 .BR HOME ,
 .BR SHELL ,
 .B USER
@@ -205,7 +205,7 @@ Generic error before executing the requested command
 The requested command could not be executed
 .TP
 127
-The requested command could was not found
+The requested command was not found
 .RE
 .SH FILES
 .PD 0
@@ -228,8 +228,8 @@ global logindef config file
 .BR login.defs (5),
 .BR su (1)
 .SH AUTHOR
-Derived from coreutils' su which was based on an implemenation from
-David MacKenzie and Fedora runuser command from Dan Walsh.
+Derived from coreutils' su which was based on an implemenation by
+David MacKenzie and the Fedora runuser command by Dan Walsh.
 .SH AVAILABILITY
 The runuser command is part of the util-linux package and is
 available from
-- 
1.8.5.1

[PATCH 03/10] su: fix minor typos in the man page

[Ondrej Oprala]

Signed-off-by: Ondrej Oprala <ooprala@redhat.com>
---
 login-utils/su.1 | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/login-utils/su.1 b/login-utils/su.1
index 55c0b8b..723ba15 100644
--- a/login-utils/su.1
+++ b/login-utils/su.1
@@ -39,7 +39,7 @@ This version of
 uses PAM for authentication, account and session management.  Some
 configuration options found in other
 .B su
-implementations, such as support of a wheel group, have to be
+implementations, such as support for a wheel group, have to be
 configured via PAM.
 .SH OPTIONS
 .TP
@@ -61,18 +61,18 @@ Pass
 to the shell, which may or may not be useful, depending on the shell.
 .TP
 \fB\-g\fR, \fB\-\-group\fR=\fIgroup\fR\fR
-Specify the primary group.  This option is available for the root user only.
+Specify the primary group.  This option is available to the root user only.
 .TP
 \fB\-G\fR, \fB\-\-supp-group\fR=\fIgroup\fR\fR
-Specify a supplemental group.  This option is available for the root user only.
+Specify a supplemental group.  This option is available to the root user only.
 .TP
 \fB\-\fR, \fB\-l\fR, \fB\-\-login\fR
-Starts the shell as login shell with an environment similar to a real
+Starts the shell as a login shell with an environment similar to a real
 login:
 .RS 10
 .TP
 o
-clears all environment variables except
+clears all the environment variables except
 .B TERM
 .TP
 o
@@ -93,7 +93,7 @@ in order to make the shell a login shell
 .RE
 .TP
 \fB\-m\fR, \fB\-p\fR, \fB\-\-preserve-environment\fR
-Preserves the whole environment, i.e. it does not set
+Preserves the entire environment, i.e. it does not set
 .BR HOME ,
 .BR SHELL ,
 .B USER
@@ -158,7 +158,7 @@ for
 .B FAIL_DELAY
 (number)
 .RS 4
-Delay in seconds in case of authentication failure.  Number must be
+Delay in seconds in case of an authentication failure. The number must be
 a non-negative integer.
 .RE
 .PP
@@ -209,7 +209,7 @@ Generic error before executing the requested command
 The requested command could not be executed
 .TP
 127
-The requested command could was not found
+The requested command was not found
 .RE
 .SH FILES
 .PD 0
@@ -234,7 +234,7 @@ the lastlog file at all.  This solution allows to control
 .B su
 behavior by PAM configuration.  If you want to use the pam_lastlog module to
 print warning message about failed log-in attempts then the pam_lastlog has to
-be configured to update lastlog file too. For example by:
+be configured to update the lastlog file as well. For example by:
 
 .RS
 .br
@@ -246,7 +246,7 @@ session  required  pam_lastlog.so nowtmp
 .BR shells (5),
 .BR login.defs (5)
 .SH AUTHOR
-Derived from coreutils' su which was based on an implementation from
+Derived from coreutils' su which was based on an implementation by
 David MacKenzie.
 .SH AVAILABILITY
 The su command is part of the util-linux package and is
-- 
1.8.5.1

[PATCH 04/10] sulogin: minor man page improvements

[Ondrej Oprala]

Signed-off-by: Ondrej Oprala <ooprala@redhat.com>
---
 login-utils/sulogin.8 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/login-utils/sulogin.8 b/login-utils/sulogin.8
index a401446..57a7118 100644
--- a/login-utils/sulogin.8
+++ b/login-utils/sulogin.8
@@ -76,7 +76,7 @@ or
 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
+If that fails, it
 will fall back to
 .IR /bin/sh .
 .SH AUTHOR
-- 
1.8.5.1

[PATCH 05/10] utmpdump: minor man page improvements

[Ondrej Oprala]

Signed-off-by: Ondrej Oprala <ooprala@redhat.com>
---
 login-utils/utmpdump.1 | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)

diff --git a/login-utils/utmpdump.1 b/login-utils/utmpdump.1
index 7069159..7a7442a 100644
--- a/login-utils/utmpdump.1
+++ b/login-utils/utmpdump.1
@@ -2,13 +2,13 @@
 .\" Copyright (C) 2010 Michael Krapp
 .\"
 .\" This program is free software; you can redistribute it and/or modify
-.\" it under the terms of the GNU General Public License as published by 
+.\" it under the terms of the GNU General Public License as published by
 .\" the Free Software Foundation; either version 2 of the License, or
 .\" (at your option) any later version.
 .\"
 .\" This program is distributed in the hope that it will be useful,
 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
-.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the  
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 .\" GNU General Public License for more details.
 .\"
 .\" You should have received a copy of the GNU General Public License
@@ -25,16 +25,16 @@ utmpdump [\-frohV] [ filename ]
 is a simple program to dump UTMP and WTMP files in raw format, so they
 can be examined.
 .B utmpdump
-eads from stdin unless a 
+reads from stdin unless a
 .I filename
 is passed.
 .SH OPTIONS
 .IP "\fB\-f\fR, \fB\-\-follow\fP"
 Output appended data as the file grows.
 .IP "\fB\-r\fR, \fB\-\-reverse\fP
-Undump, write back edited login information into utmp or wtmp files.
+Undump, write back edited login information into the utmp or wtmp files.
 .IP "\fB\-o\fR, \fB\-\-output\fP \fIfile\fR
-Write command output to file instead of standard output.
+Write command output to \fIfile\fR instead of standard output.
 .IP "\fB\-h\fR, \fB\-\-help\fP"
 Display help text and exit.
 .IP "\fB\-V\fR, \fB\-\-version\fP"
@@ -42,25 +42,25 @@ Display version information and exit.
 .SH NOTES
 .B utmpdump
 can be useful in cases of corrupted utmp or wtmp entries.  It can dump
-out utmp/wtmp to an ASCII file, then that file can be edited to remove
+out utmp/wtmp to an ASCII file, whic can then be edited to remove
 bogus entries and reintegrated, using
-.PP 
+.PP
 .RS
 utmpdump -r < ascii_file > wtmp
 .RE
 .PP
-but be warned as
+but be warned, as
 .B utmpdump
-was written for debugging purpose only.
+was written for debugging purposes only.
 .SH BUGS
 You may
 .B not
-use the option
+use the
 .B \-r
-as the format for the utmp/wtmp files strongly depends on the input
+option, as the format for the utmp/wtmp files strongly depends on the input
 format.  This tool was
 .B not
-written for normal use but for debugging.
+written for normal use, but for debugging only.
 .SH AUTHOR
 Michael Krapp
 .SH "SEE ALSO"
-- 
1.8.5.1

[PATCH 06/10] nologin: minor man page improvements

[Ondrej Oprala]

Signed-off-by: Ondrej Oprala <ooprala@redhat.com>
---
 login-utils/nologin.8 | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/login-utils/nologin.8 b/login-utils/nologin.8
index f91029d..269daf5 100644
--- a/login-utils/nologin.8
+++ b/login-utils/nologin.8
@@ -9,7 +9,7 @@ nologin \- politely refuse a login
 .SH DESCRIPTION
 .B nologin
 displays a message that an account is not available and exits non-zero.  It is
-intended as a replacement shell field to deny login access to account.
+intended as a replacement shell field to deny login access to an account.
 .PP
 If the file /etc/nologin.txt exists, nologin displays its contents to the 
 user instead of the default message.
@@ -25,15 +25,15 @@ Display help text and exit.
 Display version information and exit.
 .SH NOTES
 .B nologin
-is per-account way to disable login (usually used for system accounts like http or ftp).
+is a per-account way to disable login (usually used for system accounts like http or ftp).
 .BR nologin (8)
-uses /etc/nologin.txt as optional source for non-default message, the login
-access is always refused independently on the file.
+uses /etc/nologin.txt as an optional source for a non-default message, the login
+access is always refused independently of the file.
 .PP
 .BR pam_nologin (8)
 PAM module usually prevents all non-root users from logging into the system.
 .BR pam_nologin (8)
-functionality is controlled by /var/run/nologin or /etc/nologin file.
+functionality is controlled by /var/run/nologin or the /etc/nologin file.
 .SH AUTHORS
 .UR kzak@redhat.com
 Karel Zak
-- 
1.8.5.1

[PATCH 07/10] vipw: minor man page improvements

[Ondrej Oprala]

Signed-off-by: Ondrej Oprala <ooprala@redhat.com>
---
 login-utils/vipw.8 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/login-utils/vipw.8 b/login-utils/vipw.8
index 62dcc85..ab7b76c 100644
--- a/login-utils/vipw.8
+++ b/login-utils/vipw.8
@@ -58,7 +58,7 @@ edits the group file in the same manner as
 .B vipw
 does the passwd file.
 .SH ENVIRONMENT
-If the following environment variable exists it will be utilized by
+If the following environment variable exists, it will be utilized by
 .B vipw
 and
 .BR vigr :
-- 
1.8.5.1

[PATCH 08/10] addpart: minor man page improvements

[Ondrej Oprala]

Signed-off-by: Ondrej Oprala <ooprala@redhat.com>
---
 disk-utils/addpart.8 | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/disk-utils/addpart.8 b/disk-utils/addpart.8
index 9dcd0a3..875ca9e 100644
--- a/disk-utils/addpart.8
+++ b/disk-utils/addpart.8
@@ -5,15 +5,15 @@
 .TH ADDPART 8 "January 2007" "util-linux" "System Administration"
 .SH NAME
 addpart \-
-simple wrapper around the "add partition" ioctl
+a simple wrapper around the "add partition" ioctl
 .SH SYNOPSIS
 .B addpart
 .I device partition start length
 .SH DESCRIPTION
 .B addpart
-is a program that informs the Linux kernel of new partition.
+is a program that informs the Linux kernel of a new partition.
 
-This command doesn't manipulate partitions on hard drive.
+This command doesn't manipulate partitions on the hard drive.
 
 .SH PARAMETERS
 .TP
@@ -24,7 +24,7 @@ Specify the disk device.
 Specify the partition number.
 .TP
 .I start
-Specify the begin of the partition (in 512-byte sectors).
+Specify the beginning of the partition (in 512-byte sectors).
 .TP
 .I length
 Specify the length of the partition (in 512-byte sectors).
-- 
1.8.5.1

[PATCH 09/10] cfdisk: minor man page improvements

[Ondrej Oprala]

Signed-off-by: Ondrej Oprala <ooprala@redhat.com>
---
 disk-utils/cfdisk.8 | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)

diff --git a/disk-utils/cfdisk.8 b/disk-utils/cfdisk.8
index 64197ef..01bde08 100644
--- a/disk-utils/cfdisk.8
+++ b/disk-utils/cfdisk.8
@@ -14,7 +14,7 @@
 .\" " for hilit mode
 .TH CFDISK 8 "March 2014" "util-linux" "System Administration"
 .SH NAME
-cfdisk \- display or manipulate disk partition table
+cfdisk \- display or manipulate a disk partition table
 .SH SYNOPSIS
 .B cfdisk
 .RB [ options ]
@@ -26,13 +26,13 @@ The default device is /dev/sda.
 
 Note that
 .B cfdisk
-provides basic partitioning functionality by user friendly interface. If you
-need advanced features then use 
+provides basic partitioning functionality by a user friendly interface. If you
+need advanced features, use 
 .BR fdisk (8).
 
 Since version 2.25
 .BR cfdisk (8)
-supports MBR (DOS), GPT, SUN and SGI disk labels, but it does not provides any
+supports MBR (DOS), GPT, SUN and SGI disk labels, but it does not provide any
 functionality in regards to CHS (Cylinder-Head-Sector) addressing. CHS has
 never been important for Linux and this addressing concept does not make any
 sense for new devices.
@@ -44,9 +44,9 @@ utils
 .BR partx (8)
 and
 .BR lsblk (8)
-in very comfortable and rich way.
+in a very comfortable and rich way.
 
-If you want to remove an old partition table from device than use
+If you want to remove an old partition table from a device, use
 .BR wipefs (8).
 
 .SH OPTIONS
@@ -55,7 +55,7 @@ Display help text and exit.
 .IP "\fB\-L\fR, \fB\-\-color\fR[=\fIwhen\fR]"
 Colorize output, enabled by default.  The optional argument \fIwhen\fP can be
 \fBauto\fR, \fBnever\fR or \fBalways\fR.  If the \fIwhen\fR argument is omitted,
-then it defaults to \fBauto\fR.
+it defaults to \fBauto\fR.
 .IP "\fB-V, \-\-version"
 Display version information and exit.
 
@@ -67,9 +67,9 @@ after the command is not necessary).  Here is a list of the available
 commands:
 .TP
 .B b
-Toggle bootable flag of the current partition.  This allows you to
-select which primary partition is bootable on the drive. This command does not
-have to available for all partition label types.
+Toggle the bootable flag of the current partition.  This allows you to
+select which primary partition is bootable on the drive. This command may not
+be available for all partition label types.
 .TP
 .B d
 Delete the current partition.  This will convert the current partition
@@ -92,8 +92,8 @@ MiB=1024*1024, and so on for GiB, TiB, PiB, EiB, ZiB and YiB (the "iB"
 is optional, e.g. "K" has the same meaning as  "KiB")
 .TP
 .B q
-Quit program.  This will exit the program without writing any data to
-disk.
+Quit the program.  This will exit the program without writing any data to
+the disk.
 .TP
 .B t
 Change the partition type.  By default, new partitions are created as
-- 
1.8.5.1

[PATCH 10/10] delpart: minor man page improvements

[Ondrej Oprala]

Signed-off-by: Ondrej Oprala <ooprala@redhat.com>
---
 disk-utils/delpart.8 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/disk-utils/delpart.8 b/disk-utils/delpart.8
index 433582f..5f90ec1 100644
--- a/disk-utils/delpart.8
+++ b/disk-utils/delpart.8
@@ -13,7 +13,7 @@ simple wrapper around the "del partition" ioctl
 .B delpart
 is a program that asks the Linux kernel to remove a partition.
 
-This command doesn't manipulate partitions on hard drive.
+This command doesn't manipulate partitions on a hard drive.
 
 .SH OPTIONS
 .TP
-- 
1.8.5.1

Re: [PATCH 00/10] Man page corrections v1.0

[Karel Zak]

On Tue, Apr 08, 2014 at 09:48:39AM +0200, Ondrej Oprala wrote:
>  disk-utils/addpart.8   |  8 ++++----
>  disk-utils/cfdisk.8    | 24 ++++++++++++------------
>  disk-utils/delpart.8   |  2 +-
>  login-utils/last.1     | 32 ++++++++++++++++----------------
>  login-utils/nologin.8  | 10 +++++-----
>  login-utils/runuser.1  | 28 ++++++++++++++--------------
>  login-utils/su.1       | 20 ++++++++++----------
>  login-utils/sulogin.8  |  2 +-
>  login-utils/utmpdump.1 | 24 ++++++++++++------------
>  login-utils/vipw.8     |  2 +-
>  10 files changed, 76 insertions(+), 76 deletions(-)

 Applied, thanks.

-- 
 Karel Zak  <kzak@redhat.com>
 http://karelzak.blogspot.com