Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_image_filter_module.xml @ 1641:c0d1026e7e7b
Documented the "auto" parameter in worker_cpu_affinity.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Tue, 19 Jan 2016 14:19:30 +0300 |
parents | 95c3c3bbf1ce |
children | 6ebdef43330a |
rev | line source |
---|---|
222
bfe3eff81d04
Removed redundant encoding specification.
Ruslan Ermilov <ru@nginx.com>
parents:
205
diff
changeset
|
1 <?xml version="1.0"?> |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2 |
580
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
3 <!-- |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
4 Copyright (C) Igor Sysoev |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
5 Copyright (C) Nginx, Inc. |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
6 --> |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
7 |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
9 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
10 <module name="Module ngx_http_image_filter_module" |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
11 link="/en/docs/http/ngx_http_image_filter_module.html" |
589 | 12 lang="en" |
873
1e4f86ac3716
Documented the "image_filter_interlace" directive.
Homutov Vladimir <vl@nginx.com>
parents:
710
diff
changeset
|
13 rev="3"> |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
14 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
15 <section id="summary"> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
16 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
17 <para> |
347
daae2b619815
Specify the module history information in a unified place.
Ruslan Ermilov <ru@nginx.com>
parents:
294
diff
changeset
|
18 The <literal>ngx_http_image_filter_module</literal> module (0.7.54+) is a filter |
daae2b619815
Specify the module history information in a unified place.
Ruslan Ermilov <ru@nginx.com>
parents:
294
diff
changeset
|
19 that transforms images in JPEG, GIF, and PNG formats. |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
20 </para> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
21 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
22 <para> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
23 This module is not built by default, it should be enabled with the |
271 | 24 <literal>--with-http_image_filter_module</literal> |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
25 configuration parameter. |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
26 <note> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
27 This module utilizes the |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
28 <link url="http://libgd.org">libgd</link> library. |
966 | 29 It is recommended to use the latest available version of the library. |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
30 </note> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
31 </para> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
32 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
33 </section> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
34 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
35 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
36 <section id="example" name="Example Configuration"> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
37 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
38 <para> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
39 <example> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
40 location /img/ { |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
41 proxy_pass http://backend; |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
42 image_filter resize 150 100; |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
43 image_filter rotate 90; |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
44 error_page 415 = /empty; |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
45 } |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
46 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
47 location = /empty { |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
48 empty_gif; |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
49 } |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
50 </example> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
51 </para> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
52 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
53 </section> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
54 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
55 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
56 <section id="directives" name="Directives"> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
57 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
58 <directive name="image_filter"> |
364 | 59 <syntax><literal>off</literal></syntax> |
60 <syntax><literal>test</literal></syntax> | |
61 <syntax><literal>size</literal></syntax> | |
62 <syntax> | |
63 <literal>rotate</literal> | |
64 <literal>90</literal> | <literal>180</literal> | | |
65 <literal>270</literal></syntax> | |
66 <syntax> | |
67 <literal>resize</literal> | |
68 <value>width</value> | |
69 <value>height</value></syntax> | |
70 <syntax> | |
71 <literal>crop</literal> | |
72 <value>width</value> | |
73 <value>height</value></syntax> | |
683
6c14c73d74ee
Documented default value of the image_filter directive.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
74 <default>off</default> |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
75 <context>location</context> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
76 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
77 <para> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
78 Sets the type of transformation to perform on images: |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
79 <list type="tag"> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
80 |
271 | 81 <tag-name><literal>off</literal></tag-name> |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
82 <tag-desc> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
83 turns off module processing in a surrounding location. |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
84 </tag-desc> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
85 |
271 | 86 <tag-name><literal>test</literal></tag-name> |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
87 <tag-desc> |
294 | 88 ensures that responses are images in either JPEG, GIF, or PNG format. |
966 | 89 Otherwise, the |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
90 <http-status code="415" text="Unsupported Media Type"/> |
966 | 91 error is returned. |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
92 </tag-desc> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
93 |
271 | 94 <tag-name><literal>size</literal></tag-name> |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
95 <tag-desc> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
96 outputs information about images in a JSON format, e.g.: |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
97 <example> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
98 { "img" : { "width": 100, "height": 100, "type": "gif" } } |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
99 </example> |
966 | 100 In case of an error, the output is as follows: |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
101 <example> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
102 {} |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
103 </example> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
104 </tag-desc> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
105 |
271 | 106 <tag-name><literal>rotate</literal> |
107 <literal>90</literal>|<literal>180</literal>|<literal>270</literal> | |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
108 </tag-name> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
109 <tag-desc> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
110 rotates images counter-clockwise by the specified number of degrees. |
966 | 111 Parameter value can contain variables. |
112 This mode can be used either alone or along with the | |
271 | 113 <literal>resize</literal> and <literal>crop</literal> transformations. |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
114 </tag-desc> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
115 |
271 | 116 <tag-name><literal>resize</literal> |
117 <value>width</value> | |
118 <value>height</value> | |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
119 </tag-name> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
120 <tag-desc> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
121 proportionally reduces an image to the specified sizes. |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
122 To reduce by only one dimension, another dimension can be specified as |
271 | 123 “<literal>-</literal>”. |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
124 In case of an error, the server will return code |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
125 <http-status code="415" text="Unsupported Media Type"/>. |
966 | 126 Parameter values can contain variables. |
271 | 127 When used along with the <literal>rotate</literal> parameter, |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
128 the rotation happens <emphasis>after</emphasis> reduction. |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
129 </tag-desc> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
130 |
271 | 131 <tag-name><literal>crop</literal> |
132 <value>width</value> | |
133 <value>height</value> | |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
134 </tag-name> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
135 <tag-desc> |
966 | 136 proportionally reduces an image to the larger side size |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
137 and crops extraneous edges by another side. |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
138 To reduce by only one dimension, another dimension can be specified as |
271 | 139 “<literal>-</literal>”. |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
140 In case of an error, the server will return code |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
141 <http-status code="415" text="Unsupported Media Type"/>. |
966 | 142 Parameter values can contain variables. |
271 | 143 When used along with the <literal>rotate</literal> parameter, |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
144 the rotation happens <emphasis>before</emphasis> reduction. |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
145 </tag-desc> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
146 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
147 </list> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
148 </para> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
149 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
150 </directive> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
151 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
152 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
153 <directive name="image_filter_buffer"> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
154 <syntax><value>size</value></syntax> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
155 <default>1M</default> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
156 <context>http</context> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
157 <context>server</context> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
158 <context>location</context> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
159 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
160 <para> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
161 Sets the maximum size of the buffer used for reading images. |
966 | 162 When the size is exceeded the server returns error |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
163 <http-status code="415" text="Unsupported Media Type"/>. |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
164 </para> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
165 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
166 </directive> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
167 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
168 |
873
1e4f86ac3716
Documented the "image_filter_interlace" directive.
Homutov Vladimir <vl@nginx.com>
parents:
710
diff
changeset
|
169 <directive name="image_filter_interlace"> |
1e4f86ac3716
Documented the "image_filter_interlace" directive.
Homutov Vladimir <vl@nginx.com>
parents:
710
diff
changeset
|
170 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
1e4f86ac3716
Documented the "image_filter_interlace" directive.
Homutov Vladimir <vl@nginx.com>
parents:
710
diff
changeset
|
171 <default>off</default> |
1e4f86ac3716
Documented the "image_filter_interlace" directive.
Homutov Vladimir <vl@nginx.com>
parents:
710
diff
changeset
|
172 <context>http</context> |
1e4f86ac3716
Documented the "image_filter_interlace" directive.
Homutov Vladimir <vl@nginx.com>
parents:
710
diff
changeset
|
173 <context>server</context> |
1e4f86ac3716
Documented the "image_filter_interlace" directive.
Homutov Vladimir <vl@nginx.com>
parents:
710
diff
changeset
|
174 <context>location</context> |
1e4f86ac3716
Documented the "image_filter_interlace" directive.
Homutov Vladimir <vl@nginx.com>
parents:
710
diff
changeset
|
175 <appeared-in>1.3.15</appeared-in> |
1e4f86ac3716
Documented the "image_filter_interlace" directive.
Homutov Vladimir <vl@nginx.com>
parents:
710
diff
changeset
|
176 |
1e4f86ac3716
Documented the "image_filter_interlace" directive.
Homutov Vladimir <vl@nginx.com>
parents:
710
diff
changeset
|
177 <para> |
1e4f86ac3716
Documented the "image_filter_interlace" directive.
Homutov Vladimir <vl@nginx.com>
parents:
710
diff
changeset
|
178 If enabled, final images will be interlaced. |
1e4f86ac3716
Documented the "image_filter_interlace" directive.
Homutov Vladimir <vl@nginx.com>
parents:
710
diff
changeset
|
179 For JPEG, final images will be in “progressive JPEG” format. |
1e4f86ac3716
Documented the "image_filter_interlace" directive.
Homutov Vladimir <vl@nginx.com>
parents:
710
diff
changeset
|
180 </para> |
1e4f86ac3716
Documented the "image_filter_interlace" directive.
Homutov Vladimir <vl@nginx.com>
parents:
710
diff
changeset
|
181 |
1e4f86ac3716
Documented the "image_filter_interlace" directive.
Homutov Vladimir <vl@nginx.com>
parents:
710
diff
changeset
|
182 </directive> |
1e4f86ac3716
Documented the "image_filter_interlace" directive.
Homutov Vladimir <vl@nginx.com>
parents:
710
diff
changeset
|
183 |
1e4f86ac3716
Documented the "image_filter_interlace" directive.
Homutov Vladimir <vl@nginx.com>
parents:
710
diff
changeset
|
184 |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
185 <directive name="image_filter_jpeg_quality"> |
271 | 186 <syntax><value>quality</value></syntax> |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
187 <default>75</default> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
188 <context>http</context> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
189 <context>server</context> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
190 <context>location</context> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
191 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
192 <para> |
271 | 193 Sets the desired <value>quality</value> of the transformed JPEG images. |
966 | 194 Acceptable values are in the range from 1 to 100. |
205 | 195 Lesser values usually imply both lower image quality and less data to transfer. |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
196 The maximum recommended value is 95. |
966 | 197 Parameter value can contain variables. |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
198 </para> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
199 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
200 </directive> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
201 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
202 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
203 <directive name="image_filter_sharpen"> |
271 | 204 <syntax><value>percent</value></syntax> |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
205 <default>0</default> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
206 <context>http</context> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
207 <context>server</context> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
208 <context>location</context> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
209 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
210 <para> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
211 Increases sharpness of the final image. |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
212 The sharpness percentage can exceed 100. |
966 | 213 The zero value disables sharpening. |
214 Parameter value can contain variables. | |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
215 </para> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
216 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
217 </directive> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
218 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
219 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
220 <directive name="image_filter_transparency"> |
271 | 221 <syntax><literal>on</literal>|<literal>off</literal></syntax> |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
222 <default>on</default> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
223 <context>http</context> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
224 <context>server</context> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
225 <context>location</context> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
226 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
227 <para> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
228 Defines whether transparency should be preserved when transforming |
966 | 229 GIF images or PNG images with colors specified by a palette. |
230 The loss of transparency results in images of a better quality. | |
204
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
231 The alpha channel transparency in PNG is always preserved. |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
232 </para> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
233 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
234 </directive> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
235 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
236 </section> |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
237 |
eed54ef19197
English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
238 </module> |