[PATCH] Update irange documentation

[fio.git] / HOWTO

diff --git a/HOWTO b/HOWTO
index c9d29f299bd4109fcbcf3c504925986d28979c18..4370c9f3607ff7fdc1b72f380dcc9eb3bf3662a3 100644 (file)
--- a/HOWTO
+++ b/HOWTO
@@ -179,7 +179,10 @@ siint      SI integer. A whole number value, which may contain a postfix
 bool   Boolean. Usually parsed as an integer, however only defined for
        true and false (1 and 0).
 irange Integer range with postfix. Allows value range to be given, such
-       as 1024-4096. Also see siint.
+       as 1024-4096. A colon may also be used as the seperator, eg
+       1k:4k. If the option allows two sets of ranges, they can be
+       specified with a ',' or '/' delimiter: 1k-4k/8k-32k. Also see
+       siint.
 
 With the above in mind, here follows the complete list of fio job
 parameters.
@@ -211,6 +214,9 @@ rw=str              Type of io pattern. Accepted values are:
                For certain types of io the result may still be skewed a bit,
                since the speed may be different.
 
+randrepeat=bool        For random IO workloads, seed the generator in a predictable
+               way so that results are repeatable across repetitions.
+
 size=siint     The total size of file io for this job. This may describe
                the size of the single file the job uses, or it may be
                divided between the number of files in the job. If the
@@ -274,7 +280,10 @@ iodepth=int        This defines how many io units to keep in flight against
                concurrency.
 
 direct=bool    If value is true, use non-buffered io. This is usually
-               O_DIRECT. Defaults to true.
+               O_DIRECT.
+
+buffered=bool  If value is true, use buffered io. This is the opposite
+               of the 'direct' option. Defaults to true.
 
 offset=siint   Start io at the given offset in the file. The data before
                the given offset will not be touched. This effectively
@@ -344,7 +353,7 @@ startdelay=int      Start this job the specified number of seconds after fio
                jobs, and you want to delay starting some jobs to a certain
                time.
 
-timeout=int    Tell fio to terminate processing after the specified number
+runtime=int    Tell fio to terminate processing after the specified number
                of seconds. It can be quite hard to determine for how long
                a specified job will run, so this parameter is handy to
                cap the total runtime to a given time.
@@ -414,7 +423,7 @@ create_serialize=bool       If true, serialize the file creating for the jobs.
 create_fsync=bool      fsync the data file after creation. This is the
                        default.
 
-unlink         Unlink the job files when done. fio defaults to doing this,
+unlink=bool    Unlink the job files when done. fio defaults to doing this,
                if it created the file itself.
 
 loops=int      Run the specified number of iterations of this job. Used
@@ -526,9 +535,9 @@ direction, the output looks like:
 
 Client1 (g=0): err= 0:
   write: io=    32MiB, bw=   666KiB/s, runt= 50320msec
-    slat (msec): min=    0, max=  136, avg= 0.03, dev= 1.92
-    clat (msec): min=    0, max=  631, avg=48.50, dev=86.82
-    bw (KiB/s) : min=    0, max= 1196, per=51.00%, avg=664.02, dev=681.68
+    slat (msec): min=    0, max=  136, avg= 0.03, stdev= 1.92
+    clat (msec): min=    0, max=  631, avg=48.50, stdev=86.82
+    bw (KiB/s) : min=    0, max= 1196, per=51.00%, avg=664.02, stdev=681.68
   cpu        : usr=1.49%, sys=0.25%, ctx=7969
 
 The client number is printed, along with the group id and error of that