[PATCH] Add nginx.conf(5)

Sergey A. Osokin osa at FreeBSD.org.ru
Sat Dec 7 19:12:12 UTC 2019


# HG changeset patch
# User Sergey A. Osokin <osa at FreeBSD.org.ru>
# Date 1575745926 -10800
#      Sat Dec 07 22:12:06 2019 +0300
# Node ID 4418dfeac658f1cf5ea7334b1bdf3084e2b1c7cd
# Parent  3939483cd1b56b202a99b1db344d9568b0958e67
Add nginx.conf(5).

diff -r 3939483cd1b5 -r 4418dfeac658 docs/man/nginx.conf.5
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/man/nginx.conf.5	Sat Dec 07 22:12:06 2019 +0300
@@ -0,0 +1,112 @@
+.\"
+.\" Copyright (C) 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.
+.\"
+.\"
+.Dd December 7, 2019
+.Dt NGINX.CONF 5
+.Os
+.Sh NAME
+.Nm nginx.conf
+.Nd "configuration file used by the"
+.Xr nginx 8
+.Sh DESCRIPTION
+.Nm
+is the configuration file used by the
+.Xr nginx 8 .
+.Pp
+The default location of this file is
+.Pa %%CONF_PATH%% .
+.Pp
+.Xr nginx 8
+consists of modules which are controlled by
+directives specified in the configuration file.
+Directives are divided into simple directives
+and block directives.
+A simple directive consists of the name and
+parameters separated by spaces and ends with a
+semicolon
+.Cm ;
+symbol.
+A block directive has the same structure as a
+simple directive, but instead of the semicolon
+it ends with a set of additional instructions
+surrounded by braces:
+.Cm {
+and
+.Cm }
+\&.
+If a block directive can have other directives
+inside braces, it is called a context (examples:
+.Cm events ,
+.Cm http ,
+.Cm server ,
+and
+.Cm location )
+\&.
+.Pp
+Directives placed in the configuration file
+outside of any contexts are considered to be in
+the main context.
+The
+.Cm events
+and
+.Cm http
+directives
+reside in the
+.Pa main
+context,
+.Cm server
+in
+.Pa http ,
+and
+.Cm location
+in
+.Pa server
+\&.
+.Pp
+The rest of a line after the
+.Cm #
+sign is considered a comment.
+.Sh EXAMPLES
+.Bd -literal -offset indent
+user www www;
+worker_processes 2;
+
+error_log /var/log/nginx-error.log info;
+
+events {
+    use kqueue;
+    worker_connections 2048;
+}
+\&...
+.Ed
+.Sh FILES
+%%CONF_PATH%%
+.Sh SEE ALSO
+.Xr nginx 8
+.Sh AUTHORS
+.An -nosplit
+.An Igor Sysoev Aq igor at sysoev.ru .


More information about the nginx-devel mailing list