Added charmap facility to delete leading articles

[idzebra-moved-to-github.git] / doc / server.xml

diff --git a/doc/server.xml b/doc/server.xml
index 382a634..993fe63 100644 (file)
--- a/doc/server.xml
+++ b/doc/server.xml
@@ -1,15 +1,22 @@
 <chapter id="server">
- <!-- $Id: server.xml,v 1.2 2002-04-09 19:20:23 adam Exp $ -->
+ <!-- $Id: server.xml,v 1.7 2002-10-30 11:09:39 adam Exp $ -->
  <title>The Z39.50 Server</title>
  
  <sect1 id="zebrasrv">
   <title>Running the Z39.50 Server (zebrasrv)</title>
 
+  <!--
+   FIXME - We need to be consistent here, zebraidx had the options at the
+           end, and lots of explaining text before them. Same for zebrasvr! -H
+   FIXME - At least we need a small intro, what is zebrasvr, and how it
+           can be run (inetd, nt service, stand-alone program, daemon...) -H
+  -->
+
   <para>
    <emphasis remap="bf">Syntax</emphasis>
 
    <screen>
-    zebrasrv &lsqb;options&rsqb; &lsqb;listener-address ...&rsqb;
+    zebrasrv [options] [listener-address ...]
    </screen>
 
   </para>
@@ -51,11 +58,9 @@
      <term>-z</term>
      <listitem>
       <para>
-       Use the Z39.50 protocol (default). These two options complement
-       each other. You can use both multiple times on the same command
-       line, between listener-specifications (see below). This way, you
-       can set up the server to listen for connections in both protocols
-       concurrently, on different local ports.
+       Use the Z39.50 protocol. Currently the only protocol supported.
+       The option is retained for historical reasons, and for future
+       extensions.
       </para>
      </listitem>
     </varlistentry>
@@ -73,7 +78,7 @@
      <listitem>
       <para>
        The log level. Use a comma-separated list of members of the set
-       &lcub;fatal,debug,warn,log,all,none&rcub;.
+       {fatal,debug,warn,log,all,none}.
       </para>
      </listitem>
     </varlistentry>
@@ -129,10 +134,10 @@
   </para>
 
   <para>
-   A <replaceable>listener-address</replaceable> consists of a transport
-   mode followed by a colon (:) followed by a listener address.
+   A <replaceable>listener-address</replaceable> consists of an optional
+   transport mode followed by a colon (:) followed by a listener address.
    The transport mode is either <literal>ssl</literal> or
-   <literal>tcp</literal>.
+   <literal>tcp</literal> (default).
   </para>
 
   <para>
@@ -142,13 +147,14 @@
   <para>
 
    <screen>
-    hostname | IP-number &lsqb;: portnumber&rsqb;
+    hostname | IP-number [: portnumber]
    </screen>
 
   </para>
 
   <para>
-   The port number defaults to 210 (standard Z39.50 port).
+   The port number defaults to 210 (standard Z39.50 port) for
+   privileged users (root), and 9999 for normal users.
   </para>
 
   <para>
@@ -158,9 +164,9 @@
   <para>
 
    <screen>
-    tcp:dranet.dra.com
+    tcp:@
 
-    ssl:secure.lib.com:3000
+    ssl:@:3000
    </screen>
 
   </para>
@@ -176,7 +182,7 @@
   <para>
 
    <screen>
-    zebrasrv -u daemon tcp:@
+    zebrasrv -u daemon @
    </screen>
 
   </para>
@@ -212,6 +218,12 @@
   <sect2 id="search">
    <title>Search</title>
 
+   <!--
+    FIXME - Need to explain the string tag stuff before people get bogged 
+            down with all these attribute numbers. Perhaps in its own
+            chapter? -H
+   -->
+
    <para>
     The supported query type are 1 and 101. All operators are currently
     supported with the restriction that only proximity units of type "word"
@@ -223,7 +235,7 @@
    </para>
 
    <para>
-    The server has full support for piggy-backed present requests (see
+    The server has full support for piggy-backed retrieval (see
     also the following section).
    </para>
 
@@ -246,6 +258,7 @@
     A phrase register is created for those fields in the
     <literal>.abs</literal> file that contains a
     <literal>p</literal>-specifier.
+    <!-- ### whatever the hell _that_ is -->
    </para>
 
    <para>
@@ -309,7 +322,7 @@
     For the <emphasis>Truncation</emphasis> attribute,
     <emphasis>No Truncation</emphasis> is the default.
     <emphasis>Left Truncation</emphasis> is not supported.
-    <emphasis>Process &num;</emphasis> is supported, as is
+    <emphasis>Process # in search term</emphasis> is supported, as is
     <emphasis>Regxp-1</emphasis>.
     <emphasis>Regxp-2</emphasis> enables the fault-tolerant (fuzzy)
     search. As a default, a single error (deletion, insertion, 
@@ -376,7 +389,7 @@
        <term>x?</term>
        <listitem>
         <para>
-         Matches <emphasis>x</emphasis> once or twice. Priority: high.
+         Matches <emphasis>x</emphasis> zero or once. Priority: high.
         </para>
        </listitem>
       </varlistentry>
@@ -390,7 +403,7 @@
        </listitem>
       </varlistentry>
       <varlistentry>
-       <term>x&verbar;y</term>
+       <term>x|y</term>
        <listitem>
         <para>
          Matches either <emphasis>x</emphasis> or <emphasis>y</emphasis>.