Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_geoip_module.xml @ 834:1a6cb3e282fe

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
GeoIP: updated description of module variables (English). Documented missing variables: $geoip_city_continent_code, $geoip_area_code, $geoip_dma_code, $geoip_latitude, $geoip_longitude, and $geoip_region_name. Fixed description of the $geoip_region variable.
author Homutov Vladimir <vl@nginx.com>
date Wed, 06 Feb 2013 17:30:00 +0400
parents c66610f9a53f
children 9dab69f2b71d
comparison
equal deleted inserted replaced
833:e23004ce65ef 834:1a6cb3e282fe
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
9 9
10 <module name="Module ngx_http_geoip_module" 10 <module name="Module ngx_http_geoip_module"
11 link="/en/docs/http/ngx_http_geoip_module.html" 11 link="/en/docs/http/ngx_http_geoip_module.html"
12 lang="en" 12 lang="en"
13 rev="2"> 13 rev="3">
14 14
15 <section id="summary"> 15 <section id="summary">
16 16
17 <para> 17 <para>
18 The <literal>ngx_http_geoip_module</literal> module (0.8.6+) creates variables 18 The <literal>ngx_http_geoip_module</literal> module (0.8.6+) creates variables
101 Specifies a database used to determine a country, region, and city 101 Specifies a database used to determine a country, region, and city
102 depending on the client IP address. 102 depending on the client IP address.
103 The following variables are available when using this database: 103 The following variables are available when using this database:
104 <list type="tag"> 104 <list type="tag">
105 105
106 <tag-name><var>$geoip_area_code</var></tag-name>
107 <tag-desc>telephone area code (US only).
108 <note>
109 This variable may contain outdated information since
110 the corresponding database field is deprecated.
111 </note>
112 </tag-desc>
113
114 <tag-name><var>$geoip_city_continent_code</var></tag-name>
115 <tag-desc>two-letter continent code, for example,
116 “<literal>EU</literal>”, “<literal>NA</literal>”.
117 </tag-desc>
118
106 <tag-name><var>$geoip_city_country_code</var></tag-name> 119 <tag-name><var>$geoip_city_country_code</var></tag-name>
107 <tag-desc> 120 <tag-desc>
108 two-letter country code, for example, 121 two-letter country code, for example,
109 “<literal>RU</literal>”, “<literal>US</literal>”. 122 “<literal>RU</literal>”, “<literal>US</literal>”.
110 </tag-desc> 123 </tag-desc>
119 <tag-desc> 132 <tag-desc>
120 country name, for example, 133 country name, for example,
121 “<literal>Russian Federation</literal>”, “<literal>United States</literal>”. 134 “<literal>Russian Federation</literal>”, “<literal>United States</literal>”.
122 </tag-desc> 135 </tag-desc>
123 136
137 <tag-name><var>$geoip_dma_code</var></tag-name>
138 <tag-desc>
139 DMA region code in US (also known as “metro code”), according to the
140 <link url="https://developers.google.com/adwords/api/docs/appendix/cities-DMAregions">geotargeting</link>
141 in Google AdWords API.
142 </tag-desc>
143
144 <tag-name><var>$geoip_latitude</var></tag-name>
145 <tag-desc>latitude.</tag-desc>
146
147 <tag-name><var>$geoip_longitude</var></tag-name>
148 <tag-desc>longitude.</tag-desc>
149
124 <tag-name><var>$geoip_region</var></tag-name> 150 <tag-name><var>$geoip_region</var></tag-name>
151 <tag-desc>
152 two-symbol country region code (region, territory, state, province, federal land
153 and the like), for example,
154 “<literal>48</literal>”, “<literal>DC</literal>”.
155 </tag-desc>
156
157 <tag-name><var>$geoip_region_name</var></tag-name>
125 <tag-desc> 158 <tag-desc>
126 country region name (region, territory, state, province, federal land 159 country region name (region, territory, state, province, federal land
127 and the like), for example, 160 and the like), for example,
128 “<literal>Moscow City</literal>”, “<literal>DC</literal>”. 161 “<literal>Moscow City</literal>”, “<literal>District of Columbia</literal>”.
129 </tag-desc> 162 </tag-desc>
130 163
131 <tag-name><var>$geoip_city</var></tag-name> 164 <tag-name><var>$geoip_city</var></tag-name>
132 <tag-desc> 165 <tag-desc>
133 city name, for example, 166 city name, for example,