From: Tobias Stoeckmann Date: Tue, 7 Apr 2026 16:49:21 +0000 (+0200) Subject: man: Avoid conditional ENVIRONMENT descriptions X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f32ac8560e3b3985bb8f3f075cfb3851db067705;p=thirdparty%2Futil-linux.git man: Avoid conditional ENVIRONMENT descriptions Describe what the variable does directly to avoid conditional statements. Signed-off-by: Tobias Stoeckmann --- diff --git a/disk-utils/fsck.8.adoc b/disk-utils/fsck.8.adoc index 37e863ab9..f96609161 100644 --- a/disk-utils/fsck.8.adoc +++ b/disk-utils/fsck.8.adoc @@ -130,13 +130,13 @@ Please note that *fsck* is not designed to pass arbitrarily complicated options == ENVIRONMENT *FSCK_FORCE_ALL_PARALLEL*:: -If this environment variable is set, *fsck* will attempt to check all of the specified filesystems in parallel, regardless of whether the filesystems appear to be on the same device. (This is useful for RAID systems or high-end storage systems such as those sold by companies such as IBM or EMC.) Note that the _fs_passno_ value is still used. +Check all of the specified filesystems in parallel, regardless of whether the filesystems appear to be on the same device. (This is useful for RAID systems or high-end storage systems such as those sold by companies such as IBM or EMC.) Note that the _fs_passno_ value is still used. *FSCK_MAX_INST*:: -This environment variable will limit the maximum number of filesystem checkers that can be running at one time. This allows configurations which have a large number of disks to avoid *fsck* starting too many filesystem checkers at once, which might overload CPU and memory resources available on the system. If this value is zero, then an unlimited number of processes can be spawned. This is currently the default, but future versions of *fsck* may attempt to automatically determine how many filesystem checks can be run based on gathering accounting data from the operating system. +Limit the maximum number of filesystem checkers that can be running at one time. This allows configurations which have a large number of disks to avoid *fsck* starting too many filesystem checkers at once, which might overload CPU and memory resources available on the system. If this value is zero, then an unlimited number of processes can be spawned. This is currently the default, but future versions of *fsck* may attempt to automatically determine how many filesystem checks can be run based on gathering accounting data from the operating system. *FSTAB_FILE*:: -This environment variable allows the system administrator to override the standard location of the _/etc/fstab_ file. It is also useful for developers who are testing *fsck*. +Override the standard location of the _/etc/fstab_ file. *LIBBLKID_DEBUG=all*:: Enable libblkid debug output. @@ -145,7 +145,7 @@ Enable libblkid debug output. Enable libmount debug output. *PATH*:: -The *PATH* environment variable is used to find filesystem checkers. +Used to find filesystem checkers. == FILES diff --git a/lib/terminal-colors.d.5.adoc b/lib/terminal-colors.d.5.adoc index 9e56a8b74..c48ddec02 100644 --- a/lib/terminal-colors.d.5.adoc +++ b/lib/terminal-colors.d.5.adoc @@ -190,7 +190,7 @@ Any other use of the hash character is not interpreted as introducing a comment. == ENVIRONMENT *NO_COLOR*:: -If defined, this disables output colorization unless explicitly enabled by a +Disable output colorization unless explicitly enabled by a command-line option. See https://no-color.org/ for more details. Supported since util-linux version 2.41. diff --git a/login-utils/sulogin.8.adoc b/login-utils/sulogin.8.adoc index 52b749dc0..04429105d 100644 --- a/login-utils/sulogin.8.adoc +++ b/login-utils/sulogin.8.adoc @@ -66,7 +66,11 @@ include::man-common/help-version.adoc[] == ENVIRONMENT -*sulogin* looks for the environment variable *SUSHELL* or *sushell* to determine what shell to start. If the environment variable is not set, it will try to execute root's shell from _/etc/passwd_. If that fails, it will fall back to _/bin/sh_. +*SUSHELL*:: +Specify the shell to start. Overrides *sushell*. + +*sushell*:: +Specify the shell to start. If the environment variable is not set, it will try to execute root's shell from _/etc/passwd_. If that fails, it will fall back to _/bin/sh_. == AUTHORS diff --git a/login-utils/vipw.8.adoc b/login-utils/vipw.8.adoc index 4cfe306dc..03b42a35b 100644 --- a/login-utils/vipw.8.adoc +++ b/login-utils/vipw.8.adoc @@ -63,7 +63,7 @@ include::man-common/help-version.adoc[] == ENVIRONMENT *EDITOR*:: -The editor specified by the string *EDITOR* will be invoked instead of the default editor *vi*(1). +Override the standard editor *vi*(1). == HISTORY diff --git a/misc-utils/blkid.8.adoc b/misc-utils/blkid.8.adoc index 8ea98f07b..27bbbf106 100644 --- a/misc-utils/blkid.8.adoc +++ b/misc-utils/blkid.8.adoc @@ -174,7 +174,8 @@ Defines LABEL and UUID evaluation method(s). Currently, the libblkid library sup == ENVIRONMENT -Setting _LIBBLKID_DEBUG=all_ enables debug output. +*LIBBLKID_DEBUG*=all:: +Enable libblkid debug output. == AUTHORS diff --git a/misc-utils/getopt.1.adoc b/misc-utils/getopt.1.adoc index f0c3fffa9..13aa9c6a4 100644 --- a/misc-utils/getopt.1.adoc +++ b/misc-utils/getopt.1.adoc @@ -139,7 +139,7 @@ Example scripts for (ba)sh and (t)csh are provided with the *getopt*(1) distribu Force *getopt* to use the first calling format as specified in the *SYNOPSIS*. *POSIXLY_CORRECT*:: -This environment variable is examined by the *getopt*(3) routines. If it is set, parsing stops as soon as a parameter is found that is not an option or an option argument. All remaining parameters are also interpreted as non-option parameters, regardless whether they start with a '*-*'. +Examined by the *getopt*(3) routines. If it is set, parsing stops as soon as a parameter is found that is not an option or an option argument. All remaining parameters are also interpreted as non-option parameters, regardless whether they start with a '*-*'. == BUGS diff --git a/misc-utils/look.1.adoc b/misc-utils/look.1.adoc index bdc791929..8a81c0952 100644 --- a/misc-utils/look.1.adoc +++ b/misc-utils/look.1.adoc @@ -81,7 +81,7 @@ The *look* utility exits 0 if one or more lines were found and displayed, 1 if n == ENVIRONMENT *WORDLIST*:: -Path to a dictionary file. The environment variable has greater priority than the dictionary path defined in the *FILES* segment. +Override the standard location of the dictionary file. == FILES diff --git a/sys-utils/hwclock.8.adoc b/sys-utils/hwclock.8.adoc index 850717177..556811fe9 100644 --- a/sys-utils/hwclock.8.adoc +++ b/sys-utils/hwclock.8.adoc @@ -372,10 +372,10 @@ The operation failed or the command syntax was not valid. == ENVIRONMENT *TZ*:: -If this variable is set its value takes precedence over the system configured timezone. +Override the system configured timezone. *TZDIR*:: -If this variable is set its value takes precedence over the system configured timezone database directory path. +Override the default location of timezone database directory. == FILES diff --git a/sys-utils/mount.8.adoc b/sys-utils/mount.8.adoc index 166e54033..65b5902a6 100644 --- a/sys-utils/mount.8.adoc +++ b/sys-utils/mount.8.adoc @@ -1757,7 +1757,7 @@ Enable libblkid debug output. Enable libmount debug output. *LIBMOUNT_FORCE_MOUNT2*={always|never|auto}:: -Force to use classic *mount*(2) system call (requires support for new file descriptors based mount API). The default is *auto*; in this case, libmount tries to be smart and use classic *mount*(2) only for well-known issues. If the new mount API is unavailable, libmount can still use traditional *mount*(2), although LIBMOUNT_FORCE_MOUNT2 is set to *never*. +Force usage of classic *mount*(2) system call (requires support for new file descriptors based mount API). The default is *auto*; in this case, libmount tries to be smart and use classic *mount*(2) only for well-known issues. If the new mount API is unavailable, libmount can still use traditional *mount*(2), although LIBMOUNT_FORCE_MOUNT2 is set to *never*. *LIBMOUNT_FSTAB*=:: Override the default location of the _fstab_ file (ignored for suid). diff --git a/term-utils/script.1.adoc b/term-utils/script.1.adoc index 762508071..67b8f8130 100644 --- a/term-utils/script.1.adoc +++ b/term-utils/script.1.adoc @@ -133,7 +133,7 @@ Upon receiving *SIGUSR1*, *script* immediately flushes the output files. Enable script debug output. *SHELL*:: -If the variable *SHELL* exists, the shell forked by *script* will be that shell. If *SHELL* is not set, the Bourne shell is assumed. (Most shells set this variable automatically). +Override the default shell. If *SHELL* is not set, the Bourne shell is assumed. (Most shells set this variable automatically). *ULPTY_DEBUG*=all:: Enable pty debug output. diff --git a/text-utils/column.1.adoc b/text-utils/column.1.adoc index c03d61d6f..2bb34ccf0 100644 --- a/text-utils/column.1.adoc +++ b/text-utils/column.1.adoc @@ -255,7 +255,7 @@ will be colorized by direct color names. == ENVIRONMENT *COLUMNS*:: -Is used to determine the size of the screen if no other information is available. +Specify the size of the screen if no other information is available. include::man-common/env-smartcols.adoc[] diff --git a/text-utils/more.1.adoc b/text-utils/more.1.adoc index 5dd260311..f023bb2dc 100644 --- a/text-utils/more.1.adoc +++ b/text-utils/more.1.adoc @@ -176,10 +176,10 @@ Start up an editor. == ENVIRONMENT *EDITOR*:: -The editor of choice when *VISUAL* is not specified. +Override the default editor when *VISUAL* is not specified. *MORE*:: -This variable may be set with favored options to *more*. +Specify favored options for *more*. *MORESECURE*:: Run *more* in "secure" mode. See SECURITY for details. @@ -194,13 +194,13 @@ Equivalent to MORESECURE. Disable exit-on-eof (see option *-e* for more details). *SHELL*:: -Current shell in use (normally set by the shell at login time). +Override the default shell. *TERM*:: -The terminal type used by *more* to get the terminal characteristics necessary to manipulate the screen. +Specify the terminal type used by *more* to get the terminal characteristics necessary to manipulate the screen. *VISUAL*:: -The editor the user prefers. Invoked when command key _v_ is pressed. +Override the default editor to use when command key _v_ is pressed. == HISTORY diff --git a/text-utils/pg.1.adoc b/text-utils/pg.1.adoc index 9c6a8914c..78728c882 100644 --- a/text-utils/pg.1.adoc +++ b/text-utils/pg.1.adoc @@ -128,10 +128,10 @@ See *locale*(7). Override the system-supplied number of lines if set. *SHELL*:: -Used by the *!* command. +Override the default shell to use for the *!* command. *TERM*:: -Determine the terminal type. +Specify the terminal type. == NOTES diff --git a/text-utils/ul.1.adoc b/text-utils/ul.1.adoc index 126d02bdd..096688dc6 100644 --- a/text-utils/ul.1.adoc +++ b/text-utils/ul.1.adoc @@ -67,7 +67,7 @@ include::man-common/help-version.adoc[] == ENVIRONMENT *TERM*:: -The *TERM* variable is used to relate a tty device with its device capability description (see *terminfo*(5)). *TERM* is set at login time, either by the default terminal type specified in _/etc/ttys_ or as set during the login process by the user in their _login_ file (see *setenv*(3)). +Relate a tty device with its device capability description (see *terminfo*(5)). *TERM* is set at login time, either by the default terminal type specified in _/etc/ttys_ or as set during the login process by the user in their _login_ file (see *setenv*(3)). == HISTORY