1==================
2Directory Listings
3==================
4
5----------------------
6Module: mod_dirlisting
7----------------------
8
9:Author: Jan Kneschke
10:Date: $Date: 2004/11/03 22:26:05 $
11:Revision: $Revision: 1.2 $
12
13:abstract:
14  mod_dirlisting generates HTML based directory listings with full CSS
15  control
16
17.. meta::
18  :keywords: lighttpd, directory listings, dirlisting
19
20.. contents:: Table of Contents
21
22Description
23===========
24
25mod_dirlisting is one of the modules which is loaded by default and don't have to
26be specified on server.modules to work.
27
28A directory listing is generated if a directory is requested and no index-file
29was found in that directory.
30
31To enable directory listings globally: ::
32
33  dir-listing.activate = "enable"
34
35If you need it only for a directory, use conditionals: ::
36
37  $HTTP["url"] =~ "^/download($|/)" {
38    dir-listing.activate = "enable"
39  }
40
41You can also use a external generator for directory listings if you use
42mod_indexfile. ::
43
44  index-file.names = ( "/dir-generator.php" )
45
46If a directory is requested the dir-generator.php is called instead which can
47take the REQUEST_URI to see which directory was requested.
48
49For large folders this is highly recommend.
50
51Options
52=======
53
54dir-listing.activate
55  enables virtual directory listings if a directory is requested no
56  index-file was found
57
58  Default: disabled
59
60dir-listing.hide-dotfiles
61  if enabled, does not list hidden files in directory listings generated
62  by the dir-listing option.
63
64  Default: enabled
65
66dir-listing.external-css
67  path to an external css stylesheet for the directory listing
68
69dir-listing.exclude
70  list of regular expressions.  Files that match any of the specified regular
71  expressions will be excluded from directory listings.
72
73dir-listing.encoding
74  set a encoding for the generated directory listing
75
76  If you file-system is not using ASCII you have to set the encoding of
77  the filenames as they are put into the HTML listing AS IS (with XML
78  encoding)
79
80  Example: ::
81
82    dir-listing.encoding = "utf-8"
83
84dir-listing.show-readme
85  shows README.txt after the dirlisting if it exists in the directory
86
87  Default: disabled
88
89dir-listing.hide-readme-file
90  hides README.txt in the dirlisting
91
92  Default: disabled
93
94dir-listing.show-header
95  shows HEADER.txt before the dirlisting if it exists in the directory
96
97  Default: disabled
98
99dir-listing.hide-header-file
100  hides HEADER.txt in the dirlisting
101
102  Default: disabled
103
104dir-listing.set-footer
105
106  Default: empty, uses server.tag instead
107
108dir-listing.encode-readme
109  encodes all control characers, '&', '<', '>' and '\x7f' as &#x**;
110
111  Default: enabled
112
113dir-listing.encode-header
114  encodes all control characers, '&', '<', '>' and '\x7f' as &#x**;
115
116  Default: enabled
117
118dir-listing.auto-layout
119  Disable this if you want your own html header and footer; specify
120  them in HEADER.txt and README.txt
121
122  you have to enable dir-list.show-readme/header for this of course
123
124  .external-css and .set-footer will be ignored if this is disabled
125
126  Default: enabled
127