| 1 |
'\" t |
| 2 |
.\" Title: vfs_recycle |
| 3 |
.\" Author: [see the "AUTHOR" section] |
| 4 |
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> |
| 5 |
.\" Date: 05/26/2026 |
| 6 |
.\" Manual: System Administration tools |
| 7 |
.\" Source: Samba 4.23.8-git.477.f78166bceedSUSE-oS16.9-x86_64 |
| 8 |
.\" Language: English |
| 9 |
.\" |
| 10 |
.TH "VFS_RECYCLE" "8" "05/26/2026" "Samba 4\&.23\&.8\-git\&.477\&.f78166bcee" "System Administration tools" |
| 11 |
.\" ----------------------------------------------------------------- |
| 12 |
.\" * Define some portability stuff |
| 13 |
.\" ----------------------------------------------------------------- |
| 14 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 15 |
.\" http://bugs.debian.org/507673 |
| 16 |
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html |
| 17 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 18 |
.ie \n(.g .ds Aq \(aq |
| 19 |
.el .ds Aq ' |
| 20 |
.\" ----------------------------------------------------------------- |
| 21 |
.\" * set default formatting |
| 22 |
.\" ----------------------------------------------------------------- |
| 23 |
.\" disable hyphenation |
| 24 |
.nh |
| 25 |
.\" disable justification (adjust text to left margin only) |
| 26 |
.ad l |
| 27 |
.\" ----------------------------------------------------------------- |
| 28 |
.\" * MAIN CONTENT STARTS HERE * |
| 29 |
.\" ----------------------------------------------------------------- |
| 30 |
.SH "NAME" |
| 31 |
vfs_recycle \- Samba VFS recycle bin |
| 32 |
.SH "SYNOPSIS" |
| 33 |
.HP \w'\ 'u |
| 34 |
vfs objects = recycle |
| 35 |
.SH "DESCRIPTION" |
| 36 |
.PP |
| 37 |
This VFS module is part of the |
| 38 |
\fBsamba\fR(7) |
| 39 |
suite\&. |
| 40 |
.PP |
| 41 |
The |
| 42 |
vfs_recycle |
| 43 |
intercepts file deletion requests and moves the affected files to a temporary repository rather than deleting them immediately\&. This gives the same effect as the Recycle Bin on Windows computers\&. |
| 44 |
.PP |
| 45 |
The Recycle Bin will not appear in Windows Explorer views of the network file system (share) nor on any mapped drive\&. Instead, a directory called \&.recycle will be automatically created when the first file is deleted and recycle:repository is not configured\&. If recycle:repository is configured, the name of the created directory depends on recycle:repository\&. Users can recover files from the recycle bin\&. If the recycle:keeptree option has been specified, deleted files will be found in a path identical with that from which the file was deleted\&. |
| 46 |
.PP |
| 47 |
This module is stackable\&. |
| 48 |
.SH "OPTIONS" |
| 49 |
.PP |
| 50 |
recycle:repository = PATH |
| 51 |
.RS 4 |
| 52 |
Path of the directory where deleted files should be moved\&. |
| 53 |
.sp |
| 54 |
If this option is not set, the default path \&.recycle is used\&. |
| 55 |
.RE |
| 56 |
.PP |
| 57 |
recycle:directory_mode = MODE |
| 58 |
.RS 4 |
| 59 |
Set MODE to the octal mode the recycle repository should be created with\&. The recycle repository will be created when first file is deleted\&. If recycle:subdir_mode is not set, MODE also applies to subdirectories\&. |
| 60 |
.sp |
| 61 |
If this option is not set, the default mode 0700 is used\&. |
| 62 |
.RE |
| 63 |
.PP |
| 64 |
recycle:subdir_mode = MODE |
| 65 |
.RS 4 |
| 66 |
Set MODE to the octal mode with which sub directories of the recycle repository should be created\&. |
| 67 |
.sp |
| 68 |
If this option is not set, subdirectories will be created with the mode from recycle:directory_mode\&. |
| 69 |
.RE |
| 70 |
.PP |
| 71 |
recycle:keeptree = BOOL |
| 72 |
.RS 4 |
| 73 |
Specifies whether the directory structure should be preserved or whether the files in a directory that is being deleted should be kept separately in the repository\&. |
| 74 |
.RE |
| 75 |
.PP |
| 76 |
recycle:versions = BOOL |
| 77 |
.RS 4 |
| 78 |
If this option is True, two files with the same name that are deleted will both be kept in the repository\&. Newer deleted versions of a file will be called "Copy #x of filename"\&. |
| 79 |
.RE |
| 80 |
.PP |
| 81 |
recycle:touch = BOOL |
| 82 |
.RS 4 |
| 83 |
Specifies whether a file\*(Aqs access date should be updated when the file is moved to the repository\&. |
| 84 |
.RE |
| 85 |
.PP |
| 86 |
recycle:touch_mtime = BOOL |
| 87 |
.RS 4 |
| 88 |
Specifies whether a file\*(Aqs last modified date should be updated when the file is moved to the repository\&. |
| 89 |
.RE |
| 90 |
.PP |
| 91 |
recycle:minsize = BYTES |
| 92 |
.RS 4 |
| 93 |
Files that are smaller than the number of bytes specified by this parameter will not be put into the repository\&. |
| 94 |
.RE |
| 95 |
.PP |
| 96 |
recycle:maxsize = BYTES |
| 97 |
.RS 4 |
| 98 |
Files that are larger than the number of bytes specified by this parameter will not be put into the repository\&. |
| 99 |
.RE |
| 100 |
.PP |
| 101 |
recycle:exclude = LIST |
| 102 |
.RS 4 |
| 103 |
List of files that should not be put into the repository when deleted, but deleted in the normal way\&. Wildcards such as * and ? are supported\&. |
| 104 |
.RE |
| 105 |
.PP |
| 106 |
recycle:exclude_dir = LIST |
| 107 |
.RS 4 |
| 108 |
List of directories whose files should not be put into the repository when deleted, but deleted in the normal way\&. Wildcards such as * and ? are supported\&. |
| 109 |
.RE |
| 110 |
.PP |
| 111 |
recycle:noversions = LIST |
| 112 |
.RS 4 |
| 113 |
Specifies a list of paths (wildcards such as * and ? are supported) for which no versioning should be used\&. Only useful when recycle:versions is enabled\&. |
| 114 |
.RE |
| 115 |
.SH "EXAMPLES" |
| 116 |
.PP |
| 117 |
Move files "deleted" on |
| 118 |
\fIshare\fR |
| 119 |
to |
| 120 |
\fI/data/share/\&.recycle\fR |
| 121 |
instead of deleting them: |
| 122 |
.sp |
| 123 |
.if n \{\ |
| 124 |
.RS 4 |
| 125 |
.\} |
| 126 |
.nf |
| 127 |
\fI[share]\fR |
| 128 |
\m[blue]\fBpath = /data/share\fR\m[] |
| 129 |
\m[blue]\fBvfs objects = recycle\fR\m[] |
| 130 |
\m[blue]\fBrecycle:repository = \&.recycle\fR\m[] |
| 131 |
\m[blue]\fBrecycle:keeptree = yes\fR\m[] |
| 132 |
\m[blue]\fBrecycle:versions = yes\fR\m[] |
| 133 |
.fi |
| 134 |
.if n \{\ |
| 135 |
.RE |
| 136 |
.\} |
| 137 |
.SH "VERSION" |
| 138 |
.PP |
| 139 |
This man page is part of version 4\&.23\&.8\-git\&.477\&.f78166bceedSUSE\-oS16\&.9\-x86_64 of the Samba suite\&. |
| 140 |
.SH "AUTHOR" |
| 141 |
.PP |
| 142 |
The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. |