Removed all mention of users from setting system.

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

diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml
index 7227f34..3785042 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.13 2007-04-03 05:14:44 quinn Exp $ -->
+<!-- $Id: pazpar2_conf.xml,v 1.18 2007-04-11 02:23:21 quinn Exp $ -->
 <refentry id="pazpar2_conf">
  <refentryinfo>
   <productname>Pazpar2</productname>
@@ -285,8 +285,8 @@
      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.
+     purposes, or you would like to control what targets are accessible
+     to users by default.
    </para>
 
    <para>
@@ -330,17 +330,6 @@
            </para>
         </listitem>
        </varlistentry>
-       <varlistentry>
-         <term>user</term>
-        <listitem>
-          <para>
-            This specifies the user ID to which this setting applies. A
-            given setting may have values for any number of users, or it
-            may have a 'default' value which is applied when no user is
-            specified, or when no user-specific value is available.
-           </para>
-         </listitem>
-       </varlistentry>
        <varlistentry>
          <term>name</term>
          <listitem>
@@ -379,7 +368,7 @@
       </variablelist>
 
       <para>
-        By setting defaults for user, target, name, or value in the root
+        By setting defaults for target, name, or value in the root
        settings node, you can use the settings files in many different
        ways. For instance, you can use a single file to set defaults for
        many different settings, like search fields, retrieval syntaxes,
@@ -417,11 +406,12 @@
          </listitem>
        </varlistentry>
        <varlistentry>
-         <term>pz:syntax</term>
+         <term>pz:requestsyntax</term>
          <listitem>
            <para>
              This specifies the record syntax to use when requesting
-             records from a given server.
+             records from a given server. The value can be a symbolic name like
+             marc21 or xml, or it can be a Z39.50-style dot-separated OID.
            </para>
          </listitem>
        </varlistentry>
@@ -475,6 +465,37 @@
            </para>
          </listitem>
        </varlistentry>
+       <varlistentry>
+         <term>pz:authentication</term>
+         <listitem>
+           <para>
+             Sets an authentication string for a given server. See the section on
+             authorization and authentication for discussion.
+           </para>
+         </listitem>
+       </varlistentry>
+       <varlistentry>
+         <term>pz:allow</term>
+         <listitem>
+           <para>
+             Allows or denies access to the resources it is applied to. Possible
+             values are '0' and '1'. The default is '1' (allow access to this resource).
+             See the manual section on authorization and authentication for discussion
+             about how to use this setting.
+           </para>
+         </listitem>
+       </varlistentry>
+       <varlistentry>
+         <term>pz:id</term>
+         <listitem>
+           <para>
+             This setting can't be 'set' -- it contains the ID (normally
+             ZURL) for a given target, and is useful for filtering --
+             specifically when you want to select one or more specific
+             targets in the search command.
+           </para>
+         </listitem>
+       </varlistentry>
       </variablelist>
     </refsect2>