doc: Make all vos pages =include common options
[openafs.git] / doc / man-pages / pod1 / fs_flushmount.pod
1 =head1 NAME
2
3 fs_flushmount - Forces the Cache Manager to discard a mount point
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<fs flushmount> S<<< [B<-path> <I<dir/file path>>+] >>> [B<-help>]
11
12 B<fs flushm> S<<< [B<-p> <I<dir/file path>>+] >>> [B<-h>]
13
14 =for html
15 </div>
16
17 =head1 DESCRIPTION
18
19 The B<fs flushmount> command removes from the cache all information
20 associated with each mount point named by the B<-path> argument. The next
21 time an application accesses the mount point, the Cache Manager fetches
22 the most current version of it from the File Server. Data cached from the
23 associated volume is not affected.
24
25 The command's intended use is to discard information about mount points
26 that has become corrupted in the cache. (The Cache Manager periodically
27 refreshes cached mount points, but the only other way to discard them
28 immediately is to reinitialize the Cache Manager by rebooting the
29 machine.) Symptoms of a corrupted mount point included garbled output from
30 the B<fs lsmount> command, and failed attempts to change directory to or
31 list the contents of a mount point.
32
33 To flush cached data rather than a mount point, use the B<fs flush> or
34 B<fs flushvolume> command.
35
36 =head1 OPTIONS
37
38 =over 4
39
40 =item B<-path> <I<dir/file path>>+
41
42 Names each mount point to flush from the cache. Partial pathnames are
43 interpreted relative to the current working directory, which is also the
44 default value if this argument is omitted.
45
46 =item B<-help>
47
48 Prints the online help for this command. All other valid options are
49 ignored.
50
51 =back
52
53 =head1 EXAMPLES
54
55 The following command flushes from the cache the mount point for user
56 C<pat>'s home directory:
57
58    % fs flushm /afs/example.com/usr/pat
59
60 =head1 PRIVILEGE REQUIRED
61
62 The issuer must have the C<l> (lookup) permission on the ACL of the root
63 directory of the volume that houses the file or directory named by the
64 B<-path> argument, and on the ACL of each directory that precedes it in
65 the pathname.
66
67 =head1 SEE ALSO
68
69 L<fs_flush(1)>,
70 L<fs_flushvolume(1)>,
71 L<fs_lsmount(1)>
72
73 =head1 COPYRIGHT
74
75 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
76
77 This documentation is covered by the IBM Public License Version 1.0.  It was
78 converted from HTML to POD by software written by Chas Williams and Russ
79 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.