Add pread/pwrite support to sync engine

[fio.git] / README

diff --git a/README b/README
index a56f633767a36958d8818087d1bf6eeadce91e0b..3ef13eaa1a36d1453561ebd1dc330948637eb8b1 100644 (file)
--- a/README
+++ b/README
@@ -14,7 +14,7 @@ Source
 
 fio resides in a git repo, the canonical place is:
 
-git://git.kernel.dk/data/git/fio.git
+git://git.kernel.dk/fio.git
 
 The http protocol also works, path is the same.
 
@@ -32,6 +32,9 @@ 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
 ------------
@@ -68,21 +71,31 @@ $ fio
        --help          Print this page
        --cmdhelp=cmd   Print command help, "all" for all of them
        --showcmd       Turn a job file into command line options
+       --readonly      Turn on safety read-only checks
+       --eta=when      When ETA estimate should be printed
+                       May be "always", "never" or "auto"
+
 
 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.
 
+The --readonly switch is an extra safety guard to prevent accidentically
+turning on a write setting when that is not desired. Fio will only write
+if rw=write/randwrite/rw/randrw is given, but this extra safety net can
+be used as an extra precaution. It will also enable a write check in the
+io engine core to prevent an accidental write due to a fio bug.
+
 
 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:
 
@@ -107,13 +120,14 @@ 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, 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.
+                       psync for regular pread/pwrite io, 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,
@@ -129,6 +143,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.