docs/manpages-3/vfs_readonly.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_readonly.8">
   4
   5 <refmeta>
   6         <refentrytitle>vfs_readonly</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8 </refmeta>
   9
  10
  11 <refnamediv>
  12         <refname>vfs_readonly</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 = readonly</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_readonly</command> VFS module marks a share
  30         as read only for all clients connecting within the configured
  31         time period. Clients connecting during this time will be denied
  32         write access to all files in the share, irrespective of ther
  33         actual access privileges.</para>
  34
  35         <para>This module is stackable.</para>
  36
  37 </refsect1>
  38
  39
  40 <refsect1>
  41         <title>OPTIONS</title>
  42
  43         <variablelist>
  44
  45                 <varlistentry>
  46                 <term>readonly:period = BEGIN, END</term>
  47                 <listitem>
  48                 <para>Only mark the share as read only if the client
  49                 connection was made between the times marked by the
  50                 BEGIN and END date specifiers.
  51                 The syntax of these date specifiers is the
  52                 same as that accepted by the -d option of GNU
  53                 <citerefentry><refentrytitle>date</refentrytitle>
  54                         <manvolnum>1</manvolnum></citerefentry>.
  55                 </para>
  56
  57                 </listitem>
  58                 </varlistentry>
  59
  60         </variablelist>
  61 </refsect1>
  62
  63 <refsect1>
  64         <title>EXAMPLES</title>
  65
  66         <para>Mark all shares read only:</para>
  67 <programlisting>
  68         <smbconfsection name="[global]"/>
  69         <smbconfoption name="vfs objects">readonly</smbconfoption>
  70 </programlisting>
  71
  72         <para>Mark the [backup] share as read only during business hours:</para>
  73 <programlisting>
  74         <smbconfsection name="[backup]"/>
  75         <smbconfoption name="path">/readonly</smbconfoption>
  76         <smbconfoption name="vfs objects">readonly</smbconfoption>
  77         <smbconfoption name="readonly:period">readonly:period = "today 9:00","today 17:00"</smbconfoption>
  78 </programlisting>
  79 </refsect1>
  80
  81 <refsect1>
  82         <title>VERSION</title>
  83
  84         <para>This man page is correct for version 3.0.25 of the Samba suite.
  85         </para>
  86 </refsect1>
  87
  88 <refsect1>
  89         <title>AUTHOR</title>
  90
  91         <para>The original Samba software and related utilities
  92         were created by Andrew Tridgell. Samba is now developed
  93         by the Samba Team as an Open Source project similar
  94         to the way the Linux kernel is developed.</para>
  95
  96 </refsect1>
  97
  98 </refentry>