docs: Update doc to use absolute path for 'dedicated keytab file'
[sfrench/samba-autobuild/.git] / docs-xml / manpages / vfs_worm.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_worm.8">
4
5 <refmeta>
6         <refentrytitle>vfs_worm</refentrytitle>
7         <manvolnum>8</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
10         <refmiscinfo class="version">4.6</refmiscinfo>
11 </refmeta>
12
13
14 <refnamediv>
15         <refname>vfs_worm</refname>
16         <refpurpose>disallows writes for older file</refpurpose>
17 </refnamediv>
18
19 <refsynopsisdiv>
20         <cmdsynopsis>
21                 <command>vfs objects = worm</command>
22         </cmdsynopsis>
23 </refsynopsisdiv>
24
25 <refsect1>
26         <title>DESCRIPTION</title>
27
28         <para>This VFS module is part of the
29         <citerefentry><refentrytitle>samba</refentrytitle>
30         <manvolnum>7</manvolnum></citerefentry> suite.</para>
31
32         <para>The <command>vfs_worm</command> module controls the writability
33         of files and folders depending on their change time and a
34         adjustable grace period.</para>
35
36         <para>If the change time of a file or directory is older than
37         the specified grace period, the write access will be denied,
38         independent of further access controls (e.g. by the filesystem).</para>
39
40         <para>In the case that the grace period is not exceed, the worm
41         module will not impact any access controls.</para>
42 </refsect1>
43
44 <refsect1>
45         <title>OPTIONS</title>
46
47         <variablelist>
48
49                 <varlistentry>
50                 <term>worm:grace_period = SECONDS</term>
51                 <listitem>
52                 <para>Period in seconds which defines the time how long the
53                 write access should be handled by the normal access controls.
54                 After this grace period the file or directory becomes read
55                 only.</para>
56                 </listitem>
57                 </varlistentry>
58
59         </variablelist>
60 </refsect1>
61
62 <refsect1>
63         <title>EXAMPLES</title>
64
65         <para>Deny the write access to files and folders, which are older
66         than five minutes (300 seconds):</para>
67
68 <programlisting>
69         <smbconfsection name="[wormshare]"/>
70         <smbconfoption name="vfs objects">worm</smbconfoption>
71         <smbconfoption name="worm:grace_period">300</smbconfoption>
72 </programlisting>
73
74 </refsect1>
75
76 <refsect1>
77         <title>VERSION</title>
78
79         <para>This man page is correct for version 4.2 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>