493f281fdba0c2d34f7b5ecb75775850d08e1bf4
[gd/samba-autobuild/.git] / docs-xml / smbdotconf / locking / blockinglocks.xml
1 <samba:parameter name="blocking locks"
2                  context="S"
3                                  type="boolean"
4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
5 <description>
6         <para>This parameter controls the behavior 
7         of <citerefentry><refentrytitle>smbd</refentrytitle>
8         <manvolnum>8</manvolnum></citerefentry> when given a request by a client 
9         to obtain a byte range lock on a region of an open file, and the 
10         request has a time limit associated with it.</para>
11                 
12         <para>If this parameter is set and the lock range requested 
13         cannot be immediately satisfied, samba will internally 
14         queue the lock request, and periodically attempt to obtain 
15         the lock until the timeout period expires.</para>
16
17         <para>If this parameter is set to <constant>no</constant>, then 
18         samba will behave as previous versions of Samba would and 
19         will fail the lock request immediately if the lock range 
20         cannot be obtained.</para>
21
22 </description>
23 <value type="default">yes</value>
24 </samba:parameter>