From a74ab1a5bd29d8d5980c8ad9913c89af63919eee Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Sun, 26 Jul 2009 23:52:43 -0700 Subject: [PATCH] Update external links to syscall manpages For posix_fadvise and mmap, link to opengroup.org since that is the official specification and not tied to any particular OS. For mincore, use the kernel.org manpage links since that is more likely up-to-date than the previous page (and more canonical of a source). --- INSTALL | 24 +++++++++++++----------- README | 19 +++++++++++-------- pcu-fadvise.1.txt | 4 +++- pcu-mincore.1.txt | 4 +++- 4 files changed, 30 insertions(+), 21 deletions(-) diff --git a/INSTALL b/INSTALL index 344a7ad..78114f2 100644 --- a/INSTALL +++ b/INSTALL @@ -4,19 +4,18 @@ Installing page cache utilities Dependencies ------------ -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. +These utilities are dependent on the [posix_fadvise(2)][1] and +[mincore(2)][2] system calls. -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-fadvise(1)](pcu-fadvise.1.html) needs a kernel that supports the +[posix_fadvise(2)][1] 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)](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. +[pcu-mincore(1)](pcu-mincore.1.html) should work on most somewhat-modern +UNIX/UNIX-like kernels that support the [mincore(2)][2] system call. +While the [mincore(2)][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. @@ -39,3 +38,6 @@ To install executables globally in /usr/local/bin: All pcu-* executables are relocatable and have no dependencies outside of the system C library and kernel support for the syscalls they need. + +[1]: http://opengroup.org/onlinepubs/009695399/functions/posix_fadvise.html +[2]: http://kernel.org/doc/man-pages/online/pages/man2/mincore.2.html diff --git a/README b/README index 96c1d8d..d7cb679 100644 --- a/README +++ b/README @@ -4,12 +4,10 @@ pcu - Page Cache Utilities This package contains command-line utilities for viewing/managing the kernel page cache. -* [pcu-fadvise(1)](pcu-fadvise.1.html) - runs - [posix_fadvise(2)](http://linux.die.net/man/2/posix_fadvise) +* [pcu-fadvise(1)](pcu-fadvise.1.html) - runs [posix_fadvise(2)][1] on given files -* [pcu-mincore(1)](pcu-fadvise.1.html) - 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) +* [pcu-mincore(1)](pcu-mincore.1.html) - shows the pages in the page cache + for given files via [mmap(2)][3] and [mincore(2)][2]. See manpages for the individual commands for more details. Neither command requires privileges other than read access to the files @@ -27,8 +25,9 @@ Contact Please direct all bug reports/questions/patches/comments to Mailing list archives are available as gzipped mbox files at - in addition to the librelist.com-provided -Maildir archives at . + in addition to the +[librelist.com](http://librelist.com)-provided Maildir archives at +. Source ------ @@ -42,4 +41,8 @@ License pcu is 100% Free Software. Copyright Eric Wong and contributors. It is covered under the [GNU General Public License, -version 2](http://www.gnu.org/licenses/gpl-2.0.html). +version 2](http://gnu.org/licenses/gpl-2.0.html). + +[1]: http://opengroup.org/onlinepubs/009695399/functions/posix_fadvise.html +[2]: http://kernel.org/doc/man-pages/online/pages/man2/mincore.2.html +[3]: http://opengroup.org/onlinepubs/009695399/functions/mmap.html diff --git a/pcu-fadvise.1.txt b/pcu-fadvise.1.txt index 6a0cd1c..f4bf0c7 100644 --- a/pcu-fadvise.1.txt +++ b/pcu-fadvise.1.txt @@ -50,8 +50,10 @@ Errors only. none # SEE ALSO -[`posix_fadvise`(2)](http://linux.die.net/man/2/posix_fadvise) +[`posix_fadvise`(2)][1] # BUGS None known. Email if you find any. + +[1]: http://opengroup.org/onlinepubs/009695399/functions/posix_fadvise.html diff --git a/pcu-mincore.1.txt b/pcu-mincore.1.txt index db4f071..a3a8300 100644 --- a/pcu-mincore.1.txt +++ b/pcu-mincore.1.txt @@ -37,7 +37,9 @@ at a particular offset is cached in resident memory or not. none # SEE ALSO -[`mincore`(2)](http://linux.die.net/man/2/mincore) +[`mincore`(2)][2] # BUGS None known. Email if you find any. + +[2]: http://kernel.org/doc/man-pages/online/pages/man2/mincore.2.html -- 2.11.4.GIT