X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fyaz-proxy-ref.xml;h=252ed1ddc822f8cdfdc5f592102eaa4c651e7e39;hb=4ffb5c5f0c0c64799a89f7961fd553ae8ae4854b;hp=c643b57308b5875e8ce1fe308d7305ca5facbe3d;hpb=09b40382c41a29b7e3de2fa1a0362f25422a4367;p=yazpp-moved-to-github.git
diff --git a/doc/yaz-proxy-ref.xml b/doc/yaz-proxy-ref.xml
index c643b57..252ed1d 100644
--- a/doc/yaz-proxy-ref.xml
+++ b/doc/yaz-proxy-ref.xml
@@ -10,25 +10,41 @@
yaz-proxy
-a filename
- -c num
+ -l filename
+ -m num
-v level
-t target
- -u auth
+ -U auth
-o level
-i seconds
+ -T seconds
+ -p pidfile
+ -u userid
+ -c config
host:port
DESCRIPTION
- The proxy runs stand-alone (not from
- inetd). The
- host:port
+ yaz-proxy is a Z39.50 optimizing proxy daemon.
+ The listening port must be specified on the command-line.
+ inetd operation is not supported.
+ The host:port
argument specifies host address to listen to, and the port to
listen on. Use the host @
to listen for connections coming from any address.
+
+ yaz-proxy can be configured using command-line
+ options or a configuration file.
+ Configuration file options override values specified
+ on the command-line.
+
+
+ yaz-proxy rereads its configuration file and
+ reopens log files when it receives the hangup signal, SIGHUP.
+
OPTIONS
@@ -40,7 +56,15 @@
standard output.
- -c num
+ -l filename
+
+ 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.
+
+
+ -m num
Specifies the maximum number of connections to be cached
[default 50].
@@ -48,7 +72,7 @@
-v level
- Sets the logging level. level is
+ Sets the logging level. level is
a comma-separated list of members of the set
{fatal,debug,warn,log,malloc,all,none}.
@@ -60,7 +84,7 @@
initRequest.
- -u auth
+ -U auth
Specifies authentication info to be sent to the backend target.
This is useful if you happen to have an internal target that
@@ -78,14 +102,44 @@
-i seconds
- Specifies in seconds the idle time for communication
- for proxy. If a connection is inactive for this long
- it willl be closed. Default: 600 seconds (10 minutes).
+ 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 seconds
+
+ Specifies in seconds the idle time for communication between
+ proxy and backend target.
+ If a connection is inactive for this long
+ it will be closed. Default: 600 seconds (10 minutes).
+
+
+ -p pidfile
+
+ When specified, yaz-proxy 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, yaz-proxy will change identity to the user ID
+ specified, just after the proxy has started listening to a
+ possibly privileged port and after the PID file has been created
+ if specified by option -u.
+
+
+ -c config
+
+ Specifies config filename. Configuration is in XML
+ and is only supported if the YAZ proxy is compiled with
+ libxml2.
-
+
EXAMPLES
The following command starts the proxy, listening on port
@@ -131,14 +185,22 @@
The YAZ command-line client,
- yaz-client,
- allows you to set the proxy target as part of the Initialize
- Request using option -p.
- For example, to connect to Index Data's target you could use:
+ yaz-client,
+ allows you to set the proxy address by specifying option -p. In
+ that case, the actual backend target is specified as part of the
+ Initialize Request.
+
+ Suppose you have a proxy running on localhost,
+ port 9000 and wish to connect to Index Data's test target at
+ indexdata.dk:210/gils you could use:
+
+ yaz-client -p localhost:9000 indexdata.dk:210/gils
+
+ Since port 210 is the default, the port can be omitted:
+
+ yaz-client -p localhost:9000 indexdata.dk/gils
+
-
- yaz-client -p indexdata.dk localhost:9000/gils
-