xml-docbook-documentation-first-pass-20060915
[openafs.git] / doc / xml / AdminReference / sect5 / BosLog.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry id="BosLog5">
3   <refmeta>
4     <refentrytitle>BosLog</refentrytitle>
5     <manvolnum>5</manvolnum>
6   </refmeta>
7   <refnamediv>
8     <refname>BosLog</refname>
9     <refpurpose>Traces BOS Server operations</refpurpose>
10   </refnamediv>
11   <refsect1>
12     <title>Description</title>
13     <para>The <replaceable>BosLog</replaceable> file records a trace of Basic OverSeer (BOS) Server
14     (<emphasis role="bold">bosserver</emphasis> process) operations on the local machine and describes any
15     error conditions it encounters.</para>
16
17     <para>If the <replaceable>BosLog</replaceable> file does not already exist in the <replaceable>/usr/afs/logs</replaceable>
18     directory when the BOS Server starts, the server process creates it and
19     writes initial start-up messages to it. If there is an existing file, the
20     BOS server renames it to <replaceable>BosLog.old</replaceable>, overwriting the existing
21     <replaceable>BosLog.old</replaceable> file if it exists.</para>
22
23     <para>The file is in ASCII format. Administrators listed in the
24     <replaceable>/usr/afs/etc/UserList</replaceable> file can use the <emphasis role="bold">bos getlog</emphasis> command to display
25     its contents. Alternatively, log onto the server machine and use a text
26     editor or a file display command such as the UNIX <emphasis role="bold">cat</emphasis> command. By
27     default, the mode bits on the <replaceable>BosLog</replaceable> file grant the required <computeroutput>r</computeroutput>
28     (read) permission to all users.</para>
29
30     <para>The BOS Server records operations only as it completes them, and cannot
31     recover from failures by reviewing the file. The log contents are useful
32     for administrative evaluation of process failures and other problems.</para>
33
34   </refsect1>
35   <refsect1>
36     <title>See Also</title>
37     <para><link linkend="UserList5">UserList(5)</link>,
38     <link linkend="bos_getlog8">bos_getlog(8)</link>,
39     <link linkend="bosserver8">bosserver(8)</link></para>
40
41   </refsect1>
42   <refsect1>
43     <title>Copyright</title>
44     <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
45
46     <para>This documentation is covered by the IBM Public License Version 1.0.  It was
47     converted from HTML to POD by software written by Chas Williams and Russ
48     Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
49
50   </refsect1>
51 </refentry>