~zulcss/samba/server-dailies-3.4

« back to all changes in this revision

Viewing changes to docs/manpages/vfs_shadow_copy.8

  • Committer: Chuck Short
  • Date: 2010-09-28 20:38:39 UTC
  • Revision ID: zulcss@ubuntu.com-20100928203839-pgjulytsi9ue63x1
Initial version

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\"     Title: vfs_shadow_copy
 
2
.\"    Author: [see the "AUTHOR" section]
 
3
.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
 
4
.\"      Date: 05/10/2010
 
5
.\"    Manual: System Administration tools
 
6
.\"    Source: Samba 3.4
 
7
.\"  Language: English
 
8
.\"
 
9
.TH "VFS_SHADOW_COPY" "8" "05/10/2010" "Samba 3\&.4" "System Administration tools"
 
10
.\" -----------------------------------------------------------------
 
11
.\" * (re)Define some macros
 
12
.\" -----------------------------------------------------------------
 
13
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
14
.\" toupper - uppercase a string (locale-aware)
 
15
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
16
.de toupper
 
17
.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
 
18
\\$*
 
19
.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
 
20
..
 
21
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
22
.\" SH-xref - format a cross-reference to an SH section
 
23
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
24
.de SH-xref
 
25
.ie n \{\
 
26
.\}
 
27
.toupper \\$*
 
28
.el \{\
 
29
\\$*
 
30
.\}
 
31
..
 
32
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
33
.\" SH - level-one heading that works better for non-TTY output
 
34
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
35
.de1 SH
 
36
.\" put an extra blank line of space above the head in non-TTY output
 
37
.if t \{\
 
38
.sp 1
 
39
.\}
 
40
.sp \\n[PD]u
 
41
.nr an-level 1
 
42
.set-an-margin
 
43
.nr an-prevailing-indent \\n[IN]
 
44
.fi
 
45
.in \\n[an-margin]u
 
46
.ti 0
 
47
.HTML-TAG ".NH \\n[an-level]"
 
48
.it 1 an-trap
 
49
.nr an-no-space-flag 1
 
50
.nr an-break-flag 1
 
51
\." make the size of the head bigger
 
52
.ps +3
 
53
.ft B
 
54
.ne (2v + 1u)
 
55
.ie n \{\
 
56
.\" if n (TTY output), use uppercase
 
57
.toupper \\$*
 
58
.\}
 
59
.el \{\
 
60
.nr an-break-flag 0
 
61
.\" if not n (not TTY), use normal case (not uppercase)
 
62
\\$1
 
63
.in \\n[an-margin]u
 
64
.ti 0
 
65
.\" if not n (not TTY), put a border/line under subheading
 
66
.sp -.6
 
67
\l'\n(.lu'
 
68
.\}
 
69
..
 
70
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
71
.\" SS - level-two heading that works better for non-TTY output
 
72
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
73
.de1 SS
 
74
.sp \\n[PD]u
 
75
.nr an-level 1
 
76
.set-an-margin
 
77
.nr an-prevailing-indent \\n[IN]
 
78
.fi
 
79
.in \\n[IN]u
 
80
.ti \\n[SN]u
 
81
.it 1 an-trap
 
82
.nr an-no-space-flag 1
 
83
.nr an-break-flag 1
 
84
.ps \\n[PS-SS]u
 
85
\." make the size of the head bigger
 
86
.ps +2
 
87
.ft B
 
88
.ne (2v + 1u)
 
89
.if \\n[.$] \&\\$*
 
90
..
 
91
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
92
.\" BB/BE - put background/screen (filled box) around block of text
 
93
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
94
.de BB
 
95
.if t \{\
 
96
.sp -.5
 
97
.br
 
98
.in +2n
 
99
.ll -2n
 
100
.gcolor red
 
101
.di BX
 
102
.\}
 
103
..
 
104
.de EB
 
105
.if t \{\
 
106
.if "\\$2"adjust-for-leading-newline" \{\
 
107
.sp -1
 
108
.\}
 
109
.br
 
110
.di
 
111
.in
 
112
.ll
 
113
.gcolor
 
114
.nr BW \\n(.lu-\\n(.i
 
115
.nr BH \\n(dn+.5v
 
116
.ne \\n(BHu+.5v
 
117
.ie "\\$2"adjust-for-leading-newline" \{\
 
118
\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 
119
.\}
 
120
.el \{\
 
121
\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 
122
.\}
 
123
.in 0
 
124
.sp -.5v
 
125
.nf
 
126
.BX
 
127
.in
 
128
.sp .5v
 
129
.fi
 
130
.\}
 
131
..
 
132
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
133
.\" BM/EM - put colored marker in margin next to block of text
 
134
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
135
.de BM
 
136
.if t \{\
 
137
.br
 
138
.ll -2n
 
139
.gcolor red
 
140
.di BX
 
141
.\}
 
142
..
 
143
.de EM
 
144
.if t \{\
 
145
.br
 
146
.di
 
147
.ll
 
148
.gcolor
 
149
.nr BH \\n(dn
 
150
.ne \\n(BHu
 
151
\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
 
152
.in 0
 
153
.nf
 
154
.BX
 
155
.in
 
156
.fi
 
157
.\}
 
158
..
 
159
.\" -----------------------------------------------------------------
 
160
.\" * set default formatting
 
161
.\" -----------------------------------------------------------------
 
162
.\" disable hyphenation
 
163
.nh
 
164
.\" disable justification (adjust text to left margin only)
 
165
.ad l
 
166
.\" -----------------------------------------------------------------
 
167
.\" * MAIN CONTENT STARTS HERE *
 
168
.\" -----------------------------------------------------------------
 
169
.SH "Name"
 
170
vfs_shadow_copy \- Make a Samba share read only for a specified time period
 
171
.SH "Synopsis"
 
172
.fam C
 
173
.HP \w'\ 'u
 
174
\FCvfs objects = shadow_copy\F[]
 
175
.fam
 
176
.SH "DESCRIPTION"
 
177
.PP
 
178
This VFS module is part of the
 
179
\fBsamba\fR(7)
 
180
suite\&.
 
181
.PP
 
182
The
 
183
\FCvfs_shadow_copy\F[]
 
184
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\&.
 
185
.PP
 
186
This module is stackable\&.
 
187
.SH "CONFIGURATION"
 
188
.PP
 
189
\FCvfs_shadow_copy\F[]
 
190
relies on a filesystem snapshot implementation\&. Many common filesystems have native support for this\&.
 
191
.PP
 
192
Filesystem snapshots must be mounted on specially named directories in order to be recognized by
 
193
\FCvfs_shadow_copy\F[]\&. The snapshot mount points must be immediate children of a the directory being shared\&.
 
194
.PP
 
195
The snapshot naming convention is @GMT\-YYYY\&.MM\&.DD\-hh\&.mm\&.ss, where:
 
196
.sp
 
197
.RS 4
 
198
.ie n \{\
 
199
\h'-04'\(bu\h'+03'\c
 
200
.\}
 
201
.el \{\
 
202
.sp -1
 
203
.IP \(bu 2.3
 
204
.\}
 
205
\FCYYYY\F[]
 
206
is the 4 digit year
 
207
.RE
 
208
.sp
 
209
.RS 4
 
210
.ie n \{\
 
211
\h'-04'\(bu\h'+03'\c
 
212
.\}
 
213
.el \{\
 
214
.sp -1
 
215
.IP \(bu 2.3
 
216
.\}
 
217
\FCMM\F[]
 
218
is the 2 digit month
 
219
.RE
 
220
.sp
 
221
.RS 4
 
222
.ie n \{\
 
223
\h'-04'\(bu\h'+03'\c
 
224
.\}
 
225
.el \{\
 
226
.sp -1
 
227
.IP \(bu 2.3
 
228
.\}
 
229
\FCDD\F[]
 
230
is the 2 digit day
 
231
.RE
 
232
.sp
 
233
.RS 4
 
234
.ie n \{\
 
235
\h'-04'\(bu\h'+03'\c
 
236
.\}
 
237
.el \{\
 
238
.sp -1
 
239
.IP \(bu 2.3
 
240
.\}
 
241
\FChh\F[]
 
242
is the 2 digit hour
 
243
.RE
 
244
.sp
 
245
.RS 4
 
246
.ie n \{\
 
247
\h'-04'\(bu\h'+03'\c
 
248
.\}
 
249
.el \{\
 
250
.sp -1
 
251
.IP \(bu 2.3
 
252
.\}
 
253
\FCmm\F[]
 
254
is the 2 digit minute
 
255
.RE
 
256
.sp
 
257
.RS 4
 
258
.ie n \{\
 
259
\h'-04'\(bu\h'+03'\c
 
260
.\}
 
261
.el \{\
 
262
.sp -1
 
263
.IP \(bu 2.3
 
264
.\}
 
265
\FCss\F[]
 
266
is the 2 digit second\&.
 
267
.sp
 
268
.RE
 
269
.PP
 
270
The
 
271
\FCvfs_shadow_copy\F[]
 
272
snapshot naming convention can be produced with the following
 
273
\fBdate\fR(1)
 
274
command:
 
275
.sp
 
276
.if n \{\
 
277
.RS 4
 
278
.\}
 
279
.fam C
 
280
.ps -1
 
281
.nf
 
282
.if t \{\
 
283
.sp -1
 
284
.\}
 
285
.BB lightgray adjust-for-leading-newline
 
286
.sp -1
 
287
 
 
288
        TZ=GMT date +@GMT\-%Y\&.%m\&.%d\-%H\&.%M\&.%S
 
289
        
 
290
.EB lightgray adjust-for-leading-newline
 
291
.if t \{\
 
292
.sp 1
 
293
.\}
 
294
.fi
 
295
.fam
 
296
.ps +1
 
297
.if n \{\
 
298
.RE
 
299
.\}
 
300
.SH "EXAMPLES"
 
301
.PP
 
302
Add shadow copy support to user home directories:
 
303
.sp
 
304
.if n \{\
 
305
.RS 4
 
306
.\}
 
307
.fam C
 
308
.ps -1
 
309
.nf
 
310
.if t \{\
 
311
.sp -1
 
312
.\}
 
313
.BB lightgray adjust-for-leading-newline
 
314
.sp -1
 
315
 
 
316
        \fI[homes]\fR
 
317
        \m[blue]\fBvfs objects = shadow_copy\fR\m[]
 
318
.EB lightgray adjust-for-leading-newline
 
319
.if t \{\
 
320
.sp 1
 
321
.\}
 
322
.fi
 
323
.fam
 
324
.ps +1
 
325
.if n \{\
 
326
.RE
 
327
.\}
 
328
.SH "CAVEATS"
 
329
.PP
 
330
This is not a backup, archival, or version control solution\&.
 
331
.PP
 
332
With Samba or Windows servers,
 
333
\FCvfs_shadow_copy\F[]
 
334
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\&.
 
335
.SH "VERSION"
 
336
.PP
 
337
This man page is correct for version 3\&.0\&.25 of the Samba suite\&.
 
338
.SH "AUTHOR"
 
339
.PP
 
340
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\&.