Moving docs tree to docs-xml to make room for generated docs in the release tarball.
[samba.git] / docs-xml / smbdotconf / locking / oplocks.xml
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>
7         This boolean option tells <command moreinfo="none">smbd</command> whether to 
8         issue oplocks (opportunistic locks) to file open requests on this 
9         share. The oplock code can dramatically (approx. 30% or more) improve 
10         the speed of access to files on Samba servers. It allows the clients 
11         to aggressively cache files locally and you may want to disable this 
12         option for unreliable network environments (it is turned on by 
13         default in Windows NT Servers).  For more information see the file 
14         <filename moreinfo="none">Speed.txt</filename> in the Samba 
15         <filename moreinfo="none">docs/</filename> directory.
16         </para>
17
18         <para>
19         Oplocks may be selectively turned off on certain files with a share. See 
20         the <smbconfoption name="veto oplock files"/> parameter. On some systems 
21         oplocks are recognized by the underlying operating system. This 
22         allows data synchronization between all access to oplocked files, 
23         whether it be via Samba or NFS or a local UNIX process. See the 
24         <smbconfoption name="kernel oplocks"/> parameter for details.
25         </para>
26 </description>
27
28 <related>kernel oplocks</related>
29 <related>level2 oplocks</related>
30 <value type="default">yes</value>
31 </samba:parameter>