INSTALL

   1 Installing page cache utilities
   2 ===============================
   3
   4 Dependencies
   5 ------------
   6
   7 These utilities are dependent on the [posix_fadvise(2)][1] and
   8 [mincore(2)][2] system calls.
   9
  10 [pcu-fadvise(1)](pcu-fadvise.1.html) needs a kernel that supports the
  11 [posix_fadvise(2)][1] and syscall and C library support.  For GNU/Linux
  12 systems, this means you'll need a kernel newer than 2.5.60 and the GNU C
  13 library 2.2 or later.
  14
  15 [pcu-mincore(1)](pcu-mincore.1.html) should work on most somewhat-modern
  16 UNIX/UNIX-like kernels that support the [mincore(2)][2] system call.
  17 While the [mincore(2)][2] system call is not specified by current
  18 versions of POSIX, it is fairly common.
  19
  20 Standard build tools such as a C compiler, GNU make, install are required.
  21
  22 If you wish to build and install the manpages or HTML documentation,
  23 you'll also need [Pandoc](http://johnmacfarlane.net/pandoc/).  The
  24 documentation is otherwise viewable as Markdown.
  25
  26 Instructions
  27 ------------
  28
  29 To install executables into your home directory in ~/bin:
  30
  31     $ make
  32     $ make install
  33
  34 To install executables globally in /usr/local/bin:
  35
  36     $ make ; # as yourself
  37     # make install prefix=/usr/local/bin ; # as root
  38
  39 All pcu-* executables are relocatable and have no dependencies outside
  40 of the system C library and kernel support for the syscalls they need.
  41
  42 [1]: http://opengroup.org/onlinepubs/009695399/functions/posix_fadvise.html
  43 [2]: http://kernel.org/doc/man-pages/online/pages/man2/mincore.2.html