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 <replaceable>path</replaceable></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    <varlistentry>
 114     <term><option>-t <replaceable>path</replaceable></option></term>
 115     <listitem>
 116      <para>
 117       Specifies a file or directory with alternative settings. This
 118       overrides the <literal>settings</literal> element in the main
 119       configuration.
 120      </para>
 121     </listitem>
 122    </varlistentry>
 123
 124    <varlistentry>
 125     <term><option>-u <replaceable>uid</replaceable></option></term>
 126     <listitem>
 127      <para>
 128       Makes the Pazpar2 server change user ID to the
 129       <replaceable>uid</replaceable> given.
 130       This, normally, requires root privilege.
 131      </para>
 132     </listitem>
 133    </varlistentry>
 134
 135    <varlistentry>
 136     <term><option>-V</option></term>
 137     <listitem>
 138      <para>
 139       Shows Pazpar2 version and versions of some of the components that it
 140       is using (ICU and YAZ). Pazpar2 will not exit immediately after
 141       displaying the version information (no daemon started).
 142      </para>
 143     </listitem>
 144    </varlistentry>
 145
 146    <varlistentry>
 147     <term><option>-X</option></term>
 148     <listitem>
 149      <para>
 150       Makes the Pazpar2 server operate in debugging mode.
 151       This prevents Pazpar2 from making separate threads and processes.
 152       This option should not be used in production.
 153      </para>
 154     </listitem>
 155    </varlistentry>
 156
 157    <varlistentry>
 158     <term><option>-install</option></term>
 159     <listitem>
 160      <para>
 161        This is an option which is only recognized on Windows. It installs
 162        Pazpar2 as a Windows Service.
 163      </para>
 164      <note>
 165        <para>
 166          Pazpar2 only supports Windows Service options if Pazpar2 is
 167          linked against YAZ 3.0.29 or later.
 168        </para>
 169      </note>
 170     </listitem>
 171    </varlistentry>
 172
 173    <varlistentry>
 174     <term><option>-remove</option></term>
 175     <listitem>
 176      <para>
 177        This is an option which is only recognized on Windows. It removes
 178        a Pazpar2 - Windows Service.
 179      </para>
 180     </listitem>
 181    </varlistentry>
 182
 183   </variablelist>
 184
 185  </refsect1>
 186
 187  <refsect1><title>EXAMPLES</title>
 188   <para>The Debian package of pazpar2 starts the server with:
 189    <screen>
 190     pazpar2 -D -f /etc/pazpar2/pazpar2.cfg -l /var/log/pazpar2.log -p /var/run/pazpar2.pid -u nobody
 191    </screen>
 192    (one line).
 193   </para>
 194   <para>
 195    This will put pazpar2 in the background (-D), read config from from
 196    <filename>/etc/pazpar2/pazpar2.cfg</filename>, log messages to
 197    <filename>/var/log/pazpar2.log</filename>, create PID file
 198    <filename>/var/run/pazpar2.pid</filename>. When the daemon is properly
 199    started, the server will change effective user ID to nobody.
 200   </para>
 201   <para>
 202    The server can be terminated with:
 203    <screen>
 204     kill `cat /var/run/pazpar2.pid`
 205    </screen>
 206   </para>
 207   <para>
 208    If Pazpar2 is to be debugged using GDB, we use option -X:
 209    <screen>
 210     cd pazpar2/src
 211     gdb ./pazpar2
 212     (gdb) run -X -f ../etc/pazpar2.cfg
 213    </screen>
 214   </para>
 215  </refsect1>
 216
 217  <refsect1><title>FILES</title>
 218   <para><filename>/usr/sbin/pazpar2</filename>: pazpar2 daemon</para>
 219
 220   <para><filename>/usr/share/pazpar2</filename>: pazpar2 shared files</para>
 221
 222   <para><filename>/etc/pazpar2</filename>: pazpar2 config area</para>
 223  </refsect1>
 224
 225  <refsect1><title>SEE ALSO</title>
 226   <para>
 227    Pazpar2 configuration:
 228    <citerefentry>
 229     <refentrytitle>pazpar2_conf</refentrytitle>
 230     <manvolnum>5</manvolnum>
 231    </citerefentry>
 232   </para>
 233   <para>
 234    Pazpar2 protocol:
 235    <citerefentry>
 236     <refentrytitle>pazpar2_protocol</refentrytitle>
 237     <manvolnum>7</manvolnum>
 238    </citerefentry>
 239   </para>
 240  </refsect1>
 241
 242 </refentry>
 243
 244
 245 <!-- Keep this comment at the end of the file
 246 Local variables:
 247 mode: sgml
 248 sgml-omittag:t
 249 sgml-shorttag:t
 250 sgml-minimize-attributes:nil
 251 sgml-always-quote-attributes:t
 252 sgml-indent-step:1
 253 sgml-indent-data:t
 254 sgml-parent-document:nil
 255 sgml-local-catalogs: nil
 256 sgml-namecase-general:t
 257 End:
 258 -->