<!--
- $Id: zebrasrv-virtual.xml,v 1.1 2005-08-05 14:39:12 marc Exp $
- Description of the virtual host mechanism in YAZ GFS
+ Description of the virtual host mechanism in &yaz; GFS
Included in both manual and man page for yaz-ztest
-->
<para>
- The Virtual hosts mechanism allows a YAZ frontend server to
+ The Virtual hosts mechanism allows a &yaz; frontend server to
support multiple backends. A backend is selected on the basis of
- the TCP/IP binding (port+listening adddress) and/or the virtual host.
+ the TCP/IP binding (port+listening address) and/or the virtual host.
</para>
<para>
A backend can be configured to execute in a particular working
- directory. Or the YAZ frontend may perform CQL to RPN conversion, thus
- allowing traditional Z39.50 backends to be offered as a SRW/SRU
- service. SRW/SRU Explain information for a particular backend may also
- be specified.
+ directory. Or the &yaz; frontend may perform <ulink url="&url.cql;">&acro.cql;</ulink> to &acro.rpn; conversion, thus
+ allowing traditional &acro.z3950; backends to be offered as a
+<ulink url="&url.sru;">&acro.sru;</ulink> service.
+ &acro.sru; Explain information for a particular backend may also be specified.
</para>
<para>
For the HTTP protocol, the virtual host is specified in the Host header.
- For the Z39.50 protocol, the virtual host is specified as in the
+ For the &acro.z3950; protocol, the virtual host is specified as in the
Initialize Request in the OtherInfo, OID 1.2.840.10003.10.1000.81.1.
</para>
<note>
<para>
- Not all Z39.50 clients allows the VHOST information to be set.
+ Not all &acro.z3950; clients allows the VHOST information to be set.
For those the selection of the backend must rely on the
TCP/IP information alone (port and address).
</para>
</note>
<para>
- The YAZ frontend server uses XML to describe the backend
+ The &yaz; frontend server uses &acro.xml; to describe the backend
configurations. Command-line option <literal>-f</literal>
- specifies filename of the XML configuration.
+ specifies filename of the &acro.xml; configuration.
</para>
<para>
The configuration uses the root element <literal>yazgfs</literal>.
<para>
Specifies listener for this server. If this attribute is not
given, the server is accessible from all listener. In order
- for the server to be used for real, howeever, the virtual host
+ for the server to be used for real, however, the virtual host
must match (if specified in the configuration).
</para>
</listitem>
<listitem>
<para>
Specifies a working directory for this backend server. If
- specifid, the YAZ fronend changes current working directory
+ specified, the &yaz; frontend changes current working directory
to this directory whenever a backend of this type is
started (backend handler bend_start), stopped (backend handler hand_stop)
and initialized (bend_init).
<varlistentry><term>element <literal>cql2rpn</literal> (optional)</term>
<listitem>
<para>
- Specifies a filename that includes CQL to RPN conversion for this
- backend server. See &reference-tools-cql-map;
- If given, the backend server will only "see" a Type-1/RPN query.
+ Specifies a filename that includes <ulink url="&url.cql;">&acro.cql;</ulink> to &acro.rpn; conversion for this
+ backend server. See <ulink url="&url.cql;">&acro.cql;</ulink> section in &yaz; manual.
+ If given, the backend server will only "see" a Type-1/&acro.rpn; query.
</para>
</listitem>
</varlistentry>
<varlistentry><term>element <literal>explain</literal> (optional)</term>
<listitem>
<para>
- Specifies SRW/SRU ZeeRex content for this server. Copied verbatim
- to the client. As things are now, some of the Explain content
- seeem redundant because host information, etc. is also stored
- elsewhere.
+ Specifies <ulink url="&url.sru;">&acro.sru;</ulink> ZeeRex content for this
+ server - copied verbatim to the client.
+ As things are now, some of the Explain content seems redundant
+ because host information, etc. is also stored elsewhere.
+ </para>
+ <para>
+ The format of the Explain record is described in detail, with
+ examples, on the file at the
+ <ulink url="&url.zeerex.explain;">ZeeRex</ulink> web-site.
</para>
</listitem>
</varlistentry>
</para>
<para>
- The XML below configures a server that accepts connections from
+ The &acro.xml; below configures a server that accepts connections from
two ports, TCP/IP port 9900 and a local UNIX file socket.
We name the TCP/IP server <literal>public</literal> and the
other server <literal>internal</literal>.
elements.
</para>
<para>
- For <literal>"server2"</literal> elements for CQL to RPN conversion
+ For <literal>"server2"</literal> elements for
+<ulink url="&url.cql;">&acro.cql;</ulink> to &acro.rpn; conversion
is supported and explain information has been added (a short one here
to keep the example small).
</para>
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
-sgml-parent-document: "yaz.xml"
+sgml-parent-document: "zebrasrv.xml"
sgml-local-catalogs: nil
sgml-namecase-general:t
End: