From: Mario Blättermann Date: Tue, 23 Mar 2021 19:07:15 +0000 (+0100) Subject: Asciidoc: Review misc-utils man pages X-Git-Tag: v2.37-rc1~34^2~32 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=2c646c80d84daa24d51004893d2f585ac3ea80f6;p=thirdparty%2Futil-linux.git Asciidoc: Review misc-utils man pages --- diff --git a/misc-utils/blkid.8.adoc b/misc-utils/blkid.8.adoc index 30fc807693..819f03095d 100644 --- a/misc-utils/blkid.8.adoc +++ b/misc-utils/blkid.8.adoc @@ -7,6 +7,7 @@ :man source: util-linux {release-version} :page-layout: base :command: blkid +:underscore: _ == NAME @@ -16,7 +17,7 @@ blkid - locate/print block device attributes *blkid* *--label* _label_ | *--uuid* _uuid_ -*blkid* [*--no-encoding* *--garbage-collect* *--list-one* *--cache-file* _file_] [*--output* _format_][*--match-tag* _tag_] [*--match-token* _NAME=value_] [_device_...] +*blkid* [*--no-encoding* *--garbage-collect* *--list-one* *--cache-file* _file_] [*--output* _format_][*--match-tag* _tag_] [*--match-token* _NAME=value_] [_device_...] *blkid* *--probe* [*--offset* _offset_] [*--output* _format_] [*--size* _size_] [*--match-tag* _tag_] [*--match-types* _list_] [*--usages* _list_] [*--no-part-details*] _device_... @@ -43,104 +44,105 @@ For security reasons *blkid* silently ignores all devices where the probing resu The _size_ and _offset_ arguments may be followed by the multiplicative suffixes like KiB (=1024), 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. *-c*, *--cache-file* _cachefile_:: - Read from _cachefile_ instead of reading from the default cache file (see the CONFIGURATION FILE section for more details). If you want to start with a clean cache (i.e., don't report devices previously scanned but not necessarily available at this time), specify _/dev/null_. +Read from _cachefile_ instead of reading from the default cache file (see the CONFIGURATION FILE section for more details). If you want to start with a clean cache (i.e., don't report devices previously scanned but not necessarily available at this time), specify _/dev/null_. *-d*, *--no-encoding*:: - Don't encode non-printing characters. The non-printing characters are encoded by ^ and M- notation by default. Note that the *--output udev* output format uses a different encoding which cannot be disabled. +Don't encode non-printing characters. The non-printing characters are encoded by ^ and M- notation by default. Note that the *--output udev* output format uses a different encoding which cannot be disabled. *-D*, *--no-part-details*:: - Don't print information (PART_ENTRY_* tags) from partition table in low-level probing mode. +Don't print information (PART_ENTRY_* tags) from partition table in low-level probing mode. *-g*, *--garbage-collect*:: - Perform a garbage collection pass on the blkid cache to remove devices which no longer exist. +Perform a garbage collection pass on the blkid cache to remove devices which no longer exist. *-h*, *--help*:: - Display a usage message and exit. +Display a usage message and exit. *-i*, *--info*:: - Display information about I/O Limits (aka I/O topology). The 'export' output format is automatically enabled. This option can be used together with the *--probe* option. +Display information about I/O Limits (aka I/O topology). The 'export' output format is automatically enabled. This option can be used together with the *--probe* option. *-k*, *--list-filesystems*:: - List all known filesystems and RAIDs and exit. +List all known filesystems and RAIDs and exit. *-l*, *--list-one*:: - Look up only one device that matches the search parameter specified with the *--match-token* option. If there are multiple devices that match the specified search parameter, then the device with the highest priority is returned, and/or the first device found at a given priority (but see below note about udev). Device types in order of decreasing priority are: Device Mapper, EVMS, LVM, MD, and finally regular block devices. If this option is not specified, *blkid* will print all of the devices that match the search parameter. + - {nbsp} + - This option forces *blkid* to use udev when used for LABEL or UUID tokens in *--match-token*. The goal is to provide output consistent with other utils (like *mount*(8), etc.) on systems where the same tag is used for multiple devices. +Look up only one device that matches the search parameter specified with the *--match-token* option. If there are multiple devices that match the specified search parameter, then the device with the highest priority is returned, and/or the first device found at a given priority (but see below note about udev). Device types in order of decreasing priority are: Device Mapper, EVMS, LVM, MD, and finally regular block devices. If this option is not specified, *blkid* will print all of the devices that match the search parameter. ++ +This option forces *blkid* to use udev when used for LABEL or UUID tokens in *--match-token*. The goal is to provide output consistent with other utils (like *mount*(8), etc.) on systems where the same tag is used for multiple devices. *-L*, *--label* _label_:: - Look up the device that uses this filesystem _label_; this is equal to **--list-one --output device --match-token LABEL=**__label__. This lookup method is able to reliably use /dev/disk/by-label udev symlinks (dependent on a setting in _/etc/blkid.conf_). Avoid using the symlinks directly; it is not reliable to use the symlinks without verification. The *--label* option works on systems with and without udev. + - {nbsp} + - Unfortunately, the original *blkid*(8) from e2fsprogs uses the *-L* option as a synonym for *-o list*. For better portability, use **-l -o device -t LABEL=**__label__ and *-o list* in your scripts rather than the *-L* option. +Look up the device that uses this filesystem _label_; this is equal to **--list-one --output device --match-token LABEL=**__label__. This lookup method is able to reliably use /dev/disk/by-label udev symlinks (dependent on a setting in _/etc/blkid.conf_). Avoid using the symlinks directly; it is not reliable to use the symlinks without verification. The *--label* option works on systems with and without udev. ++ +Unfortunately, the original *blkid*(8) from e2fsprogs uses the *-L* option as a synonym for *-o list*. For better portability, use **-l -o device -t LABEL=**__label__ and *-o list* in your scripts rather than the *-L* option. *-n*, *--match-types* _list_:: - Restrict the probing functions to the specified (comma-separated) _list_ of superblock types (names). The list items may be prefixed with "no" to specify the types which should be ignored. For example: + - {nbsp} + - *blkid --probe --match-types vfat,ext3,ext4 /dev/sda1* + - {nbsp} + - probes for vfat, ext3 and ext4 filesystems, and + - {nbsp} + - *blkid --probe --match-types nominix /dev/sda1* + - {nbsp} + - probes for all supported formats except minix filesystems. This option is only useful together with *--probe*. +Restrict the probing functions to the specified (comma-separated) _list_ of superblock types (names). The list items may be prefixed with "no" to specify the types which should be ignored. For example: ++ +*blkid --probe --match-types vfat,ext3,ext4 /dev/sda1* ++ +probes for vfat, ext3 and ext4 filesystems, and ++ +*blkid --probe --match-types nominix /dev/sda1* ++ +probes for all supported formats except minix filesystems. This option is only useful together with *--probe*. *-o*, *--output* _format_:: - Use the specified output format. Note that the order of variables and devices is not fixed. See also option *-s*. The _format_ parameter may be: + - {nbsp} + - *full*;; - print all tags (the default) - *value*;; - print the value of the tags - *list*;; - print the devices in a user-friendly format; this output format is unsupported for low-level probing (*--probe* or *--info*). + - {nbsp} + - This output format is *DEPRECATED* in favour of the *lsblk*(8) command. - *device*;; - print the device name only; this output format is always enabled for the *--label* and *--uuid* options - *udev*;; - print key="value" pairs for easy import into the udev environment; the keys are prefixed by ID_FS_ or ID_PART_ prefixes. The value may be modified to be safe for udev environment; allowed is plain ASCII, hex-escaping and valid UTF-8, everything else (including whitespaces) is replaced with '+++_+++'. The keys with __ENC_ postfix use hex-escaping for unsafe chars. + - {nbsp} + - The udev output returns the ID_FS_AMBIVALENT tag if more superblocks are detected, and ID_PART_ENTRY_* tags are always returned for all partitions including empty partitions. + - {nbsp} + - This output format is *DEPRECATED*. - *export*;; - print key=value pairs for easy import into the environment; this output format is automatically enabled when I/O Limits (*--info* option) are requested. + - {nbsp} + - The non-printing characters are encoded by ^ and M- notation and all potentially unsafe characters are escaped. +Use the specified output format. Note that the order of variables and devices is not fixed. See also option *-s*. The _format_ parameter may be: ++ +*full*;; +print all tags (the default) +*value*;; +print the value of the tags +*list*;; +print the devices in a user-friendly format; this output format is unsupported for low-level probing (*--probe* or *--info*). ++ +This output format is *DEPRECATED* in favour of the *lsblk*(8) command. +*device*;; +print the device name only; this output format is always enabled for the *--label* and *--uuid* options +*udev*;; +//TRANSLATORS: Please keep {underscore} untranslated. +print key="value" pairs for easy import into the udev environment; the keys are prefixed by ID_FS_ or ID_PART_ prefixes. The value may be modified to be safe for udev environment; allowed is plain ASCII, hex-escaping and valid UTF-8, everything else (including whitespaces) is replaced with '{underscore}'. The keys with __ENC_ postfix use hex-escaping for unsafe chars. ++ +The udev output returns the ID_FS_AMBIVALENT tag if more superblocks are detected, and ID_PART_ENTRY_* tags are always returned for all partitions including empty partitions. ++ +This output format is *DEPRECATED*. +*export*;; +print key=value pairs for easy import into the environment; this output format is automatically enabled when I/O Limits (*--info* option) are requested. ++ +The non-printing characters are encoded by ^ and M- notation and all potentially unsafe characters are escaped. *-O*, *--offset* _offset_:: - Probe at the given _offset_ (only useful with *--probe*). This option can be used together with the *--info* option. +Probe at the given _offset_ (only useful with *--probe*). This option can be used together with the *--info* option. *-p*, *--probe*:: - Switch to low-level superblock probing mode (bypassing the cache). + - {nbsp} + - Note that low-level probing also returns information about partition table type (PTTYPE tag) and partitions (PART_ENTRY_* tags). The tag names produced by low-level probing are based on names used internally by libblkid and it may be different than when executed without *--probe* (for example PART_ENTRY_UUID= vs PARTUUID=). See also *--no-part-details*. +Switch to low-level superblock probing mode (bypassing the cache). ++ +Note that low-level probing also returns information about partition table type (PTTYPE tag) and partitions (PART_ENTRY_* tags). The tag names produced by low-level probing are based on names used internally by libblkid and it may be different than when executed without *--probe* (for example PART_ENTRY_UUID= vs PARTUUID=). See also *--no-part-details*. *-s*, *--match-tag* _tag_:: - For each (specified) device, show only the tags that match _tag_. It is possible to specify multiple *--match-tag* options. If no tag is specified, then all tokens are shown for all (specified) devices. In order to just refresh the cache without showing any tokens, use *--match-tag none* with no other options. +For each (specified) device, show only the tags that match _tag_. It is possible to specify multiple *--match-tag* options. If no tag is specified, then all tokens are shown for all (specified) devices. In order to just refresh the cache without showing any tokens, use *--match-tag none* with no other options. *-S*, *--size* _size_:: - Override the size of device/file (only useful with *--probe*). +Override the size of device/file (only useful with *--probe*). *-t*, *--match-token* _NAME=value_:: - Search for block devices with tokens named _NAME_ that have the value _value_, and display any devices which are found. Common values for _NAME_ include *TYPE*, *LABEL*, and *UUID*. If there are no devices specified on the command line, all block devices will be searched; otherwise only the specified devices are searched. +Search for block devices with tokens named _NAME_ that have the value _value_, and display any devices which are found. Common values for _NAME_ include *TYPE*, *LABEL*, and *UUID*. If there are no devices specified on the command line, all block devices will be searched; otherwise only the specified devices are searched. *-u*, *--usages* _list_:: - Restrict the probing functions to the specified (comma-separated) _list_ of "usage" types. Supported usage types are: filesystem, raid, crypto and other. The list items may be prefixed with "no" to specify the usage types which should be ignored. For example: + - {nbsp} + - *blkid --probe --usages filesystem,other /dev/sda1* + - {nbsp} + - probes for all filesystem and other (e.g., swap) formats, and + - {nbsp} + - *blkid --probe --usages noraid /dev/sda1* + - {nbsp} + - probes for all supported formats except RAIDs. This option is only useful together with *--probe*. +Restrict the probing functions to the specified (comma-separated) _list_ of "usage" types. Supported usage types are: filesystem, raid, crypto and other. The list items may be prefixed with "no" to specify the usage types which should be ignored. For example: ++ +*blkid --probe --usages filesystem,other /dev/sda1* ++ +probes for all filesystem and other (e.g., swap) formats, and ++ +*blkid --probe --usages noraid /dev/sda1* ++ +probes for all supported formats except RAIDs. This option is only useful together with *--probe*. *-U*, *--uuid* _uuid_:: - Look up the device that uses this filesystem _uuid_. For more details see the *--label* option. +Look up the device that uses this filesystem _uuid_. For more details see the *--label* option. *-V*, *--version*:: - Display version number and exit. +Display version number and exit. == EXIT STATUS @@ -157,13 +159,13 @@ If an ambivalent probing result was detected by low-level probing mode (*-p*), a The standard location of the _/etc/blkid.conf_ config file can be overridden by the environment variable BLKID_CONF. The following options control the libblkid library: _SEND_UEVENT=_:: - Sends uevent when _/dev/disk/by-{label,uuid,partuuid,partlabel}/_ symlink does not match with LABEL, UUID, PARTUUID or PARTLABEL on the device. Default is "yes". +Sends uevent when _/dev/disk/by-{label,uuid,partuuid,partlabel}/_ symlink does not match with LABEL, UUID, PARTUUID or PARTLABEL on the device. Default is "yes". _CACHE_FILE=_:: - Overrides the standard location of the cache file. This setting can be overridden by the environment variable *BLKID_FILE*. Default is _/run/blkid/blkid.tab_, or _/etc/blkid.tab_ on systems without a _/run_ directory. +Overrides the standard location of the cache file. This setting can be overridden by the environment variable *BLKID_FILE*. Default is _/run/blkid/blkid.tab_, or _/etc/blkid.tab_ on systems without a _/run_ directory. _EVALUATE=_:: - Defines LABEL and UUID evaluation method(s). Currently, the libblkid library supports the "udev" and "scan" methods. More than one method may be specified in a comma-separated list. Default is "udev,scan". The "udev" method uses udev _/dev/disk/by-*_ symlinks and the "scan" method scans all block devices from the _/proc/partitions_ file. +Defines LABEL and UUID evaluation method(s). Currently, the libblkid library supports the "udev" and "scan" methods. More than one method may be specified in a comma-separated list. Default is "udev,scan". The "udev" method uses udev _/dev/disk/by-*_ symlinks and the "scan" method scans all block devices from the _/proc/partitions_ file. == ENVIRONMENT diff --git a/misc-utils/cal.1.adoc b/misc-utils/cal.1.adoc index 2e0e43590c..d87331ae66 100644 --- a/misc-utils/cal.1.adoc +++ b/misc-utils/cal.1.adoc @@ -42,6 +42,7 @@ SUCH DAMAGE. :man source: util-linux {release-version} :page-layout: base :command: cal +:plus: + == NAME @@ -66,79 +67,80 @@ Optionally, either the proleptic Gregorian calendar or the Julian calendar may b == OPTIONS *-1*, *--one*:: - Display single month output. (This is the default.) +Display single month output. (This is the default.) *-3*, *--three*:: - Display three months spanning the date. +Display three months spanning the date. *-n , --months* _number_:: - Display _number_ of months, starting from the month containing the date. +Display _number_ of months, starting from the month containing the date. *-S, --span*:: - Display months spanning the date. +Display months spanning the date. *-s*, *--sunday*:: - Display Sunday as the first day of the week. +Display Sunday as the first day of the week. *-m*, *--monday*:: - Display Monday as the first day of the week. +Display Monday as the first day of the week. *-v*, *--vertical*:: - Display using a vertical layout (aka *ncal*(1) mode). +Display using a vertical layout (aka *ncal*(1) mode). *--iso*:: - Display the proleptic Gregorian calendar exclusively. This option does not affect week numbers and the first day of the week. See *--reform* below. +Display the proleptic Gregorian calendar exclusively. This option does not affect week numbers and the first day of the week. See *--reform* below. *-j*, *--julian*:: - Use day-of-year numbering for all calendars. These are also called ordinal days. Ordinal days range from 1 to 366. This option does not switch from the Gregorian to the Julian calendar system, that is controlled by the *--reform* option. + - {nbsp} + - Sometimes Gregorian calendars using ordinal dates are referred to as Julian calendars. This can be confusing due to the many date related conventions that use Julian in their name: (ordinal) julian date, julian (calendar) date, (astronomical) julian date, (modified) julian date, and more. This option is named julian, because ordinal days are identified as julian by the POSIX standard. However, be aware that *cal* also uses the Julian calendar system. See *DESCRIPTION* above. +Use day-of-year numbering for all calendars. These are also called ordinal days. Ordinal days range from 1 to 366. This option does not switch from the Gregorian to the Julian calendar system, that is controlled by the *--reform* option. ++ +Sometimes Gregorian calendars using ordinal dates are referred to as Julian calendars. This can be confusing due to the many date related conventions that use Julian in their name: (ordinal) julian date, julian (calendar) date, (astronomical) julian date, (modified) julian date, and more. This option is named julian, because ordinal days are identified as julian by the POSIX standard. However, be aware that *cal* also uses the Julian calendar system. See *DESCRIPTION* above. *--reform* _val_:: - This option sets the adoption date of the Gregorian calendar reform. Calendar dates previous to reform use the Julian calendar system. Calendar dates after reform use the Gregorian calendar system. The argument _val_ can be: + - {nbsp} + - * _1752_ - sets 3 September 1752 as the reform date (default). This is when the Gregorian calendar reform was adopted by the British Empire. - * _gregorian_ - display Gregorian calendars exclusively. This special placeholder sets the reform date below the smallest year that *cal* can use; meaning all calendar output uses the Gregorian calendar system. This is called the proleptic Gregorian calendar, because dates prior to the calendar system's creation use extrapolated values. - * _iso_ - alias of _gregorian_. The ISO 8601 standard for the representation of dates and times in information interchange requires using the proleptic Gregorian calendar. - * _julian_ - display Julian calendars exclusively. This special placeholder sets the reform date above the largest year that *cal* can use; meaning all calendar output uses the Julian calendar system. +This option sets the adoption date of the Gregorian calendar reform. Calendar dates previous to reform use the Julian calendar system. Calendar dates after reform use the Gregorian calendar system. The argument _val_ can be: ++ +* _1752_ - sets 3 September 1752 as the reform date (default). This is when the Gregorian calendar reform was adopted by the British Empire. +* _gregorian_ - display Gregorian calendars exclusively. This special placeholder sets the reform date below the smallest year that *cal* can use; meaning all calendar output uses the Gregorian calendar system. This is called the proleptic Gregorian calendar, because dates prior to the calendar system's creation use extrapolated values. +* _iso_ - alias of _gregorian_. The ISO 8601 standard for the representation of dates and times in information interchange requires using the proleptic Gregorian calendar. +* _julian_ - display Julian calendars exclusively. This special placeholder sets the reform date above the largest year that *cal* can use; meaning all calendar output uses the Julian calendar system. -See *­DESCRIPTION* above. +See *DESCRIPTION* above. *-y*, *--year*:: - Display a calendar for the whole year. +Display a calendar for the whole year. *-Y, --twelve*:: - Display a calendar for the next twelve months. +Display a calendar for the next twelve months. *-w*, *--week*[=_number_]:: - Display week numbers in the calendar (US or ISO-8601). See NOTES section for more details. +Display week numbers in the calendar (US or ISO-8601). See NOTES section for more details. *--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. +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. *-V*, *--version*:: - Display version information and exit. +Display version information and exit. *-h*, *--help*:: - Display help text and exit. +Display help text and exit. == PARAMETERS *Single digits-only parameter (e.g., 'cal 2020')*:: - Specifies the _year_ to be displayed; note the year must be fully specified: *cal 89* will not display a calendar for 1989. +Specifies the _year_ to be displayed; note the year must be fully specified: *cal 89* will not display a calendar for 1989. *Single string parameter (e.g., 'cal tomorrow' or 'cal August')*:: - Specifies _timestamp_ or a _month name_ (or abbreviated name) according to the current locales. + - {nbsp} + - The special placeholders are accepted when parsing timestamp, "now" may be used to refer to the current time, "today", "yesterday", "tomorrow" refer to of the current day, the day before or the next day, respectively. + - {nbsp} + - The relative date specifications are also accepted, in this case "+" is evaluated to the current time plus the specified time span. Correspondingly, a time span that is prefixed with "-" is evaluated to the current time minus the specified time span, for example '+2days'. Instead of prefixing the time span with "+" or "-", it may also be suffixed with a space and the word "left" or "ago" (for example '1 week ago'). +Specifies _timestamp_ or a _month name_ (or abbreviated name) according to the current locales. ++ +The special placeholders are accepted when parsing timestamp, "now" may be used to refer to the current time, "today", "yesterday", "tomorrow" refer to of the current day, the day before or the next day, respectively. ++ +The relative date specifications are also accepted, in this case "{plus}" is evaluated to the current time plus the specified time span. Correspondingly, a time span that is prefixed with "-" is evaluated to the current time minus the specified time span, for example '{plus}2days'. Instead of prefixing the time span with "{plus}" or "-", it may also be suffixed with a space and the word "left" or "ago" (for example '1 week ago'). +//TRANSLATORS: Please keep {plus} untranslated. *Two parameters (e.g., 'cal 11 2020')*:: - Denote the _month_ (1 - 12) and _year_. +Denote the _month_ (1 - 12) and _year_. *Three parameters (e.g., 'cal 25 11 2020')*:: - Denote the _day_ (1-31), _month and year_, and the day will be highlighted if the calendar is displayed on a terminal. If no parameters are specified, the current month's calendar is displayed. +Denote the _day_ (1-31), _month and year_, and the day will be highlighted if the calendar is displayed on a terminal. If no parameters are specified, the current month's calendar is displayed. == NOTES diff --git a/misc-utils/fincore.1.adoc b/misc-utils/fincore.1.adoc index 8d91ce97a1..3ad7826a1d 100644 --- a/misc-utils/fincore.1.adoc +++ b/misc-utils/fincore.1.adoc @@ -10,6 +10,7 @@ This file may be copied under the terms of the GNU Public License. :man source: util-linux {release-version} :page-layout: base :command: fincore +:plus: + == NAME @@ -28,25 +29,26 @@ The default output is subject to change. So whenever possible, you should avoid == OPTIONS *-n*, *--noheadings*:: - Do not print a header line in status output. +Do not print a header line in status output. *-b*, *--bytes*:: - Print the SIZE column in bytes rather than in a human-readable format. +Print the SIZE column in bytes rather than in a human-readable format. *-o*, *--output* _list_:: - Define output columns. See the *--help* output to get a list of the currently supported columns. The default list of columns may be extended if _list_ is specified in the format _+list_. +Define output columns. See the *--help* output to get a list of the currently supported columns. The default list of columns may be extended if _list_ is specified in the format _{plus}list_. +//TRANSLATORS: Keep {plus} untranslated. *-r*, *--raw*:: - Produce output in raw format. All potentially unsafe characters are hex-escaped (BSOLx). +Produce output in raw format. All potentially unsafe characters are hex-escaped (\x). *-J*, *--json*:: - Use JSON output format. +Use JSON output format. *-V*, *--version*:: - Display version information and exit. +Display version information and exit. *-h*, *--help*:: - Display help text and exit. +Display help text and exit. == AUTHORS diff --git a/misc-utils/findfs.8.adoc b/misc-utils/findfs.8.adoc index 2a634782d6..4d877b8f45 100644 --- a/misc-utils/findfs.8.adoc +++ b/misc-utils/findfs.8.adoc @@ -20,17 +20,17 @@ findfs - find a filesystem by label or UUID *findfs* will search the block devices in the system looking for a filesystem or partition with specified tag. The currently supported tags are: -*LABEL=