annotate xml/en/docs/syntax.xml @ 1840:15632fc2d548

Documented http and stream nginScript modules.
author Yaroslav Zhuravlev <yar@nginx.com>
date Fri, 18 Nov 2016 17:51:14 +0300
parents e1593207d1cb
children 2c14a16c61eb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
681
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
1 <!--
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
2 Copyright (C) Igor Sysoev
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
3 Copyright (C) Nginx, Inc.
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
4 -->
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
5
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
6 <!DOCTYPE article SYSTEM "../../../dtd/article.dtd">
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
7
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
8 <article name="Configuration file measurement units"
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
9 link="/en/docs/syntax.html"
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
10 lang="en"
735
e1593207d1cb Documented in more detail how time intervals are specified in nginx
Ruslan Ermilov <ru@nginx.com>
parents: 681
diff changeset
11 rev="3">
681
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
12
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
13 <section>
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
14
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
15 <para>
735
e1593207d1cb Documented in more detail how time intervals are specified in nginx
Ruslan Ermilov <ru@nginx.com>
parents: 681
diff changeset
16 Sizes can be specified in bytes, kilobytes
e1593207d1cb Documented in more detail how time intervals are specified in nginx
Ruslan Ermilov <ru@nginx.com>
parents: 681
diff changeset
17 (suffixes <literal>k</literal> and <literal>K</literal>) or megabytes
e1593207d1cb Documented in more detail how time intervals are specified in nginx
Ruslan Ermilov <ru@nginx.com>
parents: 681
diff changeset
18 (suffixes <literal>m</literal> and <literal>M</literal>), for example,
e1593207d1cb Documented in more detail how time intervals are specified in nginx
Ruslan Ermilov <ru@nginx.com>
parents: 681
diff changeset
19 “<literal>1024</literal>”, “<literal>8k</literal>”, “<literal>1m</literal>”.
681
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
20 </para>
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
21
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
22 <para>
735
e1593207d1cb Documented in more detail how time intervals are specified in nginx
Ruslan Ermilov <ru@nginx.com>
parents: 681
diff changeset
23 Time intervals can be specified in milliseconds, seconds,
e1593207d1cb Documented in more detail how time intervals are specified in nginx
Ruslan Ermilov <ru@nginx.com>
parents: 681
diff changeset
24 minutes, hours, days and so on, using the following suffixes:
681
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
25 <table width="30%">
735
e1593207d1cb Documented in more detail how time intervals are specified in nginx
Ruslan Ermilov <ru@nginx.com>
parents: 681
diff changeset
26 <tr><td width="20%">ms</td><td>milliseconds</td></tr>
681
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
27 <tr><td width="20%">s</td><td>seconds</td></tr>
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
28 <tr><td width="20%">m</td><td>minutes</td></tr>
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
29 <tr><td width="20%">h</td><td>hours</td></tr>
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
30 <tr><td width="20%">d</td><td>days</td></tr>
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
31 <tr><td width="20%">w</td><td>weeks</td></tr>
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
32 <tr><td width="20%">M</td><td>months, 30 days</td></tr>
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
33 <tr><td width="20%">y</td><td>years, 365 days</td></tr>
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
34 </table>
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
35 </para>
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
36
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
37 <para>
735
e1593207d1cb Documented in more detail how time intervals are specified in nginx
Ruslan Ermilov <ru@nginx.com>
parents: 681
diff changeset
38 Multiple units can be combined in a single value
e1593207d1cb Documented in more detail how time intervals are specified in nginx
Ruslan Ermilov <ru@nginx.com>
parents: 681
diff changeset
39 by specifying them in the order from the most to the least significant,
e1593207d1cb Documented in more detail how time intervals are specified in nginx
Ruslan Ermilov <ru@nginx.com>
parents: 681
diff changeset
40 and optionally separated by whitespace.
e1593207d1cb Documented in more detail how time intervals are specified in nginx
Ruslan Ermilov <ru@nginx.com>
parents: 681
diff changeset
41 For example, “<literal>1h 30m</literal>” specifies the same time
e1593207d1cb Documented in more detail how time intervals are specified in nginx
Ruslan Ermilov <ru@nginx.com>
parents: 681
diff changeset
42 as “<literal>90m</literal>” or “<literal>5400s</literal>”.
e1593207d1cb Documented in more detail how time intervals are specified in nginx
Ruslan Ermilov <ru@nginx.com>
parents: 681
diff changeset
43 A value without a suffix means seconds.
e1593207d1cb Documented in more detail how time intervals are specified in nginx
Ruslan Ermilov <ru@nginx.com>
parents: 681
diff changeset
44 It is recommended to always specify a suffix.
e1593207d1cb Documented in more detail how time intervals are specified in nginx
Ruslan Ermilov <ru@nginx.com>
parents: 681
diff changeset
45 </para>
e1593207d1cb Documented in more detail how time intervals are specified in nginx
Ruslan Ermilov <ru@nginx.com>
parents: 681
diff changeset
46
e1593207d1cb Documented in more detail how time intervals are specified in nginx
Ruslan Ermilov <ru@nginx.com>
parents: 681
diff changeset
47 <para>
e1593207d1cb Documented in more detail how time intervals are specified in nginx
Ruslan Ermilov <ru@nginx.com>
parents: 681
diff changeset
48 Some of the time intervals can be specified only with a seconds resolution.
681
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
49 </para>
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
50
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
51 </section>
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
52
67826df692cc Translated 'syntax' article into English and gave it a better name.
Vladimir Homutov <vl@nginx.com>
parents:
diff changeset
53 </article>