<!ENTITY % idcommon SYSTEM "common/common.ent">
%idcommon;
]>
-<!-- $Id: pazpar2.xml,v 1.6 2007-06-18 12:55:43 adam Exp $ -->
+<!-- $Id: pazpar2.xml,v 1.10 2007-07-16 08:58:12 adam Exp $ -->
<refentry id="pazpar2">
<refentryinfo>
<productname>Pazpar2</productname>
<arg choice="opt"><option>-d</option></arg>
<arg choice="opt"><option>-D</option></arg>
<arg choice="opt"><option>-f <replaceable>config</replaceable></option></arg>
+ <arg choice="opt"><option>-h <replaceable>ip:port</replaceable></option></arg>
<arg choice="opt"><option>-l <replaceable>logfile</replaceable></option></arg>
<arg choice="opt"><option>-p <replaceable>pidfile</replaceable></option></arg>
<arg choice="opt"><option>-t <replaceable>path</replaceable></option></arg>
</refsynopsisdiv>
<refsect1><title>DESCRIPTION</title>
- <para><command>pazpar2</command> is the pazpar2 Metasearch daemon
+ <para><command>pazpar2</command> is the Pazpar2 Metasearch daemon
and server.
In normal operation it acts as a simple HTTP server which serves
the Pazpar2 protocol.
<term><option>-d</option></term>
<listitem>
<para>
- Enables dump of XML records. It is useful if stylesheets are
- being debugged.
+ Enables dump of normalized XML records to the current log file.
+ It is useful if stylesheets are being debugged.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-D</option></term>
<listitem>
- <para>Puts the pazpar2 server in the background.</para>
+ <para>Puts the Pazpar2 server in the background.</para>
</listitem>
</varlistentry>
<varlistentry>
<listitem>
<para>
Specifies main configuration. This option must be specified
- in order for pazpar2 to operate normally.
+ in order for Pazpar2 to operate normally.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-h <replaceable>ip:port</replaceable></option></term>
+ <listitem>
+ <para>
+ Specifies the HTTP listener binding address.
+ The <replaceable>ip</replaceable>
+ may be a hostname or <literal>@</literal> for "any" address.
+ The <replaceable>port</replaceable> is an integer.
</para>
</listitem>
</varlistentry>
<term><option>-l <replaceable>logfile</replaceable></option></term>
<listitem>
<para>
- Specifies log file. The log file must be specified when pazpar2
+ Specifies log file. The log file must be specified when Pazpar2
is running in the background (-D).
</para>
</listitem>
<term><option>-p <replaceable>pidfile</replaceable></option></term>
<listitem>
<para>
- Specifies PID file. If pazpar2 is started and configured properly
- the file given holds the process ID of the pazpar2 process.
+ Specifies PID file. If Pazpar2 is started and configured properly
+ the file given holds the process ID of the Pazpar2 process.
</para>
</listitem>
</varlistentry>
<term><option>-u <replaceable>uid</replaceable></option></term>
<listitem>
<para>
- Specifies that pazpar2 change user to the
+ Makes the Pazpar2 server change user ID to the
<replaceable>uid</replaceable> given.
This, normally, require root privilege.
</para>
<term><option>-X</option></term>
<listitem>
<para>
- Makes the pazpar2 server operate in debugging mode. This prevents pazpar2
- from making separate threads and processes. This option
- should not be used in production.
+ Makes the Pazpar2 server operate in debugging mode.
+ This prevents Pazpar2 from making separate threads and processes.
+ This option should not be used in production.
</para>
</listitem>
</varlistentry>
</refsect1>
<refsect1><title>EXAMPLES</title>
- <para>None yet</para>
+ <para>The Debian package of pazpar2 starts the server with:
+ <screen>
+ pazpar2 -D -f /etc/pazpar2/pazpar2.cfg -l /var/log/pazpar2.log -p /var/run/pazpar2.pid -u nobody
+ </screen>
+ (one line).
+ </para>
+ <para>
+ This will put pazpar2 in the background (-D), read config from from
+ <filename>/etc/pazpar2/pazpar2.cfg</filename>, log messages to
+ <filename>/var/log/pazpar2.log</filename>, create PID file
+ <filename>/var/run/pazpar2.pid</filename>. When the daemon is properly
+ started, the server will change effective user ID to nobody.
+ </para>
+ <para>
+ The server can be terminated with:
+ <screen>
+ kill `cat /var/run/pazpar2.pid`
+ </screen>
+ </para>
+ <para>
+ If Pazpar2 is to be debugged using GDB, we use option -X:
+ <screen>
+ cd pazpar2/src
+ gdb ./pazpar2
+ (gdb) run -X -f ../etc/pazpar2.cfg
+ </screen>
+ </para>
</refsect1>
<refsect1><title>FILES</title>
- <para></para>
+ <para><filename>/usr/sbin/pazpar2</filename>: pazpar2 daemon</para>
+
+ <para><filename>/usr/share/pazpar2</filename>: pazpar2 shared files</para>
+
+ <para><filename>/etc/pazpar2</filename>: pazpar2 config area</para>
</refsect1>
<refsect1><title>SEE ALSO</title>
</citerefentry>
</para>
<para>
- Pazpar2 protocol:.
+ Pazpar2 protocol:
<citerefentry>
<refentrytitle>pazpar2_protocol</refentrytitle>
<manvolnum>7</manvolnum>