X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Fyaz-client-commands.xml;h=fd98374e342681be6714828403d1c7710fe6c0b3;hp=b368b6c48d13471c29298eddb7dd80f74e39281e;hb=7a870687ef78606cd134e82fd9085722efe3c979;hpb=bbee0df765624f1596f9063d7284dc8874c66056 diff --git a/doc/yaz-client-commands.xml b/doc/yaz-client-commands.xml index b368b6c..fd98374 100644 --- a/doc/yaz-client-commands.xml +++ b/doc/yaz-client-commands.xml @@ -1,10 +1,10 @@ - + open zurl @@ -28,11 +28,12 @@ Quits YAZ client - - f query + + find query Sends a Search Request using the query - given. + given. By default the query is assumed to be PQF. See command + querytype. @@ -76,7 +77,7 @@ Scans database index for a term. The syntax resembles the syntax - for find. + for find. If you want to scan for the word water you could write @@ -102,6 +103,16 @@ + scansize size + + + + Sets number of entries to be returned by scan. Default + number of entries is 20. + + + + scanstep step @@ -147,7 +158,8 @@ 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 + 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 @@ -271,11 +283,12 @@ - + querytype type - Sets the query type as used by command find. + Sets the query type as used by command + find. The following is supported: prefix for Prefix Query Notation (Type-1 Query); @@ -319,13 +332,23 @@ 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 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. @@ -354,7 +377,7 @@ - push_commande + push_command command @@ -373,8 +396,8 @@ Sets that APDU should be logged to file - filename. This command does the - thing as option -a. + filename. Another way to achieve + APDU log is by using command-line option -a. @@ -386,18 +409,42 @@ 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 ot + Specifies that all retrieved records should be appended to file filename. This command does the thing as option -m. @@ -416,7 +463,7 @@ - + charset negotiationcharset [displaycharset] @@ -451,7 +498,8 @@ Since character set negotation takes effect in the Z39.50 Initialize Request you should issue this command before - command open is used. + command open + is used. @@ -471,7 +519,7 @@ Specifies character set for negotiation (Z39.50). The argument is the same as second argument for command - charset. + charset. @@ -482,8 +530,8 @@ Specifies character set for output (display). The - argument is the same as second argument for - command charset. + argument is the same as second argument for command + charset. @@ -499,7 +547,8 @@ 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 charset command. + same as third argument for command + charset. @@ -577,15 +626,45 @@ - + + + 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 + doc + + + Sends XML Extended Services request using the doc given. + This is a privately defined Extended Service using OID + 1.2.840.10003.9.1000.105.4. + + + + zversion ver This command sets Z39.50 version for negotiation. - Should be used before open. - By default, 3 (version 3) is used. + Should be used before + open. + By default 3 (version 3) is used. @@ -596,7 +675,8 @@ This command sets Z39.50 options for negotiation. - Should be used before open. + Should be used before + open. The following options are supported: