home *** CD-ROM | disk | FTP | other *** search
/ GameStar 2004 May / Gamestar_62_2004-05_dvd.iso / Programy / apache_2.0.48-win32-x86-no_ssl.msi / Data.Cab / F252793_mod_userdir.xml < prev    next >
Extensible Markup Language  |  2003-04-15  |  5KB  |  140 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. <modulesynopsis metafile="mod_userdir.xml.meta">
  5.  
  6. <name>mod_userdir</name>
  7. <description>User-specific directories</description>
  8. <status>Base</status>
  9. <sourcefile>mod_userdir.c</sourcefile>
  10. <identifier>userdir_module</identifier>
  11.  
  12. <summary>
  13. <p>This module allows user-specific directories to be accessed using the
  14. <code>http://example.com/~user/</code> syntax.</p>
  15. </summary>
  16.  
  17. <seealso><a href="../urlmapping.html">Mapping URLs to the
  18. Filesystem</a></seealso>
  19. <seealso><a href="../howto/public_html.html">public_html
  20. tutorial</a></seealso>
  21.  
  22. <directivesynopsis>
  23.  
  24. <name>UserDir</name>
  25. <description>Location of the user-specific directories</description>
  26. <syntax>UserDir <em>directory-filename</em></syntax>
  27. <default>UserDir public_html</default>
  28. <contextlist><context>server config</context> <context>virtual
  29. host</context></contextlist>
  30.  
  31. <usage>
  32.  
  33.     <p>The <directive>UserDir</directive> directive sets the real
  34.     directory in a user's home directory to use when a request for a
  35.     document for a user is received. <em>Directory-filename</em> is
  36.     one of the following:</p>
  37.  
  38.     <ul>
  39.       <li>The name of a directory or a pattern such as those shown
  40.       below.</li>
  41.  
  42.       <li>The keyword <code>disabled</code>. This turns off
  43.       <em>all</em> username-to-directory translations except those
  44.       explicitly named with the <code>enabled</code> keyword (see
  45.       below).</li>
  46.  
  47.       <li>The keyword <code>disabled</code> followed by a
  48.       space-delimited list of usernames. Usernames that appear in
  49.       such a list will <em>never</em> have directory translation
  50.       performed, even if they appear in an <code>enabled</code>
  51.       clause.</li>
  52.  
  53.       <li>The keyword <code>enabled</code> followed by a
  54.       space-delimited list of usernames. These usernames will have
  55.       directory translation performed even if a global disable is
  56.       in effect, but not if they also appear in a
  57.       <code>disabled</code> clause.</li>
  58.     </ul>
  59.  
  60.     <p>If neither the <code>enabled</code> nor the
  61.     <code>disabled</code> keywords appear in the
  62.     <code>Userdir</code> directive, the argument is treated as a
  63.     filename pattern, and is used to turn the name into a directory
  64.     specification. A request for
  65.     <code>http://www.foo.com/~bob/one/two.html</code> will be
  66.     translated to:</p>
  67.  
  68. <table>
  69. <tr><th>UserDir directive used</th>
  70. <th>Translated path</th></tr>
  71. <tr><td>UserDir public_html</td><td>~bob/public_html/one/two.html</td></tr>
  72. <tr><td>UserDir /usr/web</td><td>/usr/web/bob/one/two.html</td></tr>
  73. <tr><td>UserDir /home/*/www</td><td>/home/bob/www/one/two.html</td></tr>
  74. </table>
  75.  
  76.     <p>The following directives will send redirects to the client:</p> 
  77.  
  78. <table>
  79. <tr><th>UserDir directive used</th>
  80. <th>Translated path</th></tr>
  81. <tr><td>UserDir http://www.foo.com/users</td><td>http://www.foo.com/users/bob/one/two.html</td></tr>
  82. <tr><td>UserDir
  83. http://www.foo.com/*/usr</td><td>http://www.foo.com/bob/usr/one/two.html</td></tr>
  84. <tr><td>UserDir
  85. http://www.foo.com/~*/</td><td>http://www.foo.com/~bob/one/two.html</td></tr>
  86. </table> 
  87.  
  88. <note>
  89.       <strong>Be careful when using this directive; for instance,
  90.       <code>"UserDir ./"</code> would map <code>"/~root"</code> to
  91.       <code>"/"</code> - which is probably undesirable. It is strongly
  92.       recommended that your configuration include a "<code>UserDir
  93.       disabled root</code>" declaration.  See also the <directive
  94.       module="core">Directory</directive> directive and the <a
  95.       href="../misc/security_tips.html">Security Tips</a> page for
  96.       more information.</strong>
  97. </note>
  98.  
  99. <p>Additional examples:</p>
  100.  
  101. <p>To allow a few users to have <code>UserDir</code> directories, but
  102. not anyone else, use the following:</p>
  103.  
  104. <example>
  105. UserDir disabled<br />
  106. UserDir enabled user1 user2 user3
  107. </example>
  108.  
  109. <p>To allow most users to have <code>UserDir</code> directories, but
  110. deny this to a few, use the following:</p>
  111.  
  112. <example>
  113. UserDir enabled<br />
  114. UserDir disabled user4 user5 user6
  115. </example>
  116.  
  117. <p>It is also possible to specify alternative user directories.
  118. If you use a command like:</p>
  119. <example>
  120. Userdir public_html /usr/web http://www.foo.com/
  121. </example>
  122. <p>With a request for http://www.foo.com/~bob/one/two.html, will try to 
  123. find the page at ~bob/public_html/one/two.html first, then
  124. /usr/web/bob/one/two.html, and finally it will send a redirect
  125. to http://www.foo.com/bob/one/two.html.</p>
  126. <p>If you add a redirect, it must be the last alternative in the list.
  127. Apache cannot determine if the redirect succeeded or not, so if you have
  128. the redirect earlier in the list, that will always be the alternative
  129. that is used.</p>
  130.  
  131. </usage>
  132.  
  133. <seealso><a href="../howto/public_html.html">public_html
  134. tutorial</a></seealso>
  135.  
  136. </directivesynopsis>
  137. </modulesynopsis>
  138.  
  139.  
  140.