Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_charset_module.xml @ 952:417dc982362e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated default for the "charset_types" directive.
author Valentin Bartenev <vbart@nginx.com>
date Wed, 31 Jul 2013 23:46:04 +0400
parents 764fbac1b8b4
children 95c3c3bbf1ce
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
350
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1 <?xml version="1.0"?>
55c1c4a1748f English translation of ngx_http_charset_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
350
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
9
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
10 <module name="Module ngx_http_charset_module"
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
11 link="/en/docs/http/ngx_http_charset_module.html"
589
764fbac1b8b4 Added document revision.
Ruslan Ermilov <ru@nginx.com>
parents: 580
diff changeset
12 lang="en"
952
417dc982362e Updated default for the "charset_types" directive.
Valentin Bartenev <vbart@nginx.com>
parents: 589
diff changeset
13 rev="2">
350
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
14
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
15 <section id="summary">
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
16
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
17 <para>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
18 The <literal>ngx_http_charset_module</literal> module adds the specified
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
19 charset to the <header>Content-Type</header> response header field.
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
20 In addition, the module can convert data from one charset to another,
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
21 with some limitations:
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
22 <list type="bullet">
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
23
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
24 <listitem>
367
f4033b9bc4ec - Removed unnecessary instances of unbreakable space.
Ruslan Ermilov <ru@nginx.com>
parents: 351
diff changeset
25 conversion is performed one way — from server to client,
350
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
26 </listitem>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
27
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
28 <listitem>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
29 only single-byte charsets can be converted
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
30 </listitem>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
31
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
32 <listitem>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
33 or single-byte charsets to/from UTF-8.
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
34 </listitem>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
35
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
36 </list>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
37 </para>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
38
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
39 </section>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
40
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
41
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
42 <section id="example" name="Example Configuration">
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
43
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
44 <para>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
45 <example>
351
a4fa80755eab Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents: 350
diff changeset
46 include conf/koi-win;
350
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
47
351
a4fa80755eab Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents: 350
diff changeset
48 charset windows-1251;
a4fa80755eab Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents: 350
diff changeset
49 source_charset koi8-r;
350
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
50 </example>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
51 </para>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
52
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
53 </section>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
54
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
55
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
56 <section id="directives" name="Directives">
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
57
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
58 <directive name="charset">
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
59 <syntax><value>charset</value> | <literal>off</literal></syntax>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
60 <default>off</default>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
61 <context>http</context>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
62 <context>server</context>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
63 <context>location</context>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
64 <context>if in location</context>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
65
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
66 <para>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
67 Adds the specified charset to the <header>Content-Type</header>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
68 response header field.
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
69 If this charset is different from the charset specified
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
70 in the <link id="source_charset"/> directive, a conversion is performed.
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
71 </para>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
72
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
73 <para>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
74 The parameter <literal>off</literal> cancels the addition of charset
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
75 to the <header>Content-Type</header> response header field.
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
76 </para>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
77
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
78 <para>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
79 A charset can be defined with a variable:
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
80 <example>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
81 charset $charset;
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
82 </example>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
83 In such a case, all possible values of a variable need to be present
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
84 in the configuration at least once in the form of the
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
85 <link id="charset_map"/>, <link id="charset"/>, or
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
86 <link id="source_charset"/> directives.
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
87 For <literal>utf-8</literal>, <literal>windows-1251</literal>, and
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
88 <literal>koi8-r</literal> charsets it is sufficient to include the files
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
89 <path>conf/koi-win</path>, <path>conf/koi-utf</path>, and
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
90 <path>conf/win-utf</path> into configuration.
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
91 For other charsets, simply making a fictitious conversion table works,
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
92 for example:
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
93 <example>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
94 charset_map iso-8859-5 _ { }
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
95 </example>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
96 </para>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
97
506
657848837328 Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents: 367
diff changeset
98 <para>
657848837328 Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents: 367
diff changeset
99 In addition, charset can also be set in the
657848837328 Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents: 367
diff changeset
100 <header>X-Accel-Charset</header> response header field.
657848837328 Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents: 367
diff changeset
101 This ability can be disabled using the
657848837328 Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents: 367
diff changeset
102 <link doc="ngx_http_proxy_module.xml" id="proxy_ignore_headers"/>
657848837328 Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents: 367
diff changeset
103 and
657848837328 Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents: 367
diff changeset
104 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_ignore_headers"/>
657848837328 Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents: 367
diff changeset
105 directives.
657848837328 Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents: 367
diff changeset
106 </para>
657848837328 Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents: 367
diff changeset
107
350
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
108 </directive>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
109
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
110
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
111 <directive name="charset_map">
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
112 <syntax block="yes"><value>charset1</value> <value>charset2</value></syntax>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
113 <default/>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
114 <context>http</context>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
115
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
116 <para>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
117 Describes the conversion table from one charset to another.
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
118 A reverse conversion table is built using the same data.
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
119 Character codes are given in hexadecimal.
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
120 Missing characters in the range 80-FF are replaced with “<literal>?</literal>”.
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
121 When converting from UTF-8, characters missing in a one-byte charset
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
122 are replaced with “<literal>&amp;#XXXX;</literal>”.
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
123 </para>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
124
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
125 <para>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
126 Example:
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
127 <example>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
128 charset_map koi8-r windows-1251 {
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
129 C0 FE ; # small yu
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
130 C1 E0 ; # small a
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
131 C2 E1 ; # small b
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
132 C3 F6 ; # small ts
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
133 ...
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
134 }
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
135 </example>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
136 </para>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
137
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
138 <para>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
139 When describing a conversion table to UTF-8, codes for the UTF-8 charset should
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
140 be given in the second column, for example:
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
141 <example>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
142 charset_map koi8-r utf-8 {
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
143 C0 D18E ; # small yu
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
144 C1 D0B0 ; # small a
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
145 C2 D0B1 ; # small b
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
146 C3 D186 ; # small ts
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
147 ...
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
148 }
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
149 </example>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
150 </para>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
151
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
152 <para>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
153 Full conversion tables from <literal>koi8-r</literal> to
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
154 <literal>windows-1251</literal>, and from <literal>koi8-r</literal> and
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
155 <literal>windows-1251</literal> to <literal>utf-8</literal>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
156 are provided in the distribution files <path>conf/koi-win</path>,
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
157 <path>conf/koi-utf</path>, and <path>conf/win-utf</path>.
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
158 </para>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
159
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
160 </directive>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
161
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
162
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
163 <directive name="charset_types">
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
164 <syntax><value>mime-type</value> ...</syntax>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
165 <default>text/html text/xml text/plain text/vnd.wap.wml
952
417dc982362e Updated default for the "charset_types" directive.
Valentin Bartenev <vbart@nginx.com>
parents: 589
diff changeset
166 application/javascript application/rss+xml</default>
350
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
167 <context>http</context>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
168 <context>server</context>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
169 <context>location</context>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
170 <appeared-in>0.7.9</appeared-in>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
171
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
172 <para>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
173 Enables module processing in responses with the specified MIME types
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
174 in addition to “<literal>text/html</literal>”.
546
694db9597ee0 Documented the special value "*" in various "*_type" directives.
Ruslan Ermilov <ru@nginx.com>
parents: 506
diff changeset
175 The special value “<literal>*</literal>” matches any MIME type (0.8.29).
350
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
176 </para>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
177
952
417dc982362e Updated default for the "charset_types" directive.
Valentin Bartenev <vbart@nginx.com>
parents: 589
diff changeset
178 <para>
417dc982362e Updated default for the "charset_types" directive.
Valentin Bartenev <vbart@nginx.com>
parents: 589
diff changeset
179 <note>
417dc982362e Updated default for the "charset_types" directive.
Valentin Bartenev <vbart@nginx.com>
parents: 589
diff changeset
180 Until version 1.5.4, “<literal>application/x-javascript</literal>” was used
417dc982362e Updated default for the "charset_types" directive.
Valentin Bartenev <vbart@nginx.com>
parents: 589
diff changeset
181 as the default MIME type instead of “<literal>application/javascript</literal>”.
417dc982362e Updated default for the "charset_types" directive.
Valentin Bartenev <vbart@nginx.com>
parents: 589
diff changeset
182 </note>
417dc982362e Updated default for the "charset_types" directive.
Valentin Bartenev <vbart@nginx.com>
parents: 589
diff changeset
183 </para>
417dc982362e Updated default for the "charset_types" directive.
Valentin Bartenev <vbart@nginx.com>
parents: 589
diff changeset
184
350
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
185 </directive>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
186
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
187
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
188 <directive name="override_charset">
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
189 <syntax><literal>on</literal> | <literal>off</literal></syntax>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
190 <default>off</default>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
191 <context>http</context>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
192 <context>server</context>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
193 <context>location</context>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
194 <context>if in location</context>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
195
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
196 <para>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
197 Determines if a conversion should be performed for answers
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
198 received from a proxied or FastCGI server,
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
199 if the answers already carry a charset in the <header>Content-Type</header>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
200 response header field.
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
201 If conversion is enabled, a charset specified in the received
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
202 response is used as a source charset.
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
203 <note>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
204 It should be noted that if a response was received in a subrequest
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
205 then conversion from the response charset to the main request charset
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
206 is always performed regardless of the <literal>override_charset</literal>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
207 directive setting.
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
208 </note>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
209 </para>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
210
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
211 </directive>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
212
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
213
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
214 <directive name="source_charset">
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
215 <syntax><value>charset</value></syntax>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
216 <default/>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
217 <context>http</context>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
218 <context>server</context>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
219 <context>location</context>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
220 <context>if in location</context>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
221
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
222 <para>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
223 Defines the source charset of a response.
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
224 If this charset is different from the charset specified
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
225 in the <link id="charset"/> directive, a conversion is performed.
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
226 </para>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
227
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
228 </directive>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
229
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
230 </section>
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
231
55c1c4a1748f English translation of ngx_http_charset_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
232 </module>