summaryrefslogtreecommitdiffstats
path: root/sys-utils
diff options
context:
space:
mode:
authorBenno Schulenberg2013-10-14 21:34:39 +0200
committerKarel Zak2013-10-15 10:28:30 +0200
commitb4362b6f849fd9a94e497927d513716dc09a9cd0 (patch)
tree36a260e035d9525a75ddc0b874f46a55879e8000 /sys-utils
parentdocs: format, grammarize, and standardize the wall man page (diff)
downloadkernel-qcow2-util-linux-b4362b6f849fd9a94e497927d513716dc09a9cd0.tar.gz
kernel-qcow2-util-linux-b4362b6f849fd9a94e497927d513716dc09a9cd0.tar.xz
kernel-qcow2-util-linux-b4362b6f849fd9a94e497927d513716dc09a9cd0.zip
docs: standardize the phrases for --help and --version in all man pages
Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
Diffstat (limited to 'sys-utils')
-rw-r--r--sys-utils/blkdiscard.82
-rw-r--r--sys-utils/chcpu.82
-rw-r--r--sys-utils/ctrlaltdel.84
-rw-r--r--sys-utils/dmesg.14
-rw-r--r--sys-utils/eject.14
-rw-r--r--sys-utils/fallocate.14
-rw-r--r--sys-utils/flock.14
-rw-r--r--sys-utils/fsfreeze.84
-rw-r--r--sys-utils/fstrim.82
-rw-r--r--sys-utils/hwclock.86
-rw-r--r--sys-utils/ipcmk.14
-rw-r--r--sys-utils/ipcs.12
-rw-r--r--sys-utils/ldattach.84
-rw-r--r--sys-utils/lscpu.12
-rw-r--r--sys-utils/mount.84
-rw-r--r--sys-utils/mountpoint.12
-rw-r--r--sys-utils/nsenter.12
-rw-r--r--sys-utils/pivot_root.84
-rw-r--r--sys-utils/prlimit.14
-rw-r--r--sys-utils/readprofile.86
-rw-r--r--sys-utils/renice.14
-rw-r--r--sys-utils/rtcwake.88
-rw-r--r--sys-utils/setarch.85
-rw-r--r--sys-utils/setpriv.12
-rw-r--r--sys-utils/swapon.84
-rw-r--r--sys-utils/switch_root.84
-rw-r--r--sys-utils/umount.84
-rw-r--r--sys-utils/unshare.12
-rw-r--r--sys-utils/wdctl.86
29 files changed, 53 insertions, 56 deletions
diff --git a/sys-utils/blkdiscard.8 b/sys-utils/blkdiscard.8
index 7e8c91e8f..e71a09360 100644
--- a/sys-utils/blkdiscard.8
+++ b/sys-utils/blkdiscard.8
@@ -38,7 +38,7 @@ 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.
.IP "\fB\-h, \-\-help\fP"
-Print help and exit.
+Display help text and exit.
.IP "\fB\-o, \-\-offset\fP \fIoffset\fP"
Byte offset in the device from which to discard. Provided value will be
aligned to the device sector size. Default value is zero.
diff --git a/sys-utils/chcpu.8 b/sys-utils/chcpu.8
index d016b86f2..c7555cc2c 100644
--- a/sys-utils/chcpu.8
+++ b/sys-utils/chcpu.8
@@ -76,7 +76,7 @@ instance runs and returns it to the CPU pool. A CPU must be offline, see
\-d, before it can be deconfigured.
.TP
.BR \-h , " \-\-help"
-Display help information and exit.
+Display help text and exit.
.TP
.BR \-V , " \-\-version"
Display version information and exit.
diff --git a/sys-utils/ctrlaltdel.8 b/sys-utils/ctrlaltdel.8
index 14cf3dd16..30bbae458 100644
--- a/sys-utils/ctrlaltdel.8
+++ b/sys-utils/ctrlaltdel.8
@@ -32,10 +32,10 @@ file.
.SH OPTIONS
.TP
\fB\-V\fR, \fB\-\-version\fR
-Output version information and exit.
+Display version information and exit.
.TP
\fB\-h\fR, \fB\-\-help\fR
-Display help and exit.
+Display help text and exit.
.SH FILES
.I /etc/rc.local
.SH "SEE ALSO"
diff --git a/sys-utils/dmesg.1 b/sys-utils/dmesg.1
index 4500af9c7..f5d256cf7 100644
--- a/sys-utils/dmesg.1
+++ b/sys-utils/dmesg.1
@@ -60,7 +60,7 @@ output.
Enable human-readable output. See also \fB\-\-color\fR, \fB\-\-reltime\fR
and \fB\-\-nopager\fR.
.IP "\fB\-h\fR, \fB\-\-help\fR"
-Print a help text and exit.
+Display help text and exit.
.IP "\fB\-k\fR, \fB\-\-kernel\fR"
Print kernel messages.
.IP "\fB\-L\fR, \fB\-\-color\fR[=\fIwhen\fR]"
@@ -149,7 +149,7 @@ Do not print kernel's timestamps.
.IP "\fB\-u\fR, \fB\-\-userspace\fR"
Print userspace messages.
.IP "\fB\-V\fR, \fB\-\-version\fR"
-Output version information and exit.
+Display version information and exit.
.IP "\fB\-w\fR, \fB\-\-follow\fR"
Wait for new messages. This feature is supported only on systems with
a readable /dev/kmsg (since kernel 3.5.0).
diff --git a/sys-utils/eject.1 b/sys-utils/eject.1
index 429f0dd0f..1acc3b3cd 100644
--- a/sys-utils/eject.1
+++ b/sys-utils/eject.1
@@ -46,7 +46,7 @@ disk eject command.
.IP "\fB\-F, \-\-force\fP"
Force eject, don't check device type.
.IP "\fB\-h, \-\-help\fP"
-Print a help text and exit.
+Display help text and exit.
.IP "\fB\-i, \-\-manualeject \fIon|off\fP"
This option controls locking of the hardware eject button. When enabled, the
drive will not be ejected when the button is pressed. This is useful when you
@@ -83,7 +83,7 @@ This option specifies that the drive should be ejected using SCSI commands.
Run in verbose mode; more information is displayed about what the command is
doing.
.IP "\fB\-V, \-\-version\fP"
-Display program version and exit.
+Display version information and exit.
.IP "\fB\-x, \-\-cdspeed \fI<speed>\fP"
With this option the drive is given a CD-ROM select speed command. The speed
argument is a number indicating the desired speed (e.g. 8 for 8X speed), or 0
diff --git a/sys-utils/fallocate.1 b/sys-utils/fallocate.1
index 49d26e44c..d462cee9c 100644
--- a/sys-utils/fallocate.1
+++ b/sys-utils/fallocate.1
@@ -40,9 +40,9 @@ Specifies the beginning offset of the allocation, in bytes.
.IP "\fB\-l, \-\-length\fP \fIlength\fP
Specifies the length of the allocation, in bytes.
.IP "\fB\-h, \-\-help\fP"
-Print help and exit.
+Display help text and exit.
.IP "\fB-V, \-\-version"
-Print version and exit.
+Display version information and exit.
.SH AUTHORS
.UR sandeen@redhat.com
Eric Sandeen
diff --git a/sys-utils/flock.1 b/sys-utils/flock.1
index b28526f69..d9f7d86e7 100644
--- a/sys-utils/flock.1
+++ b/sys-utils/flock.1
@@ -104,9 +104,9 @@ without arguments, to the shell with
.BR -c .
.TP
\fB\-h\fP, \fB\-\-help\fP
-Print a help message.
+Display help text and exit.
.IP "\fB\-V, \-\-version\fP"
-Show version number and exit.
+Display version information and exit.
.SH EXAMPLES
.TP
shell1> flock /tmp -c cat
diff --git a/sys-utils/fsfreeze.8 b/sys-utils/fsfreeze.8
index df161462c..f57bbd7d0 100644
--- a/sys-utils/fsfreeze.8
+++ b/sys-utils/fsfreeze.8
@@ -39,7 +39,7 @@ the traditional atime semantics (mount option strictatime, for more details see
.SH OPTIONS
.IP "\fB\-h, \-\-help\fP"
-Print help and exit.
+Display help text and exit.
.IP "\fB\-f, \-\-freeze\fP"
This option requests the specified a filesystem to be frozen from new
modifications. When this is selected, all ongoing transactions in the
@@ -57,7 +57,7 @@ This option is used to un-freeze the filesystem and allow operations to
continue. Any filesystem modifications that were blocked by the freeze are
unblocked and allowed to complete.
.IP "\fB\-V, \-\-version\fP"
-Show version number and exit.
+Display version information and exit.
.SH AUTHOR
.PP
Written by Hajime Taira.
diff --git a/sys-utils/fstrim.8 b/sys-utils/fstrim.8
index f3708b5ac..0709f9a8c 100644
--- a/sys-utils/fstrim.8
+++ b/sys-utils/fstrim.8
@@ -36,7 +36,7 @@ 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.
.IP "\fB\-h, \-\-help\fP"
-Print help and exit.
+Display help text and exit.
.IP "\fB\-o, \-\-offset\fP \fIoffset\fP"
Byte offset in filesystem from which to begin searching for free blocks
to discard. Default value is zero, starting at the beginning of the
diff --git a/sys-utils/hwclock.8 b/sys-utils/hwclock.8
index 868c2b90a..09f1edc5e 100644
--- a/sys-utils/hwclock.8
+++ b/sys-utils/hwclock.8
@@ -117,12 +117,10 @@ the difference every 10 seconds. This will also print the frequency
offset and tick.
.TP
.BR \-h , \ \-\-help
-Display a help text and exit.
+Display help text and exit.
.TP
.BR \-V , \ \-\-version
-Display the version of
-.B hwclock
-and exit.
+Display version information and exit.
.SH OPTIONS
.PP
diff --git a/sys-utils/ipcmk.1 b/sys-utils/ipcmk.1
index 0900a19b1..bc2417d95 100644
--- a/sys-utils/ipcmk.1
+++ b/sys-utils/ipcmk.1
@@ -32,10 +32,10 @@ Message queue.
Permission for the resource. Default is 0644.
.TP
\fB\-h\fR, \fB\-\-help\fR
-Display a short help message and exit.
+Display help text and exit.
.TP
\fB\-V\fR, \fB\-\-version\fR
-Output version information and exit.
+Display version information and exit.
.PP
.SH "SEE ALSO"
.BR ipcrm (1),
diff --git a/sys-utils/ipcs.1 b/sys-utils/ipcs.1
index c070d1a62..453ce5c01 100644
--- a/sys-utils/ipcs.1
+++ b/sys-utils/ipcs.1
@@ -21,7 +21,7 @@ Print details only on the resource identified by
.IR id .
.TP
\fB\-h\fR, \fB\-\-help\fR
-Display a help text and exit.
+Display help text and exit.
.TP
\fB\-V\fR, \fB\-\-version\fR
Display version information and exit.
diff --git a/sys-utils/ldattach.8 b/sys-utils/ldattach.8
index 8ce14f3c1..52bb7874f 100644
--- a/sys-utils/ldattach.8
+++ b/sys-utils/ldattach.8
@@ -96,10 +96,10 @@ to stay in the foreground so that it can be interrupted or debugged,
and to print verbose messages about its progress to the standard error output.
.TP
\fB-h\fP | \fB--help\fP
-Prints a usage message and exits.
+Display help text and exit.
.TP
\fB-V\fP | \fB--version\fP
-Prints the program version.
+Display version information and exit.
.TP
\fB-s\fP \fIvalue\fP | \fB--speed\fP \fIvalue\fP
Set the speed of the serial line to the specified value.
diff --git a/sys-utils/lscpu.1 b/sys-utils/lscpu.1
index 19c964ae3..3ce82171a 100644
--- a/sys-utils/lscpu.1
+++ b/sys-utils/lscpu.1
@@ -107,7 +107,7 @@ When specifying the \fIlist\fP argument, the string of option, equal sign (=), a
Examples: '\fB-e=cpu,node\fP' or '\fB--extended=cpu,node\fP'.
.TP
.BR \-h , " \-\-help"
-Display help information and exit.
+Display help text and exit.
.TP
.BR \-p , " \-\-parse" [=\fIlist\fP]
Optimize the command output for easy parsing.
diff --git a/sys-utils/mount.8 b/sys-utils/mount.8
index 46abbf614..6a5edd047 100644
--- a/sys-utils/mount.8
+++ b/sys-utils/mount.8
@@ -553,9 +553,9 @@ Command line options available for the
.B mount
command:
.IP "\fB\-V, \-\-version\fP"
-Output version.
+Display version information and exit.
.IP "\fB\-h, \-\-help\fP"
-Print a help message.
+Display help text and exit.
.IP "\fB\-v, \-\-verbose\fP"
Verbose mode.
.IP "\fB\-a, \-\-all\fP"
diff --git a/sys-utils/mountpoint.1 b/sys-utils/mountpoint.1
index 5eb415692..687462485 100644
--- a/sys-utils/mountpoint.1
+++ b/sys-utils/mountpoint.1
@@ -17,7 +17,7 @@ mountpoint \- see if a directory is a mountpoint
checks if the directory is mentioned in the /proc/self/mountinfo file.
.SH OPTIONS
.IP "\fB\-h, \-\-help\fP"
-Print help and exit.
+Display help text and exit.
.IP "\fB\-q, \-\-quiet\fP"
Be quiet - don't print anything.
.IP "\fB\-d, \-\-fs\-devno\fP"
diff --git a/sys-utils/nsenter.1 b/sys-utils/nsenter.1
index e3c08afa3..60ee6b3da 100644
--- a/sys-utils/nsenter.1
+++ b/sys-utils/nsenter.1
@@ -150,7 +150,7 @@ any children will also be in the newly entered PID namespace.
Display version information and exit.
.TP
\fB\-h\fR, \fB\-\-help\fR
-Display a help message and exit.
+Display help text and exit.
.SH SEE ALSO
.BR setns (2),
.BR clone (2)
diff --git a/sys-utils/pivot_root.8 b/sys-utils/pivot_root.8
index e2609728a..525eb438e 100644
--- a/sys-utils/pivot_root.8
+++ b/sys-utils/pivot_root.8
@@ -35,10 +35,10 @@ shell's root or not).
.SH OPTIONS
.TP
\fB\-V\fR, \fB\-\-version\fR
-Output version information and exit.
+Display version information and exit.
.TP
\fB\-h\fR, \fB\-\-help\fR
-Display help and exit.
+Display help text and exit.
.SH EXAMPLES
Change the root file system to /dev/hda1 from an interactive shell:
.sp
diff --git a/sys-utils/prlimit.1 b/sys-utils/prlimit.1
index 262319953..95bc87607 100644
--- a/sys-utils/prlimit.1
+++ b/sys-utils/prlimit.1
@@ -47,7 +47,7 @@ Specify the process id, if none is given, it will use the running process.
Define the output columns to use. If no output arrangement is specified, then a default set is used.
Use \fB\-\-help\fP to get list of all supported columns.
.IP "\fB\-V, \-\-version\fP"
-Output version information and exit.
+Display version information and exit.
.IP "\fB\-\-verbose\fP"
Verbose mode.
.IP "\fB\-\-raw\fP"
@@ -55,7 +55,7 @@ Use the raw output format.
.IP "\fB\-\-noheadings\fP"
Do not print a header line.
.IP "\fB\-h, \-\-help\fP"
-Print a help text and exit.
+Display help text and exit.
.SH RESOURCE OPTIONS
.IP "\fB\-c, \-\-core\fP[=limits]"
diff --git a/sys-utils/readprofile.8 b/sys-utils/readprofile.8
index ec1c22634..f4e4dd53c 100644
--- a/sys-utils/readprofile.8
+++ b/sys-utils/readprofile.8
@@ -86,12 +86,10 @@ the second is the name of the function, the third is the number of
clock ticks and the last is the normalized load.
.TP
\fB\-V\fR, \fB\-\-version\fR
-This makes
-.B readprofile
-print its version number and exit.
+Display version information and exit.
.TP
\fB\-h\fR, \fB\-\-help\fR
-Display help and exit.
+Display help text and exit.
.SH EXAMPLES
Browse the profiling buffer ordering by clock ticks:
.nf
diff --git a/sys-utils/renice.1 b/sys-utils/renice.1
index f90ebe22b..538687e34 100644
--- a/sys-utils/renice.1
+++ b/sys-utils/renice.1
@@ -73,10 +73,10 @@ Force the succeeding arguments to be interpreted as process IDs
(the default).
.TP
.BR \-h , " \-\-help"
-Display a help text.
+Display help text and exit.
.TP
.BR \-V , " \-\-version"
-Display version information.
+Display version information and exit.
.SH EXAMPLES
The following command would change the priority of the processes with
PIDs 987 and 32, plus all processes owned by the users daemon and root:
diff --git a/sys-utils/rtcwake.8 b/sys-utils/rtcwake.8
index def3faaef..02ab5cc15 100644
--- a/sys-utils/rtcwake.8
+++ b/sys-utils/rtcwake.8
@@ -47,14 +47,14 @@ appropriate for such suspend modes.
Be verbose.
.TP
\fB-h\fP | \fB--help\fP
-Display a short help message that shows how to use the program.
+Display help text and exit.
.TP
\fB-V\fP | \fB--version\fP
-Displays version information and exists.
+Display version information and exit.
.TP
\fB-n\fP | \fB--dry-run\fP
-This option does everything but actually setup alarm, suspend system or wait
-for the alarm.
+This option does everything apart from actually setting up the alarm,
+suspending the system, or waiting for the alarm.
.TP
\fB-A\fP | \fB--adjfile\fP \fIfile\fP
Specifies an alternative path to the adjust file.
diff --git a/sys-utils/setarch.8 b/sys-utils/setarch.8
index ea885c4ba..f8c748fbe 100644
--- a/sys-utils/setarch.8
+++ b/sys-utils/setarch.8
@@ -27,10 +27,11 @@ is /bin/sh.
Be verbose.
.TP
\fB\-h\fR, \fB\-\-help\fR
-Display help (it is also displayed when setarch takes no arguments).
+Display help text and exit.
+(The help text is also displayed when \fBsetarch\fR receives no arguments.)
.TP
\fB\-V\fR, \fB\-\-version\fR
-Output version information and exit.
+Display version information and exit.
.TP
\fB\-\-uname\-2.6\fR
Causes the program to see a kernel version number beginning with 2.6.
diff --git a/sys-utils/setpriv.1 b/sys-utils/setpriv.1
index 89cd60cf5..62467ad6b 100644
--- a/sys-utils/setpriv.1
+++ b/sys-utils/setpriv.1
@@ -123,7 +123,7 @@ to fail at AppArmor's whim.
Display version information and exit.
.TP
\fB\-h\fR, \fB\-\-help\fR
-Display help and exit.
+Display help text and exit.
.SH NOTES
If applying any specified option fails,
.I program
diff --git a/sys-utils/swapon.8 b/sys-utils/swapon.8
index d2f1bc51a..f30dd9bdb 100644
--- a/sys-utils/swapon.8
+++ b/sys-utils/swapon.8
@@ -120,7 +120,7 @@ match that of the current running kernel.
initializes the whole device and does not check for bad blocks.
.TP
.B \-h, \-\-help
-Provide help.
+Display help text and exit.
.TP
.B "\-L \fIlabel\fP"
Use the partition that has the specified
@@ -176,7 +176,7 @@ Use the partition that has the specified
Be verbose.
.TP
.B "\-V, \-\-version"
-Display version.
+Display version information and exit.
.SH NOTES
You should not use
.B swapon
diff --git a/sys-utils/switch_root.8 b/sys-utils/switch_root.8
index debf0c87d..e61dba627 100644
--- a/sys-utils/switch_root.8
+++ b/sys-utils/switch_root.8
@@ -24,9 +24,9 @@ process.
.SH OPTIONS
.IP "\fB\-h, \-\-help\fP"
-show help and exit
+Display help text and exit.
.IP "\fB\-V, \-\-version\fP"
-show version number and exit
+Display version information and exit.
.SH RETURN VALUE
.B switch_root
diff --git a/sys-utils/umount.8 b/sys-utils/umount.8
index d8afe1f45..2f3679db2 100644
--- a/sys-utils/umount.8
+++ b/sys-utils/umount.8
@@ -138,10 +138,10 @@ to specify the file system types on which no action should be taken.
Verbose mode.
.TP
\fB\-h\fR, \fB\-\-help\fR
-Print help message and exit.
+Display help text and exit.
.TP
\fB\-V\fR, \fB\-\-version\fR
-Print version and exit.
+Display version information and exit.
.SH "THE LOOP DEVICE"
The
.B umount
diff --git a/sys-utils/unshare.1 b/sys-utils/unshare.1
index dfd418919..d88b07344 100644
--- a/sys-utils/unshare.1
+++ b/sys-utils/unshare.1
@@ -44,7 +44,7 @@ See \fBclone\fR(2) for the exact semantics of the flags.
.SH OPTIONS
.TP
.BR \-h , " \-\-help"
-Display a help message and exit.
+Display help text and exit.
.TP
.BR \-i , " \-\-ipc"
Unshare the IPC namespace.
diff --git a/sys-utils/wdctl.8 b/sys-utils/wdctl.8
index 0c9a3acdb..61ba5c30d 100644
--- a/sys-utils/wdctl.8
+++ b/sys-utils/wdctl.8
@@ -36,14 +36,14 @@ output arrangement is specified, then a default set is used. Use
to get list of all supported columns.
.IP "\fB\-O\fR, \fB\-\-oneline\fP"
Print all wanted information on one line in key="value" output format.
-.IP "\fB\-V\fR, \fB\-\-version\fP"
-Output version information and exit.
.IP "\fB\-r\fR, \fB\-\-raw\fP"
Use the raw output format.
.IP "\fB\-x\fR, \fB\-\-flags-only\fP"
Same as \fB\-I \-T\fP.
.IP "\fB\-h\fR, \fB\-\-help\fP"
-Print a help text and exit.
+Display help text and exit.
+.IP "\fB\-V\fR, \fB\-\-version\fP"
+Display version information and exit.
.SH AUTHORS
.MT kzak@\:redhat\:.com
Karel Zak