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>-u <replaceable>uid</replaceable></option></arg>
37 <arg choice="opt"><option>-V</option></arg>
38 <arg choice="opt"><option>-X</option></arg>
39 <arg choice="opt"><option>-install</option></arg>
40 <arg choice="opt"><option>-remove</option></arg>
44 <refsect1><title>DESCRIPTION</title>
45 <para><command>pazpar2</command> is the Pazpar2 Metasearch daemon
47 In normal operation it acts as a simple HTTP server which serves
49 The HTTP listener address may be given on the command line using
50 option <option>-h</option> or in the main configuration
51 file. The main configuration must be specified using option
56 <refsect1><title>OPTIONS</title>
61 <term><option>-d</option></term>
64 Enables dump of XML records to the current log file.
65 It is useful if stylesheets are being debugged.
70 <term><option>-D</option></term>
72 <para>Puts the Pazpar2 server in the background.</para>
76 <term><option>-f <replaceable>config</replaceable></option></term>
79 Specifies main configuration. This option must be specified
80 in order for Pazpar2 to operate normally.
85 <term><option>-h <replaceable>ip:port</replaceable></option></term>
88 Specifies the HTTP listener binding address.
89 The <replaceable>ip</replaceable>
90 may be a hostname or <literal>@</literal> for "any" address.
91 The <replaceable>port</replaceable> is an integer.
96 <term><option>-l <replaceable>logfile</replaceable></option></term>
99 Specifies log file. The log file must be specified when Pazpar2
100 is running in the background (-D).
105 <term><option>-p <replaceable>pidfile</replaceable></option></term>
108 Specifies PID file. If Pazpar2 is started and configured properly
109 the file given holds the process ID of the Pazpar2 process.
114 <term><option>-t <replaceable>path</replaceable></option></term>
117 Specifies a file or directory with alternative settings. This
118 overrides the <literal>settings</literal> element in the main
125 <term><option>-u <replaceable>uid</replaceable></option></term>
128 Makes the Pazpar2 server change user ID to the
129 <replaceable>uid</replaceable> given.
130 This, normally, require root privilege.
136 <term><option>-V</option></term>
139 Shows Pazpar2 version and versions of some of the components that it
140 is using (ICU and YAZ). Pazpar2 will not exit immediately after
141 displaying the version information (no daemon started).
147 <term><option>-X</option></term>
150 Makes the Pazpar2 server operate in debugging mode.
151 This prevents Pazpar2 from making separate threads and processes.
152 This option should not be used in production.
158 <term><option>-install</option></term>
161 This is an option which is only recognized on Windows. It installs
162 Pazpar2 as a Windows Service.
168 <term><option>-install</option></term>
171 This is an option which is only recognized on Windows. It removes
172 a Pazpar2 - Windows Service.
181 <refsect1><title>EXAMPLES</title>
182 <para>The Debian package of pazpar2 starts the server with:
184 pazpar2 -D -f /etc/pazpar2/pazpar2.cfg -l /var/log/pazpar2.log -p /var/run/pazpar2.pid -u nobody
189 This will put pazpar2 in the background (-D), read config from from
190 <filename>/etc/pazpar2/pazpar2.cfg</filename>, log messages to
191 <filename>/var/log/pazpar2.log</filename>, create PID file
192 <filename>/var/run/pazpar2.pid</filename>. When the daemon is properly
193 started, the server will change effective user ID to nobody.
196 The server can be terminated with:
198 kill `cat /var/run/pazpar2.pid`
202 If Pazpar2 is to be debugged using GDB, we use option -X:
206 (gdb) run -X -f ../etc/pazpar2.cfg
211 <refsect1><title>FILES</title>
212 <para><filename>/usr/sbin/pazpar2</filename>: pazpar2 daemon</para>
214 <para><filename>/usr/share/pazpar2</filename>: pazpar2 shared files</para>
216 <para><filename>/etc/pazpar2</filename>: pazpar2 config area</para>
219 <refsect1><title>SEE ALSO</title>
221 Pazpar2 configuration:
223 <refentrytitle>pazpar2_conf</refentrytitle>
224 <manvolnum>5</manvolnum>
230 <refentrytitle>pazpar2_protocol</refentrytitle>
231 <manvolnum>7</manvolnum>
239 <!-- Keep this comment at the end of the file
244 sgml-minimize-attributes:nil
245 sgml-always-quote-attributes:t
248 sgml-parent-document:nil
249 sgml-local-catalogs: nil
250 sgml-namecase-general:t