X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=doc%2Fpazpar2.xml;h=16581d30123724a057577b6003ec0c0f24402f37;hb=babdf4ba693f4a79037d8cf8cecc109e9355ec0d;hp=b7394056202afd1e4db0e17c0eb0ad26b1fd42b6;hpb=98e1ff5ebcca708e56e87ed5ff3596cdf9b2ae1a;p=pazpar2-moved-to-github.git

diff --git a/doc/pazpar2.xml b/doc/pazpar2.xml
index b739405..16581d3 100644
--- a/doc/pazpar2.xml
+++ b/doc/pazpar2.xml
@@ -8,7 +8,6 @@
      <!ENTITY % idcommon SYSTEM "common/common.ent">
      %idcommon;
 ]>
-<!-- $Id: pazpar2.xml,v 1.7 2007-06-22 13:18:23 adam Exp $ -->
 <refentry id="pazpar2">
  <refentryinfo>
   <productname>Pazpar2</productname>
@@ -30,11 +29,16 @@
    <arg choice="opt"><option>-d</option></arg>
    <arg choice="opt"><option>-D</option></arg>
    <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>-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>
  
@@ -58,8 +62,8 @@
     <term><option>-d</option></term>
     <listitem>
      <para>
-      Enables dump of XML records. It is useful if stylesheets are
-      being debugged.
+      Enables dump of XML records to the current log file.
+      It is useful if stylesheets are being debugged.
      </para>
     </listitem>
    </varlistentry>
@@ -79,6 +83,17 @@
     </listitem>
    </varlistentry>
    <varlistentry>
+    <term><option>-h <replaceable>ip:port</replaceable></option></term>
+    <listitem>
+     <para>
+      Specifies the HTTP listener binding address.
+      The <replaceable>ip</replaceable>
+      may be a hostname or <literal>@</literal> for "any" address.
+      The <replaceable>port</replaceable> is an integer.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
     <term><option>-l <replaceable>logfile</replaceable></option></term>
     <listitem>
      <para>
@@ -96,14 +111,21 @@
      </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>
+     <note>
+      <para>
+       In Pazpar2 1.2 and earlier releasese, option -t specified a
+       local target settings file.
+      </para>
+     </note>
     </listitem>
    </varlistentry>
 
@@ -113,7 +135,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>
@@ -129,16 +171,72 @@
     </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>
  
  <refsect1><title>EXAMPLES</title>
-  <para>None yet</para>
+  <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
+   </screen>
+   (one line). 
+  </para>
+  <para>
+   This will put pazpar2 in the background (-D), read config from from
+   <filename>/etc/pazpar2/pazpar2.cfg</filename>, log messages to
+   <filename>/var/log/pazpar2.log</filename>, create PID file
+   <filename>/var/run/pazpar2.pid</filename>. When the daemon is properly
+   started, the server will change effective user ID to nobody.
+  </para>
+  <para>
+   The server can be terminated with:
+   <screen>
+    kill `cat /var/run/pazpar2.pid`
+   </screen>
+  </para>
+  <para>
+   If Pazpar2 is to be debugged using GDB, we use option -X:
+   <screen>
+    cd pazpar2/src
+    gdb ./pazpar2
+    (gdb) run -X -f ../etc/pazpar2.cfg
+   </screen>
+  </para>
  </refsect1> 
  
  <refsect1><title>FILES</title>
-  <para></para>
+  <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>
@@ -150,7 +248,7 @@
    </citerefentry>
   </para>
   <para>
-   Pazpar2 protocol:.
+   Pazpar2 protocol:
    <citerefentry>
     <refentrytitle>pazpar2_protocol</refentrytitle>
     <manvolnum>7</manvolnum>