docs-xml/smbdotconf/vfs/setquotacommand.xml

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