doc/log.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
   2     "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
   3  <!ENTITY copyright SYSTEM "copyright.xml">
   4  <!ENTITY % common SYSTEM "common/common.ent">
   5      %common;
   6 ]>
   7 <!-- $Id: log.xml,v 1.7 2007-02-17 13:24:16 adam Exp $ -->
   8 <refentry>
   9  <refmeta>
  10   <refentrytitle>log</refentrytitle>
  11   <manvolnum>3mp</manvolnum>
  12    <refmiscinfo>Metaproxy Module</refmiscinfo>
  13 </refmeta>
  14
  15  <refnamediv>
  16   <refname>log</refname>
  17   <refpurpose>Metaproxy Package Logging Module</refpurpose>
  18  </refnamediv>
  19
  20  <refsect1><title>DESCRIPTION</title>
  21   <para>
  22    This filter logs packages sent - and received .
  23   </para>
  24
  25   <para>
  26    Configurable values:
  27    <variablelist>
  28     <varlistentry><term>message</term>
  29      <listitem>
  30       <para>
  31        Specifies a custom message for the log message.
  32       </para>
  33      </listitem>
  34     </varlistentry>
  35     <varlistentry><term>filename</term>
  36      <listitem>
  37       <para>
  38        Specifies a name of file that log messages is written to.
  39       </para>
  40      </listitem>
  41     </varlistentry>
  42     <varlistentry><term>category</term>
  43      <listitem>
  44       <para>
  45        Specifies the category of messages to be logged. The category is an
  46        XML attribute and value of attribute is a boolean;
  47        <literal>true</literal> for enabled; <literal>false</literal>
  48        for disabled.
  49        The following category attributes are supported:
  50
  51    <variablelist>
  52     <varlistentry><term>access</term>
  53      <listitem>
  54       <para>
  55        One line accesss log. This is a brief message stating the
  56        request and response. This is enabled by default. All other
  57        categories are disabled by default.
  58       </para>
  59      </listitem>
  60     </varlistentry>
  61     <varlistentry><term>request-apdu</term>
  62      <listitem>
  63       <para>
  64        Z39.50 Request APDU.
  65       </para>
  66      </listitem>
  67     </varlistentry>
  68     <varlistentry><term>response-apdu</term>
  69      <listitem>
  70       <para>
  71        Z39.50 Response APDU.
  72       </para>
  73      </listitem>
  74     </varlistentry>
  75     <varlistentry><term>apdu</term>
  76      <listitem>
  77       <para>
  78        Z39.50 APDU (request and response)
  79       </para>
  80      </listitem>
  81     </varlistentry>
  82     <varlistentry><term>request-session</term>
  83      <listitem>
  84       <para>
  85        Request session.
  86       </para>
  87      </listitem>
  88     </varlistentry>
  89     <varlistentry><term>response-session</term>
  90      <listitem>
  91       <para>
  92        Response session.
  93       </para>
  94      </listitem>
  95     </varlistentry>
  96     <varlistentry><term>session</term>
  97      <listitem>
  98       <para>
  99        Session (request and response)
 100       </para>
 101      </listitem>
 102     </varlistentry>
 103     <varlistentry><term>init-options</term>
 104      <listitem>
 105       <para>
 106        Z39.50 Init Request options
 107       </para>
 108      </listitem>
 109     </varlistentry>
 110    </variablelist>
 111
 112
 113       </para>
 114      </listitem>
 115     </varlistentry>
 116    </variablelist>
 117   </para>
 118  </refsect1>
 119
 120  <refsect1><title>EXAMPLES</title>
 121   <para>
 122    A typical configuration looks like this:
 123    <screen><![CDATA[
 124     <filter type="log">
 125      <message>B</message>
 126      <category access="true"/>
 127      <filename>logs/metaproxy.log</filename>
 128     </filter>
 129 ]]>
 130    </screen>
 131   </para>
 132  </refsect1>
 133
 134  <refsect1><title>SEE ALSO</title>
 135   <para>
 136    <citerefentry>
 137     <refentrytitle>metaproxy</refentrytitle>
 138     <manvolnum>1</manvolnum>
 139    </citerefentry>
 140   </para>
 141  </refsect1>
 142
 143  &copyright;
 144 </refentry>
 145
 146 <!-- Keep this comment at the end of the file
 147 Local variables:
 148 mode: sgml
 149 sgml-omittag:t
 150 sgml-shorttag:t
 151 sgml-minimize-attributes:nil
 152 sgml-always-quote-attributes:t
 153 sgml-indent-step:1
 154 sgml-indent-data:t
 155 sgml-parent-document:nil
 156 sgml-local-catalogs: nil
 157 sgml-namecase-general:t
 158 End:
 159 -->