doc/pazpar2.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
   2  "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
   3 [
   4      <!ENTITY % local SYSTEM "local.ent">
   5      %local;
   6      <!ENTITY % entities SYSTEM "entities.ent">
   7      %entities;
   8      <!ENTITY % idcommon SYSTEM "common/common.ent">
   9      %idcommon;
  10 ]>
  11 <!-- $Id: pazpar2.xml,v 1.12 2007-09-10 08:42:48 adam Exp $ -->
  12 <refentry id="pazpar2">
  13  <refentryinfo>
  14   <productname>Pazpar2</productname>
  15   <productnumber>&version;</productnumber>
  16  </refentryinfo>
  17  <refmeta>
  18   <refentrytitle>Pazpar2</refentrytitle>
  19   <manvolnum>8</manvolnum>
  20  </refmeta>
  21
  22  <refnamediv>
  23   <refname>pazpar2</refname>
  24   <refpurpose>Metasearch daemon.</refpurpose>
  25  </refnamediv>
  26
  27  <refsynopsisdiv>
  28   <cmdsynopsis>
  29    <command>pazpar2</command>
  30    <arg choice="opt"><option>-d</option></arg>
  31    <arg choice="opt"><option>-D</option></arg>
  32    <arg choice="opt"><option>-f <replaceable>config</replaceable></option></arg>
  33    <arg choice="opt"><option>-h <replaceable>ip:port</replaceable></option></arg>
  34    <arg choice="opt"><option>-l <replaceable>logfile</replaceable></option></arg>
  35    <arg choice="opt"><option>-p <replaceable>pidfile</replaceable></option></arg>
  36    <arg choice="opt"><option>-t <replaceable>path</replaceable></option></arg>
  37    <arg choice="opt"><option>-u <replaceable>uid</replaceable></option></arg>
  38    <arg choice="opt"><option>-V</option></arg>
  39    <arg choice="opt"><option>-X</option></arg>
  40   </cmdsynopsis>
  41  </refsynopsisdiv>
  42
  43  <refsect1><title>DESCRIPTION</title>
  44   <para><command>pazpar2</command> is the Pazpar2 Metasearch daemon
  45    and server.
  46    In normal operation it acts as a simple HTTP server which serves
  47    the Pazpar2 protocol.
  48    The HTTP listener address may be given on the command line using
  49    option <option>-h</option> or in the main configuration
  50    file. The main configuration must be specified using option
  51    <option>-f</option>.
  52   </para>
  53  </refsect1>
  54
  55  <refsect1><title>OPTIONS</title>
  56   <para></para>
  57
  58   <variablelist>
  59    <varlistentry>
  60     <term><option>-d</option></term>
  61     <listitem>
  62      <para>
  63       Enables dump of XML records to the current log file.
  64       It is useful if stylesheets are being debugged.
  65      </para>
  66     </listitem>
  67    </varlistentry>
  68    <varlistentry>
  69     <term><option>-D</option></term>
  70     <listitem>
  71      <para>Puts the Pazpar2 server in the background.</para>
  72     </listitem>
  73    </varlistentry>
  74    <varlistentry>
  75     <term><option>-f <replaceable>config</replaceable></option></term>
  76     <listitem>
  77      <para>
  78       Specifies main configuration. This option must be specified
  79       in order for Pazpar2 to operate normally.
  80      </para>
  81     </listitem>
  82    </varlistentry>
  83    <varlistentry>
  84     <term><option>-h <replaceable>ip:port</replaceable></option></term>
  85     <listitem>
  86      <para>
  87       Specifies the HTTP listener binding address.
  88       The <replaceable>ip</replaceable>
  89       may be a hostname or <literal>@</literal> for "any" address.
  90       The <replaceable>port</replaceable> is an integer.
  91      </para>
  92     </listitem>
  93    </varlistentry>
  94    <varlistentry>
  95     <term><option>-l <replaceable>logfile</replaceable></option></term>
  96     <listitem>
  97      <para>
  98       Specifies log file. The log file must be specified when Pazpar2
  99       is running in the background (-D).
 100      </para>
 101     </listitem>
 102    </varlistentry>
 103    <varlistentry>
 104     <term><option>-p <replaceable>pidfile</replaceable></option></term>
 105     <listitem>
 106      <para>
 107       Specifies PID file. If Pazpar2 is started and configured properly
 108       the file given holds the process ID of the Pazpar2 process.
 109      </para>
 110     </listitem>
 111    </varlistentry>
 112    <varlistentry>
 113     <term><option>-t <replaceable>path</replaceable></option></term>
 114     <listitem>
 115      <para>
 116       Specifies a file or directory with alternative settings. This
 117       overrides the <literal>settings</literal> element in the main
 118       configuration.
 119      </para>
 120     </listitem>
 121    </varlistentry>
 122
 123    <varlistentry>
 124     <term><option>-u <replaceable>uid</replaceable></option></term>
 125     <listitem>
 126      <para>
 127       Makes the Pazpar2 server change user ID to the
 128       <replaceable>uid</replaceable> given.
 129       This, normally, require root privilege.
 130      </para>
 131     </listitem>
 132    </varlistentry>
 133
 134    <varlistentry>
 135     <term><option>-V</option></term>
 136     <listitem>
 137      <para>
 138       Shows Pazpar2 version and versions of some of the components that it
 139       is using (ICU and YAZ). Pazpar2 will not exit immediately after
 140       displaying the version information (no daemon started).
 141      </para>
 142     </listitem>
 143    </varlistentry>
 144
 145    <varlistentry>
 146     <term><option>-X</option></term>
 147     <listitem>
 148      <para>
 149       Makes the Pazpar2 server operate in debugging mode.
 150       This prevents Pazpar2 from making separate threads and processes.
 151       This option should not be used in production.
 152      </para>
 153     </listitem>
 154    </varlistentry>
 155
 156   </variablelist>
 157
 158  </refsect1>
 159
 160  <refsect1><title>EXAMPLES</title>
 161   <para>The Debian package of pazpar2 starts the server with:
 162    <screen>
 163     pazpar2 -D -f /etc/pazpar2/pazpar2.cfg -l /var/log/pazpar2.log -p /var/run/pazpar2.pid -u nobody
 164    </screen>
 165    (one line).
 166   </para>
 167   <para>
 168    This will put pazpar2 in the background (-D), read config from from
 169    <filename>/etc/pazpar2/pazpar2.cfg</filename>, log messages to
 170    <filename>/var/log/pazpar2.log</filename>, create PID file
 171    <filename>/var/run/pazpar2.pid</filename>. When the daemon is properly
 172    started, the server will change effective user ID to nobody.
 173   </para>
 174   <para>
 175    The server can be terminated with:
 176    <screen>
 177     kill `cat /var/run/pazpar2.pid`
 178    </screen>
 179   </para>
 180   <para>
 181    If Pazpar2 is to be debugged using GDB, we use option -X:
 182    <screen>
 183     cd pazpar2/src
 184     gdb ./pazpar2
 185     (gdb) run -X -f ../etc/pazpar2.cfg
 186    </screen>
 187   </para>
 188  </refsect1>
 189
 190  <refsect1><title>FILES</title>
 191   <para><filename>/usr/sbin/pazpar2</filename>: pazpar2 daemon</para>
 192
 193   <para><filename>/usr/share/pazpar2</filename>: pazpar2 shared files</para>
 194
 195   <para><filename>/etc/pazpar2</filename>: pazpar2 config area</para>
 196  </refsect1>
 197
 198  <refsect1><title>SEE ALSO</title>
 199   <para>
 200    Pazpar2 configuration:
 201    <citerefentry>
 202     <refentrytitle>pazpar2_conf</refentrytitle>
 203     <manvolnum>5</manvolnum>
 204    </citerefentry>
 205   </para>
 206   <para>
 207    Pazpar2 protocol:
 208    <citerefentry>
 209     <refentrytitle>pazpar2_protocol</refentrytitle>
 210     <manvolnum>7</manvolnum>
 211    </citerefentry>
 212   </para>
 213  </refsect1>
 214
 215 </refentry>
 216
 217
 218 <!-- Keep this comment at the end of the file
 219 Local variables:
 220 mode: sgml
 221 sgml-omittag:t
 222 sgml-shorttag:t
 223 sgml-minimize-attributes:nil
 224 sgml-always-quote-attributes:t
 225 sgml-indent-step:1
 226 sgml-indent-data:t
 227 sgml-parent-document:nil
 228 sgml-local-catalogs: nil
 229 sgml-namecase-general:t
 230 End:
 231 -->