| 1 | .\" Title: vfs_recycle
|
|---|
| 2 | .\" Author: [see the "AUTHOR" section]
|
|---|
| 3 | .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
|
|---|
| 4 | .\" Date: 02/22/2010
|
|---|
| 5 | .\" Manual: System Administration tools
|
|---|
| 6 | .\" Source: Samba 3.3
|
|---|
| 7 | .\" Language: English
|
|---|
| 8 | .\"
|
|---|
| 9 | .TH "VFS_RECYCLE" "8" "02/22/2010" "Samba 3\&.3" "System Administration tools"
|
|---|
| 10 | .\" -----------------------------------------------------------------
|
|---|
| 11 | .\" * (re)Define some macros
|
|---|
| 12 | .\" -----------------------------------------------------------------
|
|---|
| 13 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 14 | .\" toupper - uppercase a string (locale-aware)
|
|---|
| 15 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 16 | .de toupper
|
|---|
| 17 | .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
|
|---|
| 18 | \\$*
|
|---|
| 19 | .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
|
|---|
| 20 | ..
|
|---|
| 21 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 22 | .\" SH-xref - format a cross-reference to an SH section
|
|---|
| 23 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 24 | .de SH-xref
|
|---|
| 25 | .ie n \{\
|
|---|
| 26 | .\}
|
|---|
| 27 | .toupper \\$*
|
|---|
| 28 | .el \{\
|
|---|
| 29 | \\$*
|
|---|
| 30 | .\}
|
|---|
| 31 | ..
|
|---|
| 32 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 33 | .\" SH - level-one heading that works better for non-TTY output
|
|---|
| 34 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 35 | .de1 SH
|
|---|
| 36 | .\" put an extra blank line of space above the head in non-TTY output
|
|---|
| 37 | .if t \{\
|
|---|
| 38 | .sp 1
|
|---|
| 39 | .\}
|
|---|
| 40 | .sp \\n[PD]u
|
|---|
| 41 | .nr an-level 1
|
|---|
| 42 | .set-an-margin
|
|---|
| 43 | .nr an-prevailing-indent \\n[IN]
|
|---|
| 44 | .fi
|
|---|
| 45 | .in \\n[an-margin]u
|
|---|
| 46 | .ti 0
|
|---|
| 47 | .HTML-TAG ".NH \\n[an-level]"
|
|---|
| 48 | .it 1 an-trap
|
|---|
| 49 | .nr an-no-space-flag 1
|
|---|
| 50 | .nr an-break-flag 1
|
|---|
| 51 | \." make the size of the head bigger
|
|---|
| 52 | .ps +3
|
|---|
| 53 | .ft B
|
|---|
| 54 | .ne (2v + 1u)
|
|---|
| 55 | .ie n \{\
|
|---|
| 56 | .\" if n (TTY output), use uppercase
|
|---|
| 57 | .toupper \\$*
|
|---|
| 58 | .\}
|
|---|
| 59 | .el \{\
|
|---|
| 60 | .nr an-break-flag 0
|
|---|
| 61 | .\" if not n (not TTY), use normal case (not uppercase)
|
|---|
| 62 | \\$1
|
|---|
| 63 | .in \\n[an-margin]u
|
|---|
| 64 | .ti 0
|
|---|
| 65 | .\" if not n (not TTY), put a border/line under subheading
|
|---|
| 66 | .sp -.6
|
|---|
| 67 | \l'\n(.lu'
|
|---|
| 68 | .\}
|
|---|
| 69 | ..
|
|---|
| 70 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 71 | .\" SS - level-two heading that works better for non-TTY output
|
|---|
| 72 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 73 | .de1 SS
|
|---|
| 74 | .sp \\n[PD]u
|
|---|
| 75 | .nr an-level 1
|
|---|
| 76 | .set-an-margin
|
|---|
| 77 | .nr an-prevailing-indent \\n[IN]
|
|---|
| 78 | .fi
|
|---|
| 79 | .in \\n[IN]u
|
|---|
| 80 | .ti \\n[SN]u
|
|---|
| 81 | .it 1 an-trap
|
|---|
| 82 | .nr an-no-space-flag 1
|
|---|
| 83 | .nr an-break-flag 1
|
|---|
| 84 | .ps \\n[PS-SS]u
|
|---|
| 85 | \." make the size of the head bigger
|
|---|
| 86 | .ps +2
|
|---|
| 87 | .ft B
|
|---|
| 88 | .ne (2v + 1u)
|
|---|
| 89 | .if \\n[.$] \&\\$*
|
|---|
| 90 | ..
|
|---|
| 91 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 92 | .\" BB/BE - put background/screen (filled box) around block of text
|
|---|
| 93 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 94 | .de BB
|
|---|
| 95 | .if t \{\
|
|---|
| 96 | .sp -.5
|
|---|
| 97 | .br
|
|---|
| 98 | .in +2n
|
|---|
| 99 | .ll -2n
|
|---|
| 100 | .gcolor red
|
|---|
| 101 | .di BX
|
|---|
| 102 | .\}
|
|---|
| 103 | ..
|
|---|
| 104 | .de EB
|
|---|
| 105 | .if t \{\
|
|---|
| 106 | .if "\\$2"adjust-for-leading-newline" \{\
|
|---|
| 107 | .sp -1
|
|---|
| 108 | .\}
|
|---|
| 109 | .br
|
|---|
| 110 | .di
|
|---|
| 111 | .in
|
|---|
| 112 | .ll
|
|---|
| 113 | .gcolor
|
|---|
| 114 | .nr BW \\n(.lu-\\n(.i
|
|---|
| 115 | .nr BH \\n(dn+.5v
|
|---|
| 116 | .ne \\n(BHu+.5v
|
|---|
| 117 | .ie "\\$2"adjust-for-leading-newline" \{\
|
|---|
| 118 | \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
|
|---|
| 119 | .\}
|
|---|
| 120 | .el \{\
|
|---|
| 121 | \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
|
|---|
| 122 | .\}
|
|---|
| 123 | .in 0
|
|---|
| 124 | .sp -.5v
|
|---|
| 125 | .nf
|
|---|
| 126 | .BX
|
|---|
| 127 | .in
|
|---|
| 128 | .sp .5v
|
|---|
| 129 | .fi
|
|---|
| 130 | .\}
|
|---|
| 131 | ..
|
|---|
| 132 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 133 | .\" BM/EM - put colored marker in margin next to block of text
|
|---|
| 134 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 135 | .de BM
|
|---|
| 136 | .if t \{\
|
|---|
| 137 | .br
|
|---|
| 138 | .ll -2n
|
|---|
| 139 | .gcolor red
|
|---|
| 140 | .di BX
|
|---|
| 141 | .\}
|
|---|
| 142 | ..
|
|---|
| 143 | .de EM
|
|---|
| 144 | .if t \{\
|
|---|
| 145 | .br
|
|---|
| 146 | .di
|
|---|
| 147 | .ll
|
|---|
| 148 | .gcolor
|
|---|
| 149 | .nr BH \\n(dn
|
|---|
| 150 | .ne \\n(BHu
|
|---|
| 151 | \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
|
|---|
| 152 | .in 0
|
|---|
| 153 | .nf
|
|---|
| 154 | .BX
|
|---|
| 155 | .in
|
|---|
| 156 | .fi
|
|---|
| 157 | .\}
|
|---|
| 158 | ..
|
|---|
| 159 | .\" -----------------------------------------------------------------
|
|---|
| 160 | .\" * set default formatting
|
|---|
| 161 | .\" -----------------------------------------------------------------
|
|---|
| 162 | .\" disable hyphenation
|
|---|
| 163 | .nh
|
|---|
| 164 | .\" disable justification (adjust text to left margin only)
|
|---|
| 165 | .ad l
|
|---|
| 166 | .\" -----------------------------------------------------------------
|
|---|
| 167 | .\" * MAIN CONTENT STARTS HERE *
|
|---|
| 168 | .\" -----------------------------------------------------------------
|
|---|
| 169 | .SH "Name"
|
|---|
| 170 | vfs_recycle \- Samba VFS recycle bin
|
|---|
| 171 | .SH "Synopsis"
|
|---|
| 172 | .fam C
|
|---|
| 173 | .HP \w'\ 'u
|
|---|
| 174 | \FCvfs objects = recycle\F[]
|
|---|
| 175 | .fam
|
|---|
| 176 | .SH "DESCRIPTION"
|
|---|
| 177 | .PP
|
|---|
| 178 | This VFS module is part of the
|
|---|
| 179 | \fBsamba\fR(7)
|
|---|
| 180 | suite\&.
|
|---|
| 181 | .PP
|
|---|
| 182 | The
|
|---|
| 183 | \FCvfs_recycle\F[]
|
|---|
| 184 | 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\&.
|
|---|
| 185 | .PP
|
|---|
| 186 | 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\&.
|
|---|
| 187 | .PP
|
|---|
| 188 | This module is stackable\&.
|
|---|
| 189 | .SH "OPTIONS"
|
|---|
| 190 | .PP
|
|---|
| 191 | recycle:repository = PATH
|
|---|
| 192 | .RS 4
|
|---|
| 193 | Path of the directory where deleted files should be moved\&.
|
|---|
| 194 | .sp
|
|---|
| 195 | If this option is not set, the default path \&.recycle is used\&.
|
|---|
| 196 | .RE
|
|---|
| 197 | .PP
|
|---|
| 198 | recycle:directory_mode = MODE
|
|---|
| 199 | .RS 4
|
|---|
| 200 | 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\&.
|
|---|
| 201 | .sp
|
|---|
| 202 | If this option is not set, the default mode 0700 is used\&.
|
|---|
| 203 | .RE
|
|---|
| 204 | .PP
|
|---|
| 205 | recycle:subdir_mode = MODE
|
|---|
| 206 | .RS 4
|
|---|
| 207 | Set MODE to the octal mode with which sub directories of the recycle repository should be created\&.
|
|---|
| 208 | .sp
|
|---|
| 209 | If this option is not set, subdirectories will be created with the mode from recycle:directory_mode\&.
|
|---|
| 210 | .RE
|
|---|
| 211 | .PP
|
|---|
| 212 | recycle:keeptree = BOOL
|
|---|
| 213 | .RS 4
|
|---|
| 214 | 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\&.
|
|---|
| 215 | .RE
|
|---|
| 216 | .PP
|
|---|
| 217 | recycle:versions = BOOL
|
|---|
| 218 | .RS 4
|
|---|
| 219 | 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"\&.
|
|---|
| 220 | .RE
|
|---|
| 221 | .PP
|
|---|
| 222 | recycle:touch = BOOL
|
|---|
| 223 | .RS 4
|
|---|
| 224 | Specifies whether a file\'s access date should be updated when the file is moved to the repository\&.
|
|---|
| 225 | .RE
|
|---|
| 226 | .PP
|
|---|
| 227 | recycle:touch_mtime = BOOL
|
|---|
| 228 | .RS 4
|
|---|
| 229 | Specifies whether a file\'s last modified date should be updated when the file is moved to the repository\&.
|
|---|
| 230 | .RE
|
|---|
| 231 | .PP
|
|---|
| 232 | recycle:minsize = BYTES
|
|---|
| 233 | .RS 4
|
|---|
| 234 | Files that are smaller than the number of bytes specified by this parameter will not be put into the repository\&.
|
|---|
| 235 | .RE
|
|---|
| 236 | .PP
|
|---|
| 237 | recycle:maxsize = BYTES
|
|---|
| 238 | .RS 4
|
|---|
| 239 | Files that are larger than the number of bytes specified by this parameter will not be put into the repository\&.
|
|---|
| 240 | .RE
|
|---|
| 241 | .PP
|
|---|
| 242 | recycle:exclude = LIST
|
|---|
| 243 | .RS 4
|
|---|
| 244 | 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\&.
|
|---|
| 245 | .RE
|
|---|
| 246 | .PP
|
|---|
| 247 | recycle:exclude_dir = LIST
|
|---|
| 248 | .RS 4
|
|---|
| 249 | 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\&.
|
|---|
| 250 | .RE
|
|---|
| 251 | .PP
|
|---|
| 252 | recycle:noversions = LIST
|
|---|
| 253 | .RS 4
|
|---|
| 254 | 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\&.
|
|---|
| 255 | .RE
|
|---|
| 256 | .SH "EXAMPLES"
|
|---|
| 257 | .PP
|
|---|
| 258 | Move files "deleted" on
|
|---|
| 259 | \fIshare\fR
|
|---|
| 260 | to
|
|---|
| 261 | \fI/data/share/\&.recycle\fR
|
|---|
| 262 | instead of deleting them:
|
|---|
| 263 | .sp
|
|---|
| 264 | .if n \{\
|
|---|
| 265 | .RS 4
|
|---|
| 266 | .\}
|
|---|
| 267 | .fam C
|
|---|
| 268 | .ps -1
|
|---|
| 269 | .nf
|
|---|
| 270 | .if t \{\
|
|---|
| 271 | .sp -1
|
|---|
| 272 | .\}
|
|---|
| 273 | .BB lightgray adjust-for-leading-newline
|
|---|
| 274 | .sp -1
|
|---|
| 275 |
|
|---|
| 276 | \fI[share]\fR
|
|---|
| 277 | \m[blue]\fBpath = /data/share\fR\m[]
|
|---|
| 278 | \m[blue]\fBvfs objects = recycle\fR\m[]
|
|---|
| 279 | \m[blue]\fBrecycle:repository = \&.recycle\fR\m[]
|
|---|
| 280 | \m[blue]\fBrecycle:keeptree = yes\fR\m[]
|
|---|
| 281 | \m[blue]\fBrecycle:versions = yes\fR\m[]
|
|---|
| 282 | .EB lightgray adjust-for-leading-newline
|
|---|
| 283 | .if t \{\
|
|---|
| 284 | .sp 1
|
|---|
| 285 | .\}
|
|---|
| 286 | .fi
|
|---|
| 287 | .fam
|
|---|
| 288 | .ps +1
|
|---|
| 289 | .if n \{\
|
|---|
| 290 | .RE
|
|---|
| 291 | .\}
|
|---|
| 292 | .SH "VERSION"
|
|---|
| 293 | .PP
|
|---|
| 294 | This man page is correct for version 3\&.0\&.25 of the Samba suite\&.
|
|---|
| 295 | .SH "AUTHOR"
|
|---|
| 296 | .PP
|
|---|
| 297 | 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\&.
|
|---|
