X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Fyaz-client-commands.xml;h=09f7dfce345fcd51d3ca5baafd9c56fae62f1e5d;hp=b368b6c48d13471c29298eddb7dd80f74e39281e;hb=950a4ac3bd94072bb5cf880f0f411bb2c8dc80bd;hpb=bbee0df765624f1596f9063d7284dc8874c66056 diff --git a/doc/yaz-client-commands.xml b/doc/yaz-client-commands.xml index b368b6c..09f7dfc 100644 --- a/doc/yaz-client-commands.xml +++ b/doc/yaz-client-commands.xml @@ -1,10 +1,9 @@ - + open zurl @@ -28,11 +27,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 for more information. @@ -76,7 +76,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 @@ -92,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 @@ -102,6 +111,16 @@ + scansize size + + + + Sets number of entries to be returned by scan. Default + number of entries is 20. + + + + scanstep step @@ -116,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. @@ -147,7 +171,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 @@ -158,6 +183,19 @@ + sru method version + + + Selects SRU 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 + purposes (version negotiation with SRU server). + + + + + list_all @@ -174,7 +212,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. @@ -190,7 +228,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. @@ -206,7 +244,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. @@ -246,7 +284,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, @@ -271,11 +309,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,25 +358,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. @@ -354,7 +404,7 @@ - push_commande + push_command command @@ -373,8 +423,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 +436,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. @@ -411,12 +485,12 @@ 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. - + charset negotiationcharset [displaycharset] @@ -424,7 +498,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 @@ -451,14 +525,15 @@ 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, 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). @@ -471,7 +546,7 @@ Specifies character set for negotiation (Z39.50). The argument is the same as second argument for command - charset. + charset. @@ -482,8 +557,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,12 +574,26 @@ 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. + 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 @@ -577,15 +666,44 @@ - + + + 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. + Should be used before + open. + By default 3 (version 3) is used. @@ -596,7 +714,8 @@ This command sets Z39.50 options for negotiation. - Should be used before open. + Should be used before + open. The following options are supported: