.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "SALVAGELOG 5"
.TH SALVAGELOG 5 2024-03-20 OpenAFS "AFS File Reference"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
SalvageLog \- Traces Salvager operations
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \fISalvageLog\fR file records a trace of Salvager (\fBsalvager\fR process)
operations on the local machine and describes any error conditions it
encounters.
.PP
If the \fISalvageLog\fR file does not already exist in the \fI/var/log/openafs\fR
directory when the Salvager starts, the process creates it and writes
initial start-up messages to it. If there is an existing file, the
Salvager renames is to \fISalvageLog.old\fR, overwriting the existing
\&\fISalvageLog.old\fR file if it exists.
.PP
When the Salvager is salvaging an entire file server, it creates a
separate log file for each partition it starts salvaging. That file will
be named \fISalvageLog.job\fR where \fIjob\fR is a job number that will
normally (but is not guaranteed to) correspond to the index of the
partition being salvaged. Once salvaging of all partitions is complete,
the Salvager will accumulate all the partition-specific log files, append
them to \fISalvageLog\fR, and then remove the partition-specific files.
.PP
The file is in ASCII format. Administrators listed in the
\&\fI/etc/openafs/server/UserList\fR file can use the \fBbos getlog\fR command to display
its contents. Alternatively, log onto the file server machine and use a
text editor or a file display command such as the UNIX \fBcat\fR command. By
default, the mode bits on the \fISalvageLog\fR file grant the required \f(CW\*(C`r\*(C'\fR
(read) permission to all users.
.PP
The Salvager records operations only as it completes them, and cannot
recover from failures by reviewing the file. The log contents are useful
for administrative evaluation of process failures and other problems.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBUserList\fR\|(5),
\&\fBbos_getlog\fR\|(8),
\&\fBsalvager\fR\|(8)
.SH COPYRIGHT
.IX Header "COPYRIGHT"
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
.PP
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.