fio: make gui capture text ops
[fio.git] / README
diff --git a/README b/README
index 26b59099e5e86886a8255a0a36a34fb7b36d2574..c21fb6a97c6e37b3a0d5c37a0d21160da450425e 100644 (file)
--- a/README
+++ b/README
@@ -109,21 +109,10 @@ based distros, it's typically called libaio-devel.
 Windows
 -------
 
-On Windows Cygwin (http://www.cygwin.com) is required with at least
-devel/gcc4 and devel/make installed in order to build fio, and
-admin/cygrunsrv to run it. You can also install devel/git to fetch/update
-the source files. To create an MSI installer package put a copy of Cygwin
-in os\windows\fio, install WiX 3.6 from http://wix.sourceforge.net/releases/
-and run dobuild.cmd from the os/windows directory.
-
-Before running fio you'll need to have a copy of cygserver running. Run 
-"/usr/bin/cygserver-config" from an elevated Cygwin shell (i.e. launch the
-Cygwin shell under the Administrator account) to configure it. Once
-configured, run "net start cygserver" to start it, or type
-"/usr/sbin/cygserver &" in the Cygwin shell to start a local copy. 
-
-If fio exits with the message "Bad system call" it normally means that
-Cygserver isn't running.
+On Windows MinGW (http://www.mingw.org/) is required in order to
+build fio. To create an MSI installer package install WiX 3.6 from
+http://wix.sourceforge.net/releases/ and run dobuild.cmd from the
+os/windows directory.
 
 
 Command line
@@ -137,9 +126,11 @@ $ fio
        --bandwidth-log         Generate per-job bandwidth logs
        --minimal               Minimal (terse) output
        --version               Print version info and exit
-       --terse-version=type    Terse version output format
+       --terse-version=type    Terse version output format (default 3, or 2).
        --help                  Print this page
        --cmdhelp=cmd           Print command help, "all" for all of them
+       --enghelp=engine        Print ioengine help, or list available ioengines
+       --enghelp=engine,cmd    Print help for an ioengine cmd
        --showcmd               Turn a job file into command line options
        --readonly              Turn on safety read-only checks, preventing
                                writes
@@ -331,28 +322,32 @@ To start the server, you would do:
 fio --server=args
 
 on that machine, where args defines what fio listens to. The arguments
-are of the form 'type:hostname or IP:port'. 'type' is either 'ip' for
-TCP/IP, or 'sock' for a local unix domain socket. 'hostname' is either
-a hostname or IP address, and 'port' is the port to listen to (only valid
-for TCP/IP, not a local socket). Some examples:
+are of the form 'type,hostname or IP,port'. 'type' is either 'ip' (or ip4)
+for TCP/IP v4, 'ip6' for TCP/IP v6, or 'sock' for a local unix domain socket.
+'hostname' is either a hostname or IP address, and 'port' is the port to
+listen to (only valid for TCP/IP, not a local socket). Some examples:
 
 1) fio --server
 
    Start a fio server, listening on all interfaces on the default port (8765).
 
-2) fio --server=ip:hostname:4444
+2) fio --server=ip:hostname,4444
 
    Start a fio server, listening on IP belonging to hostname and on port 4444.
 
-3) fio --server=:4444
+3) fio --server=ip6:::1,4444
+
+   Start a fio server, listening on IPv6 localhost ::1 and on port 4444.
+
+4) fio --server=,4444
 
    Start a fio server, listening on all interfaces on port 4444.
 
-4) fio --server=1.2.3.4
+5) fio --server=1.2.3.4
 
    Start a fio server, listening on IP 1.2.3.4 on the default port.
 
-5) fio --server=sock:/tmp/fio.sock
+6) fio --server=sock:/tmp/fio.sock
 
    Start a fio server, listening on the local socket /tmp/fio.sock.