docs/manpages-3/vfs_recycle.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_recycle.8">
   4
   5 <refmeta>
   6         <refentrytitle>vfs_recycle</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8 </refmeta>
   9
  10
  11 <refnamediv>
  12         <refname>vfs_recycle</refname>
  13         <refpurpose>Samba VFS recycle bin</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17         <cmdsynopsis>
  18                 <command>vfs objects = recycle</command>
  19         </cmdsynopsis>
  20 </refsynopsisdiv>
  21
  22 <refsect1>
  23         <title>DESCRIPTION</title>
  24
  25         <para>This VFS module is part of the
  26         <citerefentry><refentrytitle>samba</refentrytitle>
  27         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  28
  29         <para>The <command>vfs_recycle</command> intercepts file deletion
  30         requests and moves the affected files to a temporary repository
  31         rather than deleting them immediately. This gives the same effect
  32         as the Recycle Bin on Windows computers. </para>
  33
  34         <para>The Recycle Bin will not appear in Windows Explorer
  35         views of the network file system (share) nor on any mapped
  36         drive. Instead, a directory called .recycle will be automatically
  37         created when the first file is deleted and recycle:repository is
  38         not configured. If recycle:repository is configured, the name
  39         of the created directory depends on recycle:repository. Users
  40         can recover files from the recycle bin. If the recycle:keeptree
  41         option has been specified, deleted files will be found in a path
  42         identical with that from which the file was deleted.  </para>
  43
  44
  45         <para>This module is stackable.</para>
  46
  47 </refsect1>
  48
  49
  50 <refsect1>
  51         <title>OPTIONS</title>
  52
  53         <variablelist>
  54
  55                 <varlistentry>
  56                 <term>recycle:repository = PATH</term>
  57                 <listitem>
  58                 <para>Path of the directory where deleted files should be moved.
  59                 </para>
  60                 <para>If this option is not set, the default path .recycle
  61                 is used. </para>
  62                 </listitem>
  63                 </varlistentry>
  64
  65                 <varlistentry>
  66                 <term>recycle:directory_mode = MODE</term>
  67                 <listitem>
  68                 <para>Set MODE to the octal mode the recycle repository
  69                 should be created with.  The recycle repository will be
  70                 created when first file is deleted. If recycle:subdir_mode
  71                 is not set, MODE also applies to subdirectories.
  72                 </para>
  73                 <para>If this option is not set, the default mode
  74                 0700 is used. </para>
  75                 </listitem>
  76                 </varlistentry>
  77
  78                 <varlistentry>
  79                 <term>recycle:subdir_mode = MODE</term>
  80                 <listitem>
  81                 <para>Set MODE to the octal mode with which
  82                 sub directories of the recycle repository should be created.
  83                 </para>
  84                 <para>If this option is not set, subdirectories
  85                 will be created with the mode from recycle:directory_mode.
  86                 </para>
  87                 </listitem>
  88                 </varlistentry>
  89
  90                 <varlistentry>
  91                 <term>recycle:keeptree = BOOL</term>
  92                 <listitem>
  93                 <para>Specifies whether the directory structure should
  94                 be preserved or whether the files in a directory that is being
  95                 deleted should be kept separately in the repository.
  96                 </para>
  97                 </listitem>
  98                 </varlistentry>
  99
 100                 <varlistentry>
 101                 <term>recycle:versions = BOOL</term>
 102                 <listitem>
 103                 <para>If this option is True, two files with the same
 104                 name that are deleted will both be kept in the repository.
 105                 Newer deleted versions of a file will be called
 106                 &quot;Copy #x of filename&quot;.
 107                 </para>
 108                 </listitem>
 109                 </varlistentry>
 110
 111                 <varlistentry>
 112                 <term>recycle:touch = BOOL</term>
 113                 <listitem>
 114                 <para>Specifies whether a file's access date should be
 115                 updated when the file is moved to the repository.
 116                 </para>
 117                 </listitem>
 118                 </varlistentry>
 119
 120                 <varlistentry>
 121                 <term>recycle:touch_mtime = BOOL</term>
 122                 <listitem>
 123                 <para>Specifies whether a file's last modified date should be
 124                 updated when the file is moved to the repository.
 125                 </para>
 126                 </listitem>
 127                 </varlistentry>
 128
 129                 <varlistentry>
 130                 <term>recycle:maxsize = BYTES</term>
 131                 <listitem>
 132                 <para>Files that are larger than the number of bytes
 133                 specified by this parameter will not be put into the
 134                 repository.
 135                 </para>
 136                 </listitem>
 137                 </varlistentry>
 138
 139                 <varlistentry>
 140                 <term>recycle:exclude = LIST</term>
 141                 <listitem>
 142                 <para>List of files that should not be put into the
 143                 repository when deleted, but deleted in the normal way.
 144                 </para>
 145                 </listitem>
 146                 </varlistentry>
 147
 148                 <varlistentry>
 149                 <term>recycle:exclude_dir = LIST</term>
 150                 <listitem>
 151                 <para>List of directories whose files should not be put
 152                 into the repository when deleted, but deleted in the
 153                 normal way.
 154                 </para>
 155                 </listitem>
 156                 </varlistentry>
 157
 158                 <varlistentry>
 159                 <term>recycle:noversions = LIST</term>
 160                 <listitem>
 161                 <para>Specifies a list of paths (wildcards such as *
 162                 and ? are supported) for which no versioning should
 163                 be used. Only useful when recycle:versions is enabled.
 164                 </para>
 165                 </listitem>
 166                 </varlistentry>
 167
 168         </variablelist>
 169 </refsect1>
 170
 171 <refsect1>
 172         <title>EXAMPLES</title>
 173
 174         <para>Log operations on all shares using the LOCAL1 facility
 175         and NOTICE priority:</para>
 176
 177 <programlisting>
 178         <smbconfsection name="[global]"/>
 179         <smbconfoption name="vfs objects">recycle</smbconfoption>
 180         <smbconfoption name="recycle:facility">LOCAL1</smbconfoption>
 181         <smbconfoption name="recycle:priority">NOTICE</smbconfoption>
 182 </programlisting>
 183
 184 </refsect1>
 185
 186 <refsect1>
 187         <title>VERSION</title>
 188
 189         <para>This man page is correct for version 3.0.25 of the Samba suite.
 190         </para>
 191 </refsect1>
 192
 193 <refsect1>
 194         <title>AUTHOR</title>
 195
 196         <para>The original Samba software and related utilities
 197         were created by Andrew Tridgell. Samba is now developed
 198         by the Samba Team as an Open Source project similar
 199         to the way the Linux kernel is developed.</para>
 200
 201 </refsect1>
 202
 203 </refentry>