Minor updates

[yazpp-moved-to-github.git] / doc / proxy.xml

diff --git a/doc/proxy.xml b/doc/proxy.xml
index 67ee312..efb9a1b 100644 (file)
--- a/doc/proxy.xml
+++ b/doc/proxy.xml
@@ -1,5 +1,5 @@
 <chapter id="proxy">
-  <!-- $Id: proxy.xml,v 1.3 2002-10-22 08:23:57 adam Exp $ -->
+  <!-- $Id: proxy.xml,v 1.5 2002-10-22 21:21:54 adam Exp $ -->
  <title>YAZ Proxy</title>
   <para>
    The YAZ proxy is a transparent Z39.50 to Z39.50 gateway.
@@ -7,25 +7,25 @@
    Z39.50 packages through fire walls, etc.
   </para>
   <para>
-   Furthermore, the proxy offers facilities that often
-   boost performance for "connection-less" Z39.50 clients such
-   as web gateways.
+   Furthermore, the proxy offers facilities that often boost
+   performance for stateless Z39.50 clients such as web gateways.
   </para>
   <para>
    Unlike most other "server" software the proxy runs single-threaded,
    single-process. Every I/O operation
    is non-blocking so it is light-weight and very fast.
-   It does not store "state" information on the hard drive
+   It does not store state information on the hard drive
    except the log files you want.
   </para>
-  <section><title>Specifying the backend target</title>
+  <section id="proxy-target">
+   <title>Specifying the backend target</title>
    <para>
     When a Z39.50 client session is accepted by the proxy, the proxy
     determines the backend target by the following rules:
     <orderedlist>
      <listitem>
       <para> If the Initialize Request PDU from the client
-       includes Other-Information, with OID,
+       includes Other-Information, with OID 
        <literal>1.2.840.10003.10.1000.81.1</literal>, that
        specifies the target.
       </para>
@@ -43,7 +43,8 @@
     </orderedlist>
    </para>
   </section>
-  <section><title>Keep-alive facility for Stateless clients</title>
+  <section id="proxy-keepalive">
+   <title>Keep-alive facility for Stateless clients</title>
    <para>
     Stateless clients may generate a cookie for a Z39.50
     session which is sent to the proxy as part of PDUs. 
@@ -64,7 +65,8 @@
    </para>
   </section>
 
-  <section><title>Query Caching</title>
+  <section id="proxy-cache">
+   <title>Query Caching</title>
    <para>
     Simple stateless clients often sends identical Z39.50 searches
     in a relatively short period of time (full-list, next-page,
@@ -84,13 +86,16 @@
 
   </section>
 
-  <section><title>Other optimizations</title>
+  <section id="proxy-optimizations">
+   <title>Other optimizations</title>
    <para>
     We've had some plans to support caching of result set records,
     but this had not yet been implemented.
    </para>
   </section>
-  <section><title>Proxy usage</title>
+
+  <section id="proxy-usage">
+   <title>Proxy usage</title>
    <para>
    </para>
    <refentry id="yaz-proxy">
@@ -167,11 +172,11 @@
      <title>EXAMPLES</title>
      <para>
       The following starts the proxy so that it listens on port
-      9000. The default backend target is LOC.
+      9000. The default backend target is the LOC target.
       <screen>
        $ yaz-proxy -t z3950.loc.gov:7090 @:9000
       </screen>
-      The LOC target is sometimes very slow. You can connect to
+      This target is sometimes very slow. You can connect to
       it using yaz-client as follows:
       <screen>
 $ yaz-client localhost:9000/voyager
@@ -204,7 +209,8 @@ Elapsed: 0.001417
      <para>
       The YAZ client allows you to set the backend target in
       the Initialize Request using option -p. To connect to
-      Index Data's target you could use:
+      Index Data's target through a proxy on localhost, port 9000,
+      you could use:
       <screen>
        yaz-client -p indexdata.dk localhost:9000/gils
       </screen>