iowatcher: check the return value from write()

[blktrace.git] / doc / btt.1

diff --git a/doc/btt.1 b/doc/btt.1
index fa437f9016d19577ee19fcc45165757626b47f46..28cf912d2ebbba7c32e03db0b20e5b54c8f15f0a 100644 (file)
--- a/doc/btt.1
+++ b/doc/btt.1
@@ -7,6 +7,7 @@ btt \- analyse block i/o traces produces by blktrace
 
 .SH SYNOPSIS
 .B btt 
+.br
 [ \-a               | \-\-seek\-absolute ]
 .br
 [ \-A               | \-\-all\-data ]
@@ -29,6 +30,8 @@ btt \- analyse block i/o traces produces by blktrace
 .br
 [ \-L <\fIfreq\fR>        | \-\-periodic\-latencies=<\fIfreq\fR> ]
 .br
+[ \-m <\fIoutput name\fR> | \-\-seeks\-per\-second=<\fIoutput name\fR> ]
+.br
 [ \-M <\fIdev map\fR>     | \-\-dev\-maps=<\fIdev map\fR>
 .br
 [ \-o <\fIoutput name\fR> | \-\-output\-file=<\fIoutput name\fR> ]
@@ -41,6 +44,8 @@ btt \- analyse block i/o traces produces by blktrace
 .br
 [ \-Q <\fIoutput name\fR> | \-\-active\-queue\-depth=<\fIoutput name\fR> ]
 .br
+[ \-r               | \-\-no\-remaps ]
+.br
 [ \-s <\fIoutput name\fR> | \-\-seeks=<\fIoutput name\fR> ]
 .br
 [ \-S <\fIinterval\fR>    | \-\-iostat\-interval=<\fIinterval\fR> ]
@@ -55,7 +60,11 @@ btt \- analyse block i/o traces produces by blktrace
 .br
 [ \-V               | \-\-version ]
 .br
+[ \-X               | \-\-easy\-parse\-avgs ]
+.br
 [ \-z <\fIoutput name\fR> | \-\-q2d\-latencies=<\fIoutput name\fR> ]
+.br
+[ \-Z               | \-\-do\-active ]
 
 
 .SH DESCRIPTION
@@ -72,7 +81,7 @@ of time while Q events are being produced), C activity (likewise for
 command completions), and etc.
 
 Included with the distribution is a simple 3D plotting utility,
-\fIbno_plot\fR, which can plot the block numbers btss outputs if the \fI-B\fR
+\fIbno_plot\fR, which can plot the block numbers btt outputs if the \fI-B\fR
 option is specified. The display will display each IO generated, with the time
 (seconds) along the X-axis, the block number (start) along the Y-axis and the
 number of blocks transferred in the IO represented along the Z-axis.
@@ -196,6 +205,15 @@ Q2C and D2C latencies. The frequency specified will regulate how often
 an average latency is output -- a floating point value expressing seconds.
 .RE
 
+.B \-m <\fIoutput name\fR>
+.br
+.B \-\-seeks\-per\-second=<\fIoutput name\fR>
+.RS 4
+Trigger btt to output seeks-per-second information. The first column will
+contain a time value (seconds), and the second column  will indicate the
+number of seeks per second at that point.
+.RE
+
 .B \-M <\fIdev map\fR>
 .br
 .B \-\-dev\-maps=<\fIdev map\fR>
@@ -245,6 +263,14 @@ The \-Q option allows one to output data files showing the time stamp
 and the depth of active commands (those issued but not completed).
 .RE
 
+.B \-r
+.br
+.B \-\-no\-remaps
+.RS 4
+Ignore remap traces; older kernels did not implement the full remap
+PDU.
+.RE
+
 .B \-s <\fIoutput name\fR>
 .br
 .B \-\-seeks=<\fIoutput name\fR>
@@ -319,6 +345,14 @@ Shows the version of btt.
 Requests a more verbose output.
 .RE
 
+.B \-X
+.br
+.B \-\-easy\-parse\-avgs
+.RS 4
+Provide data in an easy-to-parse form and write it to a file
+with .avg exentsion
+.RE
+
 .B \-z <\fIoutput name\fR>
 .br
 .B \-\-q2d\-latencies=<\fIoutput name\fR>
@@ -328,6 +362,14 @@ respectively. The supplied argument provides the basis for the output
 name for each device.
 .RE
 
+.B \-Z
+.br
+.B \-\-do\-active
+.RS 4
+The \-Z will output files containing data which can be plotted showing
+per\-device (and total system) I/O activity.
+.RE
+
 
 .SH AUTHORS
 \fIbtt\fR was written by Alan D. Brunelle.  This man page was created