]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
irqtop: improve the description of --batch, and align it with others
authorBenno Schulenberg <bensberg@telfort.nl>
Mon, 31 Mar 2025 09:44:37 +0000 (11:44 +0200)
committerKarel Zak <kzak@redhat.com>
Wed, 2 Apr 2025 11:04:50 +0000 (13:04 +0200)
Also improve the description of --delay and tweak the one of --json,
and align both descriptions with the preceding ones.

CC: Joe Jin <joe.jin@oracle.com>
Signed-off-by: Benno Schulenberg <bensberg@telfort.nl>
sys-utils/irqtop.1.adoc
sys-utils/irqtop.c

index 880ee190653895770a1363e86c16a0c99ac9dc91..04158a0ef92b333cc60e0c6b3e06da76d2c1b595 100644 (file)
@@ -26,7 +26,8 @@ The default output is subject to change. So whenever possible, you should avoid
 Specify which output columns to print. Use *--help* to get a list of all supported columns. The default list of columns may be extended if list is specified in the format _+list_.
 
 *-b*, *--batch*::
-Starts irqtop in batch mode, which could be useful for sending output to other programs or to a file.
+Send the produced tables to stdout instead of to a static screen.
+This can be used for sending the output to other programs or to a file.
 
 *-c*, *--cpu-stat* _mode_::
 Show per-cpu statistics by specified mode. Available modes are: *auto*, *enable*, *disable*. The default option *auto* detects the width of window, then shows the per-cpu statistics if the width of window is large enough to show a full line of statistics.
@@ -35,10 +36,10 @@ Show per-cpu statistics by specified mode. Available modes are: *auto*, *enable*
 Specify cpus in list format to show.
 
 *-d*, *--delay* _seconds_::
-Update interrupt output every _seconds_ intervals.
+Update the tables every this number of seconds.
 
 *-J*, *--json*::
-Use JSON output format. irqtop will run in batch mode.
+Use JSON output format. Implies *--batch*.
 
 *-n*, *--iter* _number_::
 Specifies the maximum iterations before quitting.
index 751e9e19b3dfb137322c73a543685f9cf07751c0..e0abddd821e9399e4d972d7f369ec43e68035568 100644 (file)
@@ -306,11 +306,11 @@ static void __attribute__((__noreturn__)) usage(void)
        puts(_("Interactive utility to display kernel interrupt information."));
 
        fputs(USAGE_OPTIONS, stdout);
-       fputs(_(" -b, --batch batch mode\n"), stdout);
+       fputs(_(" -b, --batch           send tables to stdout, not to a static screen\n"), stdout);
        fputs(_(" -c, --cpu-stat <mode> show per-cpu stat (auto, enable, disable)\n"), stdout);
        fputs(_(" -C, --cpu-list <list> specify cpus in list format\n"), stdout);
-       fputs(_(" -d, --delay <secs>   delay updates\n"), stdout);
-       fputs(_(" -J, --json  use JSON output format (will run in batch mode)\n"), stdout);
+       fputs(_(" -d, --delay <secs>    wait this number of seconds between updates\n"), stdout);
+       fputs(_(" -J, --json            use JSON output format (implies --batch)\n"), stdout);
        fputs(_(" -n, --iter <number>  the maximum number of iterations\n"), stdout);
        fputs(_(" -o, --output <list>  define which output columns to use\n"), stdout);
        fputs(_(" -s, --sort <column>  specify sort column\n"), stdout);