Windows: Switch to Interlocked ops for RDR Set/Clear
[openafs.git] / doc / man-pages / pod1 / fs_getcacheparms.pod
1 =head1 NAME
2
3 fs_getcacheparms - Displays the current size and usage of the cache
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<fs getcacheparms> [B<-help>] [B<-files>] [B<-excessive>]
11
12 B<fs getca> [B<-h>] [B<-files>] [B<-excessive>]
13
14 =for html
15 </div>
16
17 =head1 DESCRIPTION
18
19 The B<fs getcacheparms> command displays the current size of the cache
20 (which can be in memory or on disk), and the amount currently in use.
21
22 The reported statistics are from kernel memory, so the reported size can
23 differ from the setting specified in the F</usr/vice/etc/cacheinfo> file
24 on a machine using a disk cache, if the B<fs setcachesize> command has
25 been used to alter cache size.
26
27 =head1 OPTIONS
28
29 =over 4
30
31 =item B<-help>
32
33 Prints the online help for this command. All other valid options are
34 ignored.
35
36 =item B<-files>
37
38 Displays the current number of cache files in use, and the maximum
39 available, as well as displaying the current cache size.
40
41 =item B<-excessive>
42
43 Displays detailed cache statistics, including the flags set on each
44 cache element, and the distribution of cache entries by size.
45
46 =back
47
48 =head1 OUTPUT
49
50 The output reports
51
52    AFS using <amount> of the cache's available <size> 1K byte blocks.
53
54 where <amount> is the number of kilobyte blocks currently used to cache
55 data and status information, and <size> is the total current cache size.
56
57 =head1 EXAMPLES
58
59 The following example shows the output on a machine with a 25000 kilobyte
60 cache.
61
62    % fs getcacheparms
63    AFS using 22876 of the cache's available 25000 1K byte blocks.
64
65 The following shows the output when asked to show file information.
66
67    % fs getcacheparm -files
68    AFS using     0% of cache blocks (897 of 200000 1k blocks)
69                  1% of the cache files (79 of 6250 files)
70
71 And finally, the following detailed information can be obtained by using
72 the excessive flag 
73
74    % fs getcacheparm -excessive
75    AFS using     0% of cache blocks (897 of 200000 1k blocks)
76                  1% of the cache files (79 of 6250 files)
77            afs_cacheFiles:       6250
78            IFFree:               6171
79            IFEverUsed:             79
80            IFDataMod:               0
81            IFDirtyPages:            0
82            IFAnyPages:              0
83            IFDiscarded:             1
84            DCentries:        3122
85             0k-   4K:         74
86             4k-  16k:       3045
87            16k-  64k:          2
88            64k- 256k:          0
89           256k-   1M:          1
90                 >=1M:          0
91
92 =head1 PRIVILEGE REQUIRED
93
94 None
95
96 =head1 SEE ALSO
97
98 L<fs_setcachesize(1)>
99
100 =head1 COPYRIGHT
101
102 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
103
104 This documentation is covered by the IBM Public License Version 1.0.  It was
105 converted from HTML to POD by software written by Chas Williams and Russ
106 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.