doc/zebrasrv-man.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
   2  "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
   3 [
   4      <!ENTITY % local SYSTEM "local.ent">
   5      %local;
   6      <!ENTITY % entities  SYSTEM "entities.ent">
   7      %entities;
   8      <!ENTITY % common  SYSTEM "common/common.ent">
   9      %common;
  10      <!ENTITY zebrasrv-synopsis SYSTEM "zebrasrv-synopsis.xml">
  11      <!ENTITY zebrasrv-options SYSTEM "zebrasrv-options.xml">
  12      <!ENTITY zebrasrv-virtual SYSTEM "zebrasrv-virtual.xml">
  13      <!ENTITY gfs-synopsis-app "zebrasrv">
  14      <!ENTITY reference-tools-cql-map 'section "Specifiction of CQL to RPN mappings"'>
  15 ]>
  16
  17      <!-- <!ENTITY zebrasrv-commands SYSTEM "zebrasrv-commands.xml"> -->
  18
  19
  20 <!-- $Id: zebrasrv-man.xml,v 1.2 2006-06-13 13:45:08 marc Exp $ -->
  21 <refentry id="zebrasrv">
  22
  23  <refmeta>
  24   <refentrytitle>zebrasrv</refentrytitle>
  25   <manvolnum>8</manvolnum>
  26  </refmeta>
  27
  28  <refnamediv>
  29   <refname>zebrasrv</refname>
  30   <refpurpose>Zebra Server</refpurpose>
  31  </refnamediv>
  32
  33  <refsynopsisdiv>
  34   <!--
  35   <cmdsynopsis>
  36    <command>zebrasrv</command>
  37    <arg choice="opt"><option>-a <replaceable>file</replaceable></option></arg>
  38    <arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
  39    <arg choice="opt"><option>-l <replaceable>file</replaceable></option></arg>
  40    <arg choice="opt"><option>-u <replaceable>uid</replaceable></option></arg>
  41    <arg choice="opt"><option>-c <replaceable>config</replaceable></option></arg>
  42    <arg choice="opt"><option>-t <replaceable>minutes</replaceable></option></arg>
  43    <arg choice="opt"><option>-k <replaceable>kilobytes</replaceable></option></arg>
  44    <arg choice="opt"><option>-d <replaceable>daemon</replaceable></option></arg>
  45    <arg choice="opt"><option>-w <replaceable>dir</replaceable></option></arg>
  46    <arg choice="opt"><option>-ziST1</option></arg>
  47    <arg choice="opt" rep="repeat">listener-spec</arg>
  48   </cmdsynopsis>
  49   -->
  50   &zebrasrv-synopsis;
  51  </refsynopsisdiv>
  52   <refsect1><title>DESCRIPTION</title>
  53     <para>Zebra is a high-performance, general-purpose structured text indexing
  54    and retrieval engine. It reads structured records in a variety of input
  55    formats (eg. email, XML, MARC) and allows access to them through exact
  56    boolean search expressions and relevance-ranked free-text queries.
  57    </para>
  58    <para>
  59     <command>zebrasrv</command> is the Z39.50 and SRW/U frontend
  60     server for the <command>Zebra</command> indexer.
  61    </para>
  62    <para>
  63     On Unix you can run the <command>zebrasrv</command>
  64     server from the command line - and put it
  65     in the background. It may also operate under the inet daemon.
  66     On WIN32 you can run the server as a console application or
  67     as a WIN32 Service.
  68    </para>
  69   </refsect1>
  70  <!--
  71  <refsect1>
  72    <title>COMMANDS</title>
  73   &zebrasrv-commands;
  74  </refsect1>
  75  -->
  76   <refsect1>
  77    <title>OPTIONS</title>
  78
  79    <para>
  80     The options for <command>zebrasrv</command> are the same
  81     as those for YAZ' <command>yaz-ztest</command>.
  82     Option <literal>-c</literal> specifies a Zebra configuration
  83     file - if omitted <filename>zebra.cfg</filename> is read.
  84    </para>
  85
  86   &zebrasrv-options;
  87   </refsect1>
  88   <refsect1><title>VIRTUAL HOSTS</title>
  89     <para>
  90      <command>zebrasrv</command> uses the YAZ server
  91     </para>
  92     &zebrasrv-virtual;
  93   </refsect1>
  94   <refsect1><title>FILES</title>
  95    <para>
  96     <filename>zebra.cfg</filename>
  97    </para>
  98   </refsect1>
  99   <refsect1><title>SEE ALSO</title>
 100    <para>
 101     <citerefentry>
 102      <refentrytitle>zebraidx</refentrytitle>
 103      <manvolnum>1</manvolnum>
 104     </citerefentry>,
 105     <citerefentry>
 106      <refentrytitle>yaz-ztest</refentrytitle>
 107      <manvolnum>8</manvolnum>
 108     </citerefentry>
 109    </para>
 110    <para>
 111     Section "The Z39.50 Server" in the Zebra manual.
 112     <filename>http://www.indexdata.dk/zebra/doc/server.tkl</filename>
 113    </para>
 114    <para>
 115     Section "Virtual Hosts" in the YAZ manual.
 116     <filename>http://www.indexdata.dk/yaz/doc/server.vhosts.tkl</filename>
 117    </para>
 118    <para>
 119     Section "Specification of CQL to RPN mappings" in the YAZ manual.
 120     <filename>http://www.indexdata.dk/yaz/doc/tools.tkl#tools.cql.map</filename>
 121    </para>
 122    <para>
 123     The Zebra software is Copyright <command>Index Data</command>
 124     <filename>http://www.indexdata.dk</filename>
 125     and distributed under the
 126     GPLv2 license.
 127    </para>
 128   </refsect1>
 129 </refentry>
 130
 131 <!-- Keep this comment at the end of the file
 132 Local variables:
 133 mode: sgml
 134 sgml-omittag:t
 135 sgml-shorttag:t
 136 sgml-minimize-attributes:nil
 137 sgml-always-quote-attributes:t
 138 sgml-indent-step:1
 139 sgml-indent-data:t
 140 sgml-parent-document:nil
 141 sgml-local-catalogs: nil
 142 sgml-namecase-general:t
 143 End:
 144 -->