about summary refs log tree commit homepage
path: root/README
diff options
context:
space:
mode:
authorEric Wong <normalperson@yhbt.net>2009-05-10 16:34:14 -0700
committerEric Wong <normalperson@yhbt.net>2009-05-10 16:35:26 -0700
commita137167c965e8e3e9bacf4fad561d504cad7b967 (patch)
treea1d164d264581dc77c891bff450ef2f5655b5bb1 /README
parent75d049746e374303fb1c8ee038687dca125c6817 (diff)
downloadpcu-a137167c965e8e3e9bacf4fad561d504cad7b967.tar.gz
Revamp documentation, add manpages
Diffstat (limited to 'README')
-rw-r--r--README19
1 files changed, 7 insertions, 12 deletions
diff --git a/README b/README
index 3e73b72..4ce7335 100644
--- a/README
+++ b/README
@@ -1,15 +1,10 @@
-command-line utils for viewing/managing the Linux page cache
+page cache utilities
+====================
 
-pcu-mincore - shows the pages in the page cache for given files
+This package contains command-line utilities for viewing/managing the
+kernel page cache.
 
-        pcu-mincore <files>
+* pcu-fadvise - runs posix_fadvise(2) on given files
+* pcu-mincore - shows the pages in the page cache for given files
 
-
-pcu-fadvise - runs posix_fadvise(2) on a given file
-
-        pcu-fadvise [-a advice] [-o offset] [-l length] <files>
-
-        advice can be one of:
-          normal, sequential, random, noreuse, willneed, dontneed
-
-See posix_fadvise(2) and mincore(2) manpages for more details.
+See manpages for the individual commands for more details.