docs/manpages/vfs_default_quota.8

   1 .\"     Title: vfs_default_quota
   2 .\"    Author: [see the "AUTHOR" section]
   3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
   4 .\"      Date: 04/28/2009
   5 .\"    Manual: System Administration tools
   6 .\"    Source: Samba 3.3
   7 .\"  Language: English
   8 .\"
   9 .TH "VFS_DEFAULT_QUOTA" "8" "04/28/2009" "Samba 3\&.3" "System Administration tools"
  10 .\" -----------------------------------------------------------------
  11 .\" * (re)Define some macros
  12 .\" -----------------------------------------------------------------
  13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14 .\" toupper - uppercase a string (locale-aware)
  15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16 .de toupper
  17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
  18 \\$*
  19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
  20 ..
  21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22 .\" SH-xref - format a cross-reference to an SH section
  23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24 .de SH-xref
  25 .ie n \{\
  26 .\}
  27 .toupper \\$*
  28 .el \{\
  29 \\$*
  30 .\}
  31 ..
  32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33 .\" SH - level-one heading that works better for non-TTY output
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .de1 SH
  36 .\" put an extra blank line of space above the head in non-TTY output
  37 .if t \{\
  38 .sp 1
  39 .\}
  40 .sp \\n[PD]u
  41 .nr an-level 1
  42 .set-an-margin
  43 .nr an-prevailing-indent \\n[IN]
  44 .fi
  45 .in \\n[an-margin]u
  46 .ti 0
  47 .HTML-TAG ".NH \\n[an-level]"
  48 .it 1 an-trap
  49 .nr an-no-space-flag 1
  50 .nr an-break-flag 1
  51 \." make the size of the head bigger
  52 .ps +3
  53 .ft B
  54 .ne (2v + 1u)
  55 .ie n \{\
  56 .\" if n (TTY output), use uppercase
  57 .toupper \\$*
  58 .\}
  59 .el \{\
  60 .nr an-break-flag 0
  61 .\" if not n (not TTY), use normal case (not uppercase)
  62 \\$1
  63 .in \\n[an-margin]u
  64 .ti 0
  65 .\" if not n (not TTY), put a border/line under subheading
  66 .sp -.6
  67 \l'\n(.lu'
  68 .\}
  69 ..
  70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71 .\" SS - level-two heading that works better for non-TTY output
  72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  73 .de1 SS
  74 .sp \\n[PD]u
  75 .nr an-level 1
  76 .set-an-margin
  77 .nr an-prevailing-indent \\n[IN]
  78 .fi
  79 .in \\n[IN]u
  80 .ti \\n[SN]u
  81 .it 1 an-trap
  82 .nr an-no-space-flag 1
  83 .nr an-break-flag 1
  84 .ps \\n[PS-SS]u
  85 \." make the size of the head bigger
  86 .ps +2
  87 .ft B
  88 .ne (2v + 1u)
  89 .if \\n[.$] \&\\$*
  90 ..
  91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  92 .\" BB/BE - put background/screen (filled box) around block of text
  93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94 .de BB
  95 .if t \{\
  96 .sp -.5
  97 .br
  98 .in +2n
  99 .ll -2n
 100 .gcolor red
 101 .di BX
 102 .\}
 103 ..
 104 .de EB
 105 .if t \{\
 106 .if "\\$2"adjust-for-leading-newline" \{\
 107 .sp -1
 108 .\}
 109 .br
 110 .di
 111 .in
 112 .ll
 113 .gcolor
 114 .nr BW \\n(.lu-\\n(.i
 115 .nr BH \\n(dn+.5v
 116 .ne \\n(BHu+.5v
 117 .ie "\\$2"adjust-for-leading-newline" \{\
 118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 119 .\}
 120 .el \{\
 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 122 .\}
 123 .in 0
 124 .sp -.5v
 125 .nf
 126 .BX
 127 .in
 128 .sp .5v
 129 .fi
 130 .\}
 131 ..
 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133 .\" BM/EM - put colored marker in margin next to block of text
 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 135 .de BM
 136 .if t \{\
 137 .br
 138 .ll -2n
 139 .gcolor red
 140 .di BX
 141 .\}
 142 ..
 143 .de EM
 144 .if t \{\
 145 .br
 146 .di
 147 .ll
 148 .gcolor
 149 .nr BH \\n(dn
 150 .ne \\n(BHu
 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
 152 .in 0
 153 .nf
 154 .BX
 155 .in
 156 .fi
 157 .\}
 158 ..
 159 .\" -----------------------------------------------------------------
 160 .\" * set default formatting
 161 .\" -----------------------------------------------------------------
 162 .\" disable hyphenation
 163 .nh
 164 .\" disable justification (adjust text to left margin only)
 165 .ad l
 166 .\" -----------------------------------------------------------------
 167 .\" * MAIN CONTENT STARTS HERE *
 168 .\" -----------------------------------------------------------------
 169 .SH "Name"
 170 vfs_default_quota \- store default quota records for Windows clients
 171 .SH "Synopsis"
 172 .fam C
 173 .HP \w'\ 'u
 174 \FCvfs objects = default_quota\F[]
 175 .fam
 176 .SH "DESCRIPTION"
 177 .PP
 178 This VFS module is part of the
 179 \fBsamba\fR(7)
 180 suite\&.
 181 .PP
 182 Many common quota implementations only store quotas for users and groups, but do not store a default quota\&. The
 183 \FCvfs_default_quota\F[]
 184 module allows Samba to store default quota values which can be examined using the Windows Explorer interface\&.
 185 .PP
 186 By default, Samba returns NO_LIMIT the default quota and refuses to update them\&.
 187 \FCvfs_default_quota\F[]
 188 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\&.
 189 .PP
 190 This module is stackable\&.
 191 .SH "OPTIONS"
 192 .PP
 193 default_quota:uid = UID
 194 .RS 4
 195 UID specifies the user ID of the quota record where the default user quota values are stored\&.
 196 .RE
 197 .PP
 198 default_quota:gid = GID
 199 .RS 4
 200 GID specifies the group ID of the quota record where the default group quota values are stored\&.
 201 .RE
 202 .PP
 203 default_quota:uid nolimit = BOOL
 204 .RS 4
 205 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\&.
 206 .RE
 207 .PP
 208 default_quota:gid nolimit = BOOL
 209 .RS 4
 210 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\&.
 211 .RE
 212 .SH "EXAMPLES"
 213 .PP
 214 Store the default quota record in the quota record for the user with ID 65535 and report that user as having no quota limits:
 215 .sp
 216 .if n \{\
 217 .RS 4
 218 .\}
 219 .fam C
 220 .ps -1
 221 .nf
 222 .if t \{\
 223 .sp -1
 224 .\}
 225 .BB lightgray adjust-for-leading-newline
 226 .sp -1
 227
 228         \fI[global]\fR
 229         \m[blue]\fBvfs objects = default_quota\fR\m[]
 230         \m[blue]\fBdefault_quota:uid = 65535\fR\m[]
 231         \m[blue]\fBdefault_quota:uid nolimit = yes\fR\m[]
 232 .EB lightgray adjust-for-leading-newline
 233 .if t \{\
 234 .sp 1
 235 .\}
 236 .fi
 237 .fam
 238 .ps +1
 239 .if n \{\
 240 .RE
 241 .\}
 242 .SH "VERSION"
 243 .PP
 244 This man page is correct for version 3\&.0\&.25 of the Samba suite\&.
 245 .SH "AUTHOR"
 246 .PP
 247 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\&.