[PATCH] Simple support for networked IO
[fio.git] / HOWTO
diff --git a/HOWTO b/HOWTO
index f4ebac9..38f5dce 100644 (file)
--- a/HOWTO
+++ b/HOWTO
@@ -203,7 +203,9 @@ directory=str       Prefix filenames with this directory. Used to places files
 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.
+               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.
 
 rw=str         Type of io pattern. Accepted values are:
 
@@ -278,6 +280,12 @@ ioengine=str       Defines how the job issues io to the file. The following
                                to. This is mainly used to exercise fio
                                itself and for debugging/testing purposes.
 
+                       net     Transfer over the network to given host:port.
+                               'filename' must be set appropriately to
+                               filename=host:port regardless of send
+                               or receive, if the latter only the port
+                               argument is used.
+
 iodepth=int    This defines how many io units to keep in flight against
                the file. The default is 1 for each file defined in this
                job, can be overridden with a larger value for higher