document set quota command
authorJelmer Vernooij <jelmer@samba.org>
Fri, 15 Aug 2003 16:31:06 +0000 (16:31 +0000)
committerJelmer Vernooij <jelmer@samba.org>
Fri, 15 Aug 2003 16:31:06 +0000 (16:31 +0000)
(This used to be commit 8b1fd7526bf0a580edaeed45047624588e0a0a22)

docs/docbook/smbdotconf/vfs/setquotacommand.xml [new file with mode: 0644]

diff --git a/docs/docbook/smbdotconf/vfs/setquotacommand.xml b/docs/docbook/smbdotconf/vfs/setquotacommand.xml
new file mode 100644 (file)
index 0000000..b4b7303
--- /dev/null
@@ -0,0 +1,42 @@
+<samba:parameter name="set quota command"
+                 context="G"
+                 advanced="1" developer="1"
+                 xmlns:samba="http://samba.org/common">
+<listitem>
+       <para>The <command>set quota command</command> should only be used 
+       whenever there is no operating system API available from the OS that 
+       samba can use.</para>
+
+       <para>This parameter should specify the path to a script that 
+       can set quota for the specified arguments.</para>
+
+       <para>The specified script should take the following arguments:</para>
+
+       <itemizedlist>
+               <listitem><para>1 - quota type
+                       <itemizedlist>
+                               <listitem><para>1 - user quotas</para></listitem>
+                               <listitem><para>2 - user default quotas (uid = -1)</para></listitem>
+                               <listitem><para>3 - group quotas</para></listitem>
+                               <listitem><para>4 - group default quotas (gid = -1)</para></listitem>
+                       </itemizedlist>
+                       </para></listitem>
+               <listitem><para>2 - id (uid for user, gid for group, -1 if N/A)</para></listitem>
+               <listitem><para>3 - quota state (0 = disable, 1 = enable, 2 = enable and enforce)</para></listitem>
+               <listitem><para>4 - block softlimit</para></listitem>
+               <listitem><para>5 - block hardlimit</para></listitem>
+               <listitem><para>6 - inode softlimit</para></listitem>
+               <listitem><para>7 - inode hardlimit</para></listitem>
+               <listitem><para>8(optional) - block size, defaults to 1024</para></listitem>
+       </itemizedlist>
+
+       <para>The script should output at least one line of data.</para>
+
+       <para>See also the <link linkend="GETQUOTACOMMAND"><parameter moreinfo="none">get quota command</parameter></link> parameter.
+       </para>
+               
+       <para>Default: <command moreinfo="none">set quota command = </command></para>
+
+       <para>Example: <command moreinfo="none">set quota command = /usr/local/sbin/set_quota</command></para>
+</listitem>
+</samba:parameter>