<!--
- $Id: yaz-client-commands.xml,v 1.13 2006-04-24 12:41:00 marc 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>
</varlistentry>
<varlistentry><term>
+ <literal>sru</literal> <replaceable>method</replaceable> <replaceable>version</replaceable>
+ </term>
+ <listitem>
+ <para>Selects SRU method and version.
+ Must be one of <literal>POST</literal>,
+ <literal>GET</literal>, <literal>SOAP</literal> (default). Version
+ should be either 1.1 or 1.2. Other versions are allowed - for testing
+ purposes (version negotiation with SRU server).
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry><term>
<literal>list_all</literal>
</term>
<listitem>
<para>Sets the limit for when no records should be returned
together with the search result.
See the
- <ulink url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
+ <ulink
+ url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
Z39.50 standard
</ulink>
for more details.
<para>Sets the limit for when all records should be returned with
the search result.
See the
- <ulink url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
+ <ulink
+ url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
Z39.50 standard
</ulink> for more details.
</para>
number of records in the result set is between the values of
<literal>lslb</literal> and <literal>ssub</literal>.
See the
- <ulink url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
+ <ulink
+ url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
Z39.50 standard
</ulink>
for more details.
<para>Sets the preferred transfer syntax for retrieved records.
yaz-client supports all the record syntaxes that currently
are registered. See
- <ulink url="http://www.loc.gov/z3950/agency/defns/oids.html#5">
+ <ulink
+ url="http://www.loc.gov/z3950/agency/defns/oids.html#5">
Z39.50 Standard
</ulink>
for more details. Commonly used records syntaxes include usmarc,
</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>
<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
</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>
</varlistentry>
</variablelist>
-<!-- Keep this Emacs mode comment at the end of the file
+<!-- Keep this comment at the end of the file
Local variables:
-mode: nxml
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document: "yaz.xml"
+sgml-local-catalogs: nil
+sgml-namecase-general:t
End:
-->