xml-docbook-documentation-first-pass-20060915

[openafs.git] / doc / xml / AdminReference / sect5 / VolserLog.xml

diff --git a/doc/xml/AdminReference/sect5/VolserLog.xml b/doc/xml/AdminReference/sect5/VolserLog.xml
new file mode 100644 (file)
index 0000000..3b7a31d
--- /dev/null
+++ b/doc/xml/AdminReference/sect5/VolserLog.xml
@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<refentry id="VolserLog5">
+  <refmeta>
+    <refentrytitle>VolserLog</refentrytitle>
+    <manvolnum>5</manvolnum>
+  </refmeta>
+  <refnamediv>
+    <refname>VolserLog</refname>
+    <refpurpose>Traces Volume Server operations</refpurpose>
+  </refnamediv>
+  <refsect1>
+    <title>Description</title>
+    <para>The <replaceable>VolserLog</replaceable> file records a trace of Volume Server (<emphasis role="bold">volserver</emphasis>
+    process) operations on the local machine and describes any error
+    conditions it encounters.</para>
+
+    <para>If the VolserLog file does not already exist in the <replaceable>/usr/afs/logs</replaceable>
+    directory when the Volume Server starts, the server process creates it and
+    writes initial start-up messages to it. If there is an existing file, the
+    Volume Server renames it to <replaceable>VolserLog.old</replaceable>, overwriting the existing
+    <replaceable>VolserLog.old</replaceable> file if it exists.</para>
+
+    <para>The file is in ASCII format. Administrators listed in the
+    <replaceable>/usr/afs/etc/UserList</replaceable> file can use the <emphasis role="bold">bos getlog</emphasis> command to display
+    its contents. Alternatively, log onto the file server machine and use a
+    text editor or a file display command such as the UNIX <emphasis role="bold">cat</emphasis> command. By
+    default, the mode bits on the <replaceable>VolserLog</replaceable> file grant the required <computeroutput>r</computeroutput>
+    (read) permission to all users.</para>
+
+    <para>The Volume Server records operations only as it completes them, and so
+    cannot recover from failures by reviewing the file. The log contents are
+    useful for administrative evaluation of process failures and other
+    problems.</para>
+
+  </refsect1>
+  <refsect1>
+    <title>See Also</title>
+    <para><link linkend="UserList5">UserList(5)</link>,
+    <link linkend="bos_getlog8">bos_getlog(8)</link>,
+    <link linkend="volserver8">volserver(8)</link></para>
+
+  </refsect1>
+  <refsect1>
+    <title>Copyright</title>
+    <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
+
+    <para>This documentation is covered by the IBM Public License Version 1.0.  It was
+    converted from HTML to POD by software written by Chas Williams and Russ
+    Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
+
+  </refsect1>
+</refentry>