Document SSLUserName directive.

Submitted by: Martin v. Loewis

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@103835 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/docs/manual/mod/mod_ssl.xml b/docs/manual/mod/mod_ssl.xml
index 708e88ab2e01d634c94465db87d9fb57af87bb14..fe244fa1c57df6ac07bb5be23f95bc416de8b8cc 100644 (file)
--- a/docs/manual/mod/mod_ssl.xml
+++ b/docs/manual/mod/mod_ssl.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0"?>
 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
-<!-- $Revision: 1.24 $ -->
+<!-- $Revision: 1.25 $ -->
 
 <!--
  Copyright 2002-2004 The Apache Software Foundation
@@ -1497,6 +1497,29 @@ SSLProxyCARevocationFile /usr/local/apache2/conf/ssl.crl/ca-bundle-remote-server
 </usage>
 </directivesynopsis>
 
+<directivesynopsis>
+<name>SSLUserName</name>
+<description>Variable name to determine user name</description>
+<syntax>SSLUserName <em>varname</em></syntax>
+<contextlist><context>server config</context>
+<context>directory</context>
+<context>.htaccess</context></contextlist>
+<override>AuthConfig</override>
+<compatibility>Available in Apache 2.1 and later</compatibility>
+
+<usage>
+<p>
+
+This directive sets the "user" field in the Apache request object.
+This is used by lower modules to identify the user with a character
+string. In particular, this may cause the environment variable
+<code>REMOTE_USER</code> to be set.  The <em>varname</em> can be
+any of the <a href="#envvars">SSL environment variables</a>.</p>
+<example><title>Example</title>
+SSLUserName SSL_CLIENT_S_DN_CN
+</example>
+</usage>
+</directivesynopsis>
 
 
 </modulesynopsis>