docs/manpages-3/vfs_default_quota.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_default_quota.8">
   4
   5 <refmeta>
   6         <refentrytitle>vfs_default_quota</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8 </refmeta>
   9
  10
  11 <refnamediv>
  12         <refname>vfs_default_quota</refname>
  13         <refpurpose>store default quota records for Windows clients</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17         <cmdsynopsis>
  18                 <command>vfs objects = default_quota</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>
  28         suite.</para>
  29
  30         <para>Many common quota implementations only store
  31         quotas for users and groups, but do not store a default quota. The
  32         <command>vfs_default_quota</command> module allows Samba to store
  33         default quota values which can be examined using the Windows
  34         Explorer interface.
  35         </para>
  36
  37         <para>By default, Samba returns NO_LIMIT the default quota and
  38         refuses to update them. <command>vfs_default_quota</command> maps
  39         the default quota to the quota record of a user. By default the
  40         root user is taken because quota limits for root are typically
  41         not enforced.</para>
  42
  43         <para>This module is stackable.</para>
  44
  45 </refsect1>
  46
  47
  48 <refsect1>
  49         <title>OPTIONS</title>
  50
  51         <variablelist>
  52
  53                 <varlistentry>
  54                 <term>default_quota:uid = UID</term>
  55                 <listitem>
  56                 <para>UID specifies the user ID of the quota record where the
  57                 default user quota values are stored.
  58                 </para>
  59
  60                 </listitem>
  61                 </varlistentry>
  62
  63                 <varlistentry>
  64                 <term>default_quota:gid = GID</term>
  65                 <listitem>
  66                 <para>GID specifies the group ID of the quota record where the
  67                 default group quota values are stored.
  68                 </para>
  69
  70                 </listitem>
  71                 </varlistentry>
  72
  73                 <varlistentry>
  74                 <term>default_quota:uid nolimit = BOOL</term>
  75                 <listitem>
  76                 <para>If this parameter is True, then the user whose
  77                 quota record is storing the default user quota will
  78                 be reported as having a quota of NO_LIMIT. Otherwise,
  79                 the stored values will be reported.
  80                 </para>
  81
  82                 </listitem>
  83                 </varlistentry>
  84
  85                 <varlistentry>
  86                 <term>default_quota:gid nolimit = BOOL</term>
  87                 <listitem>
  88                 <para>If this parameter is True, then the group whose
  89                 quota record is storing the default group quota will
  90                 be reported as having a quota of NO_LIMIT. Otherwise,
  91                 the stored values will be reported.
  92                 </para>
  93
  94                 </listitem>
  95                 </varlistentry>
  96
  97         </variablelist>
  98 </refsect1>
  99
 100 <refsect1>
 101         <title>EXAMPLES</title>
 102
 103         <para>Store the default quota record in the quota record for
 104         the user with ID 65535 and report that user as having no quota
 105         limits:</para>
 106
 107 <programlisting>
 108         <smbconfsection name="[global]"/>
 109         <smbconfoption name="vfs objects">default_quota</smbconfoption>
 110         <smbconfoption name="default_quota:uid">65535</smbconfoption>
 111         <smbconfoption name="default_quota:uid nolimit">yes</smbconfoption>
 112 </programlisting>
 113
 114 </refsect1>
 115
 116 <refsect1>
 117         <title>VERSION</title>
 118
 119         <para>This man page is correct for version 3.0.25 of the Samba suite.
 120         </para>
 121 </refsect1>
 122
 123 <refsect1>
 124         <title>AUTHOR</title>
 125
 126         <para>The original Samba software and related utilities
 127         were created by Andrew Tridgell. Samba is now developed
 128         by the Samba Team as an Open Source project similar
 129         to the way the Linux kernel is developed.</para>
 130
 131 </refsect1>
 132
 133 </refentry>