Fix typo in bos_create manpage
[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 F<SALVAGE.fs> file, if present in a file server machine's
8 F</usr/afs/local> directory, indicates to the Basic OverSeer (BOS) Server
9 (B<bosserver> process) that it must invoke the Salvager (B<salvager>
10 process) during recovery from a failure of the File Server (B<fileserver>
11 process).
12
13 The BOS Server creates the zero-length file each time it starts or
14 restarts the C<fs> process. When the File Server exits normally (for
15 example, in response to the B<bos shutdown> or B<bos stop> command), the
16 BOS Server removes the file. However, if the File Server exits
17 unexpectedly, the file remains in the F</usr/afs/local> directory as a
18 signal that the BOS Server must invoke the Salvager process to repair any
19 file system inconsistencies possibly introduced during the failure, before
20 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 C<root> and issue the B<salvager> command.
25
26 =head1 SEE ALSO
27
28 L<bos_salvage(8)>,
29 L<bosserver(8)>,
30 L<fileserver(8)>,
31 L<salvager(8)>,
32 L<volserver(8)>
33
34 =head1 COPYRIGHT
35
36 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
37
38 This documentation is covered by the IBM Public License Version 1.0.  It was
39 converted from HTML to POD by software written by Chas Williams and Russ
40 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.