X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;ds=sidebyside;f=doc%2Freference.xml;h=c2ca0dfb052f9f5b9e9ce7d3bef14ce723faeb27;hb=fc1109697ba85291047348453030e22a7b969a82;hp=644fe5877843eebf060155f2f24e465a294326c8;hpb=b65837a1f4aadf842d112f5e37382d93f26da83d;p=yazproxy-moved-to-github.git
diff --git a/doc/reference.xml b/doc/reference.xml
index 644fe58..c2ca0df 100644
--- a/doc/reference.xml
+++ b/doc/reference.xml
@@ -12,7 +12,7 @@
see .
- As an option the proxy may change user identity to a less privileged
+ As an option, the proxy may change user identity to a less privileged
user.
@@ -116,6 +116,81 @@
+
+
+ Query Caching
+
+ Simple stateless clients often send identical Z39.50 searches
+ in a relatively short period of time (e.g. in order to produce a
+ results-list page, the next page,
+ a single full-record, etc). And for many targets, it's
+ much more expensive to produce a new result set than to
+ reuse an existing one.
+
+
+ The proxy tries to solve that by remembering the last query for each
+ backend target, so that if an identical query is received next, it
+ is turned into Present Requests rather than new Search Requests.
+
+
+
+ In a future we release will will probably allows for
+ an arbitrary-sized cache for targets supporting named result sets.
+
+
+
+ You can enable/disable query caching using option -o.
+
+
+
+
+ Record Caching
+
+ As an option, the proxy may also cache result set records for the
+ last search.
+ The proxy takes into account the Record Syntax and CompSpec.
+ The CompSpec includes simple element set names as well.
+ By default the cache is 200000 bytes per session.
+
+
+
+
+ Query Validation
+
+ The Proxy may also be configured to trap particular attributes in
+ Type-1 queries and send Bib-1 diagnostics back to the client without
+ even consulting the backend target. This facility may be useful if
+ a target does not properly issue diagnostics when unsupported attributes
+ are send to it.
+
+
+
+
+ Record Syntax Validation
+
+ The proxy may be configured to accept, reject or convert records.
+ When accepted, the target passes search/present requests to the
+ backend target under the assumption that the target can honor the
+ request (In fact it may not do that). When a record is rejected because
+ the record syntax is "unsupported" the proxy returns a diagnostic to the
+ client. Finally, the proxy may convert records.
+
+
+ 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.
+
+
+
+
+ Other Optimizations
+
+ We've had some plans to support global caching of result set records,
+ but this has not yet been implemented.
+
+
+
Proxy Configuration File
@@ -207,7 +282,7 @@
This can also be specified on the command line by using option
- -T. Refer to OPTIONS.
+ -T. Refer to OPTIONS in .
@@ -220,7 +295,7 @@
This can also be specified on the command line by using option
- -i. Refer to OPTIONS.
+ -i. Refer to OPTIONS in .
@@ -567,81 +642,6 @@
-
-
- Query Caching
-
- Simple stateless clients often send identical Z39.50 searches
- in a relatively short period of time (e.g. in order to produce a
- results-list page, the next page,
- a single full-record, etc). And for many targets, it's
- much more expensive to produce a new result set than to
- reuse an existing one.
-
-
- The proxy tries to solve that by remembering the last query for each
- backend target, so that if an identical query is received next, it
- is turned into Present Requests rather than new Search Requests.
-
-
-
- In a future we release will will probably allows for
- an arbitrary-sized cache for targets supporting named result sets.
-
-
-
- You can enable/disable query caching using option -o.
-
-
-
-
- Record Caching
-
- As an option, the proxy may also cache result set records for the
- last search.
- The proxy takes into account the Record Syntax and CompSpec.
- The CompSpec includes simple element set names as well.
- By default the cache is 200000 bytes per session.
-
-
-
-
- Query Validation
-
- The Proxy may also be configured to trap particular attributes in
- Type-1 queries and send Bib-1 diagnostics back to the client without
- even consulting the backend target. This facility may be useful if
- a target does not properly issue diagnostics when unsupported attributes
- are send to it.
-
-
-
-
- Record Syntax Validation
-
- The proxy may be configured to accept, reject or convert records.
- When accepted, the target passes search/present requests to the
- backend target under the assumption that the target can honor the
- request (In fact it may not do that). When a record is rejected because
- the record syntax is "unsupported" the proxy returns a diagnostic to the
- client. Finally, the proxy may convert records.
-
-
- 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.
-
-
-
-
- Other Optimizations
-
- We've had some plans to support global caching of result set records,
- but this has not yet been implemented.
-
-
-
Proxy Usage (man page)
@@ -688,7 +688,7 @@