Malloc info in server-status
[pazpar2-moved-to-github.git] / doc / pazpar2.xml
1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
2  "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
3 [
4      <!ENTITY % local SYSTEM "local.ent">
5      %local;
6      <!ENTITY % entities SYSTEM "entities.ent">
7      %entities;
8      <!ENTITY % idcommon SYSTEM "common/common.ent">
9      %idcommon;
10 ]>
11 <refentry id="pazpar2">
12  <refentryinfo>
13   <productname>Pazpar2</productname>
14   <productnumber>&version;</productnumber>
15   <info><orgname>Index Data</orgname></info>
16  </refentryinfo>
17
18  <refmeta>
19   <refentrytitle>Pazpar2</refentrytitle>
20   <manvolnum>8</manvolnum>
21   <refmiscinfo class="manual">System management commands</refmiscinfo>
22  </refmeta>
23  
24  <refnamediv>
25   <refname>pazpar2</refname>
26   <refpurpose>Metasearch daemon.</refpurpose>
27  </refnamediv>
28  
29  <refsynopsisdiv>
30   <cmdsynopsis>
31    <command>pazpar2</command>
32    <arg choice="opt"><option>-d</option></arg>
33    <arg choice="opt"><option>-D</option></arg>
34    <arg choice="opt"><option>-f <replaceable>config</replaceable></option></arg>
35    <arg choice="opt"><option>-h <replaceable>ip:port</replaceable></option></arg>
36    <arg choice="opt"><option>-l <replaceable>logfile</replaceable></option></arg>
37    <arg choice="opt"><option>-p <replaceable>pidfile</replaceable></option></arg>
38    <arg choice="opt"><option>-t</option></arg>
39    <arg choice="opt"><option>-u <replaceable>uid</replaceable></option></arg>
40    <arg choice="opt"><option>-V</option></arg>
41    <arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
42    <arg choice="opt"><option>-X</option></arg>
43    <arg choice="opt"><option>-install</option></arg>
44    <arg choice="opt"><option>-remove</option></arg>
45   </cmdsynopsis>
46  </refsynopsisdiv>
47  
48  <refsect1><title>DESCRIPTION</title>
49   <para><command>pazpar2</command> is the Pazpar2 Metasearch daemon
50    and server.
51    In normal operation it acts as a simple HTTP server which serves
52    the Pazpar2 protocol.
53    The HTTP listener address may be given on the command line using
54    option <option>-h</option> or in the main configuration
55    file. The main configuration must be specified using option
56    <option>-f</option>.
57   </para>
58  </refsect1>
59  
60  <refsect1><title>OPTIONS</title>
61   <para></para>
62   
63   <variablelist>
64    <varlistentry>
65     <term><option>-d</option></term>
66     <listitem>
67      <para>
68       Enables dump of XML records to the current log file.
69       It is useful if stylesheets are being debugged.
70      </para>
71      <para>
72       This option may also be used together with option <option>-t</option>
73       in which case the configuration, after include processing, will be
74       dumped to stdout.
75      </para>
76     </listitem>
77    </varlistentry>
78    <varlistentry>
79     <term><option>-D</option></term>
80     <listitem>
81      <para>Puts the Pazpar2 server in the background.</para>
82     </listitem>
83    </varlistentry>
84    <varlistentry>
85     <term><option>-f <replaceable>config</replaceable></option></term>
86     <listitem>
87      <para>
88       Specifies main configuration. This option must be specified
89       in order for Pazpar2 to operate normally.
90      </para>
91     </listitem>
92    </varlistentry>
93    <varlistentry>
94     <term><option>-h <replaceable>ip:port</replaceable></option></term>
95     <listitem>
96      <para>
97       Specifies the HTTP listener binding address.
98       The <replaceable>ip</replaceable>
99       may be a hostname or <literal>@</literal> for "any" address.
100       The <replaceable>port</replaceable> is an integer.
101      </para>
102     </listitem>
103    </varlistentry>
104    <varlistentry>
105     <term><option>-l <replaceable>logfile</replaceable></option></term>
106     <listitem>
107      <para>
108       Specifies log file. The log file must be specified when Pazpar2
109       is running in the background (-D).
110      </para>
111     </listitem>
112    </varlistentry>
113    <varlistentry>
114     <term><option>-p <replaceable>pidfile</replaceable></option></term>
115     <listitem>
116      <para>
117       Specifies PID file. If Pazpar2 is started and configured properly
118       the file given holds the process ID of the Pazpar2 process.
119      </para>
120     </listitem>
121    </varlistentry>
122
123    <varlistentry>
124     <term><option>-t</option></term>
125     <listitem>
126      <para>
127       Checks parameters and configuration. No service or daemon is
128       started. Useful for checking a new configuration before a
129       Pazpar2 is restarted.
130      </para>
131      <para>
132       The configuration, after include processing, may also be dumped
133       to stdout by supplying option <option>-d</option> as well.
134      </para>
135      <note>
136       <para>
137        In Pazpar2 1.2 and earlier releases, option -t specified a
138        local target settings file.
139       </para>
140      </note>
141     </listitem>
142    </varlistentry>
143
144    <varlistentry>
145     <term><option>-u <replaceable>uid</replaceable></option></term>
146     <listitem>
147      <para>
148       Makes the Pazpar2 server change user ID to the
149       <replaceable>uid</replaceable> given.
150       This, normally, requires root privilege.
151      </para>
152     </listitem>
153    </varlistentry>
154
155    <varlistentry>
156     <term><option>-V</option></term>
157     <listitem>
158      <para>
159       Shows Pazpar2 version and versions of some of the components that it
160       is using (ICU and YAZ). Pazpar2 will exit immediately after
161       displaying the version information (no daemon started).
162      </para>
163     </listitem>
164    </varlistentry>
165
166    <varlistentry>
167     <term><option>-v <replaceable>level</replaceable></option></term>
168     <listitem>
169      <para>
170       Sets log level (YAZ log level system).
171      </para>
172     </listitem>
173    </varlistentry>
174
175    <varlistentry>
176     <term><option>-X</option></term>
177     <listitem>
178      <para>
179       Makes the Pazpar2 server operate in debugging mode.
180       This prevents Pazpar2 from making separate threads and processes.
181       This option should not be used in production.
182      </para>
183     </listitem>
184    </varlistentry>
185
186    <varlistentry>
187     <term><option>-install</option></term>
188     <listitem>
189      <para>
190        This is an option which is only recognized on Windows. It installs
191        Pazpar2 as a Windows Service.
192      </para>
193      <note>
194        <para>
195          Pazpar2 only supports Windows Service options if Pazpar2 is
196          linked against YAZ 3.0.29 or later.
197        </para>
198      </note>
199     </listitem>
200    </varlistentry>
201
202    <varlistentry>
203     <term><option>-remove</option></term>
204     <listitem>
205      <para>
206        This is an option which is only recognized on Windows. It removes
207        a Pazpar2 - Windows Service.
208      </para>
209     </listitem>
210    </varlistentry>
211
212   </variablelist>
213   
214  </refsect1>
215  
216  <refsect1><title>EXAMPLES</title>
217   <para>The Debian package of pazpar2 starts the server with:
218    <screen>
219     pazpar2 -D -f /etc/pazpar2/pazpar2.cfg -l /var/log/pazpar2.log -p /var/run/pazpar2.pid -u nobody
220    </screen>
221    (one line). 
222   </para>
223   <para>
224    This will put pazpar2 in the background (-D), read config from from
225    <filename>/etc/pazpar2/pazpar2.cfg</filename>, log messages to
226    <filename>/var/log/pazpar2.log</filename>, create PID file
227    <filename>/var/run/pazpar2.pid</filename>. When the daemon is properly
228    started, the server will change effective user ID to nobody.
229   </para>
230   <para>
231    The server can be terminated with:
232    <screen>
233     kill `cat /var/run/pazpar2.pid`
234    </screen>
235   </para>
236   <para>
237    If Pazpar2 is to be debugged using GDB, we use option -X:
238    <screen>
239     cd pazpar2/src
240     gdb ./pazpar2
241     (gdb) run -X -f ../etc/pazpar2.cfg
242    </screen>
243   </para>
244  </refsect1> 
245  
246  <refsect1><title>FILES</title>
247   <para><filename>/usr/sbin/pazpar2</filename>: pazpar2 daemon</para>
248
249   <para><filename>/usr/share/pazpar2</filename>: pazpar2 shared files</para>
250
251   <para><filename>/etc/pazpar2</filename>: pazpar2 config area</para>
252  </refsect1>
253  
254  <refsect1><title>SEE ALSO</title>
255   <para>
256    Pazpar2 configuration:
257    <citerefentry>
258     <refentrytitle>pazpar2_conf</refentrytitle>
259     <manvolnum>5</manvolnum>
260    </citerefentry>
261   </para>
262   <para>
263    Pazpar2 protocol:
264    <citerefentry>
265     <refentrytitle>pazpar2_protocol</refentrytitle>
266     <manvolnum>7</manvolnum>
267    </citerefentry>
268   </para>
269  </refsect1>
270
271 </refentry>
272
273
274 <!-- Keep this comment at the end of the file
275 Local variables:
276 mode: sgml
277 sgml-omittag:t
278 sgml-shorttag:t
279 sgml-minimize-attributes:nil
280 sgml-always-quote-attributes:t
281 sgml-indent-step:1
282 sgml-indent-data:t
283 sgml-parent-document:nil
284 sgml-local-catalogs: nil
285 sgml-namecase-general:t
286 End:
287 -->