docs:smbdotconf: remove swat-specific flags.
[amitay/samba.git] / docs-xml / smbdotconf / tuning / keepalive.xml
1 <samba:parameter name="keepalive"
2                  context="G"
3                                  type="integer"
4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
5 <description>
6     <para>The value of the parameter (an integer) represents 
7     the number of seconds between <parameter moreinfo="none">keepalive</parameter> 
8     packets. If this parameter is zero, no keepalive packets will be 
9     sent. Keepalive packets, if sent, allow the server to tell whether 
10     a client is still present and responding.</para>
11
12     <para>Keepalives should, in general, not be needed if the socket 
13     has the SO_KEEPALIVE attribute set on it by default. (see <smbconfoption name="socket options"/>). 
14 Basically you should only use this option if you strike difficulties.</para>
15
16     <para>Please note this option only applies to SMB1 client connections, and
17     has no effect on SMB2 clients.</para>
18 </description>
19
20 <value type="default">300</value>
21 <value type="example">600</value>
22 </samba:parameter>