Fixup graph name in help text
[blktrace.git] / doc / bno_plot.1
1 .TH BNO_PLOT 1 "February 22, 2007" "blktrace git\-20080213182518" ""
2
3
4 .SH NAME
5 bno_plot \- generate interactive 3D plot of IO blocks and sizes
6
7
8 .SH SYNOPSIS
9 .B bno_plot
10 [ \-h | \-\-help ]
11 .br
12          [ \-v | \-\-verbose ]
13 .br
14          [ \-K | \-\-keys-below ]
15 .br
16          [ <file...> ]
17 .br
18
19
20 .SH DESCRIPTION
21
22 bno_plot is a visualization tool for the block layer IO tracing tool called
23 blktrace(8).  As noted in its documentation, blktrace 
24 is a block layer IO tracing mechanism which provides detailed
25 information about request queue operations up to user space.
26
27 bno_plot utilizes gnuplot to generate a 3D plot of the block number output from
28 btt.  If no \fI<files>\fR are specified, it will utilize all files generated after
29 btt was run with \fI-B blknos\fR (meaning: all files of the form \fIblknos*[rw].dat\fR).
30
31 The \fI-K\fR option forces bno_plot to put the keys below the graph.  If it is
32 not specified, all keys for input files are put in the upper right corner of the
33 graph. If the number of devices exceed 10, then bno_plot will automatically
34 push the keys under the graph.
35
36 To use this utility, the gnuplot package needs to be installed.
37
38 To exit the plotter, enter 'quit' or ^D at the 'gnuplot> ' prompt.
39
40 .SH AUTHORS
41 \fIbno_plot\fR was written by Alan D. Brunelle.  This man page was created
42 from the \fIblktrace\fR documentation by Bas Zoetekouw.
43
44
45 .SH "REPORTING BUGS"
46 Report bugs to <linux\-btrace@vger.kernel.org>
47
48 .SH COPYRIGHT
49 Copyright \(co 2008 Hewlett-Packard Development Company, L.P.
50 .br
51 This is free software.  You may redistribute copies of it under the terms of
52 the GNU General Public License <http://www.gnu.org/licenses/gpl.html>.
53 There is NO WARRANTY, to the extent permitted by law.
54 .br
55 This manual page was created for Debian by Bas Zoetekouw.  It was derived from
56 the documentation provided by the authors and it may be used, distributed and
57 modified under the terms of the GNU General Public License, version 2.
58 .br
59 On Debian systems, the text of the GNU General Public License can be found in
60 /usr/share/common\-licenses/GPL\-2.
61
62 .SH "SEE ALSO"
63 btt (1), gnuplot (1), blktrace (8), blkparse (1), verify_blkparse (1), blkrawverify (1)
64