Adds the template fields page and endpage, #4204

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

diff --git a/doc/pazpar2.xml b/doc/pazpar2.xml
index 48b2d4a..32b499c 100644 (file)
--- a/doc/pazpar2.xml
+++ b/doc/pazpar2.xml
@@ -1,5 +1,5 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
- "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
+ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
 [
      <!ENTITY % local SYSTEM "local.ent">
      %local;
@@ -12,10 +12,13 @@
  <refentryinfo>
   <productname>Pazpar2</productname>
   <productnumber>&version;</productnumber>
+  <info><orgname>Index Data</orgname></info>
  </refentryinfo>
+
  <refmeta>
   <refentrytitle>Pazpar2</refentrytitle>
   <manvolnum>8</manvolnum>
+  <refmiscinfo class="manual">System management commands</refmiscinfo>
  </refmeta>
  
  <refnamediv>
@@ -32,10 +35,14 @@
    <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>-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>-X</option></arg>
+   <arg choice="opt"><option>-install</option></arg>
+   <arg choice="opt"><option>-remove</option></arg>
   </cmdsynopsis>
  </refsynopsisdiv>
  
@@ -62,6 +69,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>
@@ -109,23 +121,43 @@
     </listitem>
    </varlistentry>
    <varlistentry>
-    <term><option>-t <replaceable>path</replaceable></option></term>
+    <term><option>-R <replaceable>recfile</replaceable></option></term>
     <listitem>
      <para>
-      Specifies a file or directory with alternative settings. This
-      overrides the <literal>settings</literal> element in the main
-      configuration.
+      If this option is given, HTTP requests are logged to file named
+      <replaceable>recfile</replaceable>.
      </para>
     </listitem>
    </varlistentry>
 
    <varlistentry>
+    <term><option>-t</option></term>
+    <listitem>
+     <para>
+      Checks parameters and configuration. No service or daemon is
+      started. Useful for checking a new configuration before a
+      Pazpar2 is restarted.
+     </para>
+     <para>
+      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>
+
+   <varlistentry>
     <term><option>-u <replaceable>uid</replaceable></option></term>
     <listitem>
      <para>
       Makes the Pazpar2 server change user ID to the
       <replaceable>uid</replaceable> given.
-      This, normally, require root privilege.
+      This, normally, requires root privilege.
      </para>
     </listitem>
    </varlistentry>
@@ -135,13 +167,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>
@@ -152,6 +193,32 @@
     </listitem>
    </varlistentry>
 
+   <varlistentry>
+    <term><option>-install</option></term>
+    <listitem>
+     <para>
+       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>
+     </note>
+    </listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term><option>-remove</option></term>
+    <listitem>
+     <para>
+       This is an option which is only recognized on Windows. It removes
+       a Pazpar2 - Windows Service.
+     </para>
+    </listitem>
+   </varlistentry>
+
   </variablelist>
   
  </refsect1>