Update man page. Mention SIGHUP.
authorAdam Dickmeiss <adam@indexdata.dk>
Thu, 16 Oct 2003 12:07:16 +0000 (12:07 +0000)
committerAdam Dickmeiss <adam@indexdata.dk>
Thu, 16 Oct 2003 12:07:16 +0000 (12:07 +0000)
doc/yaz-proxy-ref.xml

index ba4aaa5..776f28a 100644 (file)
    
 <refsect1><title>DESCRIPTION</title>
  <para>
-  The proxy runs stand-alone (not from
-  <literal>inetd</literal>). The
-  <replaceable>host</replaceable>:<replaceable>port</replaceable>
+  <command>yaz-proxy</command> is a Z39.50 optimizing proxy daemon.
+  The listening port must be specified on the command-line. 
+  <command>inetd</command> operation is not supported.
+  The <replaceable>host</replaceable>:<replaceable>port</replaceable>
   argument specifies host address to listen to, and the port to
   listen on.  Use the host <literal>@</literal>
   to listen for connections coming from any address.
  </para>
+ <para>
+  <command>yaz-proxy</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
+  reopens log files when it receivies the hangup signal, SIGHUP.
+ </para>
 </refsect1>
 <refsect1><title>OPTIONS</title>
  <variablelist>
  </para>
  <para>
   The YAZ command-line client,
-  <literal>yaz-client</literal>,
-  allows you to set the proxy target as part of the Initialize
-  Request using option <literal>-p</literal>. 
-  For example, to connect to Index Data's target you could use:
+  <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:
+  <screen>
+   yaz-client -p localhost:9000 indexdata.dk/gils
+  </screen>
  </para>
- <screen>
-  yaz-client -p indexdata.dk localhost:9000/gils
- </screen>
 </refsect1>
  <!-- Keep this comment at the end of the file
  Local variables: