about summary refs log tree commit homepage
path: root/INSTALL
diff options
context:
space:
mode:
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL37
1 files changed, 37 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..011e178
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,37 @@
+Installing page cache utilities
+===============================
+
+Dependencies
+------------
+
+These utilities are dependent on the posix_fadvise and 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-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.
+
+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.
+
+Instructions
+------------
+
+To install executables into your home directory in ~/bin:
+
+  $ make
+  $ make install
+
+To install executables globally in /usr/local/bin:
+
+  $ 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.