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
RevLine 
[201]1.\" Title: vfs_recycle
2.\" Author:
3.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
[225]4.\" Date: 12/10/2008
[201]5.\" Manual: System Administration tools
6.\" Source: Samba 3.2
7.\"
[225]8.TH "VFS_RECYCLE" "8" "12/10/2008" "Samba 3\.2" "System Administration tools"
[201]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
42Set 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\.
43.sp
44If this option is not set, the default mode 0700 is used\.
45.RE
46.PP
47recycle:subdir_mode = MODE
48.RS 4
49Set MODE to the octal mode with which sub directories of the recycle repository should be created\.
50.sp
51If this option is not set, subdirectories will be created with the mode from recycle:directory_mode\.
52.RE
53.PP
54recycle:keeptree = BOOL
55.RS 4
56Specifies 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\.
57.RE
58.PP
59recycle:versions = BOOL
60.RS 4
61If 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"\.
62.RE
63.PP
64recycle:touch = BOOL
65.RS 4
66Specifies whether a file\'s access date should be updated when the file is moved to the repository\.
67.RE
68.PP
69recycle:touch_mtime = BOOL
70.RS 4
71Specifies whether a file\'s last modified date should be updated when the file is moved to the repository\.
72.RE
73.PP
74recycle:minsize = BYTES
75.RS 4
76Files that are smaller than the number of bytes specified by this parameter will not be put into the repository\.
77.RE
78.PP
79recycle:maxsize = BYTES
80.RS 4
81Files that are larger than the number of bytes specified by this parameter will not be put into the repository\.
82.RE
83.PP
84recycle:exclude = LIST
85.RS 4
86List of files that should not be put into the repository when deleted, but deleted in the normal way\. Wildcards such as * and ? are supported\.
87.RE
88.PP
89recycle:exclude_dir = LIST
90.RS 4
91List 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\.
92.RE
93.PP
94recycle:noversions = LIST
95.RS 4
96Specifies a list of paths (wildcards such as * and ? are supported) for which no versioning should be used\. Only useful when recycle:versions is enabled\.
97.RE
98.SH "EXAMPLES"
99.PP
100Log operations on all shares using the LOCAL1 facility and NOTICE priority:
101.sp
102.RS 4
103.nf
104 \fI[global]\fR
105 \fIvfs objects = recycle\fR
106 \fIrecycle:facility = LOCAL1\fR
107 \fIrecycle:priority = NOTICE\fR
108.fi
109.RE
110.SH "VERSION"
111.PP
112This man page is correct for version 3\.0\.25 of the Samba suite\.
113.SH "AUTHOR"
114.PP
115The 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\.
Note: See TracBrowser for help on using the repository browser.