Mercurial > hg > nginx-site

annotate xml/en/docs/switches.xml @ 3042:19e4897acb84

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Free nginx: removed marketing books.
author Maxim Dounin <mdounin@mdounin.ru>
date Wed, 14 Feb 2024 20:05:46 +0300
parents 2b71a9ef37c1
children
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"
2623
2b71a9ef37c1 Documented the "-e" command-line option.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1515
diff changeset
11 rev="4">
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>
2623
2b71a9ef37c1 Documented the "-e" command-line option.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1515
diff changeset
30 <literal>-e <value>file</value></literal>&mdash;use an alternative
2b71a9ef37c1 Documented the "-e" command-line option.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1515
diff changeset
31 error log <value>file</value> to store the log
2b71a9ef37c1 Documented the "-e" command-line option.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1515
diff changeset
32 instead of a default file (1.19.5).
2b71a9ef37c1 Documented the "-e" command-line option.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1515
diff changeset
33 The special value <literal>stderr</literal> selects the standard error file.
2b71a9ef37c1 Documented the "-e" command-line option.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1515
diff changeset
34 </listitem>
2b71a9ef37c1 Documented the "-e" command-line option.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1515
diff changeset
35
2b71a9ef37c1 Documented the "-e" command-line option.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1515
diff changeset
36 <listitem>
1331
7ac25c159209 Command-line parameters: empty spaces after &mdash; removed.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1328
diff changeset
37 <literal>-g <value>directives</value></literal>&mdash;set
1328
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
38 <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
39 for example,
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
40 <programlisting>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
41 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
42 </programlisting>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
43 </listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
44
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
45 <listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
46 <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
47 i.e. a directory that will keep server files
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
48 (default value is <value>/usr/local/nginx</value>).
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
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
51 <listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
52 <literal>-q</literal>&mdash;suppress non-error messages
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
53 during configuration testing.
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
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 <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
58 to the master process.
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
59 The argument <i>signal</i> can be one of:
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
60 <list type="bullet">
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
61 <listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
62 <literal>stop</literal>&mdash;shut down quickly
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
63 </listitem>
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 <literal>quit</literal>&mdash;shut down gracefully
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
66 </listitem>
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 <literal>reload</literal>&mdash;reload configuration,
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
69 start the new worker process with a new configuration,
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
70 gracefully shut down old worker processes.
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
71 </listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
72 <listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
73 <literal>reopen</literal>&mdash;reopen log files
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
74 </listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
75 </list>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
76 </listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
77
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
78 <listitem>
1331
7ac25c159209 Command-line parameters: empty spaces after &mdash; removed.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1328
diff changeset
79 <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
80 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
81 referred in the configuration.
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
82 </listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
83
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
84 <listitem>
1515
259a48800748 Documented the -T command-line parameter.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1397
diff changeset
85 <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
86 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
87 </listitem>
259a48800748 Documented the -T command-line parameter.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1397
diff changeset
88
259a48800748 Documented the -T command-line parameter.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1397
diff changeset
89 <listitem>
1328
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
90 <literal>-v</literal>&mdash;print nginx version.
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
91 </listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
92
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
93 <listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
94 <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
95 and configure parameters.
1328
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
96 </listitem>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
97
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
98 </list>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
99 </para>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
100
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
101 </section>
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
102
b35cdfabe949 Command-line parameters: English article added.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
103 </article>