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

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>

diff --git a/disk-utils/cfdisk.8 b/disk-utils/cfdisk.8
index 6da8f431b5f0dfdde6e8d0fd376e6e374d1cdcf9..dc30b700b240e210a27454e9afff7ce906bc6452 100644 (file)
--- 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 ae1e530e003cb1da2f1fe9e08c2df32a99c3b270..9e1b989654da6899312a3dcfda01d154a37e9bce 100644 (file)
--- 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 56caab16dc5d068277b20242bd09175443aa2fac..a61176d44c4bffd425b961518f5d574c21d64f31 100644 (file)
--- 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 07ecfdc0c9587ba66e959b7805b6709ac1894fcb..98382f2f80e9914ab28d7d9b9a3c3007ed42c95f 100644 (file)
--- 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 675822d90b90613a1e53c41523a59c08c9ce5ae7..54bb004ae0679bcbdb1120b2e8d1c62c88cc3adf 100644 (file)
--- 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 e1afd0491af618f54c54a2b95407a44059738c1d..0769105bac080b6376676b3aeac92b49d2e4858e 100644 (file)
--- 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 c110d21efd07f77d9d043946d7dc4902a50775eb..562078d0c94ea665daab28ad6b91ffca2f18fa17 100644 (file)
--- 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 88eef60b1561b73ce19cc8c5715d6035f1fa7924..005fe66629eb5fcbc49b4985df2756c7acc580a2 100644 (file)
--- 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 08725fd428abc32c2d9d8725766c40c912c75d0e..62b1dcf4a388968ff9ffb1a2adda43766d9f5017 100644 (file)
--- 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 edaddd1db2327aad8904d39b0b10e2b7f575ba9a..23ebaf32e9eee5ac13828b6f225afb983081cb3b 100644 (file)
--- 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 0dbeebdb98eb1e718e81d4ba6af601bcd5cebd42..fb45b79db51c8b94e59198a338a99d27d56163a9 100644 (file)
--- 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 3209516027fc72e644296ebc32b030bb31ce955e..92141ae9eba122b12639a84b43844eb62bd67d67 100644 (file)
--- 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 27121d87f6048c8b371c0529aaf44879ad875e74..901b5124a32f86d0d885933eb396c29e4858a428 100644 (file)
--- 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 6758d2796be022051ec041f6dfc32620f06f6f6e..da7207f0aa4015620c197999b5d7204e6ff191eb 100644 (file)
--- 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 3bfcb3dbbd5a05d5bbc9e33cf9b688f4efc63b5d..2a3b47cb84689c149b4ef957f32ddd77173adfa5 100644 (file)
--- 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 d1d8f1bd4f41e18ad79fdbbc875323f5168e5476..21edb6639840bcd1b8a5e72fbfba84c5e26eeae5 100644 (file)
--- 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 8c9740c11fd2a4b4daf673d0932067b0693cad09..7c19dd860d4875a990d2e1d93e643b4eba2a0a06 100644 (file)
--- 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 20ff0dcbb22bbd6542b13e57543087afa822105b..70a5638e87ede95102b476c5ade269c910f9a92a 100644 (file)
--- 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 989b7f9b9aff76c8b4a88bf28c91f363fc998da5..6587c57e4dc6353e18b54b14564a82f75d03b483 100644 (file)
--- 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 550dc9740af9b7526a52ff015f6bab763dd44978..610d97c009b75d65c295215159c599c26f7225ea 100644 (file)
--- 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 30d9c710a6d6209dec38665bf923208876738412..c166c515f84213cab154944405289f8672fddc8d 100644 (file)
--- 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 4d64a10e1cf158db16102d6913ac1fdea77c050f..4c39d1cabd1871d6f9b0b303456164aaaacbf647 100644 (file)
--- 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 243fc14a0e76a2e81c6948bc8101ecf5222926e2..652f69bc756bdfc84dfb17cf55095ed693f78893 100644 (file)
--- 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 8ad9dc9ede34e65a20072d2cc0fd92f867da44c5..c01e3ca69c78d569df30dbe2bba60a17fe90c68d 100644 (file)
--- 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 12e481f6cf5b172f7693738626ca08e607fff946..10f339586a019977a30e96139d36e1549244047c 100644 (file)
--- 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