Add "min receivefile size" docs.
authorJeremy Allison <jra@samba.org>
Fri, 2 Nov 2007 21:54:22 +0000 (21:54 +0000)
committerGerald W. Carter <jerry@samba.org>
Wed, 23 Apr 2008 13:47:39 +0000 (08:47 -0500)
Jeremy.
(This used to be commit 3a8e086d240668bc5093c33506e0ed0a22557d4d)

docs/smbdotconf/protocol/minreceivefilesize.xml [new file with mode: 0644]

diff --git a/docs/smbdotconf/protocol/minreceivefilesize.xml b/docs/smbdotconf/protocol/minreceivefilesize.xml
new file mode 100644 (file)
index 0000000..7c31e6b
--- /dev/null
@@ -0,0 +1,22 @@
+<samba:parameter name="min receivefile size"
+               type="integer"
+               context="G"
+               advanced="1" developer="1"
+               xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+<para>This option changes the behavior of <citerefentry><refentrytitle>smbd</refentrytitle>
+<manvolnum>8</manvolnum></citerefentry> when processing SMBwriteX calls. Any incoming
+SMBwriteX call on a non-signed SMB/CIFS connection greater than this value will not be processed in the normal way but will
+be passed to any underlying kernel recvfile or splice system call (if there is no such
+call Samba will emulate in user space). This allows zero-copy writes directly from network
+socket buffers into the filesystem buffer cache, if available. It may improve performance
+but user testing is recommended. If set to zero Samba processes SMBwriteX calls in the
+normal way. To enable POSIX large write support (SMB/CIFS writes up to 16Mb) this option must be
+nonzero.</para>
+<para>Note this option will have NO EFFECT if set on a SMB signed connection.</para>
+<para>The default is zero, which diables this option.</para>
+</description>
+
+<related>min receivefile size</related>
+<value type="default">0</value>
+</samba:parameter>