summaryrefslogtreecommitdiff
path: root/docs/smbdotconf/vfs/getquotacommand.xml
blob: 809d1a118f2135a76aa9572596f50252706ea8c7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
<samba:parameter name="get quota command"
                 context="G"
				 type="string"
                 advanced="1" developer="1"
                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<description>
	<para>The <command>get quota command</command> should only be used 
	whenever there is no operating system API available from the OS that 
	samba can use.</para>

	<para>This option is only available with <command>./configure --with-sys-quotas</command>.
	Or on linux when <command>./configure --with-quotas</command> was used and a working quota api 
	was found in the system.</para>

	<para>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.</para>

	<para>Such a script should take 3 arguments:</para>

	<itemizedlist>
		<listitem><para>directory</para></listitem>
		<listitem><para>type of query</para></listitem>
		<listitem><para>uid of user or gid of group</para></listitem>
	</itemizedlist>

	<para>The type of query can be one of :</para>

	<itemizedlist>
		<listitem><para>1 - user quotas</para></listitem>
		<listitem><para>2 - user default quotas (uid = -1)</para></listitem>
		<listitem><para>3 - group quotas</para></listitem>
		<listitem><para>4 - group default quotas (gid = -1)</para></listitem>
	</itemizedlist>

	<para>This script should print one line as output with spaces between the arguments. The arguments are: 
	      </para>

	<itemizedlist>
		<listitem><para>Arg 1 - quota flags (0 = no quotas, 1 = quotas enabled, 2 = quotas enabled and enforced)</para></listitem>
		<listitem><para>Arg 2 - number of currently used blocks</para></listitem>
		<listitem><para>Arg 3 - the softlimit number of blocks</para></listitem>
		<listitem><para>Arg 4 - the hardlimit number of blocks</para></listitem>
		<listitem><para>Arg 5 - currently used number of inodes</para></listitem>
		<listitem><para>Arg 6 - the softlimit number of inodes</para></listitem>
		<listitem><para>Arg 7 - the hardlimit number of inodes</para></listitem>
		<listitem><para>Arg 8(optional) - the number of bytes in a block(default is 1024)</para></listitem>
	</itemizedlist>
</description>

<related>set quote command</related>
<value type="default"></value>
<value type="example">/usr/local/sbin/query_quota</value>
</samba:parameter>