From 5cfd060669ebc85272c60519d12c25283bb56550 Mon Sep 17 00:00:00 2001 From: James Peach Date: Wed, 28 Feb 2007 17:03:01 +0000 Subject: Document the recycle VFS module. (This used to be commit 4fac3bf9353dcd96b10673062eb59c2ff743036e) --- docs/manpages-3/smb-vfs-recycle.8.xml | 202 ++++++++++++++++++++++++++++++++++ 1 file changed, 202 insertions(+) create mode 100644 docs/manpages-3/smb-vfs-recycle.8.xml diff --git a/docs/manpages-3/smb-vfs-recycle.8.xml b/docs/manpages-3/smb-vfs-recycle.8.xml new file mode 100644 index 0000000000..923550de75 --- /dev/null +++ b/docs/manpages-3/smb-vfs-recycle.8.xml @@ -0,0 +1,202 @@ + + + + + + smb-vfs-recycle + 8 + + + + + recycle + Samba VFS recycle bin + + + + + vfs objects = recycle + + + + + DESCRIPTION + + This module is part of the samba + 7 suite. + + The recycle 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. + + The 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. + + + This module is stackable. + + + + + + OPTIONS + + + + + recycle:repository = PATH + + Path of the directory where deleted files should be moved. + + If this option is not set, the default path .recycle + is used. + + + + + recycle:directory_mode = MODE + + Set 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. + + If this option is not set, the default mode + 0700 is used. + + + + + recycle:subdir_mode = MODE + + Set MODE to the octal mode with which + sub directories of the recycle repository should be created. + + If this option is not set, subdirectories + will be created with the mode from recycle:directory_mode. + + + + + + recycle:keeptree = BOOL + + Specifies 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. + + + + + + recycle:versions = BOOL + + If 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". + + + + + + recycle:touch = BOOL + + Specifies whether a file's access date should be + updated when the file is moved to the repository. + + + + + + recycle:touch_mtime = BOOL + + Specifies whether a file's last modified date should be + updated when the file is moved to the repository. + + + + + + recycle:maxsize = BYTES + + Files that are larger than the number of bytes + specified by this parameter will not be put into the + repository. + + + + + + recycle:exclude = LIST + + List of files that should not be put into the + repository when deleted, but deleted in the normal way. + + + + + + recycle:exclude_dir = LIST + + List of directories whose files should not be put + into the repository when deleted, but deleted in the + normal way. + + + + + + recycle:noversions = LIST + + Specifies a list of paths (wildcards such as * + and ? are supported) for which no versioning should + be used. Only useful when recycle:versions is enabled. + + + + + + + + + EXAMPLES + + Log operations on all shares using the LOCAL1 facility + and NOTICE priority: + + + + recycle + LOCAL1 + NOTICE + + + + + + VERSION + + This man page is correct for version 3.0.25 of the Samba suite. + + + + + AUTHOR + + The 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. + + + + -- cgit