Happy new year

[pazpar2-moved-to-github.git] / doc / pazpar2.xml

diff --git a/doc/pazpar2.xml b/doc/pazpar2.xml
index b132a70..1d92355 100644 (file)
--- a/doc/pazpar2.xml
+++ b/doc/pazpar2.xml
@@ -12,10 +12,13 @@
  <refentryinfo>
   <productname>Pazpar2</productname>
   <productnumber>&version;</productnumber>
+  <orgname>Index Data</orgname>
  </refentryinfo>
+
  <refmeta>
   <refentrytitle>Pazpar2</refentrytitle>
   <manvolnum>8</manvolnum>
+  <refmiscinfo class="manual">System management commands</refmiscinfo>
  </refmeta>
  
  <refnamediv>
@@ -31,19 +34,24 @@
    <arg choice="opt"><option>-f <replaceable>config</replaceable></option></arg>
    <arg choice="opt"><option>-h <replaceable>ip:port</replaceable></option></arg>
    <arg choice="opt"><option>-l <replaceable>logfile</replaceable></option></arg>
+   <arg choice="opt"><option>-m <replaceable>timeformat</replaceable></option></arg>
    <arg choice="opt"><option>-p <replaceable>pidfile</replaceable></option></arg>
+   <arg choice="opt"><option>-R <replaceable>recfile</replaceable></option></arg>
    <arg choice="opt"><option>-t</option></arg>
    <arg choice="opt"><option>-u <replaceable>uid</replaceable></option></arg>
-   <arg choice="opt"><option>-V</option></arg>
    <arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
+   <arg choice="opt"><option>-V</option></arg>
+   <arg choice="opt"><option>-w <replaceable>dir</replaceable></option></arg>
    <arg choice="opt"><option>-X</option></arg>
    <arg choice="opt"><option>-install</option></arg>
    <arg choice="opt"><option>-remove</option></arg>
   </cmdsynopsis>
  </refsynopsisdiv>
  
- <refsect1><title>DESCRIPTION</title>
-  <para><command>pazpar2</command> is the Pazpar2 Metasearch daemon
+ <refsect1>
+  <title>DESCRIPTION</title>
+  <para>
+   <command>pazpar2</command> is the Pazpar2 Metasearch daemon
    and server.
    In normal operation it acts as a simple HTTP server which serves
    the Pazpar2 protocol.
@@ -54,8 +62,8 @@
   </para>
  </refsect1>
  
- <refsect1><title>OPTIONS</title>
-  <para></para>
+ <refsect1>
+  <title>OPTIONS</title>
   
   <variablelist>
    <varlistentry>
@@ -63,7 +71,8 @@
     <listitem>
      <para>
       Enables dump of XML records to the current log file.
-      It is useful if stylesheets are being debugged.
+      It is useful if stylesheets are being debugged. Using this option
+      twice makes Pazpar2 also dump full HTTP responses.
      </para>
      <para>
       This option may also be used together with option <option>-t</option>
@@ -75,7 +84,9 @@
    <varlistentry>
     <term><option>-D</option></term>
     <listitem>
-     <para>Puts the Pazpar2 server in the background.</para>
+     <para>
+     Puts the Pazpar2 server in the background.
+     </para>
     </listitem>
    </varlistentry>
    <varlistentry>
@@ -108,6 +119,17 @@
     </listitem>
    </varlistentry>
    <varlistentry>
+    <term>-m <replaceable>timeformat</replaceable></term>
+    <listitem><para>
+     Sets the format of time-stamps for logging.
+     Refer to the
+       <ulink
+          url="http://pubs.opengroup.org/onlinepubs/009695399/functions/strftime.html">
+       strftime(3)</ulink>
+       man page for the format.
+    </para></listitem>
+   </varlistentry>
+   <varlistentry>
     <term><option>-p <replaceable>pidfile</replaceable></option></term>
     <listitem>
      <para>
@@ -116,6 +138,20 @@
      </para>
     </listitem>
    </varlistentry>
+   <varlistentry>
+    <term><option>-R <replaceable>recfile</replaceable></option></term>
+    <listitem>
+     <para>
+      If this option is given, HTTP requests are logged to file named
+      <replaceable>recfile</replaceable> and predictable sessions are enabled.
+      Using special argument, dash
+      (<literal>-</literal>), will make Pazpar2 use predictable sessions
+      only (no recording).
+      This is necessary when playing HTTP communication against pazpar2
+      with the pazpar2_play program. Refer to <xref linkend="pazpar2_play"/>.
+     </para>
+    </listitem>
+   </varlistentry>
 
    <varlistentry>
     <term><option>-t</option></term>
@@ -150,6 +186,15 @@
    </varlistentry>
 
    <varlistentry>
+    <term><option>-v <replaceable>level</replaceable></option></term>
+    <listitem>
+     <para>
+      Sets log level (YAZ log level system).
+     </para>
+    </listitem>
+   </varlistentry>
+
+   <varlistentry>
     <term><option>-V</option></term>
     <listitem>
      <para>
@@ -161,10 +206,10 @@
    </varlistentry>
 
    <varlistentry>
-    <term><option>-v <replaceable>level</replaceable></option></term>
+    <term><option>-w <replaceable>dir</replaceable></option></term>
     <listitem>
      <para>
-      Sets log level (YAZ log level system).
+      Changes working directory to <replaceable>dir</replaceable>.
      </para>
     </listitem>
    </varlistentry>
@@ -184,14 +229,14 @@
     <term><option>-install</option></term>
     <listitem>
      <para>
-       This is an option which is only recognized on Windows. It installs
-       Pazpar2 as a Windows Service.
+      This is an option which is only recognized on Windows. It installs
+      Pazpar2 as a Windows Service.
      </para>
      <note>
-       <para>
-        Pazpar2 only supports Windows Service options if Pazpar2 is
-        linked against YAZ 3.0.29 or later.
-       </para>
+      <para>
+       Pazpar2 only supports Windows Service options if Pazpar2 is
+       linked against YAZ 3.0.29 or later.
+      </para>
      </note>
     </listitem>
    </varlistentry>
@@ -200,8 +245,8 @@
     <term><option>-remove</option></term>
     <listitem>
      <para>
-       This is an option which is only recognized on Windows. It removes
-       a Pazpar2 - Windows Service.
+      This is an option which is only recognized on Windows. It removes
+      a Pazpar2 - Windows Service.
      </para>
     </listitem>
    </varlistentry>
@@ -210,7 +255,8 @@
   
  </refsect1>
  
- <refsect1><title>EXAMPLES</title>
+ <refsect1>
+  <title>EXAMPLES</title>
   <para>The Debian package of pazpar2 starts the server with:
    <screen>
     pazpar2 -D -f /etc/pazpar2/pazpar2.cfg -l /var/log/pazpar2.log -p /var/run/pazpar2.pid -u nobody
@@ -240,15 +286,17 @@
   </para>
  </refsect1> 
  
- <refsect1><title>FILES</title>
+ <refsect1>
+  <title>FILES</title>
   <para><filename>/usr/sbin/pazpar2</filename>: pazpar2 daemon</para>
-
+  
   <para><filename>/usr/share/pazpar2</filename>: pazpar2 shared files</para>
-
+  
   <para><filename>/etc/pazpar2</filename>: pazpar2 config area</para>
  </refsect1>
  
- <refsect1><title>SEE ALSO</title>
+ <refsect1>
+  <title>SEE ALSO</title>
   <para>
    Pazpar2 configuration:
    <citerefentry>
@@ -263,22 +311,20 @@
     <manvolnum>7</manvolnum>
    </citerefentry>
   </para>
+  <para>
+   Pazpar2 player:
+   <citerefentry>
+    <refentrytitle>pazpar2_play</refentrytitle>
+    <manvolnum>1</manvolnum>
+   </citerefentry>
+  </para>
  </refsect1>
 
 </refentry>
 
-
 <!-- Keep this comment at the end of the file
 Local variables:
-mode: sgml
-sgml-omittag:t
-sgml-shorttag:t
-sgml-minimize-attributes:nil
-sgml-always-quote-attributes:t
-sgml-indent-step:1
-sgml-indent-data:t
-sgml-parent-document:nil
-sgml-local-catalogs: nil
-sgml-namecase-general:t
+mode: nxml
+nxml-child-indent: 1
 End:
 -->