man1-editing-pass-20051209
[openafs.git] / doc / man-pages / pod1 / fs_checkvolumes.pod
1 =head1 NAME
2
3 fs checkvolumes - Forces the Cache Manager to update volume information
4
5 =head1 SYNOPSIS
6
7 B<fs checkvolumes> [B<-help>]
8
9 B<fs checkv> [B<-h>]
10
11 =head1 DESCRIPTION
12
13 The B<fs checkvolumes> command discards the table of mappings between
14 volume names and volume ID numbers that the Cache Manager stores in memory
15 and uses when fetching data from volumes. The next time an application
16 requests AFS data, the Cache Manager must contact the Volume Location (VL)
17 Server for volume location information, and then an appropriate file
18 server machine for the actual data.
19
20 The Cache Manager updates the table of mappings periodically (by default,
21 hourly), but this command is useful if the issuer knows that a volume's
22 name has changed, or that new read-only replicas of a volume have been
23 released, because issuing it forces the Cache Manager to reference the
24 changed volume.
25
26 =head1 OPTIONS
27
28 =over 4
29
30 =item B<-help>
31
32 Prints the online help for this command. All other valid options are
33 ignored.
34
35 =back
36
37 =head1 OUTPUT
38
39 The following message confirms that the command ran successfully.
40
41    All volumeID/name mappings checked.
42
43 =head1 PRIVILEGE REQUIRED
44
45 None
46
47 =head1 COPYRIGHT
48
49 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
50
51 This documentation is covered by the IBM Public License Version 1.0.  It was
52 converted from HTML to POD by software written by Chas Williams and Russ
53 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.