X-Git-Url: http://git.indexdata.com/?p=yazproxy-moved-to-github.git;a=blobdiff_plain;f=doc%2Fyaz-proxy-ref.xml;h=77c66bdc690f7e3ddec0de1f228c85fb753cf425;hp=c44603da99386589c7df1f8de243426261afef6d;hb=5076e32b1de695dc3e7b9509c9b05104b01a5f90;hpb=e751544e4f8f678eafaf851a215033af6a779684
diff --git a/doc/yaz-proxy-ref.xml b/doc/yaz-proxy-ref.xml
index c44603d..77c66bd 100644
--- a/doc/yaz-proxy-ref.xml
+++ b/doc/yaz-proxy-ref.xml
@@ -4,23 +4,25 @@
yazproxy
- The YAZ toolkit's transparent Z39.50/SRW/SRU proxy
+ The YAZ toolkit's transparent Z39.50/SRU proxy
yazproxy
-a filename
+ -c config
+ -D
+ -i seconds
-l filename
-m num
- -v level
- -t target
- -U auth
+ -n num
-o level
- -i seconds
- -T seconds
+ -t target
-p pidfile
+ -T seconds
-u userid
- -c config
+ -v level
+ -X
host:port
@@ -28,7 +30,7 @@
DESCRIPTION
yazproxy is a proxy that accepts connections
- from Z39.50/SRW/SRU clients and contacts a Z39.50 backend.
+ from Z39.50/SRU clients and contacts a Z39.50 backend.
The listening port must be specified on the command-line.
inetd operation is not supported.
The host:port
@@ -58,40 +60,46 @@
standard output.
- -l filename
+ -c config
- Specifies the name of a file to which to write a log of the
- YAZ proxy activity. This uses the logging facility as provided
- by the YAZ toolkit. If this options is omitted, the output
- directed to stderr.
+ Specifies config filename. Configuration is in XML
+ and is only supported if the YAZ proxy is compiled with
+ libxml2.
- -m num
+ -X
- Specifies the maximum number of connections to be cached
- [default 50].
+ Puts YAZ proxy in the background after startup. This is
+ similar to using shell's & operator but often better since
+ it allows the start / stop script to capture startup errors.
- -v level
+ -i seconds
- Sets the logging level. level is
- a comma-separated list of members of the set
- {fatal,debug,warn,log,malloc,all,none}.
+ Specifies in seconds the idle time for communication between
+ client and proxy. If a connection is inactive for this long
+ it will be closed. Default: 600 seconds (10 minutes).
- -t target
+ -l filename
- Specifies the default backend target to use when a client
- connects that does not explicitly specify a target in its
- initRequest.
+ Specifies the name of a file to which to write a log of the
+ YAZ proxy activity. This uses the logging facility as provided
+ by the YAZ toolkit. If this options is omitted, the output
+ directed to stderr.
- -U auth
+ -m num
- Specifies authentication info to be sent to the backend target.
- This is useful if you happen to have an internal target that
- requires authentication, or if the client software does not allow
- you to set it.
+ Specifies the maximum number of client connections to be
+ offered [default 150].
+
+
+ -n num
+
+ Sets maximum number of open files to num.
+ This is only available on systems that offers the
+ setrlimit(2) call.
-o level
@@ -102,11 +110,18 @@
features. By default optimization is enabled (value 1).
- -i seconds
+ -p pidfile
- Specifies in seconds the idle time for communication between
- client and proxy. If a connection is inactive for this long
- it will be closed. Default: 600 seconds (10 minutes).
+ When specified, yazproxy will create pidfile
+ with the process ID of the proxy. The pidfile will be generated
+ before the process changes identity (see option -u).
+
+
+ -t target
+
+ Specifies the default backend target to use when a client
+ connects that does not explicitly specify a target in its
+ initRequest.
-T seconds
@@ -117,13 +132,6 @@
it will be closed. Default: 600 seconds (10 minutes).
- -p pidfile
-
- When specified, yazproxy will create pidfile
- with the process ID of the proxy. The pidfile will be generated
- before the process changes identity (see option -u).
-
-
-u userid
When specified, yazproxy will change identity to the user ID
@@ -132,11 +140,19 @@
if specified by option -u.
- -c config
+ -v level
- Specifies config filename. Configuration is in XML
- and is only supported if the YAZ proxy is compiled with
- libxml2.
+ Sets the logging level. level is
+ a comma-separated list of members of the set
+ {fatal,debug,warn,log,malloc,all,none}.
+
+
+ -X
+
+ Enables debugging mode for the proxy. When specified, the proxy will
+ not fork itself, thus any violations becomes fatal. Useful if
+ you run yazproxy inside gdb.
+ Don't run this in production.