Import Upstream version 1.8.5
[hcoop/debian/openafs.git] / doc / man-pages / pod5 / butc_logs.pod
CommitLineData
805e021f
CE
1=head1 NAME
2
3butc_logs - Message logs from the Tape Coordinator process
4
5=head1 DESCRIPTION
6
7The Backup System Tape Coordinator (B<butc>) process generates two log
8files per device, one for error messages and one for actions.
9
10=head2 Error Message Log
11
12The F<TE_I<device_name>> file logs error messages generated by the Backup
13System Tape Coordinator that controls the tape device or backup data file
14indicated by I<device_name>.
15
16As the Tape Coordinator initializes, it creates the file in ASCII format
17in the F</usr/afs/backup> directory. If there is an existing file, the
18Tape Coordinator renames it to F<TE_I<device_name>.old>>, overwriting the
19existing F<TE_I<device_name>.old>> file if it exists.
20
21For a tape device, the Tape Coordinator derives the variable
22I<device_name> portion of the filename from the device pathname listed in
23the local F</usr/afs/backup/tapeconfig> file, by stripping off the initial
24C</dev/> string and replacing any other slashes in the name with
25underscores. For example, the filename for a device called F</dev/rmt/4m>
26is F<TE_rmt_4m>. Similarly, for a backup data file the Tape Coordinator
27strips off the initial slash (C</>) and replaces any other slashes in the
28name with underscores. For example, the filename for a backup data file
29called F</var/tmp/FILE> is F<TE_var_tmp_FILE>.
30
31The messages in the file describe the error and warning conditions the
32Tape Coordinator encounters as it operates. For instance, a message can
33list the volumes that are inaccessible during a dump operation, or warn
34that the Tape Coordinator is overwriting a tape or backup data file. The
35messages also appear in the F</usr/afs/backup/TL_I<device_name>> file,
36which traces most of the Tape Coordinator's actions.
37
38=head2 Action Log
39
40The F<TL_I<device_name>> file logs the actions performed by the Backup
41System Tape Coordinator that controls the tape device or backup data file
42indicated by I<device_name>. It also records the same error and warning
43messages written to the F<TE_I<device_name>> file.
44
45As the Tape Coordinator initializes, it creates the file in ASCII format
46in the F</usr/afs/backup> directory. If there is an existing file, the
47Tape Coordinator renames it to F<TL_I<device_name>.old>, overwriting the
48existing F<TL_I<device_name>.old> file if it exists.
49
50For a tape device, the Tape Coordinator derives the variable
51I<device_name> portion of the filename from the device pathname listed in
52the local F</usr/afs/backup/tapeconfig> file, by stripping off the initial
53C</dev/> string and replacing any other slashes in the name with
54underscores. For example, the filename for a device called F</dev/rmt/4m>
55is F<TL_rmt_4m>. Similarly, for a backup data file the Tape Coordinator
56strips off the initial slash (C</>) and replaces any other slashes in the
57name with underscores. For example, the filename for a backup data file
58called F</var/tmp/FILE> is F<TL_var_tmp_FILE>.
59
60=head1 SEE ALSO
61
62L<tapeconfig(5)>,
63L<butc(8)>
64
65=head1 COPYRIGHT
66
67IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
68
69This documentation is covered by the IBM Public License Version 1.0. It was
70converted from HTML to POD by software written by Chas Williams and Russ
71Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.