Commit e983afc7 authored by Kir Kolyshkin's avatar Kir Kolyshkin Committed by Konstantin Khlebnikov

ioping.1: assorted improvements

(1) Use .SY/.OP/.YS macros for SYNOPSYS

(2) Simplify OPTIONS formatting using .BI and .B

(3) Fix a few cases where - was not prepended by \

(4) s/below/following/g

(5) Note that suffixes are case-insensitive

(5) Highlight the flags implied by -R

(6) s/Rate-test/Disk seek rate test/

(7) s/page/a page/
Signed-off-by: default avatarKir Kolyshkin <kir@openvz.org>
Signed-off-by: default avatarKonstantin Khlebnikov <koct9i@gmail.com>
parent 75bf081a
.TH IOPING "1" "May 2011" "" "User Commands" .TH IOPING "1" "June 2011" "" "User Commands"
.SH NAME .SH NAME
ioping \- simple disk I/O latency monitoring tool ioping \- simple disk I/O latency monitoring tool
.SH SYNOPSYS .SH SYNOPSYS
\fBioping\fR [\fB\-LCDRhq\fR] [\fB\-c \fIcount\fR] [\fB\-w \fIdeadline\fR] \ .SY ioping
[\fB\-p \fIperiod\fR] [\fB\-i \fIinterval\fR] [\fB\-s \fIsize\fR] \ .OP \-LCDRhq
[\fB\-S \fIwsize\fR] [\fB\-o \fIoffset\fR] \ .OP \-c count
\fIdevice\fR | \fIfile\fR | \fIdirectory\fR .OP \-w deadline
.OP \-p period
.OP \-i interval
.OP \-s size
.OP \-S wsize
.OP \-o offset
.IR device | file | directory
.YS
.SH DESCRIPTION .SH DESCRIPTION
This tool lets you monitor I/O latency in real time. This tool lets you monitor I/O latency in real time.
.SH OPTIONS .SH OPTIONS
.TP .TP
\fB\-c\fR \fIcount\fR .BI \-c \ count
Stop after \fIcount\fR requests. Stop after \fIcount\fR requests.
.TP .TP
\fB\-w\fR \fIdeadline\fR .BI \-w \ deadline
Stop after \fIdeadline\fR time passed. Stop after \fIdeadline\fR time passed.
.TP .TP
\fB\-p\fR \fIperiod\fR .BI \-p \ period
Print raw statistics for every \fIperiod\fR requests. Print raw statistics for every \fIperiod\fR requests.
.TP .TP
\fB\-i\fR \fIinterval\fR .BI \-i \ interval
Set time between requests to \fIinterval\fR. Set time between requests to \fIinterval\fR.
.TP .TP
\fB\-s\fR \fIsize\fR .BI \-s \ size
Request size. Request size.
.TP .TP
\fB\-S\fR \fIwsize\fR .BI \-S \ size
Working set size. Working set size.
.TP .TP
\fB\-o\fR \fIoffset\fR .BI \-o \ offset
Offset in input file. Offset in input file.
.TP .TP
\fB\-L\fR .B \-L
Use sequential operations rather than random. Use sequential operations rather than random.
.TP .TP
\fB\-C\fR .B \-C
Use cached I/O. Use cached I/O.
.TP .TP
\fB\-D\fR .B \-D
Use direct I/O. Use direct I/O.
.TP .TP
\fB\-R\fR .B \-R
Rate-test, implies: -q -i 0 -w 3 Disk seek rate test, implies \fB-q -i 0 -w 3\fR flags.
.TP .TP
\fB\-h\fR .B \-h
Display help message and exit. Display help message and exit.
.TP .TP
\fB\-q\fR .B \-q
Suppress human-readable output. Suppress human-readable output.
.SS Argument suffixes .SS Argument suffixes
For options that expect time argument (\fB\-i\fR and \fB-w\fR), For options that expect time argument (\fB\-i\fR and \fB\-w\fR),
default is seconds, unless you specify one of the below suffixes: default is seconds, unless you specify one of the following suffixes
(case-insensitive):
.TP .TP
\fBus\fR, \fBusec\fR .BR us ,\ usec
microseconds microseconds
.TP .TP
\fBms\fR, \fBmsec\fR .BR ms ,\ msec
milliseconds milliseconds
.TP .TP
\fBs\fR, \fBsec\fR .BR s ,\ sec
seconds seconds
.TP .TP
\fBm\fR, \fBmin\fR .BR m ,\ min
minutes minutes
.TP .TP
\fBh\fR, \fBhour\fR .BR h ,\ hour
hours hours
.PP .PP
For options that expect "size" argument (\fB-s\fR, \fB-S\fR and \fB-o\fR), For options that expect "size" argument (\fB\-s\fR, \fB\-S\fR and \fB\-o\fR),
default is bytes, unless you specify one of the below suffixes: default is bytes, unless you specify one of the following suffixes
(case-insensitive):
.TP .TP
\fBk\fR, \fBkb\fR .BR k ,\ kb
kilobytes kilobytes
.TP .TP
\fBp\fR .B p
memory pages (page is always 4K). memory pages (a page is always 4K).
.TP .TP
\fBm\fR, \fBmb\fR .BR m ,\ mb
megabytes megabytes
.TP .TP
\fBg\fR, \fBgb\fR .BR g ,\ gb
gigabytes gigabytes
.SH EXIT STATUS .SH EXIT STATUS
Returns \fB0\fR upon success. The following error codes are defined: Returns \fB0\fR upon success. The following error codes are defined:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment