X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fyaz-client-commands.xml;h=4865a4d045bca5312d9d5c148a177c5a4cfb8f80;hb=c1264a20ea15e9383d72063fa3c41e16afb611a8;hp=d96e56cabcb3285749d61f5ce12643199ac8a3c5;hpb=ff9c21a4a93db3d49140602e6b8bdc062bde4153;p=yaz-moved-to-github.git diff --git a/doc/yaz-client-commands.xml b/doc/yaz-client-commands.xml index d96e56c..4865a4d 100644 --- a/doc/yaz-client-commands.xml +++ b/doc/yaz-client-commands.xml @@ -1,5 +1,4 @@ - @@ -33,7 +32,7 @@ Sends a Search Request using the query given. By default the query is assumed to be PQF. See command - querytype. + querytype for more information. @@ -93,6 +92,15 @@ + setscan set term + + + Scans database index for a term within a result set. This + is similar to the scan command but has a result set as its first argument. + + + + scanpos pos @@ -127,19 +135,24 @@ Sorts a result set. The sort command takes a - sequence of sort specifications. A sort - specification holds a field (sort criteria) and is followed by flags. - If the sort criteria includes = it is assumed - that the sort SortKey is of type sortAttributes using Bib-1. - The integer before = is + 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 SortKey it is treated as a - sortfield-type of type InternationalString. - Flags observed are: s - for case sensitive, i for case insensitive, - < for sort ascending and > - for sort descending. + 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. @@ -158,7 +171,7 @@ Sets up a authentication string if a server requires authentication (v2 OpenStyle). The authentication string is first - sent to the server when the + 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. @@ -170,6 +183,21 @@ + sru method version + + + Selects Web Service method and version. + Must be one of POST, + GET, SOAP (default) + or SOLR. Version + should be either 1.1 or 1.2 for SRU. Other versions are allowed - for testing + purposes (version negotiation with SRU server). + The version is currently not used for SOLR Web Services + + + + + list_all @@ -177,7 +205,7 @@ - + lslb n @@ -186,8 +214,8 @@ together with the search result. See the - Z39.50 standard + url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6"> + Z39.50 standard on set bounds for more details. @@ -202,13 +230,13 @@ the search result. See the - Z39.50 standard + url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6"> + Z39.50 standard on set bounds for more details. - + mspn n @@ -218,8 +246,8 @@ lslb and ssub. See the - Z39.50 standard + url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6"> + Z39.50 standard on set bounds for more details. @@ -258,11 +286,11 @@ yaz-client supports all the record syntaxes that currently are registered. See - Z39.50 Standard + url="http://www.loc.gov/z3950/agency/defns/oids.html#5"> + Z39.50 Record Syntax Identifiers for more details. Commonly used records syntaxes include usmarc, - sutrs, grs1 and xml. + sutrs and xml. @@ -287,7 +315,7 @@ querytype type - Sets the query type as used by command + Sets the query type as used by command find. The following is supported: prefix for @@ -323,7 +351,7 @@ type no - Sends an Item Order Request using the ILL External. + 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. @@ -332,25 +360,36 @@ update + action + recid + doc - Sends Item Update Request. This command sends a "minimal" - PDU Update to the target supplying the last received record from - the target. - If no record has been received from the target this command is ignored - and nothing is sent to the target. + 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 preceded with + "<", then the following characters are treated as a filename + with the records to be updated. Otherwise doc is treated as + a document itself. The doc may also be quited in double quotes. + If doc is omitted, the last received record (as part of present + response or piggybacked search response) is used for the update. - . + source filename Executes list of commands from file filename, just like source on - most UNIX shells. + most UNIX shells. A single dot (.) can be used + as an alternative. @@ -417,7 +456,7 @@ 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 + These will have to be manually received when command wait_response is used. @@ -448,7 +487,7 @@ Specifies schema for retrieval. Schema may be specified as an OID for Z39.50. - For SRW, schema is a simple string URI. + For SRU, schema is a simple string URI. @@ -461,7 +500,7 @@ Specifies character set (encoding) for Z39.50 - negotiation / SRW encoding and/or character set for output (terminal). + negotiation / SRU encoding and/or character set for output (terminal). negotiationcharset is the name @@ -486,7 +525,7 @@ - Since character set negotation takes effect in the Z39.50 + Since character set negotiation takes effect in the Z39.50 Initialize Request you should issue this command before command open is used. @@ -496,7 +535,7 @@ 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). + in order to do meaningful conversion(s). @@ -520,7 +559,7 @@ Specifies character set for output (display). The - argument is the same as second argument for command + argument is the same as second argument for command charset. @@ -544,6 +583,19 @@ + querycharset + charset + + + Specifies character set for query terms for Z39.50 RPN + queries and Z39.50 Scan Requests (termListAndStartPoint). + This is a pure client-side conversion which converts from + displayCharset to queryCharset. + + + + + set_cclfile filename @@ -623,8 +675,8 @@ This command makes YAZ client wait for a number of - response packages from target. If number is - omitted, 1 is assumed. + response packages from target. If number is + omitted, 1 is assumed. This command is rarely used and is only useful if command @@ -634,13 +686,24 @@ + + 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 + This command sets Z39.50 version for negotiation. + Should be used before open. By default 3 (version 3) is used. @@ -652,37 +715,37 @@ op1 op2.. - This command sets Z39.50 options for negotiation. - Should be used before + 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, + search, + present, + delSet, + resourceReport, + triggerResourceCtrl, + resourceCtrl, + accessCtrl, + scan, + sort, + extendedServices, + level_1Segmentation, + level_2Segmentation, + concurrentOperations, + namedResultSets, + encapsulation, + resultCount, + negotiationModel, + duplicationDetection, + queryType104, + pQESCorrection, stringSchema. - +