Towards documenting the settings system

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

diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml
index 4e04980..fac262d 100644 (file)
--- a/doc/pazpar2_conf.xml
+++ b/doc/pazpar2_conf.xml
@@ -8,7 +8,7 @@
      <!ENTITY % common SYSTEM "common/common.ent">
      %common;
 ]>
-<!-- $Id: pazpar2_conf.xml,v 1.7 2007-01-26 18:53:55 quinn Exp $ -->
+<!-- $Id: pazpar2_conf.xml,v 1.10 2007-03-30 00:13:45 quinn Exp $ -->
 <refentry id="pazpar2_conf">
  <refentryinfo>
   <productname>Pazpar2</productname>
@@ -84,7 +84,10 @@
              If this item is given, pazpar2 will forward all incoming HTTP
              requests that do not contain the filename 'search.pz2' to the
              host and port specified using the 'host' and 'port'
-             attributes. This functionality is crucial if you wish to use
+             attributes. The 'myurl' attribute is required, and should provide
+             the base URL of the server. Generally, the HTTP URL for the host
+             specified in the 'listen' parameter. This functionality is
+             crucial if you wish to use
              pazpar2 in conjunction with browser-based code (JS, Flash,
              applets, etc.) which operates in a security sandbox. Such code
              can only connect to the same server from which the enclosing
@@ -98,6 +101,21 @@
        </varlistentry>
 
        <varlistentry>
+         <term>zproxy</term>
+         <listitem>
+           <para>
+             If this item is given, pazpar2 will send all Z39.50
+             packages through this Z39.50 proxy server.
+              At least one of the 'host' and 'post' attributes is required.
+              The 'host' attribute may contain both host name and port
+             number, seperated by a colon ':', or only the host name.
+              An empty 'host' attribute sets the Z39.50 host address
+             to 'localhost'.  
+           </para>
+         </listitem>
+       </varlistentry>
+
+       <varlistentry>
          <term>service</term>
          <listitem>
            <para>
@@ -321,7 +339,11 @@
 
 <server>
   <listen port="9004"/>
-  <proxy host="us1.indexdata.com"/>
+  <proxy host="us1.indexdata.com" myurl="us1.indexdata.com"/>
+
+  <!-- <zproxy host="localhost" port="9000"/> -->
+  <!-- <zproxy host="localhost:9000"/> -->
+  <!-- <zproxy port="9000"/> -->
 
   <service>
     <metadata name="title" brief="yes" sortkey="skiparticle" merge="longest" rank="6"/>
@@ -347,6 +369,33 @@
 ]]></screen>
    </para>
  </refsect1> 
+
+ <refsect1><title>TARGET SETTINGS</title>
+   <para>
+     Pazpar2 features a cunning scheme by which you can associate various
+     kinds of attributes, or settings with search targets. This is done
+     through XML files, and each file can associate one or more settings
+     with one or more targets. The file format is generic in nature,
+     designed to support a wide range of application requirements. The
+     settings can be purely technical things, like, how to perform a title
+     search against a given target, or it can associate arbitrary name=value
+     pairs with groups of targets -- for instance, if you would like to
+     place all commercial full-text bases in one group for selection
+     purposes, or you would like to control what targets are accessible to a
+     given user.
+   </para>
+
+   <para>
+     During startup, pazpar2 will recursively read a specified directory
+     (can be identified in the pazpar2.cfg file or on the command line), and
+     process any settings files found therein.
+   </para>
+
+   <refsect2><title>SETTINGS FILE FORMAT</title>
+     <para>
+     </para>
+    </refsect2>
+ </refsect1>
 </refentry>
 <!-- Keep this comment at the end of the file
 Local variables: