diff options
| author | Rajesh Joseph <rjoseph@redhat.com> | 2016-07-12 11:01:32 +0000 |
|---|---|---|
| committer | Stefan Metzmacher <metze@samba.org> | 2016-07-28 10:06:13 +0200 |
| commit | 57518cf0d2960fa5ebe7b882a7cd5e6326ee72f7 (patch) | |
| tree | de5356e9e10e524ffd4f9f5faddc90145eb1e51c | |
| parent | 8de11bd897afa1a0569d8e2609e9a7a486ba0504 (diff) | |
| download | samba-57518cf0d2960fa5ebe7b882a7cd5e6326ee72f7.tar.gz | |
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>
| -rw-r--r-- | docs-xml/manpages/vfs_shadow_copy2.8.xml | 36 |
1 files changed, 35 insertions, 1 deletions
diff --git a/docs-xml/manpages/vfs_shadow_copy2.8.xml b/docs-xml/manpages/vfs_shadow_copy2.8.xml index fbc06514538..6097511b631 100644 --- 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> |