X-Git-Url: https://git.kernel.dk/?a=blobdiff_plain;f=README;h=2eec1a2a92d8a92b2296b99c381713c037423144;hb=a9523c6f4a43e4bbf942ee49068fe4f052c6991d;hp=0f91c66ff6430123032cf890f9bed826401ea4b3;hpb=d85b1add6f6dc9d186478345a3552a835ac3166b;p=fio.git diff --git a/README b/README index 0f91c66f..2eec1a2a 100644 --- a/README +++ b/README @@ -54,6 +54,10 @@ Packages for Solaris are available from OpenCSW. Install their pkgutil tool (http://www.opencsw.org/get-it/pkgutil/) and then install fio via 'pkgutil -i fio'. +Windows: +Bruce Cran has fio packages for Windows at +http://www.bluestop.org/fio . + Mailing list ------------ @@ -79,10 +83,10 @@ http://maillist.kernel.dk/fio-devel/ Building -------- -Just type 'make' and 'make install'. If on FreeBSD, for now you have to -specify the FreeBSD Makefile with -f and use gmake (not make), eg: +Just type 'make' and 'make install'. If on BSD, for now you have to +specify the BSD Makefile with -f and use gmake (not make), eg: -$ gmake -f Makefile.Freebsd && gmake -f Makefile.FreeBSD install +$ gmake -f Makefile.FreeBSD && gmake -f Makefile.FreeBSD install Same goes for AIX: @@ -125,6 +129,7 @@ $ fio May be "always", "never" or "auto" --section=name Only run specified section in job file --alloc-size=kb Set smalloc pool to this size in kb (def 1024) + --warnings-fatal Fio parser warnings are fatal Any parameters following the options will be assumed to be job files, @@ -132,7 +137,7 @@ 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 +The --readonly switch is an extra safety guard to prevent accidentally 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 @@ -208,7 +213,8 @@ 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, solarisaio for Solaris - native async IO, sync for regular read/write io, + native async IO, windowsaio for Windows 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 @@ -274,7 +280,9 @@ The job file parameters are: and length entries being in bytes. write_iolog=x Write an iolog to file 'x' in the same format as iolog. The iolog options are exclusive, if both given the - read iolog will be performed. + read iolog will be performed. Specify a separate file + for each job, otherwise the iologs will be interspersed + and the file may be corrupt. write_bw_log Write a bandwidth log. write_lat_log Write a latency log. lockmem=x Lock down x amount of memory on the machine, to @@ -293,8 +301,8 @@ The job file parameters are: Platforms --------- -Fio works on (at least) Linux, Solaris, AIX, OSX, NetBSD, and FreeBSD. Some -features and/or options may only be available on some of the platforms, +Fio works on (at least) Linux, Solaris, AIX, OSX, NetBSD, Windows and FreeBSD. +Some features and/or options may only be available on some of the platforms, typically because those features only apply to that platform (like the solarisaio engine, or the splice engine on Linux).