annotate docs/man/nginx.8 @ 4412:d620f497c50f

Copyright updated.
author Maxim Konovalov <maxim@nginx.com>
date Wed, 18 Jan 2012 15:07:43 +0000
parents 6df31b324bbf
children 731c71ef051b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3788
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
1 .\"
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
2 .\" Copyright (c) 2010 Sergey A. Osokin
4412
d620f497c50f Copyright updated.
Maxim Konovalov <maxim@nginx.com>
parents: 4001
diff changeset
3 .\" Copyright (c) 2011,2012 Nginx, Inc.
3788
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
4 .\" All rights reserved.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
5 .\"
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
6 .\" Redistribution and use in source and binary forms, with or without
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
7 .\" modification, are permitted provided that the following conditions
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
8 .\" are met:
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
9 .\" 1. Redistributions of source code must retain the above copyright
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
10 .\" notice, this list of conditions and the following disclaimer.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
11 .\" 2. Redistributions in binary form must reproduce the above copyright
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
12 .\" notice, this list of conditions and the following disclaimer in the
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
13 .\" documentation and/or other materials provided with the distribution.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
14 .\"
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
18 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
25 .\" SUCH DAMAGE.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
26 .\"
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
27 .\"
4000
98f9fcd3c320 Mention our preferred way of accepting bug reports.
Ruslan Ermilov <ru@nginx.com>
parents: 3800
diff changeset
28 .Dd August 10, 2011
3788
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
29 .Dt NGINX 8
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
30 .Os
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
31 .Sh NAME
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
32 .Nm nginx
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
33 .Nd "HTTP and reverse proxy server, mail proxy server"
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
34 .Sh SYNOPSIS
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
35 .Nm
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
36 .Op Fl hqtvV?
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
37 .Op Fl c Ar file
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
38 .Op Fl g Ar directives
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
39 .Op Fl p Ar prefix
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
40 .Op Fl s Ar signal
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
41 .Sh DESCRIPTION
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
42 The
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
43 .Nm
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
44 (spelled
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
45 .Dq engine x )
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
46 is an HTTP and reverse proxy server, as well as a mail proxy server.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
47 The
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
48 .Nm
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
49 is known for its high performance, stability, rich feature set, simple
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
50 configuration, and low resource consumption.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
51 .Pp
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
52 The options are as follows:
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
53 .Bl -tag -width ".Fl d Ar directives"
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
54 .It Fl ?\& | h
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
55 Print help.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
56 .It Fl c Ar file
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
57 Use an alternative configuration
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
58 .Ar file .
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
59 .It Fl g Ar directives
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
60 Set global configuration directives.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
61 See
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
62 .Sx EXAMPLES
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
63 for details.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
64 .It Fl p Ar prefix
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
65 Set prefix path.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
66 Default value is
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
67 .Pa %%PREFIX%% .
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
68 .It Fl q
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
69 Suppress non-error messages during configuration testing.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
70 .It Fl s Ar signal
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
71 Send signal to the master process.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
72 The argument
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
73 .Ar signal
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
74 can be one of:
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
75 .Cm stop , quit , reopen , reload .
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
76 The following table shows the corresponding system signals.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
77 .Pp
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
78 .Bl -tag -width ".It Cm reopen" -compact
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
79 .It Cm stop
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
80 .Dv SIGTERM
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
81 .It Cm quit
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
82 .Dv SIGQUIT
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
83 .It Cm reopen
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
84 .Dv SIGUSR1
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
85 .It Cm reload
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
86 .Dv SIGHUP
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
87 .El
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
88 .It Fl t
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
89 Don't run, just test the configuration file.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
90 The
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
91 .Nm
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
92 checks configuration for correct syntax and then tries to open files
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
93 referred in configuration.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
94 .It Fl v
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
95 Print
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
96 .Nm
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
97 version.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
98 .It Fl V
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
99 Print
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
100 .Nm
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
101 version, compiler version and
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
102 .Pa configure
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
103 script parameters.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
104 .El
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
105 .Sh SIGNALS
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
106 The master process of
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
107 .Nm
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
108 can handle the following signals.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
109 .Pp
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
110 .Bl -tag -width ".It Dv SIGINT , SIGTERM" -compact
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
111 .It Dv SIGINT , SIGTERM
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
112 Shut down quickly.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
113 .It Dv SIGHUP
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
114 Reload configuration, start the new worker process with a new
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
115 configuration, gracefully shut down old worker processes.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
116 .It Dv SIGQUIT
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
117 Shut down gracefully.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
118 .It Dv SIGUSR1
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
119 Reopen log files.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
120 .It Dv SIGUSR2
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
121 Upgrade
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
122 .Nm
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
123 executable on the fly.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
124 .It Dv SIGWINCH
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
125 Shut down gracefully worker processes.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
126 .El
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
127 .Pp
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
128 While there's no need to explicitly control worker processes normally,
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
129 they support some signals, too:
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
130 .Pp
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
131 .Bl -tag -width ".It Dv SIGINT , SIGTERM" -compact
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
132 .It Dv SIGTERM
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
133 Shut down quickly.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
134 .It Dv SIGQUIT
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
135 Shut down gracefully.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
136 .It Dv SIGUSR1
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
137 Reopen log files.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
138 .El
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
139 .Sh DEBUGGING LOG
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
140 To enable a debugging log, reconfigure
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
141 .Nm
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
142 to build with debugging:
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
143 .Pp
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
144 .Dl "./configure --with-debug ..."
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
145 .Pp
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
146 and then set the
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
147 .Cm debug
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
148 level of the
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
149 .Va error_log :
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
150 .Pp
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
151 .Dl "error_log /path/to/log debug;"
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
152 .Pp
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
153 It is also possible to enable the debugging for some IP address:
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
154 .Bd -literal -offset indent
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
155 events {
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
156 debug_connection 127.0.0.1;
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
157 }
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
158 .Ed
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
159 .Sh FILES
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
160 .Bl -tag -width indent -compact
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
161 .It Pa %%PID_PATH%%
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
162 Contains the process ID of the
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
163 .Nm
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
164 listening for connections.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
165 The content of this file is not sensitive; it can be world-readable.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
166 .It Pa %%CONF_PATH%%
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
167 Main configuration file.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
168 .It Pa %%ERROR_LOG_PATH%%
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
169 Error log file.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
170 .El
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
171 .Sh EXIT STATUS
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
172 Exit status is 0 on success, or 1 if the command fails.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
173 .Sh EXAMPLES
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
174 .Bd -literal
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
175 nginx -t -c ~/mynginx.conf -g "pid /var/run/mynginx.pid; worker_processes 2;"
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
176 .Ed
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
177 Test configuration file
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
178 .Pa ~/mynginx.conf
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
179 with global directives for PID and quantity of worker processes.
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
180 .Sh SEE ALSO
4001
6df31b324bbf - Replaced explicit link to bugtracker with a support link
Ruslan Ermilov <ru@nginx.com>
parents: 4000
diff changeset
181 .\"Xr nginx.conf 5
6df31b324bbf - Replaced explicit link to bugtracker with a support link
Ruslan Ermilov <ru@nginx.com>
parents: 4000
diff changeset
182 .\"Pp
6df31b324bbf - Replaced explicit link to bugtracker with a support link
Ruslan Ermilov <ru@nginx.com>
parents: 4000
diff changeset
183 Documentation at
6df31b324bbf - Replaced explicit link to bugtracker with a support link
Ruslan Ermilov <ru@nginx.com>
parents: 4000
diff changeset
184 .Pa http://nginx.org/
6df31b324bbf - Replaced explicit link to bugtracker with a support link
Ruslan Ermilov <ru@nginx.com>
parents: 4000
diff changeset
185 and
6df31b324bbf - Replaced explicit link to bugtracker with a support link
Ruslan Ermilov <ru@nginx.com>
parents: 4000
diff changeset
186 .Pa http://sysoev.ru/nginx/ .
6df31b324bbf - Replaced explicit link to bugtracker with a support link
Ruslan Ermilov <ru@nginx.com>
parents: 4000
diff changeset
187 .Pp
6df31b324bbf - Replaced explicit link to bugtracker with a support link
Ruslan Ermilov <ru@nginx.com>
parents: 4000
diff changeset
188 For questions and technical support, please refer to
6df31b324bbf - Replaced explicit link to bugtracker with a support link
Ruslan Ermilov <ru@nginx.com>
parents: 4000
diff changeset
189 .Pa http://nginx.org/en/support.html .
3788
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
190 .Sh HISTORY
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
191 Development of
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
192 .Nm
3800
8baa96142289 add the first release date
Igor Sysoev <igor@sysoev.ru>
parents: 3788
diff changeset
193 started in 2002, with the first public release on October 4, 2004.
3788
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
194 .Sh AUTHORS
4001
6df31b324bbf - Replaced explicit link to bugtracker with a support link
Ruslan Ermilov <ru@nginx.com>
parents: 4000
diff changeset
195 .An -nosplit
3788
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
196 .An Igor Sysoev Aq igor@sysoev.ru
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
197 .Pp
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
198 This manual page was written by
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
199 .An Sergey A. Osokin Aq osa@FreeBSD.org.ru
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
200 as a result of compilation of many
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
201 .Nm
b50daa26aa22 add nginx.8 man page
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
202 documents all over the world.