X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Fyaz-client-commands.xml;h=8470c338eba7204967e1003d8ad55912dabc082a;hp=748cd90deee39575a2fc500269863314806bafa3;hb=95d8bd04e10519a635972a24176270ef4dbe8d2c;hpb=4fa314498f1528ed66674ada044076a2ba75e815 diff --git a/doc/yaz-client-commands.xml b/doc/yaz-client-commands.xml index 748cd90..8470c33 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 @@ -116,19 +127,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. @@ -147,7 +163,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 @@ -156,6 +173,16 @@ + + + list_all + + + This command displays status and values for many settings. + + + + lslb n @@ -164,7 +191,7 @@ together with the search result. See the + url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6"> Z39.50 standard for more details. @@ -180,7 +207,7 @@ the search result. See the + url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6"> Z39.50 standard for more details. @@ -196,7 +223,7 @@ lslb and ssub. See the + url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6"> Z39.50 standard for more details. @@ -236,7 +263,7 @@ yaz-client supports all the record syntaxes that currently are registered. See + url="http://www.loc.gov/z3950/agency/defns/oids.html#5"> Z39.50 Standard for more details. Commonly used records syntaxes include usmarc, @@ -261,11 +288,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); @@ -309,13 +337,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. @@ -344,7 +382,7 @@ - push_commande + push_command command @@ -363,8 +401,45 @@ 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. + + + + + + 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. @@ -374,7 +449,7 @@ 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. @@ -393,10 +468,11 @@ - + charset negotiationcharset - [outputcharset] + [displaycharset] + [[marccharset]] Specifies character set (encoding) for Z39.50 @@ -409,7 +485,7 @@ specifies no character set to be negotiated. - If outputcharset is given, it specifies name + 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) @@ -418,23 +494,54 @@ 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. + command open + is used. - MARC records are not covered by Z39.50 character set negotiation. - See marccharset. + 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 @@ -444,13 +551,15 @@ 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. + for all other MARC variants. The charset argument is the + same as third argument for command + charset. - set_cclfields + set_cclfile filename @@ -462,7 +571,7 @@ - set_cqlfields + set_cqlfile filename @@ -499,6 +608,106 @@ + + + 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. + + +