diff xml/en/docs/http/ngx_http_core_module.xml @ 768:f63b7fa3bf17

Added "id" attributes to http core module variables.
author Vladimir Homutov <vl@nginx.com>
date Mon, 19 Nov 2012 14:44:56 +0000
parents 1bb8b733416a
children d71e56d56ada
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_core_module.xml	Fri Nov 16 18:53:36 2012 +0000
+++ b/xml/en/docs/http/ngx_http_core_module.xml	Mon Nov 19 14:44:56 2012 +0000
@@ -2688,105 +2688,105 @@
 It also supports other variables:
 <list type="tag">
 
-<tag-name><var>$arg_</var><value>name</value></tag-name>
+<tag-name id="var_arg_"><var>$arg_</var><value>name</value></tag-name>
 <tag-desc>
 argument <value>name</value> in the request line
 </tag-desc>
 
-<tag-name><var>$args</var></tag-name>
+<tag-name id="var_args"><var>$args</var></tag-name>
 <tag-desc>
 arguments in the request line
 </tag-desc>
 
-<tag-name><var>$binary_remote_addr</var></tag-name>
+<tag-name id="var_binary_remote_addr"><var>$binary_remote_addr</var></tag-name>
 <tag-desc>
 client address in a binary form, value’s length is always 4 bytes
 </tag-desc>
 
-<tag-name><var>$body_bytes_sent</var></tag-name>
+<tag-name id="var_body_bytes_sent"><var>$body_bytes_sent</var></tag-name>
 <tag-desc>
 number of bytes sent to a client, not counting the response header
 </tag-desc>
 
-<tag-name><var>$content_length</var></tag-name>
+<tag-name id="var_content_length"><var>$content_length</var></tag-name>
 <tag-desc>
 <header>Content-Length</header> request header field
 </tag-desc>
 
-<tag-name><var>$content_type</var></tag-name>
+<tag-name id="var_content_type"><var>$content_type</var></tag-name>
 <tag-desc>
 <header>Content-Type</header> request header field
 </tag-desc>
 
-<tag-name><var>$cookie_</var><value>name</value></tag-name>
+<tag-name id="var_cookie_"><var>$cookie_</var><value>name</value></tag-name>
 <tag-desc>
 the <value>name</value> cookie
 </tag-desc>
 
-<tag-name><var>$document_root</var></tag-name>
+<tag-name id="var_document_root"><var>$document_root</var></tag-name>
 <tag-desc>
 <link id="root"/> or <link id="alias"/> directive’s value
 for the current request
 </tag-desc>
 
-<tag-name><var>$document_uri</var></tag-name>
+<tag-name id="var_document_uri"><var>$document_uri</var></tag-name>
 <tag-desc>
 same as <var>$uri</var>
 </tag-desc>
 
-<tag-name><var>$host</var></tag-name>
+<tag-name id="var_host"><var>$host</var></tag-name>
 <tag-desc>
 <header>Host</header> request header field,
 or the server name matching a request if this field is not present
 </tag-desc>
 
-<tag-name><var>$hostname</var></tag-name>
+<tag-name id="var_hostname"><var>$hostname</var></tag-name>
 <tag-desc>
 host name
 </tag-desc>
 
-<tag-name><var>$http_</var><value>name</value></tag-name>
+<tag-name id="var_http_"><var>$http_</var><value>name</value></tag-name>
 <tag-desc>
 arbitrary request header field;
 the last part of a variable name is the field name converted
 to lower case with dashes replaced by underscores
 </tag-desc>
 
-<tag-name><var>$https</var></tag-name>
+<tag-name id="var_https"><var>$https</var></tag-name>
 <tag-desc>
 “<literal>on</literal>”
 if connection operates in SSL mode,
 or an empty string otherwise
 </tag-desc>
 
-<tag-name><var>$is_args</var></tag-name>
+<tag-name id="var_is_args"><var>$is_args</var></tag-name>
 <tag-desc>
 “<literal>?</literal>” if a request line has arguments,
 or an empty string otherwise
 </tag-desc>
 
-<tag-name><var>$limit_rate</var></tag-name>
+<tag-name id="var_limit_rate"><var>$limit_rate</var></tag-name>
 <tag-desc>
 setting this variable allows for response rate limiting;
 see <link id="limit_rate"/>
 </tag-desc>
 
-<tag-name><var>$nginx_version</var></tag-name>
+<tag-name id="var_nginx_version"><var>$nginx_version</var></tag-name>
 <tag-desc>
 nginx version
 </tag-desc>
 
-<tag-name><var>$pid</var></tag-name>
+<tag-name id="var_pid"><var>$pid</var></tag-name>
 <tag-desc>
 PID of the worker process
 </tag-desc>
 
-<tag-name><var>$query_string</var></tag-name>
+<tag-name id="var_query_string"><var>$query_string</var></tag-name>
 <tag-desc>
 same as <var>$args</var>
 </tag-desc>
 
-<tag-name><var>$realpath_root</var></tag-name>
+<tag-name id="var_realpath_root"><var>$realpath_root</var></tag-name>
 <tag-desc>
 an absolute pathname corresponding to the
 <link id="root"/> or <link id="alias"/> directive’s value
@@ -2794,27 +2794,27 @@
 with all symbolic links resolved to real paths
 </tag-desc>
 
-<tag-name><var>$remote_addr</var></tag-name>
+<tag-name id="var_remote_addr"><var>$remote_addr</var></tag-name>
 <tag-desc>
 client address
 </tag-desc>
 
-<tag-name><var>$remote_port</var></tag-name>
+<tag-name id="var_remote_port"><var>$remote_port</var></tag-name>
 <tag-desc>
 client port
 </tag-desc>
 
-<tag-name><var>$remote_user</var></tag-name>
+<tag-name id="var_remote_user"><var>$remote_user</var></tag-name>
 <tag-desc>
 user name supplied with the Basic authentication
 </tag-desc>
 
-<tag-name><var>$request</var></tag-name>
+<tag-name id="var_request"><var>$request</var></tag-name>
 <tag-desc>
 full original request line
 </tag-desc>
 
-<tag-name><var>$request_body</var></tag-name>
+<tag-name id="var_request_body"><var>$request_body</var></tag-name>
 <tag-desc>
 request body
 <para>
@@ -2827,7 +2827,7 @@
 </para>
 </tag-desc>
 
-<tag-name><var>$request_body_file</var></tag-name>
+<tag-name id="var_request_body_file"><var>$request_body_file</var></tag-name>
 <tag-desc>
 name of a temporary file with the request body
 <para>
@@ -2846,43 +2846,43 @@
 </para>
 </tag-desc>
 
-<tag-name><var>$request_completion</var></tag-name>
+<tag-name id="var_request_completion"><var>$request_completion</var></tag-name>
 <tag-desc>
 “<literal>OK</literal>” if a request has completed,
 or an empty string otherwise
 </tag-desc>
 
-<tag-name><var>$request_filename</var></tag-name>
+<tag-name id="var_request_filename"><var>$request_filename</var></tag-name>
 <tag-desc>
 file path for the current request, based on the
 <link id="root"/> or <link id="alias"/>
 directives, and the request URI
 </tag-desc>
 
-<tag-name><var>$request_method</var></tag-name>
+<tag-name id="var_request_method"><var>$request_method</var></tag-name>
 <tag-desc>
 request method, usually
 “<literal>GET</literal>” or “<literal>POST</literal>”
 </tag-desc>
 
-<tag-name><var>$request_uri</var></tag-name>
+<tag-name id="var_request_uri"><var>$request_uri</var></tag-name>
 <tag-desc>
 full original request URI (with arguments)
 </tag-desc>
 
-<tag-name><var>$scheme</var></tag-name>
+<tag-name id="var_scheme"><var>$scheme</var></tag-name>
 <tag-desc>
 request scheme, “<literal>http</literal>” or “<literal>https</literal>”
 </tag-desc>
 
-<tag-name><var>$sent_http_</var><value>name</value></tag-name>
+<tag-name id="var_sent_http_"><var>$sent_http_</var><value>name</value></tag-name>
 <tag-desc>
 arbitrary response header field;
 the last part of a variable name is the field name converted
 to lower case with dashes replaced by underscores
 </tag-desc>
 
-<tag-name><var>$server_addr</var></tag-name>
+<tag-name id="var_server_addr"><var>$server_addr</var></tag-name>
 <tag-desc>
 an address of the server which accepted a request
 <para>
@@ -2892,17 +2892,17 @@
 </para>
 </tag-desc>
 
-<tag-name><var>$server_name</var></tag-name>
+<tag-name id="var_server_name"><var>$server_name</var></tag-name>
 <tag-desc>
 name of the server which accepted a request
 </tag-desc>
 
-<tag-name><var>$server_port</var></tag-name>
+<tag-name id="var_server_port"><var>$server_port</var></tag-name>
 <tag-desc>
 port of the server which accepted a request
 </tag-desc>
 
-<tag-name><var>$server_protocol</var></tag-name>
+<tag-name id="var_server_protocol"><var>$server_protocol</var></tag-name>
 <tag-desc>
 request protocol, usually
 “<literal>HTTP/1.0</literal>”
@@ -2910,12 +2910,12 @@
 “<literal>HTTP/1.1</literal>”
 </tag-desc>
 
-<tag-name><var>$status</var></tag-name>
+<tag-name id="var_status"><var>$status</var></tag-name>
 <tag-desc>
 response status
 </tag-desc>
 
-<tag-name>
+<tag-name id="var_tcpinfo_">
 <var>$tcpinfo_rtt</var>,
 <var>$tcpinfo_rttvar</var>,
 <var>$tcpinfo_snd_cwnd</var>,
@@ -2926,7 +2926,7 @@
 that support the <c-def>TCP_INFO</c-def> socket option
 </tag-desc>
 
-<tag-name><var>$uri</var></tag-name>
+<tag-name id="var_uri"><var>$uri</var></tag-name>
 <tag-desc>
 current URI in request, <link id="location">normalized</link>
 <para>