summaryrefslogtreecommitdiff
path: root/APACHE_1_3_42/htdocs/manual/mod/mod_dir.html.en
blob: d1573a667461506f312631409279565ad9583d94 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta name="generator" content="HTML Tidy, see www.w3.org" />

    <title>Apache module mod_dir</title>
  </head>
  <!-- Background white, links blue (unvisited), navy (visited), red (active) -->

  <body bgcolor="#FFFFFF" text="#000000" link="#0000FF"
  vlink="#000080" alink="#FF0000">
    <!--#include virtual="header.html" -->

    <h1 align="CENTER">Module mod_dir</h1>

    <p>This module provides for "trailing slash" redirects and
    serving directory index files.</p>

    <p><a href="module-dict.html#Status"
    rel="Help"><strong>Status:</strong></a> Base<br />
     <a href="module-dict.html#SourceFile"
    rel="Help"><strong>Source File:</strong></a> mod_dir.c<br />
     <a href="module-dict.html#ModuleIdentifier"
    rel="Help"><strong>Module Identifier:</strong></a>
    dir_module</p>

    <h2>Summary</h2>
    The index of a directory can come from one of two sources: 

    <ul>
      <li>A file written by the user, typically called
      <code>index.html</code>. The <a
      href="#directoryindex">DirectoryIndex</a> directive sets the
      name of this file. This is controlled by
      <code>mod_dir</code>.</li>

      <li>Otherwise, a listing generated by the server. This is
      provided by <a
      href="mod_autoindex.html"><code>mod_autoindex</code></a>.</li>
    </ul>
    The two functions are separated so that you can completely
    remove (or replace) automatic index generation should you want
    to. 

    <p>A "trailing slash" redirect is issued when the server
    receives a request for a URL
    <samp>http://servername/foo/dirname</samp> where
    <samp>dirname</samp> is a directory. Directories require a
    trailing slash, so <code>mod_dir</code> issues a redirect to
    <samp>http://servername/foo/dirname/</samp>.</p>

    <h2>Directives</h2>

    <ul>
      <li><a href="#directoryindex">DirectoryIndex</a></li>
    </ul>
    <hr />

    <h2><a id="directoryindex"
    name="directoryindex">DirectoryIndex</a> directive</h2>
    <!--%plaintext &lt;?INDEX {\tt DirectoryIndex} directive&gt; -->
    <a href="directive-dict.html#Syntax"
    rel="Help"><strong>Syntax:</strong></a> DirectoryIndex
    <em>local-url</em> [<em>local-url</em>] ...<br />
     <a href="directive-dict.html#Default"
    rel="Help"><strong>Default:</strong></a> <code>DirectoryIndex
    index.html</code><br />
     <a href="directive-dict.html#Context"
    rel="Help"><strong>Context:</strong></a> server config, virtual
    host, directory, .htaccess<br />
     <a href="directive-dict.html#Override"
    rel="Help"><strong>Override:</strong></a> Indexes<br />
     <a href="directive-dict.html#Status"
    rel="Help"><strong>Status:</strong></a> Base<br />
     <a href="directive-dict.html#Module"
    rel="Help"><strong>Module:</strong></a> mod_dir 

    <p>The DirectoryIndex directive sets the list of resources to
    look for, when the client requests an index of the directory by
    specifying a / at the end of the a directory name.
    <em>Local-url</em> is the (%-encoded) URL of a document on the
    server relative to the requested directory; it is usually the
    name of a file in the directory. Several URLs may be given, in
    which case the server will return the first one that it finds.
    If none of the resources exist and the <code>Indexes</code>
    option is set, the server will generate its own listing of the
    directory.</p>

    <p>Example:</p>

    <blockquote>
      <code>DirectoryIndex index.html</code>
    </blockquote>
    then a request for <code>http://myserver/docs/</code> would
    return <code>http://myserver/docs/index.html</code> if it
    exists, or would list the directory if it did not. 

    <p>Note that the documents do not need to be relative to the
    directory;</p>

    <blockquote>
      <code>DirectoryIndex index.html index.txt
      /cgi-bin/index.pl</code>
    </blockquote>
    would cause the CGI script <code>/cgi-bin/index.pl</code> to be
    executed if neither <code>index.html</code> or
    <code>index.txt</code> existed in a directory. 

    <p><!--#include virtual="footer.html" -->
    </p>
  </body>
</html>