X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fgfs-virtual.xml;h=1250331ac662d5639464959ee56da1d3e97058e4;hb=f4864107db9ab5780218ca0d28c480f5e6ebd684;hp=8766992bf0108da89abb42890b796797f9a62fdd;hpb=e232998663cbfa8e9c489d99245e530c03223571;p=yaz-moved-to-github.git
diff --git a/doc/gfs-virtual.xml b/doc/gfs-virtual.xml
index 8766992..1250331 100644
--- a/doc/gfs-virtual.xml
+++ b/doc/gfs-virtual.xml
@@ -1,5 +1,4 @@
-
@@ -30,7 +29,7 @@
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.
@@ -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.
@@ -130,11 +130,45 @@
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.
+ If given, the backend server will only "see" a Type-1/RPN query.
-
+
+ element ccl2rpn (optional)
+
+
+ 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.
+
+
+
+
+ element stylesheet (optional)
+
+
+ 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
+ SRU HTTP response.
+
+
+
+
+ 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
+ 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.
+
+
+
+
element explain (optional)
@@ -145,9 +179,32 @@
+
+ element maximumrecordsize (optional)
+
+
+ Specifies maximum record size/message size, in bytes. This
+ value also servers as maximum size of incoming
+ packages (for Record Updates etc). It's the same value as that
+ given by the -k option.
+
+
+
+
+ element retrievalinfo (optional)
+
+
+ Enables the retrieval facility supporting 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.
@@ -156,7 +213,7 @@
tcp:@:9900
unix:/var/tmp/socket
@@ -164,7 +221,7 @@
/var/www/s1
config.cfg
-
+
server2.mydomain
/var/www/s2
config.cfg
@@ -187,9 +244,11 @@
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
+ 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 of server in the host
elements.