nginx-site: xml/en/docs/http/ngx_http_core

comparison xml/en/docs/http/ngx_http_core_module.xml @ 102:c76a257f3fd4

The directive name is now automatically printed in <default> and <syntax>. Specifying <default> is made non-optional. Visible changes: - "types" and "proxy_set_header" get proper defaults (not yet displayed nicely); - "fastcgi_hide_header", "fastcgi_ignore_headers", "fastcgi_pass_header", "proxy_hide_header", "proxy_ignore_headers", and "proxy_pass_header" now have their (empty) defaults documented; - mentions of "fastcgi_redirect_errors" and "proxy_redirect_errors" which are long unsupported were removed.

author	Ruslan Ermilov <ru@nginx.com>
date	Wed, 19 Oct 2011 05:15:24 +0000
parents	a10bc0cb0a6a
children	56457a474903

comparison

equal deleted inserted replaced

-:b8fd014ec712
+:c76a257f3fd4
 lang="en">
 <section id="directives" name="Directives">
 <directive name="aio" appeared-in="0.8.11">
-<syntax>aio
+<syntax>
 <value>on</value> |
 <value>off</value> |
 <value>sendfile</value>
 </syntax>
-<default>aio off</default>
+<default>off</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="alias">
-<syntax>alias <argument>path</argument></syntax>
+<syntax><argument>path</argument></syntax>
 <default/>
 <context>location</context>
 <para>
 Defines a replacement for the specified location.
 </directive>
 <directive name="client_body_buffer_size">
-<syntax>client_body_buffer_size <argument>size</argument></syntax>
+<syntax><argument>size</argument></syntax>
-<default>client_body_buffer_size 8k|16k</default>
+<default>8k|16k</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="client_body_in_file_only">
-<syntax>client_body_in_file_only
+<syntax>
 <value>on</value> |
 <value>clean</value> |
 <value>off</value>
 </syntax>
-<default>client_body_in_file_only off</default>
+<default>off</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="client_body_in_single_buffer">
-<syntax>client_body_in_single_buffer <value>on</value> | <value>off</value>
+<syntax><value>on</value> | <value>off</value>
 </syntax>
-<default>client_body_in_single_buffer off</default>
+<default>off</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="client_body_temp_path">
-<syntax>client_body_temp_path
+<syntax>
 <argument>path</argument>
 [<argument>level1</argument>
 [<argument>level2</argument>
 [<argument>level3</argument>]]]
 </syntax>
-<default>client_body_temp_path client_body_temp</default>
+<default>client_body_temp</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="client_body_timeout">
-<syntax>client_body_timeout <argument>time</argument></syntax>
+<syntax><argument>time</argument></syntax>
-<default>client_body_timeout 60s</default>
+<default>60s</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="client_header_buffer_size">
-<syntax>client_header_buffer_size <argument>size</argument></syntax>
+<syntax><argument>size</argument></syntax>
-<default>client_header_buffer_size 1k</default>
+<default>1k</default>
 <context>http</context>
 <context>server</context>
 <para>
 Sets buffer size for reading client request header.
 </directive>
 <directive name="client_header_timeout">
-<syntax>client_header_timeout <argument>time</argument></syntax>
+<syntax><argument>time</argument></syntax>
-<default>client_header_timeout 60s</default>
+<default>60s</default>
 <context>http</context>
 <context>server</context>
 <para>
 Defines a timeout for reading client request header.
 </directive>
 <directive name="client_max_body_size">
-<syntax>client_max_body_size <argument>size</argument></syntax>
+<syntax><argument>size</argument></syntax>
-<default>client_max_body_size 1m</default>
+<default>1m</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="default_type">
-<syntax>default_type <argument>mime-type</argument></syntax>
+<syntax><argument>mime-type</argument></syntax>
-<default>default_type text/plain</default>
+<default>text/plain</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="directio" appeared-in="0.7.7">
-<syntax>directio <argument>size</argument> | <value>off</value></syntax>
+<syntax><argument>size</argument> | <value>off</value></syntax>
-<default>directio off</default>
+<default>off</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="directio_alignment" appeared-in="0.8.11">
-<syntax>directio_alignment <argument>size</argument></syntax>
+<syntax><argument>size</argument></syntax>
-<default>directio_alignment 512</default>
+<default>512</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="error_page">
-<syntax>error_page
+<syntax>
 <argument>code</argument> ...
 [<value>=</value>[<argument>response</argument>]]
 <argument>uri</argument>
 </syntax>
 <default/>
 </directive>
 <directive name="if_modified_since" appeared-in="0.7.24">
-<syntax>if_modified_since
+<syntax>
 <value>off</value> |
 <value>exact</value> |
 <value>before</value>
 </syntax>
-<default>if_modified_since exact</default>
+<default>exact</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="internal">
-<syntax>internal</syntax>
+<syntax/>
 <default/>
 <context>location</context>
 <para>
 Specifies that a given location can only be used for internal requests.
 </directive>
 <directive name="keepalive_requests" appeared-in="0.8.0">
-<syntax>keepalive_requests <argument>number</argument></syntax>
+<syntax><argument>number</argument></syntax>
-<default>keepalive_requests 100</default>
+<default>100</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="keepalive_timeout">
-<syntax>keepalive_timeout
+<syntax>
 <argument>timeout</argument>
 [<argument>header_timeout</argument>]
 </syntax>
-<default>keepalive_timeout 75s</default>
+<default>75s</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="large_client_header_buffers">
-<syntax>large_client_header_buffers <argument>number size</argument></syntax>
+<syntax><argument>number size</argument></syntax>
-<default>large_client_header_buffers 4 8k</default>
+<default>4 8k</default>
 <context>http</context>
 <context>server</context>
 <para>
 Sets the maximum <argument>number</argument> and <argument>size</argument> of
 </directive>
 <directive name="limit_except">
-<syntax>limit_except <argument>method</argument> ... { ... }</syntax>
+<syntax><argument>method</argument> ... { ... }</syntax>
 <default/>
 <context>location</context>
 <para>
 Limits allowed HTTP methods inside a location.
 </directive>
 <directive name="limit_rate">
-<syntax>limit_rate <argument>rate</argument></syntax>
+<syntax><argument>rate</argument></syntax>
-<default>limit_rate 0</default>
+<default>0</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <context>if in location</context>
 </directive>
 <directive name="limit_rate_after" appeared-in="0.8.0">
-<syntax>limit_rate_after <argument>size</argument></syntax>
+<syntax><argument>size</argument></syntax>
-<default>limit_rate_after 0</default>
+<default>0</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <context>if in location</context>
 </directive>
 <directive name="listen">
-<syntax>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>deferred</parameter>]
 [<parameter>bind</parameter>]
 [<parameter>ipv6only</parameter>=<value>on</value>|<value>off</value>]
 [<parameter>ssl</parameter>]
 </syntax>
-<syntax>listen
+<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>deferred</parameter>]
 [<parameter>bind</parameter>]
 [<parameter>ipv6only</parameter>=<value>on</value>|<value>off</value>]
 [<parameter>ssl</parameter>]
 </syntax>
-<syntax>listen
+<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>]
 </syntax>
-<default>listen *:80 | *:8000</default>
+<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
 </directive>
 <directive name="location">
-<syntax>location [
+<syntax>[
 <value>=</value> |
 <value>~</value> |
 <value>~*</value> |
 <value>^~</value>
 ] <argument>uri</argument>
 { ... }</syntax>
-<syntax>location <value>@</value><argument>name</argument> { ... }</syntax>
+<syntax><value>@</value><argument>name</argument> { ... }</syntax>
 <default/>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="log_not_found">
-<syntax>log_not_found <value>on</value> | <value>off</value></syntax>
+<syntax><value>on</value> | <value>off</value></syntax>
-<default>log_not_found on</default>
+<default>on</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="log_subrequest">
-<syntax>log_subrequest <value>on</value> | <value>off</value></syntax>
+<syntax><value>on</value> | <value>off</value></syntax>
-<default>log_subrequest off</default>
+<default>off</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="merge_slashes">
-<syntax>merge_slashes <value>on</value> | <value>off</value></syntax>
+<syntax><value>on</value> | <value>off</value></syntax>
-<default>merge_slashes on</default>
+<default>on</default>
 <context>http</context>
 <context>server</context>
 <para>
 Enables or disables compression of two or more adjacent slashes
 </directive>
 <directive name="msie_padding">
-<syntax>msie_padding <value>on</value> | <value>off</value></syntax>
+<syntax><value>on</value> | <value>off</value></syntax>
-<default>msie_padding on</default>
+<default>on</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="msie_refresh">
-<syntax>msie_refresh <value>on</value> | <value>off</value></syntax>
+<syntax><value>on</value> | <value>off</value></syntax>
-<default>msie_refresh off</default>
+<default>off</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="open_file_cache">
-<syntax>open_file_cache <value>off</value></syntax>
+<syntax><value>off</value></syntax>
-<syntax>open_file_cache
+<syntax>
 <parameter>max</parameter>=<argument>N</argument>
 [<parameter>inactive</parameter>=<argument>time</argument>]
 </syntax>
-<default>open_file_cache off</default>
+<default>off</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="open_file_cache_errors">
-<syntax>open_file_cache_errors <value>on</value> | <value>off</value></syntax>
+<syntax><value>on</value> | <value>off</value></syntax>
-<default>open_file_cache_errors off</default>
+<default>off</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 <!--
 <directive name="open_file_cache_events">
-<syntax>open_file_cache_events <value>on</value> | <value>off</value></syntax>
+<syntax><value>on</value> | <value>off</value></syntax>
-<default>open_file_cache_events off</default>
+<default>off</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 -->
 <directive name="open_file_cache_min_uses">
-<syntax>open_file_cache_min_uses <argument>number</argument></syntax>
+<syntax><argument>number</argument></syntax>
-<default>open_file_cache_min_uses 1</default>
+<default>1</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="open_file_cache_valid">
-<syntax>open_file_cache_valid <argument>time</argument></syntax>
+<syntax><argument>time</argument></syntax>
-<default>open_file_cache_valid 60s</default>
+<default>60s</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="optimize_server_names">
-<syntax>optimize_server_names <value>on</value> | <value>off</value></syntax>
+<syntax><value>on</value> | <value>off</value></syntax>
-<default>optimize_server_names off</default>
+<default>off</default>
 <context>http</context>
 <context>server</context>
 <para>
 This directive is made obsolete by the
 </directive>
 <directive name="port_in_redirect">
-<syntax>port_in_redirect <value>on</value> | <value>off</value></syntax>
+<syntax><value>on</value> | <value>off</value></syntax>
-<default>port_in_redirect on</default>
+<default>on</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="read_ahead">
-<syntax>read_ahead <argument>size</argument></syntax>
+<syntax><argument>size</argument></syntax>
-<default>read_ahead 0</default>
+<default>0</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="recursive_error_pages">
-<syntax>recursive_error_pages <value>on</value> | <value>off</value></syntax>
+<syntax><value>on</value> | <value>off</value></syntax>
-<default>recursive_error_pages off</default>
+<default>off</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="reset_timedout_connection">
-<syntax>reset_timedout_connection
+<syntax>
 <value>on</value> | <value>off</value></syntax>
-<default>reset_timedout_connection off</default>
+<default>off</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="resolver">
-<syntax>resolver <argument>address</argument></syntax>
+<syntax><argument>address</argument></syntax>
 <default/>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 </directive>
 <directive name="resolver_timeout">
-<syntax>resolver_timeout <argument>time</argument></syntax>
+<syntax><argument>time</argument></syntax>
-<default>resolver_timeout 30s</default>
+<default>30s</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="root">
-<syntax>root <argument>path</argument></syntax>
+<syntax><argument>path</argument></syntax>
-<default>root html</default>
+<default>html</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <context>if in location</context>
 </directive>
 <directive name="satisfy">
-<syntax>satisfy <value>all</value> | <value>any</value></syntax>
+<syntax><value>all</value> | <value>any</value></syntax>
-<default>satisfy all</default>
+<default>all</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="satisfy_any">
-<syntax>satisfy_any <value>on</value> | <value>off</value></syntax>
+<syntax><value>on</value> | <value>off</value></syntax>
-<default>satisfy_any off</default>
+<default>off</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="send_timeout">
-<syntax>send_timeout <argument>time</argument></syntax>
+<syntax><argument>time</argument></syntax>
-<default>send_timeout 60s</default>
+<default>60s</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="sendfile">
-<syntax>sendfile <value>on</value> | <value>off</value></syntax>
+<syntax><value>on</value> | <value>off</value></syntax>
-<default>sendfile off</default>
+<default>off</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <context>if in location</context>
 </directive>
 <directive name="server">
-<syntax>server { ... }</syntax>
+<syntax>{ ... }</syntax>
 <default/>
 <context>http</context>
 <para>
 Sets a configuration for the virtual server.
 </directive>
 <directive name="server_name">
-<syntax>server_name <argument>name</argument> ...</syntax>
+<syntax><argument>name</argument> ...</syntax>
-<default>server_name ""</default>
+<default>""</default>
 <context>server</context>
 <para>
 Sets names of the virtual server, for example:
 <example>
 </directive>
 <directive name="server_name_in_redirect">
-<syntax>server_name_in_redirect <value>on</value> | <value>off</value></syntax>
+<syntax><value>on</value> | <value>off</value></syntax>
-<default>server_name_in_redirect off</default>
+<default>off</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="server_names_hash_bucket_size">
-<syntax>server_names_hash_bucket_size <argument>size</argument></syntax>
+<syntax><argument>size</argument></syntax>
-<default>server_names_hash_bucket_size 32|64|128</default>
+<default>32|64|128</default>
 <context>http</context>
 <para>
 Sets the bucket size for the server names hash tables.
 Default value depends on the size of the processor's cache line.
 </directive>
 <directive name="server_names_hash_max_size">
-<syntax>server_names_hash_max_size <argument>size</argument></syntax>
+<syntax><argument>size</argument></syntax>
-<default>server_names_hash_max_size 512</default>
+<default>512</default>
 <context>http</context>
 <para>
 Sets the maximum <argument>size</argument> of the server names hash tables.
 For more information, please refer to
 </directive>
 <directive name="server_tokens">
-<syntax>server_tokens <value>on</value> | <value>off</value></syntax>
+<syntax><value>on</value> | <value>off</value></syntax>
-<default>server_tokens on</default>
+<default>on</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="tcp_nodelay">
-<syntax>tcp_nodelay <value>on</value> | <value>off</value></syntax>
+<syntax><value>on</value> | <value>off</value></syntax>
-<default>tcp_nodelay on</default>
+<default>on</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="tcp_nopush">
-<syntax>tcp_nopush <value>on</value> | <value>off</value></syntax>
+<syntax><value>on</value> | <value>off</value></syntax>
-<default>tcp_nopush off</default>
+<default>off</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="try_files">
-<syntax>try_files
+<syntax>
 <argument>file</argument> ...
 <argument>uri</argument>
 </syntax>
-<syntax>try_files
+<syntax>
 <argument>file</argument> ...
 =<argument>code</argument>
 </syntax>
 <default/>
 <context>server</context>
 </directive>
 <directive name="types">
-<syntax>types { ... }</syntax>
+<syntax>{ ... }</syntax>
-<default>see below</default>
+<default>
-<context>http</context>
+{
-<context>server</context>
-<context>location</context>
-<para>
-Maps file name extensions to MIME types of responses.
-Several extensions can map to one type.
-The following mappings are configured by default:
-<example>
-types {
 text/html  html;
 image/gif  gif;
 image/jpeg jpg;
 }
-</example>
+</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<para>
+Maps file name extensions to MIME types of responses.
+Several extensions can map to one type.
 </para>
 <para>
 A sufficiently full mapping table is distributed with nginx in the
 <pathname>conf/mime.types</pathname> file.
 </directive>
 <directive name="types_hash_bucket_size">
-<syntax>types_hash_bucket_size <argument>size</argument></syntax>
+<syntax><argument>size</argument></syntax>
-<default>types_hash_bucket_size 32|64|128</default>
+<default>32|64|128</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="types_hash_max_size">
-<syntax>types_hash_max_size <argument>size</argument></syntax>
+<syntax><argument>size</argument></syntax>
-<default>types_hash_max_size 1024</default>
+<default>1024</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
 <para>
 </directive>
 <directive name="underscores_in_headers">
-<syntax>underscores_in_headers <value>on</value> | <value>off</value></syntax>
+<syntax><value>on</value> | <value>off</value></syntax>
-<default>underscores_in_headers off</default>
+<default>off</default>
 <context>http</context>
 <context>server</context>
 <para>
 Enables or disables the use of underscores in client request header fields.
 </directive>
 <directive name="variables_hash_bucket_size">
-<syntax>variables_hash_bucket_size <argument>size</argument></syntax>
+<syntax><argument>size</argument></syntax>
-<default>variables_hash_bucket_size 64</default>
+<default>64</default>
 <context>http</context>
 <para>
 Sets the bucket size for the variables hash table.
 For more information, please refer to
 </directive>
 <directive name="variables_hash_max_size">
-<syntax>variables_hash_max_size <argument>size</argument></syntax>
+<syntax><argument>size</argument></syntax>
-<default>variables_hash_max_size 512</default>
+<default>512</default>
 <context>http</context>
 <para>
 Sets the maximum <argument>size</argument> of the variables hash table.
 For more information, please refer to

Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_core_module.xml @ 102:c76a257f3fd4