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