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