Describe option -u and -p
authorAdam Dickmeiss <adam@indexdata.dk>
Fri, 24 Oct 2003 11:18:51 +0000 (11:18 +0000)
committerAdam Dickmeiss <adam@indexdata.dk>
Fri, 24 Oct 2003 11:18:51 +0000 (11:18 +0000)
doc/installation.xml
doc/yaz-proxy-ref.xml

index 7ee6300..259a59d 100644 (file)
@@ -1,5 +1,5 @@
 <chapter id="installation">
-  <!-- $Id: installation.xml,v 1.7 2002-10-30 10:27:37 adam Exp $ -->
+  <!-- $Id: installation.xml,v 1.8 2003-10-24 11:18:51 adam Exp $ -->
   <title>Installation</title>
   <para>
    You need a C++ compiler to compile and use YAZ++.
     <literal>./configure --help</literal>.
    </para>
    <para>
+    Configure uses GCC's C/C++ compiler if available. To specify another
+    compiler, set <literal>CXX</literal>. To use other compiler flags,
+    specify <literal>CXXFLAGS</literal>. To use <literal>CC</literal> 
+    with debugging you could use:
+    <screen>
+     CXXFLAGS="-g" CXX=CC ./configure
+    </screen>
+   </para>
+   <para>
     This is what you have after successful compilation:
     <variablelist>
      <varlistentry>
index 776f28a..044ff33 100644 (file)
   <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
      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