b7adddd31d71fd4d706a571d0d4698584ef08806
[openafs.git] / doc / man-pages / pod5 / cacheinfo.pod
1 =head1 NAME
2
3 cacheinfo - Defines configuration parameters for the Cache Manager
4
5 =head1 DESCRIPTION
6
7 The cacheinfo file defines configuration parameters for the
8 Cache Manager, which reads the file as it initializes.
9
10 The file contains a single line of ASCII text and must reside in the
11 B</usr/vice/etc> directory. Use a text editor to create it
12 during initial configuration of the client machine; the required format
13 is as follows:
14
15    I<mount_dir>:I<cache_dir>:I<cache_size>
16
17 where
18
19 =over 4
20
21 =item I<mount_dir
22 >
23
24 Names the local disk directory at which the Cache Manager mounts the AFS
25 namespace. It must exist before the B<afsd> program
26 runs. The conventional value is B</afs>. Using any other
27 value prevents traversal of pathnames that begin with B</afs> (such as
28 pathnames to files in foreign cells that do use the conventional name).
29 The B<-mountdir> argument to the B<afsd> command overrides
30 this value.
31
32 =item I<cache_dir
33 >
34
35 Names the local disk directory to use as a cache. It must exist
36 before the B<afsd> program runs. The standard value is
37 B</usr/vice/cache>, but it is acceptable to substitute a directory on
38 a partition with more available space. Although the Cache Manager
39 ignores this field when configuring a memory cache, a value must always appear
40 in it. The B<-cachedir> argument to the B<afsd> command
41 overrides this value.
42
43 =item I<cache_size
44 >
45
46 Specifies the cache size as a number of 1-kilobyte blocks. Larger
47 caches generally yield better performance, but a disk cache must not exceed
48 90% of the space available on the cache partition (85% for AIX systems), and a
49 memory cache must use no more than 25% of available machine memory. 
50
51 The B<-blocks> argument to the afsd command overrides
52 this value. To reset cache size without rebooting on a machine that
53 uses disk caching, use the B<fs setcachesize> command. To
54 display the current size of a disk or memory cache between reboots, use the
55 B<fs getcacheparms> command.
56
57 =back
58
59 =head1 EXAMPLES
60
61 The following example cacheinfo file mounts the AFS namespace at
62 B</afs>, establishes a disk cache in the B</usr/vice/cache>
63 directory, and defines cache size as 50,000 1-kilobyte blocks.
64
65    /afs:/usr/vice/cache:50000
66
67 =head1 SEE ALSO
68
69 L<afsd(1)>,
70 L<fs_getcacheparms(1)>,
71 L<fs_setcachesize(1)>
72
73 =head1 COPYRIGHT
74
75 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
76
77 This documentation is covered by the IBM Public License Version 1.0.  It was
78 converted from HTML to POD by software written by Chas Williams and Russ
79 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.