r10061: add some description to the default_quota module

jht: can you merge that to the howto, please?

metze
(This used to be commit 48c5c760afd77f86778b96925486d1b21e332a61)

diff --git a/source3/modules/vfs_default_quota.c b/source3/modules/vfs_default_quota.c
index f7c5dce4d674f7054d7d0a4de5922ffff833b97a..4636441999582155cc72958b7f87213e34eb6c7e 100644 (file)
--- a/source3/modules/vfs_default_quota.c
+++ b/source3/modules/vfs_default_quota.c
@@ -18,6 +18,56 @@
  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  */
 
+/*
+ * This module allows the default quota values,
+ * in the windows explorer GUI, to be stored on a samba server.
+ * The problem is that linux filesystems only store quotas
+ * for users and groups, but no default quotas.
+ *
+ * Samba returns NO_LIMIT as the default quotas by default
+ * and refuses to update them.
+ *
+ * With this module you can store the default quotas that are reported to
+ * a windows client, in the quota record of a user. By default the root user
+ * is taken because quota limits for root are typically not enforced.
+ *
+ * This module takes 2 parametric parameters in smb.conf:
+ * (the default prefix for them is 'default_quota',
+ *  it can be overwrittem when you load the module in
+ *  the 'vfs modules' parameter like this:
+ *  vfs modules = default_quota:myprefix)
+ * 
+ * "<prefix>:uid" parameter takes a integer argument,
+ *     it specifies the uid of the quota record, that will be taken for
+ *     storing the default USER-quotas.
+ *
+ *     - default value: '0' (for root user)
+ *     - e.g.: default_quota:uid = 65534
+ *
+ * "<prefix>:uid nolimit" parameter takes a boolean argument,
+ *     it specifies if we should report the stored default quota values,
+ *     also for the user record, or if you should just report NO_LIMIT
+ *     to the windows client for the user specified by the "<prefix>:uid" parameter.
+ *     
+ *     - default value: yes (that means to report NO_LIMIT)
+ *     - e.g.: default_quota:uid nolimit = no
+ * 
+ * "<prefix>:gid" parameter takes a integer argument,
+ *     it's just like "<prefix>:uid" but for group quotas.
+ *     (NOTE: group quotas are not supported from the windows explorer!)
+ *
+ *     - default value: '0' (for root group)
+ *     - e.g.: default_quota:gid = 65534
+ *
+ * "<prefix>:gid nolimit" parameter takes a boolean argument,
+ *     it's just like "<prefix>:uid nolimit" but for group quotas.
+ *     (NOTE: group quotas are not supported from the windows explorer!)
+ *     
+ *     - default value: yes (that means to report NO_LIMIT)
+ *     - e.g.: default_quota:uid nolimit = no
+ *
+ */
+
 #include "includes.h"
 
 #undef DBGC_CLASS