source: vendor/current/docs-xml/smbdotconf/vfs/getquotacommand.xml

Last change on this file was 988, checked in by Silvan Scherrer, 9 years ago

Samba Server: update vendor to version 4.4.3

File size: 2.3 KB
Line 
1<samba:parameter name="get quota command"
2 context="G"
3 type="string"
4 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
5<description>
6 <para>The <command>get quota command</command> should only be used
7 whenever there is no operating system API available from the OS that
8 samba can use.</para>
9
10 <para>This option is only available Samba was compiled with
11 quotas support.</para>
12
13 <para>This parameter should specify the path to a script that
14 queries the quota information for the specified
15 user/group for the partition that
16 the specified directory is on.</para>
17
18 <para>Such a script is being given 3 arguments:</para>
19
20 <itemizedlist>
21 <listitem><para>directory</para></listitem>
22 <listitem><para>type of query</para></listitem>
23 <listitem><para>uid of user or gid of group</para></listitem>
24 </itemizedlist>
25
26 <para>The directory is actually mostly just "." - It needs to be
27 treated relatively to the current working directory that the script can
28 also query.</para>
29
30 <para>The type of query can be one of:</para>
31
32 <itemizedlist>
33 <listitem><para>1 - user quotas</para></listitem>
34 <listitem><para>2 - user default quotas (uid = -1)</para></listitem>
35 <listitem><para>3 - group quotas</para></listitem>
36 <listitem><para>4 - group default quotas (gid = -1)</para></listitem>
37 </itemizedlist>
38
39 <para>This script should print one line as output with spaces between the columns. The printed columns should be:
40 </para>
41
42 <itemizedlist>
43 <listitem><para>1 - quota flags (0 = no quotas, 1 = quotas enabled, 2 = quotas enabled and enforced)</para></listitem>
44 <listitem><para>2 - number of currently used blocks</para></listitem>
45 <listitem><para>3 - the softlimit number of blocks</para></listitem>
46 <listitem><para>4 - the hardlimit number of blocks</para></listitem>
47 <listitem><para>5 - currently used number of inodes</para></listitem>
48 <listitem><para>6 - the softlimit number of inodes</para></listitem>
49 <listitem><para>7 - the hardlimit number of inodes</para></listitem>
50 <listitem><para>8 (optional) - the number of bytes in a block(default is 1024)</para></listitem>
51 </itemizedlist>
52</description>
53
54<related>set quote command</related>
55<value type="default"></value>
56<value type="example">/usr/local/sbin/query_quota</value>
57</samba:parameter>
Note: See TracBrowser for help on using the repository browser.