X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;ds=sidebyside;f=doc%2Freference.xml;h=4c36259de7676c42c41ac0f5c8054f3281848ab4;hb=524e2bbd3a4ec9c651d92fb720ff337a60304d9c;hp=28cd49f25774f1fdd52fa969c3bc65336cee3566;hpb=84434e0d19b1ecd73ff09853f7cb3d96f343c237;p=yazproxy-moved-to-github.git
diff --git a/doc/reference.xml b/doc/reference.xml
index 28cd49f..4c36259 100644
--- a/doc/reference.xml
+++ b/doc/reference.xml
@@ -32,7 +32,7 @@
usual YAZ address format (typically
tcp:hostname:port)
as described in
- the Addresses section of the YAZ manual.
@@ -199,8 +199,8 @@
The config file is XML based. The YAZ proxy must be compiled
- with libxml2 and
- libXSLT support in
+ with libxml2 and
+ libXSLT support in
order for the config file facility to be enabled.
@@ -221,13 +221,13 @@
The proxy config file must have a root element called
proxy and scoped within namespace
- xmlns="http://indexdata.dk/yazproxy/schema/0.8/.
+ xmlns="http://indexdata.dk/yazproxy/schema/0.9/.
All information except an optional XML header must be stored
within the proxy element.
<?xml version="1.0"?>
- <proxy xmlns="http://indexdata.dk/yazproxy/schema/0.8/">
+ <proxy xmlns="http://indexdata.dk/yazproxy/schema/0.9/">
<!-- content here .. -->
</proxy>
@@ -352,18 +352,20 @@
The following sets maximum number of bytes transferred per minute to
- 500Kbytes and maximum number of requests to 40.
+ 500Kbytes, maximum number of records retrievals to 40
+ and maximum number of searches to 20.
<limit>
<bandwidth>524288</bandwidth>
<retrieve>40</retrieve>
+ <search>20</search>
</limit>
- Typically the limits for keepalive are much higher than
- those for session minute average.
+ Typically the values in the keepalive section are mugh higher
+ than their equivalent limit counterparts (bandwidth, pdu).
@@ -439,6 +441,9 @@
type should be XML. The proxy will use
preferred record syntax USMARC/MARC21 or backendtype
(if given) against the backend target.
+ For the special case where backendtype is
+ opac the proxy will convert the OPAC
+ record to OPACXML.
If attribute backendtype is given, that holds the
@@ -448,8 +453,8 @@
If attribute stylesheet is given, the proxy
will convert XML record from server via XSLT. It is important
that the content from server is XML. If used in conjunction with
- attribute marcxml the MARC to MARCXML conversion
- takes place before the XSLT conversion takes place.
+ attribute marcxml, the MARC to MARCXML/OPACXML
+ conversion takes place before the XSLT conversion takes place.
If attribute identifier is given that is the
@@ -532,8 +537,8 @@
See YAZ documentation for more information about the
- CQL
- to PQF conversion. See also the
+ CQL to PQF conversion.
+ See also the
pqf.properties in the etc
(or prefix/share/yazproxy)
directory of the YAZ proxy distribution.
@@ -554,32 +559,6 @@
-
- max-clients
-
- The element max-clients is the child of element
- proxy and specifies the total number of
- allowed connections to targets (all targets). If this limit
- is reached the proxy will close the least recently used connection.
-
-
- Note, that many Unix systems impose a system on the number of
- open files allowed in a single process, typically in the
- range 256 (Solaris) to 1024 (Linux).
- The proxy uses 2 sockets per session + a few files
- for logging. As a rule of thumb, ensure that 2*max-clients + 5
- can be opened by the proxy process.
-
-
-
- Using the
- bash shell, you can set the limit with
- ulimit -nno.
- Use ulimit -a to display limits.
-
-
-
-
target-authentication
@@ -627,6 +606,46 @@
+
+ target-charset
+
+ The element target-charset specifies the
+ native character set that the target uses for queries.
+
+
+ If this is specified the proxy will act as a Z39.50 server
+ supporting character set negotiation. And in SRW/SRU mode
+ it will convert from UTF-8 (UNICODE) to this native character
+ set (if possible).
+
+
+
+
+ max-clients
+
+ The element max-clients is the child of element
+ proxy and specifies the total number of
+ allowed connections to targets (all targets). If this limit
+ is reached the proxy will close the least recently used connection.
+
+
+ Note, that many Unix systems impose a system on the number of
+ open files allowed in a single process, typically in the
+ range 256 (Solaris) to 1024 (Linux).
+ The proxy uses 2 sockets per session + a few files
+ for logging. As a rule of thumb, ensure that 2*max-clients + 5
+ can be opened by the proxy process.
+
+
+
+ Using the bash shell, you can set
+ the limit with
+ ulimit -nno.
+ Use ulimit -a to display limits.
+
+
+
+
log
@@ -684,6 +703,13 @@
and the size of the APDU is logged.
+
+ client-ip
+
+ Log the client IP for each log entry. By default, the client IP
+ is only logged when a new session starts.
+
+
@@ -705,7 +731,8 @@
The element max-connect is a child of element
proxy and specifies the maximum number
- of connections to be initiated within the last minute.
+ of connections to be initiated within the last minute (or
+ value of period-connect.
If the maximum number is reached the proxy will terminate the
@@ -718,11 +745,26 @@
The element max-connect is a child of element
proxy and specifies the limit of number
- of connections to be initiated within the last minute.
+ of connections to be initiated within the last minute (or
+ value of period-connect.
+
+
+ If the maximum number is reached the proxy delays the first operation
+ in the session by one second.
+
+
+
+
+ period-connect
+
+ The element period-connect is a child of element
+ proxy and specifies period - in the number of seconds
+ that limit-connect and
+ max-connect
+ should measure connections.
- If the maximum number is reached the proxy delay the first operatation
- in the session (Thus delaying the connection).
+ If period-connect is omitted, 60 seconds is used.
@@ -798,7 +840,7 @@