docs-xml/smbdotconf/vfs/getquotacommand.xml

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