3f387441820b6d5ae0fb6c0763b00a21f8570596
[sfrench/samba-autobuild/.git] / docs-xml / manpages / vfs_recycle.8.xml
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
3 <refentry id="vfs_recycle.8">
4
5 <refmeta>
6         <refentrytitle>vfs_recycle</refentrytitle>
7         <manvolnum>8</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
10         <refmiscinfo class="version">&doc.version;</refmiscinfo>
11 </refmeta>
12
13
14 <refnamediv>
15         <refname>vfs_recycle</refname>
16         <refpurpose>Samba VFS recycle bin</refpurpose>
17 </refnamediv>
18
19 <refsynopsisdiv>
20         <cmdsynopsis>
21                 <command>vfs objects = recycle</command>
22         </cmdsynopsis>
23 </refsynopsisdiv>
24
25 <refsect1>
26         <title>DESCRIPTION</title>
27
28         <para>This VFS module is part of the
29         <citerefentry><refentrytitle>samba</refentrytitle>
30         <manvolnum>7</manvolnum></citerefentry> suite.</para>
31
32         <para>The <command>vfs_recycle</command> intercepts file deletion
33         requests and moves the affected files to a temporary repository
34         rather than deleting them immediately. This gives the same effect
35         as the Recycle Bin on Windows computers. </para>
36
37         <para>The Recycle Bin will not appear in Windows Explorer
38         views of the network file system (share) nor on any mapped
39         drive. Instead, a directory called .recycle will be automatically
40         created when the first file is deleted and recycle:repository is
41         not configured. If recycle:repository is configured, the name
42         of the created directory depends on recycle:repository. Users
43         can recover files from the recycle bin. If the recycle:keeptree
44         option has been specified, deleted files will be found in a path
45         identical with that from which the file was deleted.  </para>
46
47
48         <para>This module is stackable.</para>
49
50 </refsect1>
51
52
53 <refsect1>
54         <title>OPTIONS</title>
55
56         <variablelist>
57
58                 <varlistentry>
59                 <term>recycle:repository = PATH</term>
60                 <listitem>
61                 <para>Path of the directory where deleted files should be moved.
62                 </para>
63                 <para>If this option is not set, the default path .recycle
64                 is used. </para>
65                 </listitem>
66                 </varlistentry>
67
68                 <varlistentry>
69                 <term>recycle:directory_mode = MODE</term>
70                 <listitem>
71                 <para>Set MODE to the octal mode the recycle repository
72                 should be created with.  The recycle repository will be
73                 created when first file is deleted. If recycle:subdir_mode
74                 is not set, MODE also applies to subdirectories.
75                 </para>
76                 <para>If this option is not set, the default mode
77                 0700 is used. </para>
78                 </listitem>
79                 </varlistentry>
80
81                 <varlistentry>
82                 <term>recycle:subdir_mode = MODE</term>
83                 <listitem>
84                 <para>Set MODE to the octal mode with which
85                 sub directories of the recycle repository should be created.
86                 </para>
87                 <para>If this option is not set, subdirectories
88                 will be created with the mode from recycle:directory_mode.
89                 </para>
90                 </listitem>
91                 </varlistentry>
92
93                 <varlistentry>
94                 <term>recycle:keeptree = BOOL</term>
95                 <listitem>
96                 <para>Specifies whether the directory structure should
97                 be preserved or whether the files in a directory that is being
98                 deleted should be kept separately in the repository.
99                 </para>
100                 </listitem>
101                 </varlistentry>
102
103                 <varlistentry>
104                 <term>recycle:versions = BOOL</term>
105                 <listitem>
106                 <para>If this option is True, two files with the same
107                 name that are deleted will both be kept in the repository.
108                 Newer deleted versions of a file will be called
109                 &quot;Copy #x of filename&quot;.
110                 </para>
111                 </listitem>
112                 </varlistentry>
113
114                 <varlistentry>
115                 <term>recycle:touch = BOOL</term>
116                 <listitem>
117                 <para>Specifies whether a file's access date should be
118                 updated when the file is moved to the repository.
119                 </para>
120                 </listitem>
121                 </varlistentry>
122
123                 <varlistentry>
124                 <term>recycle:touch_mtime = BOOL</term>
125                 <listitem>
126                 <para>Specifies whether a file's last modified date should be
127                 updated when the file is moved to the repository.
128                 </para>
129                 </listitem>
130                 </varlistentry>
131
132                 <varlistentry>
133                 <term>recycle:minsize = BYTES</term>
134                 <listitem>
135                 <para>Files that are smaller than the number of bytes
136                 specified by this parameter will not be put into the
137                 repository.
138                 </para>
139                 </listitem>
140                 </varlistentry>
141
142                 <varlistentry>
143                 <term>recycle:maxsize = BYTES</term>
144                 <listitem>
145                 <para>Files that are larger than the number of bytes
146                 specified by this parameter will not be put into the
147                 repository.
148                 </para>
149                 </listitem>
150                 </varlistentry>
151
152                 <varlistentry>
153                 <term>recycle:exclude = LIST</term>
154                 <listitem>
155                 <para>List of files that should not be put into the
156                 repository when deleted, but deleted in the normal way.
157                 Wildcards such as * and ? are supported.
158                 </para>
159                 </listitem>
160                 </varlistentry>
161
162                 <varlistentry>
163                 <term>recycle:exclude_dir = LIST</term>
164                 <listitem>
165                 <para>List of directories whose files should not be put
166                 into the repository when deleted, but deleted in the
167                 normal way. Wildcards such as * and ? are supported.
168                 </para>
169                 </listitem>
170                 </varlistentry>
171
172                 <varlistentry>
173                 <term>recycle:noversions = LIST</term>
174                 <listitem>
175                 <para>Specifies a list of paths (wildcards such as *
176                 and ? are supported) for which no versioning should
177                 be used. Only useful when recycle:versions is enabled.
178                 </para>
179                 </listitem>
180                 </varlistentry>
181
182         </variablelist>
183 </refsect1>
184
185 <refsect1>
186         <title>EXAMPLES</title>
187
188         <para>Move files "deleted" on <parameter>share</parameter> to
189         <parameter>/data/share/.recycle</parameter> instead of deleting them:
190         </para>
191
192 <programlisting>
193         <smbconfsection name="[share]"/>
194         <smbconfoption name="path">/data/share</smbconfoption>
195         <smbconfoption name="vfs objects">recycle</smbconfoption>
196         <smbconfoption name="recycle:repository">.recycle</smbconfoption>
197         <smbconfoption name="recycle:keeptree">yes</smbconfoption>
198         <smbconfoption name="recycle:versions">yes</smbconfoption>
199 </programlisting>
200
201 </refsect1>
202
203 <refsect1>
204         <title>VERSION</title>
205
206         <para>This man page is correct for version &doc.version; of the Samba suite.
207         </para>
208 </refsect1>
209
210 <refsect1>
211         <title>AUTHOR</title>
212
213         <para>The original Samba software and related utilities
214         were created by Andrew Tridgell. Samba is now developed
215         by the Samba Team as an Open Source project similar
216         to the way the Linux kernel is developed.</para>
217
218 </refsect1>
219
220 </refentry>