summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBenno Schulenberg2014-12-14 20:45:29 +0100
committerKarel Zak2014-12-19 09:57:23 +0100
commitf49ccec2123f15ce25a2e9d7d83d219c237e755a (patch)
treeaa9a161b36061c433e0832d9e5739f56c546c857
parentdocs: improve the sorting of the options in the man page of getopt (diff)
downloadkernel-qcow2-util-linux-f49ccec2123f15ce25a2e9d7d83d219c237e755a.tar.gz
kernel-qcow2-util-linux-f49ccec2123f15ce25a2e9d7d83d219c237e755a.tar.xz
kernel-qcow2-util-linux-f49ccec2123f15ce25a2e9d7d83d219c237e755a.zip
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>
-rw-r--r--disk-utils/cfdisk.82
-rw-r--r--disk-utils/fdformat.82
-rw-r--r--disk-utils/fdisk.82
-rw-r--r--disk-utils/isosize.82
-rw-r--r--disk-utils/mkfs.82
-rw-r--r--disk-utils/mkfs.bfs.82
-rw-r--r--disk-utils/mkswap.82
-rw-r--r--disk-utils/partx.811
-rw-r--r--disk-utils/sfdisk.818
-rw-r--r--login-utils/last.110
-rw-r--r--login-utils/lslogins.15
-rw-r--r--misc-utils/cal.13
-rw-r--r--misc-utils/findmnt.810
-rw-r--r--misc-utils/getopt.16
-rw-r--r--misc-utils/logger.13
-rw-r--r--misc-utils/look.15
-rw-r--r--misc-utils/lsblk.82
-rw-r--r--misc-utils/lslocks.83
-rw-r--r--misc-utils/mcookie.12
-rw-r--r--misc-utils/namei.14
-rw-r--r--misc-utils/rename.13
-rw-r--r--misc-utils/uuidgen.12
-rw-r--r--misc-utils/whereis.12
-rw-r--r--sys-utils/readprofile.82
-rw-r--r--term-utils/agetty.86
25 files changed, 61 insertions, 50 deletions
diff --git a/disk-utils/cfdisk.8 b/disk-utils/cfdisk.8
index 6da8f431b..dc30b700b 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 ae1e530e0..9e1b98965 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 56caab16d..a61176d44 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 07ecfdc0c..98382f2f8 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 675822d90..54bb004ae 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 e1afd0491..0769105ba 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 c110d21ef..562078d0c 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 88eef60b1..005fe6662 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 08725fd42..62b1dcf4a 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 edaddd1db..23ebaf32e 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 0dbeebdb9..fb45b79db 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 320951602..92141ae9e 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 27121d87f..901b5124a 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 6758d2796..da7207f0a 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 3bfcb3dbb..2a3b47cb8 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 d1d8f1bd4..21edb6639 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 8c9740c11..7c19dd860 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 20ff0dcbb..70a5638e8 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 989b7f9b9..6587c57e4 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 550dc9740..610d97c00 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 30d9c710a..c166c515f 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 4d64a10e1..4c39d1cab 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 243fc14a0..652f69bc7 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 8ad9dc9ed..c01e3ca69 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 12e481f6c..10f339586 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