source: branches/samba-3.5.x/docs/manpages/vfs_shadow_copy.8

Last change on this file was 773, checked in by Herwig Bauernfeind, 12 years ago

Samba Server 3.5: Update branch to 3.5.20

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