X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fyaz-client-commands.xml;h=09f7dfce345fcd51d3ca5baafd9c56fae62f1e5d;hb=3e842bc7f9d59df80805e96913bc7076d824f848;hp=1c21bc585bbb9bbdc6c03229593b845f5c6c74d5;hpb=5b9a39fc00ab0969ff020f05c51c5d336e00d762;p=yaz-moved-to-github.git
diff --git a/doc/yaz-client-commands.xml b/doc/yaz-client-commands.xml
index 1c21bc5..09f7dfc 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 @@
+ setscansetterm
+
+
+ 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.
+
+
+
+ scanpospos
@@ -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.
@@ -170,6 +183,19 @@
+ srumethodversion
+
+
+ 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
@@ -186,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.
@@ -202,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.
@@ -218,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.
@@ -258,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,
@@ -343,24 +369,25 @@
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.
- .
+ sourcefilenameExecutes 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.
@@ -458,7 +485,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.
@@ -471,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
@@ -506,7 +533,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).
@@ -554,6 +581,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_cclfilefilename