docs-xml/smbdotconf/vfs/setquotacommand.xml

   1 <samba:parameter name="set 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>set 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 if Samba was compiled with
  11         quota support.</para>
  12
  13         <para>This parameter should specify the path to a script that
  14         can set quota for the specified arguments.</para>
  15
  16         <para>The specified script should take the following arguments:</para>
  17
  18         <itemizedlist>
  19                 <listitem><para>1 - path to where the quota needs to be set.
  20                 This needs to be interpreted relative to the current working
  21                 directory that the script may also check for.</para></listitem>
  22                 <listitem><para>2 - quota type
  23                         <itemizedlist>
  24                                 <listitem><para>1 - user quotas</para></listitem>
  25                                 <listitem><para>2 - user default quotas (uid = -1)</para></listitem>
  26                                 <listitem><para>3 - group quotas</para></listitem>
  27                                 <listitem><para>4 - group default quotas (gid = -1)</para></listitem>
  28                         </itemizedlist></para></listitem>
  29                 <listitem><para>3 - id (uid for user, gid for group, -1 if N/A)</para></listitem>
  30                 <listitem><para>4 - quota state (0 = disable, 1 = enable, 2 = enable and enforce)</para></listitem>
  31                 <listitem><para>5 - block softlimit</para></listitem>
  32                 <listitem><para>6 - block hardlimit</para></listitem>
  33                 <listitem><para>7 - inode softlimit</para></listitem>
  34                 <listitem><para>8 - inode hardlimit</para></listitem>
  35                 <listitem><para>9(optional) - block size, defaults to 1024</para></listitem>
  36         </itemizedlist>
  37
  38         <para>The script should output at least one line of data on success. And nothing on failure.</para>
  39 </description>
  40
  41 <related>get quota command</related>
  42
  43 <value type="default"></value>
  44 <value type="example">/usr/local/sbin/set_quota</value>
  45 </samba:parameter>