docs: describe the new parameter "durable handles" in the smb.conf manpage
authorMichael Adam <obnox@samba.org>
Sun, 9 Sep 2012 22:50:38 +0000 (00:50 +0200)
committerMichael Adam <obnox@samba.org>
Sun, 9 Sep 2012 23:06:54 +0000 (01:06 +0200)
docs-xml/smbdotconf/protocol/durablehandles.xml [new file with mode: 0644]

diff --git a/docs-xml/smbdotconf/protocol/durablehandles.xml b/docs-xml/smbdotconf/protocol/durablehandles.xml
new file mode 100644 (file)
index 0000000..011fabd
--- /dev/null
@@ -0,0 +1,27 @@
+<samba:parameter name="durable handles"
+                 context="S"
+                 advanced="1"
+                 type="boolean"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+    <para>
+    This boolean parameter controls
+    whether Samba can grant SMB2 durable file handles on a share.
+    </para>
+    <para>
+    Note that durable handles are only enabled if
+    <smbconfoption name="kernel oplocks">no</smbconfoption>,
+    <smbconfoption name="kernel share modes">no</smbconfoption>, and
+    <smbconfoption name="posix locking">no</smbconfoption>,
+    i.e. if the share is configured for CIFS/SMB2 only access,
+    not supporting interoperability features with local UNIX processes
+    or NFS operations.
+    </para>
+    <para>
+    Also note that, for the time being, durability is not granted
+    for a handle that has the delete on close flag set.
+    </para>
+</description>
+
+<value type="default">yes</value>
+</samba:parameter>