summaryrefslogtreecommitdiff
path: root/docs/docbook/smbdotconf/locking/blockinglocks.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/docbook/smbdotconf/locking/blockinglocks.xml')
-rw-r--r--docs/docbook/smbdotconf/locking/blockinglocks.xml23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/docbook/smbdotconf/locking/blockinglocks.xml b/docs/docbook/smbdotconf/locking/blockinglocks.xml
new file mode 100644
index 0000000000..f11d92f4f5
--- /dev/null
+++ b/docs/docbook/smbdotconf/locking/blockinglocks.xml
@@ -0,0 +1,23 @@
+<samba:parameter name="blocking locks"
+ context="S"
+ xmlns:samba="http://samba.org/common">
+<listitem>
+ <para>This parameter controls the behavior
+ of <citerefentry><refentrytitle>smbd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry> when given a request by a client
+ to obtain a byte range lock on a region of an open file, and the
+ request has a time limit associated with it.</para>
+
+ <para>If this parameter is set and the lock range requested
+ cannot be immediately satisfied, samba will internally
+ queue the lock request, and periodically attempt to obtain
+ the lock until the timeout period expires.</para>
+
+ <para>If this parameter is set to <constant>no</constant>, then
+ samba will behave as previous versions of Samba would and
+ will fail the lock request immediately if the lock range
+ cannot be obtained.</para>
+
+ <para>Default: <command moreinfo="none">blocking locks = yes</command></para>
+</listitem>
+</samba:parameter>