Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_ssi_module.xml @ 583:90a5a62031ad

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added a forgotten link to ngx_http_index_module.
author Ruslan Ermilov <ru@nginx.com>
date Wed, 11 Jul 2012 05:21:53 +0000
parents be54c443235a
children 764fbac1b8b4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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"
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
12 lang="en">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
13
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
14 <section id="summary">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
15
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 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
18 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
19 passing through it.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
20 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
21 </para>
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 </section>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
24
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 <section id="example" name="Example Configuration">
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 <para>
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 location / {
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
31 ssi on;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
32 ...
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 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
35 </para>
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 </section>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
38
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 <section id="directives" name="Directives">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
41
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
42 <directive name="ssi">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
43 <syntax><literal>on</literal> | <literal>off</literal></syntax>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
44 <default>off</default>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
45 <context>http</context>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
46 <context>server</context>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
47 <context>location</context>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
48 <context>if in location</context>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
49
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
50 <para>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
51 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
52 </para>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
53
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
54 </directive>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
55
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 <directive name="ssi_silent_errors">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
58 <syntax><literal>on</literal> | <literal>off</literal></syntax>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
59 <default>off</default>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
60 <context>http</context>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
61 <context>server</context>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
62 <context>location</context>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
63
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
64 <para>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
65 Allows to suppress output of the string
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
66 “<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
67 if an error occurred during SSI processing.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
68 </para>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
69
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
70 </directive>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
71
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 <directive name="ssi_types">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
74 <syntax><value>mime-type</value> ...</syntax>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
75 <default>text/html</default>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
76 <context>http</context>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
77 <context>server</context>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
78 <context>location</context>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
79
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
80 <para>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
81 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
82 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
83 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
84 </para>
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 </directive>
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 </section>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
89
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 <section id="commands" name="SSI Commands">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
92
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 SSI commands have the following generic format:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
95 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
96 &lt;!--# command parameter1=value1 parameter2=value2 ... --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
97 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
98 </para>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
99
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
100 <para>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
101 The following commands are supported:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
102 <list type="tag">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
103
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
104 <tag-name><literal>block</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
105 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
106 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
107 in the <literal>include</literal> command.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
108 The block can contain other SSI commands.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
109 The command has the following parameter:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
110
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
111 <list type="tag">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
112 <tag-name><literal>name</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
113 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
114 block name.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
115 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
116 </list>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
117
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 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
120 &lt;!--# block name="one" --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
121 stub
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
122 &lt;!--# endblock --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
123 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
124
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
125 </tag-desc>
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
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
128 <tag-name><literal>config</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 Sets some parameters used during SSI processing, namely:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
131
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
132 <list type="tag">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
133 <tag-name><literal>errmsg</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
134 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
135 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
136 By default, the following string is output:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
137 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
138 [an error occurred while processing the directive]
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
139 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
140 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
141
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
142 <tag-name><literal>timefmt</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
143 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
144 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
145 used to output date and time.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
146 By default, the following format is used:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
147 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
148 "%A, %d-%b-%Y %H:%M:%S %Z"
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
149 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
150 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
151 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
152 </list>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
153
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
154 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
155
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 <tag-name><literal>echo</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
158 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
159 Outputs the value of a variable.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
160 The command has the following parameters:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
161
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
162 <list type="tag">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
163 <tag-name><literal>var</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 variable name.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
166 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
167
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
168 <tag-name><literal>encoding</literal></tag-name>
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 encoding method.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
171 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
172 <literal>entity</literal>.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
173 By default, <literal>entity</literal> is used.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
174 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
175
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
176 <tag-name><literal>default</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
177 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
178 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
179 if a variable is undefined.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
180 By default, “<literal>none</literal>” is output.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
181 The command
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
182 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
183 &lt;!--# echo var="name" default="<emphasis>no</emphasis>" --&gt;
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 replaces the following sequence of commands:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
186 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
187 &lt;!--# if expr="$name" --&gt;&lt;!--# echo var="name" --&gt;&lt;!--#
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
188 else --&gt;<emphasis>no</emphasis>&lt;!--# endif --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
189 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
190 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
191 </list>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
192
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
193 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
194
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 <tag-name><literal>if</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
197 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
198 Performs a conditional inclusion.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
199 The following commands are supported:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
200 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
201 &lt;!--# if expr="..." --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
202 ...
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
203 &lt;!--# elif expr="..." --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
204 ...
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
205 &lt;!--# else --&gt;
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 &lt;!--# endif --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
208 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
209 Only one level of nesting is currently supported.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
210 The command has the following parameter:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
211
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
212 <list type="tag">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
213 <tag-name><literal>expr</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
214 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
215 expression.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
216 An expression can be:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
217
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
218 <list type="bullet">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
219
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 variable existence check:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
222 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
223 &lt;!--# if expr="$name" --&gt;
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 </listitem>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
226
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
227 <listitem>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
228 comparison of a variable with a text:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
229 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
230 &lt;!--# if expr="$name = <value>text</value>" --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
231 &lt;!--# if expr="$name != <value>text</value>" --&gt;
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 </listitem>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
234
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
235 <listitem>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
236 comparison of a variable with a regular expression:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
237 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
238 &lt;!--# if expr="$name = /<value>text</value>/" --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
239 &lt;!--# if expr="$name != /<value>text</value>/" --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
240 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
241 </listitem>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
242 </list>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
243
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
244 If a <value>text</value> contains variables,
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
245 their values are substituted.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
246 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
247 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
248 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
249 &lt;!--# if expr="$name = /(.+)@(?P&lt;domain&gt;.+)/" --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
250 &lt;!--# echo var="1" --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
251 &lt;!--# echo var="domain" --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
252 &lt;!--# endif --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
253 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
254 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
255 </list>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
256
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
257 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
258
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 <tag-name><literal>include</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
261 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
262 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
263 The command has the following parameters:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
264
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
265 <list type="tag">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
266 <tag-name><literal>file</literal></tag-name>
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 specifies an included file, for example:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
269 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
270 &lt;!--# include file="footer.html" --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
271 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
272 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
273
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
274 <tag-name><literal>virtual</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
275 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
276 specifies an included request, for example:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
277 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
278 &lt;!--# include virtual="/remote/body.php?argument=value" --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
279 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
280 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
281 FastCGI servers run in parallel.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
282 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
283 parameter should be used.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
284 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
285
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
286 <tag-name><literal>stub</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
287 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
288 non-standard parameter that names the block whose
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
289 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
290 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
291 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
292 &lt;!--# block name="one" --&gt;&amp;nbsp;&lt;!--# endblock --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
293 &lt;!--# include virtual="/remote/body.php?argument=value" stub="one" --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
294 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
295 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
296 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
297
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
298 <tag-name><literal>wait</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
299 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
300 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
301 complete before continuing with SSI processing, for example:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
302 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
303 &lt;!--# include virtual="/remote/body.php?argument=value" wait="yes" --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
304 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
305 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
306
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
307 <tag-name><literal>set</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
308 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
309 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
310 of request processing to the specified variable,
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
311 for example:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
312 <example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
313 &lt;!--# include virtual="/remote/body.php?argument=value" set="one" --&gt;
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
314 </example>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
315 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
316 <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
317 <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
318 modules can be written into variables.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
319 </tag-desc>
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 </list>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
322
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
323 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
324
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 <tag-name><literal>set</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
327 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
328 Sets a value of a variable.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
329 The command has the following parameters:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
330
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
331 <list type="tag">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
332 <tag-name><literal>var</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 name.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
335 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
336
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
337 <tag-name><literal>value</literal></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
338 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
339 variable value.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
340 If an assigned value contains variables,
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
341 their values are substituted.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
342 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
343 </list>
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 </tag-desc>
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 </list>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
348 </para>
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 </section>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
351
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 <section id="variables" name="Embedded Variables">
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 <para>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
356 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
357 two embedded variables:
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
358 <list type="tag">
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
359
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
360 <tag-name><var>$date_local</var></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
361 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
362 current time in local time zone.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
363 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
364 with the <literal>timefmt</literal> parameter.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
365 </tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
366
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
367 <tag-name><var>$date_gmt</var></tag-name>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
368 <tag-desc>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
369 current time in GMT.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
370 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
371 with the <literal>timefmt</literal> parameter.
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
372 </tag-desc>
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 </list>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
375 </para>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
376
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
377 </section>
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
378
a56540cdcea5 English translation of ngx_http_ssi_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
379 </module>