X-Git-Url: https://git.kernel.dk/?p=fio.git;a=blobdiff_plain;f=HOWTO;h=2403a5cd13048fc27e3a89de406cddbba6560aeb;hp=34c3505a39d561f431de2d2d76128321177cb8fc;hb=de890a1e48d40238dac69f302708dde8719de240;hpb=5e726d0a29b815f526f835e44afe3225522c6c20

diff --git a/HOWTO b/HOWTO
index 34c3505a..2403a5cd 100644
--- a/HOWTO
+++ b/HOWTO
@@ -524,16 +524,7 @@ ioengine=str	Defines how the job issues io to the file. The following
 			libaio	Linux native asynchronous io. Note that Linux
 				may only support queued behaviour with
 				non-buffered IO (set direct=1 or buffered=0).
-				This engine also has a sub-option,
-				userspace_reap. To set it, use
-				ioengine=libaio:userspace_reap. Normally, with
-				the libaio engine in use, fio will use the
-				io_getevents system call to reap newly returned
-				events. With this flag turned on, the AIO ring
-				will be read directly from user-space to reap
-				events. The reaping mode is only enabled when
-				polling for a minimum of 0 events (eg when
-				iodepth_batch_complete=0).
+				This engine defines engine specific options.
 
 			posixaio glibc posix asynchronous io.
 
@@ -562,16 +553,16 @@ ioengine=str	Defines how the job issues io to the file. The following
 				itself and for debugging/testing purposes.
 
 			net	Transfer over the network to given host:port.
-				'filename' must be set appropriately to
-				filename=host/port/protocol regardless of send
-				or receive, if the latter only the port
-				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.
+				Depending on the protocol used, the hostname,
+				port, listen and filename options are used to
+				specify what sort of connection to make, while
+				the protocol option determines which protocol
+				will be used.
+				This engine defines engine specific options.
 
 			netsplice Like net, but uses splice/vmsplice to
 				map data and send/receive.
+				This engine defines engine specific options.
 
 			cpuio	Doesn't transfer any data, but burns CPU
 				cycles according to the cpuload= and
@@ -981,7 +972,7 @@ verify_fatal=bool	Normally fio will keep checking the entire contents
 verify_dump=bool	If set, dump the contents of both the original data
 		block and the data block we read off disk to files. This
 		allows later analysis to inspect just what kind of data
-		corruption occurred. On by default.
+		corruption occurred. Off by default.
 
 verify_async=int	Fio will normally verify IO inline from the submitting
 		thread. This option takes an integer describing how many
@@ -1210,6 +1201,45 @@ uid=int		Instead of running as the invoking user, set the user ID to
 
 gid=int		Set group ID, see uid.
 
+In addition, there are some parameters which are only valid when a specific
+ioengine is in use. These are used identically to normal parameters, with the
+caveat that when used on the command line, they must come after the ioengine
+that defines them is selected.
+
+[libaio] userspace_reap Normally, with the libaio engine in use, fio will use
+		the io_getevents system call to reap newly returned events.
+		With this flag turned on, the AIO ring will be read directly
+		from user-space to reap events. The reaping mode is only
+		enabled when polling for a minimum of 0 events (eg when
+		iodepth_batch_complete=0).
+
+[netsplice] hostname=str
+[net] hostname=str The host name or IP address to use for TCP or UDP based IO.
+		If the job is a TCP listener or UDP reader, the hostname is not
+		used and must be omitted.
+
+[netsplice] port=int
+[net] port=int	The TCP or UDP port to bind to or connect to.
+
+[netsplice] protocol=str
+[netsplice] proto=str
+[net] protocol=str
+[net] proto=str	The network protocol to use. Accepted values are:
+
+			tcp	Transmission control protocol
+			udp	Unreliable datagram protocol
+			unix	UNIX domain socket
+
+		When the protocol is TCP or UDP, the port must also be given,
+		as well as the hostname if the job is a TCP listener or UDP
+		reader. For unix sockets, the normal filename option should be
+		used and the port is invalid.
+
+[net] listen	For TCP network connections, tell fio to listen for incoming
+		connections rather than initiating an outgoing connection. The
+		hostname must be omitted if this option is used.
+
+
 6.0 Interpreting the output
 ---------------------------
 
@@ -1382,8 +1412,7 @@ Split up, the format is as follows:
 	Disk utilization: Disk name, Read ios, write ios,
 			  Read merges, write merges,
 			  Read ticks, write ticks,
-			  Read in-queue time, write in-queue time,
-			  Disk utilization percentage
+			  Time spent in queue, disk utilization percentage
 	Additional Info (dependant on continue_on_error, default off): total # errors, first error code 
 	
 	Additional Info (dependant on description being set): Text description