Mercurial > hg > nginx-site
view xml/en/docs/http/ngx_http_index_module.xml @ 271:4c6d2c614d2c
Cleaned up XML tag mess:
- all of <parameter> and <code>, and some of <dirname>, <value>,
and <command> were replaced by <literal>;
- the rest of <dirname> were replaced by links;
- <argument> were replaced by <value>;
- <value> is now rendered in HTML in italic;
- <literal> and <path> can now contain <value>.
Cleaned up terminology mess:
- directives take "parameters".
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Fri, 23 Dec 2011 17:29:59 +0000 |
parents | bfe3eff81d04 |
children | 197ac51e7f0e |
line wrap: on
line source
<?xml version="1.0"?> <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> <module name="Module ngx_http_index_module" link="/en/docs/http/ngx_http_index_module.html" lang="en"> <section id="summary"> <para> The module <literal>ngx_http_index_module</literal> processes requests ending with the slash character (‘<literal>/</literal>’). </para> </section> <section name="Example Configuration" id="example"> <para> <example> location / { index index.$geo.html index.html; } </example> </para> </section> <section name="Directives" id="directives"> <directive name="index"> <syntax><value>file</value> ...</syntax> <default>index.html</default> <context>http</context> <context>server</context> <context>location</context> <para> Defines files that will be used as an index. The <value>file</value> name can contain variables. Files are checked in the specified order. The last element of the list can be a file with an absolute path. Example: <example> index index.$geo.html index.0.html /index.html; </example> </para> <para> It should be noted that when using an index file, an internal redirect is made, and request can be processed in a different location. For example, with the following configuration: <example> location = / { index index.html; } location / { ... } </example> a request of “<literal>/</literal>” will actually be processed in the second location as “<literal>/index.html</literal>”. </para> </directive> </section> </module>