shadow_copy2: update man pages for the newly introduced options

shadow:snapprefix and shadow:delimiter are the two newly added options
in shadow copy. Update man pages explaining the two options.

Signed-off-by: Rajesh Joseph <rjoseph@redhat.com>
Reviewed-by: Uri Simchoni <uri@samba.org>
Reviewed-by: Michael Adam <obnox@samba.org>

diff --git a/docs-xml/manpages/vfs_shadow_copy2.8.xml b/docs-xml/manpages/vfs_shadow_copy2.8.xml
index fbc06514538f9538648c149c89f813eba22ee16b..6097511b631bec05195acc3ed80ddf661dad0fd1 100644 (file)
--- a/docs-xml/manpages/vfs_shadow_copy2.8.xml
+++ b/docs-xml/manpages/vfs_shadow_copy2.8.xml
@@ -406,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>