docs/docbook/smbdotconf/vfs/setquotacommand.xml

   1 <samba:parameter name="set quota command"
   2                  context="G"
   3                  advanced="1" developer="1"
   4                  xmlns:samba="http://samba.org/common">
   5 <listitem>
   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 parameter should specify the path to a script that
  11         can set quota for the specified arguments.</para>
  12
  13         <para>The specified script should take the following arguments:</para>
  14
  15         <itemizedlist>
  16                 <listitem><para>1 - quota type
  17                         <itemizedlist>
  18                                 <listitem><para>1 - user quotas</para></listitem>
  19                                 <listitem><para>2 - user default quotas (uid = -1)</para></listitem>
  20                                 <listitem><para>3 - group quotas</para></listitem>
  21                                 <listitem><para>4 - group default quotas (gid = -1)</para></listitem>
  22                         </itemizedlist>
  23                         </para></listitem>
  24                 <listitem><para>2 - id (uid for user, gid for group, -1 if N/A)</para></listitem>
  25                 <listitem><para>3 - quota state (0 = disable, 1 = enable, 2 = enable and enforce)</para></listitem>
  26                 <listitem><para>4 - block softlimit</para></listitem>
  27                 <listitem><para>5 - block hardlimit</para></listitem>
  28                 <listitem><para>6 - inode softlimit</para></listitem>
  29                 <listitem><para>7 - inode hardlimit</para></listitem>
  30                 <listitem><para>8(optional) - block size, defaults to 1024</para></listitem>
  31         </itemizedlist>
  32
  33         <para>The script should output at least one line of data.</para>
  34
  35         <para>See also the <link linkend="GETQUOTACOMMAND"><parameter moreinfo="none">get quota command</parameter></link> parameter.
  36         </para>
  37
  38         <para>Default: <command moreinfo="none">set quota command = </command></para>
  39
  40         <para>Example: <command moreinfo="none">set quota command = /usr/local/sbin/set_quota</command></para>
  41 </listitem>
  42 </samba:parameter>