Switch to pandoc for all documentation
[pcu.git] / INSTALL
blob011e17838771b4ea9ca8ccdddfca512ab29123d3
1 Installing page cache utilities
2 ===============================
4 Dependencies
5 ------------
7 These utilities are dependent on the posix_fadvise and mincore syscalls.
9 pcu-fadvise needs a kernel that supports the posix_fadvise(2) syscall and C
10 library support.  For GNU/Linux systems, this means you'll need a kernel
11 newer than 2.5.60 and the GNU C library 2.2 or later.
13 pcu-mincore should work on most somewhat-modern UNIX/UNIX-like kernels that
14 support the mincore(2) system call.  While the mincore(2) system call is not
15 specified by current versions of POSIX, it is fairly common.
17 Standard build tools such as a C compiler, GNU make, install are required.
19 If you wish to build and install the manpages, you'll also need the txt2man
20 utility available here: http://mvertes.free.fr/download/
21 The documentation is otherwise viewable in plain text form.
23 Instructions
24 ------------
26 To install executables into your home directory in ~/bin:
28   $ make
29   $ make install
31 To install executables globally in /usr/local/bin:
33   $ make ; # as yourself
34   # make install prefix=/usr/local/bin ; # as root
36 All pcu-* executables are relocatable and have no dependencies outside
37 of the system C library and kernel support for the syscalls they need.