annotate xml/en/docs/switches.xml @ 1878:127ae107e5a9

Removed clause about shared memory and Windows versions with ASLR. Starting with nginx 1.9.0 shared memory can be used on Windows versions with address space layout randomization.
author Maxim Dounin <mdounin@mdounin.ru>
date Mon, 26 Dec 2016 19:38:06 +0300
parents 259a48800748
children 2b71a9ef37c1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1328
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
1 <!--
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
2 Copyright (C) Igor Sysoev
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
3 Copyright (C) Nginx, Inc.
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
4 -->
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
5
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
6 <!DOCTYPE article SYSTEM "../../../dtd/article.dtd">
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
7
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
8 <article name="Command-line parameters"
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
9 link="/en/docs/switches.html"
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
10 lang="en"
1515
259a48800748 Documented the -T command-line parameter.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1397
diff changeset
11 rev="3">
1328
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
12
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
13 <section>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
14
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
15 <para>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
16 nginx supports the following command-line parameters:
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
17 <list type="bullet">
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
18
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
19 <listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
20 <literal>-?</literal> | <literal>-h</literal>&mdash;print help
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
21 for command-line parameters.
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
22 </listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
23
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
24 <listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
25 <literal>-c <value>file</value></literal>&mdash;use an alternative
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
26 configuration <value>file</value> instead of a default file.
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
27 </listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
28
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
29 <listitem>
1331
7ac25c159209 Command-line parameters: empty spaces after &mdash; removed.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1328
diff changeset
30 <literal>-g <value>directives</value></literal>&mdash;set
1328
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
31 <link doc="ngx_core_module.xml">global configuration directives</link>,
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
32 for example,
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
33 <programlisting>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
34 nginx -g "pid /var/run/nginx.pid; worker_processes `sysctl -n hw.ncpu`;"
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
35 </programlisting>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
36 </listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
37
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
38 <listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
39 <literal>-p <value>prefix</value></literal>&mdash;set nginx path prefix,
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
40 i.e. a directory that will keep server files
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
41 (default value is <value>/usr/local/nginx</value>).
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
42 </listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
43
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
44 <listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
45 <literal>-q</literal>&mdash;suppress non-error messages
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
46 during configuration testing.
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
47 </listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
48
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
49 <listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
50 <literal>-s <value>signal</value></literal>&mdash;send a <i>signal</i>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
51 to the master process.
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
52 The argument <i>signal</i> can be one of:
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
53 <list type="bullet">
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
54 <listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
55 <literal>stop</literal>&mdash;shut down quickly
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
56 </listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
57 <listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
58 <literal>quit</literal>&mdash;shut down gracefully
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
59 </listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
60 <listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
61 <literal>reload</literal>&mdash;reload configuration,
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
62 start the new worker process with a new configuration,
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
63 gracefully shut down old worker processes.
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
64 </listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
65 <listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
66 <literal>reopen</literal>&mdash;reopen log files
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
67 </listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
68 </list>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
69 </listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
70
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
71 <listitem>
1331
7ac25c159209 Command-line parameters: empty spaces after &mdash; removed.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1328
diff changeset
72 <literal>-t</literal>&mdash;test the configuration file: nginx checks the
1328
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
73 configuration for correct syntax, and then tries to open files
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
74 referred in the configuration.
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
75 </listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
76
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
77 <listitem>
1515
259a48800748 Documented the -T command-line parameter.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1397
diff changeset
78 <literal>-T</literal>&mdash;same as <literal>-t</literal>,
259a48800748 Documented the -T command-line parameter.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1397
diff changeset
79 but additionally dump configuration files to standard output (1.9.2).
259a48800748 Documented the -T command-line parameter.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1397
diff changeset
80 </listitem>
259a48800748 Documented the -T command-line parameter.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1397
diff changeset
81
259a48800748 Documented the -T command-line parameter.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1397
diff changeset
82 <listitem>
1328
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
83 <literal>-v</literal>&mdash;print nginx version.
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
84 </listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
85
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
86 <listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
87 <literal>-V</literal>&mdash;print nginx version, compiler version,
1397
7904b02a70c9 Russian letter leaked into English.
Ruslan Ermilov <ru@nginx.com>
parents: 1331
diff changeset
88 and configure parameters.
1328
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
89 </listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
90
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
91 </list>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
92 </para>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
93
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
94 </section>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
95
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
96 </article>