Mercurial > hg > nginx-site
diff xml/en/docs/configure.xml @ 2154:ebc9fb8139e4
Reworked configure description to use tag list.
author | Maxim Dounin <mdounin@mdounin.ru> |
---|---|
date | Mon, 23 Apr 2018 21:41:03 +0300 |
parents | 7d9c836d14bf |
children | fd06f014e6db |
line wrap: on
line diff
--- a/xml/en/docs/configure.xml +++ b/xml/en/docs/configure.xml @@ -8,7 +8,7 @@ <article name="Building nginx from Sources" link="/en/docs/configure.html" lang="en" - rev="11"> + rev="12"> <section> @@ -18,174 +18,178 @@ It defines various aspects of the system is allowed to use for connection processing. At the end it creates a <path>Makefile</path>. The <command>configure</command> command supports the following parameters: -<list type="bullet"> +<list type="tag"> -<listitem> -<para> -<literal>--prefix=<value>path</value></literal>—defines -a directory that will keep server files. +<tag-name> +<literal>--prefix=<value>path</value></literal> +</tag-name> +<tag-desc> +defines a directory that will keep server files. This same directory will also be used for all relative paths set by <command>configure</command> (except for paths to libraries sources) and in the <path>nginx.conf</path> configuration file. It is set to the <path>/usr/local/nginx</path> directory by default. -</para> -</listitem> +</tag-desc> -<listitem> -<para> -<literal>--sbin-path=<value>path</value></literal>—sets -the name of an nginx executable file. +<tag-name> +<literal>--sbin-path=<value>path</value></literal> +</tag-name> +<tag-desc> +sets the name of an nginx executable file. This name is used only during installation. By default the file is named <path><value>prefix</value>/sbin/nginx</path>. -</para> -</listitem> +</tag-desc> -<listitem> -<para> -<literal>--conf-path=<value>path</value></literal>—sets -the name of an <path>nginx.conf</path> configuration file. +<tag-name> +<literal>--conf-path=<value>path</value></literal> +</tag-name> +<tag-desc> +sets the name of an <path>nginx.conf</path> configuration file. If needs be, nginx can always be started with a different configuration file, by specifying it in the command-line parameter <nobr><literal>-c <value>file</value></literal></nobr>. By default the file is named <path><value>prefix</value>/conf/nginx.conf</path>. -</para> -</listitem> +</tag-desc> -<listitem> -<para> -<literal>--pid-path=<value>path</value></literal>—sets -the name of an nginx.pid file that will store the process ID +<tag-name> +<literal>--pid-path=<value>path</value></literal> +</tag-name> +<tag-desc> +sets the name of an nginx.pid file that will store the process ID of the main process. After installation, the file name can always be changed in the <path>nginx.conf</path> configuration file using the <link doc="ngx_core_module.xml" id="pid"/> directive. By default the file is named <path><value>prefix</value>/logs/nginx.pid</path>. -</para> -</listitem> +</tag-desc> -<listitem> -<para> -<literal>--error-log-path=<value>path</value></literal>—sets -the name of the primary error, warnings, and diagnostic file. +<tag-name> +<literal>--error-log-path=<value>path</value></literal> +</tag-name> +<tag-desc> +sets the name of the primary error, warnings, and diagnostic file. After installation, the file name can always be changed in the <path>nginx.conf</path> configuration file using the <link doc="ngx_core_module.xml" id="error_log"/> directive. By default the file is named <path><value>prefix</value>/logs/error.log</path>. -</para> -</listitem> +</tag-desc> -<listitem> -<para> -<literal>--http-log-path=<value>path</value></literal>—sets -the name of the primary request log file of the HTTP server. +<tag-name> +<literal>--http-log-path=<value>path</value></literal> +</tag-name> +<tag-desc> +sets the name of the primary request log file of the HTTP server. After installation, the file name can always be changed in the <path>nginx.conf</path> configuration file using the <link doc="http/ngx_http_log_module.xml" id="access_log"/> directive. By default the file is named <path><value>prefix</value>/logs/access.log</path>. -</para> -</listitem> +</tag-desc> -<listitem id="build"> -<para> -<literal>--build=<value>name</value></literal>—sets -an optional nginx build name. -</para> -</listitem> +<tag-name id="build"> +<literal>--build=<value>name</value></literal> +</tag-name> +<tag-desc> +sets an optional nginx build name. +</tag-desc> -<listitem> -<para> -<literal>--user=<value>name</value></literal>—sets -the name of an unprivileged user whose credentials will be used +<tag-name> +<literal>--user=<value>name</value></literal> +</tag-name> +<tag-desc> +sets the name of an unprivileged user whose credentials will be used by worker processes. After installation, the name can always be changed in the <path>nginx.conf</path> configuration file using the <link doc="ngx_core_module.xml" id="user"/> directive. The default user name is nobody. -</para> -</listitem> +</tag-desc> -<listitem> -<para> -<literal>--group=<value>name</value></literal>—sets -the name of a group whose credentials will be used +<tag-name> +<literal>--group=<value>name</value></literal> +</tag-name> +<tag-desc> +sets the name of a group whose credentials will be used by worker processes. After installation, the name can always be changed in the <path>nginx.conf</path> configuration file using the <link doc="ngx_core_module.xml" id="user"/> directive. By default, a group name is set to the name of an unprivileged user. -</para> -</listitem> +</tag-desc> -<listitem> -<para> +<tag-name> <literal>--with-select_module</literal><br/> -<literal>--without-select_module</literal>—enables or disables -building a module that allows the server to work with the -<c-func>select</c-func> method. +<literal>--without-select_module</literal> +</tag-name> +<tag-desc> +enables or disables building a module that allows the server to work +with the <c-func>select</c-func> method. This module is built automatically if the platform does not appear to support more appropriate methods such as kqueue, epoll, or /dev/poll. -</para> -</listitem> +</tag-desc> -<listitem> -<para> +<tag-name> <literal>--with-poll_module</literal><br/> -<literal>--without-poll_module</literal>—enables or disables -building a module that allows the server to work with the -<c-func>poll</c-func> method. +<literal>--without-poll_module</literal> +</tag-name> +<tag-desc> +enables or disables building a module that allows the server to work +with the <c-func>poll</c-func> method. This module is built automatically if the platform does not appear to support more appropriate methods such as kqueue, epoll, or /dev/poll. -</para> -</listitem> +</tag-desc> -<listitem> -<para> -<literal>--without-http_gzip_module</literal>—disables building a module +<tag-name> +<literal>--without-http_gzip_module</literal> +</tag-name> +<tag-desc> +disables building a module that <link doc="http/ngx_http_gzip_module.xml">compresses responses</link> of an HTTP server. The zlib library is required to build and run this module. -</para> -</listitem> +</tag-desc> -<listitem> -<para> -<literal>--without-http_rewrite_module</literal>—disables building a -module that allows an HTTP server to +<tag-name> +<literal>--without-http_rewrite_module</literal> +</tag-name> +<tag-desc> +disables building a module that allows an HTTP server to <link doc="http/ngx_http_rewrite_module.xml">redirect requests and change URI of requests</link>. The PCRE library is required to build and run this module. -</para> -</listitem> +</tag-desc> -<listitem> -<para> -<literal>--without-http_proxy_module</literal>—disables building an -HTTP server <link doc="http/ngx_http_proxy_module.xml">proxying module</link>. +<tag-name> +<literal>--without-http_proxy_module</literal> +</tag-name> +<tag-desc> +disables building an HTTP server +<link doc="http/ngx_http_proxy_module.xml">proxying module</link>. <!-- The MD5 library is required to build and run this module. --> -</para> -</listitem> +</tag-desc> -<listitem> -<para> -<literal>--with-http_ssl_module</literal>—enables building a module -that adds the <link doc="http/ngx_http_ssl_module.xml">HTTPS protocol -support</link> to an HTTP server. +<tag-name> +<literal>--with-http_ssl_module</literal> +</tag-name> +<tag-desc> +enables building a module that adds the +<link doc="http/ngx_http_ssl_module.xml">HTTPS protocol support</link> +to an HTTP server. This module is not built by default. The OpenSSL library is required to build and run this module. -</para> -</listitem> +</tag-desc> -<listitem> -<para> -<literal>--with-pcre=<value>path</value></literal>—sets -the path to the sources of the PCRE library. +<tag-name> +<literal>--with-pcre=<value>path</value></literal> +</tag-name> +<tag-desc> +sets the path to the sources of the PCRE library. The library distribution (version 4.4—8.41) needs to be downloaded from the <link url="http://www.pcre.org">PCRE</link> site and extracted. @@ -196,21 +200,22 @@ The library is required for regular expr and for the <link doc="http/ngx_http_rewrite_module.xml">ngx_http_rewrite_module</link> module. -</para> -</listitem> +</tag-desc> -<listitem> -<para> -<literal>--with-pcre-jit</literal>—builds the PCRE library with +<tag-name> +<literal>--with-pcre-jit</literal> +</tag-name> +<tag-desc> +builds the PCRE library with “just-in-time compilation” support (1.1.12, the <link doc="ngx_core_module.xml" id="pcre_jit"/> directive). -</para> -</listitem> +</tag-desc> -<listitem> -<para> -<literal>--with-zlib=<value>path</value></literal>—sets -the path to the sources of the zlib library. +<tag-name> +<literal>--with-zlib=<value>path</value></literal> +</tag-name> +<tag-desc> +sets the path to the sources of the zlib library. The library distribution (version 1.1.3—1.2.11) needs to be downloaded from the <link url="http://zlib.net">zlib</link> site and extracted. @@ -218,31 +223,30 @@ The rest is done by nginx’s <command>./configure</command> and <command>make</command>. The library is required for the <link doc="http/ngx_http_gzip_module.xml">ngx_http_gzip_module</link> module. -</para> -</listitem> +</tag-desc> -<listitem> -<para> -<literal>--with-cc-opt=<value>parameters</value></literal>—sets -additional parameters that will be added to the CFLAGS variable. +<tag-name> +<literal>--with-cc-opt=<value>parameters</value></literal> +</tag-name> +<tag-desc> +sets additional parameters that will be added to the CFLAGS variable. When using the system PCRE library under FreeBSD, <literal>--with-cc-opt="-I /usr/local/include"</literal> should be specified. If the number of files supported by <c-func>select</c-func> needs to be increased it can also be specified here such as this: <literal>--with-cc-opt="-D FD_SETSIZE=2048"</literal>. -</para> -</listitem> +</tag-desc> -<listitem> -<para> -<literal>--with-ld-opt=<value>parameters</value></literal>—sets -additional parameters that will be used during linking. +<tag-name> +<literal>--with-ld-opt=<value>parameters</value></literal> +</tag-name> +<tag-desc> +sets additional parameters that will be used during linking. When using the system PCRE library under FreeBSD, <literal>--with-ld-opt="-L /usr/local/lib"</literal> should be specified. -</para> -</listitem> +</tag-desc> </list>