doc/pazpar2.xml

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