Describe option -u and -p

[yazpp-moved-to-github.git] / doc / yaz-proxy-ref.xml

diff --git a/doc/yaz-proxy-ref.xml b/doc/yaz-proxy-ref.xml
index 776f28a..044ff33 100644 (file)
--- a/doc/yaz-proxy-ref.xml
+++ b/doc/yaz-proxy-ref.xml
@@ -13,10 +13,12 @@
   <arg choice="opt">-m <replaceable>num</replaceable></arg>
   <arg choice="opt">-v <replaceable>level</replaceable></arg>
   <arg choice="opt">-t <replaceable>target</replaceable></arg>
-  <arg choice="opt">-u <replaceable>auth</replaceable></arg>
+  <arg choice="opt">-U <replaceable>auth</replaceable></arg>
   <arg choice="opt">-o <replaceable>level</replaceable></arg>
   <arg choice="opt">-i <replaceable>seconds</replaceable></arg>
   <arg choice="opt">-T <replaceable>seconds</replaceable></arg>
+  <arg choice="opt">-p <replaceable>pidfile</replaceable></arg>
+  <arg choice="opt">-u <replaceable>userid</replaceable></arg>
   <arg choice="opt">-c <replaceable>config</replaceable></arg>
   <arg choice="req"><replaceable>host</replaceable>:<replaceable>port</replaceable></arg>
  </cmdsynopsis>
@@ -73,7 +75,7 @@
      <literal>initRequest</literal>.
     </para></listitem>
   </varlistentry>
-  <varlistentry><term>-u <replaceable>auth</replaceable></term>
+  <varlistentry><term>-U <replaceable>auth</replaceable></term>
    <listitem><para>
      Specifies authentication info to be sent to the backend target.
      This is useful if you happen to have an internal target that
@@ -104,6 +106,21 @@
      it willl be closed. Default: 600 seconds (10 minutes).
     </para></listitem>
   </varlistentry>
+  <varlistentry><term>-p <replaceable>pidfile</replaceable></term>
+   <listitem><para>
+     When specified, yaz-proxy will create <replaceable>pidfile</replaceable>
+     with the process ID of the proxy. The pidfile will be generated
+     before the process changes identity (see option <literal>-u</literal>).
+    </para></listitem>
+  </varlistentry>
+  <varlistentry><term>-u <replaceable>userid</replaceable></term>
+   <listitem><para>
+     When specified, yaz-proxy will change identity to the user ID
+     specified, just after the proxy has started listening to a
+     possibly priviledged port and after the PID file has been created
+     if specified by option <literal>-u</literal>.
+    </para></listitem>
+  </varlistentry>
   <varlistentry><term>-c <replaceable>config</replaceable></term>
    <listitem><para>
      Specifies config filename. Configuration is in XML