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