Moving docs tree to docs-xml to make room for generated docs in the release tarball.
[samba.git] / docs-xml / smbdotconf / protocol / minreceivefilesize.xml
1 <samba:parameter name="min receivefile size"
2                 type="integer"
3                 context="G"
4                 advanced="1" developer="1"
5                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
6 <description>
7 <para>This option changes the behavior of <citerefentry><refentrytitle>smbd</refentrytitle>
8 <manvolnum>8</manvolnum></citerefentry> when processing SMBwriteX calls. Any incoming
9 SMBwriteX call on a non-signed SMB/CIFS connection greater than this value will not be processed in the normal way but will
10 be passed to any underlying kernel recvfile or splice system call (if there is no such
11 call Samba will emulate in user space). This allows zero-copy writes directly from network
12 socket buffers into the filesystem buffer cache, if available. It may improve performance
13 but user testing is recommended. If set to zero Samba processes SMBwriteX calls in the
14 normal way. To enable POSIX large write support (SMB/CIFS writes up to 16Mb) this option must be
15 nonzero. The maximum value is 128k. Values greater than 128k will be silently set to 128k.</para>
16 <para>Note this option will have NO EFFECT if set on a SMB signed connection.</para>
17 <para>The default is zero, which diables this option.</para>
18 </description>
19
20 <related>min receivefile size</related>
21 <value type="default">0</value>
22 </samba:parameter>