]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
man: Document debug environment variables
authorTobias Stoeckmann <tobias@stoeckmann.org>
Thu, 2 Apr 2026 15:31:03 +0000 (17:31 +0200)
committerTobias Stoeckmann <tobias@stoeckmann.org>
Tue, 7 Apr 2026 08:33:57 +0000 (10:33 +0200)
Document all debug environment variables affecting the tool. These
variables have an effect if the debug init function is called.

Signed-off-by: Tobias Stoeckmann <tobias@stoeckmann.org>
17 files changed:
disk-utils/partx.8.adoc
login-utils/runuser.1.adoc
login-utils/su.1.adoc
lsfd-cmd/lsfd.1.adoc
misc-utils/lsblk.8.adoc
sys-utils/blkdiscard.8.adoc
sys-utils/chcpu.8.adoc
sys-utils/chmem.8.adoc
sys-utils/fstrim.8.adoc
sys-utils/losetup.8.adoc
sys-utils/lscpu.1.adoc
sys-utils/lsmem.1.adoc
sys-utils/zramctl.8.adoc
term-utils/agetty.8.adoc
term-utils/script.1.adoc
term-utils/scriptlive.1.adoc
term-utils/scriptreplay.1.adoc

index 76fe726639c55d462c657ef034f9bc7357dd14fb..a11a5948b0578c441b6230ccf10aa70be38bc5f6 100644 (file)
@@ -107,6 +107,9 @@ enables libblkid debug output.
 
 include::man-common/env-smartcols.adoc[]
 
+*LOOPDEV_DEBUG*=all::
+enables loopdev debug output.
+
 == EXAMPLE
 
 partx --show /dev/sdb3::
index 808ab55f748acfb6ba53b180a135de9dc5e3f478..197b9761581f90c98a2734d131e4fe61a3621091 100644 (file)
@@ -119,6 +119,13 @@ The requested command could not be executed
 127::
 The requested command was not found
 
+== ENVIRONMENT
+
+*SU_DEBUG*=all::
+enables su debug output.
+
+*ULPTY_DEBUG*=all::
+enables pty debug output.
 
 == FILES
 
index 0c5845caeabcb7a1ba3c41c00d4eff34fd4a82d3..27672eb33db3d67787534b253c4cc765b9e4feae 100644 (file)
@@ -132,6 +132,14 @@ The requested command could not be executed
 127::
 The requested command was not found
 
+== ENVIRONMENT
+
+*SU_DEBUG*=all::
+enables su debug output.
+
+*ULPTY_DEBUG*=all::
+enables pty debug output.
+
 == FILES
 
 _/etc/pam.d/su_::
index a00afa93a3265dcecf72892af1fa0844eb05b69c..17ad23740cb5e3c473288b00586ca3a05e0bc885 100644 (file)
@@ -124,6 +124,9 @@ include::man-common/help-version.adoc[]
 
 include::man-common/env-smartcols.adoc[]
 
+*LSFD_DEBUG*=all::
+enables lsfd debug output.
+
 == OUTPUT COLUMNS
 
 Each column has a type. Types are surround by < and >.
index 16dce6537fc6ca4b9c62057cdf5e5cd9bb73c339..12ff6f3c15cf92cf5620822a222dc4545507d84d 100644 (file)
@@ -236,6 +236,9 @@ include::man-common/env-smartcols.adoc[]
 *LSBLK_COLUMNS*=::
 specifies a comma-separated list of output columns to print. All columns listed by *--list-columns* can be used.
 
+*ULPATH_DEBUG*=all::
+enables *path* debug output.
+
 == NOTES
 
 For partitions, some information (e.g., queue attributes) is inherited from the parent device.
index 1ae4c5fa050e0325c350687af720951e2ef25bc5..a466aed8da4dadf7f285683a794e216a04bfdf66 100644 (file)
@@ -69,6 +69,11 @@ failure; incorrect invocation, permissions or any other generic error
 *2*::
 failure; since v2.39, the device does not support discard operation
 
+== ENVIRONMENT
+
+*LIBBLKID_DEBUG*=all::
+enables libblkid debug output.
+
 == AUTHORS
 
 mailto:lczerner@redhat.com[Lukas Czerner],
index f08b5a6abf058d043d2dea29b5ac045cbeaf22f0..1980b1ade6a19bfa494bef12e3ac5d24b862f343 100644 (file)
@@ -69,6 +69,11 @@ failure
 *64*::
 partial success
 
+== ENVIRONMENT
+
+*ULPATH_DEBUG*=all::
+enables path debug output.
+
 == AUTHORS
 
 mailto:heiko.carstens@de.ibm.com[Heiko Carstens]
index 537beec63a208992ebd3d13fa6c70c02e4c0e0e3..324bf55ebe2b38cb5036ca59d41958f260cfeb2e 100644 (file)
@@ -89,6 +89,11 @@ failure
 *64*::
 partial success
 
+== ENVIRONMENT
+
+*ULPATH_DEBUG*=all::
+enables path debug output.
+
 == EXAMPLES
 
 *chmem --enable 1024*::
index a756546b1794f351571385709fe5cc00e2d84607..fbedb7d0e3e5a38aeeab053546e6c04fcdbaecd7 100644 (file)
@@ -84,6 +84,14 @@ some filesystem discards have succeeded, some failed
 
 The command *fstrim --all* returns 0 (all succeeded), 32 (all failed) or 64 (some failed, some succeeded).
 
+== ENVIRONMENT
+
+*LIBMOUNT_DEBUG*=all::
+enables libmount debug output.
+
+*ULPATH_DEBUG*=all::
+enables path debug output.
+
 == AUTHORS
 mailto:lczerner@redhat.com[Lukas Czerner],
 mailto:kzak@redhat.com[Karel Zak]
index b6b9900588ae039f3e1f6cf1cf7430ac4b1fbad2..74586d3d8af29cff15f34cefc0a400961147d800 100644 (file)
@@ -154,7 +154,13 @@ Since version 2.37 *losetup* uses *LOOP_CONFIGURE* ioctl to set up a new loop de
 == ENVIRONMENT
 
 *LOOPDEV_DEBUG*=all::
-enables debug output.
+enables loopdev debug output.
+
+*ULPATH_DEBUG*=all::
+enables path debug output.
+
+*ULSYSFS_DEBUG*=all::
+enables sysfs debug output.
 
 include::man-common/env-smartcols.adoc[]
 
index a222c7c8d36881e8bd9938ede27618c9dacc7d6b..1fd1573425d02a3b324757d811416166fc71af3b 100644 (file)
@@ -131,8 +131,14 @@ Specifies a comma-separated list of output columns to print. All columns listed
 LSCPU_CACHES_COLUMNS=::
 Same as *LSCPU_COLUMNS* with the difference that columns only listed for the *-C* option can be used.
 
+*LSCPU_DEBUG*=all::
+enables lscpu debug output.
+
 include::man-common/env-smartcols.adoc[]
 
+*ULPATH_DEBUG*=all::
+enables path debug output.
+
 == COLUMNS
 
 A list of valid column labels can be viewed with the *--list-columns* option.
index a84d6b0f4ecce9eba39a33aabccc9feee254ad21..dd9b16d2440e6131dc52d8b03a635ded2b3242b6 100644 (file)
@@ -106,6 +106,9 @@ Specifies a comma-separated list of output columns to print. All columns listed
 
 include::man-common/env-smartcols.adoc[]
 
+*ULPATH_DEBUG*=all::
+enables path debug output.
+
 == AUTHORS
 
 *lsmem* was originally written by Gerald Schaefer for s390-tools in Perl. The C version for util-linux was written by Clemens von Mann, Heiko Carstens and Karel Zak.
index 8cede321711145c1369996b15080945ce44d870e..43ccedd175ec9a88d493669017a95b7b6a16bab9 100644 (file)
@@ -92,6 +92,12 @@ include::man-common/help-version.adoc[]
 
 include::man-common/env-smartcols.adoc[]
 
+*ULPATH_DEBUG*=all::
+enables path debug output.
+
+*ULSYSFS_DEBUG*=all::
+enables sysfs debug output.
+
 == FILES
 
 _/dev/zram[0..N]_::
index 6670498f55aaea3c2a7a3c03b782cb8763d4382b..87abaaaf1dd35e6b221013f214fbad98be528ac6 100644 (file)
@@ -195,6 +195,14 @@ The following configuration items are relevant for *agetty*:
 
 Tell *agetty* that printing the hostname should be suppressed in the login: prompt. This is an alternative to the *--nohostname* command line option. The default value is _no_.
 
+== ENVIRONMENT
+
+*ULNETADDRQ_DEBUG*=all::
+enables netaddrq debug output.
+
+*ULNETLINK_DEBUG*=all::
+enables netlink debug output.
+
 == EXAMPLE
 
 This section shows examples for the process field of an entry in the _/etc/inittab_ file. You'll have to prepend appropriate values for the other fields. See *inittab*(5) for more details.
index 1bff4245796ec7141c910aa365e3a567ad7b6b7b..ca5c053b57f1bca215208fdc2cd3b7969708e036 100644 (file)
@@ -131,9 +131,15 @@ Upon receiving *SIGUSR1*, *script* immediately flushes the output files.
 
 The following environment variable is utilized by *script*:
 
+*SCRIPT_DEBUG*=all::
+enables 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).
 
+*ULPTY_DEBUG*=all::
+enables pty debug output.
+
 == NOTES
 
 The script ends when the forked shell exits (a _control-D_ for the Bourne shell (*sh*(1p)), and _exit_, _logout_ or _control-d_ (if _ignoreeof_ is not set) for the C-shell, *csh*(1)).
index 626a1f20bc12d831e4b0b96b7742d7dac42ae4e3..e0047c59a3c03fc487c2cb40ab104131acc5de03 100644 (file)
@@ -64,6 +64,14 @@ Set the maximum delay between updates to _number_ of seconds. The argument is a
 
 include::man-common/help-version.adoc[]
 
+== ENVIRONMENT
+
+*SCRIPTREPLAY_DEBUG*=all::
+enables scriptreplay debug output.
+
+*ULPTY_DEBUG*=all::
+enables pty debug output.
+
 == EXAMPLES
 
 ....
index deabb7b1665fe1d69867d2e48d7b7cfbed7324c2..64923a270b1eb3df373e52a160ddbe8afc637ba7 100644 (file)
@@ -78,6 +78,11 @@ data.
 
 include::man-common/help-version.adoc[]
 
+== ENVIRONMENT
+
+*SCRIPTREPLAY_DEBUG*=all::
+enables scriptreplay debug output.
+
 == EXAMPLES
 
 ....