doc/zebrasrv-man.sgml

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