]> granicus.if.org Git - apache/commitdiff
Small mod doc updates.
authorJoshua Slive <slive@apache.org>
Sun, 26 May 2002 22:08:58 +0000 (22:08 +0000)
committerJoshua Slive <slive@apache.org>
Sun, 26 May 2002 22:08:58 +0000 (22:08 +0000)
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@95291 13f79535-47bb-0310-9956-ffa450edef68

docs/manual/mod/mod_suexec.xml
docs/manual/mod/mod_userdir.xml
docs/manual/mod/mod_usertrack.xml
docs/manual/mod/mod_vhost_alias.xml

index 53b221e74e2e939b1cb47c68cad293dbdd38dbf0..c46b990b870ec288bc91fa0896f9ff72930c010b 100644 (file)
@@ -13,27 +13,29 @@ and Group</description>
 
 
 <summary>
-    <p>This module allows CGI scripts to run as a specified user
-    and Group.</p>
+    <p>This module, in combination with the <a
+    href="../programs/suexec.html">suexec support program</a> allows
+    CGI scripts to run as a specified user and Group.</p>
 </summary>
 
+<seealso><a href="../suexec.html">SuEXEC support</a></seealso>
 
 <directivesynopsis>
 
 <name>SuexecUserGroup</name>
+<description>User and group permissions for CGI programs</description>
 <syntax>SuexecUserGroup <em>User Group</em></syntax>
-<default>None</default>
 <contextlist><context>server config</context>
 <context>virtual host</context></contextlist>
 <compatibility>SuexecUserGroup is only available in 2.0 and
 later.</compatibility>
 
 <usage>
-    <p>The <directive>SuexecUserGroup</directive> directive allows you to
-    specify a user and group for CGI programs to run as. Non-CGI
-    requests are still processes with the user specified in the
-    User directive. This directive replaces using the User and
-    Group directives inside of VirtualHosts.</p>
+    <p>The <directive>SuexecUserGroup</directive> directive allows you
+    to specify a user and group for CGI programs to run as. Non-CGI
+    requests are still processes with the user specified in the User
+    directive. This directive replaces the Apache 1.3 configuration of
+    using the User and Group directives inside of VirtualHosts.</p>
 </usage>
 
 </directivesynopsis>
index 070ab33d19051d27cdc571d71e4d34925a680e50..1ee195d4eb06616de3356bc951984f758fbc5352 100755 (executable)
@@ -4,32 +4,27 @@
 <modulesynopsis>
 
 <name>mod_userdir</name>
-<description>Provides for user-specific
-directories</description>
+<description>User-specific directories</description>
 <status>Base</status>
 <sourcefile>mod_userdir.c</sourcefile>
 <identifier>userdir_module</identifier>
 
 <summary>
+This module allows user-specific directories to be accessed using the
+<code>http://example.com/~user/</code> syntax.
 </summary>
 
+<seealso><a href="../urlmapping.html">Mapping URLs to the
+Filesystem</a></seealso>
 
 <directivesynopsis>
 
 <name>UserDir</name>
-<description>Sets the directory from which to serve files when requests
-for a particular user are received, denoted by requests containing
-<em>~username</em>, such as 
-<em>http://server.example.com/~bob/</em></description>
+<description>Location of the user-specific directories</description>
 <syntax>UserDir <em>directory-filename</em></syntax>
 <default>UserDir public_html</default>
 <contextlist><context>server config</context> <context>virtual
 host</context></contextlist>
-<compatibility>All forms except the <code>UserDir public_html</code>
-form are only available in Apache 1.1 or above. Use of the 
-<code>enabled</code> keyword, or <code>disabled</code> with a
-list of usernames, is only available in Apache 1.3 and
-above.</compatibility>
 
 <usage>
 
@@ -90,14 +85,13 @@ http://www.foo.com/~*/</td><td>http://www.foo.com/~bob/one/two.html</td></tr>
 
 <note>
       <strong>Be careful when using this directive; for instance,
-      <code>"UserDir ./"</code> would map
-      <code>"/~root"</code> to <code>"/"</code> - which is probably
-      undesirable. If you are running Apache 1.3 or above, it is
-      strongly recommended that your configuration include a
-      "<code>UserDir disabled root</code>" declaration.
-      See also the <directive module="core">Directory</directive>
-      directive and the <a href="../misc/security_tips.html">Security
-      Tips</a> page for more information.</strong>
+      <code>"UserDir ./"</code> would map <code>"/~root"</code> to
+      <code>"/"</code> - which is probably undesirable. It is strongly
+      recommended that your configuration include a "<code>UserDir
+      disabled root</code>" declaration.  See also the <directive
+      module="core">Directory</directive> directive and the <a
+      href="../misc/security_tips.html">Security Tips</a> page for
+      more information.</strong>
 </note>
 
 <p>Additional examples:</p>
index cc87a44e9bcb1264ff335f8d31e0de49867e7f8a..ee610386c080ed2332ad65c9900efe772f282881 100755 (executable)
@@ -5,13 +5,11 @@
 <modulesynopsis>
 <name>mod_usertrack</name> 
 <description>
-    This module uses cookies to provide for a
-    <em>clickstream</em> log of user activity on a site.
+<em>Clickstream</em> logging of user activity on a site
 </description>
 <status>Extension</status>
 <sourcefile>mod_usertrack.c</sourcefile>
 <identifier>usertrack_module</identifier>
-<compatibility>Known as mod_cookies prior to Apache 1.3.</compatibility>
 
 <summary>
     <p>Previous releases of Apache have included a module which
@@ -39,8 +37,10 @@ CustomLog logs/clickstream "%{cookie}n %r %t"
 </example>
 
     <p>For backward compatibility the configurable log module
-    implements the old <directive>CookieLog</directive> directive, but this
-    should be upgraded to the above <directive>CustomLog</directive> directive. </p>
+    implements the old <directive
+    module="mod_log_config">CookieLog</directive> directive, but this
+    should be upgraded to the above <directive
+    module="mod_log_config">CustomLog</directive> directive. </p>
 </section>
 
 <section>
@@ -86,15 +86,15 @@ time late in the year "37".
 
 <directivesynopsis>
 <name>CookieDomain</name>
-<description>controls the setting of the domain to which the tracking cookie applies.</description>
+<description>The domain to which the tracking cookie applies</description>
 <syntax>CookieDomain <em>domain</em></syntax>
-<default>None</default>
 <contextlist>
 <context>server config</context>
 <context>virtual host</context>
 <context>directory</context>
 <context>.htaccess</context>
 </contextlist>
+<override>FileInfo</override>
 
 <usage>
 
@@ -111,17 +111,15 @@ time late in the year "37".
 
 <directivesynopsis>
 <name>CookieExpires</name>
+<description>Expiry time for the tracking cookie</description>
 <syntax>CookieExpires <em>expiry-period</em></syntax>
-<default></default>
 <contextlist>
 <context>server config</context>
 <context>virtual host</context>
 <context>directory</context>
 <context>.htaccess</context>
 </contextlist>
-<override></override>
-<compatibility>In 1.3.20 and earlier, not usable in directory and
-.htaccess</compatibility>
+<override>FileInfo</override>
 
 <usage>
     <p>When used, this directive sets an expiry time on the cookie
@@ -139,14 +137,16 @@ time late in the year "37".
 
 <directivesynopsis>
 <name>CookieName</name>
+<description>Name of the tracking cookie</description>
 <syntax>CookieName <em>token</em></syntax>
-<default>Apache</default>
+<default>CookieName Apache</default>
 <contextlist>
 <context>server config</context>
 <context>virtual host</context>
 <context>directory</context>
 <context>.htaccess</context>
 </contextlist>
+<override>FileInfo</override>
 
 <usage>
     <p>This directive allows you to change the name of the cookie
@@ -161,16 +161,17 @@ time late in the year "37".
 
 <directivesynopsis>
 <name>CookieStyle</name>
-<description>Controls the format of the cookie header field</description>
+<description>Format of the cookie header field</description>
 <syntax>CookieStyle
     <em>Netscape|Cookie|Cookie2|RFC2109|RFC2965</em></syntax>
-<default></default>
+<default>CookieStyle Netscape</default>
 <contextlist>
 <context>server config</context>
 <context>virtual host</context>
 <context>directory</context>
 <context>.htaccess</context>
 </contextlist>
+<override>FileInfo</override>
 
 <usage>
     <p>This directive controls the format of the cookie header
@@ -198,8 +199,9 @@ time late in the year "37".
 
 <directivesynopsis>
 <name>CookieTracking</name>
+<description>Enables tracking cookie</description>
 <syntax>CookieTracking on|off</syntax>
-<default></default>
+<default>CookieTracking off</default>
 <contextlist>
 <context>server config</context>
 <context>virtual host</context>
index 1eac909e65c1f34ad73980748a8bfbc005bd25bc..2b623f791bb4eb1a57d44a3f0a7e026f4a027231 100644 (file)
@@ -4,9 +4,8 @@
 <modulesynopsis>
 
 <name>mod_vhost_alias</name>
-<description>Provides for <a
-href="../vhosts/mass.html">dynamically configured mass virtual
-hosting</a></description>
+<description>Provides for dynamically configured mass virtual
+hosting</description>
 <status>Extension</status>
 <sourcefile>mod_vhost_alias.c</sourcefile>
 <identifier>vhost_alias_module</identifier>
@@ -23,6 +22,8 @@ hosting</a></description>
 </summary>
     <seealso><directive
     module="core">UseCanonicalName</directive>.</seealso>
+    <seealso><a href="../vhosts/mass.html">Dynamically configured mass 
+virtual hosting</a></seealso>
 
 <section>
     <title>Directory Name Interpolation</title>
@@ -187,9 +188,6 @@ for a given virtual host</description>
 <context>server config</context>
 <context>virtual host</context>
 </contextlist>
-<override></override>
-<compatibility>VirtualDocumentRoot is only available in 1.3.7 and
-later.</compatibility>
 
 <usage>
 
@@ -217,9 +215,6 @@ for a given virtual host</description>
 <context>server config</context>
 <context>virtual host</context>
 </contextlist>
-<override></override>
-<compatibility>VirtualDocumentRootIP is only available in 1.3.7 
-and later.</compatibility>
 
 <usage>
 
@@ -240,9 +235,6 @@ a given virtual host</description>
 <context>server config</context>
 <context>virtual host</context>
 </contextlist>
-<override></override>
-<compatibility>VirtualScriptAlias is only available in 1.3.7
-and later.</compatibility>
 
 <usage>
 
@@ -267,9 +259,6 @@ a given virtual host</description>
 <context>server config</context>
 <context>virtual host</context>
 </contextlist>
-<override></override>
-<compatibility>VirtualScriptAliasIP is only available in 1.3.7 
-and later.</compatibility>
 
 <usage>