INSTALL

   1
   2 Building and installing
   3 -----------------------
   4
   5 To build and install the library and the checker (called jiofsck), run "make"
   6 and then "make install" (usually as root). That installs everything using
   7 /usr/local as the base directory (so the library gets installed in
   8 /usr/local/lib, the manpage at /usr/local/man, and so on).
   9
  10 To use a different base directory, for example /home/myself, run
  11 "make PREFIX=/home/myself install".
  12
  13 After installing, you need to run "ldconfig" in order to update your dynamic
  14 library cache.
  15
  16 If the default "make" is not GNU make (like in BSD systems), use "gmake"
  17 instead. If the default "install" is not GNU/BSD compatible (like in Solaris
  18 systems), use "gmake INSTALL=ginstall".
  19
  20
  21 Special builds
  22 --------------
  23
  24  - To build with debugging information: "make DEBUG=1".
  25  - To build with profiling support: "make PROFILE=1".
  26  - To build with fault injection support, if you have libfiu: "make FI=1".
  27
  28
  29 Python bindings
  30 ---------------
  31
  32 The library comes with bindings for Python 2 and Python 3. In order to build
  33 them, you should have libjio already installed.
  34
  35  - To build the Python 2 bindings, run "make python2". To install them, run
  36    "make python2_install".
  37  - To build the Python 3 bindings, run "make python3". To install them, run
  38    "make python3_install".
  39
  40
  41 Tests
  42 -----
  43
  44 Several tests can be found in the "tests/" directory. For practical purposes,
  45 there are two make targets that run a reasonable set of tests against the
  46 built version of the library:
  47
  48  - To run the standard tests, run "make tests".
  49  - To run the tests with fault injection support, run "make FI=1 tests-fi".
  50