Document default_quota module.

diff --git a/docs/manpages-3/smb-vfs-default_quota.8.xml b/docs/manpages-3/smb-vfs-default_quota.8.xml
new file mode 100644 (file)
index 0000000..0f74163
--- /dev/null
+++ b/docs/manpages-3/smb-vfs-default_quota.8.xml
@@ -0,0 +1,132 @@
+<?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-default_quota</refentrytitle>
+       <manvolnum>8</manvolnum>
+</refmeta>
+
+
+<refnamediv>
+       <refname>default_quota</refname>
+       <refpurpose>store default quota records for Windows clients</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+       <cmdsynopsis>
+               <command>vfs objects = default_quota</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>Many common quota implementations only store
+       quotas for users and groups, but do not store a default quota. The
+       <command>default_quota</command> module allows Samba to store
+       default quota values which can be examined using the Windows
+       Explorer interface.
+       </para>
+
+       <para>By default, Samba returns NO_LIMIT the default quota and
+       refuses to update them. <command>default_quota</command> maps
+       the default quota to the quota record of a user. By default the
+       root user is taken because quota limits for root are typically
+       not enforced.</para>
+
+       <para>This module is stackable.</para>
+
+</refsect1>
+
+
+<refsect1>
+       <title>OPTIONS</title>
+
+       <variablelist>
+
+               <varlistentry>
+               <term>default_quota:uid = UID</term>
+               <listitem>
+               <para>UID specifies the user ID of the quota record where the
+               default user quota values are stored.
+               </para>
+
+               </listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>default_quota:gid = GID</term>
+               <listitem>
+               <para>GID specifies the group ID of the quota record where the
+               default group quota values are stored.
+               </para>
+
+               </listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>default_quota:uid nolimit = BOOL</term>
+               <listitem>
+               <para>If this parameter is True, then the user whose
+               quota record is storing the default user quota will
+               be reported as having a quota of NO_LIMIT. Otherwise,
+               the stored values will be reported.
+               </para>
+
+               </listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>default_quota:gid nolimit = BOOL</term>
+               <listitem>
+               <para>If this parameter is True, then the group whose
+               quota record is storing the default group quota will
+               be reported as having a quota of NO_LIMIT. Otherwise,
+               the stored values will be reported.
+               </para>
+
+               </listitem>
+               </varlistentry>
+
+       </variablelist>
+</refsect1>
+
+<refsect1>
+       <title>EXAMPLES</title>
+
+       <para>Store the default quota record in the quota record for
+       the user with ID 65535 and report that user as having no quota
+       limits:</para>
+
+<programlisting>
+        <smbconfsection name="[global]"/>
+       <smbconfoption name="vfs objects">default_quota</smbconfoption>
+       <smbconfoption name="default_quota:uid">65535</smbconfoption>
+       <smbconfoption name="default_quota:uid nolimit">yes</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>