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