HCoop / hcoop / debian / courier-authlib.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Imported Debian patch 0.63.0-6
[hcoop/debian/courier-authlib.git] / auth_login.html
diff --git a/auth_login.html b/auth_login.html
index c4305f3..b3af3e5 100644 (file)
--- a/auth_login.html
+++ b/auth_login.html
@@ -1,19 +1,19 @@
 <?xml version="1.0"?>
 <?xml version="1.0"?>
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/><title>auth_login</title><link rel="stylesheet" href="style.css" type="text/css"/><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"/><link rel="start" href="#auth-login" title="auth_login"/><link xmlns="" rel="stylesheet" type="text/css" href="manpage.css"/><meta xmlns="" name="MSSmartTagsPreventParsing" content="TRUE"/><link xmlns="" rel="icon" href="icon.gif" type="image/gif"/><!--
+<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/><title>auth_login</title><link rel="stylesheet" href="style.css" type="text/css"/><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"/><link rel="start" href="#auth-login" title="auth_login"/><link xmlns="" rel="stylesheet" type="text/css" href="manpage.css"/><meta xmlns="" name="MSSmartTagsPreventParsing" content="TRUE"/><link xmlns="" rel="icon" href="icon.gif" type="image/gif"/><!--
 
 Copyright 1998 - 2007 Double Precision, Inc.  See COPYING for distribution
 information.
 
 --></head><body><div class="refentry" lang="en" xml:lang="en"><a id="auth-login" shape="rect"> </a><div class="titlepage"/><div class="refnamediv"><h2>Name</h2><p>auth_login — Validate a userid and password</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="literallayout"><p><br clear="none"/>
 #include &lt;courierauth.h&gt;<br clear="none"/>
 
 Copyright 1998 - 2007 Double Precision, Inc.  See COPYING for distribution
 information.
 
 --></head><body><div class="refentry" lang="en" xml:lang="en"><a id="auth-login" shape="rect"> </a><div class="titlepage"/><div class="refnamediv"><h2>Name</h2><p>auth_login — Validate a userid and password</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" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td rowspan="1" colspan="1"><code class="funcdef">int rc=<b class="fsfunc">auth_login</b>(</code></td><td rowspan="1" colspan="1">const char * </td><td rowspan="1" colspan="1"><var class="pdparam">service</var>, </td></tr><tr><td rowspan="1" colspan="1"> </td><td rowspan="1" colspan="1">const char * </td><td rowspan="1" colspan="1"><var class="pdparam">userid</var>, </td></tr><tr><td rowspan="1" colspan="1"> </td><td rowspan="1" colspan="1">const char * </td><td rowspan="1" colspan="1"><var class="pdparam">password</var>, </td></tr><tr><td rowspan="1" colspan="1"> </td><td rowspan="1" colspan="1">int  </td><td rowspan="1" colspan="1"><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 * </td><td rowspan="1" colspan="1"><var class="pdparam">callback_arg</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="id282333" shape="rect"> </a><h2>DESCRIPTION</h2><p>
+</p></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td rowspan="1" colspan="1"><code class="funcdef">int rc=<b class="fsfunc">auth_login</b>(</code></td><td rowspan="1" colspan="1">const char * </td><td rowspan="1" colspan="1"><var class="pdparam">service</var>, </td></tr><tr><td rowspan="1" colspan="1"> </td><td rowspan="1" colspan="1">const char * </td><td rowspan="1" colspan="1"><var class="pdparam">userid</var>, </td></tr><tr><td rowspan="1" colspan="1"> </td><td rowspan="1" colspan="1">const char * </td><td rowspan="1" colspan="1"><var class="pdparam">password</var>, </td></tr><tr><td rowspan="1" colspan="1"> </td><td rowspan="1" colspan="1">int  </td><td rowspan="1" colspan="1"><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 * </td><td rowspan="1" colspan="1"><var class="pdparam">callback_arg</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="id318862" shape="rect"> </a><h2>DESCRIPTION</h2><p>
 <code class="function">auth_login</code> verifies whether
 <em class="replaceable"><code>userid</code></em> exists, and whether it's
 <em class="replaceable"><code>password</code></em> is correct.
 <em class="parameter"><code>service</code></em> specifies which so-called "service" is
 being authenticated; like “<span class="quote">imap</span>” or “<span class="quote">pop3</span>”.
 <em class="parameter"><code>service</code></em> may or may not be used by the Courier
 <code class="function">auth_login</code> verifies whether
 <em class="replaceable"><code>userid</code></em> exists, and whether it's
 <em class="replaceable"><code>password</code></em> is correct.
 <em class="parameter"><code>service</code></em> specifies which so-called "service" is
 being authenticated; like “<span class="quote">imap</span>” or “<span class="quote">pop3</span>”.
 <em class="parameter"><code>service</code></em> may or may not be used by the Courier
-authentication library's configured back-end module.</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="id282376" shape="rect"> </a><h2>RETURNS</h2><p>
+authentication library's configured back-end module.</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="id284618" shape="rect"> </a><h2>RETURNS</h2><p>
 <code class="function">callback_func</code> will be invoked if
 <code class="function">auth_login</code>
 succeeds, and <code class="function">callback_func</code>'s return value becomes
 <code class="function">callback_func</code> will be invoked if
 <code class="function">auth_login</code>
 succeeds, and <code class="function">callback_func</code>'s return value becomes
@@ -26,7 +26,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 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="id282647" shape="rect"> </a><p class="title"><b>Example 1. struct authinfo</b></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="id283673" shape="rect"> </a><p class="title"><b>Example 1. struct authinfo</b></p><div class="example-contents"><pre class="programlisting" xml:space="preserve">
 struct authinfo {
        const char *sysusername;
        const uid_t *sysuserid;
 struct authinfo {
        const char *sysusername;
        const uid_t *sysuserid;
@@ -79,7 +79,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.
 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" lang="en" xml:lang="en"><a id="id325666" shape="rect"> </a><h3>Account options</h3><p>
+See below for more information.</p></dd></dl></div><div class="refsect2" lang="en" xml:lang="en"><a id="id328470" 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
 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
@@ -123,15 +123,15 @@ 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 "|"
 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" lang="en" xml:lang="en"><a id="id326164" shape="rect"> </a><h2>SEE ALSO</h2><p>
-<a href="authlib.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">authlib</span>(3)</span></a>,
+characters.</p></dd></dl></div></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="id328921" 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 href="auth_generic.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">auth_generic</span>(3)</span></a>,
+<a class="ulink" href="auth_generic.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">auth_generic</span>(3)</span></a>,
 
 
-<a href="auth_getuserinfo.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">auth_getuserinfo</span>(3)</span></a>,
+<a class="ulink" href="auth_getuserinfo.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">auth_getuserinfo</span>(3)</span></a>,
 
 
-<a href="auth_enumerate.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">auth_enumerate</span>(3)</span></a>,
+<a class="ulink" href="auth_enumerate.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">auth_enumerate</span>(3)</span></a>,
 
 
-<a href="auth_passwd.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">auth_passwd</span>(3)</span></a>,
+<a class="ulink" href="auth_passwd.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">auth_passwd</span>(3)</span></a>,
 
 
-<a href="auth_getoption.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">auth_getoption</span>(3)</span></a>.</p></div></div></body></html>
+<a class="ulink" href="auth_getoption.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">auth_getoption</span>(3)</span></a>.</p></div></div></body></html>
courier-authlib packaging