<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/SRU proxy</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
- <command>yaz-proxy</command>
+ <command>yazproxy</command>
<arg choice="opt">-a <replaceable>filename</replaceable></arg>
+ <arg choice="opt">-c <replaceable>config</replaceable></arg>
+ <arg choice="opt">-D</arg>
+ <arg choice="opt">-i <replaceable>seconds</replaceable></arg>
<arg choice="opt">-l <replaceable>filename</replaceable></arg>
<arg choice="opt">-m <replaceable>num</replaceable></arg>
- <arg choice="opt">-v <replaceable>level</replaceable></arg>
- <arg choice="opt">-t <replaceable>target</replaceable></arg>
- <arg choice="opt">-U <replaceable>auth</replaceable></arg>
+ <arg choice="opt">-n <replaceable>num</replaceable></arg>
<arg choice="opt">-o <replaceable>level</replaceable></arg>
- <arg choice="opt">-i <replaceable>seconds</replaceable></arg>
- <arg choice="opt">-T <replaceable>seconds</replaceable></arg>
+ <arg choice="opt">-t <replaceable>target</replaceable></arg>
<arg choice="opt">-p <replaceable>pidfile</replaceable></arg>
+ <arg choice="opt">-T <replaceable>seconds</replaceable></arg>
<arg choice="opt">-u <replaceable>userid</replaceable></arg>
- <arg choice="opt">-c <replaceable>config</replaceable></arg>
+ <arg choice="opt">-v <replaceable>level</replaceable></arg>
+ <arg choice="opt">-X</arg>
<arg choice="req"><replaceable>host</replaceable>:<replaceable>port</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<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/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>
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>
standard output.
</para></listitem>
</varlistentry>
- <varlistentry><term>-l <replaceable>filename</replaceable></term>
+ <varlistentry><term>-c <replaceable>config</replaceable></term>
<listitem><para>
- Specifies the name of a file to which to write a log of the
- YAZ proxy activity. This uses the logging facility as provided
- by the YAZ toolkit. If this options is omitted, the output
- directed to stderr.
+ Specifies config filename. Configuration is in XML
+ and is only supported if the YAZ proxy is compiled with
+ libxml2.
</para></listitem>
</varlistentry>
- <varlistentry><term>-m <replaceable>num</replaceable></term>
+ <varlistentry><term>-X</term>
<listitem><para>
- Specifies the maximum number of connections to be cached
- [default 50].
+ Puts YAZ proxy in the background after startup. This is
+ similar to using shell's & operator but often better since
+ it allows the start / stop script to capture startup errors.
</para></listitem>
</varlistentry>
- <varlistentry><term>-v <replaceable>level</replaceable></term>
+ <varlistentry><term>-i <replaceable>seconds</replaceable></term>
<listitem><para>
- Sets the logging level. <replaceable>level</replaceable> is
- a comma-separated list of members of the set
- {<literal>fatal</literal>,<literal>debug</literal>,<literal>warn</literal>,<literal>log</literal>,<literal>malloc</literal>,<literal>all</literal>,<literal>none</literal>}.
+ Specifies in seconds the idle time for communication between
+ client and proxy. If a connection is inactive for this long
+ it will be closed. Default: 600 seconds (10 minutes).
</para></listitem>
</varlistentry>
- <varlistentry><term>-t <replaceable>target</replaceable></term>
+ <varlistentry><term>-l <replaceable>filename</replaceable></term>
<listitem><para>
- Specifies the default backend target to use when a client
- connects that does not explicitly specify a target in its
- <literal>initRequest</literal>.
+ Specifies the name of a file to which to write a log of the
+ YAZ proxy activity. This uses the logging facility as provided
+ by the YAZ toolkit. If this options is omitted, the output
+ directed to stderr.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry><term>-m <replaceable>num</replaceable></term>
+ <listitem><para>
+ Specifies the maximum number of client connections to be
+ offered [default 150].
</para></listitem>
</varlistentry>
- <varlistentry><term>-U <replaceable>auth</replaceable></term>
+ <varlistentry><term>-n <replaceable>num</replaceable></term>
<listitem><para>
- Specifies authentication info to be sent to the backend target.
- This is useful if you happen to have an internal target that
- requires authentication, or if the client software does not allow
- you to set it.
+ Sets maximum number of open files to <replaceable>num</replaceable>.
+ This is only available on systems that offers the
+ <function>setrlimit(2)</function> call.
</para></listitem>
</varlistentry>
<varlistentry><term>-o <replaceable>level</replaceable></term>
features. By default optimization is enabled (value 1).
</para></listitem>
</varlistentry>
- <varlistentry><term>-i <replaceable>seconds</replaceable></term>
+ <varlistentry><term>-p <replaceable>pidfile</replaceable></term>
<listitem><para>
- Specifies in seconds the idle time for communication between
- client and proxy. If a connection is inactive for this long
- it will be closed. Default: 600 seconds (10 minutes).
+ 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>-t <replaceable>target</replaceable></term>
+ <listitem><para>
+ Specifies the default backend target to use when a client
+ connects that does not explicitly specify a target in its
+ <literal>initRequest</literal>.
</para></listitem>
</varlistentry>
<varlistentry><term>-T <replaceable>seconds</replaceable></term>
it will be closed. Default: 600 seconds (10 minutes).
</para></listitem>
</varlistentry>
- <varlistentry><term>-p <replaceable>pidfile</replaceable></term>
- <listitem><para>
- When specified, yaz-proxy 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>.
</para></listitem>
</varlistentry>
- <varlistentry><term>-c <replaceable>config</replaceable></term>
+ <varlistentry><term>-v <replaceable>level</replaceable></term>
<listitem><para>
- Specifies config filename. Configuration is in XML
- and is only supported if the YAZ proxy is compiled with
- libxml2.
+ Sets the logging level. <replaceable>level</replaceable> is
+ a comma-separated list of members of the set
+ {<literal>fatal</literal>,<literal>debug</literal>,<literal>warn</literal>,<literal>log</literal>,<literal>malloc</literal>,<literal>all</literal>,<literal>none</literal>}.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry><term>-X</term>
+ <listitem><para>
+ Enables debugging mode for the proxy. When specified, the proxy will
+ not fork itself, thus any violations becomes fatal. Useful if
+ you run yazproxy inside <application>gdb</application>.
+ Don't run this in production.
</para></listitem>
</varlistentry>
</variablelist>
<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>
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:
projects / yazproxy-moved-to-github.git / blobdiff