Update doc/common because of new entities

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

diff --git a/doc/pazpar2.xml b/doc/pazpar2.xml
index 54f92b4..fde6da4 100644 (file)
--- a/doc/pazpar2.xml
+++ b/doc/pazpar2.xml
@@ -32,10 +32,10 @@
    <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>-p <replaceable>pidfile</replaceable></option></arg>
-   <arg choice="opt"><option>-t <replaceable>path</replaceable></option></arg>
-   <arg choice="opt"><option>-T <replaceable>session_timeout</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>-X</option></arg>
    <arg choice="opt"><option>-install</option></arg>
    <arg choice="opt"><option>-remove</option></arg>
@@ -65,6 +65,11 @@
       Enables dump of XML records to the current log file.
       It is useful if stylesheets are being debugged.
      </para>
+     <para>
+      This option may also be used together with option <option>-t</option>
+      in which case the configuration, after include processing, will be
+      dumped to stdout.
+     </para>
     </listitem>
    </varlistentry>
    <varlistentry>
@@ -113,22 +118,23 @@
    </varlistentry>
 
    <varlistentry>
-    <term><option>-t <replaceable>path</replaceable></option></term>
+    <term><option>-t</option></term>
     <listitem>
      <para>
-      Specifies a file or directory with alternative settings. This
-      overrides the <literal>settings</literal> element in the main
-      configuration.
+      Checks parameters and configuration. No service or daemon is
+      started. Useful for checking a new configuration before a
+      Pazpar2 is restarted.
      </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term><option>-T <replaceable>session_timeout</replaceable></option></term>
-    <listitem>
      <para>
-      Specifies a Pazpar2 HTTP session timeout. This
-      overrides the default value of 60 seconds which is to low for some broken browser.
+      The configuration, after include processing, may also be dumped
+      to stdout by supplying option <option>-d</option> as well.
      </para>
+     <note>
+      <para>
+       In Pazpar2 1.2 and earlier releases, option -t specified a
+       local target settings file.
+      </para>
+     </note>
     </listitem>
    </varlistentry>
 
@@ -148,13 +154,22 @@
     <listitem>
      <para>
       Shows Pazpar2 version and versions of some of the components that it
-      is using (ICU and YAZ). Pazpar2 will not exit immediately after
+      is using (ICU and YAZ). Pazpar2 will exit immediately after
       displaying the version information (no daemon started).
      </para>
     </listitem>
    </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>-X</option></term>
     <listitem>
      <para>