mirror of
https://github.com/nginx/nginx.git
synced 2025-01-07 22:53:02 -06:00
- Applied some of the OpenBSD changes.
- Expanded contractions. - Fixed some markup. - Updated URL of official documentation.
This commit is contained in:
parent
ee187436af
commit
098c7b6aa6
@ -25,7 +25,7 @@
|
|||||||
.\" SUCH DAMAGE.
|
.\" SUCH DAMAGE.
|
||||||
.\"
|
.\"
|
||||||
.\"
|
.\"
|
||||||
.Dd August 10, 2011
|
.Dd March 6, 2012
|
||||||
.Dt NGINX 8
|
.Dt NGINX 8
|
||||||
.Os
|
.Os
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
@ -33,25 +33,22 @@
|
|||||||
.Nd "HTTP and reverse proxy server, mail proxy server"
|
.Nd "HTTP and reverse proxy server, mail proxy server"
|
||||||
.Sh SYNOPSIS
|
.Sh SYNOPSIS
|
||||||
.Nm
|
.Nm
|
||||||
.Op Fl hqtvV?
|
.Op Fl ?hqtVv
|
||||||
.Op Fl c Ar file
|
.Op Fl c Ar file
|
||||||
.Op Fl g Ar directives
|
.Op Fl g Ar directives
|
||||||
.Op Fl p Ar prefix
|
.Op Fl p Ar prefix
|
||||||
.Op Fl s Ar signal
|
.Op Fl s Ar signal
|
||||||
.Sh DESCRIPTION
|
.Sh DESCRIPTION
|
||||||
The
|
|
||||||
.Nm
|
.Nm
|
||||||
(spelled
|
(pronounced
|
||||||
.Dq engine x )
|
.Dq engine x )
|
||||||
is an HTTP and reverse proxy server, as well as a mail proxy server.
|
is an HTTP and reverse proxy server, as well as a mail proxy server.
|
||||||
The
|
It is known for its high performance, stability, rich feature set, simple
|
||||||
.Nm
|
|
||||||
is known for its high performance, stability, rich feature set, simple
|
|
||||||
configuration, and low resource consumption.
|
configuration, and low resource consumption.
|
||||||
.Pp
|
.Pp
|
||||||
The options are as follows:
|
The options are as follows:
|
||||||
.Bl -tag -width ".Fl d Ar directives"
|
.Bl -tag -width ".Fl d Ar directives"
|
||||||
.It Fl ?\& | h
|
.It Fl ?\& , h
|
||||||
Print help.
|
Print help.
|
||||||
.It Fl c Ar file
|
.It Fl c Ar file
|
||||||
Use an alternative configuration
|
Use an alternative configuration
|
||||||
@ -62,20 +59,20 @@ See
|
|||||||
.Sx EXAMPLES
|
.Sx EXAMPLES
|
||||||
for details.
|
for details.
|
||||||
.It Fl p Ar prefix
|
.It Fl p Ar prefix
|
||||||
Set prefix path.
|
Set the prefix path.
|
||||||
Default value is
|
The default value is
|
||||||
.Pa %%PREFIX%% .
|
.Pa %%PREFIX%% .
|
||||||
.It Fl q
|
.It Fl q
|
||||||
Suppress non-error messages during configuration testing.
|
Suppress non-error messages during configuration testing.
|
||||||
.It Fl s Ar signal
|
.It Fl s Ar signal
|
||||||
Send signal to the master process.
|
Send a signal to the master process.
|
||||||
The argument
|
The argument
|
||||||
.Ar signal
|
.Ar signal
|
||||||
can be one of:
|
can be one of:
|
||||||
.Cm stop , quit , reopen , reload .
|
.Cm stop , quit , reopen , reload .
|
||||||
The following table shows the corresponding system signals.
|
The following table shows the corresponding system signals:
|
||||||
.Pp
|
.Pp
|
||||||
.Bl -tag -width ".It Cm reopen" -compact
|
.Bl -tag -width ".Cm reopen" -compact
|
||||||
.It Cm stop
|
.It Cm stop
|
||||||
.Dv SIGTERM
|
.Dv SIGTERM
|
||||||
.It Cm quit
|
.It Cm quit
|
||||||
@ -86,49 +83,48 @@ The following table shows the corresponding system signals.
|
|||||||
.Dv SIGHUP
|
.Dv SIGHUP
|
||||||
.El
|
.El
|
||||||
.It Fl t
|
.It Fl t
|
||||||
Don't run, just test the configuration file.
|
Do not run, just test the configuration file.
|
||||||
The
|
|
||||||
.Nm
|
.Nm
|
||||||
checks configuration for correct syntax and then tries to open files
|
checks the configuration file syntax and then tries to open files
|
||||||
referred in configuration.
|
referenced in the configuration file.
|
||||||
.It Fl v
|
|
||||||
Print
|
|
||||||
.Nm
|
|
||||||
version.
|
|
||||||
.It Fl V
|
.It Fl V
|
||||||
Print
|
Print the
|
||||||
.Nm
|
.Nm
|
||||||
version, compiler version and
|
version, compiler version, and
|
||||||
.Pa configure
|
.Pa configure
|
||||||
script parameters.
|
script parameters.
|
||||||
|
.It Fl v
|
||||||
|
Print the
|
||||||
|
.Nm
|
||||||
|
version.
|
||||||
.El
|
.El
|
||||||
.Sh SIGNALS
|
.Sh SIGNALS
|
||||||
The master process of
|
The master process of
|
||||||
.Nm
|
.Nm
|
||||||
can handle the following signals.
|
can handle the following signals:
|
||||||
.Pp
|
.Pp
|
||||||
.Bl -tag -width ".It Dv SIGINT , SIGTERM" -compact
|
.Bl -tag -width ".Dv SIGINT , SIGTERM" -compact
|
||||||
.It Dv SIGINT , SIGTERM
|
.It Dv SIGINT , SIGTERM
|
||||||
Shut down quickly.
|
Shut down quickly.
|
||||||
.It Dv SIGHUP
|
.It Dv SIGHUP
|
||||||
Reload configuration, start the new worker process with a new
|
Reload configuration, start the new worker process with a new
|
||||||
configuration, gracefully shut down old worker processes.
|
configuration, and gracefully shut down old worker processes.
|
||||||
.It Dv SIGQUIT
|
.It Dv SIGQUIT
|
||||||
Shut down gracefully.
|
Shut down gracefully.
|
||||||
.It Dv SIGUSR1
|
.It Dv SIGUSR1
|
||||||
Reopen log files.
|
Reopen log files.
|
||||||
.It Dv SIGUSR2
|
.It Dv SIGUSR2
|
||||||
Upgrade
|
Upgrade the
|
||||||
.Nm
|
.Nm
|
||||||
executable on the fly.
|
executable on the fly.
|
||||||
.It Dv SIGWINCH
|
.It Dv SIGWINCH
|
||||||
Shut down gracefully worker processes.
|
Shut down worker processes gracefully.
|
||||||
.El
|
.El
|
||||||
.Pp
|
.Pp
|
||||||
While there's no need to explicitly control worker processes normally,
|
While there is no need to explicitly control worker processes normally,
|
||||||
they support some signals, too:
|
they support some signals too:
|
||||||
.Pp
|
.Pp
|
||||||
.Bl -tag -width ".It Dv SIGINT , SIGTERM" -compact
|
.Bl -tag -width ".Dv SIGINT , SIGTERM" -compact
|
||||||
.It Dv SIGTERM
|
.It Dv SIGTERM
|
||||||
Shut down quickly.
|
Shut down quickly.
|
||||||
.It Dv SIGQUIT
|
.It Dv SIGQUIT
|
||||||
@ -150,40 +146,38 @@ level of the
|
|||||||
.Pp
|
.Pp
|
||||||
.Dl "error_log /path/to/log debug;"
|
.Dl "error_log /path/to/log debug;"
|
||||||
.Pp
|
.Pp
|
||||||
It is also possible to enable the debugging for some IP address:
|
It is also possible to enable the debugging for a particular IP address:
|
||||||
.Bd -literal -offset indent
|
.Bd -literal -offset indent
|
||||||
events {
|
events {
|
||||||
debug_connection 127.0.0.1;
|
debug_connection 127.0.0.1;
|
||||||
}
|
}
|
||||||
.Ed
|
.Ed
|
||||||
.Sh FILES
|
.Sh FILES
|
||||||
.Bl -tag -width indent -compact
|
.Bl -tag -width indent
|
||||||
.It Pa %%PID_PATH%%
|
.It Pa %%PID_PATH%%
|
||||||
Contains the process ID of the
|
Contains the process ID of
|
||||||
.Nm
|
.Nm .
|
||||||
listening for connections.
|
The contents of this file are not sensitive, so it can be world-readable.
|
||||||
The content of this file is not sensitive; it can be world-readable.
|
|
||||||
.It Pa %%CONF_PATH%%
|
.It Pa %%CONF_PATH%%
|
||||||
Main configuration file.
|
The main configuration file.
|
||||||
.It Pa %%ERROR_LOG_PATH%%
|
.It Pa %%ERROR_LOG_PATH%%
|
||||||
Error log file.
|
Error log file.
|
||||||
.El
|
.El
|
||||||
.Sh EXIT STATUS
|
.Sh EXIT STATUS
|
||||||
Exit status is 0 on success, or 1 if the command fails.
|
Exit status is 0 on success, or 1 if the command fails.
|
||||||
.Sh EXAMPLES
|
.Sh EXAMPLES
|
||||||
.Bd -literal
|
|
||||||
nginx -t -c ~/mynginx.conf -g "pid /var/run/mynginx.pid; worker_processes 2;"
|
|
||||||
.Ed
|
|
||||||
Test configuration file
|
Test configuration file
|
||||||
.Pa ~/mynginx.conf
|
.Pa ~/mynginx.conf
|
||||||
with global directives for PID and quantity of worker processes.
|
with global directives for PID and quantity of worker processes:
|
||||||
|
.Bd -literal -offset indent
|
||||||
|
nginx -t -c ~/mynginx.conf \e
|
||||||
|
-g "pid /var/run/mynginx.pid; worker_processes 2;"
|
||||||
|
.Ed
|
||||||
.Sh SEE ALSO
|
.Sh SEE ALSO
|
||||||
.\"Xr nginx.conf 5
|
.\"Xr nginx.conf 5
|
||||||
.\"Pp
|
.\"Pp
|
||||||
Documentation at
|
Documentation at
|
||||||
.Pa http://nginx.org/
|
.Pa http://nginx.org/en/docs/ .
|
||||||
and
|
|
||||||
.Pa http://sysoev.ru/nginx/ .
|
|
||||||
.Pp
|
.Pp
|
||||||
For questions and technical support, please refer to
|
For questions and technical support, please refer to
|
||||||
.Pa http://nginx.org/en/support.html .
|
.Pa http://nginx.org/en/support.html .
|
||||||
@ -193,10 +187,10 @@ Development of
|
|||||||
started in 2002, with the first public release on October 4, 2004.
|
started in 2002, with the first public release on October 4, 2004.
|
||||||
.Sh AUTHORS
|
.Sh AUTHORS
|
||||||
.An -nosplit
|
.An -nosplit
|
||||||
.An Igor Sysoev Aq igor@sysoev.ru
|
.An Igor Sysoev Aq igor@sysoev.ru .
|
||||||
.Pp
|
.Pp
|
||||||
This manual page was written by
|
This manual page was written by
|
||||||
.An Sergey A. Osokin Aq osa@FreeBSD.org.ru
|
.An Sergey A. Osokin Aq osa@FreeBSD.org.ru
|
||||||
as a result of compilation of many
|
as a result of compiling many
|
||||||
.Nm
|
.Nm
|
||||||
documents all over the world.
|
documents from all over the world.
|
||||||
|
Loading…
Reference in New Issue
Block a user