summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEdward Shishkin <edward@redhat.com>2010-10-22 20:51:22 +0200
committerJens Axboe <jaxboe@fusionio.com>2010-10-22 20:54:11 +0200
commitb9a7e9fc06db9e557779b5458c94d68638fe0f0e (patch)
tree5080356e4a3da145d9cd06dab42a25a8cb507266
parent541c9bf69fb79e476fa0b7c6726492ba58c7381f (diff)
downloadblktrace-b9a7e9fc06db9e557779b5458c94d68638fe0f0e.tar.gz
blktrace-b9a7e9fc06db9e557779b5458c94d68638fe0f0e.tar.bz2
blktrace: blktrace documentation update
Fixup for RH bugzilla 595620. Document undocumented blktrace options. Update the man pages. Signed-off-by: Edward Shishkin <edward@redhat.com> Signed-off-by: Jens Axboe <jaxboe@fusionio.com>
-rw-r--r--blktrace.c22
-rw-r--r--doc/blktrace.856
2 files changed, 69 insertions, 9 deletions
diff --git a/blktrace.c b/blktrace.c
index 4671a04..4cccb7c 100644
--- a/blktrace.c
+++ b/blktrace.c
@@ -435,9 +435,24 @@ static struct option l_opts[] = {
}
};
-static char usage_str[] = \
- "-d <dev> [ -r debugfs path ] [ -o <output> ] [-k ] [ -w time ]\n" \
- "[ -a action ] [ -A action mask ] [ -I <devs file> ] [ -v ]\n\n" \
+static char usage_str[] = "\n\n" \
+ "-d <dev> | --dev=<dev>\n" \
+ "[ -r <debugfs path> | --relay=<debugfs path> ]\n" \
+ "[ -o <file> | --output=<file>]\n" \
+ "[ -D <dir> | --output-dir=<dir>\n" \
+ "[ -w <time> | --stopwatch=<time>]\n" \
+ "[ -a <action field> | --act-mask=<action field>]\n" \
+ "[ -A <action mask> | --set-mask=<action mask>]\n" \
+ "[ -b <size> | --buffer-size]\n" \
+ "[ -n <number> | --num-sub-buffers=<number>]\n" \
+ "[ -l | --listen]\n" \
+ "[ -h <hostname> | --host=<hostname>]\n" \
+ "[ -p <port number> | --port=<port number>]\n" \
+ "[ -s | --no-sendfile]\n" \
+ "[ -I <devs file> | --input-devs=<devs file>]\n" \
+ "[ -v <version> | --version]\n" \
+ "[ -V <version> | --version]\n" \
+
"\t-d Use specified device. May also be given last after options\n" \
"\t-r Path to mounted debugfs, defaults to /sys/kernel/debug\n" \
"\t-o File(s) to send output to\n" \
@@ -452,6 +467,7 @@ static char usage_str[] = \
"\t-p Network port to use (default 8462)\n" \
"\t-s Make the network client NOT use sendfile() to transfer data\n" \
"\t-I Add devices found in <devs file>\n" \
+ "\t-v Print program version info\n" \
"\t-V Print program version info\n\n";
static void clear_events(struct pollfd *pfd)
diff --git a/doc/blktrace.8 b/doc/blktrace.8
index 598e1ed..b5e69b7 100644
--- a/doc/blktrace.8
+++ b/doc/blktrace.8
@@ -105,23 +105,59 @@ 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
\-n \fInum\-sub\fR
.br
-\-\-num\-sub=\fInum-sub\fR
+\-\-num\-sub\-buffers=\fInum-sub\fR
.RS
Specifies number of buffers to use. blktrace defaults to 4 sub buffers.
.RE
-\-o \fIfile\fR
+\-l
.br
-\-\-output=\fIfile\fR
+\-\-listen
.RS
-Prepend \fIfile\fR to output file name(s)
+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
+
+\-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.
@@ -134,9 +170,17 @@ via "-o -" with multiple devices.
Specifies debugfs mount point
.RE
+\-v
+.br
+\-\-version
+.RS
+Outputs version
+.RE
+
\-V
.br
-\-\-version
+\-\-version
+.RS
Outputs version
.RE