annotate xml/en/docs/http/ngx_http_random_index_module.xml @ 580:be54c443235a

Added copyright markers to documentation sources.
author Ruslan Ermilov <ru@nginx.com>
date Tue, 10 Jul 2012 12:59:42 +0000
parents a4fa80755eab
children 764fbac1b8b4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
222
bfe3eff81d04 Removed redundant encoding specification.
Ruslan Ermilov <ru@nginx.com>
parents: 153
diff changeset
1 <?xml version="1.0"?>
153
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
2
580
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 351
diff changeset
3 <!--
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 351
diff changeset
4 Copyright (C) Igor Sysoev
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 351
diff changeset
5 Copyright (C) Nginx, Inc.
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 351
diff changeset
6 -->
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 351
diff changeset
7
153
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
9
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
10 <module name="Module ngx_http_random_index_module"
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
11 link="/en/docs/http/ngx_http_random_index_module.html"
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
12 lang="en">
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
13
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
14 <section id="summary">
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
15
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
16 <para>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 222
diff changeset
17 The module <literal>ngx_http_random_index_module</literal> picks a random
153
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
18 file in a directory as an index file.
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
19 It works before the
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
20 <link doc="ngx_http_index_module.xml">ngx_http_index_module</link>
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
21 module.
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
22 </para>
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
23
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
24 <para>
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
25 This module is not built by default, it should be enabled with the
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 222
diff changeset
26 <literal>--with-http_random_index_module</literal>
153
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
27 configuration parameter.
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
28 </para>
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
29
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
30 </section>
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
31
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
32
320
197ac51e7f0e Changed attributes order.
Ruslan Ermilov <ru@nginx.com>
parents: 271
diff changeset
33 <section id="example" name="Example Configuration">
153
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
34
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
35 <para>
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
36 <example>
351
a4fa80755eab Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents: 320
diff changeset
37 location / {
a4fa80755eab Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents: 320
diff changeset
38 random_index on;
a4fa80755eab Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents: 320
diff changeset
39 }
153
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
40 </example>
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
41 </para>
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
42
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
43 </section>
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
44
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
45
320
197ac51e7f0e Changed attributes order.
Ruslan Ermilov <ru@nginx.com>
parents: 271
diff changeset
46 <section id="directives" name="Directives">
153
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
47
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
48 <directive name="random_index">
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 222
diff changeset
49 <syntax><literal>on</literal> | <literal>off</literal></syntax>
153
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
50 <default>off</default>
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
51 <context>location</context>
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
52
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
53 <para>
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
54 Enables or disables module processing in a surrounding location.
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
55 </para>
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
56
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
57 </directive>
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
58
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
59 </section>
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
60
317ac898ba50 Initial translation of the "ngx_http_index_module" and
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
61 </module>