summaryrefslogtreecommitdiffstats
path: root/disk-utils
diff options
context:
space:
mode:
authorBenno Schulenberg2014-12-14 20:45:29 +0100
committerKarel Zak2014-12-19 09:57:23 +0100
commitf49ccec2123f15ce25a2e9d7d83d219c237e755a (patch)
treeaa9a161b36061c433e0832d9e5739f56c546c857 /disk-utils
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>
Diffstat (limited to 'disk-utils')
-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
9 files changed, 25 insertions, 18 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