Fixup graph name in help text

[blktrace.git] / doc / blktrace.8

diff --git a/doc/blktrace.8 b/doc/blktrace.8
index 4b34dff707b7dd763b9c0d5ba5ec69c2d0fc5090..68f5e151e013f3d2389cee5664d0ce0a024c54b0 100644 (file)
--- a/doc/blktrace.8
+++ b/doc/blktrace.8
@@ -66,19 +66,10 @@ blktrace may also be run concurrently with blkparse to produce
 .TP 2
 \- 
 The default behaviour for blktrace is to run forever until explicitly
-killed by the user (via a control-C, or kill utility invocation).
-There are two ways to modify this:
-
-.TP 5
-  1. 
-You may utilise the blktrace utility itself to kill
-a running trace -- via the \fB\-k\fR option.
-
-.TP 5
-  2.
-You can specify a run-time duration for blktrace via the
-\fB\-w\fR option -- then blktrace will run for the specified number
-of seconds, and then halt.
+killed by the user (via a control-C, or sending SIGINT signal to the
+process via invocation the kill (1) utility). Also you can specify a
+run-time duration for blktrace via the \fB\-w\fR option -- then
+blktrace will run for the specified number of seconds, and then halt.
 
 
 .SH OPTIONS
@@ -114,30 +105,62 @@ Adds \fIdev\fR as a device to trace
 
 \-I \fIfile\fR
 .br
-\-\-input-devs=\fIfile\fR 
+\-\-input\-devs=\fIfile\fR
 .RS
 Adds the devices found in \fIfile\fR as devices to trace
 .RE
 
-\-k 
+\-n \fInum\-sub\fR 
 .br
-\-\-kill 
+\-\-num\-sub\-buffers=\fInum-sub\fR
 .RS
-Kill on-going trace  
+Specifies number of buffers to use. blktrace defaults to 4 sub buffers.
 .RE
 
-\-n \fInum\-sub\fR 
+\-l
 .br
-\-\-num\-sub=\fInum-sub\fR    
+\-\-listen
 .RS
-Specifies number of buffers to use. blktrace defaults to 4 sub buffers.
+Run in network listen mode (blktrace server)
+.RE
+
+\-h \fIhostname\fR
+.br
+\-\-host=\fIhostname\fR
+.RS
+Run in network client mode, connecting to the given host
+.RE
+
+\-p \fInumber\fR
+.br
+\-\-port=\fInumber\fR
+.RS
+Network port to use (default 8462)
 .RE
 
-\-o \fIfile\fR 
+\-s
 .br
-\-\-output=\fIfile\fR        
+\-\-no\-sendfile
 .RS
-Prepend \fIfile\fR to output file name(s)  
+Make the network client NOT use sendfile() to transfer data
+.RE
+
+\-o \fIbasename\fR
+.br
+\-\-output=\fIbasename\fR
+.RS
+Specifies base name for input files. Default is device.blktrace.cpu.
+Specifying -o - runs in live mode with blkparse (writing data to standard out).
+.RE
+
+\-D \fIdir\fR
+.br
+\-\-output\-dir=\fIdir\fR
+.RS
+Prepend \fIfile\fR to output file name(s)
+
+This only works when supplying a single device, or when piping the output
+via "-o -" with multiple devices.
 .RE
 
 \-r \fIrel-path\fR
@@ -147,9 +170,17 @@ Prepend \fIfile\fR to output file name(s)
 Specifies debugfs mount point  
 .RE
 
+\-v
+.br
+\-\-version
+.RS
+Outputs version
+.RE
+
 \-V               
 .br
-\-\-version                  
+\-\-version
+.RS
 Outputs version  
 .RE
 
@@ -169,7 +200,9 @@ line options.
 .RS
 \fIbarrier\fR: barrier attribute 
 .br
-\fIcomplete\fR: completed} by driver
+\fIcomplete\fR: completed by driver
+.br
+\fIdiscard\fR: discard / trim traces
 .br
 \fIfs\fR: requests 
 .br
@@ -186,6 +219,10 @@ line options.
 \fIsync\fR: synchronous attribute 
 .br
 \fIwrite\fR: write traces
+.br
+\fInotify\fR: trace messages
+.br
+\fIdrv_data\fR: additional driver specific trace
 .RE
 
 
@@ -201,7 +238,7 @@ sends the command data block as a payload so that blkparse can decode it.
 
 
 .SH EXAMPLES
-To trace the i/o on the device \fI/dev/hda\fR and parse the output to human
+To trace the i/o on the device \fI/dev/sda\fR and parse the output to human
 readable form, use the following command:
 
     % blktrace \-d /dev/sda \-o \- | blkparse \-i \-