tdb: Fix build on AIX

[vlendec/samba-autobuild/.git] / docs-xml / manpages / vfs_shadow_copy2.8.xml

diff --git a/docs-xml/manpages/vfs_shadow_copy2.8.xml b/docs-xml/manpages/vfs_shadow_copy2.8.xml
index e9515638e8a168a497ee9eba1c7c4ac3749b3d42..fe37145d41167ed58a8f6694994b16f3b403aaac 100644 (file)
--- a/docs-xml/manpages/vfs_shadow_copy2.8.xml
+++ b/docs-xml/manpages/vfs_shadow_copy2.8.xml
@@ -7,7 +7,7 @@
        <manvolnum>8</manvolnum>
        <refmiscinfo class="source">Samba</refmiscinfo>
        <refmiscinfo class="manual">System Administration tools</refmiscinfo>
-       <refmiscinfo class="version">4.2</refmiscinfo>
+       <refmiscinfo class="version">&doc.version;</refmiscinfo>
 </refmeta>
 
 
@@ -182,7 +182,7 @@
                </term>
                 <listitem>
                <para>
-               The basedir option allows to specify a directory
+               The basedir option allows one to specify a directory
                between the share's mount point and the share root,
                relative to which the file system's snapshots are taken.
                </para>
@@ -225,6 +225,46 @@
                 </listitem>
                 </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>
@@ -272,7 +312,7 @@
                <term>shadow:sscanf = yes/no</term>
                <listitem>
                <para>
-               This paramter can be used to specify that the time in
+               This parameter can be used to specify that the time in
                format string is given as an unsigned long integer (%lu)
                rather than a time strptime() can parse.
                The result must be a unix time_t time.
@@ -351,10 +391,10 @@
                only particular subtrees of the filesystem as well.
                </para>
                <para>
-               Note that <command>shadow:snapdirseverywhere</command>
+               Note that <command>shadow:crossmountpoints</command>
                depends on <command>shadow:snapdir</command> and needs it to be
                a relative path. Setting an absolute snapdir path disables
-               <command>shadow:snapdirseverywhere</command>.
+               <command>shadow:crossmountpoints</command>.
                </para>
                <para>
                Note that this option is incompatible with the
@@ -366,7 +406,41 @@
                 </listitem>
                 </varlistentry>
 
-               </variablelist>
+               <varlistentry>
+               <term>shadow:snapprefix
+               </term>
+               <listitem>
+               <para>
+               With growing number of snapshots file-systems need some mechanism
+               to differentiate one set of snapshots from other, e.g. monthly, weekly,
+               manual, special events, etc. Therefore these file-systems provide different
+               ways to tag snapshots, e.g. provide a configurable way to name snapshots,
+               which is not just based on time.  With only <command>shadow:format</command>
+               it is very difficult to filter these snapshots. With this optional parameter,
+               one can specify a variable prefix component for names of the snapshot
+               directories in the file-system. If this parameter is set, together with the
+               <command>shadow:format</command> and <command>shadow:delimiter</command>
+               parameters it determines the possible names of snapshot
+               directories in the file-system. The option only supports Basic
+               Regular Expression (BRE).
+               </para>
+               </listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>shadow:delimiter
+               </term>
+               <listitem>
+               <para>
+               This optional parameter is used as a delimiter between
+               <command>shadow:snapprefix</command> and <command>shadow:format</command>.
+               This parameter is used only when <command>shadow:snapprefix</command>
+               is set.
+               </para>
+               <para>Default: shadow:delimiter = "_GMT"</para>
+               </listitem>
+               </varlistentry>
+       </variablelist>
 </refsect1>
 
 <refsect1>
@@ -403,7 +477,7 @@
 <refsect1>
        <title>VERSION</title>
 
-       <para>This man page is correct for version 4.0 of the Samba suite.
+       <para>This man page is part of version &doc.version; of the Samba suite.
        </para>
 </refsect1>