Document in SalvageLog(5) the per-partition salvager logs

[openafs.git] / doc / man-pages / pod5 / SalvageLog.pod

diff --git a/doc/man-pages/pod5/SalvageLog.pod b/doc/man-pages/pod5/SalvageLog.pod
index 679b3bc..cdc3aa3 100644 (file)
--- a/doc/man-pages/pod5/SalvageLog.pod
+++ b/doc/man-pages/pod5/SalvageLog.pod
@@ -14,6 +14,14 @@ initial start-up messages to it. If there is an existing file, the
 Salvager renames is to F<SalvageLog.old>, overwriting the existing
 F<SalvageLog.old> file if it exists.
 
+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 F<SalvageLog.I<job>> where I<job> 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 F<SalvageLog>, and then remove the partition-specific files.
+
 The file is in ASCII format. Administrators listed in the
 F</usr/afs/etc/UserList> file can use the B<bos getlog> command to display
 its contents. Alternatively, log onto the file server machine and use a