Document the readonly VFS module.

(This used to be commit 067285af805eef643d7a34a24aff8a77b737b897)

1 files changed, 97 insertions, 0 deletions

diff --git a/docs/manpages-3/smb-vfs-readonly.8.xml b/docs/manpages-3/smb-vfs-readonly.8.xml
new file mode 100644
index 0000000000..f447702ee7
--- /dev/null
+++ b/docs/manpages-3/smb-vfs-readonly.8.xml
@@ -0,0 +1,97 @@
+<?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">
+<refentry id="smb-vfs-readonly.8">
+
+<refmeta>
+	<refentrytitle>smb-vfs-readonly</refentrytitle>
+	<manvolnum>8</manvolnum>
+</refmeta>
+
+
+<refnamediv>
+	<refname>readonly</refname>
+	<refpurpose>Make a Samba share read only for a specified time period</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+	<cmdsynopsis>
+		<command>vfs objects = readonly</command>
+	</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1>
+	<title>DESCRIPTION</title>
+
+	<para>This module is part of the <citerefentry><refentrytitle>samba</refentrytitle>
+	<manvolnum>7</manvolnum></citerefentry> suite.</para>
+
+	<para>The <command>readonly</command> VFS module marks a share
+	as read only for all clients connecting within the configured
+	time period. Clients connecting during this time will be denied
+	write access to all files in the share, irrespective of ther
+	actual access privileges.</para>
+
+	<para>This module is stackable.</para>
+
+</refsect1>
+
+
+<refsect1>
+	<title>OPTIONS</title>
+
+	<variablelist>
+
+		<varlistentry>
+		<term>readonly:period = BEGIN, END</term>
+		<listitem>
+		<para>Only mark the share as read only if the client
+		connection was made between the times marked by the
+		BEGIN and END date specifiers.
+		The syntax of these date specifiers is the
+		same as that accepted by the -d option of GNU
+		<citerefentry><refentrytitle>date</refentrytitle>
+			<manvolnum>1</manvolnum></citerefentry>.
+		</para>
+
+		</listitem>
+		</varlistentry>
+
+	</variablelist>
+</refsect1>
+
+<refsect1>
+	<title>EXAMPLES</title>
+
+	<para>Mark all shares read only:</para>
+<programlisting>
+        <smbconfsection name="[global]"/>
+	<smbconfoption name="vfs objects">readonly</smbconfoption>
+</programlisting>
+
+	<para>Mark the [backup] share as read only during business hours:</para>
+<programlisting>
+        <smbconfsection name="[backup]"/>
+	<smbconfoption name="path">/readonly</smbconfoption>
+	<smbconfoption name="vfs objects">readonly</smbconfoption>
+	<smbconfoption name="readonly:period">readonly:period = "today 9:00","today 17:00"</smbconfoption>
+</programlisting>
+</refsect1>
+
+<refsect1>
+	<title>VERSION</title>
+
+	<para>This man page is correct for version 3.0.25 of the Samba suite.
+	</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>