Makefile: ghetto generation task for the website
[pcu.git] / pcu-fadvise.1.txt
blobf4bf0c7d69452ff1b06a565425ed7a7224c6fc9d
1 % PCU-FADVISE(1) Page Cache Utilities Manual
2 % Eric Wong <normalperson@yhbt.net>
3 % July 26, 2009
5 # NAME
7 pcu-fadvise - predeclare an access pattern on given files
9 # SYNOPSIS
11 pcu-fadvise [*-a ADVICE*] [*-o OFFSET*] [*-l LENGTH*] FILE...
13 # DESCRIPTION
15 A command-line interface to the posix_fadvise(2) syscall to tell
16 the kernel to optimize access patterns for specified files.
18 # OPTIONS
20 -a *ADVICE*
21 :   File access pattern advice.
23 :   *ADVICE* must be one of the following:
25       * normal
26       * sequential
27       * random
28       * noreuse
29       * willneed
30       * dontneed
32      The default advice is `normal`.
34 -o *OFFSET*
35 :   Apply advice only to the given byte offset.
36     This offset rounded down to the previous page offset.
37     The default offset is zero (beginning of the file).
39 -l *LENGTH*
40 :   Apply advice only to the given length in bytes.
41     This length is rounded up next page offset.
42     The default is to scan the entire file.
44 # OUTPUT
46 Errors only.
48 # ENVIRONMENT
50 none
52 # SEE ALSO
53 [`posix_fadvise`(2)][1]
55 # BUGS
57 None known. Email <pcu@librelist.com> if you find any.
59 [1]: http://opengroup.org/onlinepubs/009695399/functions/posix_fadvise.html