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</option></arg>
42 <arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
43 <arg choice="opt"><option>-X</option></arg>
44 <arg choice="opt"><option>-install</option></arg>
45 <arg choice="opt"><option>-remove</option></arg>
50 <title>DESCRIPTION</title>
52 <command>pazpar2</command> is the Pazpar2 Metasearch daemon
54 In normal operation it acts as a simple HTTP server which serves
56 The HTTP listener address may be given on the command line using
57 option <option>-h</option> or in the main configuration
58 file. The main configuration must be specified using option
64 <title>OPTIONS</title>
68 <term><option>-d</option></term>
71 Enables dump of XML records to the current log file.
72 It is useful if stylesheets are being debugged.
75 This option may also be used together with option <option>-t</option>
76 in which case the configuration, after include processing, will be
82 <term><option>-D</option></term>
85 Puts the Pazpar2 server in the background.
90 <term><option>-f <replaceable>config</replaceable></option></term>
93 Specifies main configuration. This option must be specified
94 in order for Pazpar2 to operate normally.
99 <term><option>-h <replaceable>ip:port</replaceable></option></term>
102 Specifies the HTTP listener binding address.
103 The <replaceable>ip</replaceable>
104 may be a hostname or <literal>@</literal> for "any" address.
105 The <replaceable>port</replaceable> is an integer.
110 <term><option>-l <replaceable>logfile</replaceable></option></term>
113 Specifies log file. The log file must be specified when Pazpar2
114 is running in the background (-D).
119 <term><option>-p <replaceable>pidfile</replaceable></option></term>
122 Specifies PID file. If Pazpar2 is started and configured properly
123 the file given holds the process ID of the Pazpar2 process.
128 <term><option>-R <replaceable>recfile</replaceable></option></term>
131 If this option is given, HTTP requests are logged to file named
132 <replaceable>recfile</replaceable>.
138 <term><option>-t</option></term>
141 Checks parameters and configuration. No service or daemon is
142 started. Useful for checking a new configuration before a
143 Pazpar2 is restarted.
146 The configuration, after include processing, may also be dumped
147 to stdout by supplying option <option>-d</option> as well.
151 In Pazpar2 1.2 and earlier releases, option -t specified a
152 local target settings file.
159 <term><option>-u <replaceable>uid</replaceable></option></term>
162 Makes the Pazpar2 server change user ID to the
163 <replaceable>uid</replaceable> given.
164 This, normally, requires root privilege.
170 <term><option>-V</option></term>
173 Shows Pazpar2 version and versions of some of the components that it
174 is using (ICU and YAZ). Pazpar2 will exit immediately after
175 displaying the version information (no daemon started).
181 <term><option>-v <replaceable>level</replaceable></option></term>
184 Sets log level (YAZ log level system).
190 <term><option>-X</option></term>
193 Makes the Pazpar2 server operate in debugging mode.
194 This prevents Pazpar2 from making separate threads and processes.
195 This option should not be used in production.
201 <term><option>-install</option></term>
204 This is an option which is only recognized on Windows. It installs
205 Pazpar2 as a Windows Service.
209 Pazpar2 only supports Windows Service options if Pazpar2 is
210 linked against YAZ 3.0.29 or later.
217 <term><option>-remove</option></term>
220 This is an option which is only recognized on Windows. It removes
221 a Pazpar2 - Windows Service.
231 <title>EXAMPLES</title>
232 <para>The Debian package of pazpar2 starts the server with:
234 pazpar2 -D -f /etc/pazpar2/pazpar2.cfg -l /var/log/pazpar2.log -p /var/run/pazpar2.pid -u nobody
239 This will put pazpar2 in the background (-D), read config from from
240 <filename>/etc/pazpar2/pazpar2.cfg</filename>, log messages to
241 <filename>/var/log/pazpar2.log</filename>, create PID file
242 <filename>/var/run/pazpar2.pid</filename>. When the daemon is properly
243 started, the server will change effective user ID to nobody.
246 The server can be terminated with:
248 kill `cat /var/run/pazpar2.pid`
252 If Pazpar2 is to be debugged using GDB, we use option -X:
256 (gdb) run -X -f ../etc/pazpar2.cfg
263 <para><filename>/usr/sbin/pazpar2</filename>: pazpar2 daemon</para>
265 <para><filename>/usr/share/pazpar2</filename>: pazpar2 shared files</para>
267 <para><filename>/etc/pazpar2</filename>: pazpar2 config area</para>
271 <title>SEE ALSO</title>
273 Pazpar2 configuration:
275 <refentrytitle>pazpar2_conf</refentrytitle>
276 <manvolnum>5</manvolnum>
282 <refentrytitle>pazpar2_protocol</refentrytitle>
283 <manvolnum>7</manvolnum>
290 <!-- Keep this comment at the end of the file