Doc: strip-trailing-whitespace
[yaz-moved-to-github.git] / doc / yaz-client-commands.xml
index dbd3c2d..4865a4d 100644 (file)
@@ -1,4 +1,4 @@
-<!-- 
+<!--
    Commands for YAZ client.
    Included in both manual and man page for yaz-client.
 -->
     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> 
+    <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.
   <listitem>
    <para>Sets up a authentication string if a server requires
     authentication (v2 OpenStyle). The authentication string is first
-    sent to the server when the 
+    sent to the server when the
     <link linkend="command-open"><literal>open</literal></link> command is
     issued and the Z39.50 Initialize Request is sent, so this command
     must be used before <literal>open</literal> in order to be effective.
     <literal>GET</literal>, <literal>SOAP</literal> (default)
     or <literal>SOLR</literal>. Version
     should be either 1.1 or 1.2 for SRU. Other versions are allowed - for testing
-    purposes (version negotiation with SRU server). 
+    purposes (version negotiation with SRU server).
     The version is currently not used for SOLR Web Services
    </para>
   </listitem>
    </para>
   </listitem>
  </varlistentry>
+
  <varlistentry><term>
    <literal>lslb</literal> <replaceable>n</replaceable>
   </term>
    </para>
   </listitem>
  </varlistentry>
+
  <varlistentry><term>
    <literal>mspn</literal> <replaceable>n</replaceable>
   </term>
    <literal>querytype</literal> <replaceable>type</replaceable>
   </term>
   <listitem>
-   <para>Sets the query type as used by command 
+   <para>Sets the query type as used by command
    <link linkend="command-find"><literal>find</literal></link>.
     The following is supported:
     <literal>prefix</literal> for
    <replaceable>type</replaceable> <replaceable>no</replaceable>
   </term>
   <listitem>
-   <para>Sends an Item Order Request using the ILL External. 
+   <para>Sends an Item Order Request using the ILL External.
     <replaceable>type</replaceable> is either 1 or 2 which corresponds to
     ILL-Profile 1 and 2 respectively. The <replaceable>no</replaceable>
     is the Result Set position of the record to be ordered.
    <para>Sends Item Update Request. The <replaceable>action</replaceable>
     argument must be the action type: one of <literal>insert</literal>,
     <literal>replace</literal>, <literal>delete</literal> and
-    <literal>update</literal>. The second argument, 
+    <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 preceded with 
+    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.
    By default YAZ client waits (on) for response packages immediately
    after a command (find, show) has been issued. If <literal>off</literal>
    is used, YAZ client does not attempt to receive packages automatically.
-   These will have to be manually received when command 
+   These will have to be manually received when command
    <link linkend="command-wait-response">
     <literal>wait_response</literal>
    </link> is used.
   </term>
   <listitem>
    <para>Specifies character set for output (display). The
-    argument is the same as second argument for command 
+    argument is the same as second argument for command
     <link linkend="command-charset"><literal>charset</literal></link>.
    </para>
   </listitem>
    </para>
   </listitem>
  </varlistentry>
+
  <varlistentry><term>
    <literal>set_cclfile</literal>
    <replaceable>filename</replaceable>
   <listitem>
    <para>This command makes YAZ client wait for a number of
     response packages from target. If <replaceable>number</replaceable> is
-    omitted, 1 is assumed. 
+    omitted, 1 is assumed.
    </para>
    <para>This command is rarely used and is only useful if command
     <link linkend="command-set-auto-wait">
    <replaceable>ver</replaceable>
   </term>
   <listitem>
-   <para>This command sets Z39.50 version for negotiation. 
-    Should be used before 
+   <para>This command sets Z39.50 version for negotiation.
+    Should be used before
     <link linkend="command-open"><literal>open</literal></link>.
     By default 3 (version 3) is used.
    </para>
    <replaceable>op1 op2..</replaceable>
   </term>
   <listitem>
-   <para>This command sets Z39.50 options for negotiation. 
-    Should be used before 
+   <para>This command sets Z39.50 options for negotiation.
+    Should be used before
    <link linkend="command-open"><literal>open</literal></link>.
    </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>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
 Local variables: