From 7a96325baa80df515e110c5e110c2cde53a26ede Mon Sep 17 00:00:00 2001 From: David Disseldorp Date: Mon, 7 Jul 2014 14:16:13 +0200 Subject: [PATCH] doc: add vfs_shell_snap manpage Document usage of the shell_snap VFS module, explaining when and how each of the shell script commands are called. Signed-off-by: David Disseldorp Reviewed-by: Jeremy Allison --- docs-xml/manpages/vfs_shell_snap.8.xml | 155 +++++++++++++++++++++++++ docs-xml/wscript_build | 1 + 2 files changed, 156 insertions(+) create mode 100644 docs-xml/manpages/vfs_shell_snap.8.xml diff --git a/docs-xml/manpages/vfs_shell_snap.8.xml b/docs-xml/manpages/vfs_shell_snap.8.xml new file mode 100644 index 00000000000..71556623019 --- /dev/null +++ b/docs-xml/manpages/vfs_shell_snap.8.xml @@ -0,0 +1,155 @@ + + + + + + vfs_shell_snap + 8 + Samba + System Administration tools + 4.2 + + + + + vfs_shell_snap + + Shell script callouts for snapshot creation and deletion + + + + + + vfs objects = shell_snap + + + + + DESCRIPTION + + This VFS module is part of the + samba + 8 suite. + + + The vfs_shell_snap VFS provides shell-script + callouts for snapshot creation and deletion operations issued + by remote clients using the File Server Remote VSS Protocol + (FSRVP). + + + + The following shell callouts may be configured in smb.conf: + + + + + + Called when an FSRVP client wishes to check + whether a given share supports snapshot + create/delete requests. + + + The command is called with a single + share_path argument. + + + The command must return 0 if + share_path is capable of + being snapshotted. + + + + + + + + Called when an FSRVP client wishes to create + a snapshot. + + + The command is called with a single + share_path argument. + + + The command must return 0 status if the + snapshot was successfully taken. + + + The command must output the path of the newly + created snapshot to stdout. + + + + + + + + Called when an FSRVP client wishes to delete + a snapshot. + + + The command is called with + base_share_path and + snapshot_share_path + arguments. + + + The command must return 0 status if the + snapshot was successfully removed. + + + All commands are executed as the authenticated FSRVP client + user. + + + + This module is stackable. + + + + + CONFIGURATION + + + + shell_snap + + snap_check_path.sh + + snap_create.sh + + snap_delete.sh + + + + Samba's FSRVP server must be configured in the [global] section: + + + + + fork + yes + registry + + + + + VERSION + + + This man page is correct for version 4.2.0 of the Samba suite. + + + + + AUTHOR + + The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed. + + + + diff --git a/docs-xml/wscript_build b/docs-xml/wscript_build index 66da3997670..f54ae15b8fb 100644 --- a/docs-xml/wscript_build +++ b/docs-xml/wscript_build @@ -77,6 +77,7 @@ manpages=''' manpages/vfs_scannedonly.8 manpages/vfs_shadow_copy.8 manpages/vfs_shadow_copy2.8 + manpages/vfs_shell_snap.8 manpages/vfs_smb_traffic_analyzer.8 manpages/vfs_snapper.8 manpages/vfs_streams_depot.8