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