Merge remote-tracking branch 'origin/debian'

[hcoop/debian/courier-authlib.git] / auth_generic.html
diff --git a/auth_generic.html b/auth_generic.html

index ed7afb2..2ccfb28 100644 (file)
--- a/auth_generic.html
+++ b/auth_generic.html
@@ -7,7 +7,7 @@ information.
  --></head><body><div class="refentry"><a id="auth-generic" shape="rect"> </a><div class="titlepage"/><div class="refnamediv"><h2>Name</h2><p>auth_generic — Generic authentication request</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="literallayout"><p><br clear="none"/>
  #include &lt;courierauth.h&gt;<br clear="none"/>
  </p></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td rowspan="1" colspan="1"><code class="funcdef">int rc=<strong>auth_generic</strong>(</code></td><td rowspan="1" colspan="1">const char *<var class="pdparam">service</var>, </td></tr><tr><td rowspan="1" colspan="1"> </td><td rowspan="1" colspan="1">const char *<var class="pdparam">authtype</var>, </td></tr><tr><td rowspan="1" colspan="1"> </td><td rowspan="1" colspan="1">const char *<var class="pdparam">authdata</var>, </td></tr><tr><td rowspan="1" colspan="1"> </td><td rowspan="1" colspan="1">int <var class="pdparam">(*callback_func)</var>
-               <code>(</code>struct authinfo *, void *<code>)</code>, </td></tr><tr><td rowspan="1" colspan="1"> </td><td rowspan="1" colspan="1">void *<var class="pdparam">callback_arg</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a id="idm247883574864" shape="rect"> </a><h2>DESCRIPTION</h2><p>
+               <code>(</code>struct authinfo *, void *<code>)</code>, </td></tr><tr><td rowspan="1" colspan="1"> </td><td rowspan="1" colspan="1">void *<var class="pdparam">callback_arg</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a id="idm255238642128" shape="rect"> </a><h2>DESCRIPTION</h2><p>
  <code class="function">auth_generic</code> processes a generic authentication request.
  You do not want to use this function.
  You really want to use
@@ -35,7 +35,7 @@ newline character.
  followed by a second newline character.
  The base64-encoded string consists of the responding userid, a space
  character, then the response to the challenge expressed as hexadecimal
-digits.</p></dd></dl></div></div><div class="refsect1"><a id="idm247886414608" shape="rect"> </a><h2>RETURNS</h2><p>
+digits.</p></dd></dl></div></div><div class="refsect1"><a id="idm255237499360" shape="rect"> </a><h2>RETURNS</h2><p>
  <code class="function">callback_func</code> will be invoked if
  <code class="function">auth_generic</code>
  succeeds, and <code class="function">callback_func</code>'s return value becomes
@@ -48,7 +48,7 @@ return value indicates that this request was processed, but it failed.</p><p>
  The second argument to <code class="function">callback_func</code> will be
  <code class="function">callback_arg</code>, which is not interpreted by this
  function in any way.
-The first argument will be a pointer to the following structure:</p><div class="blockquote"><blockquote class="blockquote"><div class="example"><a id="idm247886408080" shape="rect"> </a><p class="title"><strong>Example 1. struct authinfo</strong></p><div class="example-contents"><pre class="programlisting" xml:space="preserve">
+The first argument will be a pointer to the following structure:</p><div class="blockquote"><blockquote class="blockquote"><div class="example"><a id="idm255237491696" shape="rect"> </a><p class="title"><strong>Example 1. struct authinfo</strong></p><div class="example-contents"><pre class="programlisting" xml:space="preserve">
  struct authinfo {
         const char *sysusername;
         const uid_t *sysuserid;
@@ -101,7 +101,7 @@ The account's cleartext password, if available.
  If the account has an encrypted password defined, this field
  can be set to <code class="literal">NULL</code>.</p></dd><dt><span class="term">options</span></dt><dd><p>
  A comma-separated list of miscellaneous account options.
-See below for more information.</p></dd></dl></div><div class="refsect2"><a id="idm247881009200" shape="rect"> </a><h3>Account options</h3><p>
+See below for more information.</p></dd></dl></div><div class="refsect2"><a id="idm255237415744" shape="rect"> </a><h3>Account options</h3><p>
  Depending on the configuration of the Courier authentication library,
  accounts may have individual options associated with them.
  If the authentication library configuration does not implement account
@@ -150,7 +150,7 @@ account could possibly access (and that's on top of whatever else the
  access control lists say). See the virtual shared folder documentation
  for more information.</p><p>
  For technical reasons, group names may not include comma, tab, "/" or "|"
-characters.</p></dd></dl></div></div></div><div class="refsect1"><a id="idm247880922640" shape="rect"> </a><h2>SEE ALSO</h2><p>
+characters.</p></dd></dl></div></div></div><div class="refsect1"><a id="idm255237328656" shape="rect"> </a><h2>SEE ALSO</h2><p>
  <a class="ulink" href="authlib.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">authlib</span>(3)</span></a>,
   
  <a class="ulink" href="auth_login.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">auth_login</span>(3)</span></a>,