X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Fgfs-options.xml;h=ed524ca47fa29c41a0762734019567ec4797e6d2;hp=70911552d6c5c99bf7c98ac62000cca17979b7bb;hb=7f79b3a521ea4d5d4e89f8659324019cecc0fe8a;hpb=e232998663cbfa8e9c489d99245e530c03223571 diff --git a/doc/gfs-options.xml b/doc/gfs-options.xml index 7091155..ed524ca 100644 --- a/doc/gfs-options.xml +++ b/doc/gfs-options.xml @@ -1,190 +1,220 @@ - - - -a - file + + -a + file - Specify a file for dumping PDUs (for diagnostic purposes). + Specify a file for dumping PDUs (for diagnostic purposes). The special name - (dash) sends output to stderr. - - - -S - - Don't fork or make threads on connection requests. This is good for - debugging, but not recommended for real operation: Although the - server is asynchronous and non-blocking, it can be nice to keep - a software malfunction (okay then, a crash) from affecting all - current users. - - - -1 - - Like -S but after one session the server - exits. This mode is for debugging only. - - - -T - - Operate the server in threaded mode. The server creates a thread - for each connection rather than a fork a process. Only available - on UNIX systems that offers POSIX threads. - - - -s + + + + -S + + Don't fork or make threads on connection requests. This is good for + debugging, but not recommended for real operation: Although the + server is asynchronous and non-blocking, it can be nice to keep + a software malfunction (okay then, a crash) from affecting all + current users. + + + + -1 - Use the SR protocol (obsolete). - - - -z - - Use the Z39.50 protocol (default). This option and -s - complement each other. - You can use both multiple times on the same command - line, between listener-specifications (see below). This way, you - can set up the server to listen for connections in both protocols - concurrently, on different local ports. - - - -l - file + Like -S but after one session the server + exits. This mode is for debugging only. + + + + -T + + Operate the server in threaded mode. The server creates a thread + for each connection rather than a fork a process. Only available + on UNIX systems that offers POSIX threads. + + + + -s + + Use the SR protocol (obsolete). + + + + -z + + Use the Z39.50 protocol (default). This option and -s + complement each other. + You can use both multiple times on the same command + line, between listener-specifications (see below). This way, you + can set up the server to listen for connections in both protocols + concurrently, on different local ports. + + + + -l file The logfile. - - - -c - config + + + + -c config A user option that serves as a specifier for some - sort of configuration, usually a filename. - The argument to this option is transferred to member - configname of the - statserv_options_block. - - - -f - vconfig + sort of configuration, usually a filename. + The argument to this option is transferred to member + configname of the + statserv_options_block. + + + + -f vconfig This specifies an XML file that describes - one or more YAZ frontend virtual servers. - - - -C - fname + one or more YAZ frontend virtual servers. + + + + -C fname Sets SSL certificate file name for server (PEM). - - - -v - level + + + + -v level - The log level. Use a comma-separated list of members of the set - {fatal,debug,warn,log,malloc,all,none}. - - - -u - uid - - Set user ID. Sets the real UID of the server process to that of the - given user. It's useful if you aren't comfortable with having the - server run as root, but you need to start it as such to bind a - privileged port. - - - -w - dir - - The server changes to this directory during before listening - on incoming connections. This option is useful - when the server is operating from the inetd - daemon (see -i). - - - -p - pidfile + The log level. Use a comma-separated list of members of the set + {fatal,debug,warn,log,malloc,all,none}. + + + + -u uid + + Set user ID. Sets the real UID of the server process to that of the + given user. It's useful if you aren't comfortable with having the + server run as root, but you need to start it as such to bind a + privileged port. + + + + -w dir + + The server changes to this directory during before listening + on incoming connections. This option is useful + when the server is operating from the inetd + daemon (see -i). + + + + -p pidfile + + + Specifies that the server should write its Process ID to + file given by pidfile. + A typical location would be /var/run/yaz-ztest.pid. + + + + -i - Specifies that the server should write its Process ID to - file given by pidfile. - A typical location would be /var/run/yaz-ztest.pid. - - - -i - - Use this to make the the server run from the - inetd server (UNIX only). - - - -D - - Use this to make the server put itself in the background and - run as a daemon. If neither -i nor - -D is given, the server starts in the foreground. - - - -install - - Use this to install the server as an NT service - (Windows NT/2000/XP only). - Control the server by going to the Services in the Control Panel. - - - -installa - - Use this to install and activate the server as an NT service - (Windows NT/2000/XP only). - Control the server by going to the Services in the Control Panel. - - - -remove - - Use this to remove the server from the NT services - (Windows NT/2000/XP only). - - - -t - minutes - - Idle session timeout, in minutes. - - - -k - size - - Maximum record size/message size, in kilobytes. - + Use this to make the the server run from the + inetd server (UNIX only). + - - -d - daemon - - Set name of daemon to be used in hosts access file. - See - - hosts_access - 5 - - and - - tcpd - 8 + + -D + + Use this to make the server put itself in the background and + run as a daemon. If neither -i nor + -D is given, the server starts in the foreground. + + + + -install + + Use this to install the server as an NT service + (Windows NT/2000/XP only). + Control the server by going to the Services in the Control Panel. + + + + -installa + + Use this to install the server as an NT service and mark it as "auto-start. + Control the server by going to the Services in the Control Panel. + + + + -remove + + Use this to remove the server from the NT services + (Windows NT/2000/XP only). + + + + -t minutes + + Idle session timeout, in minutes. + + + + -k size + + Maximum record size/message size, in kilobytes. + + + + -K + + Forces no-keepalive for HTTP sessions. By default GFS will keep + sessions alive for HTTP 1.1 sessions (as defined by the standard). + Using this option will force GFS to close the connection for each + operation. + + + + -r size + + Maximum size of log file before rotation occurs, in kilobytes. + Default size is 1048576 k (=1 GB). + + + + + -d daemon + + + Set name of daemon to be used in hosts access file. + See + + hosts_access + 5 + + and + + tcpd + 8 . - + + + + -m time-format + + Sets the format of time-stamps in the log-file. Specify a string in + the input format to strftime(). + + + + -V + + Display YAZ version and exit. + -