man-page-license-change-20071225
[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>]
11
12 B<fs getca> [B<-h>]
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 =back
37
38 =head1 OUTPUT
39
40 The output reports
41
42    AFS using <amount> of the cache's available <size> 1K byte blocks.
43
44 where <amount> is the number of kilobyte blocks currently used to cache
45 data and status information, and <size> is the total current cache size.
46
47 =head1 EXAMPLES
48
49 The following example shows the output on a machine with a 25000 kilobyte
50 cache.
51
52    % fs getcacheparms
53    AFS using 22876 of the cache's available 25000 1K byte blocks.
54
55 =head1 PRIVILEGE REQUIRED
56
57 None
58
59 =head1 SEE ALSO
60
61 L<fs_setcachesize(1)>
62
63 =head1 COPYRIGHT
64
65 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
66
67 This documentation is covered by the IBM Public License Version 1.0.  It was
68 converted from HTML to POD by software written by Chas Williams and Russ
69 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.