]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
man: Avoid conditional ENVIRONMENT descriptions
authorTobias Stoeckmann <tobias@stoeckmann.org>
Tue, 7 Apr 2026 16:49:21 +0000 (18:49 +0200)
committerTobias Stoeckmann <tobias@stoeckmann.org>
Thu, 9 Apr 2026 09:09:36 +0000 (11:09 +0200)
Describe what the variable does directly to avoid conditional
statements.

Signed-off-by: Tobias Stoeckmann <tobias@stoeckmann.org>
14 files changed:
disk-utils/fsck.8.adoc
lib/terminal-colors.d.5.adoc
login-utils/sulogin.8.adoc
login-utils/vipw.8.adoc
misc-utils/blkid.8.adoc
misc-utils/getopt.1.adoc
misc-utils/look.1.adoc
sys-utils/hwclock.8.adoc
sys-utils/mount.8.adoc
term-utils/script.1.adoc
text-utils/column.1.adoc
text-utils/more.1.adoc
text-utils/pg.1.adoc
text-utils/ul.1.adoc

index 37e863ab9e467b74a855faf14fd6a676edf65be3..f96609161a609e583ba0184530a5260df2010b84 100644 (file)
@@ -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
 
index 9e56a8b74aea2df30e80e0fff9c472f833734344..c48ddec029a5cd71d21c4f4085fa02f787e6233b 100644 (file)
@@ -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.
 
index 52b749dc0862a9ac069ef5e04421359e2e5ab0f2..04429105de399fcd46ea8305c754e3a1b97b42cf 100644 (file)
@@ -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
 
index 4cfe306dcdacd72082ca72cec3bca022cf75e7a3..03b42a35badd4806b556f85c4963fd293c18f918 100644 (file)
@@ -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
 
index 8ea98f07b20f2b1ec78eb8bfaafabbf28d2a87a8..27bbbf10667545388b21bfaf66bfdf3bf385e606 100644 (file)
@@ -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
 
index f0c3fffa95a6bbff62f9e328d472d2ca0a5187c3..13aa9c6a4714ab8bc40a79ac61557207babb1b13 100644 (file)
@@ -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
 
index bdc7919293c12b045b4d736066e02a1b8713238f..8a81c0952936c5635569732e7af3260594003fff 100644 (file)
@@ -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
 
index 8507171776bcea1ebbdf33ffa8655604b8c5ce1a..556811fe9d0d8a6657221ac33558bfa18707b25d 100644 (file)
@@ -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
 
index 166e540339cb15f33daa2a303c76c9967419d373..65b5902a640a28ab0ff931da802be0662bcc0421 100644 (file)
@@ -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*=<path>::
 Override the default location of the _fstab_ file (ignored for suid).
index 7625080712226838856dfdba138c230d00de1b4b..67b8f81301cad58b984e65e5e47edb1c5e8cd3be 100644 (file)
@@ -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.
index c03d61d6fcf393eb758d9b4ea9a77119eb7ac4c6..2bb34ccf075e7bbac7087e93434cb5c8bdc85922 100644 (file)
@@ -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[]
 
index 5dd260311f4afe455ba31c315f0fb3602d840cab..f023bb2dc4e63c8b3ce6928cc198e5cbde089fc5 100644 (file)
@@ -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
 
index 9c6a8914c4e7e4b188bd5fea6ac3c66714d24fb0..78728c882074643d5832df86725d7bd9d987af22 100644 (file)
@@ -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
 
index 126d02bddc5df1b9e6008d906d5636dda45402ee..096688dc6ca80ac16571308d210ab9a5462055eb 100644 (file)
@@ -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