source: branches/samba-3.2.x/docs/manpages/vfs_recycle.8@ 225

Last change on this file since 225 was 225, checked in by Herwig Bauernfeind, 17 years ago

Update 3.2 branch to 3.2.6 docs manpages

File size: 4.2 KB
Line 
1.\" Title: vfs_recycle
2.\" Author:
3.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
4.\" Date: 12/10/2008
5.\" Manual: System Administration tools
6.\" Source: Samba 3.2
7.\"
8.TH "VFS_RECYCLE" "8" "12/10/2008" "Samba 3\.2" "System Administration tools"
9.\" disable hyphenation
10.nh
11.\" disable justification (adjust text to left margin only)
12.ad l
13.SH "NAME"
14vfs_recycle - Samba VFS recycle bin
15.SH "SYNOPSIS"
16.HP 1
17vfs objects = recycle
18.SH "DESCRIPTION"
19.PP
20This VFS module is part of the
21\fBsamba\fR(7)
22suite\.
23.PP
24The
25vfs_recycle
26intercepts 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\.
27.PP
28The 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\.
29.PP
30This module is stackable\.
31.SH "OPTIONS"
32.PP
33recycle:repository = PATH
34.RS 4
35Path of the directory where deleted files should be moved\.
36.sp
37If this option is not set, the default path \.recycle is used\.
38.RE
39.PP
40recycle:directory_mode = MODE
41.RS 4