[hcoop/debian/openafs.git] / doc / man-pages / pod1 / fs_flushvolume.pod

=head1 NAME

fs_flushvolume - Forces the Cache Manager to discard cached data from a volume

=head1 SYNOPSIS

=for html
<div class="synopsis">

B<fs flushvolume> S<<< [B<-path> <I<dir/file path>>+] >>> [B<-help>]

B<fs flushv> S<<< [B<-p> <I<dir/file path>>+] >>> [B<-h>]

=for html
</div>

=head1 DESCRIPTION

The B<fs flushvolume> command removes from the cache all data that was
fetched from the same volume as each specified directory or file.  It does
not discard cached status information. The next time an application
requests data from a flushed directory or file, the Cache Manager fetches
the most current version from a File Server, along with a new callback (if
necessary) and associated status information. This command has no effect
on two types of data:

=over 4

=item *

Data in application program buffers.

=item *

Data that has been changed locally and written to the cache but not yet
written to the copy on the file server machine.

=back

To discard the data and status information associated with individual
files and directories, use the B<fs flush> command. To flush a corrupted
mount point, use the B<fs flushmount> command.

=head1 OPTIONS

=over 4

=item B<-path> <I<dir/file path>>+

Names a file or directory from each volume for which to discard all cached
data. Partial pathnames are interpreted relative to the current working
directory, which is also the default value if this argument is omitted.

=item B<-help>

Prints the online help for this command. All other valid options are
ignored.

=back

=head1 EXAMPLES

The following command flushes from the cache all data fetched from the
volume that contains the current working directory:

   % fs flushvolume

=head1 PRIVILEGE REQUIRED

The issuer must have the C<l> (lookup) permission on the ACL of the root
directory of the volume that houses the file or directory named by the
B<-path> argument, and on the ACL of each directory that precedes it in
the pathname.

=head1 SEE ALSO

L<fs_flush(1)>,
L<fs_flushmount(1)>

=head1 COPYRIGHT

IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.

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