summaryrefslogtreecommitdiffstats
path: root/docs-xml/smbdotconf/vfs
diff options
context:
space:
mode:
Diffstat (limited to 'docs-xml/smbdotconf/vfs')
-rw-r--r--docs-xml/smbdotconf/vfs/getquotacommand.xml58
-rw-r--r--docs-xml/smbdotconf/vfs/hostmsdfs.xml18
-rw-r--r--docs-xml/smbdotconf/vfs/msdfsproxy.xml19
-rw-r--r--docs-xml/smbdotconf/vfs/msdfsroot.xml18
-rw-r--r--docs-xml/smbdotconf/vfs/msdfsshufflereferrals.xml16
-rw-r--r--docs-xml/smbdotconf/vfs/ntvfshandler.xml27
-rw-r--r--docs-xml/smbdotconf/vfs/setquotacommand.xml46
-rw-r--r--docs-xml/smbdotconf/vfs/vfsobjects.xml16
8 files changed, 218 insertions, 0 deletions
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>
diff --git a/docs-xml/smbdotconf/vfs/hostmsdfs.xml b/docs-xml/smbdotconf/vfs/hostmsdfs.xml
new file mode 100644
index 0000000..e61b0f6
--- /dev/null
+++ b/docs-xml/smbdotconf/vfs/hostmsdfs.xml
@@ -0,0 +1,18 @@
+<samba:parameter name="host msdfs"
+ context="G"
+ type="boolean"
+ 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 0000000..55a410f
--- /dev/null
+++ b/docs-xml/smbdotconf/vfs/msdfsproxy.xml
@@ -0,0 +1,19 @@
+<samba:parameter name="msdfs proxy"
+ context="S"
+ type="string"
+ substitution="1"
+ 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 one or multiple, comma separated
+ proxied shares 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,\otherserver2\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 0000000..d858599
--- /dev/null
+++ b/docs-xml/smbdotconf/vfs/msdfsroot.xml
@@ -0,0 +1,18 @@
+<samba:parameter name="msdfs root"
+ context="S"
+ type="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/msdfsshufflereferrals.xml b/docs-xml/smbdotconf/vfs/msdfsshufflereferrals.xml
new file mode 100644
index 0000000..3461f3a
--- /dev/null
+++ b/docs-xml/smbdotconf/vfs/msdfsshufflereferrals.xml
@@ -0,0 +1,16 @@
+<samba:parameter name="msdfs shuffle referrals"
+ context="S"
+ type="boolean"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>If set to <constant>yes</constant>, Samba will shuffle
+ Dfs referrals for a given Dfs link if multiple are available,
+ allowing for load balancing across clients. 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>
+<related>msdfs root</related>
+<value type="default">no</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/vfs/ntvfshandler.xml b/docs-xml/smbdotconf/vfs/ntvfshandler.xml
new file mode 100644
index 0000000..c5fcf8c
--- /dev/null
+++ b/docs-xml/smbdotconf/vfs/ntvfshandler.xml
@@ -0,0 +1,27 @@
+<samba:parameter name="ntvfs handler"
+ context="S"
+ type="list"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>This specifies the NTVFS handlers for this share.</para>
+
+ <itemizedlist>
+ <listitem><para>unixuid: Sets up user credentials based on POSIX gid/uid.</para></listitem>
+ <listitem><para>cifs: Proxies a remote CIFS FS. Mainly useful for testing.</para></listitem>
+ <listitem><para>nbench: Filter module that saves data useful to the nbench benchmark suite.</para></listitem>
+ <listitem><para>ipc: Allows using SMB for inter process communication. Only used for the IPC$ share.</para></listitem>
+ <listitem><para>posix: Maps POSIX FS semantics to NT semantics</para></listitem>
+ <listitem><para>print: Allows printing over SMB. This is
+ LANMAN-style printing, not the be confused with the spoolss
+ DCE/RPC interface used by later versions of
+ Windows.</para></listitem>
+ </itemizedlist>
+
+ <para>Note that this option is only used when the NTVFS file server
+ is in use. It is not used with the (default)
+ s3fs file server.
+ </para>
+</description>
+
+<value type="default">unixuid, default</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/vfs/setquotacommand.xml b/docs-xml/smbdotconf/vfs/setquotacommand.xml
new file mode 100644
index 0000000..6ae6ef1
--- /dev/null
+++ b/docs-xml/smbdotconf/vfs/setquotacommand.xml
@@ -0,0 +1,46 @@
+<samba:parameter name="set quota command"
+ context="G"
+ type="string"
+ substitution="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 compiled with
+ quota support.</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 - path to where the quota needs to be set.
+ This needs to be interpreted relative to the current working
+ directory that the script may also check for.</para></listitem>
+ <listitem><para>2 - 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>3 - id (uid for user, gid for group, -1 if N/A)</para></listitem>
+ <listitem><para>4 - quota state (0 = disable, 1 = enable, 2 = enable and enforce)</para></listitem>
+ <listitem><para>5 - block softlimit</para></listitem>
+ <listitem><para>6 - block hardlimit</para></listitem>
+ <listitem><para>7 - inode softlimit</para></listitem>
+ <listitem><para>8 - inode hardlimit</para></listitem>
+ <listitem><para>9(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 0000000..f8f33b5
--- /dev/null
+++ b/docs-xml/smbdotconf/vfs/vfsobjects.xml
@@ -0,0 +1,16 @@
+<samba:parameter name="vfs objects"
+ type="cmdlist"
+ 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. Be aware that the definition of this
+ parameter will overwrite a possible previous definition of the
+ vfs objects parameter.</para> </description>
+
+<value type="default"/>
+<value type="example">extd_audit recycle</value>
+</samba:parameter>