1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
2 "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
4 <!ENTITY % local SYSTEM "local.ent">
6 <!ENTITY % entities SYSTEM "entities.ent">
8 <!ENTITY % idcommon SYSTEM "common/common.ent">
11 <refentry id="pazpar2">
13 <productname>Pazpar2</productname>
14 <productnumber>&version;</productnumber>
17 <refentrytitle>Pazpar2</refentrytitle>
18 <manvolnum>8</manvolnum>
22 <refname>pazpar2</refname>
23 <refpurpose>Metasearch daemon.</refpurpose>
28 <command>pazpar2</command>
29 <arg choice="opt"><option>-d</option></arg>
30 <arg choice="opt"><option>-D</option></arg>
31 <arg choice="opt"><option>-f <replaceable>config</replaceable></option></arg>
32 <arg choice="opt"><option>-h <replaceable>ip:port</replaceable></option></arg>
33 <arg choice="opt"><option>-l <replaceable>logfile</replaceable></option></arg>
34 <arg choice="opt"><option>-p <replaceable>pidfile</replaceable></option></arg>
35 <arg choice="opt"><option>-t <replaceable>path</replaceable></option></arg>
36 <arg choice="opt"><option>-T <replaceable>session_timeout</replaceable></option></arg>
37 <arg choice="opt"><option>-u <replaceable>uid</replaceable></option></arg>
38 <arg choice="opt"><option>-V</option></arg>
39 <arg choice="opt"><option>-X</option></arg>
40 <arg choice="opt"><option>-install</option></arg>
41 <arg choice="opt"><option>-remove</option></arg>
45 <refsect1><title>DESCRIPTION</title>
46 <para><command>pazpar2</command> is the Pazpar2 Metasearch daemon
48 In normal operation it acts as a simple HTTP server which serves
50 The HTTP listener address may be given on the command line using
51 option <option>-h</option> or in the main configuration
52 file. The main configuration must be specified using option
57 <refsect1><title>OPTIONS</title>
62 <term><option>-d</option></term>
65 Enables dump of XML records to the current log file.
66 It is useful if stylesheets are being debugged.
71 <term><option>-D</option></term>
73 <para>Puts the Pazpar2 server in the background.</para>
77 <term><option>-f <replaceable>config</replaceable></option></term>
80 Specifies main configuration. This option must be specified
81 in order for Pazpar2 to operate normally.
86 <term><option>-h <replaceable>ip:port</replaceable></option></term>
89 Specifies the HTTP listener binding address.
90 The <replaceable>ip</replaceable>
91 may be a hostname or <literal>@</literal> for "any" address.
92 The <replaceable>port</replaceable> is an integer.
97 <term><option>-l <replaceable>logfile</replaceable></option></term>
100 Specifies log file. The log file must be specified when Pazpar2
101 is running in the background (-D).
106 <term><option>-p <replaceable>pidfile</replaceable></option></term>
109 Specifies PID file. If Pazpar2 is started and configured properly
110 the file given holds the process ID of the Pazpar2 process.
116 <term><option>-t <replaceable>path</replaceable></option></term>
119 Specifies a file or directory with alternative settings. This
120 overrides the <literal>settings</literal> element in the main
126 <term><option>-T <replaceable>session_timeout</replaceable></option></term>
129 Specifies a Pazpar2 HTTP session timeout. This
130 overrides the default value of 60 seconds which is to low for some broken browser.
136 <term><option>-u <replaceable>uid</replaceable></option></term>
139 Makes the Pazpar2 server change user ID to the
140 <replaceable>uid</replaceable> given.
141 This, normally, requires root privilege.
147 <term><option>-V</option></term>
150 Shows Pazpar2 version and versions of some of the components that it
151 is using (ICU and YAZ). Pazpar2 will not exit immediately after
152 displaying the version information (no daemon started).
158 <term><option>-X</option></term>
161 Makes the Pazpar2 server operate in debugging mode.
162 This prevents Pazpar2 from making separate threads and processes.
163 This option should not be used in production.
169 <term><option>-install</option></term>
172 This is an option which is only recognized on Windows. It installs
173 Pazpar2 as a Windows Service.
177 Pazpar2 only supports Windows Service options if Pazpar2 is
178 linked against YAZ 3.0.29 or later.
185 <term><option>-remove</option></term>
188 This is an option which is only recognized on Windows. It removes
189 a Pazpar2 - Windows Service.
198 <refsect1><title>EXAMPLES</title>
199 <para>The Debian package of pazpar2 starts the server with:
201 pazpar2 -D -f /etc/pazpar2/pazpar2.cfg -l /var/log/pazpar2.log -p /var/run/pazpar2.pid -u nobody
206 This will put pazpar2 in the background (-D), read config from from
207 <filename>/etc/pazpar2/pazpar2.cfg</filename>, log messages to
208 <filename>/var/log/pazpar2.log</filename>, create PID file
209 <filename>/var/run/pazpar2.pid</filename>. When the daemon is properly
210 started, the server will change effective user ID to nobody.
213 The server can be terminated with:
215 kill `cat /var/run/pazpar2.pid`
219 If Pazpar2 is to be debugged using GDB, we use option -X:
223 (gdb) run -X -f ../etc/pazpar2.cfg
228 <refsect1><title>FILES</title>
229 <para><filename>/usr/sbin/pazpar2</filename>: pazpar2 daemon</para>
231 <para><filename>/usr/share/pazpar2</filename>: pazpar2 shared files</para>
233 <para><filename>/etc/pazpar2</filename>: pazpar2 config area</para>
236 <refsect1><title>SEE ALSO</title>
238 Pazpar2 configuration:
240 <refentrytitle>pazpar2_conf</refentrytitle>
241 <manvolnum>5</manvolnum>
247 <refentrytitle>pazpar2_protocol</refentrytitle>
248 <manvolnum>7</manvolnum>
256 <!-- Keep this comment at the end of the file
261 sgml-minimize-attributes:nil
262 sgml-always-quote-attributes:t
265 sgml-parent-document:nil
266 sgml-local-catalogs: nil
267 sgml-namecase-general:t