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