server: silence mem debug warning

[fio.git] / README

diff --git a/README b/README
index adcced65cc6027a665ed85564519b3405dd3a306..0eac41fe9da051a5979cc43adb77532003bb43dd 100644 (file)
--- a/README
+++ b/README
@@ -16,7 +16,10 @@ fio resides in a git repo, the canonical place is:
 
 git://git.kernel.dk/fio.git
 
-The http protocol also works, path is the same.
+If you are inside a corporate firewall, git:// may not always work for
+you. In that case you can use the http protocol, path is the same:
+
+http://git.kernel.dk/fio.git
 
 Snapshots are frequently generated and they include the git meta data as
 well. You can download them here:
@@ -83,18 +86,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:
-
-$ gmake -f Makefile.FreeBSD && gmake -f Makefile.FreeBSD install
-
-Same goes for AIX:
-
-$ gmake -f Makefile.aix && gmake -f Makefile.aix install
+Just type 'make' and 'make 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 +112,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
@@ -141,15 +137,19 @@ $ fio
        --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
+       --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
+       --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,
@@ -293,11 +293,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 +318,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