X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Fyaz-client-commands.xml;h=4865a4d045bca5312d9d5c148a177c5a4cfb8f80;hp=64a25f0f62fad8ad4bb30f39f2296ca67f6f9a45;hb=c1264a20ea15e9383d72063fa3c41e16afb611a8;hpb=0c4bd81e2e56724de1adbbc753f812328fb20e3c diff --git a/doc/yaz-client-commands.xml b/doc/yaz-client-commands.xml index 64a25f0..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. @@ -150,7 +149,7 @@ 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 + s for case sensitive or i for case insensitive, and < for ascending order or > for descending order. @@ -172,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. @@ -187,11 +186,13 @@ sru method version - Selects SRU method and version. + Selects Web Service method and version. Must be one of POST, - GET, SOAP (default). Version - should be either 1.1 or 1.2. Other versions are allowed - for testing + 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 @@ -204,7 +205,7 @@ - + lslb n @@ -214,7 +215,7 @@ See the - Z39.50 standard + Z39.50 standard on set bounds for more details. @@ -230,12 +231,12 @@ See the - Z39.50 standard + Z39.50 standard on set bounds for more details. - + mspn n @@ -246,7 +247,7 @@ See the - Z39.50 standard + Z39.50 standard on set bounds for more details. @@ -286,10 +287,10 @@ are registered. See - Z39.50 Standard + Z39.50 Record Syntax Identifiers for more details. Commonly used records syntaxes include usmarc, - sutrs, grs1 and xml. + sutrs and xml. @@ -314,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 @@ -350,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. @@ -367,15 +368,15 @@ Sends Item Update Request. The action argument must be the action type: one of insert, replace, delete and - update. The second argument, + 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. + 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. @@ -455,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. @@ -524,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. @@ -534,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). @@ -558,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. @@ -593,7 +594,7 @@ - + set_cclfile filename @@ -675,7 +676,7 @@ This command makes YAZ client wait for a number of response packages from target. If number is - omitted, 1 is assumed. + omitted, 1 is assumed. This command is rarely used and is only useful if command @@ -701,8 +702,8 @@ 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. @@ -714,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. - +