X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fproxy.xml;h=3f0c27ce1c1c9ed569fb2d71fb98109da6bf76d5;hb=1b6019ff065a98af709be905adc6c08094471d57;hp=556245410a2c4366e16f7100a49b887549bba276;hpb=15c4ab2ad6c4c449514c3d1d433315a71231e735;p=yazpp-moved-to-github.git diff --git a/doc/proxy.xml b/doc/proxy.xml index 5562454..3f0c27c 100644 --- a/doc/proxy.xml +++ b/doc/proxy.xml @@ -1,13 +1,19 @@ The YAZ Proxy - The YAZ proxy is a transparent Z39.50-to-Z39.50 gateway. That is, - it is a Z39.50 server which has as its back-end a Z39.50 client - that forwards requests on to another server (known as the - backend target.) + The YAZ proxy is a transparent SRW/SRU/Z39.50-to-Z39.50 gateway. + That is, it is a SRW/SRU/Z39.50 server which has as its back-end a + Z39.50 client that forwards requests on to another server (known as + the backend target.) - The YAZ Proxy is useful for debugging Z39.50 software, logging + -- All config directives -- + -- SRW/SRU .. + -- Example config + -- Mention XSLT conversion + + + The YAZ Proxy is useful for debugging SRW/SRU/Z39.50 software, logging APDUs, redirecting Z39.50 packages through firewalls, etc. Furthermore, it offers facilities that often boost performance for connectionless Z39.50 clients such @@ -126,11 +132,11 @@
Specifying the Backend Target - When the proxy accepts a Z39.50 client session, it - determines the backend target by the following rules: + When the proxy receives a Z39.50 Initialize Request from a Z39.50 + client, it determines the backend target by the following rules: - If the InitializeRequest PDU from the + If the InitializeRequest PDU from the client includes an otherInfo element with OID @@ -139,19 +145,19 @@ usual YAZ address format (typically tcp:hostname:port) as described in - the Addresses section of the YAZ manual. - Otherwise, the Proxy uses the default target, if one was + Otherwise, the Proxy uses the default target, if one was specified on the command-line with the -t option. A default target can also be specified in the XML Config file. - Otherwise, the proxy closes the connection with + Otherwise, the proxy closes the connection with the client. @@ -247,9 +253,10 @@ client. Finally, the proxy may convert records. - In the current version the only supported conversion is - MARC21/USMARC in MARC-8 charset to MARCXML in UTF-8. Future version of - the proxy may do other record/charset conversions. + The proxy can convert from MARC to MARCXML and thereby offer an + XML version of any MARC record as long as it is ISO2709 encoded. + If the proxy is compiled with libXSLT support it can also + perform XSLT on XML.
@@ -264,11 +271,11 @@
Proxy Configuration File - The Proxy as an option may read a configuration file using option + The Proxy may read a configuration file using option -c followed by the filename of a config file. - The config file is in XML format. The YAZ proxy must be compiled + The config file is XML based. The YAZ proxy must be compiled with libxml2 and libXSLT support in order for the config file facility to be enabled.