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