Mercurial > hg > nginx

comparison docs/man/nginx.8 @ 4523:731c71ef051b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
- Applied some of the OpenBSD changes. - Expanded contractions. - Fixed some markup. - Updated URL of official documentation.
author Ruslan Ermilov <ru@nginx.com>
date Tue, 06 Mar 2012 06:54:48 +0000
parents d620f497c50f
children 3ac1c784be40
comparison
equal deleted inserted replaced
4522:14411ee4d89f 4523:731c71ef051b
23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 .\" SUCH DAMAGE. 25 .\" SUCH DAMAGE.
26 .\" 26 .\"
27 .\" 27 .\"
28 .Dd August 10, 2011 28 .Dd March 6, 2012
29 .Dt NGINX 8 29 .Dt NGINX 8
30 .Os 30 .Os
31 .Sh NAME 31 .Sh NAME
32 .Nm nginx 32 .Nm nginx
33 .Nd "HTTP and reverse proxy server, mail proxy server" 33 .Nd "HTTP and reverse proxy server, mail proxy server"
34 .Sh SYNOPSIS 34 .Sh SYNOPSIS
35 .Nm 35 .Nm
36 .Op Fl hqtvV? 36 .Op Fl ?hqtVv
37 .Op Fl c Ar file 37 .Op Fl c Ar file
38 .Op Fl g Ar directives 38 .Op Fl g Ar directives
39 .Op Fl p Ar prefix 39 .Op Fl p Ar prefix
40 .Op Fl s Ar signal 40 .Op Fl s Ar signal
41 .Sh DESCRIPTION 41 .Sh DESCRIPTION
42 The
43 .Nm 42 .Nm
44 (spelled 43 (pronounced
45 .Dq engine x ) 44 .Dq engine x )
46 is an HTTP and reverse proxy server, as well as a mail proxy server. 45 is an HTTP and reverse proxy server, as well as a mail proxy server.
47 The 46 It is known for its high performance, stability, rich feature set, simple
48 .Nm
49 is known for its high performance, stability, rich feature set, simple
50 configuration, and low resource consumption. 47 configuration, and low resource consumption.
51 .Pp 48 .Pp
52 The options are as follows: 49 The options are as follows:
53 .Bl -tag -width ".Fl d Ar directives" 50 .Bl -tag -width ".Fl d Ar directives"
54 .It Fl ?\& | h 51 .It Fl ?\& , h
55 Print help. 52 Print help.
56 .It Fl c Ar file 53 .It Fl c Ar file
57 Use an alternative configuration 54 Use an alternative configuration
58 .Ar file . 55 .Ar file .
59 .It Fl g Ar directives 56 .It Fl g Ar directives
60 Set global configuration directives. 57 Set global configuration directives.
61 See 58 See
62 .Sx EXAMPLES 59 .Sx EXAMPLES
63 for details. 60 for details.
64 .It Fl p Ar prefix 61 .It Fl p Ar prefix
65 Set prefix path. 62 Set the prefix path.
66 Default value is 63 The default value is
67 .Pa %%PREFIX%% . 64 .Pa %%PREFIX%% .
68 .It Fl q 65 .It Fl q
69 Suppress non-error messages during configuration testing. 66 Suppress non-error messages during configuration testing.
70 .It Fl s Ar signal 67 .It Fl s Ar signal
71 Send signal to the master process. 68 Send a signal to the master process.
72 The argument 69 The argument
73 .Ar signal 70 .Ar signal
74 can be one of: 71 can be one of:
75 .Cm stop , quit , reopen , reload . 72 .Cm stop , quit , reopen , reload .
76 The following table shows the corresponding system signals. 73 The following table shows the corresponding system signals:
77 .Pp 74 .Pp
78 .Bl -tag -width ".It Cm reopen" -compact 75 .Bl -tag -width ".Cm reopen" -compact
79 .It Cm stop 76 .It Cm stop
80 .Dv SIGTERM 77 .Dv SIGTERM
81 .It Cm quit 78 .It Cm quit
82 .Dv SIGQUIT 79 .Dv SIGQUIT
83 .It Cm reopen 80 .It Cm reopen
84 .Dv SIGUSR1 81 .Dv SIGUSR1
85 .It Cm reload 82 .It Cm reload
86 .Dv SIGHUP 83 .Dv SIGHUP
87 .El 84 .El
88 .It Fl t 85 .It Fl t
89 Don't run, just test the configuration file. 86 Do not run, just test the configuration file.
90 The
91 .Nm 87 .Nm
92 checks configuration for correct syntax and then tries to open files 88 checks the configuration file syntax and then tries to open files
93 referred in configuration. 89 referenced in the configuration file.
90 .It Fl V
91 Print the
92 .Nm
93 version, compiler version, and
94 .Pa configure
95 script parameters.
94 .It Fl v 96 .It Fl v
95 Print 97 Print the
96 .Nm 98 .Nm
97 version. 99 version.
98 .It Fl V
99 Print
100 .Nm
101 version, compiler version and
102 .Pa configure
103 script parameters.
104 .El 100 .El
105 .Sh SIGNALS 101 .Sh SIGNALS
106 The master process of 102 The master process of
107 .Nm 103 .Nm
108 can handle the following signals. 104 can handle the following signals:
109 .Pp 105 .Pp
110 .Bl -tag -width ".It Dv SIGINT , SIGTERM" -compact 106 .Bl -tag -width ".Dv SIGINT , SIGTERM" -compact
111 .It Dv SIGINT , SIGTERM 107 .It Dv SIGINT , SIGTERM
112 Shut down quickly. 108 Shut down quickly.
113 .It Dv SIGHUP 109 .It Dv SIGHUP
114 Reload configuration, start the new worker process with a new 110 Reload configuration, start the new worker process with a new
115 configuration, gracefully shut down old worker processes. 111 configuration, and gracefully shut down old worker processes.
116 .It Dv SIGQUIT 112 .It Dv SIGQUIT
117 Shut down gracefully. 113 Shut down gracefully.
118 .It Dv SIGUSR1 114 .It Dv SIGUSR1
119 Reopen log files. 115 Reopen log files.
120 .It Dv SIGUSR2 116 .It Dv SIGUSR2
121 Upgrade 117 Upgrade the
122 .Nm 118 .Nm
123 executable on the fly. 119 executable on the fly.
124 .It Dv SIGWINCH 120 .It Dv SIGWINCH
125 Shut down gracefully worker processes. 121 Shut down worker processes gracefully.
126 .El 122 .El
127 .Pp 123 .Pp
128 While there's no need to explicitly control worker processes normally, 124 While there is no need to explicitly control worker processes normally,
129 they support some signals, too: 125 they support some signals too:
130 .Pp 126 .Pp
131 .Bl -tag -width ".It Dv SIGINT , SIGTERM" -compact 127 .Bl -tag -width ".Dv SIGINT , SIGTERM" -compact
132 .It Dv SIGTERM 128 .It Dv SIGTERM
133 Shut down quickly. 129 Shut down quickly.
134 .It Dv SIGQUIT 130 .It Dv SIGQUIT
135 Shut down gracefully. 131 Shut down gracefully.
136 .It Dv SIGUSR1 132 .It Dv SIGUSR1
148 level of the 144 level of the
149 .Va error_log : 145 .Va error_log :
150 .Pp 146 .Pp
151 .Dl "error_log /path/to/log debug;" 147 .Dl "error_log /path/to/log debug;"
152 .Pp 148 .Pp
153 It is also possible to enable the debugging for some IP address: 149 It is also possible to enable the debugging for a particular IP address:
154 .Bd -literal -offset indent 150 .Bd -literal -offset indent
155 events { 151 events {
156 debug_connection 127.0.0.1; 152 debug_connection 127.0.0.1;
157 } 153 }
158 .Ed 154 .Ed
159 .Sh FILES 155 .Sh FILES
160 .Bl -tag -width indent -compact 156 .Bl -tag -width indent
161 .It Pa %%PID_PATH%% 157 .It Pa %%PID_PATH%%
162 Contains the process ID of the 158 Contains the process ID of
163 .Nm 159 .Nm .
164 listening for connections. 160 The contents of this file are not sensitive, so it can be world-readable.
165 The content of this file is not sensitive; it can be world-readable.
166 .It Pa %%CONF_PATH%% 161 .It Pa %%CONF_PATH%%
167 Main configuration file. 162 The main configuration file.
168 .It Pa %%ERROR_LOG_PATH%% 163 .It Pa %%ERROR_LOG_PATH%%
169 Error log file. 164 Error log file.
170 .El 165 .El
171 .Sh EXIT STATUS 166 .Sh EXIT STATUS
172 Exit status is 0 on success, or 1 if the command fails. 167 Exit status is 0 on success, or 1 if the command fails.
173 .Sh EXAMPLES 168 .Sh EXAMPLES
174 .Bd -literal
175 nginx -t -c ~/mynginx.conf -g "pid /var/run/mynginx.pid; worker_processes 2;"
176 .Ed
177 Test configuration file 169 Test configuration file
178 .Pa ~/mynginx.conf 170 .Pa ~/mynginx.conf
179 with global directives for PID and quantity of worker processes. 171 with global directives for PID and quantity of worker processes:
172 .Bd -literal -offset indent
173 nginx -t -c ~/mynginx.conf \e
174 -g "pid /var/run/mynginx.pid; worker_processes 2;"
175 .Ed
180 .Sh SEE ALSO 176 .Sh SEE ALSO
181 .\"Xr nginx.conf 5 177 .\"Xr nginx.conf 5
182 .\"Pp 178 .\"Pp
183 Documentation at 179 Documentation at
184 .Pa http://nginx.org/ 180 .Pa http://nginx.org/en/docs/ .
185 and
186 .Pa http://sysoev.ru/nginx/ .
187 .Pp 181 .Pp
188 For questions and technical support, please refer to 182 For questions and technical support, please refer to
189 .Pa http://nginx.org/en/support.html . 183 .Pa http://nginx.org/en/support.html .
190 .Sh HISTORY 184 .Sh HISTORY
191 Development of 185 Development of
192 .Nm 186 .Nm
193 started in 2002, with the first public release on October 4, 2004. 187 started in 2002, with the first public release on October 4, 2004.
194 .Sh AUTHORS 188 .Sh AUTHORS
195 .An -nosplit 189 .An -nosplit
196 .An Igor Sysoev Aq igor@sysoev.ru 190 .An Igor Sysoev Aq igor@sysoev.ru .
197 .Pp 191 .Pp
198 This manual page was written by 192 This manual page was written by
199 .An Sergey A. Osokin Aq osa@FreeBSD.org.ru 193 .An Sergey A. Osokin Aq osa@FreeBSD.org.ru
200 as a result of compilation of many 194 as a result of compiling many
201 .Nm 195 .Nm
202 documents all over the world. 196 documents from all over the world.