summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGerald Carter <jerry@samba.org>2003-08-07 05:00:51 +0000
committerGerald Carter <jerry@samba.org>2003-08-07 05:00:51 +0000
commita3513090e77ddf380f7de67fc625e15ad16d5e4b (patch)
tree209cf9d6aeccf196a0dfbaadb0f2b08cee8c3089 /docs
parent110abf10d208769bf6bcfc0604874cb1bed0406a (diff)
downloadsamba-a3513090e77ddf380f7de67fc625e15ad16d5e4b.tar.gz
samba-a3513090e77ddf380f7de67fc625e15ad16d5e4b.tar.bz2
samba-a3513090e77ddf380f7de67fc625e15ad16d5e4b.zip
adding generic docs for defining VFS module options
(This used to be commit 6168d3da670f7bb75e34b65a91c76728576f8607)
Diffstat (limited to 'docs')
-rw-r--r--docs/docbook/smbdotconf/vfs/vfsobjects.xml11
1 files changed, 10 insertions, 1 deletions
diff --git a/docs/docbook/smbdotconf/vfs/vfsobjects.xml b/docs/docbook/smbdotconf/vfs/vfsobjects.xml
index 32a10b5bd6..85f5016401 100644
--- a/docs/docbook/smbdotconf/vfs/vfsobjects.xml
+++ b/docs/docbook/smbdotconf/vfs/vfsobjects.xml
@@ -2,10 +2,19 @@
context="S"
xmlns:samba="http://samba.org/common">
<listitem>
- <para>This parameter specifies the backend names which
+ <para>This parameter specifies the backend module 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>
+
+ <para>Options for a given VFS module are specified one per line
+ smb.conf perfaced by the module name and a colon (:). Such as</para>
+
+ <para>foo:bar=biddle</para>
+
+ <para>where 'foo' is the name of VFS module, 'bar' is a parameter supported
+ by ;foo;, and 'biddle' is the value of the option 'bar'. Refer to the
+ manpage for a given VFS modules regarding the options supported by that module.</para>
<para>Default: <emphasis>no value</emphasis></para>