X-Git-Url: http://lists.indexdata.dk/cgi-bin?a=blobdiff_plain;ds=sidebyside;f=doc%2Fzebrasrv-options.xml;h=b0b3fdbbb30697c59b88f05ba26b459594c5dab1;hb=b19b79e382ef8196f1625763db1af3a82b1e0c81;hp=6915e0ded7bf69460a06408bcab206f564892533;hpb=7dcaf748021e168c37a2e3eb263db03248b2d170;p=idzebra-moved-to-github.git
diff --git a/doc/zebrasrv-options.xml b/doc/zebrasrv-options.xml
index 6915e0d..b0b3fdb 100644
--- a/doc/zebrasrv-options.xml
+++ b/doc/zebrasrv-options.xml
@@ -1,7 +1,9 @@
@@ -20,8 +22,15 @@
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.
+ current users. The server can only accept a single
+ connection in this mode.
+
+
-1
@@ -43,7 +52,7 @@
-z
- Use the Z39.50 protocol (default). This option and -s
+ Use the &z3950; 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
@@ -53,22 +62,24 @@
-l
file
- The logfile.
+
+ Specify an output file for the diagnostic messages.
+ The default is to write this information to
+ stderr
-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.
-
+ config-file
+ Read configuration information from
+ config-file.
+ The default configuration is ./zebra.cfg
+
-f
vconfig
- This specifies an XML file that describes
- one or more YAZ frontend virtual servers.
+ This specifies an &xml; file that describes
+ one or more &yaz; frontend virtual servers. See section VIRTUAL
+ HOSTS for details.
-C
@@ -82,6 +93,18 @@
The log level. Use a comma-separated list of members of the set
{fatal,debug,warn,log,malloc,all,none}.
+
+
-u
uid
@@ -93,9 +116,9 @@
-w
- dir
+ working-directory
- The server changes to this directory during before listening
+ The server changes to this working directory during before listening
on incoming connections. This option is useful
when the server is operating from the inetd
daemon (see -i).
@@ -106,15 +129,24 @@
Specifies that the server should write its Process ID to
file given by pidfile.
- A typical location would be /var/run/yaz-ztest.pid.
+ A typical location would be /var/run/zebrasrv.pid.
-i
Use this to make the the server run from the
inetd server (UNIX only).
+ Make sure you use the logfile option -l in
+ conjunction with this mode and specify the -l
+ option before any other options.
-
+
+
+
-D
Use this to make the server put itself in the background and
@@ -145,13 +177,13 @@
-t
minutes
- Idle session timeout, in minutes.
+ Idle session timeout, in minutes. Default is 60 minutes.
-k
size
- Maximum record size/message size, in kilobytes.
+ Maximum record size/message size, in kilobytes. Default is 1024 KB (1 MB).
@@ -174,6 +206,60 @@
+
+
+ A listener-address consists of an optional
+ transport mode followed by a colon (:) followed by a listener address.
+ The transport mode is either a file system socket
+ unix,
+ a SSL TCP/IP socket ssl, or a plain TCP/IP socket
+ tcp (default).
+
+
+
+ For TCP, an address has the form
+
+ hostname | IP-number [: portnumber]
+
+ The port number defaults to 210 (standard &z3950; port) for
+ privileged users (root), and 9999 for normal users.
+ The special hostname "@" is mapped to
+ the address INADDR_ANY, which causes the server to listen on any local
+ interface.
+
+
+ The default behavior for zebrasrv - if started
+ as non-priviledged user - is to establish
+ a single TCP/IP listener, for the &z3950; protocol, on port 9999.
+
+ zebrasrv @
+ zebrasrv tcp:some.server.name.org:1234
+ zebrasrv ssl:@:3000
+
+
+
+
+ To start the server listening on the registered port for
+ &z3950;, or on a filesystem socket,
+ and to drop root privileges once the ports are bound, execute
+ the server like this from a root shell:
+
+ zebrasrv -u daemon @
+ zebrasrv -u daemon tcp:@:210
+ zebrasrv -u daemon unix:/some/file/system/socket
+
+ Here daemon is an existing user account, and the
+ unix socket /some/file/system/socket is readable
+ and writable for the daemon account.
+
+
+
+