From 512cf0ad50d30fcb35a28b0ef1b859d754f42a99 Mon Sep 17 00:00:00 2001 From: Karolin Seeger Date: Mon, 26 Jan 2009 14:17:23 +0100 Subject: [PATCH] docs: Add manpage for vfs_shadow_copy2. Karolin --- docs-xml/manpages-3/vfs_shadow_copy2.8.xml | 174 +++++++++++++++++++++++++++++ 1 file changed, 174 insertions(+) create mode 100644 docs-xml/manpages-3/vfs_shadow_copy2.8.xml diff --git a/docs-xml/manpages-3/vfs_shadow_copy2.8.xml b/docs-xml/manpages-3/vfs_shadow_copy2.8.xml new file mode 100644 index 00000000000..364dd59144e --- /dev/null +++ b/docs-xml/manpages-3/vfs_shadow_copy2.8.xml @@ -0,0 +1,174 @@ + + + + + + vfs_shadow_copy2 + 8 + Samba + System Administration tools + 3.2 + + + + + vfs_shadow_copy2 + Expose snapshots to Windows clients as shadow copies. + + + + + vfs objects = shadow_copy2 + + + + + DESCRIPTION + + This VFS module is part of the + samba + 7 suite. + + The vfs_shadow_copy2 VFS module functionality + that is similar to Microsoft Shadow Copy services. When setup properly, + this module allows Microsoft Shadow Copy clients to browse + "shadow copies" on Samba shares. + + + This is a 2nd implementation of a shadow copy module. This + version has the following features: + + You don't need to populate your shares with symlinks to the + snapshots. This can be very important when you have thousands of + shares, or use [homes]. + The inode number of the files is altered so it is different + from the original. This allows the 'restore' button to work + without a sharing violation. + + + This module is stackable. + + + + + CONFIGURATION + + vfs_shadow_copy2 relies on a filesystem + snapshot implementation. Many common filesystems have native + support for this. + + + Filesystem snapshots must be mounted on + specially named directories in order to be recognized by + vfs_shadow_copy2. The snapshot mount points must + be immediate children of a the directory being shared. + + The snapshot naming convention is @GMT-YYYY.MM.DD-hh.mm.ss, + where: + + YYYY is the 4 digit year + MM is the 2 digit month + DD is the 2 digit day + hh is the 2 digit hour + mm is the 2 digit minute + ss is the 2 digit second. + + + + The vfs_shadow_copy2 snapshot naming convention can be + produced with the following date + 1 command: + + TZ=GMT date +@GMT-%Y.%m.%d-%H.%M.%S + + + + + + OPTIONS + + + + shadow:snapdir = SNAPDIR + + + Path to the directory where snapshots are kept. + + + + + + shadow:basedir = BASEDIR + + + Path to the base directory that snapshots are from. + + + + + + shadow:fixinodes = yes/no + + + If you enable shadow:fixinodes + then this module will modify the apparent inode + number of files in the snapshot directories using a hash of the + files path. This is needed for snapshot systems where the + snapshots have the same device:inode number as the original + files (such as happens with GPFS snapshots). If you don't set + this option then the 'restore' button in the shadow copy UI + will fail with a sharing violation. + + + + + + + + EXAMPLES + + Add shadow copy support to user home directories: + + + shadow_copy2 + /data/snaphots + /data/home + + + + + + CAVEATS + + This is not a backup, archival, or version control solution. + + + With Samba or Windows servers, + vfs_shadow_copy2 is designed to be an end-user + tool only. It does not replace or enhance your backup and + archival solutions and should in no way be considered as + such. Additionally, if you need version control, implement a + version control system. + + + + + + + VERSION + + This man page is correct for version 3.2.7 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. + + + + -- 2.11.4.GIT