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