Merge branch 'PR/Benno-text-fixes-w7' of https://github.com/karelzak/…

…util-linux-work

* 'PR/Benno-text-fixes-w7' of https://github.com/karelzak/util-linux-work:
  zramctl: improve grammar in usage and don't gettextize list of algorithms
  usage: mention also the missing KiB and MiB as permissible suffixes
  man pages: use the same verb for --version as for --help, like in usages
  renice: put text that belongs together into a single translatable message
  blkzone: correct the wording of an error message, from ioctl to function
  blkpr: grammarize the description of the tool and its options
  textual: give seven error messages the same form as two others
  unshare: don't mark "|" and ":" as part of the placeholders
  mount: properly mark the arguments of the 'ro' and 'rw' extended options
  textual: consistently mark "=" as literal before an optional argument
  textual: remove other inconsistent uses of "=" before option argument
  unshare: use single asterisks around long options, double around values
  unshare: don't use "=" before a required option argument
  setpriv: make message for failing PR_GET_PDEATHSIG the same as the other

disk-utils/cfdisk.8.adoc

@@ -49,7 +49,7 @@ 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.
 
-*--lock*[=_mode_]::
+*--lock*[**=**_mode_]::
 Use exclusive BSD lock for device or file it operates. The optional argument _mode_ can be *yes*, *no* (or 1 and 0) or *nonblock*. If the _mode_ argument is omitted, it defaults to *yes*. This option overwrites environment variable *$LOCK_BLOCK_DEVICE*. The default is not to use any lock at all, but it's recommended to avoid collisions with *systemd-udevd*(8) or other tools.
 
 *-r*, *--read-only*::

disk-utils/fdisk.8.adoc

@@ -45,12 +45,12 @@ Specify the sector size of the disk. Valid values are 512, 1024, 2048, and 4096.
 *-B*, *--protect-boot*::
 Don't erase the beginning of the first disk sector when creating a new disk label. This feature is supported for GPT and MBR.
 
-*-c*, *--compatibility*[=_mode_]::
+*-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_]::
+*-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.
 
 *-l*, *--list*::
@@ -61,7 +61,7 @@ If no devices are given, the devices mentioned in _/proc/partitions_ (if this fi
 *-x*, *--list-details*::
 Like *--list*, but provides more details.
 
-*--lock*[=_mode_]::
+*--lock*[**=**_mode_]::
 Use exclusive BSD lock for device or file it operates. The optional argument _mode_ can be *yes*, *no* (or 1 and 0) or *nonblock*. If the _mode_ argument is omitted, it defaults to *yes*. This option overwrites environment variable *$LOCK_BLOCK_DEVICE*. The default is not to use any lock at all, but it's recommended to avoid collisions with *systemd-udevd*(8) or other tools.
 
 *-n*, *--noauto-pt*::
@@ -79,7 +79,7 @@ Print the size in 512-byte sectors of each given block device. This option is DE
 *-t*, *--type* _type_::
 Enable support only for disklabels of the specified _type_, and disable support for all other types.
 
-*-u*, *--units*[=_unit_]::
+*-u*, *--units*[**=**_unit_]::
 When listing partition tables, show sizes in 'sectors' or in 'cylinders'. The default is to show sizes in sectors. For backward compatibility, it is possible to use the option without the _unit_ argument -- then the default is used. Note that the optional _unit_ argument cannot be separated from the *-u* option by a space, the correct form is for example '**-u=**__cylinders__'.
 
 *-C*, *--cylinders* _number_::

disk-utils/fsck.cramfs.8.adoc

@@ -26,7 +26,7 @@ Enable verbose messaging.
 *-b*, *--blocksize* _blocksize_::
 Use this blocksize, defaults to page size. Must be equal to what was set at creation time. Only used for *--extract*.
 
-*--extract*[=_directory_]::
+*--extract*[**=**_directory_]::
 Test to uncompress the whole file system. Optionally extract contents of the _file_ to _directory_.
 
 *-a*::

disk-utils/mkfs.bfs.8.adoc

@@ -35,7 +35,7 @@ Specify the volume _label_. I have no idea if/where this is used.
 *-F*, *--fname* _name_::
 Specify the filesystem _name_. I have no idea if/where this is used.
 
-*--lock*[=_mode_]::
+*--lock*[**=**_mode_]::
 Use exclusive BSD lock for device or file it operates. The optional argument _mode_ can be *yes*, *no* (or 1 and 0) or *nonblock*. If the _mode_ argument is omitted, it defaults to *yes*. This option overwrites environment variable *$LOCK_BLOCK_DEVICE*. The default is not to use any lock at all, but it's recommended to avoid collisions with *systemd-udevd*(8) or other tools.
 
 *-v*, *--verbose*::

disk-utils/mkfs.cramfs.8.adoc

@@ -62,7 +62,7 @@ This option is ignored. Originally the *-s* turned on directory entry sorting.
 *-z*::
 Make explicit holes.
 
-*-l*[=_mode_]::
+*-l*[**=**_mode_]::
  Use exclusive BSD lock for device or file it operates.  The optional argument
  _mode_ can be _yes_, _no_ (or 1 and 0) or _nonblock_.  If the _mode_
  argument is omitted, it defaults to _"yes"_.  This option overwrites

disk-utils/mkfs.minix.8.adoc

@@ -46,7 +46,7 @@ Check the device for bad blocks before creating the filesystem. If any are found
 *-n*, *--namelength* _length_::
 Specify the maximum length of filenames. Currently, the only allowable values are 14 and 30 for file system versions 1 and 2. Version 3 allows only value 60. The default is 30.
 
-*--lock*[=_mode_]::
+*--lock*[**=**_mode_]::
 Use exclusive BSD lock for device or file it operates. The optional argument _mode_ can be *yes*, *no* (or 1 and 0) or *nonblock*. If the _mode_ argument is omitted, it defaults to *yes*. This option overwrites environment variable *$LOCK_BLOCK_DEVICE*. The default is not to use any lock at all, but it's recommended to avoid collisions with *systemd-udevd*(8) or other tools.
 
 *-i*, *--inodes* _number_::

disk-utils/mkswap.8.adoc

@@ -57,7 +57,7 @@ Suppress output and warning messages.
 *-L*, *--label* _label_::
 Specify a _label_ for the device, to allow *swapon*(8) by label.
 
-*--lock*[=_mode_]::
+*--lock*[**=**_mode_]::
 Use exclusive BSD lock for device or file it operates. The optional argument _mode_ can be *yes*, *no* (or 1 and 0) or *nonblock*. If the _mode_ argument is omitted, it defaults to *yes*. This option overwrites environment variable *$LOCK_BLOCK_DEVICE*. The default is not to use any lock at all, but it's recommended to avoid collisions with *systemd-udevd*(8) or other tools.
 
 *-p*, *--pagesize* _size_::

disk-utils/sfdisk.8.adoc

@@ -162,7 +162,7 @@ Disable all consistency checking.
 *--Linux*::
 Deprecated and ignored option. Partitioning that is compatible with Linux (and other modern operating systems) is the default.
 
-*--lock*[=_mode_]::
+*--lock*[**=**_mode_]::
 Use exclusive BSD lock for device or file it operates. The optional argument _mode_ can be *yes*, *no* (or 1 and 0) or *nonblock*. If the _mode_ argument is omitted, it defaults to *yes*. This option overwrites environment variable *$LOCK_BLOCK_DEVICE*. The default is not to use any lock at all, but it's recommended to avoid collisions with *systemd-udevd*(8) or other tools.
 
 *-n*, *--no-act*::

include/c.h

@@ -474,8 +474,8 @@ static inline void __attribute__((__noreturn__)) ul_sig_err(int excode, const ch
 
 #define USAGE_ARG_SEPARATOR    "\n"
 #define USAGE_ARG_SIZE(_name) \
-		_(" %s arguments may be followed by the suffixes for\n" \
-		  "   GiB, TiB, PiB, EiB, ZiB, and YiB (the \"iB\" is optional)\n"), _name
+		_(" Values for %s may be followed by a suffix: KiB, MiB,\n" \
+		  " GiB, TiB, PiB, EiB, ZiB, or YiB (where the \"iB\" is optional).\n"), _name
 
 #define USAGE_MAN_TAIL(_man)   _("\nFor more details see %s.\n"), _man
 

login-utils/chfn.1.adoc

@@ -50,10 +50,10 @@ Specify your home phone number.
 Display help text and exit.
 
 *-V*, *--version*::
-Print version and exit. The short options *-V* have been used since version 2.39; old versions use
-deprecated *-v*.
+Display version and exit. (Short option *-V* is used since version 2.39;
+older versions used the now-deprecated *-v*).
 
-include::man-common/help-version.adoc[]
+// Do not include::man-common/help-version.adoc[]  as --help and --version are already given explicitly above.
 
 == CONFIG FILE ITEMS
 

login-utils/chsh.1.adoc

@@ -37,14 +37,14 @@ Specify your login shell.
 Print the list of shells listed in _/etc/shells_ and exit.
 
 *-h*, *--help*::
-Display help text and exit. The short options *-h* have been used since version 2.30; old versions use
-deprecated *-u*.
+Display help text and exit. (Short option *-h* is used since version 2.30;
+older versions used the now-deprecated *-u*).
 
 *-V*, *--version*::
-Print version and exit. The short options *-V* have been used since version 2.39; old versions use
-deprecated *-v*.
+Display version and exit. (Short option *-V* is used since version 2.39;
+older versions used the now-deprecated *-v*).
 
-// Do not include::man-common/help-version.adoc[]  as both -h and -V were already explicitly given above in more detail. 
+// Do not include::man-common/help-version.adoc[]  as both -h and -V are already given explicitly above in more detail.
 
 == VALID SHELLS
 

login-utils/lslogins.1.adoc

@@ -14,7 +14,7 @@ lslogins - display information about known users in the system
 
 == SYNOPSIS
 
-*lslogins* [options] [*-s*|*-u*[=_UID_]] [*-g* _groups_] [*-l* _logins_] [_username_]
+*lslogins* [options] [*-s*|*-u*[**=**_UID_]] [*-g* _groups_] [*-l* _logins_] [_username_]
 
 == DESCRIPTION
 
@@ -46,15 +46,15 @@ Display data about the users' last failed login attempts.
 *-G*, *--supp-groups*::
 Show information about supplementary groups.
 
-*-g*, **--groups**=_groups_::
+*-g*, *--groups* _groups_::
 Only show data of users belonging to _groups_. More than one group may be specified; the list has to be comma-separated. Unknown group names are ignored.
 +
 Note that the relation between user and group may be invisible for the primary group if the user is not explicitly specified as group member (e.g., in _/etc/group_). If the command *lslogins* scans for groups then it uses the groups database only, and the user database with primary GID is not used at all.
 
 *-L*, *--last*::
 Display data containing information about the users' last login sessions.
 
-*-l*, **--logins**=_logins_::
+*-l*, *--logins* _logins_::
 Only show data of users with a login specified in _logins_ (user names or user IDs). More than one login may be specified; the list has to be comma-separated. Unknown login names are ignored.
 
 *-n*, *--newline*::

login-utils/newgrp.c

@@ -219,7 +219,7 @@ int main(int argc, char *argv[])
 
 	if (argc <= optind) {
 		if (setgid(pw_entry->pw_gid) < 0)
-			err(EXIT_FAILURE, _("setgid failed"));
+			err(EXIT_FAILURE, _("setgid() failed"));
 	} else {
 		errno = 0;
 		if (!(gr_entry = getgrnam(argv[optind++]))) {
@@ -231,11 +231,11 @@ int main(int argc, char *argv[])
 		if (!allow_setgid(pw_entry, gr_entry))
 			errx(EXIT_FAILURE, _("permission denied"));
 		if (setgid(gr_entry->gr_gid) < 0)
-			err(EXIT_FAILURE, _("setgid failed"));
+			err(EXIT_FAILURE, _("setgid() failed"));
 	}
 
 	if (setuid(getuid()) < 0)
-		err(EXIT_FAILURE, _("setuid failed"));
+		err(EXIT_FAILURE, _("setuid() failed"));
 
 	fflush(NULL);
 	shell = (pw_entry->pw_shell && *pw_entry->pw_shell ?

login-utils/su.1.adoc

@@ -33,16 +33,16 @@ Since version 2.38 *su* resets process resource limits RLIMIT_NICE, RLIMIT_RTPRI
 
 == OPTIONS
 
-*-c*, **--command**=__command__::
+*-c*, *--command* __command__::
 Pass _command_ to the shell with the *-c* option.
 
 *-f*, *--fast*::
 Pass *-f* to the shell, which may or may not be useful, depending on the shell.
 
-*-g*, **--group**=__group__::
+*-g*, *--group* __group__::
 Specify the primary group. This option is available to the root user only.
 
-*-G*, **--supp-group**=__group__::
+*-G*, *--supp-group* __group__::
 Specify a supplementary group. This option is available to the root user only. The first specified supplementary group is also used as a primary group if the option *--group* is not specified.
 
 *-*, *-l*, *--login*::
@@ -68,7 +68,7 @@ Create a pseudo-terminal for the session. The independent terminal provides bett
 +
 This feature is mostly designed for interactive sessions. If the standard input is not a terminal, but for example a pipe (e.g., *echo "date" | su --pty*), then the *ECHO* flag for the pseudo-terminal is disabled to avoid messy output.
 
-*-s*, **--shell**=__shell__::
+*-s*, *--shell* __shell__::
 Run the specified _shell_ instead of the default. If the target user has a restricted shell (i.e., not listed in _/etc/shells_), the *--shell* option and the *SHELL* environment variables are ignored unless the calling user is root.
 +
 The shell to run is selected according to the following rules, in order:
@@ -85,7 +85,7 @@ Same as *-c*, but do not create a new session. (Discouraged.)
 Do not create a pseudo-terminal, opposite of *--pty* and *-P*.
 Note that running without a pseudo-terminal opens the security risk of privilege escalation through TIOCSTI/TIOCLINUX ioctl command injection.
 
-*-w*, **--whitelist-environment**=__list__::
+*-w*, *--whitelist-environment* __list__::
 Don't reset the environment variables specified in the comma-separated _list_ when clearing the environment for *--login*. The whitelist is ignored for the environment variables *HOME*, *SHELL*, *USER*, *LOGNAME*, and *PATH*.
 
 include::man-common/help-version.adoc[]

man-common/help-version.adoc

@@ -2,4 +2,4 @@
 Display help text and exit.
 
 *-V*, *--version*::
-Print version and exit.
+Display version and exit.

misc-utils/cal.1.adoc

@@ -111,15 +111,15 @@ Display a calendar for the whole year.
 *-Y, --twelve*::
 Display a calendar for the next twelve months.
 
-*-w*, *--week*[=_number_]::
+*-w*, *--week*[**=**_number_]::
 Display week numbers in the calendar according to the US or ISO-8601 format. If
 a _number_ is specified, the requested week will be printed in the desired or
 current year. The _number_ may be overwritten if _day_ and _month_ are also
 specified.
 +
 See the *NOTES* section for more details.
 
-*--color*[=_when_]::
+*--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.
 
 *-c, --columns*=_columns_::

misc-utils/enosys.1.adoc

@@ -38,7 +38,7 @@ List syscalls known to *enosys*.
 *-m*, *--list-ioctl*::
 List ioctls known to *enosys*.
 
-*-d*, *--dump*[=_file_]::
+*-d*, *--dump*[**=**_file_]::
 Dump seccomp bytecode filter to standard output.
 +
 The dump can for example be used by *setpriv --seccomp-filter*.

misc-utils/findmnt.8.adoc

@@ -57,7 +57,7 @@ The search direction, either *forward* or *backward*.
 *-e*, *--evaluate*::
 Convert all tags (LABEL, UUID, PARTUUID, or PARTLABEL) to the corresponding device names for the SOURCE column.  It's an unusual situation, but the same tag may be duplicated (used for more devices). For this purpose, there is SOURCES (pl.) column. This column displays by multi-line cell all devices where the tag is detected by libblkid. This option makes sense for _fstab_ only.
 
-*--hyperlink*[=_mode_]::
+*--hyperlink*[**=**_mode_]::
 Print mountpoint paths as terminal hyperlinks. The _mode_ can be set to "always", "never", or "auto". The optional argument _when_ can be set to "auto", "never", or "always". If the _when_ argument is omitted, it will default to "auto". The "auto" setting means that hyperlinks will only be used if the output is on a terminal.
 
 *-F*, *--tab-file* _path_::

misc-utils/hardlink.1.adoc

@@ -131,7 +131,7 @@ Crypto API is not available. The methods based on checksums are implemented in
 zero-copy way, in this case file contents are not copied to the userspace and all
 calculation is done in kernel.
 
-*--reflink*[=_when_]::
+*--reflink*[**=**_when_]::
 Create copy-on-write clones (aka reflinks) rather than hardlinks. The reflinked files
 share only on-disk data, but the file mode and owner can be different. It's recommended
 to use it with *--ignore-owner* and *--ignore-mode* options. This option implies

misc-utils/lsblk.8.adoc

@@ -61,7 +61,7 @@ Exclude the devices specified by the comma-separated _list_ of major device numb
 *-f*, *--fs*::
 Output info about filesystems. This option is equivalent to *-o NAME,FSTYPE,FSVER,LABEL,UUID,FSAVAIL,FSUSE%,MOUNTPOINTS*. The authoritative information about filesystems and raids is provided by the *blkid*(8) command.
 
-*--hyperlink*[=_mode_]::
+*--hyperlink*[**=**_mode_]::
 Print mountpoint paths as terminal hyperlinks. The _mode_ can be set to "always", "never", or "auto". The optional argument _when_ can be set to "auto", "never", or "always". If the _when_ argument is omitted, it will default to "auto". The "auto" setting means that hyperlinks will only be used if the output is on a terminal.
 
 *-I*, *--include* _list_::

misc-utils/uuidd.8.adoc

@@ -24,7 +24,7 @@ The *uuidd* daemon is used by the UUID library to generate universally unique id
 
 == OPTIONS
 
-*-C*, *--cont-clock*[=_time_]::
+*-C*, *--cont-clock*[**=**_time_]::
 Activate continuous clock handling for time based UUIDs. *uuidd* could use all possible clock values, beginning with the daemon's start time. The optional argument can be used to set a value for the max_clock_offset. This guarantees, that a clock value of a UUID will always be within the range of the max_clock_offset.
 +
 The option *-C* or *--cont-clock* enables the feature with a default max_clock_offset of 2 hours.

misc-utils/wipefs.8.adoc

@@ -40,7 +40,7 @@ Note that by default *wipefs* does not erase nested partition tables on non-whol
 *-a*, *--all*::
 Erase all available signatures. The set of erased signatures can be restricted with the *-t* option.
 
-*-b*, *--backup*[=_dir_]::
+*-b*, *--backup*[**=**_dir_]::
 Create a signature backup to the file _wipefs-<devname>-<offset>.bak_ in _$HOME_ or the directory specified as the optional argument. For more details see the *EXAMPLE* section.
 
 *-f*, *--force*::
@@ -49,7 +49,7 @@ Force erasure, even if the filesystem is mounted. This is required in order to e
 *-J*, *--json*::
 Use JSON output format.
 
-*--lock*[=_mode_]::
+*--lock*[**=**_mode_]::
 Use exclusive BSD lock for device or file it operates. The optional argument _mode_ can be *yes*, *no* (or 1 and 0) or *nonblock*. If the _mode_ argument is omitted, it defaults to *"yes"*. This option overwrites environment variable *$LOCK_BLOCK_DEVICE*. The default is not to use any lock at all, but it's recommended to avoid collisions with udevd or other tools.
 
 *-i*, *--noheadings*::

schedutils/coresched.1.adoc

@@ -67,11 +67,7 @@ The type of the PID whose cookie will be modified. This can be one of three valu
 *-v*, *--verbose*::
 Show extra information when modifying cookies of tasks.
 
-*-h*, *--help*::
-Display help text and exit.
-
-*-V*, *--version*::
-Print version and exit.
+include::man-common/help-version.adoc[]
 
 == EXAMPLES
 Get the core scheduling cookie of the {command} task itself, usually inherited from its parent{colon}::

sys-utils/blkpr.8.adoc

@@ -8,23 +8,24 @@
 
 == NAME
 
-blkpr - run persistent reservations command on a device
+blkpr - run a persistent-reservations command on a device
 
 == SYNOPSIS
 
 *blkpr* [options] _device_
 
 == DESCRIPTION
 
-*blkpr* is used to run persistent reservations command on device that supports Persistent Reservations feature.
+*blkpr* is used to run a persistent-reservations command on a device
+that supports the Persistent Reservations feature.
 
 The _device_ argument is the pathname of the block device.
 
 == OPTIONS
 
 *-c*, *--command* _command_::
-The command of persistent reservations, supported commands are *register*, *reserve*, *release*, *preempt*,
-*preempt-abort*, and *clear*.
+The command for managing persistent reservations. Supported commands are:
+*register*, *reserve*, *release*, *preempt*, *preempt-abort*, and *clear*.
 
 *-k*, *--key* _key_::
 The key the command should operate on.