docs-xml/manpages/vfs_crossrename.8.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="vfs_crossrename.8">
   4
   5 <refmeta>
   6         <refentrytitle>vfs_crossrename</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
  10         <refmiscinfo class="version">4.0</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>vfs_crossrename</refname>
  16         <refpurpose>server side rename files across filesystem boundaries</refpurpose>
  17 </refnamediv>
  18
  19 <refsynopsisdiv>
  20         <cmdsynopsis>
  21                 <command>vfs objects = crossrename</command>
  22         </cmdsynopsis>
  23 </refsynopsisdiv>
  24
  25 <refsect1>
  26         <title>DESCRIPTION</title>
  27
  28         <para>This VFS module is part of the
  29         <citerefentry><refentrytitle>samba</refentrytitle>
  30         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  31
  32         <para>The <command>vfs_crossrename</command> VFS module allows
  33         server side rename operations even if source and target are on
  34         different physical devices. A "move" in Explorer is usually a
  35         rename operation if it is inside of a single share or device.
  36         Usually such a rename operation returns
  37         NT_STATUS_NOT_SAME_DEVICE and the client has to move the file by
  38         manual copy and delete operations. If the rename by copy is done by the
  39         server this can be much more efficient. vfs_crossrename tries to do
  40         this server-side cross-device rename operation. There are however
  41         limitations that this module currently does not solve:
  42
  43         <variablelist>
  44                 <varlistentry>
  45                 the ACLs of files are not preserved
  46                 </varlistentry>
  47                 <varlistentry>
  48                 meta data in EAs are not preserved
  49                 </varlistentry>
  50                 <varlistentry>
  51                 renames of whole subdirectories cannot be done recursively,
  52                 in that case we still return STATUS_NOT_SAME_DEVICE and
  53                 let the client decide what to do
  54                 </varlistentry>
  55                 <varlistentry>
  56                 rename operations of huge files can cause hangs on the
  57                 client because clients expect a rename operation to
  58                 return fast
  59                 </varlistentry>
  60         </variablelist>
  61         </para>
  62
  63         <para>This module is stackable.</para>
  64
  65 </refsect1>
  66
  67
  68 <refsect1>
  69         <title>OPTIONS</title>
  70
  71         <variablelist>
  72
  73                 <varlistentry>
  74                 <term>crossrename:sizelimit = BYTES</term>
  75                 <listitem>
  76                 <para>server-side cross-device-renames are only done
  77                 for files if the filesize is not larger than the defined
  78                 size in MiB to prevent timeouts. The default sizelimit is
  79                 20 (MiB)
  80                 </para>
  81                 </listitem>
  82                 </varlistentry>
  83         </variablelist>
  84 </refsect1>
  85
  86 <refsect1>
  87         <title>EXAMPLES</title>
  88
  89         <para>To add server-side cross-device renames inside of a share
  90         for all files sized up to 50MB:</para>
  91
  92 <programlisting>
  93         <smbconfsection name="[testshare]"/>
  94         <smbconfoption name="path">/data/mounts</smbconfoption>
  95         <smbconfoption name="vfs objects">crossrename</smbconfoption>
  96         <smbconfoption name="crossrename:sizelimit">50</smbconfoption>
  97 </programlisting>
  98 </refsect1>
  99
 100 <refsect1>
 101         <title>VERSION</title>
 102         <para>This man page is correct for version 4.0.0 of the Samba suite.
 103         </para>
 104 </refsect1>
 105
 106 <refsect1>
 107         <title>AUTHOR</title>
 108
 109         <para>The original Samba software and related utilities
 110         were created by Andrew Tridgell. Samba is now developed
 111         by the Samba Team as an Open Source project similar
 112         to the way the Linux kernel is developed.</para>
 113
 114 </refsect1>
 115
 116 </refentry>