From f0fff840ae259cab0b1c17297c4367172a7cd229 Mon Sep 17 00:00:00 2001 From: Marc Cromme Date: Mon, 24 Apr 2006 12:41:00 +0000 Subject: [PATCH] corrected DOCTYPE header and called emacs nxml-mode instead of sgml-mode in bottom of files --- doc/asn.xml | 22 +- doc/bookinfo.xml | 22 +- doc/client.xml | 22 +- doc/comstack.xml | 22 +- doc/credits.xml | 22 +- doc/frontend.xml | 22 +- doc/future.xml | 22 +- doc/gfs-options.xml | 17 +- doc/gfs-synopsis.xml | 16 +- doc/gfs-virtual.xml | 16 +- doc/indexdata.xml | 22 +- doc/installation.xml | 22 +- doc/introduction.xml | 21 +- doc/license.xml | 22 +- doc/odr.xml | 22 +- doc/tools.xml | 22 +- doc/yaz-asncomp-man.xml | 19 +- doc/yaz-client-commands.xml | 27 +- doc/yaz-client-man.xml | 814 ++++++++++++++++++++++++++++++++++++++++++- doc/yaz-config-man.xml | 20 +- doc/yaz-iconv-man.xml | 20 +- doc/yaz-log-man.xml | 20 +- doc/yaz-man.xml | 99 +++++- doc/yaz-marcdump-man.xml | 20 +- doc/yaz-ztest-man.xml | 492 ++++++++++++++++++++++++-- doc/zoom.xml | 22 +- doc/zoomsh-man.xml | 21 +- 27 files changed, 1501 insertions(+), 407 deletions(-) diff --git a/doc/asn.xml b/doc/asn.xml index fd3d649..6ee817a 100644 --- a/doc/asn.xml +++ b/doc/asn.xml @@ -1,4 +1,4 @@ - + The Z39.50 ASN.1 Module Introduction @@ -1057,17 +1057,9 @@ typedef struct Z_ext_typeent - + + diff --git a/doc/bookinfo.xml b/doc/bookinfo.xml index 4d50a46..3d4b148 100644 --- a/doc/bookinfo.xml +++ b/doc/bookinfo.xml @@ -1,4 +1,4 @@ - + YAZ User's Guide and Reference SebastianHammer @@ -29,17 +29,9 @@ - + + diff --git a/doc/client.xml b/doc/client.xml index a00c041..064b50a 100644 --- a/doc/client.xml +++ b/doc/client.xml @@ -1,4 +1,4 @@ - + The YAZ client Introduction @@ -204,17 +204,9 @@ - + + diff --git a/doc/comstack.xml b/doc/comstack.xml index 890b5cd..ae62b5e 100644 --- a/doc/comstack.xml +++ b/doc/comstack.xml @@ -1,4 +1,4 @@ - + The COMSTACK Module Synopsis (blocking mode) @@ -628,18 +628,10 @@ if (buf) - + + diff --git a/doc/credits.xml b/doc/credits.xml index e201249..36a6016 100644 --- a/doc/credits.xml +++ b/doc/credits.xml @@ -1,4 +1,4 @@ - + Credits This appendix lists individuals that have contributed in the development @@ -98,17 +98,9 @@ - + + diff --git a/doc/frontend.xml b/doc/frontend.xml index 8f590a2..e2b51bf 100644 --- a/doc/frontend.xml +++ b/doc/frontend.xml @@ -1,4 +1,4 @@ - + Generic server Introduction @@ -840,17 +840,9 @@ typedef struct bend_scan_rr { - + + diff --git a/doc/future.xml b/doc/future.xml index 1fb5b50..f2f1c11 100644 --- a/doc/future.xml +++ b/doc/future.xml @@ -1,4 +1,4 @@ - + Future Directions @@ -39,17 +39,9 @@ - + + diff --git a/doc/gfs-options.xml b/doc/gfs-options.xml index 92c7499..0510390 100644 --- a/doc/gfs-options.xml +++ b/doc/gfs-options.xml @@ -1,9 +1,8 @@ - -a @@ -181,18 +180,8 @@ - - diff --git a/doc/gfs-synopsis.xml b/doc/gfs-synopsis.xml index ef76933..05395ec 100644 --- a/doc/gfs-synopsis.xml +++ b/doc/gfs-synopsis.xml @@ -1,5 +1,5 @@ @@ -25,17 +25,9 @@ listener-spec - + diff --git a/doc/gfs-virtual.xml b/doc/gfs-virtual.xml index 62e8a0b..bf9eac9 100644 --- a/doc/gfs-virtual.xml +++ b/doc/gfs-virtual.xml @@ -1,5 +1,5 @@ @@ -227,17 +227,9 @@ via listener "internal". - + diff --git a/doc/indexdata.xml b/doc/indexdata.xml index b104835..4d99d02 100644 --- a/doc/indexdata.xml +++ b/doc/indexdata.xml @@ -1,4 +1,4 @@ - + About Index Data @@ -46,17 +46,9 @@ - + + diff --git a/doc/installation.xml b/doc/installation.xml index 8c0f7f5..761964c 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,4 +1,4 @@ - + Compilation and Installation Introduction @@ -648,18 +648,10 @@ - + + diff --git a/doc/introduction.xml b/doc/introduction.xml index a22e7dd..46184fa 100644 --- a/doc/introduction.xml +++ b/doc/introduction.xml @@ -1,4 +1,4 @@ - + Introduction @@ -299,18 +299,9 @@ + - diff --git a/doc/license.xml b/doc/license.xml index 705d7e5..bb6db01 100644 --- a/doc/license.xml +++ b/doc/license.xml @@ -1,4 +1,4 @@ - + License Index Data Copyright @@ -102,17 +102,9 @@ - + + diff --git a/doc/odr.xml b/doc/odr.xml index cb1fc65..f7734c0 100644 --- a/doc/odr.xml +++ b/doc/odr.xml @@ -1,4 +1,4 @@ - + The ODR Module Introduction @@ -1289,17 +1289,9 @@ void odr_choice_bias(ODR o, int what); - + + diff --git a/doc/tools.xml b/doc/tools.xml index 985306b..f111b55 100644 --- a/doc/tools.xml +++ b/doc/tools.xml @@ -1,4 +1,4 @@ - + Supporting Tools @@ -2063,17 +2063,9 @@ typedef struct oident - + + diff --git a/doc/yaz-asncomp-man.xml b/doc/yaz-asncomp-man.xml index f39207f..c0eba7e 100644 --- a/doc/yaz-asncomp-man.xml +++ b/doc/yaz-asncomp-man.xml @@ -1,5 +1,6 @@ - + @@ -237,18 +238,8 @@ - - diff --git a/doc/yaz-client-commands.xml b/doc/yaz-client-commands.xml index ef750cc..67c9365 100644 --- a/doc/yaz-client-commands.xml +++ b/doc/yaz-client-commands.xml @@ -1,5 +1,5 @@ @@ -190,8 +190,7 @@ Sets the limit for when no records should be returned together with the search result. See the - + Z39.50 standard for more details. @@ -206,8 +205,7 @@ Sets the limit for when all records should be returned with the search result. See the - + Z39.50 standard for more details. @@ -222,8 +220,7 @@ number of records in the result set is between the values of lslb and ssub. See the - + Z39.50 standard for more details. @@ -262,8 +259,7 @@ Sets the preferred transfer syntax for retrieved records. yaz-client supports all the record syntaxes that currently are registered. See - + Z39.50 Standard for more details. Commonly used records syntaxes include usmarc, @@ -710,17 +706,8 @@ - diff --git a/doc/yaz-client-man.xml b/doc/yaz-client-man.xml index 16be2f6..9c7d571 100644 --- a/doc/yaz-client-man.xml +++ b/doc/yaz-client-man.xml @@ -1,9 +1,82 @@ - - %common; - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ]> - + @@ -144,7 +217,722 @@ The YAZ client accepts the following commands. - &yaz-client-commands; + + + + + open zurl + + + Opens a connection to a server. The syntax for + zurl is the same as described + above for connecting from the command line. + + + Syntax: + + + [(tcp|ssl|unix|http)':']host + [:port][/base] + + + + + quit + + + Quits YAZ client + + + + find query + + Sends a Search Request using the query + given. By default the query is assumed to be PQF. See command + querytype. + + + + + delete setname + + Deletes result set with name setname + on the server. + + + + base base1 + base2 ... + + + Sets the name(s) of the database(s) to search. One or more + databases may be specified separated by blanks. This commands overrides + the database given in zurl. + + + + + show + [start[+number]] + + + Fetches records by sending a Present Request from the start + position given by + start + a number of records given by number. If + start is not given, then the client + will fetch from position of the last retrieved record plus 1. If + number is not given, then one record will + be fetched at a time. + + + + + scan term + + + Scans + database index for a term. The syntax resembles the syntax + for find. + If you want to scan for the word water you could + write + + + scan water + + + but if you want to scan only in, say the title field, you would write + + + scan @attr 1=4 water + + + + + scanpos pos + + + + Sets preferred position for scan. This value + is used in next scan. By default position is 1. + + + + + scansize size + + + + Sets number of entries to be returned by scan. Default + number of entries is 20. + + + + + scanstep step + + + + Set step-size for scan. This value is used in next scan + sent to the target. By default step-size is 0. + + + + + sort sortspecs + + + Sorts a result set. The sort command takes a + sequence of space-separated sort specifications, with each sort + specification consisting of two space-separated words (so that the + whole specification list is made up of an even number of words). + The first word of each specification + holds a field (sort criterion) and the second holds flags. + If the sort criterion includes = it is assumed + that the SortKey is of type + sortAttributes using Bib-1: in this case + the integer before = is + the attribute type and the integer following = + is the attribute value. + If no = is in the criterion it is treated as a + sortfield of type InternationalString. + The flags word of each sort specification must consist of + s + for case sensitive or i for case insensitive, and + < for ascending order or > + for descending order. + + + + + sort+ + + + Same as sort but stores the sorted + result set in a new result set. + + + + + authentication openauth + + + Sets up a authentication string if a server requires + authentication (v2 OpenStyle). The authentication string is first + sent to the server when the + open command is + issued and the Z39.50 Initialize Request is sent, so this command + must be used before open in order to be effective. + A common convention for the authopen string + is that the username - and password is separated by a slash, e.g. + myusername/mysecret. + + + + + + list_all + + + This command displays status and values for many settings. + + + + + + lslb n + + + Sets the limit for when no records should be returned + together with the search result. + See the + + Z39.50 standard + + for more details. + + + + + + ssub n + + + Sets the limit for when all records should be returned with + the search result. + See the + + Z39.50 standard + for more details. + + + + + + mspn n + + + Sets the number of records should be returned if the + number of records in the result set is between the values of + lslb and ssub. + See the + + Z39.50 standard + + for more details. + + + + + status + + + Displays the values of lslb, + ssub and mspn. + + + + + setname + + + Switches named result sets on and off. Default is on. + + + + + cancel + + + Sends a Trigger Resource Control Request to the target. + + + + + format oid + + + Sets the preferred transfer syntax for retrieved records. + yaz-client supports all the record syntaxes that currently + are registered. See + + Z39.50 Standard + + for more details. Commonly used records syntaxes include usmarc, + sutrs, grs1 and xml. + + + + + elements e + + + Sets the element set name for the records. Many targets support + element sets are B (for brief) and F (for full). + + + + + close + + + Sends a Z39.50 Close APDU and closes connection with the peer + + + + + querytype type + + + Sets the query type as used by command + find. + The following is supported: + prefix for + Prefix Query Notation (Type-1 Query); + ccl for CCL search (Type-2 Query), + cql for CQL (Type-104 search with CQL OID), + ccl2rpn for + CCL to RPN conversion (Type-1 Query). + cql2rpn for + CQL to RPN conversion (Type-1 Query). + + + + + attributeset set + + + + Sets attribute set OID for prefix queries (RPN, Type-1). + + + + + refid id + + + Sets reference ID for Z39.50 Request(s). + + + + + itemorder + type no + + + Sends an Item Order Request using the ILL External. + type is either 1 or 2 which corresponds to + ILL-Profile 1 and 2 respectively. The no + is the Result Set position of the record to be ordered. + + + + + update + action + recid + doc + + + Sends Item Update Request. The action + argument must be the action type: one of insert, + replace, delete and + update. The second argument, + recid, is the + record identifier (any string). Third argument which is optional is + the record document for the request. If doc is a quoted string + (double quotes) the string content is used verbatim. If doc is not + a quoted string, it is assumed to be a filename which is read, then + sent as the docuemnt content. If doc is omitted, the last received + record (as parf of present response or piggybacked search response) + is used for the update. + + + + + + . + filename + + + Executes list of commands from + file filename, just like source on + most UNIX shells. + + + + + + ! + args + + + Executes command args in subshell + using the system call. + + + + + + push_command + command + + + The push_command takes another command as its argument. + That command is then added to the history information (so + you can retrieve it later). The command itself is not + executed. This command only works if you have GNU readline/history + enabled. + + + + + + set_apdufile + filename + + + Sets that APDU should be logged to file + filename. Another way to achieve + APDU log is by using command-line option -a. + + + + + + set_auto_reconnect + flag + + + Specifies whether YAZ client automatically reconnect if + target closes connection (Z39.50 only). + + + flag must be either + on or off. + + + + + + set_auto_wait + flag + + + Specifies whether YAZ client should wait for + response protocol packages after a request. + By default YAZ client waits (on) for response packages immediately + after a command (find, show) has been issued. If off + is used, YAZ client does not attempt to receive packages automatically. + These will have to be manually received when command + + wait_response + is used. + + + flag must be either + on or off. + + + + + + set_marcdump + filename + + + Specifies that all retrieved records should be appended to + file filename. This command does the + thing as option -m. + + + + + + schema + schemaid + + + Specifies schema for retrieval. + Schema may be specified as an OID for Z39.50. + For SRW, schema is a simple string URI. + + + + + + charset + negotiationcharset + [displaycharset] + [[marccharset]] + + + Specifies character set (encoding) for Z39.50 + negotiation / SRW encoding and/or character set for output (terminal). + + + negotiationcharset is the name + of the character set to be negotiated by the server. The special name + - for negotiationcharset + specifies no character set to be negotiated. + + + If displaycharset is given, it specifies name + of the character set of the output (on the terminal on which + YAZ client is running). To disable conversion of characters + to the output encoding, the special name - (dash) + can be used. + If the special name auto is given, YAZ client will + convert strings to the encoding of the + terminal as returned by nl_langinfo call. + + + If marcharset is given, it specifies name + of the character set of retrieved MARC records from server. See + also marcharset command. + + + + Since character set negotation takes effect in the Z39.50 + Initialize Request you should issue this command before + command open + is used. + + + + + MARC records are not covered by Z39.50 character set negotiation, + so that's why there is a separate character that must be known + in order to do meaningful converson(s). + + + + + + + negcharset + charset + + + Specifies character set for negotiation (Z39.50). The + argument is the same as second argument for command + charset. + + + + + + displaycharset + charset + + + Specifies character set for output (display). The + argument is the same as second argument for command + charset. + + + + + + marccharset + charset + + + Specifies character set for retrieved MARC records so + that YAZ client can display them in a character suitable + for your display. See charset command. + If auto is given, YAZ will assume + that MARC21/USMARC is using MARC8/UTF8 and ISO-8859-1 + for all other MARC variants. The charset argument is the + same as third argument for command + charset. + + + + + + set_cclfile + filename + + + Specifies that CCL fields should be read from file + file filename. This command does the + thing as option -c. + + + + + + set_cqlfile + filename + + + Specifies that CQL fields should be read from file + file filename. This command does the + thing as option -q. + + + + + + register_oid + name + class + OID + + + This command allows you to register your own object + identifier - so that instead of entering a long dot-notation + you can use a short name instead. + The name is your + name for the OID, class is the + class, and OID is the raw OID in + dot notation. Class is one appctx, + absyn, attet, + transyn, diagset, + recsyn, resform, + accform, extserv, + userinfo, elemspec, + varset, schema, + tagset, general. + If you're in doubt use the general + class. + + + + + + register_tab + command + string + + + This command registers a TAB completion string for + the command given. + + + + + + sleep + seconds + + + This command makes YAZ client sleep (be idle) for + the number of seconds given. + + + + + + wait_response + [ number] + + + This command makes YAZ client wait for a number of + response packages from target. If number is + omitted, 1 is assumed. + + This command is rarely used and is only useful if command + + set_auto_wait + is set to off. + + + + + + xmles + OID + doc + + + Sends XML Extended Services request using the OID and doc given. + + + + + + zversion + ver + + + This command sets Z39.50 version for negotiation. + Should be used before + open. + By default 3 (version 3) is used. + + + + + + options + op1 op2.. + + + This command sets Z39.50 options for negotiation. + Should be used before + open. + + + The following options are supported: + search, + present, + delSet, + resourceReport, + triggerResourceCtrl, + resourceCtrl, + accessCtrl, + scan, + sort, + extendedServices, + level_1Segmentation, + level_2Segmentation, + concurrentOperations, + namedResultSets, + encapsulation, + resultCount, + negotiationModel, + duplicationDetection, + queryType104, + pQESCorrection, + stringSchema. + + + + + + + + FILES @@ -178,18 +966,8 @@ - - diff --git a/doc/yaz-config-man.xml b/doc/yaz-config-man.xml index 9e767c1..9cf88be 100644 --- a/doc/yaz-config-man.xml +++ b/doc/yaz-config-man.xml @@ -1,5 +1,7 @@ - - + + yaz-config @@ -115,17 +117,9 @@ - + diff --git a/doc/yaz-iconv-man.xml b/doc/yaz-iconv-man.xml index 502f846..dc0f3c4 100644 --- a/doc/yaz-iconv-man.xml +++ b/doc/yaz-iconv-man.xml @@ -1,5 +1,7 @@ - - + + yaz-iconv @@ -94,17 +96,9 @@ - + diff --git a/doc/yaz-log-man.xml b/doc/yaz-log-man.xml index cabd73d..5f98ee4 100644 --- a/doc/yaz-log-man.xml +++ b/doc/yaz-log-man.xml @@ -1,5 +1,7 @@ - - + + yaz-log @@ -223,17 +225,9 @@ - + diff --git a/doc/yaz-man.xml b/doc/yaz-man.xml index 5d3cb1b..bd19ead 100644 --- a/doc/yaz-man.xml +++ b/doc/yaz-man.xml @@ -1,8 +1,81 @@ - - %common; + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ]> - + yaz @@ -87,25 +160,15 @@ prefix/share/doc/yaz) - YAZ home page. + YAZ home page. - Z39.50 Maintenance Agency Page. + Z39.50 Maintenance Agency Page. - - diff --git a/doc/yaz-marcdump-man.xml b/doc/yaz-marcdump-man.xml index 257b0b1..96ed95b 100644 --- a/doc/yaz-marcdump-man.xml +++ b/doc/yaz-marcdump-man.xml @@ -1,5 +1,7 @@ - - + + yaz-marcdump @@ -154,17 +156,9 @@ - + diff --git a/doc/yaz-ztest-man.xml b/doc/yaz-ztest-man.xml index 0007b2b..d8f5fad 100644 --- a/doc/yaz-ztest-man.xml +++ b/doc/yaz-ztest-man.xml @@ -1,11 +1,12 @@ - - - - - + + + + + ]> - + @@ -19,7 +20,40 @@ - &gfs-synopsis; + + + + yaz-ztest + + + + + + + + + + + + + + + + + listener-spec + + + + + DESCRIPTION @@ -47,10 +81,434 @@ OPTIONS - &gfs-options; + + + + + -a + file + + 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 + + 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 + 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 + This specifies an XML file that describes + one or more YAZ frontend virtual servers. + + + -C + fname + Sets SSL certificate file name for server (PEM). + + + -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 + + 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. + + + + -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(). + + + + + + + VIRTUAL HOSTS - &gfs-virtual; + + + + The Virtual hosts mechanism allows a YAZ frontend server to + support multiple backends. A backend is selected on the basis of + the TCP/IP binding (port+listening adddress) and/or the virtual host. + + + A backend can be configured to execute in a particular working + directory. Or the YAZ frontend may perform CQL to RPN conversion, thus + allowing traditional Z39.50 backends to be offered as a SRW/SRU + service. SRW/SRU Explain information for a particular backend may also + be specified. + + + For the HTTP protocol, the virtual host is specified in the Host header. + For the Z39.50 protocol, the virtual host is specified as in the + Initialize Request in the OtherInfo, OID 1.2.840.10003.10.1000.81.1. + + + + Not all Z39.50 clients allows the VHOST information to be set. + For those the selection of the backend must rely on the + TCP/IP information alone (port and address). + + + + The YAZ frontend server uses XML to describe the backend + configurations. Command-line option -f + specifies filename of the XML configuration. + + + The configuration uses the root element yazgfs. + This element includes a list of listen elements, + followed by one or more server elements. + + + The listen describes listener (transport end point), + such as TCP/IP, Unix file socket or SSL server. Content for + a listener: + + CDATA (required) + + + The CDATA for the listen element holds the + listener string, such as tcp:@:210, + tcp:server1:2100, + etc. + + + + attribute id (optional) + + + identifier for this listener. This may be referred to from + server sections. + + + + + + + We expect more information to be added for the listen section in + a future version, such as CERT file for SSL servers. + + + + + The server describes a server and the parameters + for this server type. Content for a server: + + attribute id (optional) + + + Identifier for this server. Currently not used for anything, + but it might be for logging purposes. + + + + + attribute listenref (optional) + + + Specifies listener for this server. If this attribute is not + given, the server is accessible from all listener. In order + for the server to be used for real, howeever, the virtual host + must match (if specified in the configuration). + + + + + element config (optional) + + + Specifies the server configuration. This is equivalent + to the config specified using command line option + -c. + + + + + element directory (optional) + + + Specifies a working directory for this backend server. If + specifid, the YAZ fronend changes current working directory + to this directory whenever a backend of this type is + started (backend handler bend_start), stopped (backend handler hand_stop) + and initialized (bend_init). + + + + + element host (optional) + + + Specifies the virtual host for this server. If this is specified + a client must specify this host string in + order to use this backend. + + + + + element cql2rpn (optional) + + + Specifies a filename that includes CQL to RPN conversion for this + backend server. See section "Specifiction of CQL to RPN mappings" + If given, the backend server will only "see" a Type-1/RPN query. + + + + + element stylesheet (optional) + + + Specifies the stylesheet reference to be part of SRU HTTP responses + when the client does not specify one. If neither this is given, nor + the client specifies one, no stylesheet reference is part of the + SRU HTTP response. + + + + + element docpath (optional) + + + Specifies a path for local file access using HTTP. All URLs with + a leading prefix (/ exluded) that matches the value of docpath + are used for file access. For example, if the server is to offer + access in directory xsl, the docpath would be + xsl and all URLs of the form + http://host/exl will result in a local file access. + + + + + element explain (optional) + + + Specifies SRW/SRU ZeeRex content for this server. Copied verbatim + to the client. As things are now, some of the Explain content + seeem redundant because host information, etc. is also stored + elsewhere. + + + + + + + + The XML below configures a server that accepts connections from + two ports, TCP/IP port 9900 and a local UNIX file socket. + We name the TCP/IP server public and the + other server internal. + + + + tcp:@:9900 + unix:/var/tmp/socket + + server1.mydomain + /var/www/s1 + config.cfg + + + server2.mydomain + /var/www/s2 + config.cfg + ../etc/pqf.properties + + + server2.mydomain + 9900 + a + + + + + /var/www/s3 + config.cfg + + +]]> + + + There are three configured backend servers. The first two + servers, "server1" and "server2", + can be reached by both listener addresses - since + no listenref attribute is specified. + In order to distinguish between the two a virtual host has + been specified for each of server in the host + elements. + + + For "server2" elements for CQL to RPN conversion + is supported and explain information has been added (a short one here + to keep the example small). + + + The third server, "server3" can only be reached + via listener "internal". + + + + + FILES @@ -71,18 +529,8 @@ - - diff --git a/doc/zoom.xml b/doc/zoom.xml index f73f321..122ce58 100644 --- a/doc/zoom.xml +++ b/doc/zoom.xml @@ -20,7 +20,7 @@ ZOOM_options_set_int(opt, name, value) ZOOM_connection_scan1 (ZOOM_connection c, ZOOM_query startterm) ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn) --> - + ZOOM &zoom; is an acronym for 'Z39.50 Object-Orientation Model' and is @@ -1324,18 +1324,10 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn) - + + diff --git a/doc/zoomsh-man.xml b/doc/zoomsh-man.xml index 995c323..9d468b4 100644 --- a/doc/zoomsh-man.xml +++ b/doc/zoomsh-man.xml @@ -1,7 +1,8 @@ - + ]> - + @@ -145,18 +146,8 @@ ZOOM>quit - - -- 1.7.10.4