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