Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_image_filter_module.xml @ 205:f743d1f4683a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fixed wording.
author Ruslan Ermilov <ru@nginx.com>
date Fri, 25 Nov 2011 13:45:14 +0000
parents eed54ef19197
children bfe3eff81d04
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
204
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1 <?xml version="1.0" encoding="utf-8"?>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
2
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
3 <!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
4
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
5 <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
6 link="/en/docs/http/ngx_http_image_filter_module.html"
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
7 lang="en">
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
8
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
9 <section id="summary">
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
10
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
11 <para>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
12 The <code>ngx_http_image_filter_module</code> module is a filter
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
13 that transforms images in JPEG, GIF, and PNG (0.7.54+) formats.
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
14 </para>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
15
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
16 <para>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
17 This module is not built by default, it should be enabled with the
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
18 <code>--with-http_image_filter_module</code>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
19 configuration parameter.
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
20 <note>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
21 This module utilizes the
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
22 <link url="http://libgd.org">libgd</link> library.
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
23 It is recommended to use the latest available version of the library;
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
24 it is version 2.0.35 as of this writing.
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
25 </note>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
26 </para>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
27
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
28 </section>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
29
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
30
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
31 <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
32
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
33 <para>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
34 <example>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
35 location /img/ {
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
36 proxy_pass http://backend;
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
37 image_filter resize 150 100;
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
38 image_filter rotate 90;
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
39 error_page 415 = /empty;
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
40 }
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
41
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
42 location = /empty {
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
43 empty_gif;
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
44 }
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
45 </example>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
46 </para>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
47
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
48 </section>
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
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
51 <section id="directives" name="Directives">
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 <directive name="image_filter">
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
54 <syntax><parameter>off</parameter></syntax>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
55 <syntax><parameter>test</parameter></syntax>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
56 <syntax><parameter>size</parameter></syntax>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
57 <syntax><parameter>rotate </parameter>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
58 <value>90</value> | <value>180</value> | <value>270</value>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
59 </syntax>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
60 <syntax>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
61 <parameter>resize </parameter>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
62 <argument>width height</argument>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
63 </syntax>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
64 <syntax>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
65 <parameter>crop </parameter>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
66 <argument>width height</argument>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
67 </syntax>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
68 <default/>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
69 <context>location</context>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
70
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
71 <para>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
72 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
73 <list type="tag">
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
74
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
75 <tag-name><parameter>off</parameter></tag-name>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
76 <tag-desc>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
77 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
78 </tag-desc>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
79
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
80 <tag-name><parameter>test</parameter></tag-name>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
81 <tag-desc>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
82 ensures that answers are images in either JPEG, GIF, or PNG format.
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
83 Otherwise, the error
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
84 <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
85 is returned.
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
86 </tag-desc>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
87
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
88 <tag-name><parameter>size</parameter></tag-name>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
89 <tag-desc>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
90 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
91 <example>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
92 { "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
93 </example>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
94 In case of an error, the following is output:
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
95 <example>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
96 {}
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 </tag-desc>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
99
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
100 <tag-name><parameter>rotate </parameter>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
101 <value>90</value>|<value>180</value>|<value>270</value>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
102 </tag-name>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
103 <tag-desc>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
104 rotates images counter-clockwise by the specified number of degrees.
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
105 The argument value can contain variables.
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
106 Can be used either alone, or along with the
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
107 <parameter>resize</parameter> and <parameter>crop</parameter> transformations.
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
108 </tag-desc>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
109
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
110 <tag-name><parameter>resize </parameter>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
111 <argument>width height</argument>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
112 </tag-name>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
113 <tag-desc>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
114 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
115 To reduce by only one dimension, another dimension can be specified as
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
116 “<code>-</code>”.
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
117 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
118 <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
119 Values of arguments can contain variables.
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
120 When used along with the <parameter>rotate</parameter> parameter,
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
121 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
122 </tag-desc>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
123
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
124 <tag-name><parameter>crop </parameter>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
125 <argument>width height</argument>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
126 </tag-name>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
127 <tag-desc>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
128 proportionally reduces an image to the size of the largest side
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
129 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
130 To reduce by only one dimension, another dimension can be specified as
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
131 “<code>-</code>”.
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
132 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
133 <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
134 Values of arguments can contain variables.
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
135 When used along with the <parameter>rotate</parameter> parameter,
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
136 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
137 </tag-desc>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
138
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
139 </list>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
140 </para>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
141
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
142 </directive>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
143
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
144
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
145 <directive name="image_filter_buffer">
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
146 <syntax><value>size</value></syntax>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
147 <default>1M</default>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
148 <context>http</context>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
149 <context>server</context>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
150 <context>location</context>
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 <para>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
153 Sets the maximum size of the buffer used for reading images.
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
154 When a size is exceeded the server will return error
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
155 <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
156 </para>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
157
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
158 </directive>
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
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
161 <directive name="image_filter_jpeg_quality">
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
162 <syntax><value>1..100</value></syntax>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
163 <default>75</default>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
164 <context>http</context>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
165 <context>server</context>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
166 <context>location</context>
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 <para>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
169 Sets the desired quality of the transformed JPEG images.
205
f743d1f4683a Fixed wording.
Ruslan Ermilov <ru@nginx.com>
parents: 204
diff changeset
170 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
171 The maximum recommended value is 95.
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
172 The argument value can contain variables.
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
173 </para>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
174
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
175 </directive>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
176
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
177
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
178 <directive name="image_filter_sharpen">
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
179 <syntax><argument>percent</argument></syntax>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
180 <default>0</default>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
181 <context>http</context>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
182 <context>server</context>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
183 <context>location</context>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
184
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
185 <para>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
186 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
187 The sharpness percentage can exceed 100.
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
188 The value of 0 disables sharpening.
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
189 The argument value can contain variables.
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
190 </para>
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 </directive>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
193
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
194
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
195 <directive name="image_filter_transparency">
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
196 <syntax><value>on</value>|<value>off</value></syntax>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
197 <default>on</default>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
198 <context>http</context>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
199 <context>server</context>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
200 <context>location</context>
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 <para>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
203 Defines whether transparency should be preserved when transforming
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
204 PNG images with colors specified by a palette, or in GIF images.
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
205 The loss of transparency allows to obtain images of a better quality.
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
206 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
207 </para>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
208
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
209 </directive>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
210
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
211 </section>
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
212
eed54ef19197 English translation of the ngx_http_image_filter_module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
213 </module>