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