From: Tobias Stoeckmann Date: Thu, 2 Apr 2026 15:31:03 +0000 (+0200) Subject: man: Document debug environment variables X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a8251fed512ffbef6504058ead96cc7a80c51b58;p=thirdparty%2Futil-linux.git man: Document debug environment variables 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 --- diff --git a/disk-utils/partx.8.adoc b/disk-utils/partx.8.adoc index 76fe72663..a11a5948b 100644 --- a/disk-utils/partx.8.adoc +++ b/disk-utils/partx.8.adoc @@ -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:: diff --git a/login-utils/runuser.1.adoc b/login-utils/runuser.1.adoc index 808ab55f7..197b97615 100644 --- a/login-utils/runuser.1.adoc +++ b/login-utils/runuser.1.adoc @@ -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 diff --git a/login-utils/su.1.adoc b/login-utils/su.1.adoc index 0c5845cae..27672eb33 100644 --- a/login-utils/su.1.adoc +++ b/login-utils/su.1.adoc @@ -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_:: diff --git a/lsfd-cmd/lsfd.1.adoc b/lsfd-cmd/lsfd.1.adoc index a00afa93a..17ad23740 100644 --- a/lsfd-cmd/lsfd.1.adoc +++ b/lsfd-cmd/lsfd.1.adoc @@ -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 >. diff --git a/misc-utils/lsblk.8.adoc b/misc-utils/lsblk.8.adoc index 16dce6537..12ff6f3c1 100644 --- a/misc-utils/lsblk.8.adoc +++ b/misc-utils/lsblk.8.adoc @@ -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. diff --git a/sys-utils/blkdiscard.8.adoc b/sys-utils/blkdiscard.8.adoc index 1ae4c5fa0..a466aed8d 100644 --- a/sys-utils/blkdiscard.8.adoc +++ b/sys-utils/blkdiscard.8.adoc @@ -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], diff --git a/sys-utils/chcpu.8.adoc b/sys-utils/chcpu.8.adoc index f08b5a6ab..1980b1ade 100644 --- a/sys-utils/chcpu.8.adoc +++ b/sys-utils/chcpu.8.adoc @@ -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] diff --git a/sys-utils/chmem.8.adoc b/sys-utils/chmem.8.adoc index 537beec63..324bf55eb 100644 --- a/sys-utils/chmem.8.adoc +++ b/sys-utils/chmem.8.adoc @@ -89,6 +89,11 @@ failure *64*:: partial success +== ENVIRONMENT + +*ULPATH_DEBUG*=all:: +enables path debug output. + == EXAMPLES *chmem --enable 1024*:: diff --git a/sys-utils/fstrim.8.adoc b/sys-utils/fstrim.8.adoc index a756546b1..fbedb7d0e 100644 --- a/sys-utils/fstrim.8.adoc +++ b/sys-utils/fstrim.8.adoc @@ -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] diff --git a/sys-utils/losetup.8.adoc b/sys-utils/losetup.8.adoc index b6b990058..74586d3d8 100644 --- a/sys-utils/losetup.8.adoc +++ b/sys-utils/losetup.8.adoc @@ -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[] diff --git a/sys-utils/lscpu.1.adoc b/sys-utils/lscpu.1.adoc index a222c7c8d..1fd157342 100644 --- a/sys-utils/lscpu.1.adoc +++ b/sys-utils/lscpu.1.adoc @@ -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. diff --git a/sys-utils/lsmem.1.adoc b/sys-utils/lsmem.1.adoc index a84d6b0f4..dd9b16d24 100644 --- a/sys-utils/lsmem.1.adoc +++ b/sys-utils/lsmem.1.adoc @@ -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. diff --git a/sys-utils/zramctl.8.adoc b/sys-utils/zramctl.8.adoc index 8cede3217..43ccedd17 100644 --- a/sys-utils/zramctl.8.adoc +++ b/sys-utils/zramctl.8.adoc @@ -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]_:: diff --git a/term-utils/agetty.8.adoc b/term-utils/agetty.8.adoc index 6670498f5..87abaaaf1 100644 --- a/term-utils/agetty.8.adoc +++ b/term-utils/agetty.8.adoc @@ -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. diff --git a/term-utils/script.1.adoc b/term-utils/script.1.adoc index 1bff42457..ca5c053b5 100644 --- a/term-utils/script.1.adoc +++ b/term-utils/script.1.adoc @@ -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)). diff --git a/term-utils/scriptlive.1.adoc b/term-utils/scriptlive.1.adoc index 626a1f20b..e0047c59a 100644 --- a/term-utils/scriptlive.1.adoc +++ b/term-utils/scriptlive.1.adoc @@ -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 .... diff --git a/term-utils/scriptreplay.1.adoc b/term-utils/scriptreplay.1.adoc index deabb7b16..64923a270 100644 --- a/term-utils/scriptreplay.1.adoc +++ b/term-utils/scriptreplay.1.adoc @@ -78,6 +78,11 @@ data. include::man-common/help-version.adoc[] +== ENVIRONMENT + +*SCRIPTREPLAY_DEBUG*=all:: +enables scriptreplay debug output. + == EXAMPLES ....