Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_ssi_module.xml @ 564:624ac281c628
Separate links to libxml2 and libxslt.
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Tue, 03 Jul 2012 08:14:32 +0000 |
parents | 694db9597ee0 |
children | be54c443235a |
rev | line source |
---|---|
399
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1 <?xml version="1.0"?> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
3 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
4 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
5 <module name="Module ngx_http_ssi_module" |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
6 link="/en/docs/http/ngx_http_ssi_module.html" |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
7 lang="en"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
8 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
9 <section id="summary"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
10 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
11 <para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
12 The <literal>ngx_http_ssi_module</literal> module is a filter |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
13 that processes SSI (Server Side Includes) commands in responses |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
14 passing through it. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
15 Currently, the list of supported SSI commands is incomplete. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
16 </para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
17 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
18 </section> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
19 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
20 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
21 <section id="example" name="Example Configuration"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
22 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
23 <para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
24 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
25 location / { |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
26 ssi on; |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
27 ... |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
28 } |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
29 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
30 </para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
31 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
32 </section> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
33 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
34 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
35 <section id="directives" name="Directives"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
36 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
37 <directive name="ssi"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
38 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
39 <default>off</default> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
40 <context>http</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
41 <context>server</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
42 <context>location</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
43 <context>if in location</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
44 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
45 <para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
46 Enables or disables processing of SSI commands in responses. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
47 </para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
48 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
49 </directive> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
50 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
51 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
52 <directive name="ssi_silent_errors"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
53 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
54 <default>off</default> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
55 <context>http</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
56 <context>server</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
57 <context>location</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
58 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
59 <para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
60 Allows to suppress output of the string |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
61 “<literal>[an error occurred while processing the directive]</literal>” |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
62 if an error occurred during SSI processing. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
63 </para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
64 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
65 </directive> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
66 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
67 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
68 <directive name="ssi_types"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
69 <syntax><value>mime-type</value> ...</syntax> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
70 <default>text/html</default> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
71 <context>http</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
72 <context>server</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
73 <context>location</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
74 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
75 <para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
76 Enables processing of SSI commands in responses with the specified MIME types |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
77 in addition to “<literal>text/html</literal>”. |
546
694db9597ee0
Documented the special value "*" in various "*_type" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
399
diff
changeset
|
78 The special value “<literal>*</literal>” matches any MIME type (0.8.29). |
399
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
79 </para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
80 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
81 </directive> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
82 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
83 </section> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
84 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
85 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
86 <section id="commands" name="SSI Commands"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
87 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
88 <para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
89 SSI commands have the following generic format: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
90 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
91 <!--# command parameter1=value1 parameter2=value2 ... --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
92 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
93 </para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
94 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
95 <para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
96 The following commands are supported: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
97 <list type="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
98 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
99 <tag-name><literal>block</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
100 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
101 Defines a block that can be used as a stub |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
102 in the <literal>include</literal> command. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
103 The block can contain other SSI commands. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
104 The command has the following parameter: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
105 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
106 <list type="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
107 <tag-name><literal>name</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
108 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
109 block name. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
110 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
111 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
112 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
113 Example: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
114 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
115 <!--# block name="one" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
116 stub |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
117 <!--# endblock --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
118 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
119 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
120 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
121 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
122 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
123 <tag-name><literal>config</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
124 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
125 Sets some parameters used during SSI processing, namely: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
126 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
127 <list type="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
128 <tag-name><literal>errmsg</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
129 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
130 a string that is output if an error occurs during SSI processing. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
131 By default, the following string is output: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
132 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
133 [an error occurred while processing the directive] |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
134 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
135 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
136 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
137 <tag-name><literal>timefmt</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
138 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
139 a format string passed to the <c-func>strftime</c-func> function |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
140 used to output date and time. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
141 By default, the following format is used: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
142 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
143 "%A, %d-%b-%Y %H:%M:%S %Z" |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
144 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
145 The “<literal>%s</literal>” format is suitable to output time in seconds. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
146 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
147 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
148 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
149 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
150 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
151 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
152 <tag-name><literal>echo</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
153 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
154 Outputs the value of a variable. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
155 The command has the following parameters: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
156 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
157 <list type="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
158 <tag-name><literal>var</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
159 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
160 variable name. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
161 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
162 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
163 <tag-name><literal>encoding</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
164 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
165 encoding method. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
166 Possible values include <literal>none</literal>, <literal>url</literal>, and |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
167 <literal>entity</literal>. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
168 By default, <literal>entity</literal> is used. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
169 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
170 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
171 <tag-name><literal>default</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
172 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
173 non-standard parameter that sets a string to be output |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
174 if a variable is undefined. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
175 By default, “<literal>none</literal>” is output. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
176 The command |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
177 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
178 <!--# echo var="name" default="<emphasis>no</emphasis>" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
179 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
180 replaces the following sequence of commands: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
181 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
182 <!--# if expr="$name" --><!--# echo var="name" --><!--# |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
183 else --><emphasis>no</emphasis><!--# endif --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
184 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
185 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
186 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
187 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
188 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
189 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
190 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
191 <tag-name><literal>if</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
192 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
193 Performs a conditional inclusion. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
194 The following commands are supported: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
195 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
196 <!--# if expr="..." --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
197 ... |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
198 <!--# elif expr="..." --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
199 ... |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
200 <!--# else --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
201 ... |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
202 <!--# endif --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
203 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
204 Only one level of nesting is currently supported. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
205 The command has the following parameter: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
206 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
207 <list type="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
208 <tag-name><literal>expr</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
209 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
210 expression. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
211 An expression can be: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
212 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
213 <list type="bullet"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
214 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
215 <listitem> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
216 variable existence check: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
217 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
218 <!--# if expr="$name" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
219 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
220 </listitem> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
221 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
222 <listitem> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
223 comparison of a variable with a text: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
224 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
225 <!--# if expr="$name = <value>text</value>" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
226 <!--# if expr="$name != <value>text</value>" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
227 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
228 </listitem> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
229 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
230 <listitem> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
231 comparison of a variable with a regular expression: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
232 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
233 <!--# if expr="$name = /<value>text</value>/" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
234 <!--# if expr="$name != /<value>text</value>/" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
235 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
236 </listitem> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
237 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
238 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
239 If a <value>text</value> contains variables, |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
240 their values are substituted. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
241 A regular expression can contain positional and named captures |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
242 that can later be used through variables, for example: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
243 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
244 <!--# if expr="$name = /(.+)@(?P<domain>.+)/" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
245 <!--# echo var="1" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
246 <!--# echo var="domain" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
247 <!--# endif --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
248 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
249 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
250 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
251 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
252 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
253 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
254 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
255 <tag-name><literal>include</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
256 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
257 Includes the result of another request into a response. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
258 The command has the following parameters: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
259 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
260 <list type="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
261 <tag-name><literal>file</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
262 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
263 specifies an included file, for example: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
264 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
265 <!--# include file="footer.html" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
266 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
267 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
268 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
269 <tag-name><literal>virtual</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
270 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
271 specifies an included request, for example: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
272 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
273 <!--# include virtual="/remote/body.php?argument=value" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
274 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
275 Several requests specified on one page and processed by proxied or |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
276 FastCGI servers run in parallel. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
277 If sequential processing is desired, the <literal>wait</literal> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
278 parameter should be used. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
279 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
280 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
281 <tag-name><literal>stub</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
282 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
283 non-standard parameter that names the block whose |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
284 content will be output if an included request results in an empty |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
285 body or if an error occurs during request processing, for example: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
286 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
287 <!--# block name="one" -->&nbsp;<!--# endblock --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
288 <!--# include virtual="/remote/body.php?argument=value" stub="one" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
289 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
290 The replacement block content is processed in the included request context. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
291 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
292 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
293 <tag-name><literal>wait</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
294 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
295 non-standard parameter that instructs to wait for a request to fully |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
296 complete before continuing with SSI processing, for example: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
297 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
298 <!--# include virtual="/remote/body.php?argument=value" wait="yes" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
299 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
300 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
301 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
302 <tag-name><literal>set</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
303 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
304 non-standard parameter that instructs to write a successful result |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
305 of request processing to the specified variable, |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
306 for example: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
307 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
308 <!--# include virtual="/remote/body.php?argument=value" set="one" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
309 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
310 It should be noted that only the results of responses obtained using the |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
311 <link doc="ngx_http_proxy_module.xml">ngx_http_proxy_module</link> and |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
312 <link doc="ngx_http_memcached_module.xml">ngx_http_memcached_module</link> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
313 modules can be written into variables. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
314 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
315 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
316 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
317 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
318 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
319 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
320 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
321 <tag-name><literal>set</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
322 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
323 Sets a value of a variable. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
324 The command has the following parameters: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
325 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
326 <list type="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
327 <tag-name><literal>var</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
328 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
329 variable name. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
330 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
331 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
332 <tag-name><literal>value</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
333 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
334 variable value. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
335 If an assigned value contains variables, |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
336 their values are substituted. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
337 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
338 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
339 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
340 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
341 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
342 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
343 </para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
344 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
345 </section> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
346 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
347 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
348 <section id="variables" name="Embedded Variables"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
349 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
350 <para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
351 The <literal>ngx_http_ssi_module</literal> module supports |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
352 two embedded variables: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
353 <list type="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
354 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
355 <tag-name><var>$date_local</var></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
356 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
357 current time in local time zone. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
358 The format is set by the <literal>config</literal> command |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
359 with the <literal>timefmt</literal> parameter. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
360 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
361 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
362 <tag-name><var>$date_gmt</var></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
363 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
364 current time in GMT. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
365 The format is set by the <literal>config</literal> command |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
366 with the <literal>timefmt</literal> parameter. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
367 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
368 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
369 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
370 </para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
371 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
372 </section> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
373 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
374 </module> |