getquotacommand.xml   [plain text]

<samba:parameter name="get quota command"
                 context="G"
                 advanced="1" developer="1"
                 xmlns:samba="http://samba.org/common">
<listitem>
	<para>The <command>get 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 
	queries the quota information for the specified 
	user/group for the partition that 
	the specified directory is on.</para>

	<para>Such a script should take 3 arguments:</para>

	<itemizedlist>
		<listitem><para>directory</para></listitem>
		<listitem><para>type of query</para></listitem>
		<listitem><para>uid of user or gid of group</para></listitem>
	</itemizedlist>

	<para>The type of query can be one of :</para>

	<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>This script should print its output according to the following format:</para>

	<itemizedlist>
		<listitem><para>Line 1 - quota flags (0 = no quotas, 1 = quotas enabled, 2 = quotas enabled and enforced)</para></listitem>
		<listitem><para>Line 2 - number of currently used blocks</para></listitem>
		<listitem><para>Line 3 - the softlimit number of blocks</para></listitem>
		<listitem><para>Line 4 - the hardlimit number of blocks</para></listitem>
		<listitem><para>Line 5 - currently used number of inodes</para></listitem>
		<listitem><para>Line 6 - the softlimit number of inodes</para></listitem>
		<listitem><para>Line 7 - the hardlimit number of inodes</para></listitem>
		<listitem><para>Line 8(optional) - the number of bytes in a block(default is 1024)</para></listitem>
	</itemizedlist>

	<para>See also the <link linkend="SETQUOTACOMMAND"><parameter moreinfo="none">set quota command</parameter></link> parameter.
	</para>
		
	<para>Default: <command moreinfo="none">get quota command = </command></para>

	<para>Example: <command moreinfo="none">get quota command = /usr/local/sbin/query_quota</command></para>
</listitem>
</samba:parameter>