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