zoom: update zoom info on contentProxy

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

diff --git a/doc/sru_z3950.xml b/doc/sru_z3950.xml
index 2e14946..9034d9a 100644 (file)
--- a/doc/sru_z3950.xml
+++ b/doc/sru_z3950.xml
@@ -18,13 +18,14 @@
  
  <refnamediv>
   <refname>sru_z3950</refname>
-  <refpurpose>Metaproxy Module transforming SRU web service requests to Z3950 Metaproxy packages</refpurpose>
+  <refpurpose>Metaproxy Module transforming SRU web service requests to
+  Z39.50 Metaproxy packages</refpurpose>
  </refnamediv>
  
  <refsect1><title>DESCRIPTION</title>
   <para>
    The <literal>sru_z3950</literal> Metaproxy filter transforms valid
-   SRU GET/POST/SOAP requests to Z3950 requests, and wraps the
+   SRU GET/POST/SOAP requests to Z39.50 requests, and wraps the
    received hit counts and XML records into suitable SRU response messages. 
   </para>
   <para>
@@ -51,7 +52,7 @@
   </para>
   <para>
    It supports the SRU <literal>searchRetrieve</literal> operation, which
-   is transformed into successive Z3950 <literal>init</literal>, 
+   is transformed into successive Z39.50 <literal>init</literal>, 
    <literal>search</literal> and <literal>present</literal> requests. 
   </para>
   <para>
@@ -82,6 +83,29 @@
          </para>
        </listitem>
       </varlistentry>
+      <varlistentry>
+       <term>x-session-id</term>
+       <listitem>
+         <para>
+           Allow a user-defined session ID to be attached to filter
+           log that follows sru_z3950. The ID is present in the
+           log files and not available to the SRU webservice. In order
+           to log material out via SRU, the x-log-enable may be used
+           instead.
+         </para>
+       </listitem>
+      </varlistentry>
+      <varlistentry>
+       <term>x-log-enable</term>
+       <listitem>
+         <para>
+            Controls whether log is to be collected for filters that
+            sru_z3950. Log data is extra response data's log element.
+            A value of 1 enables logging; other value disables
+            logging (default).
+         </para>
+       </listitem>
+      </varlistentry>
     </variablelist>
   </para>
  </refsect1>