docs/manpages-3/vfs_shadow_copy.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_shadow_copy.8">
   4
   5 <refmeta>
   6         <refentrytitle>vfs_shadow_copy</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8 </refmeta>
   9
  10
  11 <refnamediv>
  12         <refname>vfs_shadow_copy</refname>
  13         <refpurpose>Make a Samba share read only for a specified time period</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17         <cmdsynopsis>
  18                 <command>vfs objects = shadow_copy</command>
  19         </cmdsynopsis>
  20 </refsynopsisdiv>
  21
  22 <refsect1>
  23         <title>DESCRIPTION</title>
  24
  25         <para>This VFS module is part of the
  26         <citerefentry><refentrytitle>samba</refentrytitle>
  27         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  28
  29         <para>The <command>vfs_shadow_copy</command> VFS module functionality
  30         that is similar to Microsoft Shadow Copy services. When setup properly,
  31         this module allows Microsoft Shadow Copy clients to browse
  32         "shadow copies" on Samba shares.
  33         </para>
  34
  35         <para>This module is stackable.</para>
  36
  37 </refsect1>
  38
  39 <refsect1>
  40         <title>CONFIGURATION</title>
  41
  42         <para><command>vfs_shadow_copy</command> relies on a filesystem
  43         snapshot implementation. Many common filesystems have native
  44         support for this.
  45         </para>
  46
  47         <para>Filesystem snapshots must be mounted on
  48         specially named directories in order to be recognized by
  49         <command>vfs_shadow_copy</command>. The snapshot mount points must
  50         be immediate children of a the directory being shared.</para>
  51
  52         <para>The snapshot naming convention is @GMT-YYYY.MM.DD-hh.mm.ss,
  53         where:
  54         <itemizedlist>
  55                 <listitem><para><command>YYYY</command> is the 4 digit year</para></listitem>
  56                 <listitem><para><command>MM</command> is the 2 digit month</para></listitem>
  57                 <listitem><para><command>DD</command> is the 2 digit day</para></listitem>
  58                 <listitem><para><command>hh</command> is the 2 digit hour</para></listitem>
  59                 <listitem><para><command>mm</command> is the 2 digit minute</para></listitem>
  60                 <listitem><para><command>ss</command> is the 2 digit second.</para></listitem>
  61         </itemizedlist>
  62         </para>
  63
  64         <para>The <command>vfs_shadow_copy</command> snapshot naming convention can be produced with the following
  65         <citerefentry><refentrytitle>date</refentrytitle>
  66         <manvolnum>1</manvolnum></citerefentry> command:
  67         <programlisting>
  68         TZ=GMT date +@GMT-%Y.%m.%d-%H.%M.%S
  69         </programlisting></para>
  70
  71 </refsect1>
  72
  73 <refsect1>
  74         <title>EXAMPLES</title>
  75
  76         <para>Add shadow copy support to user home directories:</para>
  77 <programlisting>
  78         <smbconfsection name="[homes]"/>
  79         <smbconfoption name="vfs objects">shadow_copy</smbconfoption>
  80 </programlisting>
  81
  82 </refsect1>
  83
  84 <refsect1>
  85         <title>CAVEATS</title>
  86
  87         <para>This is not a backup, archival, or version control solution.
  88         </para>
  89
  90         <para>With Samba or Windows servers,
  91         <command>vfs_shadow_copy</command> is designed to be an end-user
  92         tool only. It does not replace or enhance your backup and
  93         archival solutions and should in no way be considered as
  94         such. Additionally, if you need version control, implement a
  95         version control system.</para>
  96
  97 </refsect1>
  98
  99
 100
 101 <refsect1>
 102         <title>VERSION</title>
 103
 104         <para>This man page is correct for version 3.0.25 of the Samba suite.
 105         </para>
 106 </refsect1>
 107
 108 <refsect1>
 109         <title>AUTHOR</title>
 110
 111         <para>The original Samba software and related utilities
 112         were created by Andrew Tridgell. Samba is now developed
 113         by the Samba Team as an Open Source project similar
 114         to the way the Linux kernel is developed.</para>
 115
 116 </refsect1>
 117
 118 </refentry>