man-page-reorg-20051209
[openafs.git] / doc / man-pages / pod1 / fs_flushvolume.pod
1 =head1 NAME
2
3 fs flushvolume - Forces the Cache Manager to discard cached data from a volume
4
5 =head1 SYNOPSIS
6
7 B<fs flushvolume> [B<-path> <I<dir/file path>>+] [B<-help>]
8
9 B<fs flushv> [B<-p> <I<dir/file path>>+] [B<-h>]
10
11 =head1 DESCRIPTION
12
13 The B<fs flushvolume> command removes from the cache all data that was
14 fetched from the same volume as each specified directory or file.  It does
15 not discard cached status information. The next time an application
16 requests data from a flushed directory or file, the Cache Manager fetches
17 the most current version from a File Server, along with a new callback (if
18 necessary) and associated status information. This command has no effect
19 on two types of data:
20
21 =over 4
22
23 =item *
24
25 Data in application program buffers.
26
27 =item *
28
29 Data that has been changed locally and written to the cache but not yet
30 written to the copy on the file server machine.
31
32 =back
33
34 To discard the data and status information associated with individual
35 files and directories, use the B<fs flush> command. To flush a corrupted
36 mount point, use the B<fs flushmount> command.
37
38 =head1 OPTIONS
39
40 =over 4
41
42 =item B<-path> <I<dir/file path>>+
43
44 Names a file or directory from each volume for which to discard all cached
45 data. Partial pathnames are interpreted relative to the current working
46 directory, which is also the default value if this argument is omitted.
47
48 =item B<-help>
49
50 Prints the online help for this command. All other valid options are
51 ignored.
52
53 =back
54
55 =head1 EXAMPLES
56
57 The following command flushes from the cache all data fetched from the
58 volume that contains the current working directory:
59
60    % fs flushvolume 
61
62 =head1 PRIVILEGE REQUIRED
63
64 The issuer must have the C<l> (lookup) permission on the ACL of the root
65 directory of the volume that houses the file or directory named by the
66 B<-path> argument, and on the ACL of each directory that precedes it in
67 the pathname.
68
69 =head1 SEE ALSO
70
71 L<fs_flush(1)>,
72 L<fs_flushmount(1)>
73
74 =head1 COPYRIGHT
75
76 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
77
78 This documentation is covered by the IBM Public License Version 1.0.  It was
79 converted from HTML to POD by software written by Chas Williams and Russ
80 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.