X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Fgfs-virtual.xml;h=c0e386871755a0c9df510db0afa04db5ddd54eb4;hp=d04e9e21c3ce6f55c8fa9d975b85db40e4b917e9;hb=a7261ce1171ca8e90561b2055e6198e15208bcd6;hpb=68c26dc239554eb10af556b3c9d133228e862694
diff --git a/doc/gfs-virtual.xml b/doc/gfs-virtual.xml
index d04e9e2..c0e3868 100644
--- a/doc/gfs-virtual.xml
+++ b/doc/gfs-virtual.xml
@@ -1,5 +1,4 @@
-
@@ -23,14 +22,14 @@
- Not all Z39.50 clients allows the VHOST information to be set.
- For those the selection of the backend must rely on the
+ Not all Z39.50 clients allow 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
- configurations. Command-line option -f
+ configurations. Command-line option -f
specifies filename of the XML configuration.
@@ -40,14 +39,14 @@
The listen describes listener (transport end point),
- such as TCP/IP, Unix file socket or SSL server. Content for
+ such as TCP/IP, Unix file socket or SSL server. Content for
a listener:
CDATA (required)
The CDATA for the listen element holds the
- listener string, such as tcp:@:210,
+ listener string, such as tcp:@:210,
tcp:server1:2100,
etc.
@@ -56,7 +55,7 @@
attribute id (optional)
- identifier for this listener. This may be referred to from
+ Identifier for this listener. This may be referred to from
server sections.
@@ -85,10 +84,11 @@
attribute listenref (optional)
- 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
- must match (if specified in the configuration).
+ Specifies one or more listeners for this server. Each server ID is
+ separated by a comma.
+ If this attribute is not given, the server is accessible from all
+ listeners. In order for the server to be used for real, however, the
+ virtual host must match if specified in the configuration.
@@ -107,7 +107,7 @@
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).
@@ -129,8 +129,8 @@
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.
+ backend server. See &reference-tools-cql-map;.
+ If given, the backend server will only "see" a Type-1/RPN query.
@@ -139,8 +139,8 @@
Specifies a filename that includes CCL to RPN conversion for this
- backend server. See &reference-tools-ccl-qualifiers;
- If given, the backend server will only "see" a Type-1/RPN query.
+ backend server. See &reference-tools-ccl-qualifiers;.
+ If given, the backend server will only "see" a Type-1/RPN query.
@@ -149,32 +149,42 @@
Specifies the stylesheet reference to be part of SRU HTTP responses
- when the client does not specify one. If neither this is given, nor
- the client specifies one, no stylesheet reference is part of the
+ when the client does not specify one. If none is given, then if
+ the client does not specify one, then no stylesheet reference is part of the
SRU HTTP response.
-
+
+ element client_query_charset (optional)
+
+
+ If specified, a conversion from the character set given to UTF-8 is
+ performed by the generic frontend server. It is only executed for
+ Z39.50 search requests (SRU/Solr are assumed to be UTF-8 encoded already).
+
+
+
+
element docpath (optional)
Specifies a path for local file access using HTTP. All URLs with
- a leading prefix (/ exluded) that matches the value of docpath
+ a leading prefix (/ excluded) that matches the value of docpath
are used for file access. For example, if the server is to offer
access in directory xsl, the docpath would be
xsl and all URLs of the form
- http://host/exl will result in a local file access.
+ http://host/xsl will result in a local file access.
-
+
element explain (optional)
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
+ seem redundant because host information, etc. is also stored
elsewhere.
@@ -184,7 +194,7 @@
Specifies maximum record size/message size, in bytes. This
- value also servers as maximum size of incoming
+ value also serves as the maximum size of incoming
packages (for Record Updates etc). It's the same value as that
given by the -k option.
@@ -194,17 +204,17 @@
element retrievalinfo (optional)
- Enables the retrieval facility supporting conversions and
+ Enables the retrieval facility to support conversions and
specifications of record formats/types.
See for
more information.
-
+
-
+
The XML below configures a server that accepts connections from
two ports, TCP/IP port 9900 and a local UNIX file socket.
@@ -221,7 +231,7 @@
/var/www/s1
config.cfg
-
+
server2.mydomain
/var/www/s2
config.cfg
@@ -244,10 +254,12 @@
There are three configured backend servers. The first two
servers, "server1" and "server2",
- can be reached by both listener addresses - since
- no listenref attribute is specified.
- In order to distinguish between the two a virtual host has
- been specified for each of server in the host
+ can be reached by both listener addresses.
+ "server1" is reached by all (two) since no
+ listenref attribute is specified.
+ "server2" is reached by the two listeners specified.
+ In order to distinguish between the two, a virtual host has
+ been specified for each server in the host
elements.
@@ -262,15 +274,7 @@