]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
various: (man) list --help and --version last among the options
authorBenno Schulenberg <bensberg@telfort.nl>
Sun, 16 Mar 2025 15:20:39 +0000 (16:20 +0100)
committerKarel Zak <kzak@redhat.com>
Mon, 17 Mar 2025 09:51:32 +0000 (10:51 +0100)
Almost all util-linux man pages mention -h/--help and -V/--version
last in the list of options.  Make the few deviant pages conform.

Signed-off-by: Benno Schulenberg <bensberg@telfort.nl>
disk-utils/cfdisk.8.adoc
disk-utils/fdisk.8.adoc
disk-utils/swaplabel.8.adoc
misc-utils/hardlink.1.adoc
misc-utils/look.1.adoc
misc-utils/lsblk.8.adoc
misc-utils/uuidgen.1.adoc
sys-utils/eject.1.adoc
sys-utils/lsmem.1.adoc
text-utils/bits.1.adoc
text-utils/rev.1.adoc

index 5ab560a4a5c8567ed43be40b1ce67722cf729e9b..0075fd472fd8a7f8cdd2fee728497243d6fb3e0e 100644 (file)
@@ -44,8 +44,6 @@ If you want to remove an old partition table from a device, use *wipefs*(8).
 
 == OPTIONS
 
-include::man-common/help-version.adoc[]
-
 *-L*, *--color*[**=**__when__]::
 Colorize the output. The optional argument _when_ can be *auto*, *never* or *always*. If the _when_ argument is omitted, it defaults to *auto*. The colors can be disabled, for the current built-in default see *--help* output. See also the *COLORS* section.
 
@@ -61,6 +59,8 @@ Specify the sector size of the disk. Valid values are 512, 1024, 2048, and 4096.
 *-z*, *--zero*::
 Start with an in-memory zeroed partition table. This option does not zero the partition table on the disk; rather, it simply starts the program without reading the existing partition table. This option allows you to create a new partition table from scratch or from an *sfdisk*(8)-compatible script.
 
+include::man-common/help-version.adoc[]
+
 == COMMANDS
 
 The commands for *cfdisk* can be entered by pressing the corresponding key (pressing _Enter_ after the command is not necessary). Here is a list of the available commands:
index 1644f7bd9e02f7ee1758555a1b99b0ab6af143d2..c18c382730d23ebd50dfb8bfc1c41ec211305032 100644 (file)
@@ -48,8 +48,6 @@ Don't erase the beginning of the first disk sector when creating a new disk labe
 *-c*, *--compatibility*[**=**_mode_]::
 Specify the compatibility mode, 'dos' or 'nondos'. The default is non-DOS mode. For backward compatibility, it is possible to use the option without the _mode_ argument -- then the default is used. Note that the optional _mode_ argument cannot be separated from the *-c* option by a space, the correct form is for example *-c*=_dos_.
 
-include::man-common/help-version.adoc[]
-
 *-L*, *--color*[**=**_when_]::
 Colorize the output. The optional argument _when_ can be *auto*, *never* or *always*. If the _when_ argument is omitted, it defaults to *auto*. The colors can be disabled; for the current built-in default see the *--help* output. See also the *COLORS* section.
 
@@ -97,8 +95,7 @@ Wipe filesystem, RAID and partition-table signatures from the device, in order t
 *-W*, *--wipe-partitions* _when_::
 Wipe filesystem, RAID and partition-table signatures from a newly created partitions, in order to avoid possible collisions. The argument _when_ can be *auto*, *never* or *always*. When this option is not given, the default is *auto*, in which case signatures are wiped only when in interactive mode and after confirmation by user. In all cases detected signatures are reported by warning messages before a new partition is created. See also *wipefs*(8) command.
 
-*-V*, *--version*::
-Display version information and exit.
+include::man-common/help-version.adoc[]
 
 == DEVICES
 
index de440d39465c11b964d97a9533ee45452f7ec965..0a1a1136fc03b5d40f258fb1ce9eabe679203560 100644 (file)
@@ -28,14 +28,14 @@ If an optional argument is present, then *swaplabel* will change the appropriate
 
 == OPTIONS
 
-include::man-common/help-version.adoc[]
-
 *-L*, *--label* _label_::
   Specify a new _label_ for the device. Swap partition labels can be at most 16 characters long. If _label_ is longer than 16 characters, *swaplabel* will truncate it and print a warning message.
 
 *-U*, *--uuid* _UUID_::
   Specify a new _UUID_ for the device. The _UUID_ must be in the standard 8-4-4-4-12 character format, such as is output by *uuidgen*(1).
 
+include::man-common/help-version.adoc[]
+
 == ENVIRONMENT
 
 LIBBLKID_DEBUG=all::
index 98b29a3b39b3e7c29b865234555be9ace4440113..e09572f6c0f0300ead7ac706954e38c63fba5df2 100644 (file)
@@ -40,8 +40,6 @@ are very often different from the beginning.
 
 == OPTIONS
 
-include::man-common/help-version.adoc[]
-
 *-c*, *--content*::
 Consider only file content, not attributes, when determining whether two files are equal. Same as *-pot*.
 
@@ -146,6 +144,7 @@ only reflinks are allowed.
 *--skip-reflinks*::
 Ignore already cloned files. This option may be used without *--reflink* when creating classic hardlinks.
 
+include::man-common/help-version.adoc[]
 
 == ARGUMENTS
 
index 35b8978bccf32d6eac5df462c5771ed30963c9ab..0ef71ece302f64a778d11700be5f979251b6d091 100644 (file)
@@ -72,6 +72,8 @@ Specify a string termination character, i.e., only the characters in _string_ up
 
 include::man-common/help-version.adoc[]
 
+== EXIT STATUS
+
 The *look* utility exits 0 if one or more lines were found and displayed, 1 if no lines were found, and >1 if an error occurred.
 
 == ENVIRONMENT
index a67eb292eb0baf3f51c877a85a8f7d5ae4a48df1..7a0a15d3a6b2688c2e08c03f3416acbe6a58118e 100644 (file)
@@ -166,8 +166,6 @@ Output info about block-device topology. This option is equivalent to
 +
 *-o NAME,ALIGNMENT,MIN-IO,OPT-IO,PHY-SEC,LOG-SEC,ROTA,SCHED,RQ-SIZE,RA,WSAME*.
 
-include::man-common/help-version.adoc[]
-
 *-w*, *--width* _number_::
 Specifies output width as a number of characters. The default is the number of the terminal columns, and if not executed on a terminal, then output width is not restricted at all by default. This option also forces *lsblk* to assume that terminal control characters and unsafe characters are not allowed. The expected use-case is for example when *lsblk* is used by the *watch*(1) command.
 
@@ -197,6 +195,8 @@ Reads data from a file. This method is only used if the --sysroot option is spec
 *none*;;
 Does not probe. This method always stops probing.
 
+include::man-common/help-version.adoc[]
+
 == EXIT STATUS
 
 0::
index 1d89fe43d63963105183c1020a0e2ee1cdd17f02..e061d8a9486c4e5c6c0874f699bd795365393701 100644 (file)
@@ -34,8 +34,6 @@ Generate a random-based UUID. This method creates a UUID consisting mostly of ra
 *-t*, *--time*::
 Generate a time-based UUID. This method creates a UUID based on the system clock plus the system's ethernet hardware address, if present.
 
-include::man-common/help-version.adoc[]
-
 *-m*, *--md5*::
 Use MD5 as the hash algorithm.
 
@@ -60,6 +58,8 @@ Generate multiple UUIDs using the enhanced capability of the libuuid to cache ti
 *-x*, *--hex*::
 Interpret name _name_ as a hexadecimal string.
 
+include::man-common/help-version.adoc[]
+
 == CONFORMING TO
 
 OSF DCE 1.1
index dd99ae524a4562515c10b86bd61aa1597ef3e108..52988601dcf755b9c12f1e930dcc7ccbc62a2a0f 100644 (file)
@@ -79,8 +79,6 @@ With this option the drive is given a CD-ROM tray close command if it's opened,
 *-t*, *--trayclose*::
 With this option the drive is given a CD-ROM tray close command. Not all devices support this command.
 
-include::man-common/help-version.adoc[]
-
 *-v*, *--verbose*::
 Run in verbose mode; more information is displayed about what the command is doing.
 
@@ -90,6 +88,8 @@ With this option the CD-ROM drive will be probed to detect the available speeds.
 *-x*, *--cdspeed* _speed_::
 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 for maximum data rate. Not all devices support this command and you can only specify speeds that the drive is capable of. Every time the media is changed this option is cleared. This option can be used alone, or with the *-t* and *-c* options.
 
+include::man-common/help-version.adoc[]
+
 == EXIT STATUS
 
 Returns 0 if operation was successful, 1 if operation failed or command syntax was not valid.
index 3e5577ee76cf2f7d7e1bdc9e98ef4fb19ad93215..337c8b4b7534b58c63bd58e82b94be9c331d3ac9 100644 (file)
@@ -60,11 +60,11 @@ Specify which columns (attributes) use to split memory blocks to ranges. The sup
 *-s*, *--sysroot* _directory_::
 Gather memory data for a Linux instance other than the instance from which the *lsmem* command is issued. The specified _directory_ is the system root of the Linux instance to be inspected.
 
-include::man-common/help-version.adoc[]
-
 *--summary*[**=**_when_]::
 This option controls summary lines output. The optional argument _when_ can be *never*, *always* or *only*. If the _when_ argument is omitted, it defaults to *"only"*. The summary output is suppressed for *--raw*, *--pairs* and *--json*.
 
+include::man-common/help-version.adoc[]
+
 == AUTHORS
 
 *lsmem* was originally written by Gerald Schaefer for s390-tools in Perl. The C version for util-linux was written by Clemens von Mann, Heiko Carstens and Karel Zak.
index 8501bd19c7a8af4aee97a6d572c5b50ac7d20064..0a55583ec0f784aa0d8aa406afc6f3f3624da577 100644 (file)
@@ -67,12 +67,12 @@ groups so far.
 
 == OPTIONS
 
-include::man-common/help-version.adoc[]
-
 *-w* __<NUM>__, *--width* __<NUM>__::
 Maximum number of bits in the masks handled by *bits* (default __8192__). Any
 bit larger than this number will be truncated.
 
+include::man-common/help-version.adoc[]
+
 == CONVERSION MODE
 
 One of the following conversion modes can be specified. If not specified, it
index 3d40273900e4a3a52cfb94a021c8c298ac5609da..1cf375c273e37d0acf43d9e8e7b7d457ee712280 100644 (file)
@@ -56,11 +56,11 @@ This utility is a line-oriented tool and it uses in-memory allocated buffer for
 
 == OPTIONS
 
-include::man-common/help-version.adoc[]
-
 *-0*, *--zero*::
 _Zero termination_. Use the byte '\0' as line separator.
 
+include::man-common/help-version.adoc[]
+
 == SEE ALSO
 
 *tac*(1)