about summary refs log tree commit homepage
path: root/pcu-fadvise.1.txt
diff options
context:
space:
mode:
Diffstat (limited to 'pcu-fadvise.1.txt')
-rw-r--r--pcu-fadvise.1.txt101
1 files changed, 57 insertions, 44 deletions
diff --git a/pcu-fadvise.1.txt b/pcu-fadvise.1.txt
index 9e10c8b..6a0cd1c 100644
--- a/pcu-fadvise.1.txt
+++ b/pcu-fadvise.1.txt
@@ -1,44 +1,57 @@
-NAME
-  pcu-fadvise - predeclare an access pattern on given files
-SYNOPSIS
-  pcu-fadvise [-a advice] [-o offset] [-l length] FILE...
-DESCRIPTION
-  A command-line interface to the posix_fadvise(2) syscall to tell
-  the kernel to optimize access patterns for specified files.
-OPTIONS
-  -a advice
-
-  File access pattern advice.
-  The advice must be one of the following:
-
-    normal
-    sequential
-    random
-    noreuse
-    willneed
-    dontneed
-
-  The default advice is normal.
-
-  -o offset
-
-  Apply advice only to the given byte offset.
-  This offset rounded down to the previous page offset.
-  The default offset is zero (beginning of the file)
-
-  -l length
-
-  Apply advice only to the given length in bytes.
-  This length is rounded up next page offset.
-  The default is to scan the entire file.
-
-OUTPUT
-  Errors only.
-ENVIRONMENT
-  none
-SEE ALSO
-  posix_fadvise(2)
-BUGS
-  None known. Email the author if you find any.
-AUTHOR
-  Eric Wong <normalperson@yhbt.net>
+% PCU-FADVISE(1) Page Cache Utilities Manual
+% Eric Wong <normalperson@yhbt.net>
+% July 26, 2009
+
+# NAME
+
+pcu-fadvise - predeclare an access pattern on given files
+
+# SYNOPSIS
+
+pcu-fadvise [*-a ADVICE*] [*-o OFFSET*] [*-l LENGTH*] FILE...
+
+# DESCRIPTION
+
+A command-line interface to the posix_fadvise(2) syscall to tell
+the kernel to optimize access patterns for specified files.
+
+# OPTIONS
+
+-a *ADVICE*
+:   File access pattern advice.
+
+:   *ADVICE* must be one of the following:
+
+      * normal
+      * sequential
+      * random
+      * noreuse
+      * willneed
+      * dontneed
+
+     The default advice is `normal`.
+
+-o *OFFSET*
+:   Apply advice only to the given byte offset.
+    This offset rounded down to the previous page offset.
+    The default offset is zero (beginning of the file).
+
+-l *LENGTH*
+:   Apply advice only to the given length in bytes.
+    This length is rounded up next page offset.
+    The default is to scan the entire file.
+
+# OUTPUT
+
+Errors only.
+
+# ENVIRONMENT
+
+none
+
+# SEE ALSO
+[`posix_fadvise`(2)](http://linux.die.net/man/2/posix_fadvise)
+
+# BUGS
+
+None known. Email <pcu@librelist.com> if you find any.