Removal of CRUFT. 50 lashes to those who created CRUFT. Argh.
[Samba.git] / docs / smbdotconf / locking / oplocks.xml
blob3ce70a788336a24bb5b3d56fe8c0f6a9f7c626e0
1 <samba:parameter name="oplocks"
2                  context="S"
3                                  type="boolean"
4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
5 <description>
6         <para>This boolean option tells <command moreinfo="none">smbd</command> whether to 
7         issue oplocks (opportunistic locks) to file open requests on this 
8         share. The oplock code can dramatically (approx. 30% or more) improve 
9         the speed of access to files on Samba servers. It allows the clients 
10         to aggressively cache files locally and you may want to disable this 
11         option for unreliable network environments (it is turned on by 
12         default in Windows NT Servers).  For more information see the file 
13         <filename moreinfo="none">Speed.txt</filename> in the Samba <filename moreinfo="none">docs/</filename> 
14         directory.</para>
16         <para>Oplocks may be selectively turned off on certain files with a 
17         share. See the <smbconfoption name="veto oplock files"/> parameter. On some systems 
18         oplocks are recognized by the underlying operating system. This 
19         allows data synchronization between all access to oplocked files, 
20         whether it be via Samba or NFS or a local UNIX process. See the 
21         <parameter moreinfo="none">kernel oplocks</parameter> parameter for details.</para>
22 </description>
24 <related>kernel oplocks</related>
25 <related>level2 oplocks</related>
26 <value type="default">yes</value>
27 </samba:parameter>