Croak with usage info on no arguments
[pcu.git] / pcu-mincore.1.txt
blobe095621c2835324f14019d4b8b4072ab991c3622
1 NAME
2   pcu-mincore - shows cache status for given files
3 SYNOPSIS
4   pcu-mincore [-o offset] [-l length] FILE...
5 DESCRIPTION
6   A command-line interface to the mincore(2) syscall to inspect
7   whether or not certain pages belonging to a file are cached in
8   resident memory.
9 OPTIONS
10   -o offset
12   Scan only pages on or after the given offset.
13   This offset is rounded down to the previous page offset.
14   The default offset is zero (beginning of the file)
16   -l length
18   Check only the given length in bytes.
19   This length is rounded up next page offset.
20   The default is to scan the entire file.
21 OUTPUT
22   One line for every page scanned in the following format:
24   <filename>: <offset> <incore>
26   offset is a hexadecimal number for a given range of PAGE_SIZE bytes.
27   incore is a boolean value indicating whether or not the page beginning
28   at a particular offset is cached in resident memory or not.
29 SEE ALSO
30   mincore(2), pcu(7)
31 BUGS
32   None known. Email the author if you find any.
33 AUTHOR
34   Eric Wong <normalperson@yhbt.net>