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