Mercurial > hg > nginx-site

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_core_module.xml
+++ b/xml/en/docs/http/ngx_http_core_module.xml
@@ -9,12 +9,12 @@
 <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>
@@ -132,7 +132,7 @@ is used.
 
 
 <directive name="alias">
-<syntax>alias <argument>path</argument></syntax>
+<syntax><argument>path</argument></syntax>
 <default/>
 <context>location</context>
 
@@ -189,8 +189,8 @@ location /images/ {
 
 <directive name="client_body_buffer_size">
 
-<syntax>client_body_buffer_size <argument>size</argument></syntax>
-<default>client_body_buffer_size 8k|16k</default>
+<syntax><argument>size</argument></syntax>
+<default>8k|16k</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -209,12 +209,12 @@ It is usually 16K on other 64-bit platfo
 
 
 <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>
@@ -244,9 +244,9 @@ left after request processing to be remo
 
 
 <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>
@@ -263,13 +263,13 @@ variable, to save the number of copy ope
 
 
 <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>
@@ -292,8 +292,8 @@ a temporary file might look like this:
 
 
 <directive name="client_body_timeout">
-<syntax>client_body_timeout <argument>time</argument></syntax>
-<default>client_body_timeout 60s</default>
+<syntax><argument>time</argument></syntax>
+<default>60s</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -312,8 +312,8 @@ is returned.
 
 
 <directive name="client_header_buffer_size">
-<syntax>client_header_buffer_size <argument>size</argument></syntax>
-<default>client_header_buffer_size 1k</default>
+<syntax><argument>size</argument></syntax>
+<default>1k</default>
 <context>http</context>
 <context>server</context>
 
@@ -332,8 +332,8 @@ directive.
 
 
 <directive name="client_header_timeout">
-<syntax>client_header_timeout <argument>time</argument></syntax>
-<default>client_header_timeout 60s</default>
+<syntax><argument>time</argument></syntax>
+<default>60s</default>
 <context>http</context>
 <context>server</context>
 
@@ -349,8 +349,8 @@ is returned.
 
 
 <directive name="client_max_body_size">
-<syntax>client_max_body_size <argument>size</argument></syntax>
-<default>client_max_body_size 1m</default>
+<syntax><argument>size</argument></syntax>
+<default>1m</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -374,8 +374,8 @@ request body size checking.
 
 
 <directive name="default_type">
-<syntax>default_type <argument>mime-type</argument></syntax>
-<default>default_type text/plain</default>
+<syntax><argument>mime-type</argument></syntax>
+<default>text/plain</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -389,8 +389,8 @@ See also the <link id="types">types</lin
 
 
 <directive name="directio" appeared-in="0.7.7">
-<syntax>directio <argument>size</argument> | <value>off</value></syntax>
-<default>directio off</default>
+<syntax><argument>size</argument> | <value>off</value></syntax>
+<default>off</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -415,8 +415,8 @@ or when using <link id="aio">aio</link> 
 
 
 <directive name="directio_alignment" appeared-in="0.8.11">
-<syntax>directio_alignment <argument>size</argument></syntax>
-<default>directio_alignment 512</default>
+<syntax><argument>size</argument></syntax>
+<default>512</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -432,7 +432,7 @@ using XFS under Linux, it needs to be in
 
 
 <directive name="error_page">
-<syntax>error_page
+<syntax>
         <argument>code</argument> ...
         [<value>=</value>[<argument>response</argument>]]
         <argument>uri</argument>
@@ -496,12 +496,12 @@ location @fallback {
 
 
 <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>
@@ -539,7 +539,7 @@ request header.
 
 
 <directive name="internal">
-<syntax>internal</syntax>
+<syntax/>
 <default/>
 <context>location</context>
 
@@ -588,8 +588,8 @@ location /404.html {
 
 
 <directive name="keepalive_requests" appeared-in="0.8.0">
-<syntax>keepalive_requests <argument>number</argument></syntax>
-<default>keepalive_requests 100</default>
+<syntax><argument>number</argument></syntax>
+<default>100</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -604,11 +604,11 @@ After this many requests are made, the c
 
 
 <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>
@@ -633,8 +633,8 @@ MSIE will close keep-alive connection in
 
 
 <directive name="large_client_header_buffers">
-<syntax>large_client_header_buffers <argument>number size</argument></syntax>
-<default>large_client_header_buffers 4 8k</default>
+<syntax><argument>number size</argument></syntax>
+<default>4 8k</default>
 <context>http</context>
 <context>server</context>
 
@@ -658,7 +658,7 @@ into the keep-alive state, these buffers
 
 
 <directive name="limit_except">
-<syntax>limit_except <argument>method</argument> ... { ... }</syntax>
+<syntax><argument>method</argument> ... { ... }</syntax>
 <default/>
 <context>location</context>
 
@@ -701,8 +701,8 @@ Please note that this will limit access 
 
 
 <directive name="limit_rate">
-<syntax>limit_rate <argument>rate</argument></syntax>
-<default>limit_rate 0</default>
+<syntax><argument>rate</argument></syntax>
+<default>0</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -743,8 +743,8 @@ server {
 
 
 <directive name="limit_rate_after" appeared-in="0.8.0">
-<syntax>limit_rate_after <argument>size</argument></syntax>
-<default>limit_rate_after 0</default>
+<syntax><argument>size</argument></syntax>
+<default>0</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -770,7 +770,7 @@ location /flv/ {
 
 
 <directive name="listen">
-<syntax>listen
+<syntax>
         <argument>address</argument>[:<argument>port</argument>]
         [<parameter>default_server</parameter>]
         [<parameter>setfib</parameter>=<argument>number</argument>]
@@ -783,7 +783,7 @@ location /flv/ {
         [<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>]
@@ -796,7 +796,7 @@ location /flv/ {
         [<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>]
@@ -807,7 +807,7 @@ location /flv/ {
         [<parameter>bind</parameter>]
         [<parameter>ssl</parameter>]
 </syntax>
-<default>listen *:80 | *:8000</default>
+<default>*:80 | *:8000</default>
 <context>server</context>
 
 <para>
@@ -986,14 +986,14 @@ listen 127.0.0.1 default accept_filter=d
 
 
 <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>
@@ -1096,8 +1096,8 @@ They cannot be nested, and cannot contai
 
 
 <directive name="log_not_found">
-<syntax>log_not_found <value>on</value> | <value>off</value></syntax>
-<default>log_not_found on</default>
+<syntax><value>on</value> | <value>off</value></syntax>
+<default>on</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -1111,8 +1111,8 @@ Enables or disables logging of errors ab
 
 
 <directive name="log_subrequest">
-<syntax>log_subrequest <value>on</value> | <value>off</value></syntax>
-<default>log_subrequest off</default>
+<syntax><value>on</value> | <value>off</value></syntax>
+<default>off</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -1126,8 +1126,8 @@ Enables or disables logging of subreques
 
 
 <directive name="merge_slashes">
-<syntax>merge_slashes <value>on</value> | <value>off</value></syntax>
-<default>merge_slashes on</default>
+<syntax><value>on</value> | <value>off</value></syntax>
+<default>on</default>
 <context>http</context>
 <context>server</context>
 
@@ -1167,8 +1167,8 @@ all virtual servers listening on the sam
 
 
 <directive name="msie_padding">
-<syntax>msie_padding <value>on</value> | <value>off</value></syntax>
-<default>msie_padding on</default>
+<syntax><value>on</value> | <value>off</value></syntax>
+<default>on</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -1182,8 +1182,8 @@ greater than 400 for MSIE clients, to pa
 
 
 <directive name="msie_refresh">
-<syntax>msie_refresh <value>on</value> | <value>off</value></syntax>
-<default>msie_refresh off</default>
+<syntax><value>on</value> | <value>off</value></syntax>
+<default>off</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -1196,12 +1196,12 @@ Enables or disables issuing refreshes in
 
 
 <directive name="open_file_cache">
-<syntax>open_file_cache <value>off</value></syntax>
-<syntax>open_file_cache
+<syntax><value>off</value></syntax>
+<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>
@@ -1277,8 +1277,8 @@ open_file_cache_events   on;
 
 
 <directive name="open_file_cache_errors">
-<syntax>open_file_cache_errors <value>on</value> | <value>off</value></syntax>
-<default>open_file_cache_errors off</default>
+<syntax><value>on</value> | <value>off</value></syntax>
+<default>off</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -1294,8 +1294,8 @@ Enables or disables caching of file look
 <!--
 
 <directive name="open_file_cache_events">
-<syntax>open_file_cache_events <value>on</value> | <value>off</value></syntax>
-<default>open_file_cache_events off</default>
+<syntax><value>on</value> | <value>off</value></syntax>
+<default>off</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -1319,8 +1319,8 @@ file systems such as UFS or FFS.
 
 
 <directive name="open_file_cache_min_uses">
-<syntax>open_file_cache_min_uses <argument>number</argument></syntax>
-<default>open_file_cache_min_uses 1</default>
+<syntax><argument>number</argument></syntax>
+<default>1</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -1336,8 +1336,8 @@ after which a file descriptor will remai
 
 
 <directive name="open_file_cache_valid">
-<syntax>open_file_cache_valid <argument>time</argument></syntax>
-<default>open_file_cache_valid 60s</default>
+<syntax><argument>time</argument></syntax>
+<default>60s</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -1358,8 +1358,8 @@ are checked only once, and then updated 
 
 
 <directive name="optimize_server_names">
-<syntax>optimize_server_names <value>on</value> | <value>off</value></syntax>
-<default>optimize_server_names off</default>
+<syntax><value>on</value> | <value>off</value></syntax>
+<default>off</default>
 <context>http</context>
 <context>server</context>
 
@@ -1386,8 +1386,8 @@ optimization needs to be disabled.
 
 
 <directive name="port_in_redirect">
-<syntax>port_in_redirect <value>on</value> | <value>off</value></syntax>
-<default>port_in_redirect on</default>
+<syntax><value>on</value> | <value>off</value></syntax>
+<default>on</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -1400,8 +1400,8 @@ Enables or disables specifying the port 
 
 
 <directive name="read_ahead">
-<syntax>read_ahead <argument>size</argument></syntax>
-<default>read_ahead 0</default>
+<syntax><argument>size</argument></syntax>
+<default>0</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -1428,8 +1428,8 @@ FreeBSD&nbsp;7 needs to be
 
 
 <directive name="recursive_error_pages">
-<syntax>recursive_error_pages <value>on</value> | <value>off</value></syntax>
-<default>recursive_error_pages off</default>
+<syntax><value>on</value> | <value>off</value></syntax>
+<default>off</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -1444,9 +1444,9 @@ 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>
@@ -1471,7 +1471,7 @@ closed normally.
 
 
 <directive name="resolver">
-<syntax>resolver <argument>address</argument></syntax>
+<syntax><argument>address</argument></syntax>
 <default/>
 <context>http</context>
 <context>server</context>
@@ -1490,8 +1490,8 @@ the first resolved address is used.
 
 
 <directive name="resolver_timeout">
-<syntax>resolver_timeout <argument>time</argument></syntax>
-<default>resolver_timeout 30s</default>
+<syntax><argument>time</argument></syntax>
+<default>30s</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -1507,8 +1507,8 @@ resolver_timeout 5s;
 
 
 <directive name="root">
-<syntax>root <argument>path</argument></syntax>
-<default>root html</default>
+<syntax><argument>path</argument></syntax>
+<default>html</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -1543,8 +1543,8 @@ If a URI need to be modified, the
 
 
 <directive name="satisfy">
-<syntax>satisfy <value>all</value> | <value>any</value></syntax>
-<default>satisfy all</default>
+<syntax><value>all</value> | <value>any</value></syntax>
+<default>all</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -1571,8 +1571,8 @@ location / {
 
 
 <directive name="satisfy_any">
-<syntax>satisfy_any <value>on</value> | <value>off</value></syntax>
-<default>satisfy_any off</default>
+<syntax><value>on</value> | <value>off</value></syntax>
+<default>off</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -1586,8 +1586,8 @@ directive.
 
 
 <directive name="send_timeout">
-<syntax>send_timeout <argument>time</argument></syntax>
-<default>send_timeout 60s</default>
+<syntax><argument>time</argument></syntax>
+<default>60s</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -1605,8 +1605,8 @@ a connection is closed.
 
 <directive name="sendfile">
 
-<syntax>sendfile <value>on</value> | <value>off</value></syntax>
-<default>sendfile off</default>
+<syntax><value>on</value> | <value>off</value></syntax>
+<default>off</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -1621,7 +1621,7 @@ Enables or disables the use of
 
 
 <directive name="server">
-<syntax>server { ... }</syntax>
+<syntax>{ ... }</syntax>
 <default/>
 <context>http</context>
 
@@ -1642,8 +1642,8 @@ Setting Up Virtual Servers</link> docume
 
 
 <directive name="server_name">
-<syntax>server_name <argument>name</argument> ...</syntax>
-<default>server_name ""</default>
+<syntax><argument>name</argument> ...</syntax>
+<default>""</default>
 <context>server</context>
 
 <para>
@@ -1776,8 +1776,8 @@ regular expressions
 
 
 <directive name="server_name_in_redirect">
-<syntax>server_name_in_redirect <value>on</value> | <value>off</value></syntax>
-<default>server_name_in_redirect off</default>
+<syntax><value>on</value> | <value>off</value></syntax>
+<default>off</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -1795,8 +1795,8 @@ If this field is not present, an IP addr
 
 
 <directive name="server_names_hash_bucket_size">
-<syntax>server_names_hash_bucket_size <argument>size</argument></syntax>
-<default>server_names_hash_bucket_size 32|64|128</default>
+<syntax><argument>size</argument></syntax>
+<default>32|64|128</default>
 <context>http</context>
 
 <para>
@@ -1810,8 +1810,8 @@ For more information, please refer to
 
 
 <directive name="server_names_hash_max_size">
-<syntax>server_names_hash_max_size <argument>size</argument></syntax>
-<default>server_names_hash_max_size 512</default>
+<syntax><argument>size</argument></syntax>
+<default>512</default>
 <context>http</context>
 
 <para>
@@ -1824,8 +1824,8 @@ For more information, please refer to
 
 
 <directive name="server_tokens">
-<syntax>server_tokens <value>on</value> | <value>off</value></syntax>
-<default>server_tokens on</default>
+<syntax><value>on</value> | <value>off</value></syntax>
+<default>on</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -1839,8 +1839,8 @@ Enables or disables emitting of nginx ve
 
 
 <directive name="tcp_nodelay">
-<syntax>tcp_nodelay <value>on</value> | <value>off</value></syntax>
-<default>tcp_nodelay on</default>
+<syntax><value>on</value> | <value>off</value></syntax>
+<default>on</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -1855,8 +1855,8 @@ keep-alive state.
 
 
 <directive name="tcp_nopush">
-<syntax>tcp_nopush <value>on</value> | <value>off</value></syntax>
-<default>tcp_nopush off</default>
+<syntax><value>on</value> | <value>off</value></syntax>
+<default>off</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -1885,11 +1885,11 @@ send a file in full packets.
 
 
 <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>
@@ -2016,8 +2016,14 @@ location @wordpress {
 
 
 <directive name="types">
-<syntax>types { ... }</syntax>
-<default>see below</default>
+<syntax>{ ... }</syntax>
+<default>
+{
+    text/html  html;
+    image/gif  gif;
+    image/jpeg jpg;
+}
+</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -2025,14 +2031,6 @@ location @wordpress {
 <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>
 </para>
 
 <para>
@@ -2056,8 +2054,8 @@ location /download/ {
 
 
 <directive name="types_hash_bucket_size">
-<syntax>types_hash_bucket_size <argument>size</argument></syntax>
-<default>types_hash_bucket_size 32|64|128</default>
+<syntax><argument>size</argument></syntax>
+<default>32|64|128</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -2073,8 +2071,8 @@ For more information, please refer to
 
 
 <directive name="types_hash_max_size">
-<syntax>types_hash_max_size <argument>size</argument></syntax>
-<default>types_hash_max_size 1024</default>
+<syntax><argument>size</argument></syntax>
+<default>1024</default>
 <context>http</context>
 <context>server</context>
 <context>location</context>
@@ -2089,8 +2087,8 @@ For more information, please refer to
 
 
 <directive name="underscores_in_headers">
-<syntax>underscores_in_headers <value>on</value> | <value>off</value></syntax>
-<default>underscores_in_headers off</default>
+<syntax><value>on</value> | <value>off</value></syntax>
+<default>off</default>
 <context>http</context>
 <context>server</context>
 
@@ -2102,8 +2100,8 @@ Enables or disables the use of underscor
 
 
 <directive name="variables_hash_bucket_size">
-<syntax>variables_hash_bucket_size <argument>size</argument></syntax>
-<default>variables_hash_bucket_size 64</default>
+<syntax><argument>size</argument></syntax>
+<default>64</default>
 <context>http</context>
 
 <para>
@@ -2116,8 +2114,8 @@ For more information, please refer to
 
 
 <directive name="variables_hash_max_size">
-<syntax>variables_hash_max_size <argument>size</argument></syntax>
-<default>variables_hash_max_size 512</default>
+<syntax><argument>size</argument></syntax>
+<default>512</default>
 <context>http</context>
 
 <para>