Updates to pz:authentication documentation

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

diff --git a/doc/pazpar2.xml b/doc/pazpar2.xml
index 9e346e8..7caf310 100644 (file)
--- a/doc/pazpar2.xml
+++ b/doc/pazpar2.xml
@@ -34,12 +34,14 @@
    <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>
@@ -69,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>
@@ -116,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>
@@ -129,7 +143,12 @@
     <listitem>
      <para>
       If this option is given, HTTP requests are logged to file named
-      <replaceable>recfile</replaceable>.
+      <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>
@@ -167,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>
@@ -178,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>
@@ -283,6 +311,13 @@
     <manvolnum>7</manvolnum>
    </citerefentry>
   </para>
+  <para>
+   Pazpar2 player:
+   <citerefentry>
+    <refentrytitle>pazpar2_play</refentrytitle>
+    <manvolnum>1</manvolnum>
+   </citerefentry>
+  </para>
  </refsect1>
 
 </refentry>