~ubuntu-branches/ubuntu/lucid/iotop/lucid

« back to all changes in this revision

Viewing changes to iotop.1

  • Committer: Bazaar Package Importer
  • Author(s): Paul Wise
  • Date: 2009-05-04 14:17:06 UTC
  • mto: This revision was merged to the branch mainline in revision 8.
  • Revision ID: james.westby@ubuntu.com-20090504141706-ke0we6japfak6tqw
Tags: upstream-0.3
ImportĀ upstreamĀ versionĀ 0.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
.\" Debian manual page, has been forwarded upstream
2
 
.TH IOTOP "1" "May 2008"
 
2
.TH IOTOP "1" "April 2009"
3
3
.SH NAME
4
4
iotop \- simple top\-like I/O monitor
5
5
.SH SYNOPSIS
8
8
.SH DESCRIPTION
9
9
iotop watches I/O usage information output by the Linux kernel (requires
10
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.
 
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.
13
14
.PP
14
15
iotop displays columns for the I/O bandwidth read and written by each
15
16
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
 
17
of time the thread/process spent while swapping in and while waiting on I/O. For each process, its I/O priority (class/level) is shown.
 
18
In addition, the total I/O bandwidth read and written during the sampling
18
19
period is displayed at the top of the interface.
19
20
.PP
20
21
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
sorting order, o to toggle the \-\-only option, p to toggle the \-\-processes option, a to toggle the --accumulated option or q to quit. Any other key will force a refresh.
22
23
.SH OPTIONS
23
24
.TP
24
25
\fB\-\-version\fR
43
44
Accepts non-integer values such as 1.1 seconds.
44
45
.TP
45
46
\fB\-p\fR PID, \fB\-\-pid\fR=\fIPID\fR
46
 
A list of processes to monitor (all by default).
 
47
A list of processes/threads to monitor (all by default).
47
48
.TP
48
49
\fB\-u\fR USER, \fB\-\-user\fR=\fIUSER\fR
49
50
A list of users to monitor (all by default)
50
51
.TP
51
52
\fB\-P\fR, \fB\-\-processes\fR
52
53
Only show processes. Normally iotop shows all threads.
 
54
.TP
 
55
\fB\-a\fR, \fB\-\-accumulated\fR
 
56
Show accumulated I/O instead of bandwidth. In this mode, iotop shows the amount of I/O processes have done since iotop started.
 
57
.TP
 
58
\fB\-k\fR, \fB\-\-kilobytes\fR
 
59
Use kilobytes instead of a human friendly unit. This mode is useful when scripting the batch mode of iotop. Instead of choosing the most appropriate unit iotop will display all sizes in kilobytes.
 
60
.TP
 
61
\fB\-t\fR, \fB\-\-time\fR
 
62
Add a timestamp on each line (implies --batch). Each line will be prefixed by the current time.
 
63
.TP
 
64
\fB\-q\fR, \fB\-\-quiet\fR
 
65
suppress some lines of header (implies --batch). This option can be specified up to three times to remove header lines.
 
66
.RS
 
67
.PD 0
 
68
.TP
 
69
.B -q
 
70
column names are only printed on the first iteration,
 
71
.TP
 
72
.B -qq
 
73
column names are never printed,
 
74
.TP
 
75
.B -qqq
 
76
the I/O summary is never printed.
 
77
.PD 1
 
78
.RE
53
79
.SH SEE ALSO
54
 
.BR top (1)
 
80
.BR top (1),
 
81
.BR vmstat (1)
55
82
.SH AUTHOR
56
83
iotop was written by Guillaume Chazarain.
57
84
.PP