From: David Disseldorp <ddiss@samba.org>
Date: Fri, 27 Jun 2014 13:31:37 +0000 (+0200)
Subject: doc: add vfs_snapper manpage
X-Git-Tag: tdb-1.3.1~856
X-Git-Url: http://git.samba.org/?a=commitdiff_plain;h=4478dfe2082d795d8531b92c3c70b1e8847cc7aa;p=samba.git

doc: add vfs_snapper manpage

Document usage of the snapper VFS module, detailing permissions required
to list and access snapshots.

Signed-off-by: David Disseldorp <ddiss@samba.org>
Reviewed-by: Jeremy Allison <jra@samba.org>
---

diff --git a/docs-xml/manpages/vfs_snapper.8.xml b/docs-xml/manpages/vfs_snapper.8.xml
new file mode 100644
index 00000000000..0e06ec5959d
--- /dev/null
+++ b/docs-xml/manpages/vfs_snapper.8.xml
@@ -0,0 +1,93 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
+<refentry id="vfs_snapper.8">
+
+<refmeta>
+	<refentrytitle>vfs_snapper</refentrytitle>
+	<manvolnum>8</manvolnum>
+	<refmiscinfo class="source">Samba</refmiscinfo>
+	<refmiscinfo class="manual">System Administration tools</refmiscinfo>
+	<refmiscinfo class="version">4.2</refmiscinfo>
+</refmeta>
+
+
+<refnamediv>
+	<refname>vfs_snapper</refname>
+	<refpurpose>
+		Expose snapshots managed by snapper as shadow-copies
+	</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+	<cmdsynopsis>
+		<command>vfs objects = snapper</command>
+	</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1>
+	<title>DESCRIPTION</title>
+
+	<para>This VFS module is part of the
+	<citerefentry><refentrytitle>samba</refentrytitle>
+	<manvolnum>8</manvolnum></citerefentry> suite.</para>
+
+	<para>
+		The <command>vfs_snapper</command> VFS module exposes snapshots
+		managed by snapper for use by Samba. This provides the ability
+		for remote SMB clients to access shadow-copies via Windows
+		Explorer using the "previous versions" dialog.
+	</para>
+
+	<para>
+		This module is stackable.
+	</para>
+</refsect1>
+
+<refsect1>
+	<title>CONFIGURATION</title>
+
+	<para>
+		The underlying share path must have a corresponding snapper
+		configuration file. The snapshot directory tree must allow
+		access for relavent users.
+	</para>
+
+	<programlisting>
+		<smbconfsection name="[share]"/>
+		<smbconfoption name="vfs objects">snapper</smbconfoption>
+	</programlisting>
+</refsect1>
+
+<refsect1>
+	<title>PERMISSIONS</title>
+	<para>
+		Snapper stores snapshots under a .snapshots subdirectory. This
+		directory must permit traversal for any users wishing to access
+		snapshots via the Windows Explorer previous versions dialog.
+		By default, traversal is forbidden for all non-root users.
+		Additionally, users must be granted permission to list snapshots
+		managed by snapper, via snapper's ALLOW_USERS or ALLOW_GROUPS
+		options. Snapper can grant these users and groups .snapshots
+		traversal access automatically via the SYNC_ACL option.
+	</para>
+</refsect1>
+
+<refsect1>
+	<title>VERSION</title>
+
+	<para>
+		This man page is correct for version 4.2.0 of the Samba suite.
+	</para>
+</refsect1>
+
+<refsect1>
+	<title>AUTHOR</title>
+
+	<para>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.</para>
+
+</refsect1>
+
+</refentry>
diff --git a/docs-xml/wscript_build b/docs-xml/wscript_build
index d59d4b57ad8..42c9a85696a 100644
--- a/docs-xml/wscript_build
+++ b/docs-xml/wscript_build
@@ -75,6 +75,7 @@ manpages='''
          manpages/vfs_shadow_copy.8
          manpages/vfs_shadow_copy2.8
          manpages/vfs_smb_traffic_analyzer.8
+	 manpages/vfs_snapper.8
          manpages/vfs_streams_depot.8
          manpages/vfs_streams_xattr.8
          manpages/vfs_syncops.8