[PATCH 4/7] docs,usage: harmonize description of --hyperlink, and add 2 missing ones
Benno Schulenberg <[email protected]>
| Newsgroups | org.kernel.vger.util-linux |
|---|---|
| Message-ID | <[email protected]> |
Also, consistently use _when_/<when> as the optional argument, since the possible values are: "always", "never", "auto". Signed-off-by: Benno Schulenberg <[email protected]> --- lsfd-cmd/lsfd.1.adoc | 6 ++++-- lsfd-cmd/lsfd.c | 2 +- misc-utils/findmnt.8.adoc | 9 ++++----- misc-utils/findmnt.c | 2 ++ misc-utils/lsblk.8.adoc | 6 ++++-- misc-utils/lsblk.c | 2 ++ 6 files changed, 17 insertions(+), 10 deletions(-) diff --git a/lsfd-cmd/lsfd.1.adoc b/lsfd-cmd/lsfd.1.adoc index b0ba2ba53..db228a09e 100644 --- a/lsfd-cmd/lsfd.1.adoc +++ b/lsfd-cmd/lsfd.1.adoc @@ -110,8 +110,10 @@ 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. +*--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. *-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 3610de8dd..847a0ac8a 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 <name>:<expr> define custom counter for --summary output\n"), out); fputs(_(" --dump-counters dump counter definitions\n"), out); - fputs(_(" --hyperlink[=<when>] print paths as terminal hyperlinks (always|never|auto)\n"), out); + fputs(_(" --hyperlink[=<when>] print paths as hyperlinks (always|never|auto)\n"), out); fputs(_(" --summary[=<mode>] print summary information (append|only|never)\n"), out); fputs(_(" --_drop-privilege (testing purpose) do setuid(1) just after starting\n"), out); diff --git a/misc-utils/findmnt.8.adoc b/misc-utils/findmnt.8.adoc index a26fb8ca2..025a311e9 100644 --- a/misc-utils/findmnt.8.adoc +++ b/misc-utils/findmnt.8.adoc @@ -67,11 +67,10 @@ 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. +*--hyperlink*[**=**_when_]:: +Print mountpoint 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. *-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 86258dfd3..862f00c63 100644 --- a/misc-utils/findmnt.c +++ b/misc-utils/findmnt.c @@ -1567,6 +1567,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[=<when>]\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..0e9734247 100644 --- a/misc-utils/lsblk.8.adoc +++ b/misc-utils/lsblk.8.adoc @@ -62,8 +62,10 @@ 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. +*--hyperlink*[**=**_when_]:: +Print mountpoint 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. *-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 9f252d079..128217d62 100644 --- a/misc-utils/lsblk.c +++ b/misc-utils/lsblk.c @@ -2329,6 +2329,8 @@ static void __attribute__((__noreturn__)) usage(void) fputs(_(" -d, --nodeps don't print slaves or holders\n"), out); fputs(_(" -e, --exclude <list> exclude devices by major number (default: RAM disks)\n"), out); fputs(_(" -f, --fs output info about filesystems\n"), out); + fputs(_(" --hyperlink[=<when>]\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); -- 2.48.1