From c473db9c7ca11d1bbe1d0c980c48f4e470cfde70 Mon Sep 17 00:00:00 2001 From: Marc Cromme Date: Fri, 12 Aug 2005 12:44:36 +0000 Subject: [PATCH] finished re-write of chaper 7 and zebrasrv man page, now hopefully much more informative than before. All relevant YAZ frontend options are mentioned as well as zebra specific options and syntaxes --- doc/server.xml | 153 ++++++++++++++++++++++++++-------------------- doc/zebrasrv-man.sgml | 23 +++++-- doc/zebrasrv-options.xml | 82 ++++++++++++++++++++----- 3 files changed, 174 insertions(+), 84 deletions(-) diff --git a/doc/server.xml b/doc/server.xml index 993fe63..d42a39e 100644 --- a/doc/server.xml +++ b/doc/server.xml @@ -1,5 +1,5 @@ - + The Z39.50 Server @@ -12,6 +12,90 @@ can be run (inetd, nt service, stand-alone program, daemon...) -H --> + + + + DESCRIPTION + Zebra is a high-performance, general-purpose structured text indexing + and retrieval engine. It reads structured records in a variety of input + formats (eg. email, XML, MARC) and allows access to them through exact + boolean search expressions and relevance-ranked free-text queries. + + + zebrasrv is the Z39.50 and SRW/U frontend + server for the Zebra indexer. + + + On Unix you can run the zebrasrv + server from the command line - and put it + in the background. It may also operate under the inet daemon. + On WIN32 you can run the server as a console application or + as a WIN32 Service. + + + + + SYNOPSIS + &zebrasrv-synopsis; + + + + OPTIONS + + + The options for zebrasrv are the same + as those for YAZ' yaz-ztest. + Option -c specifies a Zebra configuration + file - if omitted zebra.cfg is read. + + + &zebrasrv-options; + + VIRTUAL HOSTS + + zebrasrv uses the YAZ server frontend and does + support multiple virtual servers behind multiple listening sockets. + + &zebrasrv-virtual; + + FILES + + zebra.cfg + + + SEE ALSO + + + zebraidx + 1 + , + + yaz-ztest + 8 + + + + Section "The Z39.50 Server" in the Zebra manual. + http://www.indexdata.dk/zebra/doc/server.tkl + + + Section "Virtual Hosts" in the YAZ manual. + http://www.indexdata.dk/yaz/doc/server.vhosts.tkl + + + Section "Specification of CQL to RPN mappings" in the YAZ manual. + http://www.indexdata.dk/yaz/doc/tools.tkl#tools.cql.map + + + The Zebra software is Copyright Index Data + http://www.indexdata.dk + and distributed under the + GPLv2 license. + + + + + Z39.50 Protocol Support and Behavior diff --git a/doc/zebrasrv-man.sgml b/doc/zebrasrv-man.sgml index be6c446..608f892 100644 --- a/doc/zebrasrv-man.sgml +++ b/doc/zebrasrv-man.sgml @@ -9,7 +9,7 @@ - + @@ -21,7 +21,7 @@ zebrasrv Zebra Server - + @@ -20,7 +20,8 @@ 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 @@ -53,17 +54,18 @@ -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 @@ -93,9 +95,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). @@ -113,6 +115,9 @@ 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 @@ -145,13 +150,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 +179,55 @@ + + + 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 Z39.50 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 Z39.50 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 + Z39.50, 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. + + + +