testing: use yaz-ztest -V if possible
[pazpar2-moved-to-github.git] / doc / pazpar2_conf.xml
index c61a73e..05ca85d 100644 (file)
        chacater set of the MARC must be known (if not, the resulting
        XML is probably not well-formed). The character set may be
        specified by adding:
        chacater set of the MARC must be known (if not, the resulting
        XML is probably not well-formed). The character set may be
        specified by adding:
-       <literal>;charset=</literal><replaceable>charset</replaceable> to
+       <literal>;</literal><replaceable>charset</replaceable> to
        <literal>iso2709</literal>. If omitted, a charset of
        MARC-8 is assumed. This is correct for most MARC21/USMARC records.
       </para>
        <literal>iso2709</literal>. If omitted, a charset of
        MARC-8 is assumed. This is correct for most MARC21/USMARC records.
       </para>
      <term>pz:authentication</term>
      <listitem>
       <para>
      <term>pz:authentication</term>
      <listitem>
       <para>
-       Sets an authentication string for a given server. See the section on
-       authorization and authentication for discussion.
+       Sets an authentication string for a given database. For Z39.50,
+       this is carried as part of the Initialize Request. In order to carry
+       the information in the "open" elements, separate
+       username and password with a slash (In Z39.50 it is a VisibleString).
+       In order to carry the information in the idPass  elements, separate
+       username term, password term and,  optionally, a group term with a
+       single blank.
+       If three terms are given, the order is
+       <emphasis>user, group, password</emphasis>.
+       If only two terms are given, the order is
+       <emphasis>user, password</emphasis>.
+      </para>
+      <para>
+       For HTTP based procotols, such as SRU and Solr, the authentication
+       string includes a username term and, optionally, a password term.
+       Each term is separated by a single blank. The
+       authentication information is passed either by HTTP basic
+       authentication or via URL parameters. The mode is operation is
+       determined by <literal>pz:authentication_mode</literal> setting.
+      </para>
+     </listitem>
+    </varlistentry>
+
+    <varlistentry>
+     <term>pz:authentication_mode</term>
+     <listitem>
+      <para>
+       Determines how authentication is carried in HTTP based protocols.
+       Value may be "<literal>basic</literal>" or "<literal>url</literal>".
       </para>
      </listitem>
     </varlistentry>
       </para>
      </listitem>
     </varlistentry>
        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).
        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>
       </para>
      </listitem>
     </varlistentry>