mincore: add '-s' summary option
[pcu.git] / pcu-mincore.1.txt
blobe0d907517d401233d80b9f548fa9869067eed502
1 % PCU-MINCORE(1) Page Cache Utilities Manual
2 % Eric Wong <normalperson@yhbt.net>
3 % July 26, 2009
5 # NAME
6 pcu-mincore - shows cache status for given files
8 # SYNOPSIS
9 pcu-mincore [-o OFFSET] [-l LENGTH] [-s] FILE...
11 # DESCRIPTION
12 A command-line interface to the mincore(2) syscall to inspect
13 whether or not certain pages belonging to a file are cached in
14 resident memory.
16 # OPTIONS
17 -o OFFSET
18 :   Scan only pages on or after the given offset.
19     This offset is rounded down to the previous page offset.
20     The default offset is zero (beginning of the file)
22 -l LENGTH
23 :    Check only the given length in bytes.
24     This length is rounded up next page offset.
25     The default is to scan the entire file.
28 :   Display the summary output as a floating point number between
29     0.0 and 1.0 representing the percentage of the file in core.
31 # OUTPUT
32 The following output is displayed unless "-s" summary format
33 is chosen.
35 One line for every page scanned in the following format:
37    \<filename\>: \<offset\> \<incore\>
39 offset is a hexadecimal number for a given range of PAGE_SIZE bytes.
40 incore is a boolean value indicating whether or not the page beginning
41 at a particular offset is cached in resident memory or not.
43 # ENVIRONMENT
44 none
46 # SEE ALSO
47 [`mincore`(2)][2]
49 # BUGS
50 None known. Email <pcu@librelist.com> if you find any.
52 [2]: http://kernel.org/doc/man-pages/online/pages/man2/mincore.2.html