Add new framework for smb.conf(5). Please read README before trying to compile.
[Samba/gebeck_regimport.git] / docs / docbook / smbdotconf / locking / oplocks.xml
blob071786f35c4f09891283b5ad8b8cc8245d5a08ac
1 <samba:parameter xmlns:samba="http://samba.org/common">
2                 <term><anchor id="OPLOCKS"/>oplocks (S)</term>
3                 <listitem><para>This boolean option tells <command moreinfo="none">smbd</command> whether to 
4                 issue oplocks (opportunistic locks) to file open requests on this 
5                 share. The oplock code can dramatically (approx. 30% or more) improve 
6                 the speed of access to files on Samba servers. It allows the clients 
7                 to aggressively cache files locally and you may want to disable this 
8                 option for unreliable network environments (it is turned on by 
9                 default in Windows NT Servers).  For more information see the file 
10                 <filename moreinfo="none">Speed.txt</filename> in the Samba <filename moreinfo="none">docs/</filename> 
11                 directory.</para>
13                 <para>Oplocks may be selectively turned off on certain files with a 
14                 share. See the <link linkend="VETOOPLOCKFILES"><parameter moreinfo="none">
15                 veto oplock files</parameter></link> parameter. On some systems 
16                 oplocks are recognized by the underlying operating system. This 
17                 allows data synchronization between all access to oplocked files, 
18                 whether it be via Samba or NFS or a local UNIX process. See the 
19                 <parameter moreinfo="none">kernel oplocks</parameter> parameter for details.</para>
21                 <para>See also the <link linkend="KERNELOPLOCKS"><parameter moreinfo="none">kernel 
22                 oplocks</parameter></link> and <link linkend="LEVEL2OPLOCKS"><parameter moreinfo="none">
23                 level2 oplocks</parameter></link> parameters.</para>
25                 <para>Default: <command moreinfo="none">oplocks = yes</command></para>
26                 </listitem>
27                 </samba:parameter>