man-page-reorg-20051209
[openafs.git] / doc / man-pages / pod5 / SALVAGE.fs.pod
1 =head1 NAME
2
3 SALVAGE.fs - Triggers salvaging of AFS server partitions
4
5 =head1 DESCRIPTION
6
7 The SALVAGE.fs file, if present in a file server
8 machine's B</usr/afs/local> directory, indicates to the Basic
9 OverSeer (BOS) Server (B<bosserver> process) that it must invoke the
10 Salvager (B<salvager> process) during recovery from a failure of the
11 File Server (B<fileserver> process).
12
13 The BOS Server creates the zero-length file each time it starts or restarts
14 the B<fs> process. When the File Server exits normally (for
15 example, in response to the B<bos shutdown> or B<bos stop>
16 command), the BOS Server removes the file. However, if the File Server
17 exits unexpectedly, the file remains in the B</usr/afs/local>
18 directory as a signal that the BOS Server must invoke the Salvager process to
19 repair any file system inconsistencies possibly introduced during the failure,
20 before restarting the File Server and Volume Server processes.
21
22 Do not create or remove this file. To invoke the Salvager process
23 directly, use the B<bos salvage> command or log onto the file server
24 machine as the local superuser B<root> and issue the
25 B<salvager> command.
26
27 =head1 SEE ALSO
28
29 L<bos_salvage(1)>,
30 L<bosserver(1)>,
31 L<fileserver(1)>,
32 L<salvager(1)>,
33 L<volserver(1)>
34
35 =head1 COPYRIGHT
36
37 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
38
39 This documentation is covered by the IBM Public License Version 1.0.  It was
40 converted from HTML to POD by software written by Chas Williams and Russ
41 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.