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