X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fproxy.xml;h=0fdbd1306d316b865e3c20588477ab058da32e08;hb=9e1bd9899f0a7d7e7c0a9097ffb1ff64db2627c9;hp=051e0fb6bec9188ab38f43351c51ec25611d5e71;hpb=d94ff2fae57f9d9ef58d6bed35fbd308474adad8;p=yazpp-moved-to-github.git

diff --git a/doc/proxy.xml b/doc/proxy.xml
index 051e0fb..0fdbd13 100644
--- a/doc/proxy.xml
+++ b/doc/proxy.xml
@@ -58,7 +58,7 @@
     start it up.  It will work exactly as usual, but all the packets
     will be sent via the proxy, which will generate a log like this:
    </para>
-   <screen>
+   <screen><![CDATA[
     decode choice
     initRequest {
         referenceId OCTETSTRING(len=4) 69 6E 69 74
@@ -119,6 +119,7 @@
             }
         }
     }
+]]>
    </screen>
   </section>
   
@@ -172,7 +173,7 @@
    <para>
     When a client reconnects, query and record caching works better, if the
     proxy assigns it to the same backend as before. And the result set
-    (if any) is re-used. To achive this, Index Data defined a session
+    (if any) is re-used. To achieve this, Index Data defined a session
     cookie which identifies the backend session.
    </para>
    <para>
@@ -298,7 +299,7 @@
     <title>Configuration: target</title>
     <para>
      The element <literal>target</literal> which may be repeated zero
-     or more times with parent elemtn <literal>proxy</literal> contains
+     or more times with parent element <literal>proxy</literal> contains
      information about each backend target.
      The <literal>target</literal> element have two attributes:
      <literal>name</literal> which holds the logical name of the backend
@@ -309,7 +310,6 @@
     <para>
      <screen>
      &lt;?xml version="1.0"?>
-     &lt;!-- $Id -->
      &lt;proxy>
       &lt;target name="server1" default="1">
        &lt;!-- description of server1 .. -->
@@ -375,7 +375,7 @@
      measures the number of bytes transferred within the last minute.
      The <literal>pdu</literal> is the number of requests in the last
      minute. The <literal>retrieve</literal> holds the maximum records to
-     be retrived in one Present Request.
+     be retrieved in one Present Request.
     </para>
     <para>
      If a bandwidth/pdu limit is reached the proxy will postpone the
@@ -455,7 +455,7 @@
      or a particular record syntax request from the client.
     </para>
     <para>
-     The <literal>syntax</literal> has one equired attribute:
+     The <literal>syntax</literal> has one required attribute:
      <literal>type</literal> which is the Preferred Record Syntax.
     </para>
     <para>
@@ -473,14 +473,14 @@
      <literal>type</literal> should be XML. The proxy will use
      preferred record syntax USMARC/MARC21 against the backend target.
     </para>
-    <para>To accept USMARC and offer MARCXML XML recors but reject
-     all other requests the following configuaration could be used:
+    <para>To accept USMARC and offer MARCXML XML records but reject
+     all other requests the following configuration could be used:
      <screen>
       &lt;proxy>
        &lt;target name="mytarget">
-	&lt;syntax type="usmarc"/>
-	&lt;syntax type="xml" marcxml="1"/>
-	&lt;syntax type="*" error="238"/>
+        &lt;syntax type="usmarc"/>
+        &lt;syntax type="xml" marcxml="1"/>
+        &lt;syntax type="*" error="238"/>
        &lt;/target>
       &lt;/proxy>
      </screen>
@@ -495,7 +495,7 @@
      a target session is shut down.
     </para>
     <para>
-     This can also be specified on the command line bt using option
+     This can also be specified on the command line by using option
      <literal>-T</literal>. Refer to <xref linkend="proxy-usage"/>.
     </para>
    </section>
@@ -552,7 +552,81 @@
      </para>
      </tip>
    </section>
-   
+
+   <section id="proxy-config-log">
+    <title>Configuration: log</title>
+    <para>
+     The element <literal>log</literal> is the child of element
+     <literal>proxy</literal> and specifies what to be logged by the
+     proxy.
+     </para>
+    <para>
+     Specify the log file with command-line option <literal>-l</literal>.
+    </para>
+    <para>
+     The text of the <literal>log</literal> element is a sequence of
+     options separated by white space. See the table below:
+     <table frame="top"><title>Logging options</title>
+      <tgroup cols="2">
+       <colspec colwidth="1*" colname="option"/>
+       <colspec colwidth="2*" colname="description"/>
+       <thead>
+	<row>
+	 <entry>Option</entry>
+	 <entry>Description</entry>
+	</row>
+       </thead>
+       <tbody>
+	<row>
+	 <entry><literal>client-apdu</literal></entry>
+	 <entry>
+	  Log APDUs as reported by YAZ for the
+	  communication between the client and the proxy.
+	  This facility is equivalent to the APDU logging that
+	  happens when using option <literal>-a</literal>, however
+	  this tells the proxy to log in the same file as given
+	  by <literal>-l</literal>.
+	 </entry>
+	</row>
+	<row>
+	 <entry><literal>server-apdu</literal></entry>
+	 <entry>
+	  Log APDUs as reported by YAZ for the
+	  communication between the proxy and the server (backend).
+	 </entry>
+	</row>
+	<row>
+	 <entry><literal>clients-requests</literal></entry>
+	 <entry>
+	  Log a brief description about requests transferred between
+	  the client and the proxy. The name of the request and the size
+	  of the APDU is logged.
+	 </entry>
+	</row>
+	<row>
+	 <entry><literal>server-requests</literal></entry>
+	 <entry>
+	  Log a brief description about requests transferred between
+	  the proxy and the server (backend). The name of the request
+	  and the size of the APDU is logged.
+	 </entry>
+	</row>
+       </tbody>
+      </tgroup>
+     </table>
+    </para>
+    <para>
+     To log communication in details between the proxy and the backend, th
+     following configuration could be used:
+    <screen><![CDATA[
+     <target name="mytarget">
+      <log>server-apdu server-requests</log>
+     </target>
+]]>
+     </screen>
+    </para>
+   </section>
+
   </section>
   <section id="proxy-usage">
    <title>Proxy Usage</title>
@@ -605,4 +679,4 @@
  sgml-namecase-general:t
  End:
  -->
- 
\ No newline at end of file
+