X-Git-Url: http://git.indexdata.com/?p=yazproxy-moved-to-github.git;a=blobdiff_plain;f=doc%2Fyaz-proxy-ref.xml;h=da0c713b117d1148616bdb339557becd36cd2e03;hp=209a178468ef44c949296d8d04f59e920483839f;hb=3110991d8a797c0e91037e9e615090ec57e22359;hpb=1f308f9b22a33ae53b9f217bc6b7bd4ff1adba5e diff --git a/doc/yaz-proxy-ref.xml b/doc/yaz-proxy-ref.xml index 209a178..da0c713 100644 --- a/doc/yaz-proxy-ref.xml +++ b/doc/yaz-proxy-ref.xml @@ -10,16 +10,18 @@ yazproxy -a filename + -c config + -i seconds -l filename -m num - -v level - -t target + -n num -o level - -i seconds - -T seconds + -t target -p pidfile + -T seconds -u userid - -c config + -v level + -X host:port @@ -57,6 +59,20 @@ standard output. + -c config + + Specifies config filename. Configuration is in XML + and is only supported if the YAZ proxy is compiled with + libxml2. + + + -i seconds + + 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). + + -l filename Specifies the name of a file to which to write a log of the @@ -67,22 +83,15 @@ -m num - Specifies the maximum number of connections to be cached - [default 50]. + Specifies the maximum number of client connections to be + offered [default 150]. - -v level + -n num - Sets the logging level. level is - a comma-separated list of members of the set - {fatal,debug,warn,log,malloc,all,none}. - - - -t target - - Specifies the default backend target to use when a client - connects that does not explicitly specify a target in its - initRequest. + Sets maximum number of open files to num. + This is only available on systems that offers the + setrlimit(2) call. -o level @@ -93,11 +102,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 @@ -108,13 +124,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 @@ -123,11 +132,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.