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">&doc.version;</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.
  41         </para>
  42
  43         <para>There are however limitations that this module currently does not
  44         solve:</para>
  45
  46         <variablelist>
  47                 <varlistentry>
  48                 <para>The ACLs of files are not preserved,</para>
  49                 </varlistentry>
  50                 <varlistentry>
  51                 <para>meta data in EAs are not preserved,</para>
  52                 </varlistentry>
  53                 <varlistentry>
  54                 <para>renames of whole subdirectories cannot be done recursively,
  55                 in that case we still return STATUS_NOT_SAME_DEVICE and
  56                 let the client decide what to do,</para>
  57                 </varlistentry>
  58                 <varlistentry>
  59                 <para>rename operations of huge files can cause hangs on the
  60                 client because clients expect a rename operation to
  61                 return fast.</para>
  62                 </varlistentry>
  63         </variablelist>
  64
  65         <para> This module is not fully stackable. It can be combined with other
  66         modules, but should be the last module in the <command>vfs objects</command>
  67         list. It directly access the files in the OS filesystem.
  68         </para>
  69
  70 </refsect1>
  71
  72
  73 <refsect1>
  74         <title>OPTIONS</title>
  75
  76         <variablelist>
  77
  78                 <varlistentry>
  79                 <term>crossrename:sizelimit = BYTES</term>
  80                 <listitem>
  81                 <para>server-side cross-device-renames are only done
  82                 for files if the filesize is not larger than the defined
  83                 size in MiB to prevent timeouts. The default sizelimit is
  84                 20 (MiB)
  85                 </para>
  86                 </listitem>
  87                 </varlistentry>
  88         </variablelist>
  89 </refsect1>
  90
  91 <refsect1>
  92         <title>EXAMPLES</title>
  93
  94         <para>To add server-side cross-device renames inside of a share
  95         for all files sized up to 50MB:</para>
  96
  97 <programlisting>
  98         <smbconfsection name="[testshare]"/>
  99         <smbconfoption name="path">/data/mounts</smbconfoption>
 100         <smbconfoption name="vfs objects">crossrename</smbconfoption>
 101         <smbconfoption name="crossrename:sizelimit">50</smbconfoption>
 102 </programlisting>
 103 </refsect1>
 104
 105 <refsect1>
 106         <title>VERSION</title>
 107         <para>This man page is part of version &doc.version; of the Samba suite.
 108         </para>
 109 </refsect1>
 110
 111 <refsect1>
 112         <title>AUTHOR</title>
 113
 114         <para>The original Samba software and related utilities
 115         were created by Andrew Tridgell. Samba is now developed
 116         by the Samba Team as an Open Source project similar
 117         to the way the Linux kernel is developed.</para>
 118
 119 </refsect1>
 120
 121 </refentry>