mod-auth-commit

[<fir...@us...>]

Update of /cvsroot/mod-auth/mod_auth_webspace/htdocs/docs/mod_authn_pop3
In directory sc8-pr-cvs1:/tmp/cvs-serv31898/docs/mod_authn_pop3

Added Files:
	index.xml index.xml.meta 
Log Message:
add initial docs for authn_pop3

fixed .meta for authn_dbi


--- NEW FILE: index.xml ---
<?xml version="1.0"?>
<!DOCTYPE modulesynopsis SYSTEM "../../style/modulesynopsis.dtd">
<?xml-stylesheet type="text/xsl" href="../../style/manual.en.xsl"?>

<modulesynopsis metafile="index.xml.meta">

<name>mod_authn_pop3</name>
<description>User authentication using POP3</description>
<status>External</status>
<sourcefile>mod_authn_pop3.c</sourcefile>
<identifier>authn_pop3</identifier>
<compatibility>Apache 2.1 or greater</compatibility>

  <summary>
    <p>      
      The module <code>mod_authn_pop3</code> provides Authentication against a
      POP3 useing cleartext passwords. 
    </p>
  </summary>
  
  <section id="compilation">
    <title>Compilation</title>
    <p>
      <code>mod_authn_pop3</code> uses the "<code>configure/make/make install</code>"
      mechanism 
      common to many Open Source programs.
      Most of the dirty work is handled by either configure or 
      Apache's apxs utility. If you have built apache modules before, there
      shouldn't be any surprises for you.
    </p>
    <p>
      Before you can begin compiling mod_authn_pop3, you will need a
      working installation of Apache 2.1-dev (any earlier version,
      including Apache 2.0.x will NOT work).
    </p>
    <p>
      The interesting options you can pass to configure are:
    <ul>
      <li><code>--with-apxs=/path/to/apache/dir/bin/apxs</code>
	<p>
	  This option is used to specify the location of the
	  apxs utility that was installed as part of apache.
	  Specify the location of the binary, not the directory
	  it is located in.
	</p>
      </li>
    </ul>
  </p>
    <p>
      Call configure with your site-specific values and then
      "make" and "make install" as usual. The module will be installed
      in the module directory of your Apache installation.
    </p>
  </section>

  <section id="integration">
    <title>Integration into Apache</title>
    <p>Again <code>mod_authn_dbi</code> behave like your average next-door
      Apache module. Just add<br /><br />
      <code>LoadModule authn_dbi_module   modules/mod_authn_dbi.so</code><br
	/><br />
      to your <code>httpd.conf</code> as usual and restart Apache.
</p>

</section>
<section id="basic">
<title>Basic configuration of mod_authn_pop3</title>
<p><b>Draft...</b></p>
<p>
    <example>
      <title>Example Config</title>
      <pre>
       &lt;Location /secure-area&gt;
         AuthType Basic
         AuthName  "basic authn_pop3 testing area"
         AuthBasicProvider pop3
         AuthnPOP3Hostname force-elite.com
         AuthnPOP3Port 110
         Require valid-user
       &lt;/Location&gt;
      </pre>
    </example>
</p>
</section>

  <directivesynopsis>
    <name>AuthnPOP3Hostname</name>
    <description>Sets the Server to use</description>
    <syntax>AuthnPOP3Hostname <var>hostname</var></syntax>
    <default>none</default>
    <contextlist>
      <context>.htaccess</context>
    </contextlist>
    <usage>
      <p>
      </p>
    </usage>
  </directivesynopsis>

  <directivesynopsis>
    <name>AuthnPOP3Port</name>
    <description>Sets the Port to use</description>
    <syntax>AuthnPOP3Hostname <var>port</var></syntax>
    <default>110</default>
    <contextlist>
      <context>.htaccess</context>
    </contextlist>
    <usage>
      <p>
      </p>
    </usage>
  </directivesynopsis>

</modulesynopsis>

--- NEW FILE: index.xml.meta ---
<?xml version="1.0" encoding="UTF-8" ?>

<metafile>
  <basename>mod_authn_pop3</basename>
  <path>../</path>
  <relpath>../../</relpath>

  <variants>
    <variant>en</variant>
  </variants>
</metafile>