Sync README with fio usage output

[fio.git] / README

diff --git a/README b/README
index 5fa37f3eed33a15a15a38836cf0080edc81688fd..2fa8e1bbac41db9af25546753480f1bf370e6567 100644 (file)
--- a/README
+++ b/README
@@ -65,7 +65,7 @@ tool (http://www.opencsw.org/get-it/pkgutil/) and then install fio via
 'pkgutil -i fio'.
 
 Windows:
-Bruce Cran <bruce@cran.org.uk> has fio packages for Windows at
+Rebecca Cran <rebecca+fio@bluestop.org> has fio packages for Windows at
 http://www.bluestop.org/fio/ .
 
 
@@ -149,35 +149,35 @@ $ fio
        --parse-only            Parse options only, don't start any IO
        --output                Write output to file
        --runtime               Runtime in seconds
-       --bandwidth-log         Generate per-job bandwidth logs
+       --bandwidth-log         Generate aggregate bandwidth logs
        --minimal               Minimal (terse) output
        --output-format=type    Output format (terse,json,json+,normal)
-       --terse-version=type    Terse version output format (default 3, or 2 or 4).
+       --terse-version=type    Set terse version output format (default 3, or 2 or 4)
        --version               Print version info and exit
        --help                  Print this page
        --cpuclock-test         Perform test/validation of CPU clock
-       --crctest[=test]        Test speed of checksum functions
+       --crctest=type          Test speed of checksum functions
        --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
        --eta=when              When ETA estimate should be printed
                                May be "always", "never" or "auto"
        --eta-newline=time      Force a new line for every 'time' period passed
        --status-interval=t     Force full status dump every 't' period passed
+       --readonly              Turn on safety read-only checks, preventing writes
        --section=name          Only run specified section in job file.
                                Multiple sections can be specified.
-       --alloc-size=kb         Set smalloc pool to this size in kb (def 1024)
+       --alloc-size=kb         Set smalloc pool to this size in kb (def 16384)
        --warnings-fatal        Fio parser warnings are fatal
-       --max-jobs              Maximum number of threads/processes to support
-       --server=args           Start backend server. See Client/Server section.
-       --client=host           Connect to specified backend(s).
-       --remote-config=file    Tell fio server to load this local file
+       --max-jobs=nr           Maximum number of threads/processes to support
+       --server=args           Start a backend fio server. See Client/Server section.
+       --client=hostname       Talk to remote backend(s) fio server at hostname
+       --daemonize=pidfile     Background fio server, write pid to file
+       --remote-config=file    Tell fio server to load this local job file
        --idle-prof=option      Report cpu idleness on a system or percpu basis
                                (option=system,percpu) or run unit work
-                               calibration only (option=calibrate).
+                               calibration only (option=calibrate)
        --inflate-log=log       Inflate and output compressed log
        --trigger-file=file     Execute trigger cmd when file exists
        --trigger-timeout=t     Execute trigger af this time
@@ -218,6 +218,8 @@ Currently, additional logging is available for:
        net             Dump info related to networking connections
        rate            Dump info related to IO rate switching
        compress        Dump info related to log compress/decompress
+       steadystate     Dump info related to steady state detection
+       helperthread    Dump info related to helper thread
        ? or help       Show available debug options.
 
 One can specify multiple debug options: e.g. --debug=file,mem will enable
@@ -233,7 +235,7 @@ sections.  The reserved 'global' section is always parsed and used.
 The --alloc-size switch allows one to use a larger pool size for smalloc.
 If running large jobs with randommap enabled, fio can run out of memory.
 Smalloc is an internal allocator for shared structures from a fixed size
-memory pool. The pool size defaults to 1024k and can grow to 128 pools.
+memory pool. The pool size defaults to 16MiB and can grow to 8 pools.
 
 NOTE: While running .fio_smalloc.* backing store files are visible in /tmp.