Fix splice engine compile
[fio.git] / README
diff --git a/README b/README
index f7d7457732b0a8202d15a7637d328ca58d8fba34..76aa22d69212e86b799ee15d2e4db3c5e5d4c987 100644 (file)
--- a/README
+++ b/README
@@ -14,18 +14,27 @@ Source
 
 fio resides in a git repo, the canonical place is:
 
-git://brick.kernel.dk/data/git/fio.git
+git://git.kernel.dk/fio.git
+
+The http protocol also works, path is the same.
 
 Snapshots are frequently generated and they include the git meta data as
 well. You can download them here:
 
 http://brick.kernel.dk/snaps/
 
-Pascal Bleser <guru@unixtech.be> has fio RPMs in his repository, you
-can find them here:
+Pascal Bleser <guru@unixtech.be> has fio RPMs in his repository for
+SUSE variants, you can find them here:
 
 http://linux01.gwdg.de/~pbleser/rpm-navigation.php?cat=System/fio
 
+Dag WieĆ«rs has RPMs for Red Hat related distros, find them here:
+
+http://dag.wieers.com/rpm/packages/fio/
+
+Mandriva has integrated fio into their package repository, so installing
+on that distro should be as easy as typing 'urpmi fio'.
+
 
 Mailing list
 ------------
@@ -61,6 +70,7 @@ $ fio
         --version       Print version info and exit
        --help          Print this page
        --cmdhelp=cmd   Print command help, "all" for all of them
+       --showcmd       Turn a job file into command line options
 
 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,
@@ -72,10 +82,10 @@ Job file
 --------
 
 See the HOWTO file for a more detailed description of parameters and what
-they mean. This file contains the terse version.  Only a few options can
-be controlled with command line parameters, generally it's a lot easier to
+they mean. This file contains the terse version. You can describe big and
+complex setups with the command line, but generally it's a lot easier to
 just write a simple job file to describe the workload. The job file format
-is in the ini style format, as it's easy to read and write for the user.
+is in the ini style format, as that is easy to read and write for the user.
 
 The job file parameters are:
 
@@ -100,12 +110,13 @@ The job file parameters are:
        size=x          Set file size to x bytes (x string can include k/m/g)
        ioengine=x      'x' may be: aio/libaio/linuxaio for Linux aio,
                        posixaio for POSIX aio, sync for regular read/write io,
-                       mmap for mmap'ed io, splice for using splice/vmsplice,
-                       sgio for direct SG_IO io, or net for network io. sgio
-                       only works on Linux on SCSI (or SCSI-like devices,
-                       such as usb-storage or sata/libata driven) devices.
-                       Fio also has a null io engine, which is mainly used
-                       for testing fio itself.
+                       mmap for mmap'ed io, syslet-rw for syslet driven
+                       read/write, splice for using splice/vmsplice,
+                       sgio for direct SG_IO io, net for network io, or cpuio
+                       for a cycler burner load. sgio only works on Linux on
+                       SCSI (or SCSI-like devices, such as 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,
@@ -121,6 +132,7 @@ The job file parameters are:
        ratemin=x       Quit if rate of x KiB/sec can't be met
        ratecycle=x     ratemin averaged over x msecs
        cpumask=x       Only allow job to run on CPUs defined by mask.
+       cpus_allowed=x  Like 'cpumask', but allow text setting of CPU affinity.
        fsync=x         If writing with buffered IO, fsync after every
                        'x' blocks have been written.
        end_fsync=x     If 'x', run fsync() after end-of-job.
@@ -171,7 +183,7 @@ The job file parameters are:
        ioscheduler=x   Use ioscheduler 'x' for this job.
        cpuload=x       For a CPU io thread, percentage of CPU time to attempt
                        to burn.
-       cpuchunks=x     Split burn cycles into pieces of x.
+       cpuchunks=x     Split burn cycles into pieces of x usecs.
 
 
 Author