[PATCH 1/8] docs: fix the grammar of the recent comment about comments

[PATCH 1/8] docs: fix the grammar of the recent comment about comments

[Benno Schulenberg]

Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
---
 lib/terminal-colors.d.5 |    5 +++--
 1 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/lib/terminal-colors.d.5 b/lib/terminal-colors.d.5
index 1bd98a1..66ecf2c 100644
--- a/lib/terminal-colors.d.5
+++ b/lib/terminal-colors.d.5
@@ -163,8 +163,9 @@ use:
 .RE
 
 .SS Comments
-All lines where the first non-blank character is # (hash) are ignored. The
-another usage of the hash character is not interpreted as comment.
+Lines where the first non-blank character is a # (hash) are ignored.
+Any other use of the hash character is not interpreted as introducing
+a comment.
 
 .SH FILES
 .B $XDG_CONFIG_HOME/terminal-colors.d
-- 
1.7.0.4

[PATCH 2/8] textual: do not start option descriptions with a capital

[Benno Schulenberg]

This normalizes the help text of getopt, clarifies one description,
and also adjust two comments.

Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
---
 misc-utils/getopt.c |   28 ++++++++++++++--------------
 1 files changed, 14 insertions(+), 14 deletions(-)

diff --git a/misc-utils/getopt.c b/misc-utils/getopt.c
index 197bae7..85cac32 100644
--- a/misc-utils/getopt.c
+++ b/misc-utils/getopt.c
@@ -91,12 +91,12 @@ struct getopt_control {
 
 enum { REALLOC_INCREMENT = 8 };
 
-/* Allow changing which getopt is in use with function pointer */
+/* Allow changing which getopt is in use with function pointer. */
 int (*getopt_long_fp) (int argc, char *const *argv, const char *optstr,
 		       const struct option * longopts, int *longindex);
 
 /*
- * This function 'print_normalizeds' a single argument: it puts single quotes
+ * This function 'normalizes' a single argument: it puts single quotes
  * around it and escapes other special characters. If quote is false, it
  * just returns its argument.
  *
@@ -314,21 +314,21 @@ static void __attribute__ ((__noreturn__)) print_help(void)
 {
 	fputs(USAGE_HEADER, stderr);
 	fprintf(stderr, _(
-		" %1$s optstring parameters\n"
-		" %1$s [options] [--] optstring parameters\n"
-		" %1$s [options] -o|--options optstring [options] [--] parameters\n"),
+		" %1$s <optstring> <parameters>\n"
+		" %1$s [options] [--] <optstring> <parameters>\n"
+		" %1$s [options] -o|--options <optstring> [options] [--] <parameters>\n"),
 		program_invocation_short_name);
 
 	fputs(USAGE_OPTIONS, stderr);
-	fputs(_(" -a, --alternative            Allow long options starting with single -\n"), stderr);
-	fputs(_(" -l, --longoptions <longopts> Long options to be recognized\n"), stderr);
-	fputs(_(" -n, --name <progname>        The name under which errors are reported\n"), stderr);
-	fputs(_(" -o, --options <optstring>    Short options to be recognized\n"), stderr);
-	fputs(_(" -q, --quiet                  Disable error reporting by getopt(3)\n"), stderr);
-	fputs(_(" -Q, --quiet-output           No normal output\n"), stderr);
-	fputs(_(" -s, --shell <shell>          Set shell quoting conventions\n"), stderr);
-	fputs(_(" -T, --test                   Test for getopt(1) version\n"), stderr);
-	fputs(_(" -u, --unquoted               Do not quote the output\n"), stderr);
+	fputs(_(" -a, --alternative             allow long options starting with single -\n"), stderr);
+	fputs(_(" -l, --longoptions <longopts>  the long options to be recognized\n"), stderr);
+	fputs(_(" -n, --name <progname>         the name under which errors are reported\n"), stderr);
+	fputs(_(" -o, --options <optstring>     the short options to be recognized\n"), stderr);
+	fputs(_(" -q, --quiet                   disable error reporting by getopt(3)\n"), stderr);
+	fputs(_(" -Q, --quiet-output            no normal output\n"), stderr);
+	fputs(_(" -s, --shell <shell>           set quoting conventions to those of <shell>\n"), stderr);
+	fputs(_(" -T, --test                    test for getopt(1) version\n"), stderr);
+	fputs(_(" -u, --unquoted                do not quote the output\n"), stderr);
 	fputs(USAGE_SEPARATOR, stderr);
 	fputs(USAGE_HELP, stderr);
 	fputs(USAGE_VERSION, stderr);
-- 
1.7.0.4

[PATCH 3/8] docs: improve the sorting of the options in the man page of getopt

[Benno Schulenberg]

Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
---
 misc-utils/getopt.1 |   18 +++++++++---------
 1 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/misc-utils/getopt.1 b/misc-utils/getopt.1
index 7fd8720..6758d27 100644
--- a/misc-utils/getopt.1
+++ b/misc-utils/getopt.1
@@ -1,4 +1,4 @@
-.TH GETOPT "1" "June 2012" "util-linux" "User Commands"
+.TH GETOPT "1" "December 2014" "util-linux" "User Commands"
 .SH NAME
 getopt \- parse command options (enhanced)
 .SH SYNOPSIS
@@ -69,7 +69,7 @@ for more information).
 .PP
 Traditional implementations of
 .BR getopt (1)
-are unable to cope with whitespace and other (shell\-specific)
+are unable to cope with whitespace and other (shell-specific)
 special characters in arguments and non\-option parameters.  To solve
 this problem, this implementation can generate quoted output which
 must once again be interpreted by the shell (usually by using the
@@ -151,13 +151,6 @@ conventions are used.  Valid arguments are currently
 and
 .RB ' tcsh '.
 .TP
-.BR \-u , " \-\-unquoted"
-Do not quote the output.  Note that whitespace and special
-(shell\-dependent) characters can cause havoc in this mode (like they
-do with other
-.BR getopt (1)
-implementations).
-.TP
 .BR \-T , " \-\-test"
 Test if your
 .BR getopt (1)
@@ -170,6 +163,13 @@ is set, will return
 .RB ' \-\- '
 and error status 0.
 .TP
+.BR \-u , " \-\-unquoted"
+Do not quote the output.  Note that whitespace and special
+(shell-dependent) characters can cause havoc in this mode (like they
+do with other
+.BR getopt (1)
+implementations).
+.TP
 .BR \-V , " \-\-version"
 Display version information and exit.  No other output is generated.
 .SH PARSING
-- 
1.7.0.4

[PATCH 4/8] docs: don't use bold or italics for "[option]" in synopsis of man pages

[Benno Schulenberg]

As per the convention shown in Documentation/howto-man-page.txt.
Also make a few other tiny adjustments along the way.

Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
---
 disk-utils/cfdisk.8     |    2 +-
 disk-utils/fdformat.8   |    2 +-
 disk-utils/fdisk.8      |    2 +-
 disk-utils/isosize.8    |    2 +-
 disk-utils/mkfs.8       |    2 +-
 disk-utils/mkfs.bfs.8   |    2 +-
 disk-utils/mkswap.8     |    2 +-
 disk-utils/partx.8      |   11 +++++++++--
 disk-utils/sfdisk.8     |   18 +++++++++---------
 login-utils/last.1      |   10 ++++------
 login-utils/lslogins.1  |    5 ++++-
 misc-utils/cal.1        |    3 ++-
 misc-utils/findmnt.8    |   10 +++++-----
 misc-utils/getopt.1     |    6 +++---
 misc-utils/logger.1     |    3 ++-
 misc-utils/look.1       |    5 +++--
 misc-utils/lsblk.8      |    2 +-
 misc-utils/lslocks.8    |    3 ++-
 misc-utils/mcookie.1    |    2 +-
 misc-utils/namei.1      |    4 ++--
 misc-utils/rename.1     |    3 ++-
 misc-utils/uuidgen.1    |    2 +-
 misc-utils/whereis.1    |    2 +-
 sys-utils/readprofile.8 |    2 +-
 term-utils/agetty.8     |    6 ++----
 25 files changed, 61 insertions(+), 50 deletions(-)

diff --git a/disk-utils/cfdisk.8 b/disk-utils/cfdisk.8
index 6da8f43..dc30b70 100644
--- a/disk-utils/cfdisk.8
+++ b/disk-utils/cfdisk.8
@@ -16,7 +16,7 @@
 cfdisk \- display or manipulate a disk partition table
 .SH SYNOPSIS
 .B cfdisk
-.RB [ options ]
+[options]
 .RI [ device ]
 .SH DESCRIPTION
 .B cfdisk
diff --git a/disk-utils/fdformat.8 b/disk-utils/fdformat.8
index ae1e530..9e1b989 100644
--- a/disk-utils/fdformat.8
+++ b/disk-utils/fdformat.8
@@ -5,7 +5,7 @@
 fdformat \- low-level format a floppy disk
 .SH SYNOPSIS
 .B fdformat
-.RI [ options ] " device"
+.RI [options] " device"
 .SH DESCRIPTION
 .B fdformat
 does a low-level format on a floppy disk.
diff --git a/disk-utils/fdisk.8 b/disk-utils/fdisk.8
index 56caab1..a61176d 100644
--- a/disk-utils/fdisk.8
+++ b/disk-utils/fdisk.8
@@ -10,7 +10,7 @@ fdisk \- manipulate disk partition table
 
 .SH SYNOPSIS
 .B fdisk
-.RB [ options ]
+[options]
 .I device
 .sp
 .B fdisk \-l
diff --git a/disk-utils/isosize.8 b/disk-utils/isosize.8
index 07ecfdc..98382f2 100644
--- a/disk-utils/isosize.8
+++ b/disk-utils/isosize.8
@@ -3,7 +3,7 @@
 isosize \- output the length of an iso9660 filesystem
 .SH SYNOPSIS
 .B isosize
-.RI [ options ] " iso9660_image_file"
+.RI [options] " iso9660_image_file"
 .SH DESCRIPTION
 .PP
 This command outputs the length of an iso9660 filesystem that
diff --git a/disk-utils/mkfs.8 b/disk-utils/mkfs.8
index 675822d..54bb004 100644
--- a/disk-utils/mkfs.8
+++ b/disk-utils/mkfs.8
@@ -4,7 +4,7 @@
 mkfs \- build a Linux filesystem
 .SH SYNOPSIS
 .B mkfs
-.RI [ options ]
+[options]
 .RB [ \-t
 .IR type "] [" fs-options ] " device " [ size ]
 .SH DESCRIPTION
diff --git a/disk-utils/mkfs.bfs.8 b/disk-utils/mkfs.bfs.8
index e1afd04..0769105 100644
--- a/disk-utils/mkfs.bfs.8
+++ b/disk-utils/mkfs.bfs.8
@@ -5,7 +5,7 @@
 mkfs.bfs \- make an SCO bfs filesystem
 .SH SYNOPSIS
 .B mkfs.bfs
-.RI [ options ] " device " [ block-count ]
+.RI [options] " device " [ block-count ]
 .SH DESCRIPTION
 .B mkfs.bfs
 creates an SCO bfs filesystem on a block device
diff --git a/disk-utils/mkswap.8 b/disk-utils/mkswap.8
index c110d21..562078d 100644
--- a/disk-utils/mkswap.8
+++ b/disk-utils/mkswap.8
@@ -8,7 +8,7 @@
 mkswap \- set up a Linux swap area
 .SH SYNOPSIS
 .B mkswap
-.RI [ options ]
+[options]
 .I device
 .RI [ size ]
 .SH DESCRIPTION
diff --git a/disk-utils/partx.8 b/disk-utils/partx.8
index 88eef60..005fe66 100644
--- a/disk-utils/partx.8
+++ b/disk-utils/partx.8
@@ -7,9 +7,16 @@
 .SH NAME
 partx \- tell the Linux kernel about the presence and numbering of on-disk partitions
 .SH SYNOPSIS
-partx [\-a | \-d | \-s | \-u] [\-t TYPE] [\-n M:N] [\-] disk
+.B partx
+.RB [ \-a | \-d | \-s | \-u ]
+.RB [ \-t " \fItype\fR]"
+.RB [ \-n " \fIM" : \fIN\fR]
+.RB [ \- "] " \fIdisk
 .br
-partx [\-a | \-d | \-s | \-u] [\-t TYPE] partition [disk]
+.B partx
+.RB [ \-a | \-d | \-s | \-u ]
+.RB [ \-t " \fItype\fR]"
+.IR partition " [" disk ]
 .SH DESCRIPTION
 Given a device or disk-image,
 .B partx
diff --git a/disk-utils/sfdisk.8 b/disk-utils/sfdisk.8
index 08725fd..62b1dcf 100644
--- a/disk-utils/sfdisk.8
+++ b/disk-utils/sfdisk.8
@@ -15,14 +15,14 @@
 sfdisk \- display or manipulate a disk partition table
 .SH SYNOPSIS
 .B sfdisk
-.RB [ options ]
-.RI device
-.BR [ \-N
-.IR partno ]
+[options]
+.I device
+.RB [ \-N
+.IR partition-number ]
 .sp
 .B sfdisk
-.RB [ options ]
-.RI command
+[options]
+.I command
 .SH DESCRIPTION
 .B sfdisk
 is a script oriented tool for partitioning any block device.
@@ -48,10 +48,10 @@ partitions.
 .SH COMMANDS
 The commands are mutually exclusive.
 .TP
-.BR [\-N " \fIpartno\fR"] " " \fIdevice\fR
-The default sfdisk command is to read the specification for the desired 
+.RB [ \-N " \fIpartition-number\fR] " \fIdevice\fR
+The default sfdisk command is to read the specification for the desired
 partitioning of \fIdevice\fR from standard input, and then create a partition
-table according to the specification. See below description of the input
+table according to the specification. See below for the description of the input
 format. If the standard input is a terminal then sfdisk starts interactive session.
 
 If the option \fB\-N\fR specified then the changes are applied to the partition
diff --git a/login-utils/last.1 b/login-utils/last.1
index edaddd1..23ebaf3 100644
--- a/login-utils/last.1
+++ b/login-utils/last.1
@@ -19,14 +19,12 @@
 last, lastb \- show a listing of last logged in users
 .SH SYNOPSIS
 .B last
-.RI [ options ]
-.RI [ username ...]
-.RI [ tty ...]
+[options]
+.RI [ username "...] [" tty ...]
 .br
 .B lastb
-.RI [ options ]
-.RI [ username ...]
-.RI [ tty ...]
+[options]
+.RI [ username "...] [" tty ...]
 .SH DESCRIPTION
 .B last
 searches back through the
diff --git a/login-utils/lslogins.1 b/login-utils/lslogins.1
index 0dbeebd..fb45b79 100644
--- a/login-utils/lslogins.1
+++ b/login-utils/lslogins.1
@@ -5,7 +5,10 @@
 lslogins \- display information about known users in the system
 .SH SYNOPSIS
 .B lslogins
-[\fIoptions\fR] [\fB-s\fR|\fB-u\fR[=\fIUID\fR]] [\fB-g \fIgroups\fR] [\fB-l \fIlogins\fR]
+[options]
+.RB [ \-s | \-u [ =\fIUID ]]
+.RB [ \-g " \fIgroups\fR]"
+.RB [ \-l " \fIlogins\fR]"
 .SH DESCRIPTION
 .PP
 Examine the wtmp and btmp logs, /etc/shadow (if necessary) and /etc/passwd
diff --git a/misc-utils/cal.1 b/misc-utils/cal.1
index 3209516..92141ae 100644
--- a/misc-utils/cal.1
+++ b/misc-utils/cal.1
@@ -39,7 +39,8 @@
 cal \- display a calendar
 .SH SYNOPSIS
 .B cal
-[\fIoptions\fR] [[[\fIday\fR] \fImonth\fR] \fIyear\fR]
+[options]
+.RI [[[ day ] " month" ] " year" ]
 .SH DESCRIPTION
 .B cal
 displays a simple calendar.  If no arguments are specified, the current
diff --git a/misc-utils/findmnt.8 b/misc-utils/findmnt.8
index 27121d8..901b512 100644
--- a/misc-utils/findmnt.8
+++ b/misc-utils/findmnt.8
@@ -4,17 +4,17 @@
 findmnt \- find a filesystem
 .SH SYNOPSIS
 .B findmnt
-.RB [ options ]
+[options]
 .sp
 .B findmnt
-.RB [ options ]
+[options]
 .IR device | mountpoint
 .sp
 .B findmnt
-.RB [ options ]
-.RB [ \--source ]
+[options]
+.RB [ \-\-source ]
 .IR device
-.RB [ \--target ]
+.RB [ \-\-target ]
 .IR mountpoint
 .SH DESCRIPTION
 .B findmnt
diff --git a/misc-utils/getopt.1 b/misc-utils/getopt.1
index 6758d27..da7207f 100644
--- a/misc-utils/getopt.1
+++ b/misc-utils/getopt.1
@@ -6,15 +6,15 @@ getopt \- parse command options (enhanced)
 .I optstring parameters
 .br
 .B getopt
-.RI [ options ]
+[options]
 .RB [ \-\- ]
 .I optstring parameters
 .br
 .B getopt
-.RI [ options ]
+[options]
 .BR \-o | \-\-options
 .I optstring
-.RI [ options ]
+[options]
 .RB [ \-\- ]
 .I parameters
 .SH DESCRIPTION
diff --git a/misc-utils/logger.1 b/misc-utils/logger.1
index 3bfcb3d..2a3b47c 100644
--- a/misc-utils/logger.1
+++ b/misc-utils/logger.1
@@ -38,7 +38,8 @@
 logger \- a shell command interface to the syslog(3) system log module
 .SH SYNOPSIS
 .B logger
-.RI [ options "] [" message ]
+[options]
+.RI [ message ]
 .SH DESCRIPTION
 .B logger
 makes entries in the system log.  It provides a shell command
diff --git a/misc-utils/look.1 b/misc-utils/look.1
index d1d8f1b..21edb66 100644
--- a/misc-utils/look.1
+++ b/misc-utils/look.1
@@ -36,9 +36,10 @@
 look \- display lines beginning with a given string
 .SH SYNOPSIS
 .B look
-.RI [ options ] " string " [ file ]
+[options]
+.IR "string " [ file ]
 .SH DESCRIPTION
-The 
+The
 .B look
 utility displays any lines in
 .I file
diff --git a/misc-utils/lsblk.8 b/misc-utils/lsblk.8
index 8c9740c..7c19dd8 100644
--- a/misc-utils/lsblk.8
+++ b/misc-utils/lsblk.8
@@ -4,7 +4,7 @@
 lsblk \- list block devices
 .SH SYNOPSIS
 .B lsblk
-.RB [ options ]
+[options]
 .RI [ device ...]
 .SH DESCRIPTION
 .B lsblk
diff --git a/misc-utils/lslocks.8 b/misc-utils/lslocks.8
index 20ff0dc..70a5638 100644
--- a/misc-utils/lslocks.8
+++ b/misc-utils/lslocks.8
@@ -7,7 +7,8 @@
 .SH NAME
 lslocks \- list local system locks
 .SH SYNOPSIS
-.BR lslocks " [" options ]
+.B lslocks
+[options]
 
 .SH DESCRIPTION
 .B lslocks
diff --git a/misc-utils/mcookie.1 b/misc-utils/mcookie.1
index 989b7f9..6587c57 100644
--- a/misc-utils/mcookie.1
+++ b/misc-utils/mcookie.1
@@ -5,7 +5,7 @@
 mcookie \- generate magic cookies for xauth
 .SH SYNOPSIS
 .B mcookie
-[\fIoptions\fR]
+[options]
 .SH DESCRIPTION
 .B mcookie
 generates a 128-bit random hexadecimal number for use with the X authority
diff --git a/misc-utils/namei.1 b/misc-utils/namei.1
index 550dc97..610d97c 100644
--- a/misc-utils/namei.1
+++ b/misc-utils/namei.1
@@ -6,8 +6,8 @@
 namei \- follow a pathname until a terminal point is found
 .SH SYNOPSIS
 .B namei
-.RI [ options ]
-.IR  pathname ...
+[options]
+.IR pathname ...
 .SH DESCRIPTION
 .B namei
 uses its arguments as pathnames to any type
diff --git a/misc-utils/rename.1 b/misc-utils/rename.1
index 30d9c71..c166c51 100644
--- a/misc-utils/rename.1
+++ b/misc-utils/rename.1
@@ -6,7 +6,8 @@
 rename \- rename files
 .SH SYNOPSIS
 .B rename
-.RI [ options ] " expression replacement file" ...
+[options]
+.IR "expression replacement file" ...
 .SH DESCRIPTION
 .B rename
 will rename the specified files by replacing the first occurrence of
diff --git a/misc-utils/uuidgen.1 b/misc-utils/uuidgen.1
index 4d64a10..4c39d1c 100644
--- a/misc-utils/uuidgen.1
+++ b/misc-utils/uuidgen.1
@@ -10,7 +10,7 @@
 uuidgen \- create a new UUID value
 .SH SYNOPSIS
 .B uuidgen
-[\fIoptions\fR]
+[options]
 .SH DESCRIPTION
 The
 .B uuidgen
diff --git a/misc-utils/whereis.1 b/misc-utils/whereis.1
index 243fc14..652f69b 100644
--- a/misc-utils/whereis.1
+++ b/misc-utils/whereis.1
@@ -35,7 +35,7 @@
 whereis \- locate the binary, source, and manual page files for a command
 .SH SYNOPSIS
 .B whereis
-.RB [ options ]
+[options]
 .RB [ \-BMS
 .IR directory "... " \fB\-f\fR ]
 .IR name ...
diff --git a/sys-utils/readprofile.8 b/sys-utils/readprofile.8
index 8ad9dc9..c01e3ca 100644
--- a/sys-utils/readprofile.8
+++ b/sys-utils/readprofile.8
@@ -3,7 +3,7 @@
 readprofile \- read kernel profiling information
 .SH SYNOPSIS
 .B readprofile
-.RI [ options ]
+[options]
 .SH VERSION
 This manpage documents version 2.0 of the program.
 .SH DESCRIPTION
diff --git a/term-utils/agetty.8 b/term-utils/agetty.8
index 12e481f..10f3395 100644
--- a/term-utils/agetty.8
+++ b/term-utils/agetty.8
@@ -4,10 +4,8 @@ agetty \- alternative Linux getty
 
 .SH SYNOPSIS
 .B agetty
-.RB [ options ]
-.I port
-.RI [ baud_rate ...]
-.RI [ term ]
+[options]
+.IR port " [" baud_rate "...] [" term ]
 
 .SH DESCRIPTION
 .ad
-- 
1.7.0.4

[PATCH 5/8] docs: adjust the grammar, text, sorting and formatting of logger man page

[Benno Schulenberg]

The message argument is not an option and should not be listed among
those.  Describe the optional argument of --rfc5424 better.  Use the
= and no space for optional option arguments.  Don't italicize words
unnecessarily.  Use bold for literal things.  And sort the options
alphabetically (apart from -V and -h).

Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
---
 misc-utils/logger.1 |  258 +++++++++++++++++++++++----------------------------
 1 files changed, 116 insertions(+), 142 deletions(-)

diff --git a/misc-utils/logger.1 b/misc-utils/logger.1
index 2a3b47c..197bb38 100644
--- a/misc-utils/logger.1
+++ b/misc-utils/logger.1
@@ -33,171 +33,145 @@
 .\"
 .\" Section on valid facility and level strings added by
 .\" and1000@debian.org, 26 Oct 1997.
-.TH LOGGER "1" "June 2014" "util-linux" "User Commands"
+.\"
+.TH LOGGER "1" "December 2014" "util-linux" "User Commands"
 .SH NAME
-logger \- a shell command interface to the syslog(3) system log module
+logger \- enter messages into the system log
 .SH SYNOPSIS
 .B logger
 [options]
 .RI [ message ]
 .SH DESCRIPTION
 .B logger
-makes entries in the system log.  It provides a shell command
+makes entries in the system log.  It provides a shell-command
 interface to the
 .BR syslog (3)
 system log module.
+.sp
+When the optional \fImessage\fR argument is present, it is written
+to the log.  If it is not present, and the \fB\-f\fR option is not
+given either, then standard input is logged.
 .SH OPTIONS
 .TP
-\fB\-d\fR, \fB\-\-udp\fR
-Use datagram (UDP) only.  By default the connection is tried to the
-.I syslog
-port defined in /etc/services, which is often
-.IR 514 .
+.BR \-d , " \-\-udp"
+Use datagrams (UDP) only.  By default the connection is tried to the
+syslog port defined in /etc/services, which is often 514 .
 .TP
-\fB\-h\fR, \fB\-\-help\fR
-Display help text and exit.
+.BR \-f , " \-\-file " \fIfile
+Log the contents of the specified \fIfile\fR.
+This option cannot be combined with a command-line message.
 .TP
-\fB\-i\fR, \fB\-\-id\fR[=\fBid\fR]
-Log the PID of the logger process with each line.  When optional
-argument
-.B id
-is specified then it is used instead of logger command PID.  Use of
-.B --id=$$
+.BR \-i , " \-\-id" [ = \fIid ]
+Log the PID of the logger process with each line.  When the optional
+argument \fIid\fR is specified, then it is used instead of the logger
+command's PID.  The use of \fB\-\-id=$$\fR
 (PPID) is recommended in scripts that send several messages.
 .TP
-\fB\-n\fR, \fB\-\-server\fR \fIserver\fR
-Write to the specified remote syslog
-.I server
+.BR \-\-journald [ =\fIfile ]
+Write a systemd journal entry.  The entry is read from the given \fIfile\fR,
+when specified, otherwise from standard input.
+Each line must begin with a field that is accepted by journald; see
+.BR systemd.journal-fields (7)
+for details.  The use of a MESSAGE_ID field is generally a good idea, as it
+makes finding entries easy.  Examples:
+.IP
+.nf
+\fB    printf \(dq%s\\n%s\\n%s\\n\(dq MESSAGE_ID=42 DOGS=bark \(dqCARAVAN=goes on\(dq | logger --journald
+\fB    logger --journald=entry.txt
+.fi
+.IP
+Notice that
+.B \-\-journald
+will ignore values of other options, such as priority.  If priority is
+needed it must be within input, and use PRIORITY field.  The simple
+execution of
+.B journalctl
+will display MESSAGE field.  Use
+.B journalctl --output json-pretty
+to see rest of the fields.
+
+.TP
+.BR \-n , " \-\-server " \fIserver
+Write to the specified remote syslog \fIserver\fR
 instead of to the builtin syslog routines.  Unless
-.B \-\-udp
-or
-.B \-\-tcp
+\fB\-\-udp\fR or \fB\-\-tcp\fR
 is specified, \fBlogger\fR will first try to use UDP,
 but if thist fails a TCP connection is attempted.
 .TP
-\fB\-P\fR, \fB\-\-port\fR \fIport\fR
-Use the specified
-.IR port .
-When
-.I port
-is not specified it defaults to
-.I syslog
-for udp and
-.I syslog-conn
-for tcp connections.
-.TP
-\fB\-f\fR, \fB\-\-file\fR \fIfile\fR
-Log the contents of the specified
-.IR file .
-This option cannot be combined with a command-line message.
+.BR \-P , " \-\-port " \fIport
+Use the specified \fIport\fR.  When this option is not specified, the
+port defaults to syslog for udp and to syslog-conn for tcp connections.
 .TP
-\fB\-p\fR, \fB\-\-priority\fR \fIpriority\fR
-Enter the message into the log with the specified
-.IR priority  .
+.BR \-p , " \-\-priority " \fIpriority
+Enter the message into the log with the specified \fIpriority\fR.
 The priority may be specified numerically or as a
-.I facility.level
+.IR facility . level
 pair.
-For example,
-.B -p
-.I local3.info
+For example, \fB\-p local3.info\fR
 logs the message as informational in the local3 facility.
-The default is
-.IR user.notice .
+The default is \fBuser.notice\fR.
 .TP
-\fB\-\-prio\-prefix\fR
+.B \-\-prio-prefix
 Look for a syslog prefix on every line read from standard input.
-This prefix is a number within angle brackets that contains both the facility
-and the level.  This decimal prefix is constructed by multiplying the
-facility by 8 and then adding the level.  Thus, for example, \fIlocal0.info\fR,
-facility=16 and level=6, becomes \fI<134>\fR.
-
+This prefix is a decimal number within angle brackets that encodes both
+the facility and the level.  The number is constructed by multiplying the
+facility by 8 and then adding the level.  For example, \fBlocal0.info\fR,
+meaning facility=16 and level=6, becomes \fB<134>\fR.
+.sp
 If the prefix contains no facility, the facility defaults to what is
 specified by the \fB\-p\fR option.  Similarly, if no prefix is provided,
-the line is logged using the \fB\-p\fR \fIpriority\fR.
-
+the line is logged using the \fIpriority\fR given with \fB\-p\fR.
+.sp
 This option doesn't affect a command-line message.
-
-.TP
-\fB\-\-rfc3164\fR
-Use RFC 3164 BSD syslog protocol to submit messages to remote server.
 .TP
-\fB\-\-rfc5424\fR [\fInotime\fR,\fInotq\fR,\fInohost\fR]
-Use RFC 5424 syslog protocol to submit messages to remote server.
-Optional argument
-.I notime
-will suppress submission of sender time stamp that is in ISO-8601 format,
-including microseconds and timezone.  When
-.I notime
-is specified the time quality structured data, that can be suppressed
-separately with
-.IR notq ,
-is excluded from output.  The time quality information tells if local
-clock was syncronized, and maximum number of microseconds the time stamp
-could be off.  Option argument
-.I nohost
-will suppress
-.IR gethostname (2)
-information from message header.
+.B \-\-rfc3164
+Use the RFC 3164 BSD syslog protocol to submit messages to a remote server.
+.TP
+.BR \-\-rfc5424 [ =\fIwithout ]
+Use the RFC 5424 syslog protocol to submit messages to a remote server.
+The optional \fIwithout\fR argument can be a comma-separated list of
+the following values: \fBnotq\fR, \fBnotime\fR, \fBnohost\fR.
+The \fBnotq\fR value suppresses the time-quality structured data
+from the submitted message.  (The time-quality information shows whether
+the local clock was syncronized plus the maximum number of microseconds
+the timestamp might be off.)  The \fBnotime\fR value (which implies
+\fBnotq\fR) suppresses the complete sender timestamp that is in
+ISO-8601 format, including microseconds and timezone.
+The \fBnohost\fR value suppresses
+.BR gethostname (2)
+information from the message header.
 .IP
 The rfc5424 protocol has been default for
 .B logger
 since version 2.26.
 .TP
-\fB\-s\fR, \fB\-\-stderr\fR
+.BR \-s , " \-\-stderr"
 Output the message to standard error as well as to the system log.
 .TP
-\fB\-T\fR, \fB\-\-tcp\fR
+.BR \-T , " \-\-tcp"
 Use stream (TCP) only.  By default the connection is tried to the
 .I syslog-conn
 port defined in /etc/services, which is often
 .IR 601 .
 .TP
-\fB\-t\fR, \fB\-\-tag\fR \fItag\fR
+.BR \-t , " \-\-tag " \fItag
 Mark every line to be logged with the specified
 .IR tag .
 .TP
-\fB\-u\fR, \fB\-\-socket\fR \fIsocket\fR
+.BR \-u , " \-\-socket " \fIsocket
 Write to the specified
 .I socket
 instead of to the builtin syslog routines.
 .TP
-\fB\-\-journald\fR [\fIfile\fR]
-Write systemd journal entry.  The entry is read from
-.I stdin
-or input
-.IR file .
-Each new line must begin with a field that is accepted by journald, see
-.IR systemd.journal-fields (7)
-for details.  Use of MESSAGE_ID field is generally good idea, as they
-make finding entries easy.
-.IP
-.nf
-$ printf "%s\\n%s\\n%s\\n" MESSAGE_ID=86184c3b1aa444f58ebe7b30fec1438b DOGS=bark "CARAVAN=goes on" | logger --journald
-$ logger --journald=entry.txt
-.fi
-.IP
-Notice that
-.B \-\-journald
-will ignore values of other options, such as priority.  If priority is
-needed it must be within input, and use PRIORITY field.  The simple
-execution of
-.B journalctl
-will display MESSAGE field.  Use
-.B journalctl --output json-pretty
-to see rest of the fields.
+.B \-\-
+End the argument list.  This allows the \fImessage\fR
+to start with a hyphen (\-).
 .TP
-\fB\-V\fR, \fB\-\-version\fR
+.BR \-V , " \-\-version"
 Display version information and exit.
 .TP
-\fB\-\-\fR
-End the argument list.  This is to allow the
-.I message
-to start with a hyphen (\-).
-.TP
-.I message
-Write this \fImessage\fR to the log; if not specified, and the
-.B \-f
-flag is not provided, standard input is logged.
+.BR \-h , " \-\-help"
+Display help text and exit.
 .SH RETURN VALUE
 The
 .B logger
@@ -208,22 +182,22 @@ Valid facility names are:
 .TS
 tab(:);
 left l l.
-\fIauth\fR
-\fIauthpriv\fR:for security information of a sensitive nature
-\fIcron\fR
-\fIdaemon\fR
-\fIftp\fR
-\fIkern\fR:cannot be generated from user process
-\fIlpr\fR
-\fImail\fR
-\fInews\fR
-\fIsyslog\fR
-\fIuser\fR
-\fIuucp\fR
-\fIlocal0\fR
+\fBauth
+\fBauthpriv\fR:for security information of a sensitive nature
+\fBcron
+\fBdaemon
+\fBftp
+\fBkern\fR:cannot be generated from user process
+\fBlpr
+\fBmail
+\fBnews
+\fBsyslog
+\fBuser
+\fBuucp
+\fBlocal0
   to:
-\fIlocal7\fR
-\fIsecurity\fR:deprecated synonym for \fIauth\fR
+\fBlocal7
+\fBsecurity\fR:deprecated synonym for \fBauth
 .TE
 .PP
 Valid level names are:
@@ -231,27 +205,27 @@ Valid level names are:
 .TS
 tab(:);
 left l l.
-\fIemerg\fR
-\fIalert\fR
-\fIcrit\fR
-\fIerr\fR
-\fIwarning\fR
-\fInotice\fR
-\fIinfo\fR
-\fIdebug\fR
-\fIpanic\fR:deprecated synonym for \fIemerg\fR
-\fIerror\fR:deprecated synonym for \fIerr\fR
-\fIwarn\fR:deprecated synonym for \fIwarning\fR
+\fBemerg
+\fBalert
+\fBcrit
+\fBerr
+\fBwarning
+\fBnotice
+\fBinfo
+\fBdebug
+\fBpanic\fR:deprecated synonym for \fBemerg
+\fBerror\fR:deprecated synonym for \fBerr
+\fBwarn\fR:deprecated synonym for \fBwarning
 .TE
 .PP
 For the priority order and intended purposes of these facilities and levels, see
 .BR syslog (3).
 .SH EXAMPLES
-logger System rebooted
+.B logger System rebooted
 .br
-logger \-p local0.notice \-t HOSTIDM \-f /dev/idmc
+.B logger \-p local0.notice \-t HOSTIDM \-f /dev/idmc
 .br
-logger \-n loghost.example.com System rebooted
+.B logger \-n loghost.example.com System rebooted
 .SH SEE ALSO
 .BR syslog (3),
 .BR syslogd (8),
-- 
1.7.0.4

Re: [PATCH 5/8] docs: adjust the grammar, text, sorting and formatting of logger man page

[Benno Schulenberg]

Hi Sami,

Could you please verify that the rewritten description of --rfc5424 is correct?
I had some doubts about what the original text tried to say.  :)

> +.TP
> +.BR \-\-rfc5424 [ =\fIwithout ]
> +Use the RFC 5424 syslog protocol to submit messages to a remote server.
> +The optional \fIwithout\fR argument can be a comma-separated list of
> +the following values: \fBnotq\fR, \fBnotime\fR, \fBnohost\fR.
> +The \fBnotq\fR value suppresses the time-quality structured data
> +from the submitted message.  (The time-quality information shows whether
> +the local clock was syncronized plus the maximum number of microseconds
> +the timestamp might be off.)  The \fBnotime\fR value (which implies
> +\fBnotq\fR) suppresses the complete sender timestamp that is in
> +ISO-8601 format, including microseconds and timezone.
> +The \fBnohost\fR value suppresses
> +.BR gethostname (2)
> +information from the message header.

Regards,

Benno

-- 
http://www.fastmail.com - Send your email first class

Re: [PATCH 5/8] docs: adjust the grammar, text, sorting and formatting of logger man page

[Sami Kerola]

On 14 December 2014 at 19:50, Benno Schulenberg <bensberg@justemail.net> wrote:
> Could you please verify that the rewritten description of --rfc5424 is correct?
> I had some doubts about what the original text tried to say.  :)
>
>> +.TP
>> +.BR \-\-rfc5424 [ =\fIwithout ]
>> +Use the RFC 5424 syslog protocol to submit messages to a remote server.
>> +The optional \fIwithout\fR argument can be a comma-separated list of
>> +the following values: \fBnotq\fR, \fBnotime\fR, \fBnohost\fR.
>> +The \fBnotq\fR value suppresses the time-quality structured data
>> +from the submitted message.  (The time-quality information shows whether
>> +the local clock was syncronized plus the maximum number of microseconds
>> +the timestamp might be off.)  The \fBnotime\fR value (which implies
>> +\fBnotq\fR) suppresses the complete sender timestamp that is in
>> +ISO-8601 format, including microseconds and timezone.
>> +The \fBnohost\fR value suppresses
>> +.BR gethostname (2)
>> +information from the message header.

Hi Benno,

Yes I did try to tell about that, but in usual in-understandable way ,-)

I'm not sure if the logger(1) manual should emphasis more that the
hostname is the same as printout of hostname(1) command, rather than
DNS name of the server sending the name. Configurations where they are
not in sync may cause some head scratching & swearing for system
admins (especially if hostname(1) output matches with unrelated DNS
name).

-- 
Sami Kerola
http://www.iki.fi/kerolasa/

[PATCH 6/8] docs: adjust some formatting and wordings in a handful of man pages

[Benno Schulenberg]

Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
---
 disk-utils/partx.8   |  129 +++++++++++++++++++++++++++-----------------------
 misc-utils/look.1    |   14 +++--
 misc-utils/lslocks.8 |   33 +++++-------
 misc-utils/mcookie.1 |   36 +++++++-------
 misc-utils/namei.1   |   36 +++++++++-----
 misc-utils/rename.1  |   14 +++---
 6 files changed, 137 insertions(+), 125 deletions(-)

diff --git a/disk-utils/partx.8 b/disk-utils/partx.8
index 005fe66..fb0fe38 100644
--- a/disk-utils/partx.8
+++ b/disk-utils/partx.8
@@ -3,7 +3,8 @@
 .\" Copyright 2007 Red Hat, Inc.
 .\" Copyright 2010 Davidlohr Bueso <dave@gnu.org>
 .\" May be distributed under the GNU General Public License
-.TH PARTX "8" "June 2012" "util-linux" "System Administration"
+.\"
+.TH PARTX "8" "December 2014" "util-linux" "System Administration"
 .SH NAME
 partx \- tell the Linux kernel about the presence and numbering of on-disk partitions
 .SH SYNOPSIS
@@ -43,24 +44,49 @@ The
 tells the kernel about the presence and numbering of on-disk
 partitions.
 .SH OPTIONS
-.IP "\fB\-a\fR, \fB\-\-add\fP"
+.TP
+.BR \-a , " \-\-add"
 Add the specified partitions, or read the disk and add all partitions.
-.IP "\fB\-b\fR, \fB\-\-bytes\fP"
+.TP
+.BR \-b , " \-\-bytes"
 Print the SIZE column in bytes rather than in human-readable format.
-.IP "\fB\-d\fR, \fB\-\-delete\fP"
+.TP
+.BR \-d , " \-\-delete"
 Delete the specified partitions or all partitions.
-.IP "\fB\-u\fR, \fB\-\-update\fP"
-Update the specified partitions.
-.IP "\fB\-g\fR, \fB\-\-noheadings\fP"
+.TP
+.BR \-g , " \-\-noheadings"
 Do not print a header line.
-.IP "\fB\-h\fR, \fB\-\-help\fP"
-Display help text and exit.
-.IP "\fB\-l\fR, \fB\-\-list\fP"
+.TP
+.BR \-l , " \-\-list"
 List the partitions.  Note that all numbers are in 512-byte sectors.
 This output format is DEPRECATED in favour of
 .BR \-\-show .
 Do not use it in newly written scripts.
-.IP "\fB\-o\fR, \fB\-\-output \fIlist\fP"
+.TP
+.BR \-n , " \-\-nr " \fIM : \fIN
+Specify the range of partitions.  For backward compatibility also the
+format \fIM\fB\-\fIN\fR is supported.
+The range may contain negative numbers, for example
+.B \-\-nr :\-1
+means the last partition, and
+.B \-\-nr \-2:\-1
+means the last two partitions.  Supported range specifications are:
+.RS 14
+.TP
+.I M
+Specifies just one partition (e.g.\& \fB\-\-nr 3\fR).
+.TP
+.IB M :
+Specifies the lower limit only (e.g.\& \fB\-\-nr 2:\fR).
+.TP
+.BI : N
+Specifies the upper limit only (e.g.\& \fB\-\-nr :4\fR).
+.TP
+.IB M : N
+Specifies the lower and upper limits (e.g.\& \fB\-\-nr 2:4\fR).
+.RE
+.TP
+.BR \-o , " \-\-output " \fIlist
 Define the output columns to use for
 .B \-\-show
 and
@@ -70,66 +96,49 @@ used.  Use
 .B \-\-help
 to get
 .I list
-of all supported columns.  This option cannot be combined with
+of all supported columns.  This option cannot be combined with the
 .BR \-\-add ,
 .BR \-\-delete ,
 or
 .B \-\-list
 options.
-.IP "\fB\-P\fR, \fB\-\-pairs\fP"
-Output using key="value" format.
-.IP "\fB\-n\fR, \fB\-\-nr \fIM:N\fP"
-Specify the range of partitions.  For backward compatibility also the
-format
-.I M\(enN
-is supported.  The range may contain negative numbers, for example
-.BI \-\-nr \ :\-1
-means the last partition, and
-.BI \-\-nr \ \-2:\-1
-means the last two partitions.  Supported range specifications are:
-.RS 14
 .TP
-.I M
-Specifies just one partition (e.g.\& \fB\-\-nr\fR
-.IR 3 ).
+.BR \-P , " \-\-pairs"
+Output using key="value" format.
 .TP
-.I M:
-Specifies lower limit only (e.g.\& \fB\-\-nr\fR
-.IR 2: ).
+.BR \-r , " \-\-raw"
+Use the raw output format.
 .TP
-.I :N
-Specifies upper limit only (e.g.\& \fB\-\-nr\fR
-.IR :4 ).
+.BR \-s , "\-\-show"
+List the partitions.  All numbers (except SIZE) are in 512-byte sectors.
+The output columns can be rearranged with the \fB\-\-output\fR option.
 .TP
-.IR M:N \ or
-.TQ
-.I M\(enN
-Specifies lower and upper limits (e.g.\& \fB\-\-nr\fR
-.IR 2:4 ).
-.RE
-.IP "\fB\-r\fR, \fB\-\-raw\fP"
-Use the raw output format.
-.IP "\fB\-s\fR, \fB\-\-show\fP"
-List the partitions.  All numbers (except SIZE) are in 512-byte
-sectors.  The output columns can be rearranged with the
-.B \-\-output
-option.
-.IP "\fB\-t\fR, \fB\-\-type \fItype\fP"
-Specify the partition table type
-.IR aix ,
-.IR bsd ,
-.IR dos ,
-.IR gpt ,
-.IR mac ,
-.IR minix ,
-.IR sgi ,
-.IR solaris_x86 ,
-.IR sun ,
-.IR ultrix ,
+.BR \-t , " \-\-type " \fItype
+Specify the partition table type, which can be one of
+.BR aix ,
+.BR bsd ,
+.BR dos ,
+.BR gpt ,
+.BR mac ,
+.BR minix ,
+.BR sgi ,
+.BR solaris_x86 ,
+.BR sun ,
+.BR ultrix ,
 or
-.IR unixware .
-.IP "\fB\-v\fR, \fB\-\-verbose\fP"
+.BR unixware .
+.TP
+.BR \-u , " \-\-update"
+Update the specified partitions.
+.TP
+.BR \-v , " \-\-verbose"
 Verbose mode.
+.TP
+.BR \-V , " \-\-version"
+Display version information and exit.
+.TP
+.BR \-h , " \-\-help"
+Display help text and exit.
 .SH EXAMPLES
 .TP
 partx \-\-show /dev/sdb3
diff --git a/misc-utils/look.1 b/misc-utils/look.1
index 21edb66..d54751c 100644
--- a/misc-utils/look.1
+++ b/misc-utils/look.1
@@ -49,7 +49,9 @@ As
 .B look
 performs a binary search, the lines in
 .I file
-must be sorted (where sort(1) got the same options
+must be sorted (where
+.BR sort (1)
+was given the same options
 .BR "\-d " and/or " \-f " that
 .B look
 is invoked with).
@@ -78,11 +80,11 @@ Specify a string termination character, i.e. only the characters
 in \fIstring\fR up to and including the first occurrence of \fIcharacter\fR
 are compared.
 .TP
-.BR \-h , " \-\-help"
-Display help text and exit.
-.TP
 .BR \-V , " \-\-version"
 Display version information and exit.
+.TP
+.BR \-h , " \-\-help"
+Display help text and exit.
 .PP
 The
 .B look
@@ -106,8 +108,8 @@ the alternative dictionary
 .BR sort (1)
 .SH COMPATIBILITY
 The original manual page stated that tabs and blank characters participated
-in comparisons when the alphanum option was specified.  This was incorrect,
-and the current man page matches the historic implementation.
+in comparisons when the \fB\-\-alphanum\fR option was specified.  This was
+incorrect, and the current man page matches the historic implementation.
 .SH HISTORY
 The
 .B look
diff --git a/misc-utils/lslocks.8 b/misc-utils/lslocks.8
index 70a5638..83c7585 100644
--- a/misc-utils/lslocks.8
+++ b/misc-utils/lslocks.8
@@ -3,7 +3,7 @@
 .\" Copyright 2012 Davidlohr Bueso <dave@gnu.org>
 .\" May be distributed under the GNU General Public License
 
-.TH LSLOCKS 8 "February 2012" "util-linux" "System Administration"
+.TH LSLOCKS 8 "December 2014" "util-linux" "System Administration"
 .SH NAME
 lslocks \- list local system locks
 .SH SYNOPSIS
@@ -16,9 +16,6 @@ lists information about all the currently held file locks in a Linux system.
 
 .SH OPTIONS
 .TP
-.BR \-h , " \-\-help"
-Display help text and exit.
-.TP
 .BR \-n , " \-\-noheadings"
 Do not print a header line.
 .TP
@@ -38,47 +35,45 @@ Use the raw output format.
 .TP
 .BR \-u , " \-\-notruncate"
 Do not truncate text in columns.
+.TP
+.BR \-V , " \-\-version"
+Display version information and exit.
+.TP
+.BR \-h , " \-\-help"
+Display help text and exit.
 
 .SH OUTPUT
 .IP "COMMAND"
 The command name of the process holding the lock.
-
 .IP "PID"
 The process ID of the process which holds the lock.
-
 .IP "TYPE"
-The type of lock; can be FLOCK (created with flock(2)) or POSIX (created with fcntl(2) and lockf(3)).
-
+The type of lock; can be FLOCK (created with \fBflock\fR(2)) or POSIX
+(created with \fBfcntl\fR(2) and \fBlockf\fR(3)).
 .IP "SIZE"
 Size of the locked file.
-
 .IP "MODE"
 The lock's access permissions (read, write).  If the process is blocked and waiting for the lock,
 then the mode is postfixed with an '*' (asterisk).
-
 .IP "M"
 Whether the lock is mandatory; 0 means no (meaning the lock is only advisory), 1 means yes.
-(See fcntl(2)).
-
+(See \fBfcntl\fR(2).)
 .IP "START"
 Relative byte offset of the lock.
-
 .IP "END"
 Ending offset of the lock.
-
 .IP "PATH"
 Full path of the lock.  If none is found, or there are no permissions to read the path,
 it will fall back to the device's mountpoint.  The path might be truncated; use
-.B "--notruncate"
-to get the full path.
-
+\fB\-\-notruncate\fR to get the full path.
 .IP "BLOCKER"
 The PID of the process which blocks the lock.
 
 .SH NOTES
 .nf
-The lslocks command is meant to replace the lslk(8) command, originally written by
-Victor A. Abell <abe@purdue.edu> and unmaintained since 2001.
+The \fBlslocks\fR command is meant to replace the \fBlslk\fR(8) command,
+originally written by Victor A. Abell <abe@purdue.edu> and unmaintained
+since 2001.
 .fi
 
 .SH AUTHORS
diff --git a/misc-utils/mcookie.1 b/misc-utils/mcookie.1
index 6587c57..5863821 100644
--- a/misc-utils/mcookie.1
+++ b/misc-utils/mcookie.1
@@ -1,6 +1,6 @@
 .\" mcookie.1 --
 .\" Public Domain 1995 Rickard E. Faith (faith@cs.unc.edu)
-.TH MCOOKIE 1 "March 2014" "util-linux" "User Commands"
+.TH MCOOKIE 1 "December 2014" "util-linux" "User Commands"
 .SH NAME
 mcookie \- generate magic cookies for xauth
 .SH SYNOPSIS
@@ -10,30 +10,28 @@ mcookie \- generate magic cookies for xauth
 .B mcookie
 generates a 128-bit random hexadecimal number for use with the X authority
 system.  Typical usage:
+.sp
 .RS
-xauth add :0 . `mcookie`
+.B xauth add :0 . `mcookie`
 .RE
 .PP
-The "random" number generated is actually the output of the MD5 message
-digest fed with random information from one of the sources
+The "random" number generated is actually the MD5 message
+digest of random information coming from one of the sources
 .IR /dev/urandom ,
 .IR /dev/random ,
-or
-.I "libc pseudo-random functions"
+or the
+.IR "libc pseudo-random functions" ,
 in this preference order.
 .SH OPTIONS
 .TP
-\fB\-f\fR, \fB\-\-file\fR=\fIFILE\fR
-Use additional file as a macig cookie random seed.  When file is defined
-as '-' character input is read from stdin.
+.BR \-f , " \-\-file " \fIfile
+Use this \fIfile\fR as an additional source of randomness.
+When \fIfile\fR is '-', characters are read from standard input.
 .TP
-\fB\-m\fR, \fB\-\-max\-size\fR=\fInumber\fR
-Read form
-.I FILE
-only
-.I number
-of bytes.  This option is meant to be used when reading additional
-randomness from a device.
+.BR \-m , " \-\-max\-size " \fInumber
+Read from \fIfile\fR only this \fInumber\fR of bytes.
+This option is meant to be used when reading additional
+randomness from a file or device.
 .IP
 The
 .I number
@@ -42,14 +40,14 @@ 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") or the suffixes
 KB=1000, MB=1000*1000, and so on for GB, TB, PB, EB, ZB and YB.
 .TP
-\fB\-v\fR, \fB\-\-verbose\fR
+.BR \-v , " \-\-verbose"
 Inform where randomness originated, with amount of entropy read from each
 source.
 .TP
-\fB\-V\fR, \fB\-\-version\fR
+.BR \-V , " \-\-version"
 Display version information and exit.
 .TP
-\fB\-h\fR, \fB\-\-help\fR
+.BR \-h , " \-\-help"
 Display help text and exit.
 .SH BUGS
 It is assumed that none of the randomness sources will block.
diff --git a/misc-utils/namei.1 b/misc-utils/namei.1
index 610d97c..c19ac46 100644
--- a/misc-utils/namei.1
+++ b/misc-utils/namei.1
@@ -10,7 +10,7 @@ namei \- follow a pathname until a terminal point is found
 .IR pathname ...
 .SH DESCRIPTION
 .B namei
-uses its arguments as pathnames to any type
+interprets its arguments as pathnames to any type
 of Unix file (symlinks, files, directories, and so forth).
 .B namei
 then follows each pathname until an endpoint
@@ -41,29 +41,37 @@ uses the following characters to identify the file type found:
 prints an informative message when
 the maximum number of symbolic links this system can have has been exceeded.
 .SH OPTIONS
-.IP "\fB\-l, \-\-long\fP"
-Use the long listing format (same as -m -o -v).
-.IP "\fB\-m, \-\-modes\fP"
+.TP
+.BR \-l , " \-\-long"
+Use the long listing format (same as \fB\-m \-o \-v\fR).
+.TP
+.BR \-m , " \-\-modes"
 Show the mode bits of each file type in the style of ls(1),
 for example 'rwxr-xr-x'.
-.IP "\fB\-o, \-\-owners\fP"
-Show owner and group name of each file.
-.IP "\fB\-n, \-\-nosymlinks\fP"
+.TP
+.BR \-n , " \-\-nosymlinks"
 Don't follow symlinks.
-.IP "\fB\-v, \-\-vertical\fP"
+.TP
+.BR \-o , " \-\-owners"
+Show owner and group name of each file.
+.TP
+.BR \-v , " \-\-vertical"
 Vertically align the modes and owners.
-.IP "\fB\-x, \-\-mountpoints\fP"
+.TP
+.BR \-x , " \-\-mountpoints"
 Show mountpoint directories with a 'D' rather than a 'd'.
-.IP "\fB\-h\fR, \fB\-\-help\fR"
-Display help text and exit.
-.IP "\fB\-V\fR, \fB\-\-version\fR"
+.TP
+.BR \-V , " \-\-version"
 Display version information and exit.
+.TP
+.BR \-h , " \-\-help"
+Display help text and exit.
 .SH AUTHOR
 The original
 .B namei
 program was written by Roger Southwick <rogers@amadeus.wr.tek.com>.
-
-The program was re-written by Karel Zak <kzak@redhat.com>.
+.sp
+The program was rewritten by Karel Zak <kzak@redhat.com>.
 .SH BUGS
 To be discovered.
 .SH "SEE ALSO"
diff --git a/misc-utils/rename.1 b/misc-utils/rename.1
index c166c51..f63d2f2 100644
--- a/misc-utils/rename.1
+++ b/misc-utils/rename.1
@@ -16,16 +16,16 @@ in their name by
 .IR replacement .
 .SH OPTIONS
 .TP
-\fB\-v\fR, \fB\-\-verbose\fR
-Give visual feedback which files where renamed, if any.
+.BR \-s , " \-\-symlink"
+Do not rename a symlink but its target.
 .TP
-\fB\-V\fR, \fB\-\-version\fR
-Display version information and exit.
+.BR \-v , " \-\-verbose"
+Show which files where renamed, if any.
 .TP
-\fB\-s\fR, \fB\-\-symlink\fR
-Peform rename on symlink target
+.BR \-V , " \-\-version"
+Display version information and exit.
 .TP
-\fB\-h\fR, \fB\-\-help\fR
+.BR \-h , " \-\-help"
 Display help text and exit.
 .SH EXAMPLES
 Given the files
-- 
1.7.0.4

[PATCH 7/8] docs: fix the grammar and formatting in the man page of sfdisk

[Benno Schulenberg]

Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
---
 disk-utils/sfdisk.8 |  311 ++++++++++++++++++++++++++-------------------------
 1 files changed, 161 insertions(+), 150 deletions(-)

diff --git a/disk-utils/sfdisk.8 b/disk-utils/sfdisk.8
index 62b1dcf..b36ddef 100644
--- a/disk-utils/sfdisk.8
+++ b/disk-utils/sfdisk.8
@@ -10,7 +10,7 @@
 .\" entire resulting derived work is distributed under the terms of a
 .\" permission notice identical to this one.
 .\"
-.TH SFDISK 8 "September 2014" "util-linux" "System Administration"
+.TH SFDISK 8 "December 2014" "util-linux" "System Administration"
 .SH NAME
 sfdisk \- display or manipulate a disk partition table
 .SH SYNOPSIS
@@ -25,7 +25,7 @@ sfdisk \- display or manipulate a disk partition table
 .I command
 .SH DESCRIPTION
 .B sfdisk
-is a script oriented tool for partitioning any block device.
+is a script-oriented tool for partitioning any block device.
 
 Since version 2.26
 .B sfdisk
@@ -33,15 +33,16 @@ supports MBR (DOS), GPT, SUN and SGI disk labels, but no longer provides any
 functionality for CHS (Cylinder-Head-Sector) addressing.  CHS has
 never been important for Linux, and this addressing concept does not make any
 sense for new devices.
-
+.sp
 .B sfdisk
 (since version 2.26) aligns start and end of the partitions to
-block-device I/O limits when specified by relative sizes, or when default
-values expected.
-
+block-device I/O limits when relative sizes are specified, or when the
+default values are used.
+.sp
 .B sfdisk
-does not create default system partitions for SGI and SUN disk label like
-.BR fdisk (8).
+does not create the standard system partitions for SGI and SUN disk labels like
+.BR fdisk (8)
+does.
 It is necessary to explicitly create all partitions including whole-disk system
 partitions.
 
@@ -49,82 +50,86 @@ partitions.
 The commands are mutually exclusive.
 .TP
 .RB [ \-N " \fIpartition-number\fR] " \fIdevice\fR
-The default sfdisk command is to read the specification for the desired
+The default \fBsfdisk\fR command is to read the specification for the desired
 partitioning of \fIdevice\fR from standard input, and then create a partition
-table according to the specification. See below for the description of the input
-format. If the standard input is a terminal then sfdisk starts interactive session.
-
-If the option \fB\-N\fR specified then the changes are applied to the partition
-addressed by \fIpartno\fR.
+table according to the specification.  See below for the description of the
+input format.  If standard input is a terminal, then \fBsfdisk\fR starts an
+interactive session.
+.sp
+If the option \fB\-N\fR is specified, then the changes are applied to
+the partition addressed by \fIpartition-number\fR.
 .TP
-.BR \-a , " \-\-activate " \fIdevice\fR " "[\fIpartno\fR ...]
-Switch on the bootable flag. If \fIpartno\fR no specified then lists all partitions
-with enabled flag.
+.BR \-a , " \-\-activate \fIdevice\fR [" \fIpartition-number\fR...]
+Switch on the bootable flag.  If no \fIpartition-number\fR is specified,
+then all partitions with an enabled flag are listed.
 .TP
 .BR \-d , " \-\-dump " \fIdevice\fR
 Dump the partitions of a device in a format that is usable as input to sfdisk.
-See the section "BACKUP PARTITION TABLE".
+See the section \fBBACKING UP THE PARTITION TABLE\fR.
 .TP
-.BR \-g , " \-\-show-geometry " [\fIdevice\fR ...]
-List geometry of all or specified devices.
+.BR \-g , " \-\-show-geometry " [ \fIdevice ...]
+List the geometry of all or the specified devices.
 .TP
-.BR \-l , " \-\-list " [\fIdevice\fR ...]
-List partitions of all or specified devices. This command can be used
+.BR \-l , " \-\-list " [ \fIdevice ...]
+List the partitions of all or the specified devices.  This command can be used
 together with \fB\-\-verify\fR.
 .TP
-.BR \-\-part\-attrs " " \fIdevice\fR " " \fIpartno\fR " "[\fIattrs\fR]
-Change GPT partition attribute bits. If \fIattrs\fR no specified then print the current
-partition setting. The \fIattrs\fR is comma or space delimited list of bits. The currently
-supported attribute bits are: RequiredPartiton, NoBlockIOProtocol, LegacyBIOSBootable
-and GUID specific bits in range from 48 to 63. For example string 
+.BR \-\-part-attrs " \fIdevice partno [" \fIattrs ]
+Change the GPT partition attribute bits.  If \fIattrs\fR is not specified,
+then print the current partition settings.  The \fIattrs\fR argument is a
+comma- or space-delimited list of bits.  The currently supported attribute
+bits are: RequiredPartiton, NoBlockIOProtocol, LegacyBIOSBootable
+and GUID-specific bits in the range from 48 to 63.  For example, the string
 "RequiredPartiton,50,51" sets three bits.
 .TP
-.BR \-\-part\-label " " \fIdevice\fR " " \fIpartno\fR " "[\fIlabel\fR]
-Change GPT partition name (label). If \fIlabel\fR no specified then print the current
-partition label.
+.BR \-\-part-label " \fIdevice partno [" \fIlabel ]
+Change the GPT partition name (label).  If \fIlabel\fR is nto specified,
+then print the current partition label.
 .TP
-.BR \-\-part-type " " \fIdevice\fR " " \fIpartno\fR " "[\fItype\fR]
-Change partition type. If \fItype\fR no specified then print the current
-partition type. The argument \fItype\fR is hex for MBR or GUID for GPT.
-For backward compatibility the option -c, --id has the same meaning.
+.BR \-\-part-type " \fIdevice partno [" \fItype ]
+Change the partition type.  If \fItype\fR is not specified, then print the
+current partition type.  The \fItype\fR argument is hexadecimal for MBR,
+or a GUID for GPT.  For backward compatibility the options \fB\-c\fR and
+\fB\-\-id\fR have the same meaning.
 .TP
-.BR \-\-part\-uuid " " \fIdevice\fR " " \fIpartno\fR " "[\fIuuid\fR]
-Change GPT partition UUID. If \fIuuid\fR no specified then print the current
-partition UUID.
+.BR \-\-part-uuid " \fIdevice partno [" \fIuuid ]
+Change the GPT partition UUID.  If \fIuuid\fR is not specified,
+then print the current partition UUID.
 .TP
-.BR \-s , " \-\-show-size " [\fIdevice\fR ...]
-List sizes of all or specified devices.
+.BR \-s , " \-\-show-size " [ \fIdevice ...]
+List the sizes of all or the specified devices.
 .TP
-.BR \-T , " \-\-list-types
-Print all supported types for the current disk label or label specified by
+.BR \-T , " \-\-list-types"
+Print all supported types for the current disk label or the label specified by
 \fB\-\-label\fR.
 .TP
 .BR \-V , " \-\-verify
-Test whether partition table and partitions seem correct.
+Test whether the partition table and partitions seem correct.
 
 .SH OPTIONS
 .TP
 .BR \-A , " \-\-append"
-Don't create a new partition table, but rather appends specified partitions only.
+Don't create a new partition table, but only append the specified partitions.
 .TP
 .BR \-b , " \-\-backup"
-Backup the current partition table sectors before start partitioning. The defautl
-backup file name is ~/sfdisk-<device>-<offset>.bak, see \fI\-\-backup-file\fR.
+Back up the current partition table sectors before starting the partitioning.
+The default backup file name is ~/sfdisk-<device>-<offset>.bak; to use another
+name see \fB\-\-backup-file\fR.
 .TP
 .BR \-f , " \-\-force"
 Disable all consistency checking.
 .TP
-.BR \-o , " \-\-output " \fIlist\fP
+.BR \-o , " \-\-output " \fIlist
 Specify which output columns to print.  Use
 .B \-\-help
 to get a list of all supported columns.
-
+.sp
 The default list of columns may be extended if \fIlist\fP is
 specified in the format \fI+list\fP (e.g. \fB-o +UUID\fP).
 .TP
 .BR \-O , " \-\-backup-file " \fIpath\fR
-Override default backup file name. Note that the device name and offset is always
-appended to the file name.
+Override the default backup file name.  Note that the device name and offset
+are always appended to the file name.
 .TP
 .BR \-q , " \-\-quiet"
 Suppress extra info messages.
@@ -132,30 +137,30 @@ Suppress extra info messages.
 .BR \-n , " \-\-no\-act"
 Do everything except write to device.
 .TP
-.BR "\-\-no\-reread"
-Do not check by re-read-partition-table ioctl whether the device is in use.
+.B \-\-no-reread
+Do not check through the re-read-partition-table ioctl whether the device is in use.
 .TP
-.BR \-u , " \-\-unit " S
-Deprecated option. The sector unit is supported only.
+.BR \-u , " \-\-unit S"
+Deprecated option.  Only the sector unit is supported.
 .TP
 .BR "\-\-Linux"
-Deprecated and ignored option. Linux (and another moder OS) compatible
+Deprecated and ignored option.  Linux (and another modern OS) compatible
 partitioning is the default.
 .TP
-.BR \-X , " \-\-label \fItype\fR
-Specify disk label type (e.g. dos, gpt, ...). If no label specified then sfdisk
-defaults to an existing label. If there is no label on the device than defaults
-to "dos".
+.BR \-X , " \-\-label " \fItype
+Specify the disk label type (e.g. \fBdos\fR, \fBgpt\fR, ...).  If this option
+is not given, then \fBsfdisk\fR defaults to the existing label, but if there
+is no label on the device yet, then the type defaults to \fBdos\fR.
 .TP
-.BR \-Y , " \-\-label-nested \fItype\fR
-Force sfdisk to edit nested disk label. The primary disk label has to already exist.
-This option allows to edit for example hybrid/protective MBR on devices with GPT.
+.BR \-Y , " \-\-label-nested " \fItype
+Force editing of a nested disk label.  The primary disk label has to exist already.
+This option allows to edit for example a hybrid/protective MBR on devices with GPT.
+.TP
+.BR \-v , " \-\-version"
+Display version information and exit.
 .TP
 .BR \-h , " \-\-help"
 Display help text and exit.
-.TP
-.BR \-V , " \-\-version"
-Display version information and exit.
 
 .SH "INPUT FORMATS"
 .B sfdisk
@@ -163,70 +168,70 @@ supports two input formats and generic header lines.
 
 .B Header lines
 .RS
-The optional headers lines specify generic information that apply to partition 
-table. The header line format is:
-.RS     
-.sp     
+The optional header lines specify generic information that apply to the partition
+table.  The header-line format is:
+.RS
+.sp
 .B "<name>: <value>"
-.sp     
-.RE 
+.sp
+.RE
 The currently recognized headers are:
 .RS
 .TP
 .B unit
-Specify partitioning unit. The supported unit is only "sectors".
+Specify the partitioning unit.  The only supported unit is \fBsectors\fR.
 .TP
 .B label
-Specify partition table type. For example "dos" or "gpt".
+Specify the partition table type.  For example \fBdos\fR or \fBgpt\fR.
 .TP
 .B label-id
-Specify partition table identifier. It's hexadecimal number (with 0x prefix) for 
-MBR and UUID for GPT.
+Specify the partition table identifier.  It should be a  hexadecimal number
+(with a 0x prefix) for MBR and a UUID for GPT.
 .RE
 .sp
-Note that header lines is possible to use only before the first partition 
+Note that it is only possible to use header lines before the first partition
 is specified in the input.
 .RE
 
-.B Unnamed fields format
+.B Unnamed-fields format
+.RS
 .RS
-.RS     
-.sp     
-.B "<start> <size> <type> <bootable>"
-.sp     
-.RE 
+.sp
+.I start size type bootable
+.sp
+.RE
 where each line fills one partition descriptor.
-
-Fields are separated by whitespace, or comma or semicolon possibly followed  by
+.sp
+Fields are separated by whitespace, or q comma or semicolon possibly followed by
 whitespace; initial and trailing whitespace is ignored.  Numbers can be octal,
-decimal or hexadecimal, decimal is default.  When  a field is absent or empty,
-a default value is used. But when the \fB-N\fR option (change a single partition
-only) is given, the default for each field is its previous value.
-
+decimal or hexadecimal; decimal is the default.  When  a field is absent or empty,
+a default value is used.  But when the \fB-N\fR option (change a single partition)
+is given, the default for each field is its previous value.
+.sp
 The default value of
 .I start
-is the first non-assigned sector aligned according to device I/O limits. The default
-start offset for the first partition is 1 MiB.
-
+is the first non-assigned sector aligned according to device I/O limits.
+The default start offset for the first partition is 1 MiB.
+.sp
 The default value of
 .I size
-is as much as possible (until next partition or end-of-device). A '+' can be
+is as much as possible (until the next partition or end-of-device).  A '+' can be
 used instead of a number for size, which also means as much as possible.  The
 size may be followed by the multiplicative suffixes (KiB, MiB, GiB, TiB, PiB,
 EiB, ZiB and YiB), then the number is interpreted as size of the partition in
 bytes and then the size is aligned according to the device I/O limits.
 The default is to interpret the number as number of sectors.
-
-Patition
+.sp
+The partition
 .I type
-is given in hex for MBR (DOS), without the 0x prefix, GUID string for GPT or
-shortcut:
+is given in hex for MBR (DOS), without the 0x prefix, a GUID string for GPT, or
+a shortcut:
 .RS
 .TP
-.B L 
+.B L
 Linux; means 83 for MBR and 0FC63DAF-8483-4772-8E79-3D69D8477DE4 for GPT.
 .TP
-.B S 
+.B S
 swap area; means 82 for MBR and 0657FD6D-A4AB-43C4-84E5-0933C84B4F4F for GPT
 .TP
 .B E
@@ -239,110 +244,115 @@ home partition; means 933AC7E1-2EB4-4F13-B844-0E14E2AEF915 for GPT
 linux extended partition; means 85 for MBR.
 .RE
 
-.I Bootable
-is specified as [*|-], with as default not-bootable. (The value of this
-field is irrelevant for Linux - when Linux  runs  it  has been booted already -
-but might play a role for certain boot loaders and for other operating systems).
+.I bootable
+is specified as [\fB*\fR|\fB-\fR], with as default not-bootable.  (The value of
+this field is irrelevant for Linux - when Linux runs it has been booted already -
+but might play a role for certain boot loaders and for other operating systems.)
 .RE
 
-.B Named fields format
+.B Named-fields format
 .RS
-This format is more readable, robust, extendible and allows to specify additional 
-information (e.g. uuid). It's recommended to use this format to keep you scripts
+This format is more readable, robust, extendible and allows to specify additional
+information (e.g. a UUID).  It is recommended to use this format to keep you scripts
 more readable.
-.RS     
-.sp     
-.B "[<device> :] <name>[=<value>], ..."
-.sp     
-.RE 
-The 
+.RS
+.sp
+.RI [ "device \fB:" ] " name" [\fB= value "], ..."
+.sp
+.RE
+The
 .I device
-field is optional. sfdisk extracts partition number from the device name. It 
-allows to specify partition in random order. This functionality is mostly
-used by \fR\-\-dump\fR. Don't use it if you are not sure.
+field is optional.  \fBsfdisk\fRextracts the partition number from the
+device name.  It allows to specify the partitions in random order.
+This functionality is mostly used by \fb\-\-dump\fR.
+Don't use it if you are not sure.
 
 The
 .I value
-can be between quotation marks (e.g. name="This is partition name"). The currently
-supported fields:
+can be between quotation marks (e.g. name="This is partition name").
+The currently supported fields are:
 .RS
 .TP
-.B start=<number>
-The first non-assigned sector aligned according to device I/O limits. The default
+.BI start= number
+The first non-assigned sector aligned according to device I/O limits.  The default
 start offset for the first partition is 1 MiB.
 .TP
-.B size=<number>
-Specify partition size in sectors. The number may be followed by the multiplicative 
+.BI size= number
+Specify the partition size in sectors.  The number may be followed by the multiplicative
 suffixes (KiB, MiB, GiB, TiB, PiB, EiB, ZiB and YiB), then it's interpreted as size
 in bytes and the size is aligned according to device I/O limits.
 .TP
-.B bootable 
-Mark partition as bootable.
+.B bootable
+Mark the partition as bootable.
 .TP
-.B attrs=<string>
-Partition attributes, usually GPT partition attribute bits. See --part-attrs for
-more details about GPT bits string format.
+.BI attrs= string
+Partition attributes, usually GPT partition attribute bits.  See
+\fB\-\-part-attrs\fR for more details about the GPT-bits string format.
 .TP
-.B uuid=<string>
+.BI uuid= string
 GPT partition UUID.
 .TP
-.B name=<string>
+.BI name= string
 GPT partition name.
 .TP
-.B type=<code>
-Hexadecimal number (without 0x) for MBR partition or GUID for GPT partition. For backward
-compatibility \fBId=\fR field has the same meaning.
+.BI type= code
+A hexadecimal number (without 0x) for an MBR partition, or a GUID for a GPT partition.
+For backward compatibility the \fBId=\fR field has the same meaning.
 .RE
 .RE
 
-.SH "BACKUP PARTITION TABLE"
-It's recommended to save device layout.
+.SH "BACKING UP THE PARTITION TABLE"
+It is recommended to save the layout of your devices.
 .B sfdisk
 supports two ways.
-
-Use \fB\-\-dump\fR command line option to save description of the device layout
-to text file. The dump format is suitable for later sfdisk input. For example
+.sp
+Use the \fB\-\-dump\fR option to save a description of the device layout
+to a text file.  The dump format is suitable for later \fBsfdisk\fR input.
+For example:
 .RS
 .sp
 .B "sfdisk --dump /dev/sda > sda.dump"
 .sp
 .RE
-and restore by:
+This can later be restored by:
 .RS
 .sp
 .B "sfdisk /dev/sda < sda.dump"
 .RE
 
-If you want to full (binary) backup of all sectors where is stored partition table 
-then use \fB\-\-backup\fR command line option. It writes the sectors to 
-~/sfdisk-<device>-<offset>.bak files. The default name of the backup file might
-be changed by \fB\-\-backup\-file\fR command line option. The backup files
-contain only raw data from the \fIdevice\fR. Note that the same concept of
-backups files uses
-.B wipefs (8)
+If you want to do a full (binary) backup of all sectors where the
+partition table is stored,
+then use the \fB\-\-backup\fR option.  It writes the sectors to
+~/sfdisk-<device>-<offset>.bak files.  The default name of the backup file can
+be changed with the \fB\-\-backup\-file\fR option.  The backup files
+contain only raw data from the \fIdevice\fR.
+Note that the same concept of backup files is used by
+.BR wipefs (8).
+For example:
 .RS
 .sp
 .B "sfdisk --backup /dev/sda"
 .sp
 .RE
-and later restore GPT header by:
+The GPT header can later be restored by:
 .RS
 .sp
 .B dd if=~/sfdisk-sda-0x00000200.bak of=/dev/sda seek=$((0x00000200.bak)) bs=1 conv=notrunc
 .sp
 .RE
-Note that sfdisk since version 2.26 does not provide \fB\-I\fR command line option to
-restore sectors. 
+Note that \fBsfdisk\fR since version 2.26 no longer provides the \fB\-I\fR option to
+restore sectors.
 .B dd (1)
 provides all necessary functionality.
 
 .SH NOTES
-sfdisk since version 2.26 does not provide \fB\-\-re\-read\fR command to force kernel to reread partition table. Use
-\fBblockdev \-\-rereadpt\fR.
+Since version 2.26 \fBsfdisk\fR no longer provides the \fB\-R\fR or
+\fB\-\-re-read\fR option to force the kernel to reread the partition table.
+Use \fBblockdev \-\-rereadpt\fR instead.
 .PP
-sfdisk since version 2.26 does not provide \fB\-\-DOS\fR, \fB\-\-IBM\fR, \fB\-\-DOS-extended\fR,
-\fB\-\-unhide\fR, \fB\-\-show\-extended\fR, \fB\-\-cylinders\fR, \fB\-\-heads\fR, \fB\-\-sectors\fR,
-\fB\-\-inside\-outer\fR, \fB\-\-not\-inside\-outer\fR options.
+Since version 2.26 \fBsfdisk\fR does not provide the \fB\-\-DOS\fR, \fB\-\-IBM\fR, \fB\-\-DOS-extended\fR,
+\fB\-\-unhide\fR, \fB\-\-show-extended\fR, \fB\-\-cylinders\fR, \fB\-\-heads\fR, \fB\-\-sectors\fR,
+\fB\-\-inside-outer\fR, \fB\-\-not-inside-outer\fR options.
 
 .SH ENVIRONMENT
 .IP LIBFDISK_DEBUG=all
@@ -358,6 +368,7 @@ enables libsmartcols debug output.
 .BR parted (8),
 .BR partprobe (8),
 .BR partx(8)
+
 .SH AUTHOR
 Karel Zak <kzak@redhat.com>
 .PP
-- 
1.7.0.4

[PATCH 8/8] sfdisk: in the usage text show -v for --version instead of -V

[Benno Schulenberg]

In sfdisk -V is taken by --verify.  Use for the description of --version
the same indentation as for --help, not that of the other options.

Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
---
 disk-utils/sfdisk.c |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/disk-utils/sfdisk.c b/disk-utils/sfdisk.c
index cff8664..73a1331 100644
--- a/disk-utils/sfdisk.c
+++ b/disk-utils/sfdisk.c
@@ -1348,7 +1348,7 @@ static void __attribute__ ((__noreturn__)) usage(FILE *out)
 
 	fputs(USAGE_SEPARATOR, out);
 	fputs(USAGE_HELP, out);
-	fputs(USAGE_VERSION, out);
+	fputs(_(" -v, --version  output version information and exit\n"), out);
 
 	list_available_columns(out);
 
-- 
1.7.0.4

Re: [PATCH 1/8] docs: fix the grammar of the recent comment about comments

[Karel Zak]

On Sun, Dec 14, 2014 at 08:45:26PM +0100, Benno Schulenberg wrote:
>  lib/terminal-colors.d.5 |    5 +++--
>  1 files changed, 3 insertions(+), 2 deletions(-)

 All 8 patches applied, thanks!

    Karel

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