1
0
mirror of https://github.com/samba-team/samba.git synced 2024-12-23 17:34:34 +03:00
samba-mirror/docs-xml/smbdotconf/vfs/getquotacommand.xml
Ralph Boehme 2503964149 smbdotconf: mark "get quota command" with substitution="1"
Signed-off-by: Ralph Boehme <slow@samba.org>
Reviewed-by: Stefan Metzmacher <metze@samba.org>
2019-11-27 10:25:34 +00:00

59 lines
2.3 KiB
XML

<samba:parameter name="get quota command"
context="G"
type="string"
substitution="1"
xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<description>
<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 option is only available Samba was compiled with
quotas support.</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 is being given 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 directory is actually mostly just "." - It needs to be
treated relatively to the current working directory that the script can
also query.</para>
<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 one line as output with spaces between the columns. The printed columns should be:
</para>
<itemizedlist>
<listitem><para>1 - quota flags (0 = no quotas, 1 = quotas enabled, 2 = quotas enabled and enforced)</para></listitem>
<listitem><para>2 - number of currently used blocks</para></listitem>
<listitem><para>3 - the softlimit number of blocks</para></listitem>
<listitem><para>4 - the hardlimit number of blocks</para></listitem>
<listitem><para>5 - currently used number of inodes</para></listitem>
<listitem><para>6 - the softlimit number of inodes</para></listitem>
<listitem><para>7 - the hardlimit number of inodes</para></listitem>
<listitem><para>8 (optional) - the number of bytes in a block(default is 1024)</para></listitem>
</itemizedlist>
</description>
<related>set quote command</related>
<value type="default"></value>
<value type="example">/usr/local/sbin/query_quota</value>
</samba:parameter>