diff --git a/docs/xml/http/ngx_http_core_module.xml b/docs/xml/http/ngx_http_core_module.xml
index 8e193dcb8..c1f73ca87 100644
--- a/docs/xml/http/ngx_http_core_module.xml
+++ b/docs/xml/http/ngx_http_core_module.xml
@@ -23,7 +23,7 @@ on FreeBSD and Linux.
-On FreeBSD, AIO is usable used starting from FreeBSD 4.3.
+On FreeBSD, AIO is usable starting from FreeBSD 4.3.
AIO can either be linked statically into a kernel:
options VFS_AIO
@@ -38,14 +38,14 @@ kldload aio
In FreeBSD versions 5 and 6, enabling AIO statically, or dynamically
when booting the kernel, will cause the entire networking subsystem
to use the Giant lock that can impact overall performance negatively.
-This limitation has been removed in FreeBSD 6.4-STABLE in 2009, and in
-FreeBSD 7.
-However, starting from FreeBSD 5.3, it's possible to enable AIO
+This limitation has been removed in FreeBSD 6.4-STABLE in 2009, and in
+FreeBSD 7.
+However, starting from FreeBSD 5.3 it is possible to enable AIO
without the penalty of running the networking subsystem under a
Giant lock—for this to work, the AIO module needs to be loaded
after the kernel has booted.
In this case, the following message will appear in
-/var/log/messages
+/var/log/messages
WARNING: Network stack Giant-free, but aio requires Giant.
Consider adding 'options NET_WITH_GIANT' or setting debug.mpsafenet=0
@@ -67,22 +67,22 @@ For AIO to work,
sendfile
needs to be disabled:
-location /video/ {
- sendfile off;
- aio on;
- output_buffers 1 64k;
+location /video/ {
+ sendfile off;
+ aio on;
+ output_buffers 1 64k;
}
-In addition, starting from FreeBSD 5.2.1 and nginx 0.8.12, AIO can
+In addition, starting from FreeBSD 5.2.1 and nginx 0.8.12, AIO can
also be used to pre-load data for sendfile:
-location /video/ {
- sendfile on;
- tcp_nopush on;
- aio sendfile;
+location /video/ {
+ sendfile on;
+ tcp_nopush on;
+ aio sendfile;
}
In this configuration, sendfile is called with
@@ -102,10 +102,10 @@ plus, it is also necessary to enable
directio,
otherwise reading will be blocking:
-location /video/ {
- aio on;
- directio 512;
- output_buffers 1 128k;
+location /video/ {
+ aio on;
+ directio 512;
+ output_buffers 1 128k;
}
@@ -115,7 +115,7 @@ On Linux,
directio
can only be used for reading blocks that are aligned on 512-byte
boundaries (or 4K for XFS).
-Reading of unaligned file's tail is still made in blocking mode.
+Reading of unaligned file's end is still made in blocking mode.
The same holds true for byte range requests, and for FLV requests
not from the beginning of a file: reading of unaligned data at the
beginning and end of a file will be blocking.
@@ -138,12 +138,14 @@ is used.
Defines a replacement for the specified location.
For example, with the following configuration
-location /i/ {
- alias /data/w3/images/;
+location /i/ {
+ alias /data/w3/images/;
}
-the request of "/i/top.gif" will be responded
-with the file "/data/w3/images/top.gif".
+the request of
+/i/top.gif will be responded
+with the file
+/data/w3/images/top.gif.
@@ -157,7 +159,7 @@ contain captures and alias should refer to
these captures (0.7.40), for example:
location ~ ^/users/(.+\.(?:gif|jpe?g|png))$ {
- alias /data/w3/images/$1;
+ alias /data/w3/images/$1;
}
@@ -165,16 +167,16 @@ location ~ ^/users/(.+\.(?:gif|jpe?g|png))$ {
When location matches the last part of the directive's value:
-location /images/ {
- alias /data/w3/images/;
+location /images/ {
+ alias /data/w3/images/;
}
-it's better to use the
+it is better to use the
root
directive instead:
-location /images/ {
- root /data/w3;
+location /images/ {
+ root /data/w3;
}
@@ -205,12 +207,12 @@ method of the
-When set to the value on, temporary files are not
+When set to the value on, temporary files are not
removed after request processing.
-The value clean will cause the temporary files
+The value clean will cause the temporary files
left after request processing to be removed.
@@ -275,7 +277,7 @@ Up to three-level subdirectory hierarchy can be used underneath the specified
directory.
For example, in the following configuration
-client_body_temp_path /spool/nginx/client_temp 1 2;
+client_body_temp_path /spool/nginx/client_temp 1 2;
a temporary file might look like this:
@@ -317,7 +319,7 @@ Sets buffer size for reading client request header.
For most requests, a buffer of 1K bytes is enough.
However, if a request includes long cookies, or comes from a WAP client,
it may not fit into 1K.
-If a request line, or a request header line do not fit entirely into
+If a request line, or a request header field do not fit entirely into
this buffer then larger buffers are allocated, configured by the
large_client_header_buffers
directive.
@@ -354,7 +356,7 @@ is returned.
Sets the maximum allowed size of the client request body,
specified in the
Content-Length
-request header line.
+request header field.
If size is greater than the configured value, the
error is returned to a client.
@@ -398,7 +400,7 @@ It automatically disables (0.7.15) the use of
for a given request.
It could be useful for serving large files:
-directio 4m;
+directio 4m;
or when using aio on Linux.
@@ -425,7 +427,7 @@ using XFS under Linux, it needs to be increased to 4K.
error_page
- code ...
+ code ...
[=[response]]
uri
@@ -438,33 +440,35 @@ using XFS under Linux, it needs to be increased to 4K.
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 error_page directives on
+only if there are no
+error_page
+directives on
the current level.
A URI value can contain variables.
-Example usage:
+Example:
-error_page 404 /404.html;
-error_page 502 503 504 /50x.html;
-error_page 403 http://example.com/forbidden.html;
+error_page 404 /404.html;
+error_page 502 503 504 /50x.html;
+error_page 403 http://example.com/forbidden.html;
Furthermore, it is possible to change the response code to another, for example:
-error_page 404 =200 /empty.gif;
+error_page 404 =200 /empty.gif;
-If an error response is processed by a proxied server, or a FastCGI-server,
+If an error response is processed by a proxied server, or a FastCGI server,
and the server may return different response codes (e.g., 200, 302, 401
or 404), it is possible to respond with a returned code:
-error_page 404 = /404.php;
+error_page 404 = /404.php;
@@ -473,11 +477,11 @@ If there is no need to change URI during redirection it is possible to redirect
error processing into a named location:
location / {
- error_page 404 = @fallback;
+ error_page 404 = @fallback;
}
location @fallback {
- proxy_pass http://backend;
+ proxy_pass http://backend;
}
@@ -502,22 +506,25 @@ with the time in the
If-Modified-Since
request header:
-
+
-
-off—the
+off
+
+the
If-Modified-Since request header is ignored (0.7.34);
-
+
-
-exact—exact match;
-
+exact
+
+exact match;
+
-
-before—modification time of a response is
+before
+
+modification time of a response is
less than or equal to the time in the If-Modified-Since
request header.
-
+
@@ -560,11 +567,11 @@ directive of the
-Example usage:
+Example:
-error_page 404 /404.html;
+error_page 404 /404.html;
-location /404.html {
+location /404.html {
internal;
}
@@ -602,14 +609,14 @@ made through one keep-alive connection.
The first argument 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
-"Keep-Alive: timeout=time"
+Keep-Alive: timeout=time
response header.
Two arguments may differ.
The
-"Keep-Alive: timeout="
+Keep-Alive: timeout=
is understood by Mozilla and Konqueror.
MSIE will close keep-alive connection in about 60 seconds.
@@ -629,7 +636,7 @@ buffers used when reading large client request headers.
A request line cannot exceed the size of one buffer, or the
error is returned.
-A request header line cannot exceed the size of one buffer as well, or the
+A request header field cannot exceed the size of one buffer as well, or the
error is returned.
Buffers are allocated only on demand.
@@ -656,9 +663,9 @@ and
http_auth_basic
modules directives:
-limit_except GET {
- allow 192.168.1.0/32;
- deny all;
+limit_except GET {
+ allow 192.168.1.0/32;
+ deny all;
}
Please note that this will limit access to all methods
@@ -698,7 +705,7 @@ variable:
server {
if ($slow) {
- set $limit_rate 4k;
+ set $limit_rate 4k;
}
...
@@ -727,8 +734,8 @@ Example:
location /flv/ {
flv;
- limit_rate_after 500k;
- limit_rate 50k;
+ limit_rate_after 500k;
+ limit_rate 50k;
}
@@ -771,16 +778,16 @@ Only one of address or port can be
specified.
An address may also be a hostname, for example:
-listen 127.0.0.1:8000;
-listen 127.0.0.1;
-listen 8000;
-listen *:8000;
-listen localhost:8000;
+listen 127.0.0.1:8000;
+listen 127.0.0.1;
+listen 8000;
+listen *:8000;
+listen localhost:8000;
IPv6 addresses (0.7.36) are specified in square brackets:
-listen [::]:8000;
-listen [fe80::1];
+listen [::]:8000;
+listen [fe80::1];
@@ -813,50 +820,62 @@ parameter can have several additional parameters specific to system calls
Starting from version 0.8.21, these parameters can be specified in any
listen directive, but only once for the given
address:port pair.
-
+
-
-backlog=number—
+
+backlog=number
+
+
sets the backlog parameter in the
listen call.
By default, backlog equals -1 on FreeBSD
and 511 on other platforms.
-
+
-
-rcvbuf=size—
+
+rcvbuf=size
+
+
sets the SO_RCVBUF parameter for the listening socket.
-
+
-
-sndbuf=size—
+
+sndbuf=size
+
+
sets the SO_SNDBUF parameter for the listening socket.
-
+
-
-accept_filter=filter—
+
+accept_filter=filter
+
+
sets the name of the accept filter.
This works only on FreeBSD, acceptable values are dataready
and httpready.
-On receiving SIGHUP signal, an accept filter can only be
+On receipt of the SIGHUP signal, an accept filter can only be
changed in recent versions of FreeBSD, starting from 6.0, 5.4-STABLE
and 4.11-STABLE.
-
+
-
-deferred—
+
+deferred
+
+
instructs to use a deferred accept on Linux
using the TCP_DEFER_ACCEPT option.
-
+
-
-bind—
+
+bind
+
+
specifies to make a separate bind call for a given
address:port pair.
This is because nginx will only bind to
*:port
if there are several listen directives with
-the same port and different addresses, and one of the
+the same port but different addresses, and one of the
listen directives listens on all addresses
for the given port (*:port).
It should be noted that in this case a getsockname
@@ -867,17 +886,21 @@ If parameters backlog, rcvbuf,
deferred are used then for a given
address:port pair
a separate bind call will always be made.
-
+
-
-ipv6only=on|off—
+
+ipv6only=on|off
+
+
this parameter (0.7.42) sets the value of the IPV6_V6ONLY
parameter for the listening socket.
This parameter can only be set once on start.
-
+
-
-ssl—
+
+ssl
+
+
this parameter (0.7.14) does not relate to system calls
listen and bind, but allows to
specify that all connections accepted on this port should work in
@@ -885,10 +908,10 @@ the SSL mode.
This allows for a more compact configuration for the server operating
in both HTTP and HTTPS modes simultaneously.
-listen 80;
-listen 443 default ssl;
+listen 80;
+listen 443 default ssl;
-
+
@@ -896,7 +919,7 @@ listen 443 default ssl;
Example:
-listen 127.0.0.1 default accept_filter=dataready backlog=1024;
+listen 127.0.0.1 default accept_filter=dataready backlog=1024;
@@ -922,8 +945,8 @@ listen 127.0.0.1 default accept_filter=dataready backlog=1024;
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
-"~*" prefix (for case-insensitive matching), or with the
-"~" prefix (for case-sensitive matching).
+~* prefix (for case-insensitive matching), or with the
+~ prefix (for case-sensitive matching).
To find a location matching a given request, nginx first checks
locations defined using the prefix strings (prefix locations).
Amongst them, the most specific one is searched.
@@ -947,35 +970,35 @@ be used in other directives.
-If the most specific prefix location has the "^~" prefix
+If the most specific prefix location has the ^~ prefix
then regular expressions are not checked.
-Also, using the "=" prefix it's possible to define
+Also, using the = 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 "/" request happens frequently,
-defining "location = /" will speed up the processing
+For example, if a / request happens frequently,
+defining location = / will speed up the processing
of these requests, as search terminates right after the first
comparison.
In versions from 0.7.1 to 0.8.41, if a request matched the prefix
-location without the "=" and "^~"
+location without the = and ^~
prefixes, the search also terminated and regular expressions were
not checked.
-Let's illustrate the above by an example:
+Let's illustrate the above by example:
-location = / {
+location = / {
[ configuration A ]
}
-location / {
+location / {
[ configuration B ]
}
@@ -987,15 +1010,16 @@ location ~* \.(gif|jpg|jpeg)$ {
[ configuration D ]
}
-The "/" request will match configuration A,
-the "/documents/document.html" request—configuration B,
-the "/images/1.gif" request—configuration C, and
-the "/documents/1.jpg" request—configuration D.
+The / request will match configuration A,
+the /documents/document.html request will match
+configuration B,
+the /images/1.gif request will match configuration C, and
+the /documents/1.jpg request will match configuration D.
-The "@" prefix defines a named location.
-Such a location isn't used for a regular request processing, but instead
+The @ prefix defines a named location.
+Such a location is not used for a regular request processing, but instead
used for request redirection.
@@ -1050,20 +1074,20 @@ in a URI into a single slash.
Note that compression is essential for the correct prefix string
and regular expressions location matching.
-Without it, the "//scripts/one.php" request would not match
+Without it, the //scripts/one.php request would not match
location /scripts/ {
...
}
and might be processed as a static file,
-so it gets converted to "/scripts/one.php".
+so it gets converted to /scripts/one.php.
Turning the compression off can become necessary if a URI
contains base64-encoded names, since base64 uses the "/" character internally.
-However, for security considerations, it's better to avoid turning off
+However, for security considerations, it is better to avoid turning off
the compression.
@@ -1142,24 +1166,31 @@ directive.
The directive has the following parameters:
-
+
-
-max—
+
+max
+
+
sets the maximum number of elements in the cache;
on cache overflow the least recently used (LRU) elements get removed;
-
+
-
-inactive—
+
+inactive
+
+
defines a time, after which the element gets removed from the cache
if there were no accesses to it during this time;
by default, it is 60 seconds;
-
+
-
-off—disables the cache.
-
+
+off
+
+
+disables the cache.
+
@@ -1167,10 +1198,13 @@ by default, it is 60 seconds;
Example:
-open_file_cache max=1000 inactive=20s;
+open_file_cache max=1000 inactive=20s;
open_file_cache_valid 30s;
open_file_cache_min_uses 2;
-open_file_cache_errors on;
+open_file_cache_errors on;
+
@@ -1298,7 +1332,7 @@ Enables or disables specifying the port in redirects issued by nginx.
read_ahead size
-read_ahead 0
+read_ahead 0httpserverlocation
@@ -1316,7 +1350,7 @@ system call is used, so the size argument is ignored.
On FreeBSD, the
fcntl(O_READAHEAD,size)
-system call is used, supported in FreeBSD 9.0-CURRENT.
+system call is used, supported in FreeBSD 9.0-CURRENT.
FreeBSD 7 needs to be
patched.
@@ -1341,7 +1375,8 @@ directive.
-reset_timedout_connection on | off
+reset_timedout_connection
+ on | offreset_timedout_connection offhttpserver
@@ -1376,7 +1411,7 @@ closed normally.
Sets the address of a name server, for example:
-resolver 127.0.0.1;
+resolver 127.0.0.1;
@@ -1393,7 +1428,7 @@ resolver 127.0.0.1;
Sets a timeout for name resolution, for example:
-resolver_timeout 5s;
+resolver_timeout 5s;
@@ -1412,12 +1447,13 @@ resolver_timeout 5s;
Sets the root directory for requests.
For example, with the following configuration
-location /i/ {
- root /data/w3;
+location /i/ {
+ root /data/w3;
}
-the request of "/i/top.gif" will be responded
-with the file "/data/w3/images/top.gif".
+/i/top.gif will be responded
+with the file
+/data/w3/i/top.gif.
@@ -1446,13 +1482,13 @@ or http_auth_basic
modules grant access.
location / {
- satisfy any;
+ satisfy any;
- allow 192.168.1.0/32;
- deny all;
+ allow 192.168.1.0/32;
+ deny all;
- auth_basic "closed site";
- auth_basic_user_file conf/htpasswd;
+ auth_basic "closed site";
+ auth_basic_user_file conf/htpasswd;
}
@@ -1514,7 +1550,7 @@ Enables or disables the use of
Sets a configuration for the virtual server.
There is no clean separation between IP-based (based on the IP address)
-and name-based (based on the Host header string)
+and name-based (based on the Host request header field)
virtual servers.
Instead, the listen directives describe all
addresses and ports that should accept connections for a server, and the
@@ -1528,7 +1564,7 @@ Setting Up Virtual Servers document.
-server_name name ...
+server_name name ...server_name hostnameserver
@@ -1536,7 +1572,7 @@ Setting Up Virtual Servers document.
Sets names of the virtual server, for example:
server {
- server_name example.com www.example.com;
+ server_name example.com www.example.com;
}
@@ -1544,11 +1580,11 @@ server {
The first name becomes a primary server name.
By default, the machine's hostname is used.
-Server names can include an asterisk ("*")
+Server names can include an asterisk (*)
to replace the first or last part of a name:
server {
- server_name example.com *.example.com www.example.*;
+ server_name example.com *.example.com www.example.*;
}
@@ -1557,17 +1593,17 @@ server {
The first two of the above mentioned names can be combined:
server {
- server_name .example.com;
+ server_name .example.com;
}
It is also possible to use regular expressions in server names,
-prepending the name with a tilde ("~"):
+prepending the name with a tilde (~):
server {
- server_name www.example.com ~^www\d+\.example\.com$;
+ server_name www.example.com ~^www\d+\.example\.com$;
}
@@ -1577,18 +1613,18 @@ Regular expressions can contain captures (0.7.40) that can later
be used in other directives:
server {
- server_name ~^(www\.)?(.+)$;
+ server_name ~^(www\.)?(.+)$;
location / {
- root /sites/$2;
+ root /sites/$2;
}
}
server {
- server_name _;
+ server_name _;
location / {
- root /sites/default;
+ root /sites/default;
}
}
@@ -1599,28 +1635,28 @@ Starting from version 0.8.25, named captures in regular expressions create
variables that can later be used in other directives:
server {
- server_name ~^(www\.)?(?<domain>.+)$;
+ server_name ~^(www\.)?(?<domain>.+)$;
location / {
- root /sites/$domain;
+ root /sites/$domain;
}
}
server {
- server_name _;
+ server_name _;
location / {
- root /sites/default;
+ root /sites/default;
}
}
-Starting from version 0.7.11, it is possible to specify an empty name "":
+Starting from version 0.7.11, it is possible to specify an empty name:
server {
- server_name www.example.com "";
+ server_name www.example.com "";
}
It allows this server to process requests without the Host
@@ -1636,11 +1672,11 @@ full names
-names with the prefix mask—*.example.com
+names with the prefix mask, e.g. *.example.com
-names with the suffix mask—mail.*
+names with the suffix mask, e.g. mail.*
@@ -1664,9 +1700,9 @@ regular expressions
Enables or disables the use of the primary server name, specified by the
server_name
directive, in redirects issued by nginx.
-When disabled, the name from the Host request header string
+When disabled, the name from the Host request header field
is used.
-If there's no such a string, an IP address of the server is used.
+If this field is not present, an IP address of the server is used.
@@ -1710,7 +1746,7 @@ For more information, please refer to
Enables or disables emitting of nginx version in error messages and in the
-Server response header string.
+Server response header field.
@@ -1763,8 +1799,14 @@ send a file in full packets.
-try_files file ... uri
-try_files file ... =code
+try_files
+ file ...
+ uri
+
+try_files
+ file ...
+ =code
+location
@@ -1773,14 +1815,14 @@ Checks the existence of files in the specified order, and uses
the first found file for request processing; the processing
is performed in this location's context.
It is possible to check the directory existence by specifying
-the slash at the end of a name, e.g. "$uri/".
+the slash at the end of a name, e.g. $uri/.
If none of the files were found, an internal redirect to the
uri specified by the last argument is made.
As of version 0.7.51, the last argument can also be a
code:
location / {
- try_files $uri $uri/index.html $uri.html =404;
+ try_files $uri $uri/index.html $uri.html =404;
}
@@ -1789,13 +1831,13 @@ location / {
Example when proxying Mongrel:
location / {
- try_files /system/maintenance.html
- $uri $uri/index.html $uri.html
- @mongrel;
+ try_files /system/maintenance.html
+ $uri $uri/index.html $uri.html
+ @mongrel;
}
location @mongrel {
- proxy_pass http://mongrel;
+ proxy_pass http://mongrel;
}
@@ -1804,27 +1846,27 @@ location @mongrel {
Example for Drupal/FastCGI:
location / {
- try_files $uri $uri/ @drupal;
+ try_files $uri $uri/ @drupal;
}
location ~ \.php$ {
- try_files $uri @drupal;
+ try_files $uri @drupal;
- fastcgi_pass ...;
+ fastcgi_pass ...;
- fastcgi_param SCRIPT_FILENAME /path/to$fastcgi_script_name;
- fastcgi_param SCRIPT_NAME $fastcgi_script_name;
- fastcgi_param QUERY_STRING $args;
+ fastcgi_param SCRIPT_FILENAME /path/to$fastcgi_script_name;
+ fastcgi_param SCRIPT_NAME $fastcgi_script_name;
+ fastcgi_param QUERY_STRING $args;
... other fastcgi_param's
}
location @drupal {
- fastcgi_pass ...;
+ fastcgi_pass ...;
- fastcgi_param SCRIPT_FILENAME /path/to/index.php;
- fastcgi_param SCRIPT_NAME /index.php;
- fastcgi_param QUERY_STRING q=$uri&$args;
+ fastcgi_param SCRIPT_FILENAME /path/to/index.php;
+ fastcgi_param SCRIPT_NAME /index.php;
+ fastcgi_param QUERY_STRING q=$uri&$args;
... other fastcgi_param's
}
@@ -1832,24 +1874,24 @@ location @drupal {
In the following example,
location / {
- try_files $uri $uri/ @drupal;
+ try_files $uri $uri/ @drupal;
}
the try_files directive is equivalent to
location / {
- error_page 404 = @drupal;
- log_not_found off;
+ error_page 404 = @drupal;
+ log_not_found off;
}
And here,
location ~ \.php$ {
- try_files $uri @drupal;
+ try_files $uri @drupal;
- fastcgi_pass ...;
+ fastcgi_pass ...;
- fastcgi_param SCRIPT_FILENAME /path/to$fastcgi_script_name;
+ fastcgi_param SCRIPT_FILENAME /path/to$fastcgi_script_name;
...
}
@@ -1862,22 +1904,22 @@ before passing the request to the FastCGI server.
Example for Wordpress and Joomla:
location / {
- try_files $uri $uri/ @wordpress;
+ try_files $uri $uri/ @wordpress;
}
location ~ \.php$ {
- try_files $uri @wordpress;
+ try_files $uri @wordpress;
- fastcgi_pass ...;
+ fastcgi_pass ...;
- fastcgi_param SCRIPT_FILENAME /path/to$fastcgi_script_name;
+ fastcgi_param SCRIPT_FILENAME /path/to$fastcgi_script_name;
... other fastcgi_param's
}
location @wordpress {
- fastcgi_pass ...;
+ fastcgi_pass ...;
- fastcgi_param SCRIPT_FILENAME /path/to/index.php;
+ fastcgi_param SCRIPT_FILENAME /path/to/index.php;
... other fastcgi_param's
}
@@ -1899,25 +1941,26 @@ Several extensions can map to one type.
The following mappings are configured by default:
types {
- text/html html;
- image/gif gif;
- image/jpeg jpg;
+ text/html html;
+ image/gif gif;
+ image/jpeg jpg;
}
A sufficiently full mapping table is distributed with nginx in the
-conf/mime.types file.
+conf/mime.types file.
-To make a particular location emit the "application/octet-stream"
+To make a particular location emit the
+application/octet-stream
MIME type for all requests, try the following:
location /download/ {
- types { }
- default_type application/octet-stream;
+ types { }
+ default_type application/octet-stream;
}
@@ -1932,11 +1975,218 @@ location /download/ {
server
-Enables or disables the use of underscores in client request header strings.
+Enables or disables the use of underscores in client request header fields.
+
+
+
+The http_core module supports embedded variables with names matching
+those of the Apache Server.
+First of all, these are variables representing client request header
+fields, such as, $http_user_agent, $http_cookie,
+and so on.
+It also supports other variables:
+
+
+$args
+
+arguments in the request line
+
+
+$arg_name
+
+argument name in the request line
+
+
+$binary_remote_addr
+
+client address in a binary form, value's length is always 4 bytes
+
+
+$content_length
+
+Content-Length request header field
+
+
+$content_type
+
+Content-Type request header field
+
+
+$cookie_name
+
+the name cookie
+
+
+$document_root
+
+root directive's value for the current request
+
+
+$document_uri
+
+same as $uri
+
+
+$host
+
+Host request header field,
+or the server name matching a request if this field is not present
+
+
+$hostname
+
+host name
+
+
+$http_name
+
+the name request header field
+
+
+$is_args
+
+? if a request line has arguments,
+or an empty string otherwise
+
+
+$limit_rate
+
+allows for connection rate limiting
+
+
+$pid
+
+PID of the worker process
+
+
+$request_method
+
+request method, usually
+GET or POST
+
+
+$remote_addr
+
+client address
+
+
+$remote_port
+
+client port
+
+
+$remote_user
+
+user name supplied with the Basic authentication
+
+
+$realpath_root
+
+root directive's value
+for the current request, with all symbolic links resolved to real paths
+
+
+$request_filename
+
+file path for the current query, based on the
+root and alias
+directives, and the request URI
+
+
+$request_body
+
+request body
+
+The variable's value is made available in locations
+processed by the
+proxy_pass
+and
+fastcgi_pass
+directives.
+
+
+
+$request_body_file
+
+name of a temporary file with the request body
+
+At the end of processing, the file needs to be removed.
+To always write a request body to a file,
+client_body_in_file_only on
+needs be specified.
+When passing the name of a temporary file in a proxied request,
+or in a request to a FastCGI server,
+passing of the request body should be disabled by the
+proxy_pass_request_body
+and
+fastcgi_pass_request_body
+directives, respectively.
+
+
+
+$request_uri
+
+full original request URI (with arguments)
+
+
+$query_string
+
+same as $args
+
+
+$scheme
+
+request scheme, http or https>
+
+
+$server_protocol
+
+request protocol, usually
+HTTP/1.0
+or
+HTTP/1.1
+
+
+$server_addr
+
+an address of the server which accepted a request
+
+Computing a value of this variable usually requires one system call.
+To avoid a system call, the listen directives
+must specify addresses and use the bind parameter
+
+
+
+$server_name
+
+name of the server which accepted a request
+
+
+$server_port
+
+port of the server which accepted a request
+
+
+$uri
+
+current URI in request
+
+It may differ from an original, e.g. when doing internal redirects,
+or when using index files.
+
+
+
+
+
+
+
+
diff --git a/docs/xml/ngx_core_module.xml b/docs/xml/ngx_core_module.xml
index 065d1f271..2afc3172d 100644
--- a/docs/xml/ngx_core_module.xml
+++ b/docs/xml/ngx_core_module.xml
@@ -8,14 +8,14 @@
-user www www;
-worker_processes 2;
+user www www;
+worker_processes 2;
-error_log /var/log/nginx-error.log info;
+error_log /var/log/nginx-error.log info;
events {
- use kqueue;
- worker_connections 2048;
+ use kqueue;
+ worker_connections 2048;
}
...
@@ -65,7 +65,7 @@ module;
use of variables by worker processes.
Please bear in mind that controlling system libraries in this way
-isn't always possible as it's not uncommon for libraries to check
+is not always possible as it is not uncommon for libraries to check
variables only during initialization, well before they can be set
using this directive.
An exception from this is an above mentioned
@@ -85,9 +85,9 @@ module, unless configured explicitly.
Usage example:
-env MALLOC_OPTIONS;
-env PERL5LIB=/data/site/modules;
-env OPENSSL_ALLOW_PROXY_CERTS=1;
+env MALLOC_OPTIONS;
+env PERL5LIB=/data/site/modules;
+env OPENSSL_ALLOW_PROXY_CERTS=1;
@@ -108,8 +108,8 @@ syntactically correct directives and blocks.
Usage example:
-include mime.types;
-include vhosts/*.conf;
+include mime.types;
+include vhosts/*.conf;
@@ -185,7 +185,7 @@ called once per specified interval.
Example:
-timer_resolution 100ms;
+timer_resolution 100ms;
@@ -194,11 +194,11 @@ An internal implementation of interval depends on the method used:
-an EVFILT_TIMER filter if kqueue is used;
+an EVFILT_TIMER filter if kqueue is used;
-timer_create if eventport is used;
+timer_create if eventport is used;
@@ -255,7 +255,7 @@ Allowed range normally varies from -20 to 20.
Example:
-worker_priority -10;
+worker_priority -10;
@@ -281,7 +281,7 @@ Defines the number of worker processes.
Defines a current working directory for a worker process.
-It's primarily used for writing a core-file, in which case
+It is primarily used when writing a core-file, in which case
a working process should have write permission for the
specified directory.