sin/samba-mirror
1
0
Fork 0
mirror of https://github.com/samba-team/samba.git synced 2024-12-24 21:34:56 +03:00
Code
b9207b32fc
samba-mirror/docs-xml/manpages/vfs_shadow_copy.8.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

122 lines
3.6 KiB
XML
Raw Normal View History

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 •). suggestions welcome on how to fix the above :) (This used to be commit 54b8f9b9c2e0cdd98471b52e3ef07c5f85276068)
2007-02-28 21:38:34 +03:00
<?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">
Make sure all the modules are referred to as vfs_module_name to avoid collisions with existing man pages. (This used to be commit 2c7722ac9ed62bfb4670aa61e382a4cf1653a3ba)
2007-03-01 02:14:41 +03:00
<refentry id="vfs_shadow_copy.8">
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)
2007-02-28 21:38:34 +03:00
<refmeta>
Make sure all the modules are referred to as vfs_module_name to avoid collisions with existing man pages. (This used to be commit 2c7722ac9ed62bfb4670aa61e382a4cf1653a3ba)
2007-03-01 02:14:41 +03:00
<refentrytitle>vfs_shadow_copy</refentrytitle>
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)
2007-02-28 21:38:34 +03:00
<manvolnum>8</manvolnum>
Add man page metadata fields that are used by temprorary manpages XSLT (This used to be commit b2f3f38e57d96132f2befb13359306848c998ffc)
2008-04-07 00:26:45 +04:00
<refmiscinfo class="source">Samba</refmiscinfo>
<refmiscinfo class="manual">System Administration tools</refmiscinfo>
docs-xml/manpages: Use new doc.version XML entity. BUG: https://bugzilla.samba.org/show_bug.cgi?id=9531 Signed-off-by: Karolin Seeger <kseeger@samba.org> Reviewed-by: Stefan Metzmacher <metze@samba.org> Reviewed-by: Andreas Schneider <asn@samba.org> Autobuild-User(master): Andreas Schneider <asn@cryptomilk.org> Autobuild-Date(master): Wed Dec 13 17:22:01 CET 2017 on sn-devel-144
2017-12-12 11:08:06 +03:00
<refmiscinfo class="version">&doc.version;</refmiscinfo>
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)
2007-02-28 21:38:34 +03:00
</refmeta>
<refnamediv>
Make sure all the modules are referred to as vfs_module_name to avoid collisions with existing man pages. (This used to be commit 2c7722ac9ed62bfb4670aa61e382a4cf1653a3ba)
2007-03-01 02:14:41 +03:00
<refname>vfs_shadow_copy</refname>
docs: Fix vfs_shadow_copy(8) Found by Miguel Medalha <miguelmedalha@sapo.pt> Signed-off-by: Volker Lendecke <vl@samba.org> Reviewed-by: David Disseldorp <ddiss@samba.org> Autobuild-User(master): David Disseldorp <ddiss@samba.org> Autobuild-Date(master): Fri Feb 13 18:24:38 CET 2015 on sn-devel-104
2015-02-13 16:06:29 +03:00
<refpurpose>Expose snapshots to Windows clients as shadow copies.</refpurpose>
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)
2007-02-28 21:38:34 +03:00
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>vfs objects = shadow_copy</command>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
Make sure all the modules are referred to as vfs_module_name to avoid collisions with existing man pages. (This used to be commit 2c7722ac9ed62bfb4670aa61e382a4cf1653a3ba)
2007-03-01 02:14:41 +03:00
<para>This VFS module is part of the
<citerefentry><refentrytitle>samba</refentrytitle>
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)
2007-02-28 21:38:34 +03:00
<manvolnum>7</manvolnum></citerefentry> suite.</para>
Make sure all the modules are referred to as vfs_module_name to avoid collisions with existing man pages. (This used to be commit 2c7722ac9ed62bfb4670aa61e382a4cf1653a3ba)
2007-03-01 02:14:41 +03:00
<para>The <command>vfs_shadow_copy</command> VFS module functionality
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)
2007-02-28 21:38:34 +03:00
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>
Make sure all the modules are referred to as vfs_module_name to avoid collisions with existing man pages. (This used to be commit 2c7722ac9ed62bfb4670aa61e382a4cf1653a3ba)
2007-03-01 02:14:41 +03:00
<para><command>vfs_shadow_copy</command> relies on a filesystem
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)
2007-02-28 21:38:34 +03:00
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
Make sure all the modules are referred to as vfs_module_name to avoid collisions with existing man pages. (This used to be commit 2c7722ac9ed62bfb4670aa61e382a4cf1653a3ba)
2007-03-01 02:14:41 +03:00
<command>vfs_shadow_copy</command>. The snapshot mount points must
docs-xml: Fix spelling Signed-off-by: Joseph Sutton <josephsutton@catalyst.net.nz> Reviewed-by: Andrew Bartlett <abartlet@samba.org>
2023-09-04 03:14:58 +03:00
be immediate children of the directory being shared.</para>
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)
2007-02-28 21:38:34 +03:00
<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>
Cleanup trailing whitespace. (This used to be commit 232e5e548ec2219944c3002dda355b377a1ea711)
2007-08-21 02:47:12 +04:00
<para>The <command>vfs_shadow_copy</command> snapshot naming convention can be produced with the following
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)
2007-02-28 21:38:34 +03:00
<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,
Make sure all the modules are referred to as vfs_module_name to avoid collisions with existing man pages. (This used to be commit 2c7722ac9ed62bfb4670aa61e382a4cf1653a3ba)
2007-03-01 02:14:41 +03:00
<command>vfs_shadow_copy</command> is designed to be an end-user
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)
2007-02-28 21:38:34 +03:00
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>
docs-xml: mention that the man pages are "part of" version x writing that they are correct for version x is not always precise. But we're working on that also :-) Signed-off-by: Bjoern Jacke <bjacke@samba.org> Reviewed-by: Andrew Bartlett <abartlet@samba.org> Reviewed-by: Garming Sam <garming@catalyst.net.nz>
2017-12-13 03:38:25 +03:00
<para>This man page is part of version &doc.version; of the Samba suite.
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)
2007-02-28 21:38:34 +03:00
</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>
Copy Permalink