source: trunk/server/docs/manpages/vfs_shadow_copy.8

Last change on this file was 862, checked in by Silvan Scherrer, 11 years ago

Samba Server: update trunk to 3.6.23

File size: 3.8 KB
Line 
1'\" t
2.\" Title: vfs_shadow_copy
3.\" Author: [see the "AUTHOR" section]
4.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
5.\" Date: 09/18/2013
6.\" Manual: System Administration tools
7.\" Source: Samba 3.6
8.\" Language: English
9.\"
10.TH "VFS_SHADOW_COPY" "8" "09/18/2013" "Samba 3\&.6" "System Administration tools"
11.\" -----------------------------------------------------------------
12.\" * Define some portability stuff
13.\" -----------------------------------------------------------------
14.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15.\" http://bugs.debian.org/507673
16.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18.ie \n(.g .ds Aq \(aq
19.el .ds Aq '
20.\" -----------------------------------------------------------------
21.\" * set default formatting
22.\" -----------------------------------------------------------------
23.\" disable hyphenation
24.nh
25.\" disable justification (adjust text to left margin only)
26.ad l
27.\" -----------------------------------------------------------------
28.\" * MAIN CONTENT STARTS HERE *
29.\" -----------------------------------------------------------------
30.SH "NAME"
31vfs_shadow_copy \- Make a Samba share read only for a specified time period
32.SH "SYNOPSIS"
33.HP \w'\ 'u
34vfs objects = shadow_copy
35.SH "DESCRIPTION"
36.PP
37This VFS module is part of the
38\fBsamba\fR(7)
39suite\&.
40.PP
41The
42vfs_shadow_copy
43VFS 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\&.
44.PP
45This module is stackable\&.
46.SH "CONFIGURATION"
47.PP
48vfs_shadow_copy
49relies on a filesystem snapshot implementation\&. Many common filesystems have native support for this\&.
50.PP
51Filesystem snapshots must be mounted on specially named directories in order to be recognized by
52vfs_shadow_copy\&. The snapshot mount points must be immediate children of a the directory being shared\&.
53.PP
54The snapshot naming convention is @GMT\-YYYY\&.MM\&.DD\-hh\&.mm\&.ss, where:
55.sp
56.RS 4
57.ie n \{\
58\h'-04'\(bu\h'+03'\c
59.\}
60.el \{\
61.sp -1
62.IP \(bu 2.3
63.\}
64YYYY
65is the 4 digit year
66.RE
67.sp
68.RS 4
69.ie n \{\
70\h'-04'\(bu\h'+03'\c
71.\}
72.el \{\
73.sp -1
74.IP \(bu 2.3
75.\}
76MM
77is the 2 digit month
78.RE
79.sp
80.RS 4
81.ie n \{\
82\h'-04'\(bu\h'+03'\c
83.\}
84.el \{\
85.sp -1
86.IP \(bu 2.3
87.\}
88DD
89is the 2 digit day
90.RE
91.sp
92.RS 4
93.ie n \{\
94\h'-04'\(bu\h'+03'\c
95.\}
96.el \{\
97.sp -1
98.IP \(bu 2.3
99.\}
100hh
101is the 2 digit hour
102.RE
103.sp
104.RS 4
105.ie n \{\
106\h'-04'\(bu\h'+03'\c
107.\}
108.el \{\
109.sp -1
110.IP \(bu 2.3
111.\}
112mm
113is the 2 digit minute
114.RE
115.sp
116.RS 4
117.ie n \{\
118\h'-04'\(bu\h'+03'\c
119.\}
120.el \{\
121.sp -1
122.IP \(bu 2.3
123.\}
124ss
125is the 2 digit second\&.
126.RE
127.sp
128.RE
129.PP
130The
131vfs_shadow_copy
132snapshot naming convention can be produced with the following
133\fBdate\fR(1)
134command:
135.sp
136.if n \{\
137.RS 4
138.\}
139.nf
140 TZ=GMT date +@GMT\-%Y\&.%m\&.%d\-%H\&.%M\&.%S
141
142.fi
143.if n \{\
144.RE
145.\}
146.SH "EXAMPLES"
147.PP
148Add shadow copy support to user home directories:
149.sp
150.if n \{\
151.RS 4
152.\}
153.nf
154 \fI[homes]\fR
155 \m[blue]\fBvfs objects = shadow_copy\fR\m[]
156.fi
157.if n \{\
158.RE
159.\}
160.SH "CAVEATS"
161.PP
162This is not a backup, archival, or version control solution\&.
163.PP
164With Samba or Windows servers,
165vfs_shadow_copy
166is 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\&.
167.SH "VERSION"
168.PP
169This man page is correct for version 3\&.0\&.25 of the Samba suite\&.
170.SH "AUTHOR"
171.PP
172The 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\&.
Note: See TracBrowser for help on using the repository browser.