Minor changes.
[yaz-moved-to-github.git] / doc / client.xml
index d7d60e6..1c8df1c 100644 (file)
@@ -1,19 +1,19 @@
-<!-- $Id: client.xml,v 1.1 2001-08-08 19:33:21 adam Exp $ -->
- <chapter><title>The YAZ client</title>
-  <sect1><title>Introduction</title>
+<!-- $Id: client.xml,v 1.4 2001-10-24 20:12:36 adam Exp $ -->
+ <chapter id="client"><title>The YAZ client</title>
+  <sect1 id="client.introduction"><title>Introduction</title>
    <para>
    <para>
-    yaz-client is a linemode Z39.50 client. It supports a fair amount
+    yaz-client is a line-mode Z39.50 client. It supports a fair amount
     of the functionality of the Z39.50-1995 standard, but some things you
     of the functionality of the Z39.50-1995 standard, but some things you
-    need to enable or disable by recompilation.
+    need to enable or disable by re-compilation.
     Its primary purpose is to exercise the
     package, and verify that the protocol works OK.
     For the same reason some commands offers more functionality than others.
     Its primary purpose is to exercise the
     package, and verify that the protocol works OK.
     For the same reason some commands offers more functionality than others.
-    Commands that exercies common Z39.50 services such as search and present
+    Commands that exercises common Z39.50 services such as search and present
     have more features than less common supported services, such as Extended
     Services (ItemOrder, ItemUpdate,..).
    </para>
   </sect1>
     have more features than less common supported services, such as Extended
     Services (ItemOrder, ItemUpdate,..).
    </para>
   </sect1>
-  <sect1><title>Invoking the YAZ client</title>
+  <sect1 id="client.invoking"><title>Invoking the YAZ client</title>
    <para>
     It can be started by typing
    </para>
    <para>
     It can be started by typing
    </para>
@@ -61,7 +61,7 @@
       <literal>-v</literal> <replaceable>level</replaceable>
      </term><listitem>
       <simpara>Sets the LOG level to <replaceable>level</replaceable>.
       <literal>-v</literal> <replaceable>level</replaceable>
      </term><listitem>
       <simpara>Sets the LOG level to <replaceable>level</replaceable>.
-       Level is a sequence of tokens separated by comman. Each token
+       Level is a sequence of tokens separated by comma. Each token
        is a integer or a named LOG item - one of 
        <literal>fatal</literal>,
        <literal>debug</literal>,
        is a integer or a named LOG item - one of 
        <literal>fatal</literal>,
        <literal>debug</literal>,
@@ -88,7 +88,7 @@
     yaz-client -a - localhost
    </screen>
   </sect1>
     yaz-client -a - localhost
    </screen>
   </sect1>
-  <sect1><title>YAZ client commands</title>
+  <sect1 id="client.commands"><title>Commands</title>
    <para>
     When the YAZ client has read options and connected to a target, if given,
     it will display <literal>Z &gt;</literal> and away your command.
    <para>
     When the YAZ client has read options and connected to a target, if given,
     it will display <literal>Z &gt;</literal> and away your command.
       </screen>
      </listitem>
     </varlistentry>
       </screen>
      </listitem>
     </varlistentry>
-    <varlistentry><term>
+    <varlistentry id="sortspec"><term>
       <literal>sort</literal> <replaceable>sortspecs</replaceable>
      </term>
      <listitem>
       <literal>sort</literal> <replaceable>sortspecs</replaceable>
      </term>
      <listitem>
-      <para>Sorts a result set. The sort command takes a sequence of
-       sort specifications. A sort
+      <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.
        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.
      </term>
      <listitem>
       <para>Sends an Item Order Request using the ILL External. 
      </term>
      <listitem>
       <para>Sends an Item Order Request using the ILL External. 
-       <replaceable>type</replaceable> is either 1 or 2 which correponds to
+       <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>
        ILL-Profile 1 and 2 respectively. The <replaceable>no</replaceable>
        is the Result Set position of the record to be ordered.
       </para>
     </varlistentry>
    </variablelist>
   </sect1>
     </varlistentry>
    </variablelist>
   </sect1>
-  <sect1><title>Searching</title>
+  <sect1 id="client.searching"><title>Searching</title>
    <para>
     The simplest example of a Prefix Query would be something like
     <screen>
    <para>
     The simplest example of a Prefix Query would be something like
     <screen>
     <screen>
      f @attrset Bib-1 @and @attr GILS 1=2008 Washington @attr 1=21 weather
     </screen>
     <screen>
      f @attrset Bib-1 @and @attr GILS 1=2008 Washington @attr 1=21 weather
     </screen>
-    For the full specifiction of the Prefix Query see the section
+    For the full specification of the Prefix Query see the section
      <link linkend="PQF">Prefix Query Format</link>.
    </para>
   </sect1>
      <link linkend="PQF">Prefix Query Format</link>.
    </para>
   </sect1>