# HG changeset patch # User Ruslan Ermilov # Date 1331016888 0 # Node ID 731c71ef051b8606435b1e736285f5f5cafad5c3 # Parent 14411ee4d89f011aea8dde588162a6c0b739a36e - Applied some of the OpenBSD changes. - Expanded contractions. - Fixed some markup. - Updated URL of official documentation. diff --git a/docs/man/nginx.8 b/docs/man/nginx.8 --- a/docs/man/nginx.8 +++ b/docs/man/nginx.8 @@ -25,7 +25,7 @@ .\" SUCH DAMAGE. .\" .\" -.Dd August 10, 2011 +.Dd March 6, 2012 .Dt NGINX 8 .Os .Sh NAME @@ -33,25 +33,22 @@ .Nd "HTTP and reverse proxy server, mail proxy server" .Sh SYNOPSIS .Nm -.Op Fl hqtvV? +.Op Fl ?hqtVv .Op Fl c Ar file .Op Fl g Ar directives .Op Fl p Ar prefix .Op Fl s Ar signal .Sh DESCRIPTION -The .Nm -(spelled +(pronounced .Dq engine x ) is an HTTP and reverse proxy server, as well as a mail proxy server. -The -.Nm -is known for its high performance, stability, rich feature set, simple +It is known for its high performance, stability, rich feature set, simple configuration, and low resource consumption. .Pp The options are as follows: .Bl -tag -width ".Fl d Ar directives" -.It Fl ?\& | h +.It Fl ?\& , h Print help. .It Fl c Ar file Use an alternative configuration @@ -62,20 +59,20 @@ See .Sx EXAMPLES for details. .It Fl p Ar prefix -Set prefix path. -Default value is +Set the prefix path. +The default value is .Pa %%PREFIX%% . .It Fl q Suppress non-error messages during configuration testing. .It Fl s Ar signal -Send signal to the master process. +Send a signal to the master process. The argument .Ar signal can be one of: .Cm stop , quit , reopen , reload . -The following table shows the corresponding system signals. +The following table shows the corresponding system signals: .Pp -.Bl -tag -width ".It Cm reopen" -compact +.Bl -tag -width ".Cm reopen" -compact .It Cm stop .Dv SIGTERM .It Cm quit @@ -86,49 +83,48 @@ The following table shows the correspond .Dv SIGHUP .El .It Fl t -Don't run, just test the configuration file. -The +Do not run, just test the configuration file. .Nm -checks configuration for correct syntax and then tries to open files -referred in configuration. +checks the configuration file syntax and then tries to open files +referenced in the configuration file. +.It Fl V +Print the +.Nm +version, compiler version, and +.Pa configure +script parameters. .It Fl v -Print +Print the .Nm version. -.It Fl V -Print -.Nm -version, compiler version and -.Pa configure -script parameters. .El .Sh SIGNALS The master process of .Nm -can handle the following signals. +can handle the following signals: .Pp -.Bl -tag -width ".It Dv SIGINT , SIGTERM" -compact +.Bl -tag -width ".Dv SIGINT , SIGTERM" -compact .It Dv SIGINT , SIGTERM Shut down quickly. .It Dv SIGHUP 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 Shut down gracefully. .It Dv SIGUSR1 Reopen log files. .It Dv SIGUSR2 -Upgrade +Upgrade the .Nm executable on the fly. .It Dv SIGWINCH -Shut down gracefully worker processes. +Shut down worker processes gracefully. .El .Pp -While there's no need to explicitly control worker processes normally, -they support some signals, too: +While there is no need to explicitly control worker processes normally, +they support some signals too: .Pp -.Bl -tag -width ".It Dv SIGINT , SIGTERM" -compact +.Bl -tag -width ".Dv SIGINT , SIGTERM" -compact .It Dv SIGTERM Shut down quickly. .It Dv SIGQUIT @@ -150,40 +146,38 @@ level of the .Pp .Dl "error_log /path/to/log debug;" .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 events { debug_connection 127.0.0.1; } .Ed .Sh FILES -.Bl -tag -width indent -compact +.Bl -tag -width indent .It Pa %%PID_PATH%% -Contains the process ID of the -.Nm -listening for connections. -The content of this file is not sensitive; it can be world-readable. +Contains the process ID of +.Nm . +The contents of this file are not sensitive, so it can be world-readable. .It Pa %%CONF_PATH%% -Main configuration file. +The main configuration file. .It Pa %%ERROR_LOG_PATH%% Error log file. .El .Sh EXIT STATUS Exit status is 0 on success, or 1 if the command fails. .Sh EXAMPLES -.Bd -literal -nginx -t -c ~/mynginx.conf -g "pid /var/run/mynginx.pid; worker_processes 2;" -.Ed Test configuration file .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 .\"Xr nginx.conf 5 .\"Pp Documentation at -.Pa http://nginx.org/ -and -.Pa http://sysoev.ru/nginx/ . +.Pa http://nginx.org/en/docs/ . .Pp For questions and technical support, please refer to .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. .Sh AUTHORS .An -nosplit -.An Igor Sysoev Aq igor@sysoev.ru +.An Igor Sysoev Aq igor@sysoev.ru . .Pp This manual page was written by .An Sergey A. Osokin Aq osa@FreeBSD.org.ru -as a result of compilation of many +as a result of compiling many .Nm -documents all over the world. +documents from all over the world.