X-Git-Url: https://git.kernel.dk/?p=fio.git;a=blobdiff_plain;f=README;h=b7fc96b6888d1032bf04cbbb5f8c5f309fa18e7c;hp=0d7de7eb1ca7f5d02cc8713f68325a77632a8d7e;hb=724e4435c1374e97309b122429ad9291744966c0;hpb=d0ff85dfc86a8c62807ba0f6faa8e04cca64bcb8

diff --git a/README b/README
index 0d7de7eb..b7fc96b6 100644
--- 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,21 +70,29 @@ $ 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
+	--readonly	Turn on safety read-only checks
 
 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:
 
@@ -102,11 +119,11 @@ The job file parameters are:
 			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, 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.
+			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,
@@ -122,6 +139,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.
@@ -172,7 +190,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