Merge branch 'master' of ssh://git.kernel.dk/data/git/fio

[fio.git] / README

diff --git a/README b/README
index 7e79d94a0be50a760862d09d1fbde4db6780b3b2..97251d019cb1925d43d25591473343b4f3ef4d18 100644 (file)
--- a/README
+++ b/README
@@ -27,6 +27,16 @@ can find them here:
 http://linux01.gwdg.de/~pbleser/rpm-navigation.php?cat=System/fio
 
 
+Mailing list
+------------
+
+There's a mailing list associated with fio. It's meant for general
+discussion, bug reporting, questions - basically anything that has to
+do with fio. An automated mail detailing recent commits is automatically
+sent to the list at most daily. The list address is fio-devel@kernel.dk,
+subscribe by sending an empty email to fio-devel+subscribe@kernel.dk.
+
+
 Building
 --------
 
@@ -43,17 +53,19 @@ Command line
 ------------
 
 $ fio
-       -t <sec> Runtime in seconds
-       -l Generate per-job latency logs
-       -w Generate per-job bandwidth logs
-       -o <file> Log output to file
-       -m Minimal (terse) output
-       -h Print help info
-       -v Print version information and exit
+        --output        Write output to file
+        --timeout       Runtime in seconds
+        --latency-log   Generate per-job latency logs
+        --bandwidth-log Generate per-job bandwidth logs
+        --minimal       Minimal (terse) output
+        --version       Print version info and exit
+       --help          Print this page
+       --cmdhelp=cmd   Print command help, "all" for all of them
 
-Any parameters following the options will be assumed to be job files.
-You can add as many as you want, each job file will be regarded as a
-separate group and fio will stonewall it's execution.
+Any parameters following the options will be assumed to be job files,
+unless they match a job file parameter. You can add as many as you want,
+each job file will be regarded as a separate group and fio will stonewall
+its execution.
 
 
 Job file
@@ -90,7 +102,9 @@ The job file parameters are:
                        mmap for mmap'ed io, splice for using splice/vmsplice,
                        or sgio for direct SG_IO io. The latter only works on
                        Linux on SCSI (or SCSI-like devices, such as
-                       usb-storage or sata/libata driven) devices.
+                       usb-storage or sata/libata driven) devices. Fio also
+                       has a null io engine, which is mainly used for testing
+                       fio itself.
        iodepth=x       For async io, allow 'x' ios in flight
        overwrite=x     If 'x', layout a write file first.
        nrfiles=x       Spread io load over 'x' number of files per job,