path: root/README
AgeCommit message (Collapse)Author
2018-03-27doc: add Windows processor group behaviour and Windows target optionSitsofe Wheeler
- Add information on targeting the build against different versions of Windows to the README - Stop listing -i686 packages in the 64 bit section of the README and add a note to about them to the 32 bit build section - Rejig cpus_allowed to be before cpumask in the documentation to make people more likely to read that section first - Make it clear that CPUs specified in the cpus_allowed section are indexed from 0 (and not 1) - Add information about how processor group awareness when setting CPUs is only available when using a build targeted at Windows 7 (because only then do we have the processor group APIs available to us) and how selecting a CPU sets the processor group too (because we concatanate the CPUs from all the processor groups together) Signed-off-by: Sitsofe Wheeler <>
2018-02-21windows: document MinGW zlib install and remove custom zlib searchSitsofe Wheeler
In 5580d200d7ae49cdb4f30913e3ef2d74e431ff60 ("appveyor: install zlib and minor clean ups") I found AppVeyor builds could use a pre-built, statically linkable zlib from Cygwin/MinGW. Document the MinGW zlib packages in the README and remove the custom Windows zlib searching from the configure script. Signed-off-by: Sitsofe Wheeler <>
2018-01-05Change bluestop link to be httpsJens Axboe
Doesn't answer on http:// anymore. Also include link to AppVeyor builds for Windows, as they always build the latest and greatest. Signed-off-by: Jens Axboe <>
2017-08-18README: update/add mintty issue linksSitsofe Wheeler
Signed-off-by: Sitsofe Wheeler <>
2017-07-04man: refer to REPORTING-BUGS for bug reportingTomohiro Kusumi
REPORTING-BUGS should be mentioned here rather than README, provided REPORTING-BUGS also mentions to see README for the mailing list in addition to details of bug reporting. Signed-off-by: Tomohiro Kusumi <> Signed-off-by: Jens Axboe <>
2017-06-26README: update Red Hat fio package URLSitsofe Wheeler
Signed-off-by: Sitsofe Wheeler <>
2017-06-18<README/pkg: Add reference to Arch Linux package>Quentin Bourgeois
2017-03-14configure: add generic pshared mutex testSitsofe Wheeler
Add a feature test to configure to determine if a platform has interprocess synchronization primitives that work with threads and remove the hardcoded enablement in the individual os/os-* headers. This should work better for platforms where support was overlooked or didn't exist at some point in the past but has since been added. Also update the README to not single out FreeBSD for being thread only as this might change... This is based off work by the Boost project ( ) that found that OSX 10.6 and Cygwin are buggy even though _POSIX_THREAD_PROCESS_SHARED says this feature should be work on them. Signed-off-by: Sitsofe Wheeler <>
2017-01-27doc: minor documentation changesSitsofe Wheeler
- Change some parameter types to be time in the HOWTO. - Put a space before the end of sentence but after links in the README. - Update the Red Hat fio package information. Signed-off-by: Sitsofe Wheeler <>
2017-01-18Revert README and HOWTO files renaming.Mikhail Terekhov
github doesn't support Sphinx extencions to ReStructured text format.
2017-01-17add .rst suffix to README and HOWTOMikhail Terekhov
2017-01-17Convert documentation to reStructured text.Mikhail Terekhov
Reshuffle contents of README and HOWTO Add some job file examples to HTML docs Automatically generate fio.1 manpage
2017-01-10Fix README regarding fio snapshotsTomohiro Kusumi
As of now, fio-git-*.tar.{gz,bz2} are git repositories, but fio-`version`.tar.gz are archives without .git/ meta data. Signed-off-by: Tomohiro Kusumi <> Signed-off-by: Jens Axboe <>
2017-01-05Remove '--runtime' command line optionJens Axboe
It conflicts with the job file option, and we (in most cases) set the default before we have parsed it, depending on where in the command line the --runtime option is added. Signed-off-by: Jens Axboe <>
2017-01-03Fix README - change just type "configure" to "./configure"Tomohiro Kusumi
Literally typing "configure" may or may not work depending on visible paths. Signed-off-by: Tomohiro Kusumi <> Signed-off-by: Jens Axboe <>
2017-01-03Add BSD package/building info to READMETomohiro Kusumi
Signed-off-by: Tomohiro Kusumi <> Signed-off-by: Jens Axboe <>
2017-01-03Sync README with fio usage outputTomohiro Kusumi
Some of the commits only update one of these. Signed-off-by: Tomohiro Kusumi <> Signed-off-by: Jens Axboe <>
2017-01-02Clean up unit prefixes for binary multiples in comments and printsRobert Elliott
Change comments and prints that are referring to values based on binary multiples to use IEC 80000-13 prefixes for binary multiples rather than SI prefixes for decimal multiples (e.g., KiB, MiB, and GiB rather than KB, MB, and GB). Includes a fix for the rate_min print that was printing "KB/s" although it was really printing bytes per second. Includes a fix for goptions confusing the PB and TB units (while changing them to PiB and TiB). Signed-off-by: Jens Axboe <>
2017-01-02Update Windows maintainer contact detailsRebecca Cran
Signed-off-by: Jens Axboe <>
2016-10-11Update bandwidth log documentationOmar Sandoval
The behavior of --bandwidth-log and write_bw_log has changed multiple times, but the documentation hasn't been updated accordingly. Signed-off-by: Omar Sandoval <> Signed-off-by: Jens Axboe <>
2016-09-25smalloc: fixup --alloc-sizeJens Axboe
Signed-off-by: Jens Axboe <>
2015-11-06Add latency bin output to the json output formatVincent Fu
We add a new format for this, json+, as it generates a lot of data. As of now, the only difference between json and json+ is the full dump of all latency bins. Signed-off-by: Jens Axboe <>
2015-08-20Add --aux-path supportJens Axboe
For certain files, fio just stores them in the current working directory. This can create a bit of a mess. These files might be verification dump files, or verification state saves. Add --aux-path to enable storing these files in an arbitrary directory instead. Signed-off-by: Jens Axboe <>
2015-08-20README: update for trigger optionsJens Axboe
Signed-off-by: Jens Axboe <>
2015-07-15README: no delay on sync to backup git hosts anymoreJens Axboe
Signed-off-by: Jens Axboe <>
2015-07-13Update README for DragonFlyJens Axboe
Signed-off-by: Jens Axboe <>
2015-05-07README: add git:// for github as wellJens Axboe
Signed-off-by: Jens Axboe <>
2015-05-07document changes to --client syntax and behaviorBen England
2015-01-28Fixing typoFelipe Franciosi
2014-10-07Add support for --remote-configJens Axboe
This allows you to tell a fio server to open a local job file, as opposed to being passed one that the fio client opens and sends to it. Signed-off-by: Jens Axboe <>
2014-07-09Add some basic debug output for log compressionJens Axboe
Guarded by --debug=compress, like the other debug measures. Signed-off-by: Jens Axboe <>
2014-07-03Add support for storing compressed logsJens Axboe
If log_store_compressed is set, fio won't decompress for storing them in a file. Instead, you can use --inflate-log=logfile.fz to output the contents to stdout. Signed-off-by: Jens Axboe <>
2014-07-01--latency-log is now goneJens Axboe
Use per-job options for this. Signed-off-by: Jens Axboe <>
2014-06-23README: update to include official mirrors for the git repoJens Axboe
Signed-off-by: Jens Axboe <>
2014-06-18Add support for compiling for ESXJens Axboe
With contributions from Ryan Haynes <> Signed-off-by: Jens Axboe <>
2014-02-07README: update for crctestJens Axboe
Signed-off-by: Jens Axboe <>
2014-01-28Update Windows build for new threading libraryBruce Cran
MinGW now uses libwinpthread-1.dll instead of pthreadGC2.dll. To simplify things, create a static executable so users can run fio from anywhere without needing to copy the dll. Signed-off-by: Jens Axboe <>
2013-12-29Update README to reflect that fio now runs on OpenBSDJens Axboe
Signed-off-by: Jens Axboe <>
2013-12-09Add options to have fio latency profile a deviceJens Axboe
This adds three new options: - latency_target. This defines a specific latency target, in usec. - latency_window. This defines the period over which fio samples. - latency_percentile. This defines the percentage of IOs that must meet the criteria specified by latency_target/latency_window. With these options set, fio will run the described workload and vary the queue depth between 1 and iodepth= to find the best performing spot that meets the criteria specified by the three options. A sample job file is also added to demonstrate how to use this. Signed-off-by: Jens Axboe <>
2013-09-04Rework descriptions for mailing list, options, job filesGrant Grundler
In general, make the existing document less ambiguous: o Use consistent formatting/layout when describing options o always refer to options with "--" prefix. o reduce use of pronouns: "its" and "this" are often ambigous. o remove use of "you" to describe user actions/choices o add reference to examples/ directory Signed-off-by: Grant Grundler <> Signed-off-by: Jens Axboe <>
2013-04-24Add support for other ways of triggering intermediate result outputsJens Axboe
Fio has support for using the USR1 signal to dump the current results while continuing to run. Add a --status-interval parameter to allow this to be configured to automatically happen every X seconds. There's also support for signaling fio through the file system. To do that, simply touch /tmp/fio-dump-status. When fio sees this file, it will unlink and dump the current results. A small tweak is needed for the file approach to work in Windows. Signed-off-by: Jens Axboe <>
2013-04-15README: quick note on how to cross compileAaron Carroll
Signed-off-by: Aaron Carroll <> Signed-off-by: Jens Axboe <>
2013-04-11README: updateJens Axboe
Signed-off-by: Jens Axboe <>
2013-04-10README: remove partial option listJens Axboe
The HOWTO or man page should be used, since either of those has the full list of option keywords. Signed-off-by: Jens Axboe <>
2013-03-07Add --parse-only command line optionJens Axboe
Sometimes it's useful just being able to verify whether a job config is valid or not, without actually starting any jobs. Signed-off-by: Jens Axboe <>
2013-02-22Add --eta-newline optionJens Axboe
For certain situations, it's handy to force a new line in the ETA output. It allows you to easily track what happened, without having to do detailed logging. Signed-off-by: Jens Axboe <>
2013-02-21README: kill reference to non-functional SUSE package pageJens Axboe
Signed-off-by: Jens Axboe <>
2013-02-21Add recommendation that fio be run in a native console on Windows.Bruce Cran
Windows console applications often don't run correctly under Cygwin shells such as mintty because of the way they're implemented. Add a recommendation to the README to run fio under a native console such as the Command Prompt or console2 to avoid these problems. documents the problem. Signed-off-by: Jens Axboe <>
2013-02-05Enable forced 32-bit build on WindowsHuadong Liu
Signed-off-by: Jens Axboe <>
2013-02-03Update the Windows section of the README file.Bruce Cran
The 64-bit Windows build instructions can be simplified since Cygwin includes all the required MinGW64 packages. Also, the pthread DLL is available as an individual download. Update the WiX Toolset version to 3.7 and fix the URL since it's no longer hosted at Sourceforge. Signed-off-by: Jens Axboe <>