Changeset 429 for trunk/server/docs/manpages/vfs_shadow_copy2.8

Timestamp:

Apr 9, 2010, 3:51:41 PM (16 years ago)

Author:

Silvan Scherrer

Message:

Samba 3.5.x: trunk update to 3.5.2

Location:

trunk/server

Files:

• . (modified) (1 prop)
• docs/manpages/vfs_shadow_copy2.8 (modified) (15 diffs)

trunk/server/docs/manpages/vfs_shadow_copy2.8

@@ -1 @@
-'\" t
 .\"     Title: vfs_shadow_copy2
 .\"    Author: [see the "AUTHOR" section]
-.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\"      Date: 02/19/2010
+.\" Generator: DocBook XSL Stylesheets v1.7 <http://docbook.sf.net/>
+.\"      Date: 0/2010
 .\"    Manual: System Administration tools
 .\"    Source: Samba 3.5
 .\"  Language: English
 .\"
-.TH "VFS_SHADOW_COPY2" "8" "02/19/2010" "Samba 3\&.5" "System Administration tools"
+.TH "VFS_SHADOW_COPY2" "8" "03/30/2010" "Samba 3\&.5" "System Administration tools"
+.\" -----------------------------------------------------------------
+.\" * (re)Define some macros
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" toupper - uppercase a string (locale-aware)
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de toupper
+.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
+\\$*
+.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SH-xref - format a cross-reference to an SH section
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de SH-xref
+.ie n \{\
+.\}
+.toupper \\$*
+.el \{\
+\\$*
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SH - level-one heading that works better for non-TTY output
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de1 SH
+.\" put an extra blank line of space above the head in non-TTY output
+.if t \{\
+.sp 1
+.\}
+.sp \\n[PD]u
+.nr an-level 1
+.set-an-margin
+.nr an-prevailing-indent \\n[IN]
+.fi
+.in \\n[an-margin]u
+.ti 0
+.HTML-TAG ".NH \\n[an-level]"
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+\." make the size of the head bigger
+.ps +3
+.ft B
+.ne (2v + 1u)
+.ie n \{\
+.\" if n (TTY output), use uppercase
+.toupper \\$*
+.\}
+.el \{\
+.nr an-break-flag 0
+.\" if not n (not TTY), use normal case (not uppercase)
+\\$1
+.in \\n[an-margin]u
+.ti 0
+.\" if not n (not TTY), put a border/line under subheading
+.sp -.6
+\l'\n(.lu'
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SS - level-two heading that works better for non-TTY output
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de1 SS
+.sp \\n[PD]u
+.nr an-level 1
+.set-an-margin
+.nr an-prevailing-indent \\n[IN]
+.fi
+.in \\n[IN]u
+.ti \\n[SN]u
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.ps \\n[PS-SS]u
+\." make the size of the head bigger
+.ps +2
+.ft B
+.ne (2v + 1u)
+.if \\n[.$] \&\\$*
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" BB/BE - put background/screen (filled box) around block of text
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de BB
+.if t \{\
+.sp -.5
+.br
+.in +2n
+.ll -2n
+.gcolor red
+.di BX
+.\}
+..
+.de EB
+.if t \{\
+.if "\\$2"adjust-for-leading-newline" \{\
+.sp -1
+.\}
+.br
+.di
+.in
+.ll
+.gcolor
+.nr BW \\n(.lu-\\n(.i
+.nr BH \\n(dn+.5v
+.ne \\n(BHu+.5v
+.ie "\\$2"adjust-for-leading-newline" \{\
+\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
+.\}
+.el \{\
+\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
+.\}
+.in 0
+.sp -.5v
+.nf
+.BX
+.in
+.sp .5v
+.fi
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" BM/EM - put colored marker in margin next to block of text
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de BM
+.if t \{\
+.br
+.ll -2n
+.gcolor red
+.di BX
+.\}
+..
+.de EM
+.if t \{\
+.br
+.di
+.ll
+.gcolor
+.nr BH \\n(dn
+.ne \\n(BHu
+\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
+.in 0
+.nf
+.BX
+.in
+.fi
+.\}
+..
 .\" -----------------------------------------------------------------
 .\" * set default formatting
@@ -19 +167 @@
 .\" * MAIN CONTENT STARTS HERE *
 .\" -----------------------------------------------------------------
-.SH "NAME"
+.SH "N"
 vfs_shadow_copy2 \- Expose snapshots to Windows clients as shadow copies\&.
-.SH "SYNOPSIS"
+.SH "Synopsis"
+.fam C
 .HP \w'\ 'u
-vfs objects = shadow_copy2
+\FCvfs objects = shadow_copy2\F[]
+.fam
 .SH "DESCRIPTION"
 .PP
@@ -31 +181 @@
 .PP
 The
-vfs_shadow_copy2
+\FCvfs_shadow_copy2\F[]
 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\&.
 .PP
@@ -63 +213 @@
 .SH "CONFIGURATION"
 .PP
-vfs_shadow_copy2
+\FCvfs_shadow_copy2\F[]
 relies on a filesystem snapshot implementation\&. Many common filesystems have native support for this\&.
 .PP
 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 mount points must be immediate children of a the directory being shared\&.
 .PP
 The snapshot naming convention is @GMT\-YYYY\&.MM\&.DD\-hh\&.mm\&.ss, where:
@@ -79 +229 @@
 .IP \(bu 2.3
 .\}
-YYYY
+\FCYYYY\F[]
 is the 4 digit year
 .RE
@@ -91 +241 @@
 .IP \(bu 2.3
 .\}
-MM
+\FCMM\F[]
 is the 2 digit month
 .RE
@@ -103 +253 @@
 .IP \(bu 2.3
 .\}
-DD
+\FCDD\F[]
 is the 2 digit day
 .RE
@@ -115 +265 @@
 .IP \(bu 2.3
 .\}
-hh
+\FChh\F[]
 is the 2 digit hour
 .RE
@@ -127 +277 @@
 .IP \(bu 2.3
 .\}
-mm
+\FCmm\F[]
 is the 2 digit minute
 .RE
@@ -139 +289 @@
 .IP \(bu 2.3
 .\}
-ss
+\FCss\F[]
 is the 2 digit second\&.
 .sp
@@ -145 +295 @@
 .PP
 The
-vfs_shadow_copy2
+\FCvfs_shadow_copy2\F[]
 snapshot naming convention can be produced with the following
 \fBdate\fR(1)
@@ -153 +303 @@
 .RS 4
 .\}
+
+
 .nf
+
+
+
+
+
+
         TZ=GMT date +@GMT\-%Y\&.%m\&.%d\-%H\&.%M\&.%S
         
-.fi
+.EB lightgray adjust-for-leading-newline
+.if t \{\
+.sp 1
+.\}
+.fi
+.fam
+.ps +1
 .if n \{\
 .RE
@@ -175 +339 @@
 .RS 4
 If you enable
-shadow:fixinodes
+\FCshadow:fixinodes \F[]
 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\&.
 .RE
@@ -185 +349 @@
 .RS 4
 .\}
+
+
 .nf
+
+
+
+
+
+
         \fI[homes]\fR
         \m[blue]\fBvfs objects = shadow_copy2\fR\m[]
         \m[blue]\fBshadow:snapdir = /data/snaphots\fR\m[]
         \m[blue]\fBshadow:basedir = /data/home\fR\m[]
-.fi
+.EB lightgray adjust-for-leading-newline
+.if t \{\
+.sp 1
+.\}
+.fi
+.fam
+.ps +1
 .if n \{\
 .RE
@@ -199 +377 @@
 .PP
 With Samba or Windows servers,
-vfs_shadow_copy2
+\FCvfs_shadow_copy2\F[]
 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\&.
 .SH "VERSION"