1VFS_RECYCLE(8) VFS_RECYCLE(8)
2
6 vfs_recycle - Samba VFS recycle bin
7
9 vfs objects = recycle
10
12 This VFS module is part of the samba(7) suite.
13 The vfs_recycle intercepts file deletion requests and moves the
15 affected files to a temporary repository rather than deleting them
16 immediately. This gives the same effect as the Recycle Bin on Windows
17 computers.
18 The Recycle Bin will not appear in Windows Explorer views of the net‐
20 work file system (share) nor on any mapped drive. Instead, a directory
21 called .recycle will be automatically created when the first file is
22 deleted and recycle:repository is not configured. If recycle:repository
23 is configured, the name of the created directory depends on recy‐
24 cle:repository. Users can recover files from the recycle bin. If the
25 recycle:keeptree option has been specified, deleted files will be found
26 in a path identical with that from which the file was deleted.
27 This module is stackable.
29
31 recycle:repository = PATH
32 Path of the directory where deleted files should be moved.
33 If this option is not set, the default path .recycle is used.
35 recycle:directory_mode = MODE
37 Set MODE to the octal mode the recycle repository should be created
38 with. The recycle repository will be created when first file is
39 deleted. If recycle:subdir_mode is not set, MODE also applies to
40 subdirectories.
41 If this option is not set, the default mode 0700 is used.
43 recycle:subdir_mode = MODE
45 Set MODE to the octal mode with which sub directories of the recycle
46 repository should be created.
47 If this option is not set, subdirectories will be created with the
49 mode from recycle:directory_mode.
50 recycle:keeptree = BOOL
52 Specifies whether the directory structure should be preserved or
53 whether the files in a directory that is being deleted should be
54 kept separately in the repository.
55 recycle:versions = BOOL
57 If this option is True, two files with the same name that are
58 deleted will both be kept in the repository. Newer deleted versions
59 of a file will be called "Copy #x of filename".
60 recycle:touch = BOOL
62 Specifies whether a file's access date should be updated when the
63 file is moved to the repository.
64 recycle:touch_mtime = BOOL
66 Specifies whether a file's last modified date should be updated when
67 the file is moved to the repository.
68 recycle:minsize = BYTES
70 Files that are smaller than the number of bytes specified by this
71 parameter will not be put into the repository.
72 recycle:maxsize = BYTES
74 Files that are larger than the number of bytes specified by this
75 parameter will not be put into the repository.
76 recycle:exclude = LIST
78 List of files that should not be put into the repository when
79 deleted, but deleted in the normal way. Wildcards such as * and ?
80 are supported.
81 recycle:exclude_dir = LIST
83 List of directories whose files should not be put into the reposi‐
84 tory when deleted, but deleted in the normal way. Wildcards such as
85 * and ? are supported.
86 recycle:noversions = LIST
88 Specifies a list of paths (wildcards such as * and ? are supported)
89 for which no versioning should be used. Only useful when recy‐
90 cle:versions is enabled.
91
93 Log operations on all shares using the LOCAL1 facility and NOTICE pri‐
94 ority:
95 [global]
98 vfs objects = recycle
99 recycle:facility = LOCAL1
100 recycle:priority = NOTICE
101
104 This man page is correct for version 3.0.25 of the Samba suite.
105
107 The original Samba software and related utilities were created by
108 Andrew Tridgell. Samba is now developed by the Samba Team as an Open
109 Source project similar to the way the Linux kernel is developed.
110 VFS_RECYCLE(8)