X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;f=doc%2Freference.xml;h=3e52ecbe14dde799d9fdd420a55f0459ce885ec8;hb=ce193eb0444478dc61e832497ab7f4a7ae73c0c6;hp=c2ca0dfb052f9f5b9e9ce7d3bef14ce723faeb27;hpb=e751544e4f8f678eafaf851a215033af6a779684;p=yazproxy-moved-to-github.git
diff --git a/doc/reference.xml b/doc/reference.xml
index c2ca0df..3e52ecb 100644
--- a/doc/reference.xml
+++ b/doc/reference.xml
@@ -3,7 +3,7 @@
Operating Environment
- The YAZ proxy is a single program. After startup it spawns
+ The YAZ proxy is a console program. After startup it spawns
a child process (except on Windows or if option -X is given).
The child process is the core of the proxy and it handles all
communication with clients and servers. The parent process
@@ -322,7 +322,7 @@
<keepalive>
<bandwidth>1048576</bandwidth>
- <retrieve>400</retrieve>
+ <pdu>400</pdu>
</keepalive>
@@ -406,7 +406,7 @@
A target that supports use attributes 1,4, 1000 through 1003 and
no other use attributes, could use the following rules:
- <attribute type="1" value="1,4,1000-1003">
+ <attribute type="1" value="1,4,1000-1003"/>
<attribute type="1" value="*" error="114"/>
@@ -434,7 +434,12 @@
If attribute marcxml is given, the proxy will
perform MARC21 to MARCXML conversion. In this case the
type should be XML. The proxy will use
- preferred record syntax USMARC/MARC21 against the backend target.
+ preferred record syntax USMARC/MARC21 or backendtype
+ (if given) against the backend target.
+
+
+ If attribute backendtype is given, that holds the
+ record syntax to be transmitted to backend.
If attribute stylesheet is given, the proxy
@@ -468,15 +473,15 @@
..
<syntax type="usmarc"/>
<syntax type="xml" marcxml="1"
- identifier="info:srw/schema/1/marcxml-v1.1"
- <title>MARCXML<title>
- <name>marcxml<name>
- <syntax>
+ identifier="info:srw/schema/1/marcxml-v1.1"
+ <title>MARCXML<title>
+ <name>marcxml<name>
+ </syntax>
<syntax type="xml" marcxml="1" stylesheet="MARC21slim2SRWDC.xsl"
- identifier="info:srw/schema/1/dc-v1.1">
- <title>Dublin Core<title>
- <name>dc<name>
- <syntax>
+ identifier="info:srw/schema/1/dc-v1.1">
+ <title>Dublin Core<title>
+ <name>dc<name>
+ </syntax>
<syntax type="*" error="238"/>
..
</target>
@@ -515,17 +520,20 @@
cql2rpn
- The CDATA of cql2rpn refers to CQL to a RPN conversion
- file - for the server in the target section. This element
- is required for SRW/SRU searches to operate against a Z39.50
- server that doesn't support CQL. Most Z39.50 servers only support
+ The content of the cql2rpn element specifies
+ the path from the working directory to a CQL-to-RPN conversion
+ file for the server in the target section. This element
+ is required for SRW/SRU searches to operate against Z39.50
+ servers that don't support CQL. Most Z39.50 servers only support
Type-1/RPN so this is usually required.
+
+
See YAZ documentation for more information about the
CQL
to PQF conversion. See also the
pqf.properties in the etc
(or prefix/share/yazproxy)
- directory of the YAZ proxy.
+ directory of the YAZ proxy distribution.
@@ -569,6 +577,53 @@
+
+ target-authentication
+
+ The element target-authentication specifies
+ fixed authentication information to be sent to the backend target.
+
+
+ This element takes a an attribute type which is
+ the authenticatin type to be used..
+
+
+ none
+
+
+ No authentication. There is no CDATA associated with this.
+
+
+
+
+ anonymous
+
+
+ Anonymous authentication. There is no CDATA associated with this.
+
+
+
+
+ open
+
+
+ Open authentication. The CDATA consists of the
+ open authentication string.
+
+
+
+
+ idPass
+
+
+ IdPass authentication. The CDATA consists of
+ three terms: user, group and password.
+
+
+
+
+
+
- Proxy Usage (man page)
+ Proxy Manual Pages
&yaz-proxy-ref;
@@ -686,15 +741,15 @@
directory etc of the distribution.
+
@@ -704,6 +759,7 @@
+
@@ -719,11 +775,16 @@
-
+
+
+
+
+
+
@@ -735,6 +796,29 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -765,23 +849,29 @@
-
-
+
+
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-
]]>