Fixed bug #831: New yaz-client command: 'source'.

[yaz-moved-to-github.git] / doc / yaz-client-commands.xml

diff --git a/doc/yaz-client-commands.xml b/doc/yaz-client-commands.xml
index 1c21bc5..6aabc7f 100644 (file)
--- a/doc/yaz-client-commands.xml
+++ b/doc/yaz-client-commands.xml
@@ -1,5 +1,5 @@
 <!-- 
-   $Id: yaz-client-commands.xml,v 1.10 2005-06-23 13:09:42 adam Exp $
+   $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.
 -->
@@ -127,19 +127,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 +175,16 @@
  </varlistentry>
 
  <varlistentry><term>
+   <literal>sru</literal> <replaceable>method</replaceable>
+  </term>
+  <listitem>
+   <para>Selects SRU method. Must be one of <literal>POST</literal>,
+    <literal>GET</literal>, <literal>SOAP</literal> (default).
+   </para>
+  </listitem>
+ </varlistentry>
+
+ <varlistentry><term>
    <literal>list_all</literal>
   </term>
   <listitem>
@@ -186,7 +201,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 +217,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 +233,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 +273,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 +369,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 +474,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 +487,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