comparison xml/en/docs/mail/ngx_mail_core_module.xml @ 966:95c3c3bbf1ce

Text review.
author Egor Nikitin <yegor.nikitin@gmail.com>
date Wed, 14 Aug 2013 12:03:41 +0400
parents a2aea48ff155
children b81ad8234f90
comparison
equal deleted inserted replaced
965:fadccc156188 966:95c3c3bbf1ce
76 [<literal>bind</literal>]</syntax> 76 [<literal>bind</literal>]</syntax>
77 <default/> 77 <default/>
78 <context>server</context> 78 <context>server</context>
79 79
80 <para> 80 <para>
81 Sets an <value>address</value> and a <value>port</value> for a socket, 81 Sets the <value>address</value> and <value>port</value> for the socket
82 on which the server will accept requests. 82 on which the server will accept requests.
83 Only port may be specified. 83 It is possible to specify just the port.
84 An address may also be a hostname, for example: 84 The address can also be a hostname, for example:
85 <example> 85 <example>
86 listen 127.0.0.1:110; 86 listen 127.0.0.1:110;
87 listen *:110; 87 listen *:110;
88 listen 110; # same as *:110 88 listen 110; # same as *:110
89 listen localhost:110; 89 listen localhost:110;
103 103
104 <para> 104 <para>
105 The optional <literal>bind</literal> parameter 105 The optional <literal>bind</literal> parameter
106 instructs to make a separate <c-func>bind</c-func> 106 instructs to make a separate <c-func>bind</c-func>
107 call for a given address:port pair. 107 call for a given address:port pair.
108 The fact is that nginx will <c-func>bind</c-func> only to 108 The fact is that if there are several <literal>listen</literal> directives with
109 <literal>*:</literal><value>port</value>
110 if there are several <literal>listen</literal> directives with
111 the same port but different addresses, and one of the 109 the same port but different addresses, and one of the
112 <literal>listen</literal> directives listens on all addresses 110 <literal>listen</literal> directives listens on all addresses
113 for the given port (<literal>*:</literal><value>port</value>). 111 for the given port (<literal>*:</literal><value>port</value>), nginx will
112 <c-func>bind</c-func> only to <literal>*:</literal><value>port</value>.
114 It should be noted that the <c-func>getsockname</c-func> system call will be 113 It should be noted that the <c-func>getsockname</c-func> system call will be
115 made in this case to determine an address that accepted a connection. 114 made in this case to determine the address that accepted the connection.
116 </para> 115 </para>
117 116
118 <para> 117 <para>
119 Different servers must listen on different 118 Different servers must listen on different
120 <value>address</value>:<value>port</value> pairs. 119 <value>address</value>:<value>port</value> pairs.
127 <syntax block="yes"/> 126 <syntax block="yes"/>
128 <default/> 127 <default/>
129 <context>main</context> 128 <context>main</context>
130 129
131 <para> 130 <para>
132 Provides a configuration file context in which the mail server directives 131 Provides the configuration file context in which the mail server directives
133 are specified. 132 are specified.
134 </para> 133 </para>
135 134
136 </directive> 135 </directive>
137 136
143 <literal>smtp</literal></syntax> 142 <literal>smtp</literal></syntax>
144 <default/> 143 <default/>
145 <context>server</context> 144 <context>server</context>
146 145
147 <para> 146 <para>
148 Sets the protocol of a proxied server. 147 Sets the protocol for a proxied server.
149 Supported protocols are 148 Supported protocols are
150 <link doc="ngx_mail_imap_module.xml">IMAP</link>, 149 <link doc="ngx_mail_imap_module.xml">IMAP</link>,
151 <link doc="ngx_mail_pop3_module.xml">POP3</link> and 150 <link doc="ngx_mail_pop3_module.xml">POP3</link>, and
152 <link doc="ngx_mail_smtp_module.xml">SMTP</link>. 151 <link doc="ngx_mail_smtp_module.xml">SMTP</link>.
153 </para> 152 </para>
154 153
155 <para> 154 <para>
156 If the directive is not set, the protocol can be detected automatically 155 If the directive is not set, the protocol can be detected automatically
157 basing on the well-known port specified in the <link id="listen"/> 156 based on the well-known port specified in the <link id="listen"/>
158 directive: 157 directive:
159 <list type="bullet"> 158 <list type="bullet">
160 159
161 <listitem> 160 <listitem>
162 <literal>imap</literal>: 143, 993 161 <literal>imap</literal>: 143, 993
188 <syntax block="yes"/> 187 <syntax block="yes"/>
189 <default/> 188 <default/>
190 <context>mail</context> 189 <context>mail</context>
191 190
192 <para> 191 <para>
193 Sets a configuration for the server. 192 Sets the configuration for a server.
194 </para> 193 </para>
195 194
196 </directive> 195 </directive>
197 196
198 197
201 <default>hostname</default> 200 <default>hostname</default>
202 <context>mail</context> 201 <context>mail</context>
203 <context>server</context> 202 <context>server</context>
204 203
205 <para> 204 <para>
206 Sets a name of the server, used: 205 Sets the server name that is used:
207 206
208 <list type="bullet"> 207 <list type="bullet">
209 208
210 <listitem> 209 <listitem>
211 in the initial POP3/SMTP server greeting; 210 in the initial POP3/SMTP server greeting;
233 <default>off</default> 232 <default>off</default>
234 <context>mail</context> 233 <context>mail</context>
235 <context>server</context> 234 <context>server</context>
236 235
237 <para> 236 <para>
238 Controls if the “TCP keepalive” mode should be enabled on the client’s 237 Indicates if the “TCP keepalive” mode should be enabled on the client’s
239 connection (<c-def>SO_KEEPALIVE</c-def> socket parameter) on the 238 connection (<c-def>SO_KEEPALIVE</c-def> socket parameter) when connecting to
240 proxied server connection. 239 a proxied server.
241 </para> 240 </para>
242 241
243 </directive> 242 </directive>
244 243
245 244
248 <default>60s</default> 247 <default>60s</default>
249 <context>mail</context> 248 <context>mail</context>
250 <context>server</context> 249 <context>server</context>
251 250
252 <para> 251 <para>
253 Sets the timeout which is used before proxying to the backend started. 252 Sets the timeout that is used before proxying to the backend starts.
254 </para> 253 </para>
255 254
256 </directive> 255 </directive>
257 256
258 </section> 257 </section>