<!--
- $Id: yaz-client-commands.xml,v 1.3 2003-05-19 20:45:07 adam Exp $
+ $Id: yaz-client-commands.xml,v 1.7 2005-02-02 17:11:05 adam Exp $
Commands for YAZ client.
Included in both manual and man page for yaz-client.
-->
</screen>
</listitem>
</varlistentry>
+ <varlistentry><term>
+ <literal>scanpos</literal> <replaceable>pos</replaceable>
+ </term>
+ <listitem>
+ <simpara>
+ Sets preferred position for scan. This value
+ is used in next scan. By default position is 1.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry><term>
+ <literal>scansize</literal> <replaceable>size</replaceable>
+ </term>
+ <listitem>
+ <simpara>
+ Sets number of entries to be returned by scan. Default
+ number of entries is 20.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry><term>
+ <literal>scanstep</literal> <replaceable>step</replaceable>
+ </term>
+ <listitem>
+ <simpara>
+ Set step-size for scan. This value is used in next scan
+ sent to the target. By default step-size is 0.
+ </simpara>
+ </listitem>
+ </varlistentry>
<varlistentry id="sortspec"><term>
<literal>sort</literal> <replaceable>sortspecs</replaceable>
</term>
</para>
</listitem>
</varlistentry>
+
+ <varlistentry><term>
+ <literal>list_all</literal>
+ </term>
+ <listitem>
+ <para>This command displays status and values for many settings.
+ </para>
+ </listitem>
+ </varlistentry>
+
<varlistentry><term>
<literal>lslb</literal> <replaceable>n</replaceable>
</term>
</term>
<listitem>
<para>Sets the query type as used by command <literal>find</literal>.
- The following is supported: <literal>prefix</literal> for
- <link linkend="PQF">Prefix Query Notation</link> (Type-1 Query);
- <literal>ccl</literal> for CCL search (Type-2
- Query), <literal>cql</literal> for CQL or <literal>ccl2rpn</literal> for
- <link linkend="CCL">CCL</link> to RPN conversion (Type-1 Query).
+ The following is supported:
+ <literal>prefix</literal> for
+ <link linkend="PQF">Prefix Query Notation</link> (Type-1 Query);
+ <literal>ccl</literal> for CCL search (Type-2 Query),
+ <literal>cql</literal> for CQL (Type-104 search with CQL OID),
+ <literal>ccl2rpn</literal> for
+ <link linkend="CCL">CCL</link> to RPN conversion (Type-1 Query).
+ <literal>cql2rpn</literal> for
+ CQL to RPN conversion (Type-1 Query).
</para>
</listitem>
</varlistentry>
</varlistentry>
<varlistentry><term>
+ <literal>set_auto_reconnect</literal>
+ <replaceable>flag</replaceable>
+ </term>
+ <listitem>
+ <para>Specifies whether YAZ client automatically reconnect if
+ target closes connection (Z39.50 only).
+ <replaceable>flag</replaceable> must be either
+ <literal>on</literal> or <literal>off</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry><term>
<literal>set_marcdump</literal>
<replaceable>filename</replaceable>
</term>
<varlistentry><term>
<literal>charset</literal>
<replaceable>negotiationcharset</replaceable>
- [<replaceable>outputcharset</replaceable>]
+ [<replaceable>displaycharset</replaceable>]
+ [[<replaceable>marccharset</replaceable>]]
</term>
<listitem>
<para>Specifies character set (encoding) for Z39.50
specifies <emphasis>no</emphasis> character set to be negotiated.
</para>
<para>
- If <replaceable>outputcharset</replaceable> is given, it specifies name
+ If <replaceable>displaycharset</replaceable> 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 <literal>-</literal> (dash)
convert strings to the encoding of the
terminal as returned by <function>nl_langinfo</function> call.
</para>
+ <para>
+ If <replaceable>marcharset</replaceable> is given, it specifies name
+ of the character set of retrieved MARC records from server. See
+ also <literal>marcharset</literal> command.
+ </para>
<note>
<para>
Since character set negotation takes effect in the Z39.50
</note>
<note>
<para>
- MARC records are not covered by Z39.50 character set negotiation.
- See <literal>marccharset</literal>.
+ 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).
</para>
</note>
</listitem>
</varlistentry>
<varlistentry><term>
+ <literal>negcharset</literal>
+ <replaceable>charset</replaceable>
+ </term>
+ <listitem>
+ <para>Specifies character set for negotiation (Z39.50). The
+ argument is the same as second argument for command
+ <literal>charset</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry><term>
+ <literal>displaycharset</literal>
+ <replaceable>charset</replaceable>
+ </term>
+ <listitem>
+ <para>Specifies character set for output (display). The
+ argument is the same as second argument for
+ command <literal>charset</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry><term>
<literal>marccharset</literal>
<replaceable>charset</replaceable>
</term>
for your display. See <literal>charset</literal> command.
If <literal>auto</literal> 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 <literal>charset</literal> command.
</para>
</listitem>
</varlistentry>
<varlistentry><term>
- <literal>set_cclfields</literal>
+ <literal>set_cclfile</literal>
<replaceable>filename</replaceable>
</term>
<listitem>
</varlistentry>
<varlistentry><term>
+ <literal>set_cqlfile</literal>
+ <replaceable>filename</replaceable>
+ </term>
+ <listitem>
+ <para>Specifies that CQL fields should be read from file
+ file <replaceable>filename</replaceable>. This command does the
+ thing as option <literal>-q</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry><term>
<literal>register_oid</literal>
<replaceable>name</replaceable>
<replaceable>class</replaceable>
</para>
</listitem>
</varlistentry>
+
+ <varlistentry><term>
+ <literal>register_tab</literal>
+ <replaceable>command</replaceable>
+ <replaceable>string</replaceable>
+ </term>
+ <listitem>
+ <para>This command registers a TAB completion string for
+ the command given.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry><term>
+ <literal>sleep</literal>
+ <replaceable>seconds</replaceable>
+ </term>
+ <listitem>
+ <para>This command makes YAZ client sleep (be idle) for
+ the number of seconds given.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry><term>
+ <literal>zversion</literal>
+ <replaceable>ver</replaceable>
+ </term>
+ <listitem>
+ <para>This command sets Z39.50 version for negotiation.
+ Should be used before <literal>open</literal>.
+ By default, 3 (version 3) is used.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry><term>
+ <literal>options</literal>
+ <replaceable>op1 op2..</replaceable>
+ </term>
+ <listitem>
+ <para>This command sets Z39.50 options for negotiation.
+ Should be used before <literal>open</literal>.
+ </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>stringSchema</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
<!-- Keep this comment at the end of the file