about summary refs log tree commit homepage
diff options
context:
space:
mode:
authorEric Wong <normalperson@yhbt.net>2009-07-25 18:13:09 -0700
committerEric Wong <normalperson@yhbt.net>2009-07-25 18:13:09 -0700
commit43660d5b50ac5755f7ac28eabe12f019c2a441d1 (patch)
tree151b79243988a650336984c75b4c8368ed1f5874
parentfcab3eaea57a25185d88b529ed1620e67c9c2080 (diff)
downloadpcu-43660d5b50ac5755f7ac28eabe12f019c2a441d1.tar.gz
README: updates
* add links to syscall manpages
* include mailing list info
-rw-r--r--README33
1 files changed, 21 insertions, 12 deletions
diff --git a/README b/README
index cf6c57c..524d329 100644
--- a/README
+++ b/README
@@ -4,27 +4,36 @@ pcu - Page Cache Utilities
 This package contains command-line utilities for viewing/managing the
 kernel page cache.
 
-* 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)](http://linux.die.net/man/2/posix_fadvise)
+                on given files
+* pcu-mincore - shows the pages in the page cache for given files via
+                [mmap(2)](http://linux.die.net/man/2/mmap) and
+                [mincore(2)](http://linux.die.net/man/2/mincore)
 
 See manpages for the individual commands for more details.  Neither
 command requires privileges other than read access to the files
 specified on the command-line.
 
-You may clone the source repository via git:
-
-* git://git.bogomips.org/pcu.git
-* <http://git.bogomips.org/pcu.git>
-* git://repo.or.cz/pcu.git (mirror)
-* <http://repo.or.cz/r/pcu.git> (mirror)
-
-You may also brows the source code or obtain tarballs from cgit:
+Download
+--------
+You may also browse the source code or obtain tarballs from cgit or gitweb:
 
 * <http://git.bogomips.org/cgit/pcu.git>
+* <http://repo.or.cz/w/pcu.git>
 
-Or via gitweb:
+Contact
+-------
+Please direct all bug reports/questions/patches/comments to <pcu@librelist.com>
 
-* <http://repo.or.cz/w/pcu.git>
+Source
+------
+You may clone the source repository via git:
+
+* git://git.bogomips.org/pcu.git
+* git://repo.or.cz/pcu.git (mirror)
 
+License
+-------
 pcu is copyright Eric Wong <normalperson@yhbt.net> and contributors.
 It is covered under the GNU General Public License, version 2.