Moving docs tree to docs-xml to make room for generated docs in the release tarball.

(This used to be commit 9f672c26d63955f613088489c6efbdc08b5b2d14)

7 files changed, 186 insertions, 0 deletions

diff --git a/docs-xml/smbdotconf/vfs/aclcompatibility.xml b/docs-xml/smbdotconf/vfs/aclcompatibility.xml
new file mode 100644
index 0000000000..7891adc13b
--- /dev/null
+++ b/docs-xml/smbdotconf/vfs/aclcompatibility.xml
@@ -0,0 +1,17 @@
+<samba:parameter name="acl compatibility"
+                 context="S"
+				 type="enum"
+                 advanced="1" developer="1"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>This parameter specifies what OS ACL semantics should 
+	be compatible with. Possible values are <emphasis>winnt</emphasis> for Windows NT 4, 
+	<emphasis>win2k</emphasis> for Windows 2000 and above and <emphasis>auto</emphasis>.
+	If you specify <emphasis>auto</emphasis>, the value for this parameter 
+	will be based upon the version of the client. There should 
+	be no reason to change this parameter from the default.</para>
+</description>
+
+<value type="default">Auto</value>
+<value type="example">win2k</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/vfs/getquotacommand.xml b/docs-xml/smbdotconf/vfs/getquotacommand.xml
new file mode 100644
index 0000000000..809d1a118f
--- /dev/null
+++ b/docs-xml/smbdotconf/vfs/getquotacommand.xml
@@ -0,0 +1,55 @@
+<samba:parameter name="get quota command"
+                 context="G"
+				 type="string"
+                 advanced="1" developer="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 with <command>./configure --with-sys-quotas</command>.
+	Or on linux when <command>./configure --with-quotas</command> was used and a working quota api 
+	was found in the system.</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 one line as output with spaces between the arguments. The arguments are: 
+	      </para>
+
+	<itemizedlist>
+		<listitem><para>Arg 1 - quota flags (0 = no quotas, 1 = quotas enabled, 2 = quotas enabled and enforced)</para></listitem>
+		<listitem><para>Arg 2 - number of currently used blocks</para></listitem>
+		<listitem><para>Arg 3 - the softlimit number of blocks</para></listitem>
+		<listitem><para>Arg 4 - the hardlimit number of blocks</para></listitem>
+		<listitem><para>Arg 5 - currently used number of inodes</para></listitem>
+		<listitem><para>Arg 6 - the softlimit number of inodes</para></listitem>
+		<listitem><para>Arg 7 - the hardlimit number of inodes</para></listitem>
+		<listitem><para>Arg 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>
diff --git a/docs-xml/smbdotconf/vfs/hostmsdfs.xml b/docs-xml/smbdotconf/vfs/hostmsdfs.xml
new file mode 100644
index 0000000000..67f67dce45
--- /dev/null
+++ b/docs-xml/smbdotconf/vfs/hostmsdfs.xml
@@ -0,0 +1,19 @@
+<samba:parameter name="host msdfs"
+                 context="G"
+				 type="boolean"
+                 advanced="1" developer="1"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+ <description>
+	<para>
+	If set to <constant>yes</constant>, Samba will act as a Dfs server, and allow Dfs-aware clients to browse
+	Dfs trees hosted on the server.
+	</para>
+
+	<para>
+	See also the <smbconfoption name="msdfs root"/> share  level  parameter.  For more  information  on
+	setting  up a Dfs tree on Samba, refer to the MSFDS chapter in the book Samba3-HOWTO.
+	</para>
+</description>
+
+<value type="default">yes</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/vfs/msdfsproxy.xml b/docs-xml/smbdotconf/vfs/msdfsproxy.xml
new file mode 100644
index 0000000000..5117bae224
--- /dev/null
+++ b/docs-xml/smbdotconf/vfs/msdfsproxy.xml
@@ -0,0 +1,18 @@
+<samba:parameter name="msdfs proxy"
+                 context="S"
+				 type="string"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>This parameter indicates that the share is a
+	stand-in for another CIFS share whose location is specified by
+	the value of the parameter. When clients attempt to connect to
+	this share, they are redirected to the proxied share using
+	the SMB-Dfs protocol.</para>
+
+	<para>Only Dfs roots can act as proxy shares. Take a look at the
+	<smbconfoption name="msdfs root"/> and <smbconfoption name="host msdfs"/>
+	options to find out how to set up a Dfs root share.</para>
+</description>
+
+<value type="example">\otherserver\someshare</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/vfs/msdfsroot.xml b/docs-xml/smbdotconf/vfs/msdfsroot.xml
new file mode 100644
index 0000000000..86dc6f1d8c
--- /dev/null
+++ b/docs-xml/smbdotconf/vfs/msdfsroot.xml
@@ -0,0 +1,18 @@
+<samba:parameter name="msdfs root"
+                 context="S"
+				 tye="boolean"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>If set to <constant>yes</constant>, Samba treats the
+	share as a Dfs root and allows clients to browse the
+	distributed file system tree rooted at the share directory.
+	Dfs links are specified in the share directory by symbolic
+	links of the form <filename>msdfs:serverA\\shareA,serverB\\shareB</filename>
+	and so on.  For more information on setting up a Dfs tree on
+	Samba, refer to the MSDFS chapter in the Samba3-HOWTO book.</para>
+</description>
+
+<related>host msdfs</related>
+<value type="default">no</value>
+<para>See also <smbconfoption name="host msdfs"/></para>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/vfs/setquotacommand.xml b/docs-xml/smbdotconf/vfs/setquotacommand.xml
new file mode 100644
index 0000000000..b00a620628
--- /dev/null
+++ b/docs-xml/smbdotconf/vfs/setquotacommand.xml
@@ -0,0 +1,44 @@
+<samba:parameter name="set quota command"
+                 context="G"
+				 type="string"
+                 advanced="1" developer="1"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<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 option is only available if Samba was configured with the argument <command>--with-sys-quotas</command> or 
+	on linux when <command>./configure --with-quotas</command> was used and a working quota api 
+	was found in the system. Most packages are configured with these options already.</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 on success. And nothing on failure.</para>
+</description>
+
+<related>get quota command</related>
+
+<value type="default"></value>
+<value type="example">/usr/local/sbin/set_quota</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/vfs/vfsobjects.xml b/docs-xml/smbdotconf/vfs/vfsobjects.xml
new file mode 100644
index 0000000000..09d41c75b0
--- /dev/null
+++ b/docs-xml/smbdotconf/vfs/vfsobjects.xml
@@ -0,0 +1,15 @@
+<samba:parameter name="vfs objects"
+				type="list"
+                 context="S"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<synonym>vfs object</synonym>
+<description>
+	<para>This parameter specifies the backend names which 
+	are used for Samba VFS I/O operations.  By default, normal 
+	disk I/O operations are used but these can be overloaded 
+	with one or more VFS objects. </para>
+</description>
+
+<value type="default"/>
+<value type="example">extd_audit recycle</value>
+</samba:parameter>