INSTALL

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