X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Fyaz-client-commands.xml;h=02c2ac5c90fec4ac3bbffd9895f328b3cecde5c9;hp=fd98374e342681be6714828403d1c7710fe6c0b3;hb=726bffd1002026ce15056e97a1511392724377e5;hpb=7a870687ef78606cd134e82fd9085722efe3c979

diff --git a/doc/yaz-client-commands.xml b/doc/yaz-client-commands.xml
index fd98374..02c2ac5 100644
--- a/doc/yaz-client-commands.xml
+++ b/doc/yaz-client-commands.xml
@@ -1,5 +1,4 @@
 <!-- 
-   $Id: yaz-client-commands.xml,v 1.9 2005-06-21 07:34:26 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>
@@ -93,6 +92,15 @@
   </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>
@@ -127,19 +135,24 @@
   </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>&lt;</literal> for sort ascending and <literal>&gt;</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>&lt;</literal> for ascending order or <literal>&gt;</literal>
+    for descending order.
    </para>
   </listitem>
  </varlistentry>
@@ -170,6 +183,19 @@
  </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>
@@ -186,7 +212,7 @@
     together with the search result.
     See the
     <ulink
-           url="http://lcweb.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
+     url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
      Z39.50 standard
     </ulink>
     for more details.
@@ -202,7 +228,7 @@
     the search result.
     See the
     <ulink
-           url="http://lcweb.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
+     url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
      Z39.50 standard
     </ulink> for more details.
    </para>
@@ -218,7 +244,7 @@
     <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">
+     url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
      Z39.50 standard
     </ulink>
     for more details.
@@ -258,7 +284,7 @@
     yaz-client supports all the record syntaxes that currently
     are registered. See
     <ulink
-           url="http://lcweb.loc.gov/z3950/agency/defns/oids.html#5">
+     url="http://www.loc.gov/z3950/agency/defns/oids.html#5">
      Z39.50 Standard
     </ulink>
     for more details. Commonly used records syntaxes include usmarc,
@@ -354,13 +380,14 @@
  </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>
@@ -458,7 +485,7 @@
   <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>
@@ -471,7 +498,7 @@
   </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
@@ -554,6 +581,19 @@
  </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>
@@ -646,12 +686,11 @@
 
  <varlistentry id="command-xmles"><term>
    <literal>xmles</literal>
+   <replaceable>OID</replaceable>
    <replaceable>doc</replaceable>
   </term>
   <listitem>
-   <para>Sends XML Extended Services request using the doc given.
-    This is a privately defined Extended Service using OID
-    1.2.840.10003.9.1000.105.4.
+   <para>Sends XML Extended Services request using the OID and doc given.
    </para>
   </listitem>
  </varlistentry>