GPL v2.

[metaproxy-moved-to-github.git] / doc / log.xml

diff --git a/doc/log.xml b/doc/log.xml
index 4c55955..1c3cf5c 100644 (file)
--- a/doc/log.xml
+++ b/doc/log.xml
@@ -1,9 +1,11 @@
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" 
     "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
  <!ENTITY copyright SYSTEM "copyright.xml">
+ <!ENTITY % common SYSTEM "common/common.ent">
+     %common;
 ]>
-<!-- $Id: log.xml,v 1.2 2006-04-20 11:12:32 mike Exp $ -->
-<refentry>
+<!-- $Id: log.xml,v 1.9 2007-05-09 21:23:08 adam Exp $ -->
+<refentry id="ref-log">
  <refmeta>
   <refentrytitle>log</refentrytitle>
   <manvolnum>3mp</manvolnum>
@@ -12,13 +14,108 @@
  
  <refnamediv>
   <refname>log</refname>
-  <refpurpose>logs packages</refpurpose>
+  <refpurpose>Metaproxy Package Logging Module</refpurpose>
  </refnamediv>
  
  <refsect1><title>DESCRIPTION</title>
   <para>
    This filter logs packages sent - and received . 
   </para>
+
+  <para>
+   Configurable values:
+   <variablelist>
+    <varlistentry><term>message</term>
+     <listitem>
+      <para>
+       Specifies a custom message for the log message.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry><term>filename</term>
+     <listitem>
+      <para>
+       Specifies a name of file that log messages is written to.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry><term>category</term>
+     <listitem>
+      <para>
+       Specifies the category of messages to be logged. The category is an
+       XML attribute and value of attribute is a boolean; 
+       <literal>true</literal> for enabled; <literal>false</literal>
+       for disabled.
+       The following category attributes are supported:
+
+   <variablelist>
+    <varlistentry><term>access</term>
+     <listitem>
+      <para>
+       One line log messages inspired by Apache access log entries.
+       This is a brief message stating the request and response.
+       This is enabled by default. All other categories are disabled by
+       default.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry><term>request-apdu</term>
+     <listitem>
+      <para>
+       Z39.50 Request APDU.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry><term>response-apdu</term>
+     <listitem>
+      <para>
+       Z39.50 Response APDU.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry><term>apdu</term>
+     <listitem>
+      <para>
+       Z39.50 APDU (request and response)
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry><term>request-session</term>
+     <listitem>
+      <para>
+       Request session.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry><term>response-session</term>
+     <listitem>
+      <para>
+       Response session.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry><term>session</term>
+     <listitem>
+      <para>
+       Session (request and response)
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry><term>init-options</term>
+     <listitem>
+      <para>
+       Z39.50 Init Request options
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+
+
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
  </refsect1>
  
  <refsect1><title>EXAMPLES</title>
@@ -27,6 +124,8 @@
    <screen><![CDATA[
     <filter type="log">
      <message>B</message>
+     <category access="true"/>
+     <filename>logs/metaproxy.log</filename>
     </filter>
 ]]>
    </screen>