Update man page
authorSitsofe Wheeler <sitsofe@yahoo.com>
Fri, 27 Sep 2013 12:17:59 +0000 (13:17 +0100)
committerSitsofe Wheeler <sitsofe@yahoo.com>
Mon, 30 Sep 2013 10:54:10 +0000 (11:54 +0100)
Many of fio's options are not described in the man page. Copy the short
text to the man page for those commands listed by:

./fio --cmdhelp=all | sed 's/ *:.*$//' | sed 's/ \+//' \
| while read line; do grep "\b$line\b" -q fio.1; if [[ $? -eq 1 ]]; then \
echo $line; fi; done

Signed-off-by: Sitsofe Wheeler <sitsofe@yahoo.com>
fio.1

diff --git a/fio.1 b/fio.1
index 34669665bfdbe59fbd00c22fbeb9dbdcfc4d13e5..ab2fae9d7e8d92ecfde71166a54e13b67a97f337 100644 (file)
--- a/fio.1
+++ b/fio.1
@@ -219,12 +219,18 @@ Sequential reads.
 .B write
 Sequential writes.
 .TP
+.B trim
+Sequential trim (Linux block devices only).
+.TP
 .B randread
 Random reads.
 .TP
 .B randwrite
 Random writes.
 .TP
+.B randtrim
+Random trim (Linux block devices only).
+.TP
 .B rw, readwrite
 Mixed sequential reads and writes.
 .TP
@@ -592,6 +598,9 @@ How many I/Os to perform before issuing an \fBfsync\fR\|(2) of dirty data.  If
 Like \fBfsync\fR, but uses \fBfdatasync\fR\|(2) instead to only sync the
 data parts of the file. Default: 0.
 .TP
+.BI write_barrier \fR=\fPint
+Make every Nth write a barrier write.
+.TP
 .BI sync_file_range \fR=\fPstr:int
 Use sync_file_range() for every \fRval\fP number of write operations. Fio will
 track range of writes that have happened since the last sync_file_range() call.
@@ -926,6 +935,9 @@ be of the newly written data.
 If true, written verify blocks are sorted if \fBfio\fR deems it to be faster to
 read them back in a sorted manner.  Default: true.
 .TP
+.BI verifysort_nr \fR=\fPint
+Pre-load and sort verify blocks for a read workload.
+.TP
 .BI verify_offset \fR=\fPint
 Swap the verification header with data somewhere else in the block before
 writing.  It is swapped back before verifying.
@@ -981,6 +993,21 @@ read back and verified).  If \fBverify_backlog_batch\fR is less than
 \fBverify_backlog_batch\fR is larger than \fBverify_backlog\fR,  some blocks
 will be verified more than once.
 .TP
+.BI trim_percentage \fR=\fPint
+Number of verify blocks to discard/trim.
+.TP
+.BI trim_verify_zero \fR=\fPbool
+Verify that trim/discarded blocks are returned as zeroes.
+.TP
+.BI trim_backlog \fR=\fPint
+Trim after this number of blocks are written.
+.TP
+.BI trim_backlog_batch \fR=\fPint
+Trim this number of IO blocks.
+.TP
+.BI experimental_verify \fR=\fPbool
+Enable experimental verification.
+.TP
 .B stonewall "\fR,\fP wait_for_previous"
 Wait for preceding jobs in the job file to exit before starting this one.
 \fBstonewall\fR implies \fBnew_group\fR.
@@ -1004,6 +1031,9 @@ with \fBfork\fR\|(2).
 .BI zonesize \fR=\fPint
 Divide file into zones of the specified size in bytes.  See \fBzoneskip\fR.
 .TP
+.BI zonerange \fR=\fPint
+Give size of an IO zone.  See \fBzoneskip\fR.
+.TP
 .BI zoneskip \fR=\fPint
 Skip the specified number of bytes when \fBzonesize\fR bytes of data have been
 read.
@@ -1152,6 +1182,9 @@ This option will ignore EAGAIN from READ, and ENOSPC and 122(EDQUOT) from WRITE.
 If set dump every error even if it is non fatal, true by default. If disabled
 only fatal error will be dumped
 .TP
+.BI profile \fR=\fPstr
+Select a specific builtin performance test.
+.TP
 .BI cgroup \fR=\fPstr
 Add job to this control group. If it doesn't exist, it will be created.
 The system must have a mounted cgroup blkio mount point for this to work. If
@@ -1176,6 +1209,21 @@ the thread/process does any work.
 .BI gid \fR=\fPint
 Set group ID, see \fBuid\fR.
 .TP
+.BI unit_base \fR=\fPint
+Base unit for reporting.  Allowed values are:
+.RS
+.TP
+.B 0
+Use auto-detection (default).
+.TP
+.B 8
+Byte based.
+.TP
+.B 1
+Bit based.
+.RE
+.P
+.TP
 .BI flow_id \fR=\fPint
 The ID of the flow. If not specified, it defaults to being a global flow. See
 \fBflow\fR.