From 869b67764d06995e232a97118737be6779ad4929 Mon Sep 17 00:00:00 2001 From: Björn Jacke Date: Fri, 7 Sep 2012 23:41:12 +0200 Subject: doc: improve quotacommand man page docu --- docs-xml/smbdotconf/vfs/getquotacommand.xml | 30 +++++++++++++++-------------- docs-xml/smbdotconf/vfs/setquotacommand.xml | 24 ++++++++++++----------- 2 files changed, 29 insertions(+), 25 deletions(-) (limited to 'docs-xml/smbdotconf/vfs') diff --git a/docs-xml/smbdotconf/vfs/getquotacommand.xml b/docs-xml/smbdotconf/vfs/getquotacommand.xml index 04f30344f1..eacd19cf79 100644 --- a/docs-xml/smbdotconf/vfs/getquotacommand.xml +++ b/docs-xml/smbdotconf/vfs/getquotacommand.xml @@ -8,17 +8,15 @@ whenever there is no operating system API available from the OS that samba can use. - This option is only available you have compiled Samba with the - --with-sys-quotas option or on Linux with - --with-quotas and a working quota api - was found in the system. + This option is only available Samba was compiled with + quotas support. This parameter should specify the path to a script that queries the quota information for the specified user/group for the partition that the specified directory is on. - Such a script should take 3 arguments: + Such a script is being given 3 arguments: directory @@ -26,6 +24,10 @@ uid of user or gid of group + The directory is actually mostly just "." - It needs to be + treated relatively to the current working directory that the script can + also query. + The type of query can be one of: @@ -35,18 +37,18 @@ 4 - group default quotas (gid = -1) - This script should print one line as output with spaces between the arguments. The arguments are: + This script should print one line as output with spaces between the columns. The printed columns should be: - Arg 1 - quota flags (0 = no quotas, 1 = quotas enabled, 2 = quotas enabled and enforced) - Arg 2 - number of currently used blocks - Arg 3 - the softlimit number of blocks - Arg 4 - the hardlimit number of blocks - Arg 5 - currently used number of inodes - Arg 6 - the softlimit number of inodes - Arg 7 - the hardlimit number of inodes - Arg 8(optional) - the number of bytes in a block(default is 1024) + 1 - quota flags (0 = no quotas, 1 = quotas enabled, 2 = quotas enabled and enforced) + 2 - number of currently used blocks + 3 - the softlimit number of blocks + 4 - the hardlimit number of blocks + 5 - currently used number of inodes + 6 - the softlimit number of inodes + 7 - the hardlimit number of inodes + 8 (optional) - the number of bytes in a block(default is 1024) diff --git a/docs-xml/smbdotconf/vfs/setquotacommand.xml b/docs-xml/smbdotconf/vfs/setquotacommand.xml index 03e40a9e3d..cf62715ca5 100644 --- a/docs-xml/smbdotconf/vfs/setquotacommand.xml +++ b/docs-xml/smbdotconf/vfs/setquotacommand.xml @@ -8,9 +8,8 @@ whenever there is no operating system API available from the OS that samba can use. - This option is only available if Samba was configured with the argument --with-sys-quotas or - on Linux when ./configure --with-quotas was used and a working quota api - was found in the system. Most packages are configured with these options already. + This option is only available if Samba was compiled with + quota support. This parameter should specify the path to a script that can set quota for the specified arguments. @@ -18,20 +17,23 @@ The specified script should take the following arguments: - 1 - quota type + 1 - path to where the quota needs to be set. + This needs to be interpreted relative to the current working + directory that the script may also check for. + 2 - quota type 1 - user quotas 2 - user default quotas (uid = -1) 3 - group quotas 4 - group default quotas (gid = -1) - 2 - id (uid for user, gid for group, -1 if N/A) - 3 - quota state (0 = disable, 1 = enable, 2 = enable and enforce) - 4 - block softlimit - 5 - block hardlimit - 6 - inode softlimit - 7 - inode hardlimit - 8(optional) - block size, defaults to 1024 + 3 - id (uid for user, gid for group, -1 if N/A) + 4 - quota state (0 = disable, 1 = enable, 2 = enable and enforce) + 5 - block softlimit + 6 - block hardlimit + 7 - inode softlimit + 8 - inode hardlimit + 9(optional) - block size, defaults to 1024 The script should output at least one line of data on success. And nothing on failure. -- cgit