about summary refs log tree commit homepage
path: root/pcu-mincore.1.txt
diff options
context:
space:
mode:
Diffstat (limited to 'pcu-mincore.1.txt')
-rw-r--r--pcu-mincore.1.txt77
1 files changed, 43 insertions, 34 deletions
diff --git a/pcu-mincore.1.txt b/pcu-mincore.1.txt
index d2334e5..db4f071 100644
--- a/pcu-mincore.1.txt
+++ b/pcu-mincore.1.txt
@@ -1,34 +1,43 @@
-NAME
-  pcu-mincore - shows cache status for given files
-SYNOPSIS
-  pcu-mincore [-o offset] [-l length] FILE...
-DESCRIPTION
-  A command-line interface to the mincore(2) syscall to inspect
-  whether or not certain pages belonging to a file are cached in
-  resident memory.
-OPTIONS
-  -o offset
-
-  Scan only pages on or after the given offset.
-  This offset is rounded down to the previous page offset.
-  The default offset is zero (beginning of the file)
-
-  -l length
-
-  Check only the given length in bytes.
-  This length is rounded up next page offset.
-  The default is to scan the entire file.
-OUTPUT
-  One line for every page scanned in the following format:
-
-  <filename>: <offset> <incore>
-
-  offset is a hexadecimal number for a given range of PAGE_SIZE bytes.
-  incore is a boolean value indicating whether or not the page beginning
-  at a particular offset is cached in resident memory or not.
-SEE ALSO
-  mincore(2)
-BUGS
-  None known. Email the author if you find any.
-AUTHOR
-  Eric Wong <normalperson@yhbt.net>
+% PCU-MINCORE(1) Page Cache Utilities Manual
+% Eric Wong <normalperson@yhbt.net>
+% July 26, 2009
+
+# NAME
+pcu-mincore - shows cache status for given files
+
+# SYNOPSIS
+pcu-mincore [-o OFFSET] [-l LENGTH] FILE...
+
+# DESCRIPTION
+A command-line interface to the mincore(2) syscall to inspect
+whether or not certain pages belonging to a file are cached in
+resident memory.
+
+# OPTIONS
+-o OFFSET
+:   Scan only pages on or after the given offset.
+    This offset is rounded down to the previous page offset.
+    The default offset is zero (beginning of the file)
+
+-l LENGTH
+:    Check only the given length in bytes.
+    This length is rounded up next page offset.
+    The default is to scan the entire file.
+
+# OUTPUT
+One line for every page scanned in the following format:
+
+   \<filename\>: \<offset\> \<incore\>
+
+offset is a hexadecimal number for a given range of PAGE_SIZE bytes.
+incore is a boolean value indicating whether or not the page beginning
+at a particular offset is cached in resident memory or not.
+
+# ENVIRONMENT
+none
+
+# SEE ALSO
+[`mincore`(2)](http://linux.die.net/man/2/mincore)
+
+# BUGS
+None known. Email <pcu@librelist.com> if you find any.