Merge branch 'offload-flags-fix' of https://github.com/vincentkfu/fio
[fio.git] / README
diff --git a/README b/README
index 8f5385ef6fe5102db97275cf4c641bcdf852a9b6..38022bbb6596bb1dc18214995e603aa09fa96bba 100644 (file)
--- a/README
+++ b/README
@@ -59,7 +59,8 @@ Mailing list
 ------------
 
 The fio project mailing list is meant for anything related to fio including
-general discussion, bug reporting, questions, and development.
+general discussion, bug reporting, questions, and development. For bug reporting,
+see REPORTING-BUGS.
 
 An automated mail detailing recent commits is automatically sent to the list at
 most daily. The list address is fio@vger.kernel.org, subscribe by sending an
@@ -92,21 +93,26 @@ Binary packages
 
 Debian:
        Starting with Debian "Squeeze", fio packages are part of the official
-       Debian repository. http://packages.debian.org/search?keywords=fio.
+       Debian repository. http://packages.debian.org/search?keywords=fio .
 
 Ubuntu:
        Starting with Ubuntu 10.04 LTS (aka "Lucid Lynx"), fio packages are part
        of the Ubuntu "universe" repository.
-       http://packages.ubuntu.com/search?keywords=fio.
+       http://packages.ubuntu.com/search?keywords=fio .
 
-Red Hat, CentOS & Co:
-       Dag WieĆ«rs has RPMs for Red Hat related distros, find them here:
-       http://dag.wieers.com/rpm/packages/fio/.
+Red Hat, Fedora, CentOS & Co:
+       Starting with Fedora 9/Extra Packages for Enterprise Linux 4, fio
+       packages are part of the Fedora/EPEL repositories.
+       https://apps.fedoraproject.org/packages/fio .
 
 Mandriva:
        Mandriva has integrated fio into their package repository, so installing
        on that distro should be as easy as typing ``urpmi fio``.
 
+Arch Linux:
+        An Arch Linux package is provided under the Community sub-repository:
+        https://www.archlinux.org/packages/?sort=&q=fio
+
 Solaris:
        Packages for Solaris are available from OpenCSW. Install their pkgutil
        tool (http://www.opencsw.org/get-it/pkgutil/) and then install fio via
@@ -114,7 +120,9 @@ Solaris:
 
 Windows:
        Rebecca Cran <rebecca+fio@bluestop.org> has fio packages for Windows at
-       http://www.bluestop.org/fio/ .
+       https://www.bluestop.org/fio/ . The latest builds for Windows can also
+       be grabbed from https://ci.appveyor.com/project/axboe/fio by clicking
+       the latest x86 or x64 build, then selecting the ARTIFACTS tab.
 
 BSDs:
        Packages for BSDs may be available from their binary package repositories.
@@ -164,18 +172,25 @@ directory.
 How to compile fio on 64-bit Windows:
 
  1. Install Cygwin (http://www.cygwin.com/). Install **make** and all
-    packages starting with **mingw64-i686** and **mingw64-x86_64**.
+    packages starting with **mingw64-x86_64**. Ensure
+    **mingw64-x86_64-zlib** are installed if you wish
+    to enable fio's log compression functionality.
  2. Open the Cygwin Terminal.
  3. Go to the fio directory (source files).
  4. Run ``make clean && make -j``.
 
-To build fio on 32-bit Windows, run ``./configure --build-32bit-win`` before
-``make``.
+To build fio for 32-bit Windows, ensure the -i686 versions of the previously
+mentioned -x86_64 packages are installed and run ``./configure
+--build-32bit-win`` before ``make``. To build an fio that supports versions of
+Windows below Windows 7/Windows Server 2008 R2 also add ``--target-win-ver=xp``
+to the end of the configure line that you run before doing ``make``.
 
 It's recommended that once built or installed, fio be run in a Command Prompt or
 other 'native' console such as console2, since there are known to be display and
 signal issues when running it under a Cygwin shell (see
-http://code.google.com/p/mintty/issues/detail?id=56 for details).
+https://github.com/mintty/mintty/issues/56 and
+https://github.com/mintty/mintty/wiki/Tips#inputoutput-interaction-with-alien-programs
+for details).
 
 
 Documentation
@@ -204,10 +219,10 @@ implemented, I'd be happy to take patches for that. An example of that is disk
 utility statistics and (I think) huge page support, support for that does exist
 in FreeBSD/Solaris.
 
-Fio uses pthread mutexes for signalling and locking and FreeBSD does not
-support process shared pthread mutexes. As a result, only threads are
-supported on FreeBSD. This could be fixed with sysv ipc locking or
-other locking alternatives.
+Fio uses pthread mutexes for signalling and locking and some platforms do not
+support process shared pthread mutexes. As a result, on such platforms only
+threads are supported. This could be fixed with sysv ipc locking or other
+locking alternatives.
 
 Other \*BSD platforms are untested, but fio should work there almost out of the
 box. Since I don't do test runs or even compiles on those platforms, your