docs/smbdotconf/vfs/setquotacommand.xml

   1 <samba:parameter name="set quota command"
   2                  context="G"
   3                                  type="string"
   4                  advanced="1" developer="1"
   5                  xmlns:samba="http://samba.org/common">
   6 <description>
   7         <para>The <command>set 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 if Samba was configured with the argument <command>--with-sys-quotas</command> or
  12         on linux when <command>./configure --with-quotas</command> was used and a working quota api
  13         was found in the system. Most packages are configured with these options already.</para>
  14
  15         <para>This parameter should specify the path to a script that
  16         can set quota for the specified arguments.</para>
  17
  18         <para>The specified script should take the following arguments:</para>
  19
  20         <itemizedlist>
  21                 <listitem><para>1 - quota type
  22                         <itemizedlist>
  23                                 <listitem><para>1 - user quotas</para></listitem>
  24                                 <listitem><para>2 - user default quotas (uid = -1)</para></listitem>
  25                                 <listitem><para>3 - group quotas</para></listitem>
  26                                 <listitem><para>4 - group default quotas (gid = -1)</para></listitem>
  27                         </itemizedlist>
  28                         </para></listitem>
  29                 <listitem><para>2 - id (uid for user, gid for group, -1 if N/A)</para></listitem>
  30                 <listitem><para>3 - quota state (0 = disable, 1 = enable, 2 = enable and enforce)</para></listitem>
  31                 <listitem><para>4 - block softlimit</para></listitem>
  32                 <listitem><para>5 - block hardlimit</para></listitem>
  33                 <listitem><para>6 - inode softlimit</para></listitem>
  34                 <listitem><para>7 - inode hardlimit</para></listitem>
  35                 <listitem><para>8(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>