Clarify -p help text, and cosmetically add a terminating '.'.
[iotop.git] / iotop.1
blobaafbf15be12e662d83618e958e9262c5b8aa7c75
1 .\" Debian manual page, has been forwarded upstream
2 .TH IOTOP "1" "September 2008"
3 .SH NAME
4 iotop \- simple top\-like I/O monitor
5 .SH SYNOPSIS
6 .B iotop
7 [\fIOPTIONS\fR]
8 .SH DESCRIPTION
9 iotop watches I/O usage information output by the Linux kernel (requires
10 2.6.20 or later) and displays a table of current I/O usage by processes
11 or threads on the system. At least the CONFIG_TASK_DELAY_ACCT and
12 CONFIG_TASK_IO_ACCOUNTING options need to be enabled in your Linux kernel
13 build configuration, these options depend on CONFIG_TASKSTATS.
14 .PP
15 iotop displays columns for the I/O bandwidth read and written by each
16 process/thread during the sampling period. It also displays the percentage
17 of time the thread/process spent while swapping in and while waiting on I/O.
18 In addition the total I/O bandwidth read and written during the sampling
19 period is displayed at the top of the interface.
20 .PP
21 Use the left and right arrows to change the sorting, r to reverse the
22 sorting order, o to toggle the \-\-only option or q to quit. Any other key will force a refresh.
23 .SH OPTIONS
24 .TP
25 \fB\-\-version\fR
26 Show the version number and exit
27 .TP
28 \fB\-h\fR, \fB\-\-help\fR
29 Show usage information and exit
30 .TP
31 \fB\-o\fR, \fB\-\-only\fR
32 Only show processes or threads actually doing I/O, instead of showing all processes or threads. This can be dynamically toggled by pressing o.
33 .TP
34 \fB\-b\fR, \fB\-\-batch\fR
35 Turn on non\-interactive mode.
36 Useful for logging I/O usage over time.
37 .TP
38 \fB\-n\fR NUM, \fB\-\-iter\fR=\fINUM\fR
39 Set the number of iterations before quitting (never quit by default).
40 This is most useful in non\-interactive mode.
41 .TP
42 \fB\-d\fR SEC, \fB\-\-delay\fR=\fISEC\fR
43 Set the delay between iterations in seconds (1 second by default).
44 Accepts non-integer values such as 1.1 seconds.
45 .TP
46 \fB\-p\fR PID, \fB\-\-pid\fR=\fIPID\fR
47 A list of processes/threads to monitor (all by default).
48 .TP
49 \fB\-u\fR USER, \fB\-\-user\fR=\fIUSER\fR
50 A list of users to monitor (all by default)
51 .TP
52 \fB\-P\fR, \fB\-\-processes\fR
53 Only show processes. Normally iotop shows all threads.
54 .SH SEE ALSO
55 .BR top (1),
56 .BR vmstat (1)
57 .SH AUTHOR
58 iotop was written by Guillaume Chazarain.
59 .PP
60 This manual page was started by Paul Wise for the
61 Debian project and is placed in the public domain.