X-Git-Url: https://git.kernel.dk/?a=blobdiff_plain;f=README;h=75553495205c5354397235da553a536b6583b9c9;hb=8b4a7c860d004ea8dffc11f6232124b574fe6cd7;hp=db8e6724ee7745d2c81f5ae2793ad6ebdd0f8d41;hpb=2b386d2569c9078ca9790c4e6d318ec3835b8739;p=fio.git

diff --git a/README b/README
index db8e6724..75553495 100644
--- a/README
+++ b/README
@@ -50,12 +50,26 @@ Building
 --------
 
 Just type 'make' and 'make install'. If on FreeBSD, for now you have to
-specify the FreeBSD Makefile with -f, eg:
+specify the FreeBSD Makefile with -f and use gmake (not make), eg:
 
-$ make -f Makefile.Freebsd && make -f Makefile.FreeBSD install
+$ gmake -f Makefile.Freebsd && gmake -f Makefile.FreeBSD install
 
 Likewise with OpenSolaris, use the Makefile.solaris to compile there.
-This might change in the future if I opt for an autoconf type setup.
+The OpenSolaris make should work fine. This might change in the
+future if I opt for an autoconf type setup.
+
+If your compile fails with an error like this:
+
+    CC gettime.o
+In file included from fio.h:23,
+                 from gettime.c:8:
+os/os.h:15:20: error: libaio.h: No such file or directory
+In file included from gettime.c:8:
+fio.h:119: error: field 'iocb' has incomplete type
+make: *** [gettime.o] Error 1
+
+Check that you have the libaio development package installed. On RPM
+based distros, it's typically called libaio-devel.
 
 
 Command line
@@ -103,6 +117,7 @@ options in fio. Currently the options are:
 	random		Dump info related to random offset generation
 	parse		Dump info related to option matching and parsing
 	diskutil	Dump info related to disk utilization updates
+	job:x		Dump info only related to job number x
 	? or help	Show available debug options.
 
 You can specify as many as you want, eg --debug=file,mem will enable
@@ -153,12 +168,13 @@ The job file parameters are:
 			across runs, if 'x' is 1.
 	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,
+			posixaio for POSIX aio, solarisaio for Solaris
+			native async IO, sync for regular read/write io,
 			psync for regular pread/pwrite io, vsync for regular
 			readv/writev (with queuing emulation) 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
+			using splice/vmsplice, sg for direct SG_IO io, net
+			for network io, or cpuio for a cycler burner load. sg
 			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
@@ -202,6 +218,7 @@ The job file parameters are:
 	verify=x	If 'x' == md5, use md5 for verifies. If 'x' == crc32,
 			use crc32 for verifies. md5 is 'safer', but crc32 is
 			a lot faster. Only makes sense for writing to a file.
+			For other types of checksumming, see HOWTO.
 	stonewall	Wait for preceeding jobs to end before running.
 	numjobs=x	Create 'x' similar entries for this job
 	thread		Use pthreads instead of forked jobs