annotate 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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
580
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 486
diff changeset
1 <!--
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 486
diff changeset
2 Copyright (C) Igor Sysoev
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 486
diff changeset
3 Copyright (C) Nginx, Inc.
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 486
diff changeset
4 -->
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 486
diff changeset
5
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
6 <!DOCTYPE article SYSTEM "../../../dtd/article.dtd">
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
7
924
a2aea48ff155 New "installation" article.
Ruslan Ermilov <ru@nginx.com>
parents: 858
diff changeset
8 <article name="Building nginx from Sources"
a2aea48ff155 New "installation" article.
Ruslan Ermilov <ru@nginx.com>
parents: 858
diff changeset
9 link="/en/docs/configure.html"
589
764fbac1b8b4 Added document revision.
Ruslan Ermilov <ru@nginx.com>
parents: 580
diff changeset
10 lang="en"
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
11 rev="12">
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
12
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
13 <section>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
14
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
15 <para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
16 The build is configured using the <command>configure</command> command.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
17 It defines various aspects of the system, including the methods nginx
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
18 is allowed to use for connection processing.
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
19 At the end it creates a <path>Makefile</path>.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
20 The <command>configure</command> command supports the following parameters:
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
21 <list type="tag">
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
22
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
23 <tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
24 <literal>--prefix=<value>path</value></literal>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
25 </tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
26 <tag-desc>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
27 defines a directory that will keep server files.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
28 This same directory will also be used for all relative paths set by
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
29 <command>configure</command> (except for paths to libraries sources)
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
30 and in the <path>nginx.conf</path> configuration file.
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
31 It is set to the <path>/usr/local/nginx</path> directory by default.
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
32 </tag-desc>
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
33
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
34 <tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
35 <literal>--sbin-path=<value>path</value></literal>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
36 </tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
37 <tag-desc>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
38 sets the name of an nginx executable file.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
39 This name is used only during installation.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
40 By default the file is named
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
41 <path><value>prefix</value>/sbin/nginx</path>.
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
42 </tag-desc>
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
43
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
44 <tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
45 <literal>--conf-path=<value>path</value></literal>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
46 </tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
47 <tag-desc>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
48 sets the name of an <path>nginx.conf</path> configuration file.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
49 If needs be, nginx can always be started with a different configuration file,
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
50 by specifying it in the command-line parameter
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
51 <nobr><literal>-c <value>file</value></literal></nobr>.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
52 By default the file is named
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
53 <path><value>prefix</value>/conf/nginx.conf</path>.
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
54 </tag-desc>
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
55
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
56 <tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
57 <literal>--pid-path=<value>path</value></literal>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
58 </tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
59 <tag-desc>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
60 sets the name of an nginx.pid file that will store the process ID
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
61 of the main process.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
62 After installation, the file name can always be changed in the
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
63 <path>nginx.conf</path> configuration file using the
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
64 <link doc="ngx_core_module.xml" id="pid"/> directive.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
65 By default the file is named
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
66 <path><value>prefix</value>/logs/nginx.pid</path>.
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
67 </tag-desc>
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
68
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
69 <tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
70 <literal>--error-log-path=<value>path</value></literal>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
71 </tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
72 <tag-desc>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
73 sets the name of the primary error, warnings, and diagnostic file.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
74 After installation, the file name can always be changed in the
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
75 <path>nginx.conf</path> configuration file using the
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
76 <link doc="ngx_core_module.xml" id="error_log"/> directive.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
77 By default the file is named
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
78 <path><value>prefix</value>/logs/error.log</path>.
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
79 </tag-desc>
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
80
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
81 <tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
82 <literal>--http-log-path=<value>path</value></literal>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
83 </tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
84 <tag-desc>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
85 sets the name of the primary request log file of the HTTP server.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
86 After installation, the file name can always be changed in the
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
87 <path>nginx.conf</path> configuration file using the
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
88 <link doc="http/ngx_http_log_module.xml" id="access_log"/> directive.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
89 By default the file is named
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
90 <path><value>prefix</value>/logs/access.log</path>.
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
91 </tag-desc>
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
92
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
93 <tag-name id="build">
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
94 <literal>--build=<value>name</value></literal>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
95 </tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
96 <tag-desc>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
97 sets an optional nginx build name.
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
98 </tag-desc>
1952
3be7279397c8 Documented the "build" parameter of the "configure" command.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1894
diff changeset
99
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
100 <tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
101 <literal>--user=<value>name</value></literal>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
102 </tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
103 <tag-desc>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
104 sets the name of an unprivileged user whose credentials will be used
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
105 by worker processes.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
106 After installation, the name can always be changed in the
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
107 <path>nginx.conf</path> configuration file using the
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
108 <link doc="ngx_core_module.xml" id="user"/> directive.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
109 The default user name is nobody.
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
110 </tag-desc>
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
111
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
112 <tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
113 <literal>--group=<value>name</value></literal>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
114 </tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
115 <tag-desc>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
116 sets the name of a group whose credentials will be used
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
117 by worker processes.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
118 After installation, the name can always be changed in the
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
119 <path>nginx.conf</path> configuration file using the
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
120 <link doc="ngx_core_module.xml" id="user"/> directive.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
121 By default, a group name is set to the name of an unprivileged user.
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
122 </tag-desc>
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
123
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
124 <tag-name>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
125 <literal>--with-select_module</literal><br/>
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
126 <literal>--without-select_module</literal>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
127 </tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
128 <tag-desc>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
129 enables or disables building a module that allows the server to work
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
130 with the <c-func>select</c-func> method.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
131 This module is built automatically if the platform does not appear
1465
eea7541e7c6a Removed "rtsig" and "worker_rlimit_sigpending".
Ruslan Ermilov <ru@nginx.com>
parents: 924
diff changeset
132 to support more appropriate methods such as kqueue, epoll, or /dev/poll.
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
133 </tag-desc>
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
134
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
135 <tag-name>
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
136 <literal>--with-poll_module</literal><br/>
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
137 <literal>--without-poll_module</literal>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
138 </tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
139 <tag-desc>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
140 enables or disables building a module that allows the server to work
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
141 with the <c-func>poll</c-func> method.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
142 This module is built automatically if the platform does not appear
1465
eea7541e7c6a Removed "rtsig" and "worker_rlimit_sigpending".
Ruslan Ermilov <ru@nginx.com>
parents: 924
diff changeset
143 to support more appropriate methods such as kqueue, epoll, or /dev/poll.
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
144 </tag-desc>
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
145
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
146 <tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
147 <literal>--without-http_gzip_module</literal>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
148 </tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
149 <tag-desc>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
150 disables building a module
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
151 that <link doc="http/ngx_http_gzip_module.xml">compresses responses</link>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
152 of an HTTP server.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
153 The zlib library is required to build and run this module.
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
154 </tag-desc>
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
155
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
156 <tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
157 <literal>--without-http_rewrite_module</literal>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
158 </tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
159 <tag-desc>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
160 disables building a module that allows an HTTP server to
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
161 <link doc="http/ngx_http_rewrite_module.xml">redirect requests and change URI
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
162 of requests</link>.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
163 The PCRE library is required to build and run this module.
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
164 </tag-desc>
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
165
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
166 <tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
167 <literal>--without-http_proxy_module</literal>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
168 </tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
169 <tag-desc>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
170 disables building an HTTP server
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
171 <link doc="http/ngx_http_proxy_module.xml">proxying module</link>.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
172 <!--
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
173 The MD5 library is required to build and run this module.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
174 -->
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
175 </tag-desc>
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
176
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
177 <tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
178 <literal>--with-http_ssl_module</literal>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
179 </tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
180 <tag-desc>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
181 enables building a module that adds the
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
182 <link doc="http/ngx_http_ssl_module.xml">HTTPS protocol support</link>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
183 to an HTTP server.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
184 This module is not built by default.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
185 The OpenSSL library is required to build and run this module.
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
186 </tag-desc>
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
187
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
188 <tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
189 <literal>--with-pcre=<value>path</value></literal>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
190 </tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
191 <tag-desc>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
192 sets the path to the sources of the PCRE library.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
193 The library distribution (version
2043
7d9c836d14bf Updated PCRE version in "Building nginx".
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2018
diff changeset
194 4.4&mdash;8.41) needs to be downloaded from the
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
195 <link url="http://www.pcre.org">PCRE</link> site and extracted.
924
a2aea48ff155 New "installation" article.
Ruslan Ermilov <ru@nginx.com>
parents: 858
diff changeset
196 The rest is done by nginx’s <command>./configure</command> and
a2aea48ff155 New "installation" article.
Ruslan Ermilov <ru@nginx.com>
parents: 858
diff changeset
197 <command>make</command>.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
198 The library is required for regular expressions support in the
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
199 <link doc="http/ngx_http_core_module.xml" id="location"/> directive
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
200 and for the
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
201 <link doc="http/ngx_http_rewrite_module.xml">ngx_http_rewrite_module</link>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
202 module.
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
203 </tag-desc>
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
204
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
205 <tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
206 <literal>--with-pcre-jit</literal>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
207 </tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
208 <tag-desc>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
209 builds the PCRE library with
659
77a3314c74a7 Avoid the uses of second person.
Ruslan Ermilov <ru@nginx.com>
parents: 625
diff changeset
210 “just-in-time compilation” support (1.1.12, the
77a3314c74a7 Avoid the uses of second person.
Ruslan Ermilov <ru@nginx.com>
parents: 625
diff changeset
211 <link doc="ngx_core_module.xml" id="pcre_jit"/> directive).
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
212 </tag-desc>
289
df261b1ce71f Documented the --with-pcre-jit configuration parameter
Ruslan Ermilov <ru@nginx.com>
parents: 282
diff changeset
213
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
214 <tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
215 <literal>--with-zlib=<value>path</value></literal>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
216 </tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
217 <tag-desc>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
218 sets the path to the sources of the zlib library.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
219 The library distribution (version
1894
d011ffde3760 Updated zlib and PCRE versions.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1749
diff changeset
220 1.1.3&mdash;1.2.11) needs to be downloaded from the
858
65e75e59a714 Updated versions of external libraries and link to zlib site.
Valentin Bartenev <vbart@nginx.com>
parents: 732
diff changeset
221 <link url="http://zlib.net">zlib</link> site and extracted.
924
a2aea48ff155 New "installation" article.
Ruslan Ermilov <ru@nginx.com>
parents: 858
diff changeset
222 The rest is done by nginx’s <command>./configure</command> and
a2aea48ff155 New "installation" article.
Ruslan Ermilov <ru@nginx.com>
parents: 858
diff changeset
223 <command>make</command>.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
224 The library is required for the
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
225 <link doc="http/ngx_http_gzip_module.xml">ngx_http_gzip_module</link> module.
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
226 </tag-desc>
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
227
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
228 <tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
229 <literal>--with-cc-opt=<value>parameters</value></literal>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
230 </tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
231 <tag-desc>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
232 sets additional parameters that will be added to the CFLAGS variable.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
233 When using the system PCRE library under FreeBSD,
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
234 <literal>--with-cc-opt="-I /usr/local/include"</literal>
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
235 should be specified.
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
236 If the number of files supported by <c-func>select</c-func> needs to be
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
237 increased it can also be specified here such as this:
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
238 <literal>--with-cc-opt="-D FD_SETSIZE=2048"</literal>.
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
239 </tag-desc>
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
240
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
241 <tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
242 <literal>--with-ld-opt=<value>parameters</value></literal>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
243 </tag-name>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
244 <tag-desc>
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
245 sets additional parameters that will be used during linking.
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
246 When using the system PCRE library under FreeBSD,
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 264
diff changeset
247 <literal>--with-ld-opt="-L /usr/local/lib"</literal>
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
248 should be specified.
2154
ebc9fb8139e4 Reworked configure description to use tag list.
Maxim Dounin <mdounin@mdounin.ru>
parents: 2043
diff changeset
249 </tag-desc>
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
250
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
251 </list>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
252
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
253 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
254
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
255 <para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
256 Example of parameters usage (all of this needs to be typed in one line):
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
257 <programlisting>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
258 ./configure
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
259 --sbin-path=/usr/local/nginx/nginx
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
260 --conf-path=/usr/local/nginx/nginx.conf
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
261 --pid-path=/usr/local/nginx/nginx.pid
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
262 --with-http_ssl_module
2018
7ee425a5ae29 Updated PCRE version.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1952
diff changeset
263 --with-pcre=../pcre-8.41
1894
d011ffde3760 Updated zlib and PCRE versions.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1749
diff changeset
264 --with-zlib=../zlib-1.2.11
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
265 </programlisting>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
266 </para>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
267
924
a2aea48ff155 New "installation" article.
Ruslan Ermilov <ru@nginx.com>
parents: 858
diff changeset
268 <para>
a2aea48ff155 New "installation" article.
Ruslan Ermilov <ru@nginx.com>
parents: 858
diff changeset
269 After configuration,
a2aea48ff155 New "installation" article.
Ruslan Ermilov <ru@nginx.com>
parents: 858
diff changeset
270 nginx is compiled and installed using <command>make</command>.
a2aea48ff155 New "installation" article.
Ruslan Ermilov <ru@nginx.com>
parents: 858
diff changeset
271 </para>
a2aea48ff155 New "installation" article.
Ruslan Ermilov <ru@nginx.com>
parents: 858
diff changeset
272
263
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
273 </section>
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
274
be3772a799a2 English translation of "Installing nginx".
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
275 </article>