summaryrefslogtreecommitdiff
path: root/docs-xml
diff options
context:
space:
mode:
authorUri Simchoni <uri@samba.org>2015-11-03 13:21:58 +0200
committerMichael Adam <obnox@samba.org>2016-01-26 00:06:16 +0100
commitdee38e04d217a868721b622b5c9c22d3ba381790 (patch)
tree480bf2057ba1e7e1be73c363160fa092f33c6be2 /docs-xml
parentbbb5a8a9d545b4e3014bdcb96dd7c7d48cf0b8f7 (diff)
downloadsamba-dee38e04d217a868721b622b5c9c22d3ba381790.tar.gz
vfs_shadow_copy2: documentation for snapsharepath
Signed-off-by: Uri Simchoni <uri@samba.org> Reviewed-by: Michael Adam <obnox@samba.org>
Diffstat (limited to 'docs-xml')
-rw-r--r--docs-xml/manpages/vfs_shadow_copy2.8.xml40
1 files changed, 40 insertions, 0 deletions
diff --git a/docs-xml/manpages/vfs_shadow_copy2.8.xml b/docs-xml/manpages/vfs_shadow_copy2.8.xml
index 0bb95af2088..fbc06514538 100644
--- a/docs-xml/manpages/vfs_shadow_copy2.8.xml
+++ b/docs-xml/manpages/vfs_shadow_copy2.8.xml
@@ -226,6 +226,46 @@
</varlistentry>
<varlistentry>
+ <term>shadow:snapsharepath = SNAPSHAREPATH
+ </term>
+ <listitem>
+ <para>
+ With this parameter, one can specify the path of the share's
+ root directory in snapshots, relative to the snapshot's
+ root directory. It is an alternative method to
+ <command>shadow:basedir</command>, allowing greater control.
+ </para>
+ <para>
+ For example, if within each
+ snapshot the files of the share have a
+ <command>path/to/share/</command> prefix, then
+ <command>shadow:snapsharepath</command> can be
+ set to <command>path/to/share</command>.
+ </para>
+ <para>
+ With this parameter, it is no longer assumed that a
+ snapshot represents an image of the original file system or
+ a portion of it. For example, a system could perform
+ backups of only files contained in shares, and then
+ expose the backup files in a logical structure:
+ </para>
+ <itemizedlist>
+ <listitem><para>share1/</para></listitem>
+ <listitem><para>share2/</para></listitem>
+ <listitem><para>.../</para></listitem>
+ </itemizedlist>
+ <para>
+ Note that the <command>shadow:snapdirseverywhere</command>
+ and the <command>shadow:basedir</command> options
+ are incompatible with <command>shadow:snapsharepath</command>
+ and disable <command>shadow:snapsharepath</command> setting.
+ </para>
+ <para>Example: shadow:snapsharepath = path/to/share</para>
+ <para>Default: shadow:snapsharepath = NOT SPECIFIED</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term>shadow:sort = asc/desc
</term>
<listitem>