home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F278381_mod_userdir.xml < prev    next >
Extensible Markup Language  |  2004-04-17  |  6KB  |  158 lines
  1. <?xml version="1.0"?>
  2. <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
  3. <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  4. <!-- $Revision: 1.10.2.4 $ -->
  5.  
  6. <!--
  7.  Copyright 2002-2004 The Apache Software Foundation
  8.  
  9.  Licensed under the Apache License, Version 2.0 (the "License");
  10.  you may not use this file except in compliance with the License.
  11.  You may obtain a copy of the License at
  12.  
  13.      http://www.apache.org/licenses/LICENSE-2.0
  14.  
  15.  Unless required by applicable law or agreed to in writing, software
  16.  distributed under the License is distributed on an "AS IS" BASIS,
  17.  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18.  See the License for the specific language governing permissions and
  19.  limitations under the License.
  20. -->
  21.  
  22. <modulesynopsis metafile="mod_userdir.xml.meta">
  23.  
  24. <name>mod_userdir</name>
  25. <description>User-specific directories</description>
  26. <status>Base</status>
  27. <sourcefile>mod_userdir.c</sourcefile>
  28. <identifier>userdir_module</identifier>
  29.  
  30. <summary>
  31. <p>This module allows user-specific directories to be accessed using the
  32. <code>http://example.com/~user/</code> syntax.</p>
  33. </summary>
  34.  
  35. <seealso><a href="../urlmapping.html">Mapping URLs to the
  36. Filesystem</a></seealso>
  37. <seealso><a href="../howto/public_html.html">public_html
  38. tutorial</a></seealso>
  39.  
  40. <directivesynopsis>
  41.  
  42. <name>UserDir</name>
  43. <description>Location of the user-specific directories</description>
  44. <syntax>UserDir <em>directory-filename</em></syntax>
  45. <default>UserDir public_html</default>
  46. <contextlist><context>server config</context> <context>virtual
  47. host</context></contextlist>
  48.  
  49. <usage>
  50.  
  51.     <p>The <directive>UserDir</directive> directive sets the real
  52.     directory in a user's home directory to use when a request for a
  53.     document for a user is received. <em>Directory-filename</em> is
  54.     one of the following:</p>
  55.  
  56.     <ul>
  57.       <li>The name of a directory or a pattern such as those shown
  58.       below.</li>
  59.  
  60.       <li>The keyword <code>disabled</code>. This turns off
  61.       <em>all</em> username-to-directory translations except those
  62.       explicitly named with the <code>enabled</code> keyword (see
  63.       below).</li>
  64.  
  65.       <li>The keyword <code>disabled</code> followed by a
  66.       space-delimited list of usernames. Usernames that appear in
  67.       such a list will <em>never</em> have directory translation
  68.       performed, even if they appear in an <code>enabled</code>
  69.       clause.</li>
  70.  
  71.       <li>The keyword <code>enabled</code> followed by a
  72.       space-delimited list of usernames. These usernames will have
  73.       directory translation performed even if a global disable is
  74.       in effect, but not if they also appear in a
  75.       <code>disabled</code> clause.</li>
  76.     </ul>
  77.  
  78.     <p>If neither the <code>enabled</code> nor the
  79.     <code>disabled</code> keywords appear in the
  80.     <code>Userdir</code> directive, the argument is treated as a
  81.     filename pattern, and is used to turn the name into a directory
  82.     specification. A request for
  83.     <code>http://www.foo.com/~bob/one/two.html</code> will be
  84.     translated to:</p>
  85.  
  86. <table>
  87. <tr><th>UserDir directive used</th>
  88. <th>Translated path</th></tr>
  89. <tr><td>UserDir public_html</td><td>~bob/public_html/one/two.html</td></tr>
  90. <tr><td>UserDir /usr/web</td><td>/usr/web/bob/one/two.html</td></tr>
  91. <tr><td>UserDir /home/*/www</td><td>/home/bob/www/one/two.html</td></tr>
  92. </table>
  93.  
  94.     <p>The following directives will send redirects to the client:</p> 
  95.  
  96. <table>
  97. <tr><th>UserDir directive used</th>
  98. <th>Translated path</th></tr>
  99. <tr><td>UserDir http://www.foo.com/users</td><td>http://www.foo.com/users/bob/one/two.html</td></tr>
  100. <tr><td>UserDir
  101. http://www.foo.com/*/usr</td><td>http://www.foo.com/bob/usr/one/two.html</td></tr>
  102. <tr><td>UserDir
  103. http://www.foo.com/~*/</td><td>http://www.foo.com/~bob/one/two.html</td></tr>
  104. </table> 
  105.  
  106. <note>
  107.       <strong>Be careful when using this directive; for instance,
  108.       <code>"UserDir ./"</code> would map <code>"/~root"</code> to
  109.       <code>"/"</code> - which is probably undesirable. It is strongly
  110.       recommended that your configuration include a "<code>UserDir
  111.       disabled root</code>" declaration.  See also the <directive
  112.       module="core">Directory</directive> directive and the <a
  113.       href="../misc/security_tips.html">Security Tips</a> page for
  114.       more information.</strong>
  115. </note>
  116.  
  117. <p>Additional examples:</p>
  118.  
  119. <p>To allow a few users to have <code>UserDir</code> directories, but
  120. not anyone else, use the following:</p>
  121.  
  122. <example>
  123. UserDir disabled<br />
  124. UserDir enabled user1 user2 user3
  125. </example>
  126.  
  127. <p>To allow most users to have <code>UserDir</code> directories, but
  128. deny this to a few, use the following:</p>
  129.  
  130. <example>
  131. UserDir enabled<br />
  132. UserDir disabled user4 user5 user6
  133. </example>
  134.  
  135. <p>It is also possible to specify alternative user directories.
  136. If you use a command like:</p>
  137. <example>
  138. Userdir public_html /usr/web http://www.foo.com/
  139. </example>
  140. <p>With a request for http://www.foo.com/~bob/one/two.html, will try to 
  141. find the page at ~bob/public_html/one/two.html first, then
  142. /usr/web/bob/one/two.html, and finally it will send a redirect
  143. to http://www.foo.com/bob/one/two.html.</p>
  144. <p>If you add a redirect, it must be the last alternative in the list.
  145. Apache cannot determine if the redirect succeeded or not, so if you have
  146. the redirect earlier in the list, that will always be the alternative
  147. that is used.</p>
  148.  
  149. </usage>
  150.  
  151. <seealso><a href="../howto/public_html.html">public_html
  152. tutorial</a></seealso>
  153.  
  154. </directivesynopsis>
  155. </modulesynopsis>
  156.  
  157.  
  158.