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 <!-- $Id: pazpar2.xml,v 1.9 2007-07-10 09:18:49 adam Exp $ -->
  12 <refentry id="pazpar2">
  13  <refentryinfo>
  14   <productname>Pazpar2</productname>
  15   <productnumber>&version;</productnumber>
  16  </refentryinfo>
  17  <refmeta>
  18   <refentrytitle>Pazpar2</refentrytitle>
  19   <manvolnum>8</manvolnum>
  20  </refmeta>
  21
  22  <refnamediv>
  23   <refname>pazpar2</refname>
  24   <refpurpose>Metasearch daemon.</refpurpose>
  25  </refnamediv>
  26
  27  <refsynopsisdiv>
  28   <cmdsynopsis>
  29    <command>pazpar2</command>
  30    <arg choice="opt"><option>-d</option></arg>
  31    <arg choice="opt"><option>-D</option></arg>
  32    <arg choice="opt"><option>-f <replaceable>config</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>-X</option></arg>
  38   </cmdsynopsis>
  39  </refsynopsisdiv>
  40
  41  <refsect1><title>DESCRIPTION</title>
  42   <para><command>pazpar2</command> is the Pazpar2 Metasearch daemon
  43    and server.
  44    In normal operation it acts as a simple HTTP server which serves
  45    the Pazpar2 protocol.
  46    The HTTP listener address may be given on the command line using
  47    option <option>-h</option> or in the main configuration
  48    file. The main configuration must be specified using option
  49    <option>-f</option>.
  50   </para>
  51  </refsect1>
  52
  53  <refsect1><title>OPTIONS</title>
  54   <para></para>
  55
  56   <variablelist>
  57    <varlistentry>
  58     <term><option>-d</option></term>
  59     <listitem>
  60      <para>
  61       Enables dump of XML records. It is useful if stylesheets are
  62       being debugged.
  63      </para>
  64     </listitem>
  65    </varlistentry>
  66    <varlistentry>
  67     <term><option>-D</option></term>
  68     <listitem>
  69      <para>Puts the Pazpar2 server in the background.</para>
  70     </listitem>
  71    </varlistentry>
  72    <varlistentry>
  73     <term><option>-f <replaceable>config</replaceable></option></term>
  74     <listitem>
  75      <para>
  76       Specifies main configuration. This option must be specified
  77       in order for Pazpar2 to operate normally.
  78      </para>
  79     </listitem>
  80    </varlistentry>
  81    <varlistentry>
  82     <term><option>-l <replaceable>logfile</replaceable></option></term>
  83     <listitem>
  84      <para>
  85       Specifies log file. The log file must be specified when Pazpar2
  86       is running in the background (-D).
  87      </para>
  88     </listitem>
  89    </varlistentry>
  90    <varlistentry>
  91     <term><option>-p <replaceable>pidfile</replaceable></option></term>
  92     <listitem>
  93      <para>
  94       Specifies PID file. If Pazpar2 is started and configured properly
  95       the file given holds the process ID of the Pazpar2 process.
  96      </para>
  97     </listitem>
  98    </varlistentry>
  99    <varlistentry>
 100     <term><option>-t <replaceable>path</replaceable></option></term>
 101     <listitem>
 102      <para>
 103       Specifies a file or directory with alternative settings. This
 104       overrides the <literal>settings</literal> element in the main
 105       configuration.
 106      </para>
 107     </listitem>
 108    </varlistentry>
 109
 110    <varlistentry>
 111     <term><option>-u <replaceable>uid</replaceable></option></term>
 112     <listitem>
 113      <para>
 114       Makes the Pazpar2 server change user ID to the
 115       <replaceable>uid</replaceable> given.
 116       This, normally, require root privilege.
 117      </para>
 118     </listitem>
 119    </varlistentry>
 120
 121    <varlistentry>
 122     <term><option>-X</option></term>
 123     <listitem>
 124      <para>
 125       Makes the Pazpar2 server operate in debugging mode.
 126       This prevents Pazpar2 from making separate threads and processes.
 127       This option should not be used in production.
 128      </para>
 129     </listitem>
 130    </varlistentry>
 131
 132   </variablelist>
 133
 134  </refsect1>
 135
 136  <refsect1><title>EXAMPLES</title>
 137   <para>The Debian package of pazpar2 starts the server with:
 138    <screen>
 139     pazpar2 -D -f /etc/pazpar2/pazpar2.cfg -l /var/log/pazpar2.log -p /var/run/pazpar2.pid -u nobody
 140    </screen>
 141    (one line).
 142   </para>
 143   <para>
 144    This will put pazpar2 in the background (-D), read config from from
 145    <filename>/etc/pazpar2/pazpar2.cfg</filename>, log messages to
 146    <filename>/var/log/pazpar2.log</filename>, create PID file
 147    <filename>/var/run/pazpar2.pid</filename>. When the daemon is properly
 148    started, the server will change effective user ID to nobody.
 149   </para>
 150   <para>
 151    The server can be terminated with:
 152    <screen>
 153     kill `cat /var/run/pazpar2.pid`
 154    </screen>
 155   </para>
 156   <para>
 157    If Pazpar2 is to be debugged using GDB, we use option -X:
 158    <screen>
 159     cd pazpar2/src
 160     gdb ./pazpar2
 161     (gdb) run -X -f ../etc/pazpar2.cfg
 162    </screen>
 163   </para>
 164  </refsect1>
 165
 166  <refsect1><title>FILES</title>
 167   <para><filename>/usr/sbin/pazpar2</filename>: pazpar2 daemon</para>
 168
 169   <para><filename>/usr/share/pazpar2</filename>: pazpar2 shared files</para>
 170
 171   <para><filename>/etc/pazpar2</filename>: pazpar2 config area</para>
 172  </refsect1>
 173
 174  <refsect1><title>SEE ALSO</title>
 175   <para>
 176    Pazpar2 configuration:
 177    <citerefentry>
 178     <refentrytitle>pazpar2_conf</refentrytitle>
 179     <manvolnum>5</manvolnum>
 180    </citerefentry>
 181   </para>
 182   <para>
 183    Pazpar2 protocol:
 184    <citerefentry>
 185     <refentrytitle>pazpar2_protocol</refentrytitle>
 186     <manvolnum>7</manvolnum>
 187    </citerefentry>
 188   </para>
 189  </refsect1>
 190
 191 </refentry>
 192
 193
 194 <!-- Keep this comment at the end of the file
 195 Local variables:
 196 mode: sgml
 197 sgml-omittag:t
 198 sgml-shorttag:t
 199 sgml-minimize-attributes:nil
 200 sgml-always-quote-attributes:t
 201 sgml-indent-step:1
 202 sgml-indent-data:t
 203 sgml-parent-document:nil
 204 sgml-local-catalogs: nil
 205 sgml-namecase-general:t
 206 End:
 207 -->