Fixup graph name in help text
[blktrace.git] / doc / btrace.8
CommitLineData
98eee4e4
JA
1.TH BTRACE 8 "March 6, 2007" "blktrace git\-20070306202522" ""
2
3
4.SH NAME
fbdf23ec 5btrace \- perform live tracing for block devices
98eee4e4
JA
6
7
8.SH SYNOPSIS
bc93336f 9.B btrace [\-s] [\-t] [\-w \fIN\fN] [\-n \fIN\fR] [\-b \fIN\fR] [\-r \fI<dbg mnt>\fR] [\-a <\fItrace\fR>...] <\fIdev\fR>...
98eee4e4
JA
10.br
11
12
13.SH DESCRIPTION
14
fbdf23ec
ES
15The \fIbtrace\fR script provides a quick and easy way to do live tracing of
16block devices. It calls \fIblktrace\fR on the specified devices
17and pipes the output through \fIblkparse\fR for formatting. See blktrace (8)
98eee4e4
JA
18for more in-depth information about how \fIblktrace\fR works.
19
20.SH OPTIONS
21
22.HP 4
23.B \-s
24Displays data sorted by program (see \fIblkparse\fR (1)).
25
26.HP 4
27.B \-t
fbdf23ec 28Displays time deltas per IO (see \fIblkparse\fR (1)).
98eee4e4
JA
29
30.HP 4
31.B \-w \fIN\fR
32Sets run time to the number of seconds specified (see \fIblktrace\fR (8)).
33
34.HP 4
35.B \-n \fIN\fR
36Specifies the number of buffers to use (see \fIblktrace\fR (8)).
37
38.HP 4
39.B \-b \fIN\fR
40Specifies buffer size for event extraction (scaled by 1024) (see
41\fIblktrace\fR (8)).
42
bc93336f
ES
43.HP 4
44.B \-r \fI<dbg mnt>\fR
45Specifies the debugfs mountpoint.
46
98eee4e4
JA
47.HP 4
48.B \-a <\fItrace\fR>...
fbdf23ec 49Adds mask to current filter (see \fIblktrace\fR (8)).
98eee4e4
JA
50
51.HP 4
52.B <\fIdev\fR>
53Specifies the device to trace.
54
55
56.SH EXAMPLE
57Simply running
58
fbdf23ec 59 % btrace /dev/sda
98eee4e4
JA
60
61will show a trace of the device \fI/dev/sda\fR.
62
63
64.SH AUTHORS
65\fIblkparse\fR was written by Jens Axboe, Alan D. Brunelle and Nathan Scott. This
66man page was created from the \fIblktrace\fR documentation by Bas Zoetekouw.
67
68
69.SH "REPORTING BUGS"
70Report bugs to <linux\-btrace@vger.kernel.org>
71
72.SH COPYRIGHT
73Copyright \(co 2006 Jens Axboe, Alan D. Brunelle and Nathan Scott.
74.br
75This is free software. You may redistribute copies of it under the terms of
76the GNU General Public License <http://www.gnu.org/licenses/gpl.html>.
77There is NO WARRANTY, to the extent permitted by law.
78.br
79This manual page was created for Debian by Bas Zoetekouw. It was derived from
80the documentation provided by the authors and it may be used, distributed and
81modified under the terms of the GNU General Public License, version 2.
82.br
83On Debian systems, the text of the GNU General Public License can be found in
84/usr/share/common\-licenses/GPL\-2.
85
86.SH "SEE ALSO"
87blktrace (8), blkparse (1), verify_blkparse (1), blkrawverify (1), btt (1)
88