diff options
Diffstat (limited to 'doc/blktrace.8')
| -rw-r--r-- | doc/blktrace.8 | 87 |
1 files changed, 61 insertions, 26 deletions
diff --git a/doc/blktrace.8 b/doc/blktrace.8 index 58e8f90..820b03a 100644 --- a/doc/blktrace.8 +++ b/doc/blktrace.8 @@ -6,7 +6,7 @@ blktrace \- generate traces of the i/o traffic on block devices .SH SYNOPSIS -.B blktrace \-d \fIdev\fR [ \-r \fIdebugfs_path\fR ] [ \-o \fIoutput\fR ] [\-k ] [ \-w \fItime\fR ] [ \-a \fIaction\fR ] [ \-A \fIaction_mask\fR ] [ \-v ] +.B blktrace \-d \fIdev\fR [ \-r \fIdebugfs_path\fR ] [ \-o \fIoutput\fR ] [ \-w \fItime\fR ] [ \-a \fIaction\fR ] [ \-A \fIaction_mask\fR ] [ \-v ] .br @@ -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 + +\-s +.br +\-\-no\-sendfile +.RS +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 -\-o \fIfile\fR +\-D \fIdir\fR .br -\-\-output=\fIfile\fR +\-\-output\-dir=\fIdir\fR .RS -Prepend \fIfile\fR to output file name(s) +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 @@ -171,6 +202,8 @@ line options. .br \fIcomplete\fR: completed by driver .br +\fIdiscard\fR: discard / trim traces +.br \fIfs\fR: requests .br \fIissue\fR: issued to driver @@ -188,6 +221,8 @@ line options. \fIwrite\fR: write traces .br \fInotify\fR: trace messages +.br +\fIdrv_data\fR: additional driver specific trace .RE @@ -203,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 \- |