updated the zebrasrv man page by copying relevant files over from yaz documentation...
[idzebra-moved-to-github.git] / 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.3 2005-08-05 14:39:12 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>
46     <command>zebrasrv</command> is a Z39.50 and SRW/U server for Zebra.
47     On Unix you can run the server from the command line - and put it
48     in the background. It may also operate under the inet daemon.
49     On WIN32 you can run the server as a console application or
50     as a WIN32 Service.
51    </para>
52   </refsect1>
53  <!--
54  <refsect1>
55    <title>COMMANDS</title>
56   &zebrasrv-commands;
57  </refsect1>
58  -->
59   <refsect1>
60    <title>OPTIONS</title>
61     
62    <para>
63     The options for <command>zebrasrv</command> are the same
64     as those for YAZ' <command>yaz-ztest</command>.
65     Option <literal>-c</literal> specifies a Zebra configuration
66     file - if omitted <filename>zebra.cfg</filename> is read.
67    </para>
68    
69   &zebrasrv-options;
70   </refsect1>
71   <refsect1><title>VIRTUAL HOSTS</title>
72     <para>
73      <command>zebrasrv</command>uses the YAZ server
74     </para>
75     &zebrasrv-virtual;
76   </refsect1>
77   <refsect1><title>FILES</title>
78    <para>
79     <filename>zebra.cfg</filename>
80    </para>
81   </refsect1>
82   <refsect1><title>SEE ALSO</title>
83    <para>
84     <citerefentry>
85      <refentrytitle>zebraidx</refentrytitle>
86      <manvolnum>1</manvolnum>
87     </citerefentry>,
88     <citerefentry>
89      <refentrytitle>yaz-ztest</refentrytitle>
90      <manvolnum>8</manvolnum>
91     </citerefentry>
92    </para>
93    <para>
94     Section "The Z39.50 Server" in the Zebra manual.
95     <filename>http://www.indexdata.dk/zebra/doc/server.tkl</filename>
96    </para>
97    <para>
98     Section "Virtual Hosts" in the YAZ manual.
99     <filename>http://www.indexdata.dk/yaz/doc/server.vhosts.tkl</filename>
100    </para>
101    <para>
102     Section "Specification of CQL to RPN mappings" in the YAZ manual.
103     <filename>http://www.indexdata.dk/yaz/doc/tools.tkl#tools.cql.map</filename>
104    </para>
105   </refsect1>
106 </refentry>
107
108 <!-- Keep this comment at the end of the file
109 Local variables:
110 mode: sgml
111 sgml-omittag:t
112 sgml-shorttag:t
113 sgml-minimize-attributes:nil
114 sgml-always-quote-attributes:t
115 sgml-indent-step:1
116 sgml-indent-data:t
117 sgml-parent-document:nil
118 sgml-local-catalogs: nil
119 sgml-namecase-general:t
120 End:
121 -->