Blame iotop.8

Packit Service 77e874
.\" Debian manual page, has been forwarded upstream
Packit Service 77e874
.TH IOTOP "8" "April 2009"
Packit Service 77e874
.SH NAME
Packit Service 77e874
iotop \- simple top\-like I/O monitor
Packit Service 77e874
.SH SYNOPSIS
Packit Service 77e874
.B iotop
Packit Service 77e874
[\fIOPTIONS\fR]
Packit Service 77e874
.SH DESCRIPTION
Packit Service 77e874
iotop watches I/O usage information output by the Linux kernel (requires
Packit Service 77e874
2.6.20 or later) and displays a table of current I/O usage by processes
Packit Service 77e874
or threads on the system. At least the CONFIG_TASK_DELAY_ACCT,
Packit Service 77e874
CONFIG_TASK_IO_ACCOUNTING, CONFIG_TASKSTATS and CONFIG_VM_EVENT_COUNTERS
Packit Service 77e874
options need to be enabled in your Linux kernel build configuration.
Packit Service 77e874
.PP
Packit Service 77e874
iotop displays columns for the I/O bandwidth read and written by each
Packit Service 77e874
process/thread during the sampling period. It also displays the percentage
Packit Service 77e874
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.
Packit Service 77e874
.PP
Packit Service 77e874
In addition, the total I/O bandwidth read and written during the sampling
Packit Service 77e874
period is displayed at the top of the interface.
Packit Service 77e874
\fBTotal DISK READ\fR and \fBTotal DISK WRITE\fR values represent total read
Packit Service 77e874
and write bandwidth between processes and kernel threads on the one side and
Packit Service 77e874
kernel block device subsystem on the other. While \fBActual DISK READ\fR and
Packit Service 77e874
\fBActual DISK WRITE\fR values represent corresponding bandwidths for actual
Packit Service 77e874
disk I/O between kernel block device subsystem and underlying hardware (HDD, SSD, etc.).
Packit Service 77e874
Thus \fBTotal\fR and \fBActual\fR values may not be equal at any given moment of time
Packit Service 77e874
due to data caching and I/O operations reordering that take place inside Linux kernel.
Packit Service 77e874
.PP
Packit Service 77e874
Use the left and right arrows to change the sorting, r to reverse the
Packit Service 77e874
sorting order, o to toggle the \-\-only option, p to toggle the \-\-processes option, a to toggle the \-\-accumulated option, q to quit or i to change the priority of a thread or a process' thread(s). Any other key will force a refresh.
Packit Service 77e874
.SH OPTIONS
Packit Service 77e874
.TP
Packit Service 77e874
\fB\-\-version\fR
Packit Service 77e874
Show the version number and exit
Packit Service 77e874
.TP
Packit Service 77e874
\fB\-h\fR, \fB\-\-help\fR
Packit Service 77e874
Show usage information and exit
Packit Service 77e874
.TP
Packit Service 77e874
\fB\-o\fR, \fB\-\-only\fR
Packit Service 77e874
Only show processes or threads actually doing I/O, instead of showing all processes or threads. This can be dynamically toggled by pressing o.
Packit Service 77e874
.TP
Packit Service 77e874
\fB\-b\fR, \fB\-\-batch\fR
Packit Service 77e874
Turn on non\-interactive mode.
Packit Service 77e874
Useful for logging I/O usage over time.
Packit Service 77e874
.TP
Packit Service 77e874
\fB\-n\fR NUM, \fB\-\-iter\fR=\fINUM\fR
Packit Service 77e874
Set the number of iterations before quitting (never quit by default).
Packit Service 77e874
This is most useful in non\-interactive mode.
Packit Service 77e874
.TP
Packit Service 77e874
\fB\-d\fR SEC, \fB\-\-delay\fR=\fISEC\fR
Packit Service 77e874
Set the delay between iterations in seconds (1 second by default).
Packit Service 77e874
Accepts non-integer values such as 1.1 seconds.
Packit Service 77e874
.TP
Packit Service 77e874
\fB\-p\fR PID, \fB\-\-pid\fR=\fIPID\fR
Packit Service 77e874
A list of processes/threads to monitor (all by default).
Packit Service 77e874
.TP
Packit Service 77e874
\fB\-u\fR USER, \fB\-\-user\fR=\fIUSER\fR
Packit Service 77e874
A list of users to monitor (all by default)
Packit Service 77e874
.TP
Packit Service 77e874
\fB\-P\fR, \fB\-\-processes\fR
Packit Service 77e874
Only show processes. Normally iotop shows all threads.
Packit Service 77e874
.TP
Packit Service 77e874
\fB\-a\fR, \fB\-\-accumulated\fR
Packit Service 77e874
Show accumulated I/O instead of bandwidth. In this mode, iotop shows the amount of I/O processes have done since iotop started.
Packit Service 77e874
.TP
Packit Service 77e874
\fB\-k\fR, \fB\-\-kilobytes\fR
Packit Service 77e874
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.
Packit Service 77e874
.TP
Packit Service 77e874
\fB\-t\fR, \fB\-\-time\fR
Packit Service 77e874
Add a timestamp on each line (implies \-\-batch). Each line will be prefixed by the current time.
Packit Service 77e874
.TP
Packit Service 77e874
\fB\-q\fR, \fB\-\-quiet\fR
Packit Service 77e874
suppress some lines of header (implies \-\-batch). This option can be specified up to three times to remove header lines.
Packit Service 77e874
.RS
Packit Service 77e874
.PD 0
Packit Service 77e874
.TP
Packit Service 77e874
.B \-q
Packit Service 77e874
column names are only printed on the first iteration,
Packit Service 77e874
.TP
Packit Service 77e874
.B \-qq
Packit Service 77e874
column names are never printed,
Packit Service 77e874
.TP
Packit Service 77e874
.B \-qqq
Packit Service 77e874
the I/O summary is never printed.
Packit Service 77e874
.PD 1
Packit Service 77e874
.RE
Packit Service 77e874
.SH SEE ALSO
Packit Service 77e874
.BR ionice (1),
Packit Service 77e874
.BR top (1),
Packit Service 77e874
.BR vmstat (1),
Packit Service 77e874
.BR atop (1),
Packit Service 77e874
.BR htop (1)
Packit Service 77e874
.SH AUTHOR
Packit Service 77e874
iotop was written by Guillaume Chazarain.
Packit Service 77e874
.PP
Packit Service 77e874
This manual page was started by Paul Wise for the
Packit Service 77e874
Debian project and is placed in the public domain.