xml-docbook-documentation-first-pass-20060915
[openafs.git] / doc / xml / AdminReference / sect5 / SALVAGE.fs.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry id="SALVAGE_fs5">
3   <refmeta>
4     <refentrytitle>SALVAGE.fs</refentrytitle>
5     <manvolnum>5</manvolnum>
6   </refmeta>
7   <refnamediv>
8     <refname>SALVAGE.fs</refname>
9     <refpurpose>Triggers salvaging of AFS server partitions</refpurpose>
10   </refnamediv>
11   <refsect1>
12     <title>Description</title>
13     <para>The <replaceable>SALVAGE.fs</replaceable> file, if present in a file server machine's
14     <replaceable>/usr/afs/local</replaceable> directory, indicates to the Basic OverSeer (BOS) Server
15     (<emphasis role="bold">bosserver</emphasis> process) that it must invoke the Salvager (<emphasis role="bold">salvager</emphasis>
16     process) during recovery from a failure of the File Server (<emphasis role="bold">fileserver</emphasis>
17     process).</para>
18
19     <para>The BOS Server creates the zero-length file each time it starts or
20     restarts the <computeroutput>fs</computeroutput> process. When the File Server exits normally (for
21     example, in response to the <emphasis role="bold">bos shutdown</emphasis> or <emphasis role="bold">bos stop</emphasis> command), the
22     BOS Server removes the file. However, if the File Server exits
23     unexpectedly, the file remains in the <replaceable>/usr/afs/local</replaceable> directory as a
24     signal that the BOS Server must invoke the Salvager process to repair any
25     file system inconsistencies possibly introduced during the failure, before
26     restarting the File Server and Volume Server processes.</para>
27
28     <para>Do not create or remove this file. To invoke the Salvager process
29     directly, use the <emphasis role="bold">bos salvage</emphasis> command or log onto the file server
30     machine as the local superuser <computeroutput>root</computeroutput> and issue the <emphasis role="bold">salvager</emphasis> command.</para>
31
32   </refsect1>
33   <refsect1>
34     <title>See Also</title>
35     <para><link linkend="bos_salvage8">bos_salvage(8)</link>,
36     <link linkend="bosserver8">bosserver(8)</link>,
37     <link linkend="fileserver8">fileserver(8)</link>,
38     <link linkend="salvager8">salvager(8)</link>,
39     <link linkend="volserver8">volserver(8)</link></para>
40
41   </refsect1>
42   <refsect1>
43     <title>Copyright</title>
44     <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
45
46     <para>This documentation is covered by the IBM Public License Version 1.0.  It was
47     converted from HTML to POD by software written by Chas Williams and Russ
48     Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
49
50   </refsect1>
51 </refentry>