Mercurial > hg > nginx-site
diff xml/en/docs/http/ngx_http_core_module.xml @ 271:4c6d2c614d2c
Cleaned up XML tag mess:
- all of <parameter> and <code>, and some of <dirname>, <value>,
and <command> were replaced by <literal>;
- the rest of <dirname> were replaced by links;
- <argument> were replaced by <value>;
- <value> is now rendered in HTML in italic;
- <literal> and <path> can now contain <value>.
Cleaned up terminology mess:
- directives take "parameters".
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Fri, 23 Dec 2011 17:29:59 +0000 |
parents | 945d7299c26c |
children | 4a0fe9283dc7 |
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_core_module.xml Thu Dec 22 13:39:18 2011 +0000 +++ b/xml/en/docs/http/ngx_http_core_module.xml Fri Dec 23 17:29:59 2011 +0000 @@ -10,9 +10,9 @@ <directive name="aio"> <syntax> - <value>on</value> | - <value>off</value> | - <value>sendfile</value></syntax> + <literal>on</literal> | + <literal>off</literal> | + <literal>sendfile</literal></syntax> <default>off</default> <context>http</context> <context>server</context> @@ -132,7 +132,7 @@ <directive name="alias"> -<syntax><argument>path</argument></syntax> +<syntax><value>path</value></syntax> <default/> <context>location</context> @@ -145,20 +145,20 @@ } </example> the request of -“<code>/i/top.gif</code>” will be responded +“<literal>/i/top.gif</literal>” will be responded with the file <path>/data/w3/images/top.gif</path>. </para> <para> -The <argument>path</argument> value can contain variables +The <value>path</value> value can contain variables except <var>$document_root</var> and <var>$realpath_root</var>. </para> <para> -If <code>alias</code> is used inside a location defined +If <literal>alias</literal> is used inside a location defined with a regular expression then such regular expression should -contain captures and <code>alias</code> should refer to +contain captures and <literal>alias</literal> should refer to these captures (0.7.40), for example: <example> location ~ ^/users/(.+\.(?:gif|jpe?g|png))$ { @@ -188,7 +188,7 @@ <directive name="chunked_transfer_encoding"> -<syntax><value>on</value> | <value>off</value></syntax> +<syntax><literal>on</literal> | <literal>off</literal></syntax> <default>on</default> <context>http</context> <context>server</context> @@ -205,7 +205,7 @@ <directive name="client_body_buffer_size"> -<syntax><argument>size</argument></syntax> +<syntax><value>size</value></syntax> <default>8k|16k</default> <context>http</context> <context>server</context> @@ -226,9 +226,9 @@ <directive name="client_body_in_file_only"> <syntax> - <value>on</value> | - <value>clean</value> | - <value>off</value></syntax> + <literal>on</literal> | + <literal>clean</literal> | + <literal>off</literal></syntax> <default>off</default> <context>http</context> <context>server</context> @@ -246,12 +246,12 @@ </para> <para> -When set to the value <value>on</value>, temporary files are not +When set to the value <literal>on</literal>, temporary files are not removed after request processing. </para> <para> -The value <value>clean</value> will cause the temporary files +The value <literal>clean</literal> will cause the temporary files left after request processing to be removed. </para> @@ -259,7 +259,7 @@ <directive name="client_body_in_single_buffer"> -<syntax><value>on</value> | <value>off</value></syntax> +<syntax><literal>on</literal> | <literal>off</literal></syntax> <default>off</default> <context>http</context> <context>server</context> @@ -278,10 +278,10 @@ <directive name="client_body_temp_path"> <syntax> - <argument>path</argument> - [<argument>level1</argument> - [<argument>level2</argument> - [<argument>level3</argument>]]]</syntax> + <value>path</value> + [<value>level1</value> + [<value>level2</value> + [<value>level3</value>]]]</syntax> <default>client_body_temp</default> <context>http</context> <context>server</context> @@ -305,7 +305,7 @@ <directive name="client_body_timeout"> -<syntax><argument>time</argument></syntax> +<syntax><value>time</value></syntax> <default>60s</default> <context>http</context> <context>server</context> @@ -325,7 +325,7 @@ <directive name="client_header_buffer_size"> -<syntax><argument>size</argument></syntax> +<syntax><value>size</value></syntax> <default>1k</default> <context>http</context> <context>server</context> @@ -345,7 +345,7 @@ <directive name="client_header_timeout"> -<syntax><argument>time</argument></syntax> +<syntax><value>time</value></syntax> <default>60s</default> <context>http</context> <context>server</context> @@ -362,7 +362,7 @@ <directive name="client_max_body_size"> -<syntax><argument>size</argument></syntax> +<syntax><value>size</value></syntax> <default>1m</default> <context>http</context> <context>server</context> @@ -379,7 +379,7 @@ Please be aware that <!--link doc="/web/upload.xml"-->browsers cannot correctly display this error<!--/link-->. -Setting <argument>size</argument> to 0 disables client +Setting <value>size</value> to 0 disables client request body size checking. </para> @@ -387,7 +387,7 @@ <directive name="connection_pool_size"> -<syntax><argument>size</argument></syntax> +<syntax><value>size</value></syntax> <default>256</default> <context>http</context> <context>server</context> @@ -402,7 +402,7 @@ <directive name="default_type"> -<syntax><argument>mime-type</argument></syntax> +<syntax><value>mime-type</value></syntax> <default>text/plain</default> <context>http</context> <context>server</context> @@ -417,7 +417,7 @@ <directive name="directio"> -<syntax><argument>size</argument> | <value>off</value></syntax> +<syntax><value>size</value> | <literal>off</literal></syntax> <default>off</default> <context>http</context> <context>server</context> @@ -430,7 +430,7 @@ the <c-def>F_NOCACHE</c-def> flag (Mac OS X), or the <c-func>directio</c-func> function (Solaris), when reading files that are larger than or equal to -the specified <argument>size</argument>. +the specified <value>size</value>. It automatically disables (0.7.15) the use of <link id="sendfile"/> for a given request. @@ -445,7 +445,7 @@ <directive name="directio_alignment"> -<syntax><argument>size</argument></syntax> +<syntax><value>size</value></syntax> <default>512</default> <context>http</context> <context>server</context> @@ -464,9 +464,9 @@ <directive name="error_page"> <syntax> - <argument>code</argument> ... - [<value>=</value>[<argument>response</argument>]] - <argument>uri</argument></syntax> + <value>code</value> ... + [<literal>=</literal>[<value>response</value>]] + <value>uri</value></syntax> <default/> <context>http</context> <context>server</context> @@ -477,7 +477,7 @@ Defines the URI that will be shown for the specified errors. These directives are inherited from the previous level if and only if there are no -<code>error_page</code> +<literal>error_page</literal> directives on the current level. A URI value can contain variables. @@ -527,9 +527,9 @@ <directive name="if_modified_since"> <syntax> - <value>off</value> | - <value>exact</value> | - <value>before</value></syntax> + <literal>off</literal> | + <literal>exact</literal> | + <literal>before</literal></syntax> <default>exact</default> <context>http</context> <context>server</context> @@ -544,18 +544,18 @@ <list type="tag"> -<tag-name><value>off</value></tag-name> +<tag-name><literal>off</literal></tag-name> <tag-desc> the <header>If-Modified-Since</header> request header field is ignored (0.7.34); </tag-desc> -<tag-name><value>exact</value></tag-name> +<tag-name><literal>exact</literal></tag-name> <tag-desc> exact match; </tag-desc> -<tag-name><value>before</value></tag-name> +<tag-name><literal>before</literal></tag-name> <tag-desc> modification time of a response is less than or equal to the time in the <header>If-Modified-Since</header> @@ -569,7 +569,7 @@ <directive name="ignore_invalid_headers"> -<syntax><value>on</value> | <value>off</value></syntax> +<syntax><literal>on</literal> | <literal>off</literal></syntax> <default>on</default> <context>http</context> <context>server</context> @@ -604,7 +604,7 @@ <listitem> subrequests formed by the -<command>include virtual</command> +“<command>include virtual</command>” command of the module <link doc="ngx_http_ssi_module.xml">ngx_http_ssi_module</link>; </listitem> @@ -633,7 +633,7 @@ <directive name="keepalive_disable"> -<syntax><value>none</value> | <argument>browser</argument> ...</syntax> +<syntax><literal>none</literal> | <value>browser</value> ...</syntax> <default>msie6 safari</default> <context>http</context> <context>server</context> @@ -641,13 +641,13 @@ <para> Disables keep-alive connections with misbehaving browsers. -The <argument>browser</argument> arguments specify which +The <value>browser</value> parameters specify which browsers will be affected. -The value <value>msie6</value> disables keep-alive connections +The value <literal>msie6</literal> disables keep-alive connections with old versions of MSIE, after seeing a POST request. -The value <value>safari</value> disables keep-alive connections +The value <literal>safari</literal> disables keep-alive connections with Safari browsers. -The value <value>none</value> enables keep-alive connections +The value <literal>none</literal> enables keep-alive connections with all browsers. </para> @@ -655,7 +655,7 @@ <directive name="keepalive_requests"> -<syntax><argument>number</argument></syntax> +<syntax><value>number</value></syntax> <default>100</default> <context>http</context> <context>server</context> @@ -673,25 +673,25 @@ <directive name="keepalive_timeout"> <syntax> - <argument>timeout</argument> - [<argument>header_timeout</argument>]</syntax> + <value>timeout</value> + [<value>header_timeout</value>]</syntax> <default>75s</default> <context>http</context> <context>server</context> <context>location</context> <para> -The first argument sets a timeout during which a keep-alive +The first parameter sets a timeout during which a keep-alive client connection will stay open on the server side. -The optional second argument sets a value in the -<header>Keep-Alive: timeout=<argument>time</argument></header> +The optional second parameter sets a value in the +<header>Keep-Alive: timeout=<value>time</value></header> response header field. -Two arguments may differ. +Two parameters may differ. </para> <para> The -<header>Keep-Alive: timeout=<argument>time</argument></header> +<header>Keep-Alive: timeout=<value>time</value></header> header field is understood by Mozilla and Konqueror. MSIE will close keep-alive connection in about 60 seconds. </para> @@ -700,13 +700,13 @@ <directive name="large_client_header_buffers"> -<syntax><argument>number</argument> <argument>size</argument></syntax> +<syntax><value>number</value> <value>size</value></syntax> <default>4 8k</default> <context>http</context> <context>server</context> <para> -Sets the maximum <argument>number</argument> and <argument>size</argument> of +Sets the maximum <value>number</value> and <value>size</value> of buffers used when reading large client request header. A request line cannot exceed the size of one buffer, or the client error <http-status code="414" text="Request-URI Too Large"/> @@ -725,30 +725,30 @@ <directive name="limit_except"> -<syntax block="yes"><argument>method</argument> ...</syntax> +<syntax block="yes"><value>method</value> ...</syntax> <default/> <context>location</context> <para> Limits allowed HTTP methods inside a location. -The <argument>method</argument> argument can be one of the following: -<value>GET</value>, -<value>HEAD</value>, -<value>POST</value>, -<value>PUT</value>, -<value>DELETE</value>, -<value>MKCOL</value>, -<value>COPY</value>, -<value>MOVE</value>, -<value>OPTIONS</value>, -<value>PROPFIND</value>, -<value>PROPPATCH</value>, -<value>LOCK</value>, -<value>UNLOCK</value>, +The <value>method</value> parameter can be one of the following: +<literal>GET</literal>, +<literal>HEAD</literal>, +<literal>POST</literal>, +<literal>PUT</literal>, +<literal>DELETE</literal>, +<literal>MKCOL</literal>, +<literal>COPY</literal>, +<literal>MOVE</literal>, +<literal>OPTIONS</literal>, +<literal>PROPFIND</literal>, +<literal>PROPPATCH</literal>, +<literal>LOCK</literal>, +<literal>UNLOCK</literal>, or -<value>PATCH</value>. -Allowing the <value>GET</value> method also allows the -<value>HEAD</value> method. +<literal>PATCH</literal>. +Allowing the <literal>GET</literal> method also allows the +<literal>HEAD</literal> method. Access to other methods can be limited using the <link doc="ngx_http_access_module.xml">ngx_http_access_module</link> and @@ -768,7 +768,7 @@ <directive name="limit_rate"> -<syntax><argument>rate</argument></syntax> +<syntax><value>rate</value></syntax> <default>0</default> <context>http</context> <context>server</context> @@ -777,7 +777,7 @@ <para> Rate limits the transmission of a response to a client. -The <argument>rate</argument> is specified in bytes per second. +The <value>rate</value> is specified in bytes per second. Value 0 (the default) disables rate limiting. <!-- The smaller the rate, the more accurate will be the limitation. @@ -810,7 +810,7 @@ <directive name="limit_rate_after"> -<syntax><argument>size</argument></syntax> +<syntax><value>size</value></syntax> <default>0</default> <context>http</context> <context>server</context> @@ -838,7 +838,10 @@ <directive name="lingering_close"> -<syntax><value>off</value> | <value>on</value> | <value>always</value></syntax> +<syntax> + <literal>off</literal> | + <literal>on</literal> | + <literal>always</literal></syntax> <default>on</default> <context>http</context> <context>server</context> @@ -851,7 +854,7 @@ </para> <para> -The default value “<value>on</value>” instructs nginx to +The default value “<literal>on</literal>” instructs nginx to <link id="lingering_timeout">wait for</link> and <link id="lingering_time">process</link> additional data from a client before fully closing a connection, but only @@ -859,12 +862,12 @@ </para> <para> -The value “<value>always</value>” will cause nginx to unconditionally +The value “<literal>always</literal>” will cause nginx to unconditionally wait for and process additional client data. </para> <para> -The value “<value>off</value>” tells nginx to never wait for +The value “<literal>off</literal>” tells nginx to never wait for more data and close the connection immediately. This breaks the protocol and should not be used under normal circumstances. </para> @@ -873,7 +876,7 @@ <directive name="lingering_time"> -<syntax><argument>time</argument></syntax> +<syntax><value>time</value></syntax> <default>30s</default> <context>http</context> <context>server</context> @@ -890,7 +893,7 @@ <directive name="lingering_timeout"> -<syntax><argument>time</argument></syntax> +<syntax><value>time</value></syntax> <default>5s</default> <context>http</context> <context>server</context> @@ -910,52 +913,52 @@ <directive name="listen"> <syntax> - <argument>address</argument>[:<argument>port</argument>] - [<parameter>default_server</parameter>] - [<parameter>setfib</parameter>=<argument>number</argument>] - [<parameter>backlog</parameter>=<argument>number</argument>] - [<parameter>rcvbuf</parameter>=<argument>size</argument>] - [<parameter>sndbuf</parameter>=<argument>size</argument>] - [<parameter>accept_filter</parameter>=<argument>filter</argument>] - [<parameter>deferred</parameter>] - [<parameter>bind</parameter>] - [<parameter>ipv6only</parameter>=<value>on</value>|<value>off</value>] - [<parameter>ssl</parameter>] - [<parameter>so_keepalive</parameter>=<value>on</value>|<value>off</value>|[<argument>keepidle</argument>]:[<argument>keepintvl</argument>]:[<argument>keepcnt</argument>]]</syntax> + <value>address</value>[:<value>port</value>] + [<literal>default_server</literal>] + [<literal>setfib</literal>=<value>number</value>] + [<literal>backlog</literal>=<value>number</value>] + [<literal>rcvbuf</literal>=<value>size</value>] + [<literal>sndbuf</literal>=<value>size</value>] + [<literal>accept_filter</literal>=<value>filter</value>] + [<literal>deferred</literal>] + [<literal>bind</literal>] + [<literal>ipv6only</literal>=<literal>on</literal>|<literal>off</literal>] + [<literal>ssl</literal>] + [<literal>so_keepalive</literal>=<literal>on</literal>|<literal>off</literal>|[<value>keepidle</value>]:[<value>keepintvl</value>]:[<value>keepcnt</value>]]</syntax> <syntax> - <argument>port</argument> - [<parameter>default_server</parameter>] - [<parameter>setfib</parameter>=<argument>number</argument>] - [<parameter>backlog</parameter>=<argument>number</argument>] - [<parameter>rcvbuf</parameter>=<argument>size</argument>] - [<parameter>sndbuf</parameter>=<argument>size</argument>] - [<parameter>accept_filter</parameter>=<argument>filter</argument>] - [<parameter>deferred</parameter>] - [<parameter>bind</parameter>] - [<parameter>ipv6only</parameter>=<value>on</value>|<value>off</value>] - [<parameter>ssl</parameter>] - [<parameter>so_keepalive</parameter>=<value>on</value>|<value>off</value>|[<argument>keepidle</argument>]:[<argument>keepintvl</argument>]:[<argument>keepcnt</argument>]]</syntax> + <value>port</value> + [<literal>default_server</literal>] + [<literal>setfib</literal>=<value>number</value>] + [<literal>backlog</literal>=<value>number</value>] + [<literal>rcvbuf</literal>=<value>size</value>] + [<literal>sndbuf</literal>=<value>size</value>] + [<literal>accept_filter</literal>=<value>filter</value>] + [<literal>deferred</literal>] + [<literal>bind</literal>] + [<literal>ipv6only</literal>=<literal>on</literal>|<literal>off</literal>] + [<literal>ssl</literal>] + [<literal>so_keepalive</literal>=<literal>on</literal>|<literal>off</literal>|[<value>keepidle</value>]:[<value>keepintvl</value>]:[<value>keepcnt</value>]]</syntax> <syntax> - <value>unix:</value><argument>path</argument> - [<parameter>default_server</parameter>] - [<parameter>backlog</parameter>=<argument>number</argument>] - [<parameter>rcvbuf</parameter>=<argument>size</argument>] - [<parameter>sndbuf</parameter>=<argument>size</argument>] - [<parameter>accept_filter</parameter>=<argument>filter</argument>] - [<parameter>deferred</parameter>] - [<parameter>bind</parameter>] - [<parameter>ssl</parameter>] - [<parameter>so_keepalive</parameter>=<value>on</value>|<value>off</value>|[<argument>keepidle</argument>]:[<argument>keepintvl</argument>]:[<argument>keepcnt</argument>]]</syntax> + <literal>unix:</literal><value>path</value> + [<literal>default_server</literal>] + [<literal>backlog</literal>=<value>number</value>] + [<literal>rcvbuf</literal>=<value>size</value>] + [<literal>sndbuf</literal>=<value>size</value>] + [<literal>accept_filter</literal>=<value>filter</value>] + [<literal>deferred</literal>] + [<literal>bind</literal>] + [<literal>ssl</literal>] + [<literal>so_keepalive</literal>=<literal>on</literal>|<literal>off</literal>|[<value>keepidle</value>]:[<value>keepintvl</value>]:[<value>keepcnt</value>]]</syntax> <default>*:80 | *:8000</default> <context>server</context> <para> -Sets an <argument>address</argument> and a <argument>port</argument> for IP, -or a <argument>path</argument> for a UNIX-domain socket, on which +Sets an <value>address</value> and a <value>port</value> for IP, +or a <value>path</value> for a UNIX-domain socket, on which the server will accept requests. -Only one of <argument>address</argument> or <argument>port</argument> may be +Only one of <value>address</value> or <value>port</value> may be specified. -An <argument>address</argument> may also be a hostname, for example: +An <value>address</value> may also be a hostname, for example: <example> listen 127.0.0.1:8000; listen 127.0.0.1; @@ -968,51 +971,51 @@ listen [::]:8000; listen [fe80::1]; </example> -UNIX-domain sockets (0.8.21) are specified with the “<code>unix:</code>” prefix: +UNIX-domain sockets (0.8.21) are specified with the “<literal>unix:</literal>” prefix: <example> listen unix:/var/run/nginx.sock; </example> </para> <para> -If only <argument>address</argument> is given, the port 80 is used. +If only <value>address</value> is given, the port 80 is used. </para> <para> -If directive is not present then either the <code>*:80</code> is used -if nginx runs with superuser privileges, or <code>*:8000</code> otherwise. +If directive is not present then either the <literal>*:80</literal> is used +if nginx runs with superuser privileges, or <literal>*:8000</literal> otherwise. </para> <para> -The <parameter>default_server</parameter> parameter, if present, +The <literal>default_server</literal> parameter, if present, will cause the server to become the default server for the specified -<argument>address</argument>:<argument>port</argument> pair. -If none of the directives have the <parameter>default_server</parameter> +<value>address</value>:<value>port</value> pair. +If none of the directives have the <literal>default_server</literal> parameter then the first server with the -<argument>address</argument>:<argument>port</argument> pair will be +<value>address</value>:<value>port</value> pair will be the default server for this pair. <note> In versions prior to 0.8.21 this parameter is named simply -<parameter>default</parameter>. +<literal>default</literal>. </note> </para> <para> -A <code>listen</code> directive +A <literal>listen</literal> directive can have several additional parameters specific to system calls <c-func>listen</c-func> and <c-func>bind</c-func>. They can be specified in any -<code>listen</code> directive, but only once for the given -<argument>address</argument>:<argument>port</argument> pair. +<literal>listen</literal> directive, but only once for the given +<value>address</value>:<value>port</value> pair. <note> In versions prior to 0.8.21, they could only be -specified in the <code>listen</code> directive with the -<parameter>default</parameter> parameter. +specified in the <literal>listen</literal> directive with the +<literal>default</literal> parameter. </note> <list type="tag"> <tag-name> -<parameter>setfib</parameter>=<argument>number</argument> +<literal>setfib</literal>=<value>number</value> </tag-name> <tag-desc> this parameter (0.8.44) sets the associated FIB (routing table) @@ -1021,43 +1024,43 @@ </tag-desc> <tag-name> -<parameter>backlog</parameter>=<argument>number</argument> +<literal>backlog</literal>=<value>number</value> </tag-name> <tag-desc> -sets the <parameter>backlog</parameter> parameter in the +sets the <literal>backlog</literal> parameter in the <c-func>listen</c-func> call. -By default, <parameter>backlog</parameter> equals -1 on FreeBSD +By default, <literal>backlog</literal> equals -1 on FreeBSD and 511 on other platforms. </tag-desc> <tag-name> -<parameter>rcvbuf</parameter>=<argument>size</argument> +<literal>rcvbuf</literal>=<value>size</value> </tag-name> <tag-desc> sets the <c-def>SO_RCVBUF</c-def> parameter for the listening socket. </tag-desc> <tag-name> -<parameter>sndbuf</parameter>=<argument>size</argument> +<literal>sndbuf</literal>=<value>size</value> </tag-name> <tag-desc> sets the <c-def>SO_SNDBUF</c-def> parameter for the listening socket. </tag-desc> <tag-name> -<parameter>accept_filter</parameter>=<argument>filter</argument> +<literal>accept_filter</literal>=<value>filter</value> </tag-name> <tag-desc> sets the name of the accept filter. -This works only on FreeBSD, acceptable values are <value>dataready</value> -and <value>httpready</value>. +This works only on FreeBSD, acceptable values are <literal>dataready</literal> +and <literal>httpready</literal>. On receipt of the <c-def>SIGHUP</c-def> signal, an accept filter can only be changed in recent versions of FreeBSD, starting from 6.0, 5.4-STABLE and 4.11-STABLE. </tag-desc> <tag-name> -<parameter>deferred</parameter> +<literal>deferred</literal> </tag-name> <tag-desc> instructs to use a deferred <c-func>accept</c-func> on Linux @@ -1065,30 +1068,30 @@ </tag-desc> <tag-name> -<parameter>bind</parameter> +<literal>bind</literal> </tag-name> <tag-desc> instructs to make a separate <c-func>bind</c-func> call for a given -<argument>address</argument>:<argument>port</argument> pair. +<value>address</value>:<value>port</value> pair. This is because nginx will <c-func>bind</c-func> only to -<code>*</code>:<argument>port</argument> -if there are several <code>listen</code> directives with +<literal>*:</literal><value>port</value> +if there are several <literal>listen</literal> directives with the same port but different addresses, and one of the -<code>listen</code> directives listens on all addresses -for the given port (<code>*</code>:<argument>port</argument>). +<literal>listen</literal> directives listens on all addresses +for the given port (<literal>*:</literal><value>port</value>). It should be noted that in this case a <c-func>getsockname</c-func> system call will be made to determine an address that accepted a connection. -If parameters <parameter>backlog</parameter>, <parameter>rcvbuf</parameter>, -<parameter>sndbuf</parameter>, <parameter>accept_filter</parameter>, -<parameter>deferred</parameter>, or <parameter>so_keepalive</parameter> +If parameters <literal>backlog</literal>, <literal>rcvbuf</literal>, +<literal>sndbuf</literal>, <literal>accept_filter</literal>, +<literal>deferred</literal>, or <literal>so_keepalive</literal> are used then for a given -<argument>address</argument>:<argument>port</argument> pair +<value>address</value>:<value>port</value> pair a separate <c-func>bind</c-func> call will always be made. </tag-desc> <tag-name> -<parameter>ipv6only</parameter>=<value>on</value>|<value>off</value> +<literal>ipv6only</literal>=<literal>on</literal>|<literal>off</literal> </tag-name> <tag-desc> this parameter (0.7.42) sets the value of the <c-def>IPV6_V6ONLY</c-def> @@ -1097,7 +1100,7 @@ </tag-desc> <tag-name> -<parameter>ssl</parameter> +<literal>ssl</literal> </tag-name> <tag-desc> this parameter (0.7.14) does not relate to system calls @@ -1113,24 +1116,24 @@ </tag-desc> <tag-name> -<parameter>so_keepalive</parameter>=<value>on</value>|<value>off</value>|[<argument>keepidle</argument>]:[<argument>keepintvl</argument>]:[<argument>keepcnt</argument>] +<literal>so_keepalive</literal>=<literal>on</literal>|<literal>off</literal>|[<value>keepidle</value>]:[<value>keepintvl</value>]:[<value>keepcnt</value>] </tag-name> <tag-desc> this parameter (1.1.11) configures the “TCP keepalive” behavior for the listening socket. If this parameter is omitted then the system default setting will be in effect for the socket. -If set to the value “<value>on</value>”, the <c-def>SO_KEEPALIVE</c-def> +If set to the value “<literal>on</literal>”, the <c-def>SO_KEEPALIVE</c-def> socket option is turned on for the socket. -If set to the value “<value>off</value>”, the <c-def>SO_KEEPALIVE</c-def> +If set to the value “<literal>off</literal>”, the <c-def>SO_KEEPALIVE</c-def> socket option is turned off for the socket. Some operating systems support tuning TCP keepalive parameters on a per-socket basis using the <c-def>TCP_KEEPIDLE</c-def>, <c-def>TCP_KEEPINTVL</c-def>, and <c-def>TCP_KEEPCNT</c-def> socket options. On such systems (currently, Linux 2.4+ and NetBSD 5+) they can be configured -using the <argument>keepidle</argument>, <argument>keepintvl</argument>, and -<argument>keepcnt</argument> arguments. -One or two arguments may be omitted, in which case the system default setting +using the <value>keepidle</value>, <value>keepintvl</value>, and +<value>keepcnt</value> parameters. +One or two parameters may be omitted, in which case the system default setting for the corresponding socket option will be in effect. For example, <example>so_keepalive=30m::10</example> @@ -1154,12 +1157,12 @@ <directive name="location"> <syntax block="yes">[ - <value>=</value> | - <value>~</value> | - <value>~*</value> | - <value>^~</value> - ] <argument>uri</argument></syntax> -<syntax block="yes"><value>@</value><argument>name</argument></syntax> + <literal>=</literal> | + <literal>~</literal> | + <literal>~*</literal> | + <literal>^~</literal> + ] <value>uri</value></syntax> +<syntax block="yes"><literal>@</literal><value>name</value></syntax> <default/> <context>server</context> <context>location</context> @@ -1168,8 +1171,8 @@ Sets a configuration based on a request URI. A location can either be defined by a prefix string, or by a regular expression. Regular expressions are specified by prepending them with the -“<value>~*</value>” prefix (for case-insensitive matching), or with the -“<value>~</value>” prefix (for case-sensitive matching). +“<literal>~*</literal>” prefix (for case-insensitive matching), or with the +“<literal>~</literal>” prefix (for case-sensitive matching). To find a location matching a given request, nginx first checks locations defined using the prefix strings (prefix locations). Among them, the most specific one is searched. @@ -1197,16 +1200,16 @@ </para> <para> -If the most specific prefix location has the “<value>^~</value>” prefix +If the most specific prefix location has the “<literal>^~</literal>” prefix then regular expressions are not checked. </para> <para> -Also, using the “<value>=</value>” prefix it is possible to define +Also, using the “<literal>=</literal>” prefix it is possible to define an exact match of URI and location. If an exact match is found, the search terminates. -For example, if a “<code>/</code>” request happens frequently, -defining “<code>location = /</code>” will speed up the processing +For example, if a “<literal>/</literal>” request happens frequently, +defining “<literal>location = /</literal>” will speed up the processing of these requests, as search terminates right after the first comparison. Such a location cannot obviously contain nested locations. @@ -1215,7 +1218,7 @@ <para> <note> In versions from 0.7.1 to 0.8.41, if a request matched the prefix -location without the “<value>=</value>” and “<value>^~</value>” +location without the “<literal>=</literal>” and “<literal>^~</literal>” prefixes, the search also terminated and regular expressions were not checked. </note> @@ -1240,15 +1243,15 @@ [ configuration D ] } </example> -The “<code>/</code>” request will match configuration A, -the “<code>/documents/document.html</code>” request will match +The “<literal>/</literal>” request will match configuration A, +the “<literal>/documents/document.html</literal>” request will match configuration B, -the “<code>/images/1.gif</code>” request will match configuration C, and -the “<code>/documents/1.jpg</code>” request will match configuration D. +the “<literal>/images/1.gif</literal>” request will match configuration C, and +the “<literal>/documents/1.jpg</literal>” request will match configuration D. </para> <para> -The “<value>@</value>” prefix defines a named location. +The “<literal>@</literal>” prefix defines a named location. Such a location is not used for a regular request processing, but instead used for request redirection. They cannot be nested, and cannot contain nested locations. @@ -1262,7 +1265,7 @@ <directive name="log_not_found"> -<syntax><value>on</value> | <value>off</value></syntax> +<syntax><literal>on</literal> | <literal>off</literal></syntax> <default>on</default> <context>http</context> <context>server</context> @@ -1277,7 +1280,7 @@ <directive name="log_subrequest"> -<syntax><value>on</value> | <value>off</value></syntax> +<syntax><literal>on</literal> | <literal>off</literal></syntax> <default>off</default> <context>http</context> <context>server</context> @@ -1292,7 +1295,7 @@ <directive name="max_ranges"> -<syntax><argument>number</argument></syntax> +<syntax><value>number</value></syntax> <default/> <context>http</context> <context>server</context> @@ -1310,7 +1313,7 @@ <directive name="merge_slashes"> -<syntax><value>on</value> | <value>off</value></syntax> +<syntax><literal>on</literal> | <literal>off</literal></syntax> <default>on</default> <context>http</context> <context>server</context> @@ -1323,19 +1326,19 @@ <para> Note that compression is essential for the correct prefix string and regular expressions location matching. -Without it, the “<code>//scripts/one.php</code>” request would not match +Without it, the “<literal>//scripts/one.php</literal>” request would not match <example> location /scripts/ { ... } </example> and might be processed as a static file, -so it gets converted to “<code>/scripts/one.php</code>”. +so it gets converted to “<literal>/scripts/one.php</literal>”. </para> <para> -Turning the compression <value>off</value> can become necessary if a URI -contains base64-encoded names, since base64 uses the “<code>/</code>” +Turning the compression <literal>off</literal> can become necessary if a URI +contains base64-encoded names, since base64 uses the “<literal>/</literal>” character internally. However, for security considerations, it is better to avoid turning off the compression. @@ -1352,7 +1355,7 @@ <directive name="msie_padding"> -<syntax><value>on</value> | <value>off</value></syntax> +<syntax><literal>on</literal> | <literal>off</literal></syntax> <default>on</default> <context>http</context> <context>server</context> @@ -1367,7 +1370,7 @@ <directive name="msie_refresh"> -<syntax><value>on</value> | <value>off</value></syntax> +<syntax><literal>on</literal> | <literal>off</literal></syntax> <default>off</default> <context>http</context> <context>server</context> @@ -1381,10 +1384,10 @@ <directive name="open_file_cache"> -<syntax><value>off</value></syntax> +<syntax><literal>off</literal></syntax> <syntax> -<parameter>max</parameter>=<argument>N</argument> -[<parameter>inactive</parameter>=<argument>time</argument>]</syntax> +<literal>max</literal>=<value>N</value> +[<literal>inactive</literal>=<value>time</value>]</syntax> <default>off</default> <context>http</context> <context>server</context> @@ -1420,7 +1423,7 @@ <list type="tag"> <tag-name> -<parameter>max</parameter> +<literal>max</literal> </tag-name> <tag-desc> sets the maximum number of elements in the cache; @@ -1428,7 +1431,7 @@ </tag-desc> <tag-name> -<parameter>inactive</parameter> +<literal>inactive</literal> </tag-name> <tag-desc> defines a time, after which an element gets removed from the cache @@ -1437,7 +1440,7 @@ </tag-desc> <tag-name> -<value>off</value> +<literal>off</literal> </tag-name> <tag-desc> disables the cache. @@ -1462,7 +1465,7 @@ <directive name="open_file_cache_errors"> -<syntax><value>on</value> | <value>off</value></syntax> +<syntax><literal>on</literal> | <literal>off</literal></syntax> <default>off</default> <context>http</context> <context>server</context> @@ -1479,7 +1482,7 @@ <!-- <directive name="open_file_cache_events"> -<syntax><value>on</value> | <value>off</value></syntax> +<syntax><literal>on</literal> | <literal>off</literal></syntax> <default>off</default> <context>http</context> <context>server</context> @@ -1504,15 +1507,15 @@ <directive name="open_file_cache_min_uses"> -<syntax><argument>number</argument></syntax> +<syntax><value>number</value></syntax> <default>1</default> <context>http</context> <context>server</context> <context>location</context> <para> -Sets the minimum <argument>number</argument> of file accesses during -the period configured by the <parameter>inactive</parameter> parameter +Sets the minimum <value>number</value> of file accesses during +the period configured by the <literal>inactive</literal> parameter of the <link id="open_file_cache"/> directive, after which a file descriptor will remain open in the cache. </para> @@ -1521,7 +1524,7 @@ <directive name="open_file_cache_valid"> -<syntax><argument>time</argument></syntax> +<syntax><value>time</value></syntax> <default>60s</default> <context>http</context> <context>server</context> @@ -1543,7 +1546,7 @@ <directive name="optimize_server_names"> -<syntax><value>on</value> | <value>off</value></syntax> +<syntax><literal>on</literal> | <literal>off</literal></syntax> <default>off</default> <context>http</context> <context>server</context> @@ -1571,7 +1574,7 @@ <directive name="port_in_redirect"> -<syntax><value>on</value> | <value>off</value></syntax> +<syntax><literal>on</literal> | <literal>off</literal></syntax> <default>on</default> <context>http</context> <context>server</context> @@ -1589,7 +1592,7 @@ <directive name="postpone_output"> -<syntax><argument>size</argument></syntax> +<syntax><value>size</value></syntax> <default>1460</default> <context>http</context> <context>server</context> @@ -1597,7 +1600,7 @@ <para> If possible, the output of client data will be postponed until -nginx has at least <argument>size</argument> bytes of data to send. +nginx has at least <value>size</value> bytes of data to send. Value of zero disables postponing. </para> @@ -1605,7 +1608,7 @@ <directive name="read_ahead"> -<syntax><argument>size</argument></syntax> +<syntax><value>size</value></syntax> <default>0</default> <context>http</context> <context>server</context> @@ -1617,13 +1620,14 @@ <para> On Linux, the -<code>posix_fadvise(0, 0, 0, POSIX_FADV_SEQUENTIAL)</code> -system call is used, so the <argument>size</argument> argument is ignored. +<literal>posix_fadvise(0, 0, 0, POSIX_FADV_SEQUENTIAL)</literal> +system call is used, so the <value>size</value> parameter is ignored. </para> <para> On FreeBSD, the -<code>fcntl(O_READAHEAD,</code><argument>size</argument><code>)</code> +<literal>fcntl(O_READAHEAD,</literal> +<value>size</value><literal>)</literal> system call is used, supported in FreeBSD 9.0-CURRENT. FreeBSD 7 needs to be <link url="http://sysoev.ru/freebsd/patch.readahead.txt">patched</link>. @@ -1633,7 +1637,7 @@ <directive name="recursive_error_pages"> -<syntax><value>on</value> | <value>off</value></syntax> +<syntax><literal>on</literal> | <literal>off</literal></syntax> <default>off</default> <context>http</context> <context>server</context> @@ -1649,7 +1653,7 @@ <directive name="request_pool_size"> -<syntax><argument>size</argument></syntax> +<syntax><value>size</value></syntax> <default>4k</default> <context>http</context> <context>server</context> @@ -1665,7 +1669,7 @@ <directive name="reset_timedout_connection"> <syntax> - <value>on</value> | <value>off</value></syntax> + <literal>on</literal> | <literal>off</literal></syntax> <default>off</default> <context>http</context> <context>server</context> @@ -1692,8 +1696,8 @@ <directive name="resolver"> <syntax> -<argument>address</argument> ... -[<parameter>valid</parameter>=<argument>time</argument>]</syntax> +<value>address</value> ... +[<literal>valid</literal>=<value>time</value>]</syntax> <default/> <context>http</context> <context>server</context> @@ -1705,7 +1709,7 @@ <example> resolver 127.0.0.1 192.0.2.1; </example> -An <argument>address</argument> argument may be specified as +An <value>address</value> parameter may be specified as either an IPv4 address or a hostname; in the latter case, the first resolved IPv4 address is used. Name servers are queried in a round-robin fashion. @@ -1713,7 +1717,7 @@ Before version 1.1.7, only a single name server could be configured. </note> By default, nginx caches answers using the TTL value of a response. -An optional <parameter>valid</parameter> parameter allows to override it: +An optional <literal>valid</literal> parameter allows to override it: <example> resolver 127.0.0.1 192.0.2.1 valid=30s; </example> @@ -1727,7 +1731,7 @@ <directive name="resolver_timeout"> -<syntax><argument>time</argument></syntax> +<syntax><value>time</value></syntax> <default>30s</default> <context>http</context> <context>server</context> @@ -1744,7 +1748,7 @@ <directive name="root"> -<syntax><argument>path</argument></syntax> +<syntax><value>path</value></syntax> <default>html</default> <context>http</context> <context>server</context> @@ -1759,19 +1763,19 @@ root /data/w3; } </example> -“<code>/i/top.gif</code>” will be responded +“<literal>/i/top.gif</literal>” will be responded with the file <path>/data/w3/i/top.gif</path>. </para> <para> -The <argument>path</argument> value can contain variables +The <value>path</value> value can contain variables except <var>$document_root</var> and <var>$realpath_root</var>. </para> <para> A path to the file is constructed by merely adding a URI to the value -of the <code>root</code> directive. +of the <literal>root</literal> directive. If a URI need to be modified, the <link id="alias"/> directive should be used. </para> @@ -1780,14 +1784,14 @@ <directive name="satisfy"> -<syntax><value>all</value> | <value>any</value></syntax> +<syntax><literal>all</literal> | <literal>any</literal></syntax> <default>all</default> <context>http</context> <context>server</context> <context>location</context> <para> -Allows access if <value>all</value> or <value>any</value> of the +Allows access if <literal>all</literal> or <literal>any</literal> of the <link doc="ngx_http_access_module.xml">ngx_http_access_module</link> or <link doc="ngx_http_auth_basic_module.xml">ngx_http_auth_basic_module</link> modules grant access. @@ -1812,7 +1816,7 @@ <directive name="satisfy_any"> -<syntax><value>on</value> | <value>off</value></syntax> +<syntax><literal>on</literal> | <literal>off</literal></syntax> <default>off</default> <context>http</context> <context>server</context> @@ -1827,7 +1831,7 @@ <directive name="send_lowat"> -<syntax><argument>size</argument></syntax> +<syntax><value>size</value></syntax> <default>0</default> <context>http</context> <context>server</context> @@ -1839,7 +1843,7 @@ <c-def>NOTE_LOWAT</c-def> flag of <link doc="../events.xml" id="kqueue"/>, or the <c-def>SO_SNDLOWAT</c-def> socket option, -with the specified <argument>size</argument>. +with the specified <value>size</value>. </para> <para> @@ -1850,7 +1854,7 @@ <directive name="send_timeout"> -<syntax><argument>time</argument></syntax> +<syntax><value>time</value></syntax> <default>60s</default> <context>http</context> <context>server</context> @@ -1869,7 +1873,7 @@ <directive name="sendfile"> -<syntax><value>on</value> | <value>off</value></syntax> +<syntax><literal>on</literal> | <literal>off</literal></syntax> <default>off</default> <context>http</context> <context>server</context> @@ -1886,7 +1890,7 @@ <directive name="sendfile_max_chunk"> -<syntax><argument>size</argument></syntax> +<syntax><value>size</value></syntax> <default>0</default> <context>http</context> <context>server</context> @@ -1923,7 +1927,7 @@ <directive name="server_name"> -<syntax><argument>name</argument> ...</syntax> +<syntax><value>name</value> ...</syntax> <default>""</default> <context>server</context> @@ -1938,7 +1942,7 @@ <para> The first name becomes the primary server name. -Server names can include an asterisk (“<code>*</code>”) +Server names can include an asterisk (“<literal>*</literal>”) to replace the first or last part of a name: <example> server { @@ -1957,13 +1961,13 @@ </para> <para> -If the argument equals “<var>$hostname</var>” (0.9.4), the +If the parameter equals “<var>$hostname</var>” (0.9.4), the machine's hostname is substituted. </para> <para> It is also possible to use regular expressions in server names, -prepending the name with a tilde (“<code>~</code>”): +prepending the name with a tilde (“<literal>~</literal>”): <example> server { server_name www.example.com ~^www\d+\.example\.com$; @@ -2039,11 +2043,11 @@ </listitem> <listitem> -names with the prefix mask, e.g. “<code>*.example.com</code>” +names with the prefix mask, e.g. “<literal>*.example.com</literal>” </listitem> <listitem> -names with the suffix mask, e.g. “<code>mail.*</code>” +names with the suffix mask, e.g. “<literal>mail.*</literal>” </listitem> <listitem> @@ -2057,7 +2061,7 @@ <directive name="server_name_in_redirect"> -<syntax><value>on</value> | <value>off</value></syntax> +<syntax><literal>on</literal> | <literal>off</literal></syntax> <default>off</default> <context>http</context> <context>server</context> @@ -2080,7 +2084,7 @@ <directive name="server_names_hash_bucket_size"> -<syntax><argument>size</argument></syntax> +<syntax><value>size</value></syntax> <default>32|64|128</default> <context>http</context> @@ -2095,12 +2099,12 @@ <directive name="server_names_hash_max_size"> -<syntax><argument>size</argument></syntax> +<syntax><value>size</value></syntax> <default>512</default> <context>http</context> <para> -Sets the maximum <argument>size</argument> of the server names hash tables. +Sets the maximum <value>size</value> of the server names hash tables. For more information, please refer to <link doc="../hash.xml">Setting Up Hashes</link>. </para> @@ -2109,7 +2113,7 @@ <directive name="server_tokens"> -<syntax><value>on</value> | <value>off</value></syntax> +<syntax><literal>on</literal> | <literal>off</literal></syntax> <default>on</default> <context>http</context> <context>server</context> @@ -2124,7 +2128,7 @@ <directive name="tcp_nodelay"> -<syntax><value>on</value> | <value>off</value></syntax> +<syntax><literal>on</literal> | <literal>off</literal></syntax> <default>on</default> <context>http</context> <context>server</context> @@ -2140,7 +2144,7 @@ <directive name="tcp_nopush"> -<syntax><value>on</value> | <value>off</value></syntax> +<syntax><literal>on</literal> | <literal>off</literal></syntax> <default>off</default> <context>http</context> <context>server</context> @@ -2171,11 +2175,11 @@ <directive name="try_files"> <syntax> - <argument>file</argument> ... - <argument>uri</argument></syntax> + <value>file</value> ... + <value>uri</value></syntax> <syntax> - <argument>file</argument> ... - =<argument>code</argument></syntax> + <value>file</value> ... + =<value>code</value></syntax> <default/> <context>server</context> <context>location</context> @@ -2185,13 +2189,13 @@ the first found file for request processing; the processing is performed in the current context. A path to the file is constructed from the -<argument>file</argument> argument +<value>file</value> parameter according to the <link id="root"/> and <link id="alias"/> directives. It is possible to check the directory existence by specifying -a slash at the end of a name, e.g. “<code>$uri/</code>”. +a slash at the end of a name, e.g. “<literal>$uri/</literal>”. If none of the files were found, an internal redirect to the -<argument>uri</argument> specified by the last argument is made. +<value>uri</value> specified by the last parameter is made. For example: <example> location /images/ { @@ -2202,10 +2206,10 @@ expires 30s; } </example> -The last argument can also point to a named location, +The last parameter can also point to a named location, see examples below. -As of version 0.7.51, the last argument can also be a -<argument>code</argument>: +As of version 0.7.51, the last parameter can also be a +<value>code</value>: <example> location / { try_files $uri $uri/index.html $uri.html =404; @@ -2263,7 +2267,7 @@ try_files $uri $uri/ @drupal; } </example> -the <code>try_files</code> directive is equivalent to +the <literal>try_files</literal> directive is equivalent to <example> location / { error_page 404 = @drupal; @@ -2282,7 +2286,7 @@ ... } </example> -<code>try_files</code> checks the existence of the PHP file +<literal>try_files</literal> checks the existence of the PHP file before passing the request to the FastCGI server. </para> @@ -2345,7 +2349,7 @@ <para> To make a particular location emit the -“<code>application/octet-stream</code>” +“<literal>application/octet-stream</literal>” MIME type for all requests, try the following: <example> location /download/ { @@ -2359,7 +2363,7 @@ <directive name="types_hash_bucket_size"> -<syntax><argument>size</argument></syntax> +<syntax><value>size</value></syntax> <default>32|64|128</default> <context>http</context> <context>server</context> @@ -2376,14 +2380,14 @@ <directive name="types_hash_max_size"> -<syntax><argument>size</argument></syntax> +<syntax><value>size</value></syntax> <default>1024</default> <context>http</context> <context>server</context> <context>location</context> <para> -Sets the maximum <argument>size</argument> of the types hash tables. +Sets the maximum <value>size</value> of the types hash tables. For more information, please refer to <link doc="../hash.xml">Setting Up Hashes</link>. </para> @@ -2392,7 +2396,7 @@ <directive name="underscores_in_headers"> -<syntax><value>on</value> | <value>off</value></syntax> +<syntax><literal>on</literal> | <literal>off</literal></syntax> <default>off</default> <context>http</context> <context>server</context> @@ -2408,7 +2412,7 @@ <directive name="variables_hash_bucket_size"> -<syntax><argument>size</argument></syntax> +<syntax><value>size</value></syntax> <default>64</default> <context>http</context> @@ -2422,12 +2426,12 @@ <directive name="variables_hash_max_size"> -<syntax><argument>size</argument></syntax> +<syntax><value>size</value></syntax> <default>512</default> <context>http</context> <para> -Sets the maximum <argument>size</argument> of the variables hash table. +Sets the maximum <value>size</value> of the variables hash table. For more information, please refer to <link doc="../hash.xml">Setting Up Hashes</link>. </para> @@ -2439,17 +2443,17 @@ <section id="variables" name="Embedded Variables"> <para> -The module <code>ngx_http_core_module</code> supports embedded variables with -names matching those of the Apache Server. +The module <literal>ngx_http_core_module</literal> supports embedded variables +with names matching those of the Apache Server. First of all, these are variables representing client request header fields, such as <var>$http_user_agent</var>, <var>$http_cookie</var>, and so on. It also supports other variables: <list type="tag"> -<tag-name><var>$arg_</var><argument>name</argument></tag-name> +<tag-name><var>$arg_</var><value>name</value></tag-name> <tag-desc> -argument <argument>name</argument> in the request line +argument <value>name</value> in the request line </tag-desc> <tag-name><var>$args</var></tag-name> @@ -2477,9 +2481,9 @@ <header>Content-Type</header> request header field </tag-desc> -<tag-name><var>$cookie_</var><argument>name</argument></tag-name> +<tag-name><var>$cookie_</var><value>name</value></tag-name> <tag-desc> -the <argument>name</argument> cookie +the <value>name</value> cookie </tag-desc> <tag-name><var>$document_root</var></tag-name> @@ -2503,21 +2507,21 @@ host name </tag-desc> -<tag-name><var>$http_</var><argument>name</argument></tag-name> +<tag-name><var>$http_</var><value>name</value></tag-name> <tag-desc> -the <argument>name</argument> request header field +the <value>name</value> request header field </tag-desc> <tag-name><var>$https</var></tag-name> <tag-desc> -“<code>on</code>” +“<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-desc> -“<code>?</code>” if a request line has arguments, +“<literal>?</literal>” if a request line has arguments, or an empty string otherwise </tag-desc> @@ -2602,7 +2606,7 @@ <tag-name><var>$request_completion</var></tag-name> <tag-desc> -“<code>OK</code>” if a request has completed, +“<literal>OK</literal>” if a request has completed, or an empty string otherwise </tag-desc> @@ -2616,7 +2620,7 @@ <tag-name><var>$request_method</var></tag-name> <tag-desc> request method, usually -“<code>GET</code>” or “<code>POST</code>” +“<literal>GET</literal>” or “<literal>POST</literal>” </tag-desc> <tag-name><var>$request_uri</var></tag-name> @@ -2626,12 +2630,12 @@ <tag-name><var>$scheme</var></tag-name> <tag-desc> -request scheme, “<code>http</code>” or “<code>https</code>” +request scheme, “<literal>http</literal>” or “<literal>https</literal>” </tag-desc> -<tag-name><var>$sent_http_</var><argument>name</argument></tag-name> +<tag-name><var>$sent_http_</var><value>name</value></tag-name> <tag-desc> -the <argument>name</argument> response header field +the <value>name</value> response header field </tag-desc> <tag-name><var>$server_addr</var></tag-name> @@ -2640,7 +2644,7 @@ <para> Computing a value of this variable usually requires one system call. To avoid a system call, the <link id="listen"/> directives -must specify addresses and use the <parameter>bind</parameter> parameter. +must specify addresses and use the <literal>bind</literal> parameter. </para> </tag-desc> @@ -2657,9 +2661,9 @@ <tag-name><var>$server_protocol</var></tag-name> <tag-desc> request protocol, usually -“<code>HTTP/1.0</code>” +“<literal>HTTP/1.0</literal>” or -“<code>HTTP/1.1</code>” +“<literal>HTTP/1.1</literal>” </tag-desc> <tag-name><var>$uri</var></tag-name>