corrected DOCTYPE header and called emacs nxml-mode instead of sgml-mode in bottom...
[yaz-moved-to-github.git] / doc / yaz-client-commands.xml
index 1c21bc5..67c9365 100644 (file)
@@ -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.13 2006-04-24 12:41:00 marc Exp $
    Commands for YAZ client.
    Included in both manual and man page for yaz-client.
 -->
   </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>
    <para>Sets the limit for when no records should be returned
     together with the search result.
     See the
-    <ulink
-           url="http://lcweb.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
+    <ulink url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
      Z39.50 standard
     </ulink>
     for more details.
    <para>Sets the limit for when all records should be returned with
     the search result.
     See the
-    <ulink
-           url="http://lcweb.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
+    <ulink url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
      Z39.50 standard
     </ulink> for more details.
    </para>
     number of records in the result set is between the values of
     <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">
+    <ulink url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
      Z39.50 standard
     </ulink>
     for more details.
    <para>Sets the preferred transfer syntax for retrieved records.
     yaz-client supports all the record syntaxes that currently
     are registered. See
-    <ulink
-           url="http://lcweb.loc.gov/z3950/agency/defns/oids.html#5">
+    <ulink url="http://www.loc.gov/z3950/agency/defns/oids.html#5">
      Z39.50 Standard
     </ulink>
     for more details. Commonly used records syntaxes include usmarc,
  </varlistentry>
  
 </variablelist>
-<!-- Keep this comment at the end of the file
+<!-- Keep this Emacs mode comment at the end of the file
 Local variables:
-mode: sgml
-sgml-omittag:t
-sgml-shorttag:t
-sgml-minimize-attributes:nil
-sgml-always-quote-attributes:t
-sgml-indent-step:1
-sgml-indent-data:t
-sgml-parent-document: "yaz.xml"
-sgml-local-catalogs: nil
-sgml-namecase-general:t
+mode: nxml
 End:
 -->