Pazpar2 1.4.4-2 for squeeze

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

diff --git a/doc/pazpar2.xml b/doc/pazpar2.xml
index 5b7fb9b..fde6da4 100644 (file)
--- a/doc/pazpar2.xml
+++ b/doc/pazpar2.xml
@@ -8,7 +8,6 @@
      <!ENTITY % idcommon SYSTEM "common/common.ent">
      %idcommon;
 ]>
-<!-- $Id: pazpar2.xml,v 1.10 2007-07-16 08:58:12 adam Exp $ -->
 <refentry id="pazpar2">
  <refentryinfo>
   <productname>Pazpar2</productname>
@@ -33,9 +32,13 @@
    <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</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>
  
@@ -59,9 +62,14 @@
     <term><option>-d</option></term>
     <listitem>
      <para>
-      Enables dump of normalized XML records to the current log file.
+      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>
@@ -108,14 +116,25 @@
      </para>
     </listitem>
    </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>
+     <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>
 
@@ -125,7 +144,27 @@
      <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>
+
+   <varlistentry>
+    <term><option>-V</option></term>
+    <listitem>
+     <para>
+      Shows Pazpar2 version and versions of some of the components that it
+      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>
@@ -141,6 +180,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>