openafs/doc/xml/AdminReference/sect1/fs_flushvolume.xml
Chas Williams 52557c982e xml-docbook-documentation-first-pass-20060915
needs more massaging to make it fit the tree, but, get it here first
2006-09-16 01:13:22 +00:00

100 lines
3.9 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<refentry id="fs_flushvolume1">
<refmeta>
<refentrytitle>fs flushvolume</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>fs flushvolume</refname>
<refpurpose>Forces the Cache Manager to discard cached data from a volume</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<para><emphasis role="bold">fs flushvolume</emphasis> [<emphasis role="bold">-path</emphasis> &lt;<emphasis>dir/file path</emphasis>&gt;+] [<emphasis role="bold">-help</emphasis>]</para>
<para><emphasis role="bold">fs flushv</emphasis> [<emphasis role="bold">-p</emphasis> &lt;<emphasis>dir/file path</emphasis>&gt;+] [<emphasis role="bold">-h</emphasis>]</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>The <emphasis role="bold">fs flushvolume</emphasis> 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:</para>
<itemizedlist>
<listitem>
<para>Data in application program buffers.</para>
</listitem>
<listitem>
<para>Data that has been changed locally and written to the cache but not yet
written to the copy on the file server machine.</para>
</listitem>
</itemizedlist>
<para>To discard the data and status information associated with individual
files and directories, use the <emphasis role="bold">fs flush</emphasis> command. To flush a corrupted
mount point, use the <emphasis role="bold">fs flushmount</emphasis> command.</para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term><emphasis role="bold">-path</emphasis> &lt;<emphasis>dir/file path</emphasis>&gt;+</term>
<listitem>
<para>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.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">-help</emphasis></term>
<listitem>
<para>Prints the online help for this command. All other valid options are
ignored.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
<para>The following command flushes from the cache all data fetched from the
volume that contains the current working directory:</para>
<programlisting>
% fs flushvolume
</programlisting>
</refsect1>
<refsect1>
<title>Privilege Required</title>
<para>The issuer must have the <computeroutput>l</computeroutput> (lookup) permission on the ACL of the root
directory of the volume that houses the file or directory named by the
<emphasis role="bold">-path</emphasis> argument, and on the ACL of each directory that precedes it in
the pathname.</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para><link linkend="fs_flush1">fs_flush(1)</link>,
<link linkend="fs_flushmount1">fs_flushmount(1)</link></para>
</refsect1>
<refsect1>
<title>Copyright</title>
<para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
<para>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.</para>
</refsect1>
</refentry>