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>
42 <refsect1><title>DESCRIPTION</title>
43 <para><command>pazpar2</command> is the Pazpar2 Metasearch daemon
45 In normal operation it acts as a simple HTTP server which serves
47 The HTTP listener address may be given on the command line using
48 option <option>-h</option> or in the main configuration
49 file. The main configuration must be specified using option
54 <refsect1><title>OPTIONS</title>
59 <term><option>-d</option></term>
62 Enables dump of XML records to the current log file.
63 It is useful if stylesheets are being debugged.
68 <term><option>-D</option></term>
70 <para>Puts the Pazpar2 server in the background.</para>
74 <term><option>-f <replaceable>config</replaceable></option></term>
77 Specifies main configuration. This option must be specified
78 in order for Pazpar2 to operate normally.
83 <term><option>-h <replaceable>ip:port</replaceable></option></term>
86 Specifies the HTTP listener binding address.
87 The <replaceable>ip</replaceable>
88 may be a hostname or <literal>@</literal> for "any" address.
89 The <replaceable>port</replaceable> is an integer.
94 <term><option>-l <replaceable>logfile</replaceable></option></term>
97 Specifies log file. The log file must be specified when Pazpar2
98 is running in the background (-D).
103 <term><option>-p <replaceable>pidfile</replaceable></option></term>
106 Specifies PID file. If Pazpar2 is started and configured properly
107 the file given holds the process ID of the Pazpar2 process.
112 <term><option>-t <replaceable>path</replaceable></option></term>
115 Specifies a file or directory with alternative settings. This
116 overrides the <literal>settings</literal> element in the main
123 <term><option>-u <replaceable>uid</replaceable></option></term>
126 Makes the Pazpar2 server change user ID to the
127 <replaceable>uid</replaceable> given.
128 This, normally, require root privilege.
134 <term><option>-V</option></term>
137 Shows Pazpar2 version and versions of some of the components that it
138 is using (ICU and YAZ). Pazpar2 will not exit immediately after
139 displaying the version information (no daemon started).
145 <term><option>-X</option></term>
148 Makes the Pazpar2 server operate in debugging mode.
149 This prevents Pazpar2 from making separate threads and processes.
150 This option should not be used in production.
159 <refsect1><title>EXAMPLES</title>
160 <para>The Debian package of pazpar2 starts the server with:
162 pazpar2 -D -f /etc/pazpar2/pazpar2.cfg -l /var/log/pazpar2.log -p /var/run/pazpar2.pid -u nobody
167 This will put pazpar2 in the background (-D), read config from from
168 <filename>/etc/pazpar2/pazpar2.cfg</filename>, log messages to
169 <filename>/var/log/pazpar2.log</filename>, create PID file
170 <filename>/var/run/pazpar2.pid</filename>. When the daemon is properly
171 started, the server will change effective user ID to nobody.
174 The server can be terminated with:
176 kill `cat /var/run/pazpar2.pid`
180 If Pazpar2 is to be debugged using GDB, we use option -X:
184 (gdb) run -X -f ../etc/pazpar2.cfg
189 <refsect1><title>FILES</title>
190 <para><filename>/usr/sbin/pazpar2</filename>: pazpar2 daemon</para>
192 <para><filename>/usr/share/pazpar2</filename>: pazpar2 shared files</para>
194 <para><filename>/etc/pazpar2</filename>: pazpar2 config area</para>
197 <refsect1><title>SEE ALSO</title>
199 Pazpar2 configuration:
201 <refentrytitle>pazpar2_conf</refentrytitle>
202 <manvolnum>5</manvolnum>
208 <refentrytitle>pazpar2_protocol</refentrytitle>
209 <manvolnum>7</manvolnum>
217 <!-- Keep this comment at the end of the file
222 sgml-minimize-attributes:nil
223 sgml-always-quote-attributes:t
226 sgml-parent-document:nil
227 sgml-local-catalogs: nil
228 sgml-namecase-general:t