From: James Peach <jpeach@samba.org>
Date: Wed, 28 Feb 2007 18:38:34 +0000 (+0000)
Subject: Document shadow_copy module.
X-Git-Url: http://git.samba.org/?a=commitdiff_plain;h=d868b93f326bf56f704d25d3dfd0a8923179e2fe;p=abartlet%2Fsamba.git%2F.git

Document shadow_copy module.

NOTE - the formatting is a bit wonky because itemized list emits a
trailing .RE the messes up the indentation of the ssubsequent paragraph.
Also, itemizedlist emits character entities (dot points?) that man
doesn't appear to understand (ie. it renders them as  &#8226;).

suggestions welcome on how to fix the above :)
(This used to be commit 54b8f9b9c2e0cdd98471b52e3ef07c5f85276068)
---

diff --git a/docs/manpages-3/smb-vfs-shadow_copy.8.xml b/docs/manpages-3/smb-vfs-shadow_copy.8.xml
new file mode 100644
index 00000000000..e735b881ced
--- /dev/null
+++ b/docs/manpages-3/smb-vfs-shadow_copy.8.xml
@@ -0,0 +1,117 @@
+<?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="smb-vfs-shadow_copy.8">
+
+<refmeta>
+	<refentrytitle>smb-vfs-shadow_copy</refentrytitle>
+	<manvolnum>8</manvolnum>
+</refmeta>
+
+
+<refnamediv>
+	<refname>shadow_copy</refname>
+	<refpurpose>Make a Samba share read only for a specified time period</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+	<cmdsynopsis>
+		<command>vfs objects = shadow_copy</command>
+	</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1>
+	<title>DESCRIPTION</title>
+
+	<para>This module is part of the <citerefentry><refentrytitle>samba</refentrytitle>
+	<manvolnum>7</manvolnum></citerefentry> suite.</para>
+
+	<para>The <command>shadow_copy</command> VFS module functionality
+	that is similar to Microsoft Shadow Copy services. When setup properly,
+	this module allows Microsoft Shadow Copy clients to browse
+	"shadow copies" on Samba shares.
+	</para>
+
+	<para>This module is stackable.</para>
+
+</refsect1>
+
+<refsect1>
+	<title>CONFIGURATION</title>
+
+	<para><command>shadow_copy</command> relies on a filesystem
+	snapshot implementation. Many common filesystems have native
+	support for this.
+	</para>
+
+	<para>Filesystem snapshots must be mounted on
+	specially named directories in order to be recognized by
+	<command>shadow_copy</command>. The snapshot mount points must
+	be immediate children of a the directory being shared.</para>
+
+	<para>The snapshot naming convention is @GMT-YYYY.MM.DD-hh.mm.ss,
+	where:
+       	<itemizedlist>
+       		<listitem><para><command>YYYY</command> is the 4 digit year</para></listitem>
+       		<listitem><para><command>MM</command> is the 2 digit month</para></listitem>
+       		<listitem><para><command>DD</command> is the 2 digit day</para></listitem>
+       		<listitem><para><command>hh</command> is the 2 digit hour</para></listitem>
+       		<listitem><para><command>mm</command> is the 2 digit minute</para></listitem>
+       		<listitem><para><command>ss</command> is the 2 digit second.</para></listitem>
+       	</itemizedlist>
+	</para>
+
+       	<para>The <command>shadow_copy</command> snapshot naming convention can be produced with the following 
+	<citerefentry><refentrytitle>date</refentrytitle>
+	<manvolnum>1</manvolnum></citerefentry> command:
+	<programlisting>
+	TZ=GMT date +@GMT-%Y.%m.%d-%H.%M.%S
+	</programlisting></para>
+
+</refsect1>
+
+<refsect1>
+	<title>EXAMPLES</title>
+
+	<para>Add shadow copy support to user home directories:</para>
+<programlisting>
+        <smbconfsection name="[homes]"/>
+	<smbconfoption name="vfs objects">shadow_copy</smbconfoption>
+</programlisting>
+
+</refsect1>
+
+<refsect1>
+	<title>CAVEATS</title>
+
+	<para>This is not a backup, archival, or version control solution.
+	</para>
+
+	<para>With Samba or Windows servers,
+	<command>shadow_copy</command> is designed to be an end-user
+	tool only. It does not replace or enhance your backup and
+	archival solutions and should in no way be considered as
+	such. Additionally, if you need version control, implement a
+	version control system.</para>
+
+</refsect1>
+
+
+
+<refsect1>
+	<title>VERSION</title>
+
+	<para>This man page is correct for version 3.0.25 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>