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