summaryrefslogtreecommitdiff
path: root/docs/docbook/smbdotconf/locking/oplocks.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/docbook/smbdotconf/locking/oplocks.xml')
-rw-r--r--docs/docbook/smbdotconf/locking/oplocks.xml27
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/docbook/smbdotconf/locking/oplocks.xml b/docs/docbook/smbdotconf/locking/oplocks.xml
new file mode 100644
index 0000000000..071786f35c
--- /dev/null
+++ b/docs/docbook/smbdotconf/locking/oplocks.xml
@@ -0,0 +1,27 @@
+<samba:parameter xmlns:samba="http://samba.org/common">
+ <term><anchor id="OPLOCKS"/>oplocks (S)</term>
+ <listitem><para>This boolean option tells <command moreinfo="none">smbd</command> whether to
+ issue oplocks (opportunistic locks) to file open requests on this
+ share. The oplock code can dramatically (approx. 30% or more) improve
+ the speed of access to files on Samba servers. It allows the clients
+ to aggressively cache files locally and you may want to disable this
+ option for unreliable network environments (it is turned on by
+ default in Windows NT Servers). For more information see the file
+ <filename moreinfo="none">Speed.txt</filename> in the Samba <filename moreinfo="none">docs/</filename>
+ directory.</para>
+
+ <para>Oplocks may be selectively turned off on certain files with a
+ share. See the <link linkend="VETOOPLOCKFILES"><parameter moreinfo="none">
+ veto oplock files</parameter></link> parameter. On some systems
+ oplocks are recognized by the underlying operating system. This
+ allows data synchronization between all access to oplocked files,
+ whether it be via Samba or NFS or a local UNIX process. See the
+ <parameter moreinfo="none">kernel oplocks</parameter> parameter for details.</para>
+
+ <para>See also the <link linkend="KERNELOPLOCKS"><parameter moreinfo="none">kernel
+ oplocks</parameter></link> and <link linkend="LEVEL2OPLOCKS"><parameter moreinfo="none">
+ level2 oplocks</parameter></link> parameters.</para>
+
+ <para>Default: <command moreinfo="none">oplocks = yes</command></para>
+ </listitem>
+ </samba:parameter>