docs-xml/manpages/vfs_snapper.8.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="vfs_snapper.8">
   4
   5 <refmeta>
   6         <refentrytitle>vfs_snapper</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
  10         <refmiscinfo class="version">4.2</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>vfs_snapper</refname>
  16         <refpurpose>
  17                 Expose snapshots managed by snapper as shadow-copies
  18         </refpurpose>
  19 </refnamediv>
  20
  21 <refsynopsisdiv>
  22         <cmdsynopsis>
  23                 <command>vfs objects = snapper</command>
  24         </cmdsynopsis>
  25 </refsynopsisdiv>
  26
  27 <refsect1>
  28         <title>DESCRIPTION</title>
  29
  30         <para>This VFS module is part of the
  31         <citerefentry><refentrytitle>samba</refentrytitle>
  32         <manvolnum>8</manvolnum></citerefentry> suite.</para>
  33
  34         <para>
  35                 The <command>vfs_snapper</command> VFS module exposes snapshots
  36                 managed by snapper for use by Samba. This provides the ability
  37                 for remote SMB clients to access shadow-copies via Windows
  38                 Explorer using the "previous versions" dialog.
  39         </para>
  40
  41         <para>
  42                 This module is stackable.
  43         </para>
  44 </refsect1>
  45
  46 <refsect1>
  47         <title>CONFIGURATION</title>
  48
  49         <para>
  50                 The underlying share path must have a corresponding snapper
  51                 configuration file. The snapshot directory tree must allow
  52                 access for relavent users.
  53         </para>
  54
  55         <programlisting>
  56                 <smbconfsection name="[share]"/>
  57                 <smbconfoption name="vfs objects">snapper</smbconfoption>
  58         </programlisting>
  59 </refsect1>
  60
  61 <refsect1>
  62         <title>PERMISSIONS</title>
  63         <para>
  64                 Snapper stores snapshots under a .snapshots subdirectory. This
  65                 directory must permit traversal for any users wishing to access
  66                 snapshots via the Windows Explorer previous versions dialog.
  67                 By default, traversal is forbidden for all non-root users.
  68                 Additionally, users must be granted permission to list snapshots
  69                 managed by snapper, via snapper's ALLOW_USERS or ALLOW_GROUPS
  70                 options. Snapper can grant these users and groups .snapshots
  71                 traversal access automatically via the SYNC_ACL option.
  72         </para>
  73 </refsect1>
  74
  75 <refsect1>
  76         <title>VERSION</title>
  77
  78         <para>
  79                 This man page is correct for version 4.2.0 of the Samba suite.
  80         </para>
  81 </refsect1>
  82
  83 <refsect1>
  84         <title>AUTHOR</title>
  85
  86         <para>The original Samba software and related utilities
  87         were created by Andrew Tridgell. Samba is now developed
  88         by the Samba Team as an Open Source project similar
  89         to the way the Linux kernel is developed.</para>
  90
  91 </refsect1>
  92
  93 </refentry>