This commit was manufactured by cvs2svn to create branch 'SAMBA_3_0'.(This used to...
[samba.git] / docs / docbook / smbdotconf / locking / oplocks.xml
1 <samba:parameter name="oplocks"
2                  context="S"
3                  xmlns:samba="http://samba.org/common">
4 <listitem>
5         <para>This boolean option tells <command moreinfo="none">smbd</command> whether to 
6         issue oplocks (opportunistic locks) to file open requests on this 
7         share. The oplock code can dramatically (approx. 30% or more) improve 
8         the speed of access to files on Samba servers. It allows the clients 
9         to aggressively cache files locally and you may want to disable this 
10         option for unreliable network environments (it is turned on by 
11         default in Windows NT Servers).  For more information see the file 
12         <filename moreinfo="none">Speed.txt</filename> in the Samba <filename moreinfo="none">docs/</filename> 
13         directory.</para>
14
15         <para>Oplocks may be selectively turned off on certain files with a 
16         share. See the <link linkend="VETOOPLOCKFILES"><parameter moreinfo="none">
17         veto oplock files</parameter></link> 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
23         <para>See also the <link linkend="KERNELOPLOCKS"><parameter moreinfo="none">kernel 
24         oplocks</parameter></link> and <link linkend="LEVEL2OPLOCKS"><parameter moreinfo="none">
25         level2 oplocks</parameter></link> parameters.</para>
26
27         <para>Default: <command moreinfo="none">oplocks = yes</command></para>
28 </listitem>
29 </samba:parameter>