]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
irqtop: add manual page
authorSami Kerola <kerolasa@iki.fi>
Sat, 8 Feb 2020 16:03:07 +0000 (16:03 +0000)
committerSami Kerola <kerolasa@iki.fi>
Sat, 22 Feb 2020 21:43:54 +0000 (21:43 +0000)
Signed-off-by: Sami Kerola <kerolasa@iki.fi>
sys-utils/Makemodule.am
sys-utils/irqtop.1 [new file with mode: 0644]

index 03ece85ec3577cbced83940157910346d17cb09e..28e01c9ba75c41261e2be1740411fc17e57bb57a 100644 (file)
@@ -52,6 +52,7 @@ endif
 
 if BUILD_IRQTOP
 usrbin_exec_PROGRAMS += irqtop
+dist_man_MANS += sys-utils/irqtop.1
 irqtop_SOURCES = sys-utils/irqtop.c \
                 lib/monotonic.c
 irqtop_LDADD = $(LDADD) libcommon.la $(NCURSES_LIBS) $(REALTIME_LIBS) libsmartcols.la
diff --git a/sys-utils/irqtop.1 b/sys-utils/irqtop.1
new file mode 100644 (file)
index 0000000..4353c23
--- /dev/null
@@ -0,0 +1,62 @@
+.TH IRQTOP "1" "February 2020" "util-linux" "User Commands"
+.SH NAME
+irqtop \- utility to display kernel interrupt information
+.SH SYNOPSIS
+.B irqtop
+[options]
+.SH DESCRIPTION
+Display kernel interrupt counter information in
+.BR top (1)
+style view.
+.SH OPTIONS
+.TP
+.BR \-d ,\  \-\-delay\ \c
+.I seconds
+Update interrupt output every
+.I seconds
+intervals.
+.TP
+.BR \-o ,\  \-\-once
+Collect interrupt information and output it.  This mode does not use
+ncurses, so the output can easily be redirected to a pipe, file, or such.
+.TP
+.BR \-s ,\  \-\-sort\ \c
+.I char
+Specify sort criteria by character.  Pressing these characters in
+interactive mode will make the ncurses output to be ordered accordingly.
+.PP
+.RS
+.PD 0
+.TP
+.B c
+sort by increase count of each interrupt (the default)
+.TP
+.B i
+sort by default interrupts from proc interrupt
+.TP
+.B n
+sort by name
+.TP
+.B q Q
+stop updates and exit program
+.PD
+.RE
+.TP
+.BR \-V ", " \-\-version
+Display version information and exit.
+.TP
+.BR \-h ,\  \-\-help
+Display help text and exit.
+.SH AUTHORS
+.MT pizhenwei@\:bytedance.com
+Zhenwei Pi
+.ME
+.br
+.MT kerolasa@\:iki.fi
+Sami Kerola
+.ME
+.SH AVAILABILITY
+The example command is part of the util-linux package and is available from
+.UR https://\:www.kernel.org\:/pub\:/linux\:/utils\:/util-linux/
+Linux Kernel Archive
+.UE .