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 <orgname>Index Data</orgname>
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>-m <replaceable>timeformat</replaceable></option></arg>
38 <arg choice="opt"><option>-p <replaceable>pidfile</replaceable></option></arg>
39 <arg choice="opt"><option>-R <replaceable>recfile</replaceable></option></arg>
40 <arg choice="opt"><option>-t</option></arg>
41 <arg choice="opt"><option>-u <replaceable>uid</replaceable></option></arg>
42 <arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
43 <arg choice="opt"><option>-V</option></arg>
44 <arg choice="opt"><option>-w <replaceable>dir</replaceable></option></arg>
45 <arg choice="opt"><option>-X</option></arg>
46 <arg choice="opt"><option>-install</option></arg>
47 <arg choice="opt"><option>-remove</option></arg>
52 <title>DESCRIPTION</title>
54 <command>pazpar2</command> is the Pazpar2 Metasearch daemon
56 In normal operation it acts as a simple HTTP server which serves
58 The HTTP listener address may be given on the command line using
59 option <option>-h</option> or in the main configuration
60 file. The main configuration must be specified using option
66 <title>OPTIONS</title>
70 <term><option>-d</option></term>
73 Enables dump of XML records to the current log file.
74 It is useful if stylesheets are being debugged. Using this option
75 twice makes Pazpar2 also dump full HTTP responses.
78 This option may also be used together with option <option>-t</option>
79 in which case the configuration, after include processing, will be
85 <term><option>-D</option></term>
88 Puts the Pazpar2 server in the background.
93 <term><option>-f <replaceable>config</replaceable></option></term>
96 Specifies main configuration. This option must be specified
97 in order for Pazpar2 to operate normally.
102 <term><option>-h <replaceable>ip:port</replaceable></option></term>
105 Specifies the HTTP listener binding address.
106 The <replaceable>ip</replaceable>
107 may be a hostname or <literal>@</literal> for "any" address.
108 The <replaceable>port</replaceable> is an integer.
113 <term><option>-l <replaceable>logfile</replaceable></option></term>
116 Specifies log file. The log file must be specified when Pazpar2
117 is running in the background (-D).
122 <term>-m <replaceable>timeformat</replaceable></term>
124 Sets the format of time-stamps for logging.
127 url="http://pubs.opengroup.org/onlinepubs/009695399/functions/strftime.html">
129 man page for the format.
133 <term><option>-p <replaceable>pidfile</replaceable></option></term>
136 Specifies PID file. If Pazpar2 is started and configured properly
137 the file given holds the process ID of the Pazpar2 process.
142 <term><option>-R <replaceable>recfile</replaceable></option></term>
145 If this option is given, HTTP requests are logged to file named
146 <replaceable>recfile</replaceable> and predictable sessions are enabled.
147 Using special argument, dash
148 (<literal>-</literal>), will make Pazpar2 use predictable sessions
150 This is necessary when playing HTTP communication against pazpar2
151 with the pazpar2_play program. Refer to <xref linkend="pazpar2_play"/>.
157 <term><option>-t</option></term>
160 Checks parameters and configuration. No service or daemon is
161 started. Useful for checking a new configuration before a
162 Pazpar2 is restarted.
165 The configuration, after include processing, may also be dumped
166 to stdout by supplying option <option>-d</option> as well.
170 In Pazpar2 1.2 and earlier releases, option -t specified a
171 local target settings file.
178 <term><option>-u <replaceable>uid</replaceable></option></term>
181 Makes the Pazpar2 server change user ID to the
182 <replaceable>uid</replaceable> given.
183 This, normally, requires root privilege.
189 <term><option>-v <replaceable>level</replaceable></option></term>
192 Sets log level (YAZ log level system).
198 <term><option>-V</option></term>
201 Shows Pazpar2 version and versions of some of the components that it
202 is using (ICU and YAZ). Pazpar2 will exit immediately after
203 displaying the version information (no daemon started).
209 <term><option>-w <replaceable>dir</replaceable></option></term>
212 Changes working directory to <replaceable>dir</replaceable>.
218 <term><option>-X</option></term>
221 Makes the Pazpar2 server operate in debugging mode.
222 This prevents Pazpar2 from making separate threads and processes.
223 This option should not be used in production.
229 <term><option>-install</option></term>
232 This is an option which is only recognized on Windows. It installs
233 Pazpar2 as a Windows Service.
237 Pazpar2 only supports Windows Service options if Pazpar2 is
238 linked against YAZ 3.0.29 or later.
245 <term><option>-remove</option></term>
248 This is an option which is only recognized on Windows. It removes
249 a Pazpar2 - Windows Service.
259 <title>EXAMPLES</title>
260 <para>The Debian package of pazpar2 starts the server with:
262 pazpar2 -D -f /etc/pazpar2/pazpar2.cfg -l /var/log/pazpar2.log -p /var/run/pazpar2.pid -u nobody
267 This will put pazpar2 in the background (-D), read config from from
268 <filename>/etc/pazpar2/pazpar2.cfg</filename>, log messages to
269 <filename>/var/log/pazpar2.log</filename>, create PID file
270 <filename>/var/run/pazpar2.pid</filename>. When the daemon is properly
271 started, the server will change effective user ID to nobody.
274 The server can be terminated with:
276 kill `cat /var/run/pazpar2.pid`
280 If Pazpar2 is to be debugged using GDB, we use option -X:
284 (gdb) run -X -f ../etc/pazpar2.cfg
291 <para><filename>/usr/sbin/pazpar2</filename>: pazpar2 daemon</para>
293 <para><filename>/usr/share/pazpar2</filename>: pazpar2 shared files</para>
295 <para><filename>/etc/pazpar2</filename>: pazpar2 config area</para>
299 <title>SEE ALSO</title>
301 Pazpar2 configuration:
303 <refentrytitle>pazpar2_conf</refentrytitle>
304 <manvolnum>5</manvolnum>
310 <refentrytitle>pazpar2_protocol</refentrytitle>
311 <manvolnum>7</manvolnum>
317 <refentrytitle>pazpar2_play</refentrytitle>
318 <manvolnum>1</manvolnum>
325 <!-- Keep this comment at the end of the file