X-Git-Url: https://git.kernel.dk/?a=blobdiff_plain;f=README;h=ede4c81452fd8ca248752a981db582a71636d92c;hb=fad82f76eaa03e2f486315537e9d83809d155d58;hp=eef8dc9036e5bc849f477955f79bf7591742de65;hpb=53adf64fba2457b922d5afeee500dcbad5ce963c;p=fio.git diff --git a/README b/README index eef8dc90..ede4c814 100644 --- a/README +++ b/README @@ -83,18 +83,11 @@ http://maillist.kernel.dk/fio-devel/ Building -------- -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: +Just type 'make' and 'make install'. -$ gmake -f Makefile.FreeBSD && gmake -f Makefile.FreeBSD install - -Same goes for AIX: - -$ gmake -f Makefile.aix && gmake -f Makefile.aix install - -Likewise with OpenSolaris, use the Makefile.solaris to compile there. -The OpenSolaris make should work fine. This might change in the -future if I opt for an autoconf type setup. +Note that GNU make is required. On BSD it's available from devel/gmake; +on Solaris it's in the SUNWgmake package. On platforms where GNU make +isn't the default, type 'gmake' instead of 'make'. If your compile fails with an error like this: @@ -116,9 +109,9 @@ Windows On Windows Cygwin (http://www.cygwin.com) is required with at least devel/gcc4 and devel/make installed in order to build fio, and admin/cygrunsrv to run it. You can also install devel/git to fetch/update -the source files. To create an MSI installer package, install WiX 3.6 from -http://wix.sourceforge.net/releases/ and run dobuild.cmd from the -os/windows directory. +the source files. To create an MSI installer package put a copy of Cygwin +in os\windows\fio, install WiX 3.6 from http://wix.sourceforge.net/releases/ +and run dobuild.cmd from the os/windows directory. Before running fio you'll need to have a copy of cygserver running. Run "/usr/bin/cygserver-config" from an elevated Cygwin shell (i.e. launch the @@ -134,22 +127,26 @@ Command line ------------ $ fio - --debug Enable some debugging options (see below) - --output Write output to file - --timeout Runtime in seconds - --latency-log Generate per-job latency logs - --bandwidth-log Generate per-job bandwidth logs - --minimal Minimal (terse) output - --version Print version info and exit - --help Print this page + --debug Enable some debugging options (see below) + --output Write output to file + --timeout Runtime in seconds + --latency-log Generate per-job latency logs + --bandwidth-log Generate per-job bandwidth logs + --minimal Minimal (terse) output + --version Print version info and exit + --terse-version=type Terse version output format + --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, preventing writes - --eta=when When ETA estimate should be printed - May be "always", "never" or "auto" - --section=name Only run specified section in job file + --showcmd Turn a job file into command line options + --readonly Turn on safety read-only checks, preventing + writes + --eta=when When ETA estimate should be printed + May be "always", "never" or "auto" + --section=name Only run specified section in job file. Multiple + sections can be specified. --alloc-size=kb Set smalloc pool to this size in kb (def 1024) --warnings-fatal Fio parser warnings are fatal + --max-jobs Maximum number of threads/processes to support Any parameters following the options will be assumed to be job files, @@ -168,11 +165,11 @@ options in fio. Currently the options are: process Dump info related to processes file Dump info related to file actions - io Dump info related to IO queuing - mem Dump info related to memory allocations + io Dump info related to IO queuing + mem Dump info related to memory allocations blktrace Dump info related to blktrace setup verify Dump info related to IO verification - all Enable all debug options + all Enable all debug options 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 @@ -293,11 +290,8 @@ The job file parameters are: can be used to gauge hard drive speed over the entire platter, without reading everything. Both x/y can include k/m/g suffix. - iolog=x Open and read io pattern from file 'x'. The file must - contain one io action per line in the following format: - rw, offset, length - where with rw=0/1 for read/write, and the offset - and length entries being in bytes. + read_iolog=x Open and read io pattern from file 'x'. The file format + is described in the HOWTO. 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. Specify a separate file @@ -321,10 +315,10 @@ The job file parameters are: 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). +Fio works on (at least) Linux, Solaris, AIX, HP-UX, 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). Some features are not available on FreeBSD/Solaris even if they could be implemented, I'd be happy to take patches for that. An example of that is