Describe option -V of yaz-config
[yaz-moved-to-github.git] / doc / yaz-client-commands.xml
index 6aabc7f..02c2ac5 100644 (file)
@@ -1,5 +1,4 @@
 <!-- 
-   $Id: yaz-client-commands.xml,v 1.17 2007-01-24 09:54:04 adam Exp $
    Commands for YAZ client.
    Included in both manual and man page for yaz-client.
 -->
@@ -33,7 +32,7 @@
   <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>
+   <literal>sru</literal> <replaceable>method</replaceable> <replaceable>version</replaceable>
   </term>
   <listitem>
-   <para>Selects SRU method. Must be one of <literal>POST</literal>,
-    <literal>GET</literal>, <literal>SOAP</literal> (default).
+   <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>
 
  <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>