Document in SalvageLog(5) the per-partition salvager logs
[openafs.git] / doc / man-pages / pod5 / SalvageLog.pod
1 =head1 NAME
2
3 SalvageLog - Traces Salvager operations
4
5 =head1 DESCRIPTION
6
7 The F<SalvageLog> file records a trace of Salvager (B<salvager> process)
8 operations on the local machine and describes any error conditions it
9 encounters.
10
11 If the F<SalvageLog> file does not already exist in the F</usr/afs/logs>
12 directory when the Salvager starts, the process creates it and writes
13 initial start-up messages to it. If there is an existing file, the
14 Salvager renames is to F<SalvageLog.old>, overwriting the existing
15 F<SalvageLog.old> file if it exists.
16
17 When the Salvager is salvaging an entire file server, it creates a
18 separate log file for each partition it starts salvaging. That file will
19 be named F<SalvageLog.I<job>> where I<job> is a job number that will
20 normally (but is not guaranteed to) correspond to the index of the
21 partition being salvaged. Once salvaging of all partitions is complete,
22 the Salvager will accumulate all the partition-specific log files, append
23 them to F<SalvageLog>, and then remove the partition-specific files.
24
25 The file is in ASCII format. Administrators listed in the
26 F</usr/afs/etc/UserList> file can use the B<bos getlog> command to display
27 its contents. Alternatively, log onto the file server machine and use a
28 text editor or a file display command such as the UNIX B<cat> command. By
29 default, the mode bits on the F<SalvageLog> file grant the required C<r>
30 (read) permission to all users.
31
32 The Salvager records operations only as it completes them, and cannot
33 recover from failures by reviewing the file. The log contents are useful
34 for administrative evaluation of process failures and other problems.
35
36 =head1 SEE ALSO
37
38 L<UserList(5)>,
39 L<bos_getlog(8)>,
40 L<salvager(8)>
41
42 =head1 COPYRIGHT
43
44 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
45
46 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.