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