From: Benno Schulenberg Date: Sat, 26 Apr 2025 09:30:18 +0000 (+0200) Subject: docs,usage: harmonize description of --hyperlink, and add 2 missing ones X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=f6531ecfd2e9cd2210412f77543a5db1c7952952;p=thirdparty%2Futil-linux.git docs,usage: harmonize description of --hyperlink, and add 2 missing ones Harmonize the description by placing the option in a separate file. Also, use _when_/ (instead of _mode_/) as the optional argument, since the possible values are: "always", "never", "auto". Signed-off-by: Benno Schulenberg --- diff --git a/lsfd-cmd/lsfd.1.adoc b/lsfd-cmd/lsfd.1.adoc index 2654e8eaf..9c4b8a0b5 100644 --- a/lsfd-cmd/lsfd.1.adoc +++ b/lsfd-cmd/lsfd.1.adoc @@ -109,8 +109,7 @@ only for *lsfd* developers. *--dump-counters*:: Dump the definition of counters used in *--summary* output. -*--hyperlink*[=_mode_]:: -Print 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. +include::man-common/hyperlink.adoc[] *-H*, *--list-columns*:: List the columns that can be specified with the *--output* option. diff --git a/lsfd-cmd/lsfd.c b/lsfd-cmd/lsfd.c index 9e9cb52ac..d05a09396 100644 --- a/lsfd-cmd/lsfd.c +++ b/lsfd-cmd/lsfd.c @@ -2196,7 +2196,7 @@ static void __attribute__((__noreturn__)) usage(void) fputs(_(" --debug-filter dump the internal data structure of filter and exit\n"), out); fputs(_(" -C, --counter : define custom counter for --summary output\n"), out); fputs(_(" --dump-counters dump counter definitions\n"), out); - fputs(_(" --hyperlink[=] print paths as terminal hyperlinks (always|never|auto)\n"), out); + fputs(_(" --hyperlink[=] print paths as hyperlinks (always|never|auto)\n"), out); fputs(_(" --summary[=] print summary information (append|only|never)\n"), out); fputs(_(" --_drop-privilege (testing purpose) do setuid(1) just after starting\n"), out); diff --git a/man-common/Makemodule.am b/man-common/Makemodule.am index c999ee7cf..11acb73de 100644 --- a/man-common/Makemodule.am +++ b/man-common/Makemodule.am @@ -5,6 +5,7 @@ ADOCFILES_COMMON += \ man-common/footer-config.adoc \ man-common/footer-lib.adoc \ man-common/help-version.adoc \ + man-common/hyperlink.adoc \ man-common/in-bytes.adoc \ man-common/manpage-stub.adoc \ man-common/translation.adoc diff --git a/man-common/hyperlink.adoc b/man-common/hyperlink.adoc new file mode 100644 index 000000000..dc067490d --- /dev/null +++ b/man-common/hyperlink.adoc @@ -0,0 +1,5 @@ +*--hyperlink*[**=**_when_]:: +Print paths as terminal hyperlinks. The optional _when_ argument can be +*always*, *never*, or *auto*. If the argument is omitted, it defaults to +*auto*, which means that hyperlinks will only be used when the output +goes to a terminal. diff --git a/man-common/meson.build b/man-common/meson.build index 647f54c68..b9fc92730 100644 --- a/man-common/meson.build +++ b/man-common/meson.build @@ -5,6 +5,7 @@ man_common_adocs = files( 'footer-config.adoc', 'footer-lib.adoc', 'help-version.adoc', + 'hyperlink.adoc', 'in-bytes.adoc', 'manpage-stub.adoc', 'translation.adoc', diff --git a/misc-utils/findmnt.8.adoc b/misc-utils/findmnt.8.adoc index a26fb8ca2..8c8ffa2cc 100644 --- a/misc-utils/findmnt.8.adoc +++ b/misc-utils/findmnt.8.adoc @@ -67,11 +67,7 @@ Print the first matching filesystem only. List the columns that can be specified with the *--output* option. Can be used with *--json* or *--raw* to get the list in a machine-readable format. -*--hyperlink*[**=**_mode_]:: -Print mountpoint paths as terminal hyperlinks. The optional _mode_ argument -can be *always*, *never*, or *auto*. If the argument is omitted, it defaults -to *auto*, which means that hyperlinks will only be used when the output goes -to a terminal. +include::man-common/hyperlink.adoc[] *-I*, *--dfi*:: Imitate the output of *df*(1) with its *-i* option. This option is equivalent to *-o SOURCE,FSTYPE,INO.TOTAL,INO.USED,INO.AVAIL,INO.USE%,TARGET* but excludes all pseudo filesystems. Use *--all* to print all filesystems. diff --git a/misc-utils/findmnt.c b/misc-utils/findmnt.c index 2682de1d7..130ac1b13 100644 --- a/misc-utils/findmnt.c +++ b/misc-utils/findmnt.c @@ -1568,6 +1568,8 @@ static void __attribute__((__noreturn__)) usage(void) fputs(_(" -D, --df imitate the output of df(1)\n"), out); fputs(_(" -e, --evaluate convert tags (LABEL,UUID,PARTUUID,PARTLABEL) \n" " to device names\n"), out); + fputs(_(" --hyperlink[=]\n" + " print paths as hyperlinks (always|never|auto)\n"), out); fputs(_(" -I, --dfi imitate the output of df(1) with -i option\n"), out); fputs(_(" -J, --json use JSON output format\n"), out); fputs(_(" -l, --list use list format output\n"), out); diff --git a/misc-utils/lsblk.8.adoc b/misc-utils/lsblk.8.adoc index 8151525af..04efa276c 100644 --- a/misc-utils/lsblk.8.adoc +++ b/misc-utils/lsblk.8.adoc @@ -62,8 +62,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_]:: -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. +include::man-common/hyperlink.adoc[] *-I*, *--include* _list_:: Include devices specified by the comma-separated _list_ of major device numbers. The filter is applied to the top-level devices only. This may be confusing for *--list* output format where hierarchy of the devices is not obvious. diff --git a/misc-utils/lsblk.c b/misc-utils/lsblk.c index 7daa7f58f..a65f5e4e6 100644 --- a/misc-utils/lsblk.c +++ b/misc-utils/lsblk.c @@ -2330,6 +2330,8 @@ static void __attribute__((__noreturn__)) usage(void) fputs(_(" -d, --nodeps don't print slaves or holders\n"), out); fputs(_(" -e, --exclude exclude devices by major number (default: RAM disks)\n"), out); fputs(_(" -f, --fs output info about filesystems\n"), out); + fputs(_(" --hyperlink[=]\n" + " print paths as hyperlinks (always|never|auto)\n"), out); fputs(_(" -i, --ascii use ascii characters only\n"), out); fputs(_(" -l, --list use list format output\n"), out); fputs(_(" -m, --perms output info about permissions\n"), out);