| 1 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>vfs_recycle</title><link rel="stylesheet" href="../samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="vfs_recycle"><a name="vfs_recycle.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>vfs_recycle — Samba VFS recycle bin</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">vfs objects = recycle</code></p></div></div><div class="refsect1" title="DESCRIPTION"><a name="id2528903"></a><h2>DESCRIPTION</h2><p>This VFS module is part of the
|
|---|
| 2 | <a class="citerefentry" href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>The <code class="literal">vfs_recycle</code> intercepts file deletion
|
|---|
| 3 | requests and moves the affected files to a temporary repository
|
|---|
| 4 | rather than deleting them immediately. This gives the same effect
|
|---|
| 5 | as the Recycle Bin on Windows computers. </p><p>The Recycle Bin will not appear in Windows Explorer
|
|---|
| 6 | views of the network file system (share) nor on any mapped
|
|---|
| 7 | drive. Instead, a directory called .recycle will be automatically
|
|---|
| 8 | created when the first file is deleted and recycle:repository is
|
|---|
| 9 | not configured. If recycle:repository is configured, the name
|
|---|
| 10 | of the created directory depends on recycle:repository. Users
|
|---|
| 11 | can recover files from the recycle bin. If the recycle:keeptree
|
|---|
| 12 | option has been specified, deleted files will be found in a path
|
|---|
| 13 | identical with that from which the file was deleted. </p><p>This module is stackable.</p></div><div class="refsect1" title="OPTIONS"><a name="id2489308"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">recycle:repository = PATH</span></dt><dd><p>Path of the directory where deleted files should be moved.
|
|---|
| 14 | </p><p>If this option is not set, the default path .recycle
|
|---|
| 15 | is used. </p></dd><dt><span class="term">recycle:directory_mode = MODE</span></dt><dd><p>Set MODE to the octal mode the recycle repository
|
|---|
| 16 | should be created with. The recycle repository will be
|
|---|
| 17 | created when first file is deleted. If recycle:subdir_mode
|
|---|
| 18 | is not set, MODE also applies to subdirectories.
|
|---|
| 19 | </p><p>If this option is not set, the default mode
|
|---|
| 20 | 0700 is used. </p></dd><dt><span class="term">recycle:subdir_mode = MODE</span></dt><dd><p>Set MODE to the octal mode with which
|
|---|
| 21 | sub directories of the recycle repository should be created.
|
|---|
| 22 | </p><p>If this option is not set, subdirectories
|
|---|
| 23 | will be created with the mode from recycle:directory_mode.
|
|---|
| 24 | </p></dd><dt><span class="term">recycle:keeptree = BOOL</span></dt><dd><p>Specifies whether the directory structure should
|
|---|
| 25 | be preserved or whether the files in a directory that is being
|
|---|
| 26 | deleted should be kept separately in the repository.
|
|---|
| 27 | </p></dd><dt><span class="term">recycle:versions = BOOL</span></dt><dd><p>If this option is True, two files with the same
|
|---|
| 28 | name that are deleted will both be kept in the repository.
|
|---|
| 29 | Newer deleted versions of a file will be called
|
|---|
| 30 | "Copy #x of filename".
|
|---|
| 31 | </p></dd><dt><span class="term">recycle:touch = BOOL</span></dt><dd><p>Specifies whether a file's access date should be
|
|---|
| 32 | updated when the file is moved to the repository.
|
|---|
| 33 | </p></dd><dt><span class="term">recycle:touch_mtime = BOOL</span></dt><dd><p>Specifies whether a file's last modified date should be
|
|---|
| 34 | updated when the file is moved to the repository.
|
|---|
|
|---|
