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