X-Git-Url: http://git.indexdata.com/?p=idzebra-moved-to-github.git;a=blobdiff_plain;f=doc%2Fzebrasrv-options.xml;h=ff025ae216899e3db00d6e5dc93112ea3bffdb10;hp=9d39d3c92853312f2b274392ddb84bb4aae4d0dd;hb=a5c8c78e8671af863fc61b2ad8b24f92f827f7b2;hpb=c473db9c7ca11d1bbe1d0c980c48f4e470cfde70

diff --git a/doc/zebrasrv-options.xml b/doc/zebrasrv-options.xml
index 9d39d3c..ff025ae 100644
--- a/doc/zebrasrv-options.xml
+++ b/doc/zebrasrv-options.xml
@@ -1,7 +1,8 @@
 <!-- 
-   $Id: zebrasrv-options.xml,v 1.2 2005-08-12 12:44:36 marc Exp $
    Options for generic frontend server and yaz-ztest.
    Included in both manual and man page for yaz-ztest
+   Note - these files have been altered for zebrasrv, and are not in
+   sync any more!!
 -->
 
 <variablelist>
@@ -23,6 +24,12 @@
     current users. The server can only accept a single
        connection in this mode.
    </para></listitem></varlistentry>
+<!-- The text for -S option is (in my opinion) the wrong way around. The main
+argument for not using -S is that it can handle only one connection at a
+time, whereas the forking and threading interfaces can handle multiple
+connections. Also, the forking (but not threading) model can survive a
+crash at a single server instance. Heikki -->
+
  
  <varlistentry><term><literal>-1</literal></term>
   <listitem><para>
@@ -44,7 +51,7 @@
 
  <varlistentry><term><literal>-z</literal></term>
   <listitem><para>
-    Use the Z39.50 protocol (default). This option and <literal>-s</literal>
+    Use the &acro.z3950; protocol (default). This option and <literal>-s</literal>
     complement each other.
     You can use both multiple times on the same command
     line, between listener-specifications (see below). This way, you
@@ -69,8 +76,9 @@
 
  <varlistentry><term><literal>-f </literal>
    <replaceable>vconfig</replaceable></term>
-  <listitem><para>This specifies an XML file that describes
-    one or more YAZ frontend virtual servers.
+  <listitem><para>This specifies an &acro.xml; file that describes
+    one or more &yaz; frontend virtual servers. See section VIRTUAL
+   HOSTS for details.
    </para></listitem></varlistentry>
 
  <varlistentry><term><literal>-C </literal>
@@ -84,6 +92,18 @@
     The log level. Use a comma-separated list of members of the set
     {fatal,debug,warn,log,malloc,all,none}.
    </para></listitem></varlistentry>
+<!-- The -v option (for log level) is not enough. There are many more
+log switches than the simple levels you mention, and more can (and will)
+be defined in (loadable?) modules. You can get them all listed in the
+log file with '-v loglevel'. Most users will at least have interest in 
+'server', 'session', 'request', and 'requestdetail', and possibly
+'searchhits', 'searchterms', 'resultsets', 'rpn'. And maybe many more...
+I ought to write a script that greps the bits from the source code -
+that is the only way to get to them, there is no longer any central
+repository for them. No idea how to explain this neatly in the man
+page...
+Heikki -->
+
 
  <varlistentry><term><literal>-u </literal>
    <replaceable>uid</replaceable></term>
@@ -108,7 +128,7 @@
   <listitem><para>
     Specifies that the server should write its Process ID to
     file given by <replaceable>pidfile</replaceable>. 
-    A typical location would be <filename>/var/run/yaz-ztest.pid</filename>.
+    A typical location would be <filename>/var/run/zebrasrv.pid</filename>.
    </para></listitem></varlistentry>
 
  <varlistentry><term><literal>-i</literal></term>
@@ -119,7 +139,13 @@
        conjunction with this mode and specify the <literal>-l</literal>
        option before any other options.
    </para></listitem></varlistentry>
- 
+<!--
+-i: Better say "use this when the server is run from inetd", than "use
+this to make the server run from inetd", as the option itself will only
+tell zebra that it should assume that inetd started it.
+Heikki --> 
+
+
  <varlistentry><term><literal>-D</literal></term>
   <listitem><para>
     Use this to make the server put itself in the background and
@@ -194,7 +220,7 @@
    <screen>
     hostname | IP-number [: portnumber]
    </screen>
-   The port number defaults to 210 (standard Z39.50 port) for
+   The port number defaults to 210 (standard &acro.z3950; port) for
    privileged users (root), and 9999 for normal users.
    The special hostname "@" is mapped to
    the address INADDR_ANY, which causes the server to listen on any local
@@ -202,8 +228,8 @@
 
   <para>
    The default behavior for <literal>zebrasrv</literal> - if started
-   as non-priviledged user - is to establish
-   a single TCP/IP listener, for the Z39.50 protocol, on port 9999.
+   as non-privileged user - is to establish
+   a single TCP/IP listener, for the &acro.z3950; protocol, on port 9999.
    <screen>
     zebrasrv @
     zebrasrv tcp:some.server.name.org:1234
@@ -213,7 +239,7 @@
 
   <para>
    To start the server listening on the registered port for
-   Z39.50, or on a filesystem socket, 
+   &acro.z3950;, or on a filesystem socket, 
    and to drop root privileges once the ports are bound, execute
    the server like this from a root shell:
    <screen>
@@ -225,7 +251,12 @@
    unix socket <literal>/some/file/system/socket</literal> is readable
    and writable for the <literal>daemon</literal> account.
   </para>
-
+<!--
+The line before the examples "zebrasrv -u daemon @" would sound better
+if it said something like "execute the server from a root shell with a
+command like one of these:" - so that our users won't cut and paste all
+three lines...
+Heikki -->
 
 
 <!-- Keep this comment at the end of the file
@@ -237,7 +268,7 @@ sgml-minimize-attributes:nil
 sgml-always-quote-attributes:t
 sgml-indent-step:1
 sgml-indent-data:t
-sgml-parent-document: "yaz.xml"
+sgml-parent-document: "zebrasrv.xml"
 sgml-local-catalogs: nil
 sgml-namecase-general:t
 End: