Botch edit in files setup

[fio.git] / HOWTO

diff --git a/HOWTO b/HOWTO
index 731684cb9d62c7766155ba050ee66178ea19c428..2cfe36954bbf1defe8bdf5868828685e0e0027b5 100644 (file)
--- a/HOWTO
+++ b/HOWTO
@@ -237,14 +237,15 @@ filename=str      Fio normally makes up a filename based on the job name,
                thread number, and file number. If you want to share
                files between threads in a job or several jobs, specify
                a filename for each of them to override the default. If
-               the ioengine used is 'net', the filename is the host and
-               port to connect to in the format of =host/port. If the
-               ioengine is file based, you can specify a number of files
-               by separating the names with a ':' colon. So if you wanted
-               a job to open /dev/sda and /dev/sdb as the two working files,
-               you would use filename=/dev/sda:/dev/sdb. '-' is a reserved
-               name, meaning stdin or stdout. Which of the two depends
-               on the read/write direction set.
+               the ioengine used is 'net', the filename is the host, port,
+               and protocol to use in the format of =host/port/protocol.
+               See ioengine=net for more. If the ioengine is file based, you
+               can specify a number of files by separating the names with a
+               ':' colon. So if you wanted a job to open /dev/sda and /dev/sdb
+               as the two working files, you would use
+               filename=/dev/sda:/dev/sdb. '-' is a reserved name, meaning
+               stdin or stdout. Which of the two depends on the read/write
+               direction set.
 
 opendir=str    Tell fio to recursively add any file it can find in this
                directory and down the file system tree.
@@ -386,6 +387,10 @@ file_service_type=str  Defines how fio decides which file from a job to
                        roundrobin  Round robin over open files. This
                                is the default.
 
+                       sequential  Finish one file before moving on to
+                               the next. Multiple files can still be
+                               open depending on 'openfiles'.
+
                The string can have a number appended, indicating how
                often to switch to a new file. So if option random:4 is
                given, fio will switch to a new random file after 4 ios
@@ -401,7 +406,9 @@ ioengine=str        Defines how the job issues io to the file. The following
 
                        vsync   Basic readv(2) or writev(2) IO.
 
-                       libaio  Linux native asynchronous io.
+                       libaio  Linux native asynchronous io. Note that Linux
+                               may only support queued behaviour with
+                               non-buffered IO (set direct=1 or buffered=0).
 
                        posixaio glibc posix asynchronous io.
 
@@ -429,9 +436,12 @@ ioengine=str       Defines how the job issues io to the file. The following
 
                        net     Transfer over the network to given host:port.
                                'filename' must be set appropriately to
-                               filename=host/port regardless of send
+                               filename=host/port/protocol regardless of send
                                or receive, if the latter only the port
-                               argument is used.
+                               argument is used. 'host' may be an IP address
+                               or hostname, port is the port number to be used,
+                               and protocol may be 'udp' or 'tcp'. If no
+                               protocol is given, TCP is used.
 
                        netsplice Like net, but uses splice/vmsplice to
                                map data and send/receive.
@@ -526,9 +536,9 @@ norandommap Normally fio will cover every block of the file when doing
                new random offset without looking at past io history. This
                means that some blocks may not be read or written, and that
                some blocks may be read/written more than once. This option
-               is mutually exclusive with verify= for that reason, since
-               fio doesn't track potential block rewrites which may alter
-               the calculated checksum for that block.
+               is mutually exclusive with verify= if and only if multiple
+               blocksizes (via bsrange=) are used, since fio only tracks
+               complete rewrites of blocks.
 
 softrandommap  See norandommap. If fio runs with the random block map enabled
                and it fails to allocate the map, if this option is set it
@@ -683,6 +693,9 @@ 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.
 
+create_on_open=bool    Don't pre-setup the files for IO, just create open()
+                       when it's time to do IO to that file.
+
 unlink=bool    Unlink the job files when done. Not the default, as repeated
                runs of that job would then waste time recreating the file
                set again and again.