From 4f5791ebd03eaec1c7da0865a383175b05102712 Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Sun, 5 May 2024 19:47:29 +0200
Subject: Adding upstream version 2:4.17.12+dfsg.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 docs-xml/smbdotconf/vfs/getquotacommand.xml | 58 +++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 docs-xml/smbdotconf/vfs/getquotacommand.xml

(limited to 'docs-xml/smbdotconf/vfs/getquotacommand.xml')

diff --git a/docs-xml/smbdotconf/vfs/getquotacommand.xml b/docs-xml/smbdotconf/vfs/getquotacommand.xml
new file mode 100644
index 0000000..9422b7e
--- /dev/null
+++ b/docs-xml/smbdotconf/vfs/getquotacommand.xml
@@ -0,0 +1,58 @@
+<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>
-- 
cgit v1.2.3