pod-updates-20060227
[openafs.git] / doc / man-pages / pod1 / fs_setcachesize.pod
1 =head1 NAME
2
3 fs setcachesize - Sets the size of the disk cache
4
5 =head1 SYNOPSIS
6
7 B<fs setcachesize> [B<-blocks> <I<size in 1K byte blocks (0 => reset)>>]
8     [B<-reset>] [B<-help>]
9
10 B<fs setca> [B<-b> <I<size in 1K byte blocks (0 => reset)>>]
11     [B<-r>] [B<-h>]
12
13 B<fs cachesize> [B<-b> <I<size in 1K byte blocks (0 => reset)>>]
14     [B<-r>] [B<-h>]
15
16 B<fs ca> [B<-b> <I<size in 1K byte blocks (0 => reset)>>]
17     [B<-r>] [B<-h>]
18
19 =head1 DESCRIPTION
20
21 The B<fs setcachesize> command changes the number of kilobyte blocks of
22 local disk space available to the Cache Manager for its data cache, on
23 machines that use a disk cache. The command is not operative on machines
24 that use a memory cache.
25
26 To return the cache size to the default value specified in the third field
27 of the local F</usr/vice/etc/cacheinfo> file, provide a value of C<0> to
28 the B<-blocks> argument.
29
30 To return the cache size to the value set when the machine was last
31 rebooted, use the B<-reset> flag instead of the B<-blocks> argument. This
32 is normally the amount specified in the F<cacheinfo> file, unless the
33 B<-blocks> argument was included on the B<afsd> command to override the
34 B<cacheinfo> value.
35
36 To display the current cache size and amount of cache in use, for both
37 disk and memory caches, use the B<fs getcacheparms> command.
38
39 =head1 CAUTIONS
40
41 This command is not operative on machines using a memory cache, and
42 results in an error message. To change memory cache size, edit the
43 B<cacheinfo> file and reboot, or reboot and provide the B<-blocks>
44 argument to the B<afsd> command.
45
46 On machines using a disk cache, do not set the cache size to exceed 85% to
47 90% of the actual disk space available for the cache directory. The cache
48 implementation itself requires a small amount of space on the partition.
49
50 =head1 OPTIONS
51
52 =over 4
53
54 =item B<-blocks> <I<size in 1K byte blocks>>
55
56 Specifies the number of one-kilobyte blocks of disk space available for
57 the Cache Manager to devote to the cache. Provide a value of C<0> to set
58 cache size to the default specified in the F<cacheinfo> file.
59
60 =item B<-reset>
61
62 Returns the cache size to the value set when the machine was last
63 booted. This agrees with the value in the F<cacheinfo> file unless the
64 B<-blocks> argument was used on the B<afsd> command.
65
66 =item B<-help>
67
68 Prints the online help for this command. All other valid options are
69 ignored.
70
71 =back
72
73 =head1 EXAMPLES
74
75 The following command sets the disk cache size to 25000 kilobyte blocks.
76
77    % fs setcachesize -blocks 25000
78
79 Both of the following commands reset the disk cache size to the value in
80 the F<cacheinfo> file, assuming that the B<-blocks> argument to the
81 B<afsd> command was not used.
82
83    % fs setcachesize -blocks 0
84    % fs setcachesize -reset
85
86 =head1 PRIVILEGE REQUIRED
87
88 The issuer must be logged in as the local superuser root.
89
90 =head1 SEE ALSO
91
92 L<cacheinfo(5)>,
93 L<afsd(8)>,
94 L<fs_getcacheparms(1)>
95
96 =head1 COPYRIGHT
97
98 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
99
100 This documentation is covered by the IBM Public License Version 1.0.  It was
101 converted from HTML to POD by software written by Chas Williams and Russ
102 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.