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