source: trunk/samba/docs/manpages/vfs_recycle.8 @ 26

Last change on this file since 26 was 26, checked in by Paul Smedley, 14 years ago

Updated source to 3.0.25rc1

File size: 4.1 KB
Line 
1.\"Generated by db2man.xsl. Don't modify this, modify the source.
2.de Sh \" Subsection
3.br
4.if t .Sp
5.ne 5
6.PP
7\fB\\$1\fR
8.PP
9..
10.de Sp \" Vertical space (when we can't use .PP)
11.if t .sp .5v
12.if n .sp
13..
14.de Ip \" List item
15.br
16.ie \\n(.$>=3 .ne \\$3
17.el .ne 3
18.IP "\\$1" \\$2
19..
20.TH "VFS_RECYCLE" 8 "" "" ""
21.SH NAME
22vfs_recycle \- Samba VFS recycle bin
23.SH "SYNOPSIS"
24.ad l
25.hy 0
26.HP 22
27\fBvfs objects = recycle\fR
28.ad
29.hy
30
31.SH "DESCRIPTION"
32
33.PP
34This VFS module is part of the\fBsamba\fR(7) suite\&.
35
36.PP
37The \fBvfs_recycle\fR 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\&.
38
39.PP
40The 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\&.
41
42.PP
43This module is stackable\&.
44
45.SH "OPTIONS"
46
47.TP
48recycle:repository = PATH
49Path of the directory where deleted files should be moved\&.
50
51If this option is not set, the default path \&.recycle is used\&.
52
53.TP
54recycle:directory_mode = MODE
55Set 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\&.
56
57If this option is not set, the default mode 0700 is used\&.
58
59.TP
60recycle:subdir_mode = MODE
61Set MODE to the octal mode with which sub directories of the recycle repository should be created\&.
62
63If this option is not set, subdirectories will be created with the mode from recycle:directory_mode\&.
64
65.TP
66recycle:keeptree = BOOL
67Specifies 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\&.
68
69.TP
70recycle:versions = BOOL
71If 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"\&.
72
73.TP
74recycle:touch = BOOL
75Specifies whether a file's access date should be updated when the file is moved to the repository\&.
76
77.TP
78recycle:touch_mtime = BOOL
79Specifies whether a file's last modified date should be updated when the file is moved to the repository\&.
80
81.TP
82recycle:minsize = BYTES
83Files that are smaller than the number of bytes specified by this parameter will not be put into the repository\&.
84
85.TP
86recycle:maxsize = BYTES
87Files that are larger than the number of bytes specified by this parameter will not be put into the repository\&.
88
89.TP
90recycle:exclude = LIST
91List of files that should not be put into the repository when deleted, but deleted in the normal way\&. Wildcards such as * and ? are supported\&.
92
93.TP
94recycle:exclude_dir = LIST
95List 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\&.
96
97.TP
98recycle:noversions = LIST
99Specifies a list of paths (wildcards such as * and ? are supported) for which no versioning should be used\&. Only useful when recycle:versions is enabled\&.
100
101.SH "EXAMPLES"
102
103.PP
104Log operations on all shares using the LOCAL1 facility and NOTICE priority:
105
106.nf
107
108        \fI[global]\fR
109        vfs objects = recycle
110        recycle:facility = LOCAL1
111        recycle:priority = NOTICE
112
113.fi
114
115.SH "VERSION"
116
117.PP
118This man page is correct for version 3\&.0\&.25 of the Samba suite\&.
119
120.SH "AUTHOR"
121
122.PP
123The 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\&.
124
Note: See TracBrowser for help on using the repository browser.