diff options
Diffstat (limited to 'INSTALL')
| -rw-r--r-- | INSTALL | 32 |
1 files changed, 18 insertions, 14 deletions
@@ -4,34 +4,38 @@ Installing page cache utilities Dependencies ------------ -These utilities are dependent on the posix_fadvise and mincore syscalls. +These utilities are dependent on the +[posix_fadvise(2)](http://linux.die.net/man/2/posix_fadvise) and +[mincore(2)](http://linux.die.net/man/2/mincore) syscalls. -pcu-fadvise needs a kernel that supports the posix_fadvise(2) syscall and C -library support. For GNU/Linux systems, this means you'll need a kernel -newer than 2.5.60 and the GNU C library 2.2 or later. +pcu-fadvise needs a kernel that supports the +[posix_fadvise(2)](http://linux.die.net/man/2/posix_fadvise) and syscall +and C library support. For GNU/Linux systems, this means you'll need a +kernel newer than 2.5.60 and the GNU C library 2.2 or later. -pcu-mincore should work on most somewhat-modern UNIX/UNIX-like kernels that -support the mincore(2) system call. While the mincore(2) system call is not -specified by current versions of POSIX, it is fairly common. +pcu-mincore should work on most somewhat-modern UNIX/UNIX-like kernels +that support the [mincore(2)](http://linux.die.net/man/2/mincore) system +call. While the [mincore(2)](http://linux.die.net/man/2/mincore) system +call is not specified by current versions of POSIX, it is fairly common. Standard build tools such as a C compiler, GNU make, install are required. -If you wish to build and install the manpages, you'll also need the txt2man -utility available here: http://mvertes.free.fr/download/ -The documentation is otherwise viewable in plain text form. +If you wish to build and install the manpages or HTML documentation, +you'll also need [Pandoc](http://johnmacfarlane.net/pandoc/). The +documentation is otherwise viewable as Markdown. Instructions ------------ To install executables into your home directory in ~/bin: - $ make - $ make install + $ make + $ make install To install executables globally in /usr/local/bin: - $ make ; # as yourself - # make install prefix=/usr/local/bin ; # as root + $ make ; # as yourself + # make install prefix=/usr/local/bin ; # as root All pcu-* executables are relocatable and have no dependencies outside of the system C library and kernel support for the syscalls they need. |