doc/pazpar2_play.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
   2  "http://www.oasis-open.org/docbook/xml/4.4/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_play">
  12  <refentryinfo>
  13   <productname>Pazpar2_Play</productname>
  14   <productnumber>&version;</productnumber>
  15   <info><orgname>Index Data</orgname></info>
  16  </refentryinfo>
  17
  18  <refmeta>
  19   <refentrytitle>Pazpar2_Play</refentrytitle>
  20   <manvolnum>1</manvolnum>
  21   <refmiscinfo class="manual">User Commands</refmiscinfo>
  22  </refmeta>
  23  <refnamediv>
  24   <refname>pazpar2_play</refname>
  25   <refpurpose>Play recorded HTTP log against pazpar2</refpurpose>
  26  </refnamediv>
  27  <refsynopsisdiv>
  28   <cmdsynopsis>
  29    <command>pazpar2_play</command>
  30    <arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
  31    <arg choice="opt">file</arg>
  32    <arg choice="opt">server-addr</arg>
  33   </cmdsynopsis>
  34  </refsynopsisdiv>
  35  <refsect1>
  36   <title>DESCRIPTION</title>
  37   <para>
  38    <command>pazpar2_play</command> is a utility that plays recorded
  39    HTTP activity against pazpar2. Pazpar2 may record activity to a file
  40    with option -R. This utilility allow you to play the activity again
  41    against pazpar2. Pazpar2 must use predictable sessions in order for this
  42    to work. This means that either Pazpar2 should be executed with option -R.
  43   </para>
  44  </refsect1>
  45  <refsect1>
  46   <title>OPTIONS</title>
  47   <variablelist>
  48    <varlistentry>
  49     <term><option>-v <replaceable>level</replaceable></option></term>
  50     <listitem>
  51      <para>
  52       Sets log level (YAZ log level system).
  53      </para>
  54     </listitem>
  55    </varlistentry>
  56   </variablelist>
  57  </refsect1>
  58  <refsect1>
  59   <title>EXAMPLES</title>
  60   <para>
  61    Typical usage. First step is to enable recording in pazpar2.
  62    Something like:
  63    <screen>
  64     pazpar2 -f config.xml -R /tmp/recording.log
  65    </screen>
  66    For RPM version of Pazpar2, add/modify
  67    <filename>/etc/sysconfig/pazpar2</filename> and modify OPTIONS.
  68    For Debian version of Pazpar2 add/modify
  69    <filename>/etc/defaults/pazpar2</filename> and modify OPTIONS.
  70   </para>
  71   <para>
  72    At some point we want to run recording.. Perhaps against another
  73    Pazpar2 instance for analysis. We start Pazpar2 with -R- to ensure
  74    that sessions are numbered in the same way initial recording.
  75    <screen>
  76     pazpar2 -f config.xml -R -
  77    </screen>
  78    We can now run the player against it:
  79    <screen>
  80     pazpar2_play /tmp/recording.log localhost:9004
  81    </screen>
  82   </para>
  83  </refsect1>
  84  <refsect1>
  85   <title>SEE ALSO</title>
  86   <para>
  87    Pazpar2 configuration:
  88    <citerefentry>
  89     <refentrytitle>pazpar2</refentrytitle>
  90     <manvolnum>8</manvolnum>
  91    </citerefentry>
  92   </para>
  93  </refsect1>
  94
  95 </refentry>
  96
  97 <!-- Keep this comment at the end of the file
  98 Local variables:
  99 mode: nxml
 100 nxml-child-indent: 1
 101 End:
 102 -->