-<!--
- $Id: yaz-client-commands.xml,v 1.10 2005-06-23 13:09:42 adam Exp $
+<!--
Commands for YAZ client.
Included in both manual and man page for yaz-client.
-->
<listitem>
<para>Sends a Search Request using the <replaceable>query</replaceable>
given. By default the query is assumed to be PQF. See command
- <link linkend="command-querytype"><literal>querytype</literal></link>.
+ <link linkend="command-querytype">querytype</link> for more information.
</para>
</listitem>
</varlistentry>
</listitem>
</varlistentry>
<varlistentry><term>
+ <literal>setscan</literal> <replaceable>set</replaceable> <replaceable>term</replaceable>
+ </term>
+ <listitem>
+ <simpara>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.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry><term>
<literal>scanpos</literal> <replaceable>pos</replaceable>
</term>
<listitem>
</term>
<listitem>
<para>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 <literal>=</literal> it is assumed
- that the sort SortKey is of type sortAttributes using Bib-1.
- The integer before <literal>=</literal> 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 <literal>=</literal> it is assumed
+ that the <literal>SortKey</literal> is of type
+ <literal>sortAttributes</literal> using Bib-1: in this case
+ the integer before <literal>=</literal> is
the attribute type and the integer following <literal>=</literal>
is the attribute value.
- If no <literal>=</literal> is in the SortKey it is treated as a
- sortfield-type of type InternationalString.
- Flags observed are: <literal>s</literal>
- for case sensitive, <literal>i</literal> for case insensitive,
- <literal><</literal> for sort ascending and <literal>></literal>
- for sort descending.
+ If no <literal>=</literal> is in the criterion it is treated as a
+ sortfield of type InternationalString.
+ The flags word of each sort specification must consist of
+ <literal>s</literal>
+ for case sensitive or <literal>i</literal> for case insensitive, and
+ <literal><</literal> for ascending order or <literal>></literal>
+ for descending order.
</para>
</listitem>
</varlistentry>
<listitem>
<para>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
<link linkend="command-open"><literal>open</literal></link> command is
issued and the Z39.50 Initialize Request is sent, so this command
must be used before <literal>open</literal> in order to be effective.
</varlistentry>
<varlistentry><term>
+ <literal>sru</literal> <replaceable>method</replaceable> <replaceable>version</replaceable>
+ </term>
+ <listitem>
+ <para>Selects Web Service method and version.
+ Must be one of <literal>POST</literal>,
+ <literal>GET</literal>, <literal>SOAP</literal> (default)
+ or <literal>SOLR</literal>. 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
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry><term>
<literal>list_all</literal>
</term>
<listitem>
</para>
</listitem>
</varlistentry>
-
+
<varlistentry><term>
<literal>lslb</literal> <replaceable>n</replaceable>
</term>
together with the search result.
See the
<ulink
- url="http://lcweb.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
- Z39.50 standard
+ url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
+ Z39.50 standard on set bounds
</ulink>
for more details.
</para>
the search result.
See the
<ulink
- url="http://lcweb.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
- Z39.50 standard
+ url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
+ Z39.50 standard on set bounds
</ulink> for more details.
</para>
</listitem>
</varlistentry>
-
+
<varlistentry><term>
<literal>mspn</literal> <replaceable>n</replaceable>
</term>
<literal>lslb</literal> and <literal>ssub</literal>.
See the
<ulink
- url="http://lcweb.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
- Z39.50 standard
+ url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
+ Z39.50 standard on set bounds
</ulink>
for more details.
</para>
yaz-client supports all the record syntaxes that currently
are registered. See
<ulink
- url="http://lcweb.loc.gov/z3950/agency/defns/oids.html#5">
- Z39.50 Standard
+ url="http://www.loc.gov/z3950/agency/defns/oids.html#5">
+ Z39.50 Record Syntax Identifiers
</ulink>
for more details. Commonly used records syntaxes include usmarc,
- sutrs, grs1 and xml.
+ sutrs and xml.
</para>
</listitem>
</varlistentry>
<literal>querytype</literal> <replaceable>type</replaceable>
</term>
<listitem>
- <para>Sets the query type as used by command
+ <para>Sets the query type as used by command
<link linkend="command-find"><literal>find</literal></link>.
The following is supported:
<literal>prefix</literal> for
<replaceable>type</replaceable> <replaceable>no</replaceable>
</term>
<listitem>
- <para>Sends an Item Order Request using the ILL External.
+ <para>Sends an Item Order Request using the ILL External.
<replaceable>type</replaceable> is either 1 or 2 which corresponds to
ILL-Profile 1 and 2 respectively. The <replaceable>no</replaceable>
is the Result Set position of the record to be ordered.
<para>Sends Item Update Request. The <replaceable>action</replaceable>
argument must be the action type: one of <literal>insert</literal>,
<literal>replace</literal>, <literal>delete</literal> and
- <literal>update</literal>. The second argument,
+ <literal>update</literal>. The second argument,
<replaceable>recid</replaceable>, 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.
</para>
</listitem>
</varlistentry>
<varlistentry><term>
- <literal>.</literal>
+ <literal>source</literal>
<replaceable>filename</replaceable>
</term>
<listitem>
<para>Executes list of commands from
file <replaceable>filename</replaceable>, just like source on
- most UNIX shells.
+ most UNIX shells. A single dot (<literal>.</literal>) can be used
+ as an alternative.
</para>
</listitem>
</varlistentry>
By default YAZ client waits (on) for response packages immediately
after a command (find, show) has been issued. If <literal>off</literal>
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
<link linkend="command-wait-response">
<literal>wait_response</literal>
</link> is used.
<listitem>
<para>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.
</para>
</listitem>
</varlistentry>
</term>
<listitem>
<para>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).
</para>
<para>
<replaceable>negotiationcharset</replaceable> is the name
</para>
<note>
<para>
- 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 <link linkend="command-open"><literal>open</literal></link>
is used.
<para>
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).
</para>
</note>
</listitem>
</term>
<listitem>
<para>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
<link linkend="command-charset"><literal>charset</literal></link>.
</para>
</listitem>
</varlistentry>
<varlistentry><term>
+ <literal>querycharset</literal>
+ <replaceable>charset</replaceable>
+ </term>
+ <listitem>
+ <para>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.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry><term>
<literal>set_cclfile</literal>
<replaceable>filename</replaceable>
</term>
<listitem>
<para>This command makes YAZ client wait for a number of
response packages from target. If <replaceable>number</replaceable> is
- omitted, 1 is assumed.
+ omitted, 1 is assumed.
</para>
<para>This command is rarely used and is only useful if command
<link linkend="command-set-auto-wait">
<replaceable>ver</replaceable>
</term>
<listitem>
- <para>This command sets Z39.50 version for negotiation.
- Should be used before
+ <para>This command sets Z39.50 version for negotiation.
+ Should be used before
<link linkend="command-open"><literal>open</literal></link>.
By default 3 (version 3) is used.
</para>
<replaceable>op1 op2..</replaceable>
</term>
<listitem>
- <para>This command sets Z39.50 options for negotiation.
- Should be used before
+ <para>This command sets Z39.50 options for negotiation.
+ Should be used before
<link linkend="command-open"><literal>open</literal></link>.
</para>
<para>
The following options are supported:
- <literal>search</literal>,
- <literal>present</literal>,
- <literal>delSet</literal>,
- <literal>resourceReport</literal>,
- <literal>triggerResourceCtrl</literal>,
- <literal>resourceCtrl</literal>,
- <literal>accessCtrl</literal>,
- <literal>scan</literal>,
- <literal>sort</literal>,
- <literal>extendedServices</literal>,
- <literal>level_1Segmentation</literal>,
- <literal>level_2Segmentation</literal>,
- <literal>concurrentOperations</literal>,
- <literal>namedResultSets</literal>,
- <literal>encapsulation</literal>,
- <literal>resultCount</literal>,
- <literal>negotiationModel</literal>,
- <literal>duplicationDetection</literal>,
- <literal>queryType104</literal>,
- <literal>pQESCorrection</literal>,
+ <literal>search</literal>,
+ <literal>present</literal>,
+ <literal>delSet</literal>,
+ <literal>resourceReport</literal>,
+ <literal>triggerResourceCtrl</literal>,
+ <literal>resourceCtrl</literal>,
+ <literal>accessCtrl</literal>,
+ <literal>scan</literal>,
+ <literal>sort</literal>,
+ <literal>extendedServices</literal>,
+ <literal>level_1Segmentation</literal>,
+ <literal>level_2Segmentation</literal>,
+ <literal>concurrentOperations</literal>,
+ <literal>namedResultSets</literal>,
+ <literal>encapsulation</literal>,
+ <literal>resultCount</literal>,
+ <literal>negotiationModel</literal>,
+ <literal>duplicationDetection</literal>,
+ <literal>queryType104</literal>,
+ <literal>pQESCorrection</literal>,
<literal>stringSchema</literal>.
</para>
</listitem>
</varlistentry>
-
+
</variablelist>
<!-- Keep this comment at the end of the file
Local variables:
projects / yaz-moved-to-github.git / blobdiff