Mercurial > hg > nginx-site
comparison xml/en/docs/http/ngx_http_core_module.xml @ 364:bb51d3e17dd0
Style fixed.
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Fri, 27 Jan 2012 10:39:12 +0000 |
parents | 4a0fe9283dc7 |
children | f1c0ae9c1c48 |
comparison
equal
deleted
inserted
replaced
363:c7fccbe03827 | 364:bb51d3e17dd0 |
---|---|
8 | 8 |
9 <section id="directives" name="Directives"> | 9 <section id="directives" name="Directives"> |
10 | 10 |
11 <directive name="aio"> | 11 <directive name="aio"> |
12 <syntax> | 12 <syntax> |
13 <literal>on</literal> | | 13 <literal>on</literal> | |
14 <literal>off</literal> | | 14 <literal>off</literal> | |
15 <literal>sendfile</literal></syntax> | 15 <literal>sendfile</literal></syntax> |
16 <default>off</default> | 16 <default>off</default> |
17 <context>http</context> | 17 <context>http</context> |
18 <context>server</context> | 18 <context>server</context> |
19 <context>location</context> | 19 <context>location</context> |
20 <appeared-in>0.8.11</appeared-in> | 20 <appeared-in>0.8.11</appeared-in> |
89 </example> | 89 </example> |
90 In this configuration, <c-func>sendfile</c-func> is called with | 90 In this configuration, <c-func>sendfile</c-func> is called with |
91 the <c-def>SF_NODISKIO</c-def> flag which causes it not to | 91 the <c-def>SF_NODISKIO</c-def> flag which causes it not to |
92 block on disk I/O and instead report back when the data are not in | 92 block on disk I/O and instead report back when the data are not in |
93 memory; nginx then initiates an asynchronous data load by reading | 93 memory; nginx then initiates an asynchronous data load by reading |
94 one byte. The FreeBSD kernel then loads the first 128K bytes | 94 one byte. |
95 The FreeBSD kernel then loads the first 128K bytes | |
95 of a file into memory, however next reads will only load data | 96 of a file into memory, however next reads will only load data |
96 in 16K chunks. This can be tuned using the | 97 in 16K chunks. |
98 This can be tuned using the | |
97 <link id="read_ahead"/> | 99 <link id="read_ahead"/> |
98 directive. | 100 directive. |
99 </para> | 101 </para> |
100 | 102 |
101 <para> | 103 <para> |
224 </directive> | 226 </directive> |
225 | 227 |
226 | 228 |
227 <directive name="client_body_in_file_only"> | 229 <directive name="client_body_in_file_only"> |
228 <syntax> | 230 <syntax> |
229 <literal>on</literal> | | 231 <literal>on</literal> | |
230 <literal>clean</literal> | | 232 <literal>clean</literal> | |
231 <literal>off</literal></syntax> | 233 <literal>off</literal></syntax> |
232 <default>off</default> | 234 <default>off</default> |
233 <context>http</context> | 235 <context>http</context> |
234 <context>server</context> | 236 <context>server</context> |
235 <context>location</context> | 237 <context>location</context> |
236 | 238 |
276 </directive> | 278 </directive> |
277 | 279 |
278 | 280 |
279 <directive name="client_body_temp_path"> | 281 <directive name="client_body_temp_path"> |
280 <syntax> | 282 <syntax> |
281 <value>path</value> | 283 <value>path</value> |
282 [<value>level1</value> | 284 [<value>level1</value> |
283 [<value>level2</value> | 285 [<value>level2</value> |
284 [<value>level3</value>]]]</syntax> | 286 [<value>level3</value>]]]</syntax> |
285 <default>client_body_temp</default> | 287 <default>client_body_temp</default> |
286 <context>http</context> | 288 <context>http</context> |
287 <context>server</context> | 289 <context>server</context> |
288 <context>location</context> | 290 <context>location</context> |
289 | 291 |
462 </directive> | 464 </directive> |
463 | 465 |
464 | 466 |
465 <directive name="error_page"> | 467 <directive name="error_page"> |
466 <syntax> | 468 <syntax> |
467 <value>code</value> ... | 469 <value>code</value> ... |
468 [<literal>=</literal>[<value>response</value>]] | 470 [<literal>=</literal>[<value>response</value>]] |
469 <value>uri</value></syntax> | 471 <value>uri</value></syntax> |
470 <default/> | 472 <default/> |
471 <context>http</context> | 473 <context>http</context> |
472 <context>server</context> | 474 <context>server</context> |
473 <context>location</context> | 475 <context>location</context> |
474 <context>if in location</context> | 476 <context>if in location</context> |
525 </directive> | 527 </directive> |
526 | 528 |
527 | 529 |
528 <directive name="if_modified_since"> | 530 <directive name="if_modified_since"> |
529 <syntax> | 531 <syntax> |
530 <literal>off</literal> | | 532 <literal>off</literal> | |
531 <literal>exact</literal> | | 533 <literal>exact</literal> | |
532 <literal>before</literal></syntax> | 534 <literal>before</literal></syntax> |
533 <default>exact</default> | 535 <default>exact</default> |
534 <context>http</context> | 536 <context>http</context> |
535 <context>server</context> | 537 <context>server</context> |
536 <context>location</context> | 538 <context>location</context> |
537 <appeared-in>0.7.24</appeared-in> | 539 <appeared-in>0.7.24</appeared-in> |
671 </directive> | 673 </directive> |
672 | 674 |
673 | 675 |
674 <directive name="keepalive_timeout"> | 676 <directive name="keepalive_timeout"> |
675 <syntax> | 677 <syntax> |
676 <value>timeout</value> | 678 <value>timeout</value> |
677 [<value>header_timeout</value>]</syntax> | 679 [<value>header_timeout</value>]</syntax> |
678 <default>75s</default> | 680 <default>75s</default> |
679 <context>http</context> | 681 <context>http</context> |
680 <context>server</context> | 682 <context>server</context> |
681 <context>location</context> | 683 <context>location</context> |
682 | 684 |
837 </directive> | 839 </directive> |
838 | 840 |
839 | 841 |
840 <directive name="lingering_close"> | 842 <directive name="lingering_close"> |
841 <syntax> | 843 <syntax> |
842 <literal>off</literal> | | 844 <literal>off</literal> | |
843 <literal>on</literal> | | 845 <literal>on</literal> | |
844 <literal>always</literal></syntax> | 846 <literal>always</literal></syntax> |
845 <default>on</default> | 847 <default>on</default> |
846 <context>http</context> | 848 <context>http</context> |
847 <context>server</context> | 849 <context>server</context> |
848 <context>location</context> | 850 <context>location</context> |
849 <appeared-in>1.1.0</appeared-in> | 851 <appeared-in>1.1.0</appeared-in> |
911 </directive> | 913 </directive> |
912 | 914 |
913 | 915 |
914 <directive name="listen"> | 916 <directive name="listen"> |
915 <syntax> | 917 <syntax> |
916 <value>address</value>[:<value>port</value>] | 918 <value>address</value>[:<value>port</value>] |
917 [<literal>default_server</literal>] | 919 [<literal>default_server</literal>] |
918 [<literal>setfib</literal>=<value>number</value>] | 920 [<literal>setfib</literal>=<value>number</value>] |
919 [<literal>backlog</literal>=<value>number</value>] | 921 [<literal>backlog</literal>=<value>number</value>] |
920 [<literal>rcvbuf</literal>=<value>size</value>] | 922 [<literal>rcvbuf</literal>=<value>size</value>] |
921 [<literal>sndbuf</literal>=<value>size</value>] | 923 [<literal>sndbuf</literal>=<value>size</value>] |
922 [<literal>accept_filter</literal>=<value>filter</value>] | 924 [<literal>accept_filter</literal>=<value>filter</value>] |
923 [<literal>deferred</literal>] | 925 [<literal>deferred</literal>] |
924 [<literal>bind</literal>] | 926 [<literal>bind</literal>] |
925 [<literal>ipv6only</literal>=<literal>on</literal>|<literal>off</literal>] | 927 [<literal>ipv6only</literal>=<literal>on</literal>|<literal>off</literal>] |
926 [<literal>ssl</literal>] | 928 [<literal>ssl</literal>] |
927 [<literal>so_keepalive</literal>=<literal>on</literal>|<literal>off</literal>|[<value>keepidle</value>]:[<value>keepintvl</value>]:[<value>keepcnt</value>]]</syntax> | 929 [<literal>so_keepalive</literal>=<literal>on</literal>|<literal>off</literal>|[<value>keepidle</value>]:[<value>keepintvl</value>]:[<value>keepcnt</value>]]</syntax> |
928 <syntax> | 930 <syntax> |
929 <value>port</value> | 931 <value>port</value> |
930 [<literal>default_server</literal>] | 932 [<literal>default_server</literal>] |
931 [<literal>setfib</literal>=<value>number</value>] | 933 [<literal>setfib</literal>=<value>number</value>] |
932 [<literal>backlog</literal>=<value>number</value>] | 934 [<literal>backlog</literal>=<value>number</value>] |
933 [<literal>rcvbuf</literal>=<value>size</value>] | 935 [<literal>rcvbuf</literal>=<value>size</value>] |
934 [<literal>sndbuf</literal>=<value>size</value>] | 936 [<literal>sndbuf</literal>=<value>size</value>] |
935 [<literal>accept_filter</literal>=<value>filter</value>] | 937 [<literal>accept_filter</literal>=<value>filter</value>] |
936 [<literal>deferred</literal>] | 938 [<literal>deferred</literal>] |
937 [<literal>bind</literal>] | 939 [<literal>bind</literal>] |
938 [<literal>ipv6only</literal>=<literal>on</literal>|<literal>off</literal>] | 940 [<literal>ipv6only</literal>=<literal>on</literal>|<literal>off</literal>] |
939 [<literal>ssl</literal>] | 941 [<literal>ssl</literal>] |
940 [<literal>so_keepalive</literal>=<literal>on</literal>|<literal>off</literal>|[<value>keepidle</value>]:[<value>keepintvl</value>]:[<value>keepcnt</value>]]</syntax> | 942 [<literal>so_keepalive</literal>=<literal>on</literal>|<literal>off</literal>|[<value>keepidle</value>]:[<value>keepintvl</value>]:[<value>keepcnt</value>]]</syntax> |
941 <syntax> | 943 <syntax> |
942 <literal>unix:</literal><value>path</value> | 944 <literal>unix:</literal><value>path</value> |
943 [<literal>default_server</literal>] | 945 [<literal>default_server</literal>] |
944 [<literal>backlog</literal>=<value>number</value>] | 946 [<literal>backlog</literal>=<value>number</value>] |
945 [<literal>rcvbuf</literal>=<value>size</value>] | 947 [<literal>rcvbuf</literal>=<value>size</value>] |
946 [<literal>sndbuf</literal>=<value>size</value>] | 948 [<literal>sndbuf</literal>=<value>size</value>] |
947 [<literal>accept_filter</literal>=<value>filter</value>] | 949 [<literal>accept_filter</literal>=<value>filter</value>] |
948 [<literal>deferred</literal>] | 950 [<literal>deferred</literal>] |
949 [<literal>bind</literal>] | 951 [<literal>bind</literal>] |
950 [<literal>ssl</literal>] | 952 [<literal>ssl</literal>] |
951 [<literal>so_keepalive</literal>=<literal>on</literal>|<literal>off</literal>|[<value>keepidle</value>]:[<value>keepintvl</value>]:[<value>keepcnt</value>]]</syntax> | 953 [<literal>so_keepalive</literal>=<literal>on</literal>|<literal>off</literal>|[<value>keepidle</value>]:[<value>keepintvl</value>]:[<value>keepcnt</value>]]</syntax> |
952 <default>*:80 | *:8000</default> | 954 <default>*:80 | *:8000</default> |
953 <context>server</context> | 955 <context>server</context> |
954 | 956 |
955 <para> | 957 <para> |
956 Sets an <value>address</value> and a <value>port</value> for IP, | 958 Sets an <value>address</value> and a <value>port</value> for IP, |
969 IPv6 addresses (0.7.36) are specified in square brackets: | 971 IPv6 addresses (0.7.36) are specified in square brackets: |
970 <example> | 972 <example> |
971 listen [::]:8000; | 973 listen [::]:8000; |
972 listen [fe80::1]; | 974 listen [fe80::1]; |
973 </example> | 975 </example> |
974 UNIX-domain sockets (0.8.21) are specified with the “<literal>unix:</literal>” prefix: | 976 UNIX-domain sockets (0.8.21) are specified with the “<literal>unix:</literal>” |
977 prefix: | |
975 <example> | 978 <example> |
976 listen unix:/var/run/nginx.sock; | 979 listen unix:/var/run/nginx.sock; |
977 </example> | 980 </example> |
978 </para> | 981 </para> |
979 | 982 |
1155 </directive> | 1158 </directive> |
1156 | 1159 |
1157 | 1160 |
1158 <directive name="location"> | 1161 <directive name="location"> |
1159 <syntax block="yes">[ | 1162 <syntax block="yes">[ |
1160 <literal>=</literal> | | 1163 <literal>=</literal> | |
1161 <literal>~</literal> | | 1164 <literal>~</literal> | |
1162 <literal>~*</literal> | | 1165 <literal>~*</literal> | |
1163 <literal>^~</literal> | 1166 <literal>^~</literal> |
1164 ] <value>uri</value></syntax> | 1167 ] <value>uri</value></syntax> |
1165 <syntax block="yes"><literal>@</literal><value>name</value></syntax> | 1168 <syntax block="yes"><literal>@</literal><value>name</value></syntax> |
1166 <default/> | 1169 <default/> |
1167 <context>server</context> | 1170 <context>server</context> |
1168 <context>location</context> | 1171 <context>location</context> |
1169 | 1172 |
1666 | 1669 |
1667 </directive> | 1670 </directive> |
1668 | 1671 |
1669 | 1672 |
1670 <directive name="reset_timedout_connection"> | 1673 <directive name="reset_timedout_connection"> |
1671 <syntax> | 1674 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
1672 <literal>on</literal> | <literal>off</literal></syntax> | |
1673 <default>off</default> | 1675 <default>off</default> |
1674 <context>http</context> | 1676 <context>http</context> |
1675 <context>server</context> | 1677 <context>server</context> |
1676 <context>location</context> | 1678 <context>location</context> |
1677 | 1679 |
2172 | 2174 |
2173 </directive> | 2175 </directive> |
2174 | 2176 |
2175 | 2177 |
2176 <directive name="try_files"> | 2178 <directive name="try_files"> |
2177 <syntax> | 2179 <syntax><value>file</value> ... <value>uri</value></syntax> |
2178 <value>file</value> ... | 2180 <syntax><value>file</value> ... =<value>code</value></syntax> |
2179 <value>uri</value></syntax> | |
2180 <syntax> | |
2181 <value>file</value> ... | |
2182 =<value>code</value></syntax> | |
2183 <default/> | 2181 <default/> |
2184 <context>server</context> | 2182 <context>server</context> |
2185 <context>location</context> | 2183 <context>location</context> |
2186 | 2184 |
2187 <para> | 2185 <para> |
2437 </para> | 2435 </para> |
2438 | 2436 |
2439 </directive> | 2437 </directive> |
2440 | 2438 |
2441 </section> | 2439 </section> |
2440 | |
2442 | 2441 |
2443 <section id="variables" name="Embedded Variables"> | 2442 <section id="variables" name="Embedded Variables"> |
2444 | 2443 |
2445 <para> | 2444 <para> |
2446 The module <literal>ngx_http_core_module</literal> supports embedded variables | 2445 The module <literal>ngx_http_core_module</literal> supports embedded variables |