install-and-document-klog-krb5-20080627
[openafs.git] / doc / xml / AdminReference / sect5 / butc_logs.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry id="butc_logs5">
3   <refmeta>
4     <refentrytitle>butc_logs</refentrytitle>
5     <manvolnum>5</manvolnum>
6   </refmeta>
7   <refnamediv>
8     <refname>butc_logs</refname>
9     <refpurpose>Message logs from the Tape Coordinator process</refpurpose>
10   </refnamediv>
11   <refsect1>
12     <title>Description</title>
13     <para>The Backup System Tape Coordinator (<emphasis role="bold">butc</emphasis>) process generates two log
14     files per device, one for error messages and one for actions.</para>
15
16     <refsect2>
17       <title>Error Message Log</title>
18       <para>The <replaceable>TE_</replaceable><emphasis>device_name</emphasis><replaceable></replaceable> file logs error messages generated by the Backup
19       System Tape Coordinator that controls the tape device or backup data file
20       indicated by <emphasis>device_name</emphasis>.</para>
21
22       <para>As the Tape Coordinator initializes, it creates the file in ASCII format
23       in the <replaceable>/usr/afs/backup</replaceable> directory. If there is an existing file, the
24       Tape Coordinator renames it to <replaceable>TE_</replaceable><emphasis>device_name</emphasis><replaceable>.old</replaceable>&gt;, overwriting the
25       existing <replaceable>TE_</replaceable><emphasis>device_name</emphasis><replaceable>.old</replaceable>&gt; file if it exists.</para>
26
27       <para>For a tape device, the Tape Coordinator derives the variable
28       <emphasis>device_name</emphasis> portion of the filename from the device pathname listed in
29       the local <replaceable>/usr/afs/backup/tapeconfig</replaceable> file, by stripping off the initial
30       <computeroutput>/dev/</computeroutput> string and replacing any other slashes in the name with
31       underscores. For example, the filename for a device called <replaceable>/dev/rmt/4m</replaceable>
32       is <replaceable>TE_rmt_4m</replaceable>. Similarly, for a backup data file the Tape Coordinator
33       strips off the initial slash (<computeroutput>/</computeroutput>) and replaces any other slashes in the
34       name with underscores. For example, the filename for a backup data file
35       called <replaceable>/var/tmp/FILE</replaceable> is <replaceable>TE_var_tmp_FILE</replaceable>.</para>
36
37       <para>The messages in the file describe the error and warning conditions the
38       Tape Coordinator encounters as it operates. For instance, a message can
39       list the volumes that are inaccessible during a dump operation, or warn
40       that the Tape Coordinator is overwriting a tape or backup data file. The
41       messages also appear in the <replaceable>/usr/afs/backup/TL_</replaceable><emphasis>device_name</emphasis><replaceable></replaceable> file,
42       which traces most of the Tape Coordinator's actions.</para>
43
44     </refsect2>
45     <refsect2>
46       <title>Action Log</title>
47       <para>The <replaceable>TL_</replaceable><emphasis>device_name</emphasis><replaceable></replaceable> file logs the actions performed by the Backup
48       System Tape Coordinator that controls the tape device or backup data file
49       indicated by <emphasis>device_name</emphasis>. It also records the same error and warning
50       messages written to the <replaceable>TE_</replaceable><emphasis>device_name</emphasis><replaceable></replaceable> file.</para>
51
52       <para>As the Tape Coordinator initializes, it creates the file in ASCII format
53       in the <replaceable>/usr/afs/backup</replaceable> directory. If there is an existing file, the
54       Tape Coordinator renames it to <replaceable>TL_</replaceable><emphasis>device_name</emphasis><replaceable>.old</replaceable>, overwriting the
55       existing <replaceable>TL_</replaceable><emphasis>device_name</emphasis><replaceable>.old</replaceable> file if it exists.</para>
56
57       <para>For a tape device, the Tape Coordinator derives the variable
58       <emphasis>device_name</emphasis> portion of the filename from the device pathname listed in
59       the local <replaceable>/usr/afs/backup/tapeconfig</replaceable> file, by stripping off the initial
60       <computeroutput>/dev/</computeroutput> string and replacing any other slashes in the name with
61       underscores. For example, the filename for a device called <replaceable>/dev/rmt/4m</replaceable>
62       is <replaceable>TL_rmt_4m</replaceable>. Similarly, for a backup data file the Tape Coordinator
63       strips off the initial slash (<computeroutput>/</computeroutput>) and replaces any other slashes in the
64       name with underscores. For example, the filename for a backup data file
65       called <replaceable>/var/tmp/FILE</replaceable> is <replaceable>TL_var_tmp_FILE</replaceable>.</para>
66
67     </refsect2>
68   </refsect1>
69   <refsect1>
70     <title>See Also</title>
71     <para><link linkend="tapeconfig5">tapeconfig(5)</link>,
72     <link linkend="butc8">butc(8)</link></para>
73
74   </refsect1>
75   <refsect1>
76     <title>Copyright</title>
77     <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
78
79     <para>This documentation is covered by the IBM Public License Version 1.0.  It was
80     converted from HTML to POD by software written by Chas Williams and Russ
81     Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
82
83   </refsect1>
84 </refentry>