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