pod-man-pages-20051015
[openafs.git] / doc / man-pages / pod / 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 fs flushmount [B<-path> I<dir/file path> [I<dir/file path> ...]]  [B<-help>]
8
9 fs flushm [B<-p> I<dir/file path> [I<dir/file path> ...]]  [B<-h>]
10
11 =head1 DESCRIPTION
12
13 The C<fs flushmount> command removes from the cache all information
14 associated with each mount point named by the B<-path> argument. The next
15 time an application accesses the mount point, the Cache Manager
16 fetches the most current version of it from the File Server. Data
17 cached from the associated volume is not affected.
18
19 The command's intended use is to discard information about mount
20 points that has become corrupted in the cache. (The Cache Manager
21 periodically refreshes cached mount points, but the only other way to
22 discard them immediately is to reinitialize the Cache Manager by
23 rebooting the machine.) Symptoms of a corrupted mount point included
24 garbled output from the C<fs lsmount> command, and failed attempts to
25 change directory to or list the contents of a mount point.
26
27 To flush cached data rather than a mount point, use the C<fs flush> or C<fs
28 flushvolume> command.
29
30 =head1 OPTIONS
31
32 =over 4
33
34 =item B<-path> I<dir/file path> [I<dir/file path> ...]
35
36 Names each mount point to flush from the cache. Partial
37 pathnames are interpreted relative to the current working
38 directory, which is also the default value if this argument is
39 omitted.
40
41 =item B<-help>
42
43 Prints the online help for this command. All other valid
44 options are ignored.
45
46 =back
47
48 =head1 EXAMPLES
49
50 The following command flushes from the cache the mount point for user
51 B<pat>'s home directory:
52
53     fs flushm /afs/abc.com/usr/pat
54
55 =head1 PRIVILEGE REQUIRED
56
57 The issuer must have the B<l> (B<lookup>) permission on the ACL of the root
58 directory of the volume that houses the file or directory named by the
59 B<-path> argument, and on the ACL of each directory that precedes it in
60 the pathname.
61
62 =head1 COPYRIGHT
63
64 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
65
66 Converted from html to pod by Alf Wachsmann <alfw@slac.stanford.edu>, 2003,
67 and Elizabeth Cassell <e_a_c@mailsnare.net>, 2004,
68 Stanford Linear Accelerator Center, a department of Stanford University.
69
70 =head1 SEE ALSO
71
72 L<fs_flush(1)>,
73 L<fs_flushvolume(1)>,
74 L<fs_lsmount(1)>
75
76 =cut