Update documentation on new terse format and add version number

[fio.git] / fio.1

diff --git a/fio.1 b/fio.1
index 0e6095d6499b1f33e8cd1937a17ecbdd2fa548b5..77773a0cb42db641fc1fd713b8a4130ba6b6a908 100644 (file)
--- a/fio.1
+++ b/fio.1
@@ -199,7 +199,9 @@ are likely to be issued. Default: true.
 Total size of I/O for this job.  \fBfio\fR will run until this many bytes have
 been transfered, unless limited by other options (\fBruntime\fR, for instance).
 Unless \fBnr_files\fR and \fBfilesize\fR options are given, this amount will be
-divided between the available files for the job.
+divided between the available files for the job. If not set, fio will use the
+full size of the given files or devices. If the the files do not exist, size
+must be given.
 .TP
 .BI fill_device \fR=\fPbool
 Sets size to something really large and waits for ENOSPC (no space left on
@@ -722,17 +724,20 @@ Same as \fBwrite_bw_log\fR, but writes I/O completion latencies.  If no
 filename is given with this option, the default filename of "jobname_type.log"
 is used. Even if the filename is given, fio will still append the type of log.
 .TP
-.B disable_clat \fR=\fPbool
-Disable measurements of completion latency numbers. Useful only for cutting
+.B disable_lat \fR=\fPbool
+Disable measurements of total latency numbers. Useful only for cutting
 back the number of calls to gettimeofday, as that does impact performance at
 really high IOPS rates.  Note that to really get rid of a large amount of these
 calls, this option must be used with disable_slat and disable_bw as well.
 .TP
+.B disable_clat \fR=\fPbool
+Disable measurements of submission latency numbers. See \fBdisable_lat\fR.
+.TP
 .B disable_slat \fR=\fPbool
-Disable measurements of submission latency numbers. See \fBdisable_clat\fR.
+Disable measurements of submission latency numbers. See \fBdisable_lat\fR.
 .TP
 .B disable_bw_measurement \fR=\fPbool
-Disable measurements of throughput/bandwidth numbers. See \fBdisable_clat\fR.
+Disable measurements of throughput/bandwidth numbers. See \fBdisable_lat\fR.
 .TP
 .BI lockmem \fR=\fPint
 Pin the specified amount of memory with \fBmlock\fR\|(2).  Can be used to
@@ -946,10 +951,13 @@ Disk utilization.
 .PD
 .SH TERSE OUTPUT
 If the \fB\-\-minimal\fR option is given, the results will be printed in a
-semicolon-delimited format suitable for scripted use.  The fields are:
+semicolon-delimited format suitable for scripted use.  Note that the first
+number in the line is the version number. If the output has to be changed
+for some reason, this number will be incremented by 1 to signify that
+change.  The fields are:
 .P
 .RS
-.B jobname, groupid, error
+.B version, jobname, groupid, error
 .P
 Read status:
 .RS
@@ -963,6 +971,10 @@ Completion latency:
 .RS
 .B min, max, mean, standard deviation
 .RE
+Total latency:
+.RS
+.B min, max, mean, standard deviation
+.RE
 Bandwidth:
 .RS
 .B min, max, aggregate percentage of total, mean, standard deviation
@@ -981,6 +993,10 @@ Completion latency:
 .RS
 .B min, max, mean, standard deviation
 .RE
+Total latency:
+.RS
+.B min, max, mean, standard deviation
+.RE
 Bandwidth:
 .RS
 .B min, max, aggregate percentage of total, mean, standard deviation