comparison xml/en/docs/http/ngx_http_autoindex_module.xml @ 1374:90922e31756d

Documented the autoindex_format directive.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 16 Dec 2014 17:22:42 +0300
parents 95c3c3bbf1ce
children 6866a74393e0
comparison
equal deleted inserted replaced
1373:47e19b6d3dbc 1374:90922e31756d
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
9 9
10 <module name="Module ngx_http_autoindex_module" 10 <module name="Module ngx_http_autoindex_module"
11 link="/en/docs/http/ngx_http_autoindex_module.html" 11 link="/en/docs/http/ngx_http_autoindex_module.html"
12 lang="en" 12 lang="en"
13 rev="2"> 13 rev="3">
14 14
15 <section id="summary"> 15 <section id="summary">
16 16
17 <para> 17 <para>
18 The <literal>ngx_http_autoindex_module</literal> module processes requests 18 The <literal>ngx_http_autoindex_module</literal> module processes requests
62 <context>http</context> 62 <context>http</context>
63 <context>server</context> 63 <context>server</context>
64 <context>location</context> 64 <context>location</context>
65 65
66 <para> 66 <para>
67 Specifies whether exact file sizes should be output in the directory listing, 67 For the HTML <link id="autoindex_format">format</link>,
68 specifies whether exact file sizes should be output in the directory listing,
68 or rather rounded to kilobytes, megabytes, and gigabytes. 69 or rather rounded to kilobytes, megabytes, and gigabytes.
70 </para>
71
72 </directive>
73
74
75 <directive name="autoindex_format">
76 <syntax>
77 <literal>html</literal> |
78 <literal>xml</literal> |
79 <literal>json</literal> |
80 <literal>jsonp</literal></syntax>
81 <default>html</default>
82 <context>http</context>
83 <context>server</context>
84 <context>location</context>
85 <appeared-in>1.7.9</appeared-in>
86
87 <para>
88 Sets the format of a directory listing.
89 </para>
90
91 <para>
92 When the JSONP format is used, the name of a callback function is set
93 with the <literal>callback</literal> request argument.
94 If the argument is missing or has an empty value,
95 then the JSON format is used.
69 </para> 96 </para>
70 97
71 </directive> 98 </directive>
72 99
73 100
77 <context>http</context> 104 <context>http</context>
78 <context>server</context> 105 <context>server</context>
79 <context>location</context> 106 <context>location</context>
80 107
81 <para> 108 <para>
82 Specifies whether times in the directory listing should be 109 For the HTML <link id="autoindex_format">format</link>,
110 specifies whether times in the directory listing should be
83 output in the local time zone or UTC. 111 output in the local time zone or UTC.
84 </para> 112 </para>
85 113
86 </directive> 114 </directive>
87 115