dbwrap: Use tdb_null in db_ctdb_delete
[Samba/gbeck.git] / docs-xml / manpages / vfs_readonly.8.xml
blob88a62ae67edb0aa3e95dce61c089680fd32f088f
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_readonly.8">
5 <refmeta>
6         <refentrytitle>vfs_readonly</refentrytitle>
7         <manvolnum>8</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
10         <refmiscinfo class="version">4.0</refmiscinfo>
11 </refmeta>
14 <refnamediv>
15         <refname>vfs_readonly</refname>
16         <refpurpose>make a Samba share read only for a specified time period</refpurpose>
17 </refnamediv>
19 <refsynopsisdiv>
20         <cmdsynopsis>
21                 <command>vfs objects = readonly</command>
22         </cmdsynopsis>
23 </refsynopsisdiv>
25 <refsect1>
26         <title>DESCRIPTION</title>
28         <para>This VFS module is part of the
29         <citerefentry><refentrytitle>samba</refentrytitle>
30         <manvolnum>7</manvolnum></citerefentry> suite.</para>
32         <para>The <command>vfs_readonly</command> VFS module marks a share
33         as read only for all clients connecting within the configured
34         time period. Clients connecting during this time will be denied
35         write access to all files in the share, irrespective of their
36         actual access privileges.</para>
38         <para>This module is stackable.</para>
40 </refsect1>
43 <refsect1>
44         <title>OPTIONS</title>
46         <variablelist>
48                 <varlistentry>
49                 <term>readonly:period = BEGIN, END</term>
50                 <listitem>
51                 <para>Only mark the share as read only if the client
52                 connection was made between the times marked by the
53                 BEGIN and END date specifiers.
54                 The syntax of these date specifiers is the
55                 same as that accepted by the -d option of GNU
56                 <citerefentry><refentrytitle>date</refentrytitle>
57                         <manvolnum>1</manvolnum></citerefentry>.
58                 </para>
60                 </listitem>
61                 </varlistentry>
63         </variablelist>
64 </refsect1>
66 <refsect1>
67         <title>EXAMPLES</title>
69         <para>Mark all shares read only:</para>
70 <programlisting>
71         <smbconfsection name="[global]"/>
72         <smbconfoption name="vfs objects">readonly</smbconfoption>
73 </programlisting>
75         <para>Mark the [backup] share as read only during business hours:</para>
76 <programlisting>
77         <smbconfsection name="[backup]"/>
78         <smbconfoption name="path">/readonly</smbconfoption>
79         <smbconfoption name="vfs objects">readonly</smbconfoption>
80         <smbconfoption name="readonly:period">readonly:period = "today 9:00","today 17:00"</smbconfoption>
81 </programlisting>
82 </refsect1>
84 <refsect1>
85         <title>VERSION</title>
87         <para>This man page is correct for version 3.0.25 of the Samba suite.
88         </para>
89 </refsect1>
91 <refsect1>
92         <title>AUTHOR</title>
94         <para>The original Samba software and related utilities
95         were created by Andrew Tridgell. Samba is now developed
96         by the Samba Team as an Open Source project similar
97         to the way the Linux kernel is developed.</para>
99 </refsect1>
101 </refentry>