X-Git-Url: http://git.indexdata.com/?p=yazproxy-moved-to-github.git;a=blobdiff_plain;f=doc%2Fyaz-proxy-ref.xml;h=c44603da99386589c7df1f8de243426261afef6d;hp=252ed1ddc822f8cdfdc5f592102eaa4c651e7e39;hb=057fb5b5dc6bc2f57cb064117e5a1add3c3da3b3;hpb=2f1a9a4b28ae43c9da9e0740f84048065b2d3bf6

diff --git a/doc/yaz-proxy-ref.xml b/doc/yaz-proxy-ref.xml
index 252ed1d..c44603d 100644
--- a/doc/yaz-proxy-ref.xml
+++ b/doc/yaz-proxy-ref.xml
@@ -1,14 +1,14 @@
 <refmeta>
- <refentrytitle>yaz-proxy</refentrytitle>
+ <refentrytitle>yazproxy</refentrytitle>
  <manvolnum>8</manvolnum>
 </refmeta>
 <refnamediv>
- <refname>yaz-proxy</refname>
- <refpurpose>The YAZ toolkit's transparent Z39.50 proxy</refpurpose>
+ <refname>yazproxy</refname>
+ <refpurpose>The YAZ toolkit's transparent Z39.50/SRW/SRU proxy</refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <cmdsynopsis>
-  <command>yaz-proxy</command>
+  <command>yazproxy</command>
   <arg choice="opt">-a <replaceable>filename</replaceable></arg>
   <arg choice="opt">-l <replaceable>filename</replaceable></arg>
   <arg choice="opt">-m <replaceable>num</replaceable></arg>
@@ -27,7 +27,8 @@
    
 <refsect1><title>DESCRIPTION</title>
  <para>
-  <command>yaz-proxy</command> is a Z39.50 optimizing proxy daemon.
+  <command>yazproxy</command> is a proxy that accepts connections
+  from Z39.50/SRW/SRU clients and contacts a Z39.50 backend.
   The listening port must be specified on the command-line. 
   <command>inetd</command> operation is not supported.
   The <replaceable>host</replaceable>:<replaceable>port</replaceable>
@@ -36,16 +37,17 @@
   to listen for connections coming from any address.
  </para>
  <para>
-  <command>yaz-proxy</command> can be configured using command-line
+  <command>yazproxy</command> can be configured using command-line
   options or a configuration file.
   Configuration file options override values specified
   on the command-line.
  </para>
  <para>
-  <command>yaz-proxy</command> rereads its configuration file and
+  <command>yazproxy</command> rereads its configuration file and
   reopens log files when it receives the hangup signal, SIGHUP.
  </para>
 </refsect1>
+
 <refsect1><title>OPTIONS</title>
  <variablelist>
   <varlistentry><term>-a <replaceable>filename</replaceable></term>
@@ -117,14 +119,14 @@
   </varlistentry>
   <varlistentry><term>-p <replaceable>pidfile</replaceable></term>
    <listitem><para>
-     When specified, yaz-proxy will create <replaceable>pidfile</replaceable>
+     When specified, yazproxy will create <replaceable>pidfile</replaceable>
      with the process ID of the proxy. The pidfile will be generated
      before the process changes identity (see option <literal>-u</literal>).
     </para></listitem>
   </varlistentry>
   <varlistentry><term>-u <replaceable>userid</replaceable></term>
    <listitem><para>
-     When specified, yaz-proxy will change identity to the user ID
+     When specified, yazproxy will change identity to the user ID
      specified, just after the proxy has started listening to a
      possibly privileged port and after the PID file has been created
      if specified by option <literal>-u</literal>.
@@ -143,62 +145,46 @@
  <title>EXAMPLES</title>
  <para>
   The following command starts the proxy, listening on port
-  9000, with its default backend target set to the Library of
-  Congress bibliographic server:
-    </para>
+  9000, with its default backend target set to Index Data's
+  test server:
+ </para>
  <screen>
-  $ yaz-proxy -t z3950.loc.gov:7090 @:9000
+  $ yazproxy -t indexdata.dk:210 @:9000
  </screen>
  <para>
-  The LOC target is sometimes very slow.  You can connect to
-  it using yaz-client as follows:
+  You can connect to the proxy via yaz-client as follows:
  </para>
  <screen>
-  $ yaz-client localhost:9000/voyager
-  Connecting...Ok.
+  $ ./yaz-client  localhost:9000/gils
+  Connecting...OK.
   Sent initrequest.
-  Connection accepted by target.
-  ID     : 34
-  Name   : Voyager LMS - Z39.50 Server
-  Version: 1.13
-  Options: search present
-  Elapsed: 7.131197
-  Z> f computer
-  Sent searchRequest.
-  Received SearchResponse.
-  Search was a success.
-  Number of hits: 10000
-  records returned: 0
-  Elapsed: 6.695174
+  Connection accepted by v3 target.
+  ID     : 81
+  Name   : Zebra Information Server/GFS/YAZ (YAZ Proxy)
+  Version: Zebra 1.3.15/1.23/2.0.19
+  Options: search present delSet scan sort extendedServices namedResultSets
+  Elapsed: 0.152108
   Z> f computer
   Sent searchRequest.
   Received SearchResponse.
   Search was a success.
-  Number of hits: 10000
+  Number of hits: 3, setno 1
+  SearchResult-1: computer(3)
   records returned: 0
-  Elapsed: 0.001417
+  Elapsed: 0.172533
  </screen>
  <para>
-  In this test, the second search was more than 4000 times faster
-  than the first, because the proxy cached the result of the first
-  search and noticed that the second was the same.
- </para>
- <para>
   The YAZ command-line client,
   <command>yaz-client</command>,
   allows you to set the proxy address by specifying option -p. In
   that case, the actual backend target is specified as part of the
   Initialize Request.
  </para>
- <para>Suppose you have a proxy running on localhost,
-  port 9000 and wish to connect to Index Data's test target at
-  <literal>indexdata.dk:210/gils</literal> you could use:
-  <screen>
-   yaz-client -p localhost:9000 indexdata.dk:210/gils
-  </screen>
-  Since port 210 is the default, the port can be omitted:
+ <para>Suppose the proxy running on localhost, port 9000.
+  To connect to British Library's server at
+  <literal>blpcz.bl.uk:21021</literal> use:
   <screen>
-   yaz-client -p localhost:9000 indexdata.dk/gils
+   yaz-client -p localhost:9000 blpcz.bl.uk:21021/BLPC-ALL
   </screen>
  </para>
 </refsect1>
@@ -211,7 +197,7 @@
  sgml-always-quote-attributes:t
  sgml-indent-step:1
  sgml-indent-data:t
- sgml-parent-document: "proxy.xml"
+ sgml-parent-document: "reference.xml"
  sgml-local-catalogs: nil
  sgml-namecase-general:t
  End: