X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Ffrontend.xml;h=2121b07392cf4a0b914b782eafc36b198248943f;hb=3bb2e157affd19490974257a252472716d7858b3;hp=19729e102d18fe8426b6ed10b889068c80fcdaad;hpb=bd7e251dac1b07c54884d26295f66b90cfb23131;p=yaz-moved-to-github.git diff --git a/doc/frontend.xml b/doc/frontend.xml index 19729e1..2121b07 100644 --- a/doc/frontend.xml +++ b/doc/frontend.xml @@ -1,4 +1,4 @@ - + Generic server Introduction @@ -217,8 +217,8 @@ statserv_options_block *statserv_getcontrol(void); enum oid_proto default_proto; - Either PROTO_SR or - PROTO_Z3950. + Either PROTO_Z3950 or + PROTO_SR. Default is PROTO_Z39_50. @@ -342,6 +342,7 @@ typedef struct bend_initrequest Z_ReferenceId *referenceId;/* reference ID */ char *peer_name; /* dns host of peer (client) */ + char *implementation_id; char *implementation_name; char *implementation_version; int (*bend_sort) (void *handle, bend_sort_rr *rr); @@ -394,8 +395,9 @@ typedef struct bend_initresult The members peer_name, + implementation_id, implementation_name and - implementation_version holds DNS of client, name + implementation_version holds DNS of client, ID of implementor, name of client (Z39.50) implementation - and version. @@ -687,14 +689,15 @@ typedef struct bend_scan_rr { - -a file + -a + file Specify a file for dumping PDUs (for diagnostic purposes). The special name "-" sends output to stderr. - -S + -S Don't fork or make threads on connection requests. This is good for debugging, but not recommended for real operation: Although the @@ -703,19 +706,19 @@ typedef struct bend_scan_rr { current users. - -T + -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 Use the SR protocol (obsolete). - -z + -z Use the Z39.50 protocol (default). These two options complement each other. You can use both multiple times on the same command @@ -724,11 +727,13 @@ typedef struct bend_scan_rr { concurrently, on different local ports. - -l file + -l + file The logfile. - -c config + -c + config A user option that serves as a specifier for some sort of configuration, e.g. a filename. The argument to this option is transferred to member @@ -736,13 +741,15 @@ typedef struct bend_scan_rr { statserv_options_block. - -v level + -v + level The log level. Use a comma-separated list of members of the set {fatal,debug,warn,log,all,none}. - -u userid + -u + userid 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 @@ -750,22 +757,37 @@ typedef struct bend_scan_rr { privileged port. - -w dir + -w + dir Working directory. - -i + -i - Use this when running from the inetd server. + Use this to make the the server run from the + inetd server (UNIX only). + + + -install + + Use this to install the server as an NT service (Windows 2000/NT 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 2000/NT only). - -t minutes + -t + minutes Idle session timeout, in minutes. - -k size + -k + size Maximum record size/message size, in kilobytes. @@ -776,11 +798,11 @@ typedef struct bend_scan_rr { A listener specification consists of a transport mode followed by a colon (:) followed by a listener address. The transport mode is - either osi or tcp. + either tcp or ssl. - For TCP, an address has the form + For TCP and SSL, an address has the form @@ -792,46 +814,19 @@ typedef struct bend_scan_rr { - For osi, the address form is - - - - [t-selector /] hostname | IP-number [: portnumber] - - - - The transport selector is given as a string of hex digits (with an even - number of digits). The default port number is 102 (RFC1006 port). - - - Examples tcp:dranet.dra.com - osi:0402/dbserver.osiworld.com:3000 + ssl:ssl.enterprise.com:3000 In both cases, the special hostname "@" is mapped to - the address INADDR_ANY, which causes the server to listen on any local - interface. To start the server listening on the registered ports for - Z39.50 and SR over OSI/RFC1006, and to drop root privileges once the - ports are bound, execute the server like this (from a root shell): - - - - my-server -u daemon tcp:@ -s osi:@ - - - - You can replace daemon with another user, eg. your - own account, or a dedicated IR server account. - my-server should be the name of your - server application. You can test the procedure with the - yaz-ztest application. + the address INADDR_ANY, which causes the + server to listen on any local interface.