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 <refentry id="pazpar2">
  12  <refentryinfo>
  13   <productname>Pazpar2</productname>
  14   <productnumber>&version;</productnumber>
  15  </refentryinfo>
  16  <refmeta>
  17   <refentrytitle>Pazpar2</refentrytitle>
  18   <manvolnum>8</manvolnum>
  19  </refmeta>
  20
  21  <refnamediv>
  22   <refname>pazpar2</refname>
  23   <refpurpose>Metasearch daemon.</refpurpose>
  24  </refnamediv>
  25
  26  <refsynopsisdiv>
  27   <cmdsynopsis>
  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</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>-v <replaceable>level</replaceable></option></arg>
  39    <arg choice="opt"><option>-X</option></arg>
  40    <arg choice="opt"><option>-install</option></arg>
  41    <arg choice="opt"><option>-remove</option></arg>
  42   </cmdsynopsis>
  43  </refsynopsisdiv>
  44
  45  <refsect1><title>DESCRIPTION</title>
  46   <para><command>pazpar2</command> is the Pazpar2 Metasearch daemon
  47    and server.
  48    In normal operation it acts as a simple HTTP server which serves
  49    the Pazpar2 protocol.
  50    The HTTP listener address may be given on the command line using
  51    option <option>-h</option> or in the main configuration
  52    file. The main configuration must be specified using option
  53    <option>-f</option>.
  54   </para>
  55  </refsect1>
  56
  57  <refsect1><title>OPTIONS</title>
  58   <para></para>
  59
  60   <variablelist>
  61    <varlistentry>
  62     <term><option>-d</option></term>
  63     <listitem>
  64      <para>
  65       Enables dump of XML records to the current log file.
  66       It is useful if stylesheets are being debugged.
  67      </para>
  68      <para>
  69       This option may also be used together with option <option>-t</option>
  70       in which case the configuration, after include processing, will be
  71       dumped to stdout.
  72      </para>
  73     </listitem>
  74    </varlistentry>
  75    <varlistentry>
  76     <term><option>-D</option></term>
  77     <listitem>
  78      <para>Puts the Pazpar2 server in the background.</para>
  79     </listitem>
  80    </varlistentry>
  81    <varlistentry>
  82     <term><option>-f <replaceable>config</replaceable></option></term>
  83     <listitem>
  84      <para>
  85       Specifies main configuration. This option must be specified
  86       in order for Pazpar2 to operate normally.
  87      </para>
  88     </listitem>
  89    </varlistentry>
  90    <varlistentry>
  91     <term><option>-h <replaceable>ip:port</replaceable></option></term>
  92     <listitem>
  93      <para>
  94       Specifies the HTTP listener binding address.
  95       The <replaceable>ip</replaceable>
  96       may be a hostname or <literal>@</literal> for "any" address.
  97       The <replaceable>port</replaceable> is an integer.
  98      </para>
  99     </listitem>
 100    </varlistentry>
 101    <varlistentry>
 102     <term><option>-l <replaceable>logfile</replaceable></option></term>
 103     <listitem>
 104      <para>
 105       Specifies log file. The log file must be specified when Pazpar2
 106       is running in the background (-D).
 107      </para>
 108     </listitem>
 109    </varlistentry>
 110    <varlistentry>
 111     <term><option>-p <replaceable>pidfile</replaceable></option></term>
 112     <listitem>
 113      <para>
 114       Specifies PID file. If Pazpar2 is started and configured properly
 115       the file given holds the process ID of the Pazpar2 process.
 116      </para>
 117     </listitem>
 118    </varlistentry>
 119
 120    <varlistentry>
 121     <term><option>-t</option></term>
 122     <listitem>
 123      <para>
 124       Checks parameters and configuration. No service or daemon is
 125       started. Useful for checking a new configuration before a
 126       Pazpar2 is restarted.
 127      </para>
 128      <para>
 129       The configuration, after include processing, may also be dumped
 130       to stdout by supplying option <option>-d</option> as well.
 131      </para>
 132      <note>
 133       <para>
 134        In Pazpar2 1.2 and earlier releases, option -t specified a
 135        local target settings file.
 136       </para>
 137      </note>
 138     </listitem>
 139    </varlistentry>
 140
 141    <varlistentry>
 142     <term><option>-u <replaceable>uid</replaceable></option></term>
 143     <listitem>
 144      <para>
 145       Makes the Pazpar2 server change user ID to the
 146       <replaceable>uid</replaceable> given.
 147       This, normally, requires root privilege.
 148      </para>
 149     </listitem>
 150    </varlistentry>
 151
 152    <varlistentry>
 153     <term><option>-V</option></term>
 154     <listitem>
 155      <para>
 156       Shows Pazpar2 version and versions of some of the components that it
 157       is using (ICU and YAZ). Pazpar2 will exit immediately after
 158       displaying the version information (no daemon started).
 159      </para>
 160     </listitem>
 161    </varlistentry>
 162
 163    <varlistentry>
 164     <term><option>-v <replaceable>level</replaceable></option></term>
 165     <listitem>
 166      <para>
 167       Sets log level (YAZ log level system).
 168      </para>
 169     </listitem>
 170    </varlistentry>
 171
 172    <varlistentry>
 173     <term><option>-X</option></term>
 174     <listitem>
 175      <para>
 176       Makes the Pazpar2 server operate in debugging mode.
 177       This prevents Pazpar2 from making separate threads and processes.
 178       This option should not be used in production.
 179      </para>
 180     </listitem>
 181    </varlistentry>
 182
 183    <varlistentry>
 184     <term><option>-install</option></term>
 185     <listitem>
 186      <para>
 187        This is an option which is only recognized on Windows. It installs
 188        Pazpar2 as a Windows Service.
 189      </para>
 190      <note>
 191        <para>
 192          Pazpar2 only supports Windows Service options if Pazpar2 is
 193          linked against YAZ 3.0.29 or later.
 194        </para>
 195      </note>
 196     </listitem>
 197    </varlistentry>
 198
 199    <varlistentry>
 200     <term><option>-remove</option></term>
 201     <listitem>
 202      <para>
 203        This is an option which is only recognized on Windows. It removes
 204        a Pazpar2 - Windows Service.
 205      </para>
 206     </listitem>
 207    </varlistentry>
 208
 209   </variablelist>
 210
 211  </refsect1>
 212
 213  <refsect1><title>EXAMPLES</title>
 214   <para>The Debian package of pazpar2 starts the server with:
 215    <screen>
 216     pazpar2 -D -f /etc/pazpar2/pazpar2.cfg -l /var/log/pazpar2.log -p /var/run/pazpar2.pid -u nobody
 217    </screen>
 218    (one line).
 219   </para>
 220   <para>
 221    This will put pazpar2 in the background (-D), read config from from
 222    <filename>/etc/pazpar2/pazpar2.cfg</filename>, log messages to
 223    <filename>/var/log/pazpar2.log</filename>, create PID file
 224    <filename>/var/run/pazpar2.pid</filename>. When the daemon is properly
 225    started, the server will change effective user ID to nobody.
 226   </para>
 227   <para>
 228    The server can be terminated with:
 229    <screen>
 230     kill `cat /var/run/pazpar2.pid`
 231    </screen>
 232   </para>
 233   <para>
 234    If Pazpar2 is to be debugged using GDB, we use option -X:
 235    <screen>
 236     cd pazpar2/src
 237     gdb ./pazpar2
 238     (gdb) run -X -f ../etc/pazpar2.cfg
 239    </screen>
 240   </para>
 241  </refsect1>
 242
 243  <refsect1><title>FILES</title>
 244   <para><filename>/usr/sbin/pazpar2</filename>: pazpar2 daemon</para>
 245
 246   <para><filename>/usr/share/pazpar2</filename>: pazpar2 shared files</para>
 247
 248   <para><filename>/etc/pazpar2</filename>: pazpar2 config area</para>
 249  </refsect1>
 250
 251  <refsect1><title>SEE ALSO</title>
 252   <para>
 253    Pazpar2 configuration:
 254    <citerefentry>
 255     <refentrytitle>pazpar2_conf</refentrytitle>
 256     <manvolnum>5</manvolnum>
 257    </citerefentry>
 258   </para>
 259   <para>
 260    Pazpar2 protocol:
 261    <citerefentry>
 262     <refentrytitle>pazpar2_protocol</refentrytitle>
 263     <manvolnum>7</manvolnum>
 264    </citerefentry>
 265   </para>
 266  </refsect1>
 267
 268 </refentry>
 269
 270
 271 <!-- Keep this comment at the end of the file
 272 Local variables:
 273 mode: sgml
 274 sgml-omittag:t
 275 sgml-shorttag:t
 276 sgml-minimize-attributes:nil
 277 sgml-always-quote-attributes:t
 278 sgml-indent-step:1
 279 sgml-indent-data:t
 280 sgml-parent-document:nil
 281 sgml-local-catalogs: nil
 282 sgml-namecase-general:t
 283 End:
 284 -->