Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_ssi_module.xml @ 702:6b6585577c33
Slightly changed the wording when talking about the "rewrite_log" directive.
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Thu, 04 Oct 2012 08:27:40 +0000 |
parents | 764fbac1b8b4 |
children | 64085bf227f6 |
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 |
580
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
546
diff
changeset
|
3 <!-- |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
546
diff
changeset
|
4 Copyright (C) Igor Sysoev |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
546
diff
changeset
|
5 Copyright (C) Nginx, Inc. |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
546
diff
changeset
|
6 --> |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
546
diff
changeset
|
7 |
399
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
9 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
10 <module name="Module ngx_http_ssi_module" |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
11 link="/en/docs/http/ngx_http_ssi_module.html" |
589 | 12 lang="en" |
13 rev="1"> | |
399
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
14 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
15 <section id="summary"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
16 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
17 <para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
18 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
|
19 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
|
20 passing through it. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
21 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
|
22 </para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
23 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
24 </section> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
25 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
26 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
27 <section id="example" name="Example Configuration"> |
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 <para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
30 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
31 location / { |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
32 ssi on; |
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 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
36 </para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
37 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
38 </section> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
39 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
40 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
41 <section id="directives" name="Directives"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
42 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
43 <directive name="ssi"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
44 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
45 <default>off</default> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
46 <context>http</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
47 <context>server</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
48 <context>location</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
49 <context>if in location</context> |
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 <para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
52 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
|
53 </para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
54 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
55 </directive> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
56 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
57 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
58 <directive name="ssi_silent_errors"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
59 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
60 <default>off</default> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
61 <context>http</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
62 <context>server</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
63 <context>location</context> |
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 <para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
66 Allows to suppress output of the string |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
67 “<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
|
68 if an error occurred during SSI processing. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
69 </para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
70 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
71 </directive> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
72 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
73 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
74 <directive name="ssi_types"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
75 <syntax><value>mime-type</value> ...</syntax> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
76 <default>text/html</default> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
77 <context>http</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
78 <context>server</context> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
79 <context>location</context> |
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 <para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
82 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
|
83 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
|
84 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
|
85 </para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
86 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
87 </directive> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
88 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
89 </section> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
90 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
91 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
92 <section id="commands" name="SSI Commands"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
93 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
94 <para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
95 SSI commands have the following generic format: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
96 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
97 <!--# command parameter1=value1 parameter2=value2 ... --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
98 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
99 </para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
100 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
101 <para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
102 The following commands are supported: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
103 <list type="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
104 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
105 <tag-name><literal>block</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
106 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
107 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
|
108 in the <literal>include</literal> command. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
109 The block can contain other SSI commands. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
110 The command has the following parameter: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
111 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
112 <list type="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
113 <tag-name><literal>name</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
114 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
115 block name. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
116 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
117 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
118 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
119 Example: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
120 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
121 <!--# block name="one" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
122 stub |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
123 <!--# endblock --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
124 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
125 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
126 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
127 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
128 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
129 <tag-name><literal>config</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
130 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
131 Sets some parameters used during SSI processing, namely: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
132 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
133 <list type="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
134 <tag-name><literal>errmsg</literal></tag-name> |
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 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
|
137 By default, the following string is output: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
138 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
139 [an error occurred while processing the directive] |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
140 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
141 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
142 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
143 <tag-name><literal>timefmt</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
144 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
145 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
|
146 used to output date and time. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
147 By default, the following format is used: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
148 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
149 "%A, %d-%b-%Y %H:%M:%S %Z" |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
150 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
151 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
|
152 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
153 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
154 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
155 </tag-desc> |
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 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
158 <tag-name><literal>echo</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 Outputs the value of a variable. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
161 The command has the following parameters: |
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 <list type="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
164 <tag-name><literal>var</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
165 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
166 variable name. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
167 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
168 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
169 <tag-name><literal>encoding</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
170 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
171 encoding method. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
172 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
|
173 <literal>entity</literal>. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
174 By default, <literal>entity</literal> is used. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
175 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
176 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
177 <tag-name><literal>default</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
178 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
179 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
|
180 if a variable is undefined. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
181 By default, “<literal>none</literal>” is output. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
182 The command |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
183 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
184 <!--# echo var="name" default="<emphasis>no</emphasis>" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
185 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
186 replaces the following sequence of commands: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
187 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
188 <!--# if expr="$name" --><!--# echo var="name" --><!--# |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
189 else --><emphasis>no</emphasis><!--# endif --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
190 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
191 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
192 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
193 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
194 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
195 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
196 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
197 <tag-name><literal>if</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
198 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
199 Performs a conditional inclusion. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
200 The following commands are supported: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
201 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
202 <!--# if expr="..." --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
203 ... |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
204 <!--# elif expr="..." --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
205 ... |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
206 <!--# else --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
207 ... |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
208 <!--# endif --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
209 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
210 Only one level of nesting is currently supported. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
211 The command has the following parameter: |
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="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
214 <tag-name><literal>expr</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
215 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
216 expression. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
217 An expression can be: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
218 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
219 <list type="bullet"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
220 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
221 <listitem> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
222 variable existence check: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
223 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
224 <!--# if expr="$name" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
225 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
226 </listitem> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
227 |
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 comparison of a variable with a text: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
230 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
231 <!--# if expr="$name = <value>text</value>" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
232 <!--# if expr="$name != <value>text</value>" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
233 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
234 </listitem> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
235 |
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 comparison of a variable with a regular expression: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
238 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
239 <!--# if expr="$name = /<value>text</value>/" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
240 <!--# if expr="$name != /<value>text</value>/" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
241 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
242 </listitem> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
243 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
244 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
245 If a <value>text</value> contains variables, |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
246 their values are substituted. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
247 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
|
248 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
|
249 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
250 <!--# if expr="$name = /(.+)@(?P<domain>.+)/" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
251 <!--# echo var="1" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
252 <!--# echo var="domain" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
253 <!--# endif --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
254 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
255 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
256 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
257 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
258 </tag-desc> |
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 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
261 <tag-name><literal>include</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 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
|
264 The command has the following parameters: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
265 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
266 <list type="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
267 <tag-name><literal>file</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
268 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
269 specifies an included file, for example: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
270 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
271 <!--# include file="footer.html" --> |
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 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
274 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
275 <tag-name><literal>virtual</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
276 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
277 specifies an included request, for example: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
278 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
279 <!--# include virtual="/remote/body.php?argument=value" --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
280 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
281 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
|
282 FastCGI servers run in parallel. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
283 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
|
284 parameter should be used. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
285 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
286 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
287 <tag-name><literal>stub</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
288 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
289 non-standard parameter that names the block whose |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
290 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
|
291 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
|
292 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
293 <!--# block name="one" -->&nbsp;<!--# endblock --> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
294 <!--# 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
|
295 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
296 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
|
297 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
298 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
299 <tag-name><literal>wait</literal></tag-name> |
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 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
|
302 complete before continuing with SSI processing, for example: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
303 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
304 <!--# 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
|
305 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
306 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
307 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
308 <tag-name><literal>set</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
309 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
310 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
|
311 of request processing to the specified variable, |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
312 for example: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
313 <example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
314 <!--# 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
|
315 </example> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
316 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
|
317 <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
|
318 <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
|
319 modules can be written into variables. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
320 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
321 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
322 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
323 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
324 </tag-desc> |
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 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
327 <tag-name><literal>set</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 Sets a value of a variable. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
330 The command has the following parameters: |
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 <list type="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
333 <tag-name><literal>var</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
334 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
335 variable name. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
336 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
337 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
338 <tag-name><literal>value</literal></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
339 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
340 variable value. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
341 If an assigned value contains variables, |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
342 their values are substituted. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
343 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
344 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
345 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
346 </tag-desc> |
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 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
349 </para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
350 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
351 </section> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
352 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
353 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
354 <section id="variables" name="Embedded Variables"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
355 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
356 <para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
357 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
|
358 two embedded variables: |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
359 <list type="tag"> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
360 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
361 <tag-name><var>$date_local</var></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
362 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
363 current time in local time zone. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
364 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
|
365 with the <literal>timefmt</literal> parameter. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
366 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
367 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
368 <tag-name><var>$date_gmt</var></tag-name> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
369 <tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
370 current time in GMT. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
371 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
|
372 with the <literal>timefmt</literal> parameter. |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
373 </tag-desc> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
374 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
375 </list> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
376 </para> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
377 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
378 </section> |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
379 |
a56540cdcea5
English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
380 </module> |