8000 docs,usage: harmonize description of --hyperlink, and add 2 missing ones · util-linux/util-linux@f6531ec · GitHub
[go: up one dir, main page]
Skip to content

Commit f6531ec

Browse files
Benno Schulenbergkarelzak
Benno Schulenberg
authored and
karelzak
committed
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_/<when> (instead of _mode_/<mode>) as the optional argument, since the possible values are: "always", "never", "auto". Signed-off-by: Benno Schulenberg <bensberg@telfort.nl>
1 parent fa6d89e commit f6531ec

File tree

9 files changed

+15
-10
lines changed

9 files changed

+15
-10
lines changed

‎lsfd-cmd/lsfd.1.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,7 @@ only for *lsfd* developers.
109109
*--dump-counters*::
110110
Dump the definition of counters used in *--summary* output.
111111

112-
*--hyperlink*[=_mode_]::
113-
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.
112+
include::man-common/hyperlink.adoc[]
114113

115114
*-H*, *--list-columns*::
116115
List the columns that can be specified with the *--output* option.

‎lsfd-cmd/lsfd.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2196,7 +2196,7 @@ static void __attribute__((__noreturn__)) usage(void)
21962196
fputs(_(" --debug-filter dump the internal data structure of filter and exit\n"), out);
21972197
fputs(_(" -C, --counter <name>:<expr> define custom counter for --summary output\n"), out);
21982198
fputs(_(" --dump-counters dump counter definitions\n"), out);
2199-
fputs(_(" --hyperlink[=<when>] print paths as terminal hyperlinks (always|never|auto)\n"), out);
2199+
fputs(_(" --hyperlink[=<when>] print paths as hyperlinks (always|never|auto)\n"), out);
22002200
fputs(_(" --summary[=<mode>] print summary information (append|only|never)\n"), out);
22012201
fputs(_(" --_drop-privilege (testing purpose) do setuid(1) just after starting\n"), out);
22022202

‎man-common/Makemodule.am

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ ADOCFILES_COMMON += \
55
man-common/footer-config.adoc \
66
man-common/footer-lib.adoc \
77
man-common/help-version.adoc \
8+
man-common/hyperlink.adoc \
89
ma 8000 n-common/in-bytes.adoc \
910
man-common/manpage-stub.adoc \
1011
man-common/translation.adoc

‎man-common/hyperlink.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
*--hyperlink*[**=**_when_]::
2+
Print paths as terminal hyperlinks. The optional _when_ argument can be
3+
*always*, *never*, or *auto*. If the argument is omitted, it defaults to
4+
*auto*, which means that hyperlinks will only be used when the output
5+
goes to a terminal.

‎man-common/meson.build

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ man_common_adocs = files(
55
'footer-config.adoc',
66
'footer-lib.adoc',
77
'help-version.adoc',
8+
'hyperlink.adoc',
89
'in-bytes.adoc',
910
'manpage-stub.adoc',
1011
'translation.adoc',

‎misc-utils/findmnt.8.adoc

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,11 +67,7 @@ Print the first matching filesystem only.
6767
List the columns that can be specified with the *--output* option.
6868
Can be used with *--json* or *--raw* to get the list in a machine-readable format.
6969

70-
*--hyperlink*[**=**_mode_]::
71-
Print mountpoint paths as terminal hyperlinks. The optional _mode_ argument
72-
can be *always*, *never*, or *auto*. If the argument is omitted, it defaults
73-
to *auto*, which means that hyperlinks will only be used when the output goes
74-
to a terminal.
70+
include::man-common/hyperlink.adoc[]
7571

7672
*-I*, *--dfi*::
7773
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.

‎misc-utils/findmnt.c

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1568,6 +1568,8 @@ static void __attribute__((__noreturn__)) usage(void)
15681568
fputs(_(" -D, --df imitate the output of df(1)\n"), out);
15691569
fputs(_(" -e, --evaluate convert tags (LABEL,UUID,PARTUUID,PARTLABEL) \n"
15701570
" to device names\n"), out);
1571+
fputs(_(" --hyperlink[=<when>]\n"
1572+
" print paths as hyperlinks (always|never|auto)\n"), out);
15711573
fputs(_(" -I, --dfi imitate the output of df(1) with -i option\n"), out);
15721574
fputs(_(" -J, --json use JSON output format\n"), out);
15731575
fputs(_(" -l, --list use list format output\n"), out);

‎misc-utils/lsblk.8.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,7 @@ Exclude the devices specified by the comma-separated _list_ of major device numb
6262
*-f*, *--fs*::
6363
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.
6464

65-
*--hyperlink*[**=**_mode_]::
66-
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.
65+
include::man-common/hyperlink.adoc[]
6766

6867
*-I*, *--include* _list_::
6968
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.

‎misc-utils/lsblk.c

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2330,6 +2330,8 @@ static void __attribute__((__noreturn__)) usage(void)
23302330
fputs(_(" -d, --nodeps don't print slaves or holders\n"), out);
23312331
fputs(_(" -e, --exclude <list> exclude devices by major number (default: RAM disks)\n"), out);
23322332
fputs(_(" -f, --fs output info about filesystems\n"), out);
2333+
fputs(_(" --hyperlink[=<when>]\n"
2334+
" print paths as hyperlinks (always|never|auto)\n"), out);
23332335
fputs(_(" -i, --ascii use ascii characters only\n"), out);
23342336
fputs(_(" -l, --list use list format output\n"), out);
23352337
fputs(_(" -m, --perms output info about permissions\n"), out);

0 commit comments

Comments
 (0)
0