X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fzebrasrv-virtual.xml;h=eb240e52acbefc9a1f89034f870a26e37b3e1842;hb=b19b79e382ef8196f1625763db1af3a82b1e0c81;hp=cc428f1d93a61731f6244f99f5f2316326954101;hpb=5ca4e60e990af6ad6b62ebff855d7b642f37c3ec;p=idzebra-moved-to-github.git diff --git a/doc/zebrasrv-virtual.xml b/doc/zebrasrv-virtual.xml index cc428f1..eb240e5 100644 --- a/doc/zebrasrv-virtual.xml +++ b/doc/zebrasrv-virtual.xml @@ -1,37 +1,37 @@ - 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. 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 -SRU service. - SRU Explain information for a particular backend may also be specified. + directory. Or the &yaz; frontend may perform &cql; to &rpn; conversion, thus + allowing traditional &z3950; backends to be offered as a +&sru; service. + &sru; Explain information for a particular backend may also be specified. 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 &z3950; protocol, the virtual host is specified as in the Initialize Request in the OtherInfo, OID 1.2.840.10003.10.1000.81.1. - Not all Z39.50 clients allows the VHOST information to be set. + Not all &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). - The YAZ frontend server uses XML to describe the backend + The &yaz; frontend server uses &xml; to describe the backend configurations. Command-line option -f - specifies filename of the XML configuration. + specifies filename of the &xml; configuration. The configuration uses the root element yazgfs. @@ -107,7 +107,7 @@ Specifies a working directory for this backend server. If - specifid, the YAZ fronend changes current working directory + specifid, the &yaz; fronend 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). @@ -128,9 +128,9 @@ element cql2rpn (optional) - Specifies a filename that includes CQL to RPN conversion for this - backend server. See CQL section in YAZ manual. - If given, the backend server will only "see" a Type-1/RPN query. + Specifies a filename that includes &cql; to &rpn; conversion for this + backend server. See &cql; section in &yaz; manual. + If given, the backend server will only "see" a Type-1/&rpn; query. @@ -138,7 +138,7 @@ element explain (optional) - Specifies SRU ZeeRex content for this + Specifies &sru; 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. @@ -154,7 +154,7 @@ - The XML below configures a server that accepts connections from + The &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 public and the other server internal. @@ -200,7 +200,7 @@ For "server2" elements for -CQL to RPN conversion +&cql; to &rpn; conversion is supported and explain information has been added (a short one here to keep the example small).