finished re-write of chaper 7 and zebrasrv man page, now hopefully much more informat...

[idzebra-moved-to-github.git] / doc / zebrasrv-man.sgml

diff --git a/doc/zebrasrv-man.sgml b/doc/zebrasrv-man.sgml
index e0ee72b..608f892 100644 (file)
--- a/doc/zebrasrv-man.sgml
+++ b/doc/zebrasrv-man.sgml
@@ -1,5 +1,15 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
-<!-- $Id: zebrasrv-man.sgml,v 1.1 2002-09-19 21:06:51 adam Exp $ -->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+     <!ENTITY zebrasrv-synopsis SYSTEM "zebrasrv-synopsis.xml">
+     <!ENTITY zebrasrv-options SYSTEM "zebrasrv-options.xml">
+     <!ENTITY zebrasrv-virtual SYSTEM "zebrasrv-virtual.xml">
+     <!ENTITY gfs-synopsis-app "zebrasrv">
+     <!ENTITY reference-tools-cql-map 'section "Specifiction of CQL to RPN mappings"'>
+]>
+
+     <!-- <!ENTITY zebrasrv-commands SYSTEM "zebrasrv-commands.xml"> -->
+
+
+<!-- $Id: zebrasrv-man.sgml,v 1.4 2005-08-12 12:44:36 marc Exp $ -->
 <refentry id="zebrasrv">
  
  <refmeta>
@@ -11,8 +21,9 @@
   <refname>zebrasrv</refname>
   <refpurpose>Zebra Server</refpurpose>
  </refnamediv>
- 
+  
  <refsynopsisdiv>
+  <!--
   <cmdsynopsis>
    <command>zebrasrv</command>
    <arg choice="opt"><option>-a <replaceable>file</replaceable></option></arg>
@@ -27,24 +38,50 @@
    <arg choice="opt"><option>-ziST1</option></arg>
    <arg choice="opt" rep="repeat">listener-spec</arg>
   </cmdsynopsis>
-  
+  -->
+  &zebrasrv-synopsis;
+ </refsynopsisdiv>
   <refsect1><title>DESCRIPTION</title>
+    <para>Zebra is a high-performance, general-purpose structured text indexing
+   and retrieval engine. It reads structured records in a variety of input
+   formats (eg. email, XML, MARC) and allows access to them through exact
+   boolean search expressions and relevance-ranked free-text queries. 
+   </para>
    <para>
-    <command>zebrasrv</command> is a Z39.50 server for Zebra.
-    On Unix you can run the server from the command line - and put it
+    <command>zebrasrv</command> is the Z39.50 and SRW/U frontend
+    server for the <command>Zebra</command> indexer.
+   </para> 
+   <para> 
+    On Unix you can run the <command>zebrasrv</command>
+    server from the command line - and put it
     in the background. It may also operate under the inet daemon.
     On WIN32 you can run the server as a console application or
     as a WIN32 Service.
    </para>
   </refsect1>
+ <!--
+ <refsect1>
+   <title>COMMANDS</title>
+  &zebrasrv-commands;
+ </refsect1>
+ -->
   <refsect1>
    <title>OPTIONS</title>
+    
    <para>
     The options for <command>zebrasrv</command> are the same
     as those for YAZ' <command>yaz-ztest</command>.
     Option <literal>-c</literal> specifies a Zebra configuration
     file - if omitted <filename>zebra.cfg</filename> is read.
    </para>
+   
+  &zebrasrv-options;
+  </refsect1>
+  <refsect1><title>VIRTUAL HOSTS</title>
+    <para>
+     <command>zebrasrv</command>uses the YAZ server
+    </para>
+    &zebrasrv-virtual;
   </refsect1>
   <refsect1><title>FILES</title>
    <para>
@@ -64,7 +101,22 @@
    </para>
    <para>
     Section "The Z39.50 Server" in the Zebra manual.
+    <filename>http://www.indexdata.dk/zebra/doc/server.tkl</filename>
+   </para>
+   <para>
+    Section "Virtual Hosts" in the YAZ manual.
+    <filename>http://www.indexdata.dk/yaz/doc/server.vhosts.tkl</filename>
    </para>
+   <para>
+    Section "Specification of CQL to RPN mappings" in the YAZ manual.
+    <filename>http://www.indexdata.dk/yaz/doc/tools.tkl#tools.cql.map</filename>
+   </para>
+   <para>
+    The Zebra software is Copyright <command>Index Data</command> 
+    <filename>http://www.indexdata.dk</filename>
+    and distributed under the
+    GPLv2 license.
+   </para> 
   </refsect1>
 </refentry>