Fix description of update command

[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 3ef958a..09f7dfc 100644 (file)
--- a/doc/yaz-client-commands.xml
+++ b/doc/yaz-client-commands.xml
@@ -1,5 +1,4 @@
 <!-- 
-   $Id: yaz-client-commands.xml,v 1.11 2005-11-04 17:15:30 mike 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>
@@ -175,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>
@@ -191,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.
@@ -207,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>
@@ -223,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.
@@ -263,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,
@@ -348,24 +369,25 @@
     <literal>update</literal>. The second argument, 
     <replaceable>recid</replaceable>, is the
     record identifier (any string). Third argument which is optional is
-    the record document for the request. If doc is a quoted string
-    (double quotes) the string content is used verbatim. If doc is not
-    a quoted string, it is assumed to be a filename which is read, then
-    sent as the docuemnt content. If doc is omitted, the last received
-    record (as parf of present response or piggybacked search response) 
-    is used for the update.
+    the record document for the request. If doc is preceded with 
+    "&lt;", then the following characters are treated as a filename
+    with the records to be updated. Otherwise doc is treated as
+    a document itself. The doc may also be quited in double quotes.
+    If doc is omitted, the last received record (as part of present
+    response or piggybacked search response) is used for the update.
    </para>
   </listitem>
  </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>
@@ -463,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>
@@ -476,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
@@ -511,7 +533,7 @@
     <para>
      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).
+     in order to do meaningful conversion(s).
     </para>
    </note>
   </listitem>
@@ -559,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>