.\"
.\" Copyright (C) 2010, 2019 Sergey A. Osokin
.\" Copyright (C) Nginx, Inc.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"
.\"*******************************************************************
.\"
.\" This file was generated with po4a. Translate the source file.
.\"
.\"*******************************************************************
.\"
.\" translated for 1.21.6, 2022-05-07 ribbon <ribbon@users.osdn.me>
.\"
.Dd 2020/11/05
.Dt NGINX 8
.Os
.Sh 名前
.Nm nginx
.Nd "HTTP およびリバースプロキシーサーバー、メールプロキシーサーバー"
.Sh 書式
.Nm
.Op Fl ?hqTtVv
.Op Fl c Ar file
.Op Fl e Ar file
.Op Fl g Ar directives
.Op Fl p Ar prefix
.Op Fl s Ar signal
.Sh 説明
.Nm
(発音は
.Dq engine x )
は、 HTTP およびリバースプロキシーサーバー、 メールプロキシーサーバー、汎用的な
TCP/UDP プロキシーサーバーです。 高性能、安定性、豊富な機能セット、簡単な設定、リソースの低消費という特徴が知られています。
.Pp
オプションは以下のとおりです。
.Bl -tag -width ".Fl d Ar directives"
.It Fl ?\& , h
ヘルプを表示します。
.It Fl c Ar file
別の設定ファイルとして
.Ar file
を用います。
.It Fl e Ar file
別のエラーログとして
.Ar file
を用います。 特別な設定値
.Cm stderr
があって、 これは標準エラーへの出力が行われます。
.It Fl g Ar directives
グローバル設定ディレクティブを設定します。
.Sx 例
のセクションを参照してください。
.It Fl p Ar prefix
プレフィックスパスを設定します。デフォルトは
.Pa /usr
です。
.It Fl q
設定テストを行う際、 エラーではないメッセージは省略します。
.It Fl s Ar signal
マスタープロセスにシグナルを送信します。 引数
.Ar signal
には、
.Cm stop , quit , reopen , reload
のいずれかを指定します。 以下に示す一覧は、 これに対応するシステムシグナルです。
.Pp
.Bl -tag -width ".Cm reopen" -compact
.It Cm stop
.Dv SIGTERM
.It Cm quit
.Dv SIGQUIT
.It Cm reopen
.Dv SIGUSR1
.It Cm reload
.Dv SIGHUP
.El
.It Fl T
.Fl t
と同様です。 ただしこれに加えて、 設定ファイル内容を標準出力に書き出します。
.It Fl t
実行は行わずに、 設定ファイルのテストだけを行います。
.Nm
は、 設定ファイルの文法チェックを行い、
設定ファイル内から参照されているファイルの読み込みを試します。
.It Fl V
.Nm
のバージョン、 コンパイラーバージョン、
.Pa configure
スクリプトのパラメーターを表示します。
.It Fl v
.Nm
のバージョンを表示します。
.El
.Sh シグナル
.Nm
のマスタープロセスは、 以下のシグナルを取り扱います。
.Pp
.Bl -tag -width ".Dv SIGINT , SIGTERM" -compact
.It Dv SIGINT , SIGTERM
すぐにシャットダウンします。
.It Dv SIGHUP
設定を再ロードして、 新たな設定を用いた新たなワーカープロセスを起動します。 そして古いワーカープロセスは、 適切にシャットダウンします。
.It Dv SIGQUIT
適切にシャットダウンします。
.It Dv SIGUSR1
ログファイルを開き直します。
.It Dv SIGUSR2
.Nm
実行ファイルをその場でアップグレードします。
.It Dv SIGWINCH
ワーカープロセスを適切にシャットダウンします。
.El
.Pp
ワーカープロセスに対して、 通常の制御を明示的に行う必要がない場合には、 さらに以下のシグナルもサポートしています。
.Pp
.Bl -tag -width ".Dv SIGINT , SIGTERM" -compact
.It Dv SIGTERM
すぐにシャットダウンします。
.It Dv SIGQUIT
適切にシャットダウンします。
.It Dv SIGUSR1
ログファイルを開き直します。
.El
.Sh デバッグログ
デバッグログを有効にするには、 デバッグ機能が含まれるように
.Nm
ビルドを再構成します。
.Pp
.Dl "./configure --with-debug ..."
.Pp
そして
.Va error_log
のログレベルを
.Cm debug
に設定します。
.Pp
.Dl "error_log /path/to/log debug;"
.Pp
特定の IP アドレスに対して、 デバッグを有効にすることもできます。
.Bd -literal -offset indent
events {
	debug_connection 127.0.0.1;
}
.Ed
.Sh 環境変数
環境変数
.Ev NGINX
は、
.Nm
が内部で利用しています。 これはユーザーが直接設定するものではありません。
.Sh ファイル
.Bl -tag -width indent
.It Pa /var/run/nginx.pid
.Nm
のプロセス ID を保持します。 このファイルの内容は機密情報ではないため、 だれでも見ることができます (world-readable
です)。
.It Pa /etc/nginx/nginx.conf
メインの設定ファイル。
.It Pa /var/log/error.log
エラーログファイル。
.El
.Sh 終了ステータス
終了ステータスは、 正常処理時に 0、 処理失敗時に 1 です。
.Sh 例
テストの設定ファイルとして
.Pa ~/mynginx.conf
を指定します。 そして PID に対するグローバルディレクティブを用いて、
ワーカープロセス量を設定します。
.Bd -literal -offset indent
nginx -t -c ~/mynginx.conf \e
	-g "pid /var/run/mynginx.pid; worker_processes 2;"
.Ed
.Sh 関連項目
.\"Xr nginx.conf 5
.\"Pp
ドキュメント:
.Pa http://nginx.org/en/docs/
.Pp
疑問や技術サポートの必要がある場合は、
.Pa http://nginx.org/en/support.html
に問い合わせてください。
.Sh 開発経緯
.Nm
の開発は 2002 年に開始しました。 初めての公開版は 2004 年 10 月 4 日にリリースしています。
.Sh 著者
.An -nosplit
.An Igor Sysoev Aq Mt igor@sysoev.ru
.Pp
このマニュアルページは、 もともとは
.An Sergey A. Osokin Aq Mt osa@FreeBSD.org.ru
が、
世界中から寄せられた
.Nm
のドキュメントを取りまとめた結果として記述しました。