1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
2 "http://www.oasis-open.org/docbook/xml/4.4/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>
15 <info><orgname>Index Data</orgname></info>
19 <refentrytitle>Pazpar2</refentrytitle>
20 <manvolnum>8</manvolnum>
21 <refmiscinfo class="manual">System management commands</refmiscinfo>
25 <refname>pazpar2</refname>
26 <refpurpose>Metasearch daemon.</refpurpose>
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>-R <replaceable>recfile</replaceable></option></arg>
39 <arg choice="opt"><option>-t</option></arg>
40 <arg choice="opt"><option>-u <replaceable>uid</replaceable></option></arg>
41 <arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
42 <arg choice="opt"><option>-V</option></arg>
43 <arg choice="opt"><option>-w <replaceable>dir</replaceable></option></arg>
44 <arg choice="opt"><option>-X</option></arg>
45 <arg choice="opt"><option>-install</option></arg>
46 <arg choice="opt"><option>-remove</option></arg>
51 <title>DESCRIPTION</title>
53 <command>pazpar2</command> is the Pazpar2 Metasearch daemon
55 In normal operation it acts as a simple HTTP server which serves
57 The HTTP listener address may be given on the command line using
58 option <option>-h</option> or in the main configuration
59 file. The main configuration must be specified using option
65 <title>OPTIONS</title>
69 <term><option>-d</option></term>
72 Enables dump of XML records to the current log file.
73 It is useful if stylesheets are being debugged.
76 This option may also be used together with option <option>-t</option>
77 in which case the configuration, after include processing, will be
83 <term><option>-D</option></term>
86 Puts the Pazpar2 server in the background.
91 <term><option>-f <replaceable>config</replaceable></option></term>
94 Specifies main configuration. This option must be specified
95 in order for Pazpar2 to operate normally.
100 <term><option>-h <replaceable>ip:port</replaceable></option></term>
103 Specifies the HTTP listener binding address.
104 The <replaceable>ip</replaceable>
105 may be a hostname or <literal>@</literal> for "any" address.
106 The <replaceable>port</replaceable> is an integer.
111 <term><option>-l <replaceable>logfile</replaceable></option></term>
114 Specifies log file. The log file must be specified when Pazpar2
115 is running in the background (-D).
120 <term><option>-p <replaceable>pidfile</replaceable></option></term>
123 Specifies PID file. If Pazpar2 is started and configured properly
124 the file given holds the process ID of the Pazpar2 process.
129 <term><option>-R <replaceable>recfile</replaceable></option></term>
132 If this option is given, HTTP requests are logged to file named
133 <replaceable>recfile</replaceable>.
139 <term><option>-t</option></term>
142 Checks parameters and configuration. No service or daemon is
143 started. Useful for checking a new configuration before a
144 Pazpar2 is restarted.
147 The configuration, after include processing, may also be dumped
148 to stdout by supplying option <option>-d</option> as well.
152 In Pazpar2 1.2 and earlier releases, option -t specified a
153 local target settings file.
160 <term><option>-u <replaceable>uid</replaceable></option></term>
163 Makes the Pazpar2 server change user ID to the
164 <replaceable>uid</replaceable> given.
165 This, normally, requires root privilege.
171 <term><option>-v <replaceable>level</replaceable></option></term>
174 Sets log level (YAZ log level system).
180 <term><option>-V</option></term>
183 Shows Pazpar2 version and versions of some of the components that it
184 is using (ICU and YAZ). Pazpar2 will exit immediately after
185 displaying the version information (no daemon started).
191 <term><option>-w <replaceable>dir</replaceable></option></term>
194 Changes working directory to <replaceable>dir</replaceable>.
200 <term><option>-X</option></term>
203 Makes the Pazpar2 server operate in debugging mode.
204 This prevents Pazpar2 from making separate threads and processes.
205 This option should not be used in production.
211 <term><option>-install</option></term>
214 This is an option which is only recognized on Windows. It installs
215 Pazpar2 as a Windows Service.
219 Pazpar2 only supports Windows Service options if Pazpar2 is
220 linked against YAZ 3.0.29 or later.
227 <term><option>-remove</option></term>
230 This is an option which is only recognized on Windows. It removes
231 a Pazpar2 - Windows Service.
241 <title>EXAMPLES</title>
242 <para>The Debian package of pazpar2 starts the server with:
244 pazpar2 -D -f /etc/pazpar2/pazpar2.cfg -l /var/log/pazpar2.log -p /var/run/pazpar2.pid -u nobody
249 This will put pazpar2 in the background (-D), read config from from
250 <filename>/etc/pazpar2/pazpar2.cfg</filename>, log messages to
251 <filename>/var/log/pazpar2.log</filename>, create PID file
252 <filename>/var/run/pazpar2.pid</filename>. When the daemon is properly
253 started, the server will change effective user ID to nobody.
256 The server can be terminated with:
258 kill `cat /var/run/pazpar2.pid`
262 If Pazpar2 is to be debugged using GDB, we use option -X:
266 (gdb) run -X -f ../etc/pazpar2.cfg
273 <para><filename>/usr/sbin/pazpar2</filename>: pazpar2 daemon</para>
275 <para><filename>/usr/share/pazpar2</filename>: pazpar2 shared files</para>
277 <para><filename>/etc/pazpar2</filename>: pazpar2 config area</para>
281 <title>SEE ALSO</title>
283 Pazpar2 configuration:
285 <refentrytitle>pazpar2_conf</refentrytitle>
286 <manvolnum>5</manvolnum>
292 <refentrytitle>pazpar2_protocol</refentrytitle>
293 <manvolnum>7</manvolnum>
300 <!-- Keep this comment at the end of the file