summaryrefslogtreecommitdiff
path: root/docs/smbdotconf/filename/vetofiles.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/smbdotconf/filename/vetofiles.xml')
-rw-r--r--docs/smbdotconf/filename/vetofiles.xml46
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/smbdotconf/filename/vetofiles.xml b/docs/smbdotconf/filename/vetofiles.xml
new file mode 100644
index 0000000000..495722d295
--- /dev/null
+++ b/docs/smbdotconf/filename/vetofiles.xml
@@ -0,0 +1,46 @@
+<samba:parameter name="veto files"
+ context="S"
+ type="string"
+ xmlns:samba="http://samba.org/common">
+ <description>
+ <para>This is a list of files and directories that
+ are neither visible nor accessible. Each entry in the list must
+ be separated by a '/', which allows spaces to be included
+ in the entry. '*' and '?' can be used to specify multiple files
+ or directories as in DOS wildcards.</para>
+
+ <para>Each entry must be a unix path, not a DOS path and
+ must <emphasis>not</emphasis> include the unix directory
+ separator '/'.</para>
+
+ <para>Note that the <parameter moreinfo="none">case sensitive</parameter> option
+ is applicable in vetoing files.</para>
+
+ <para>One feature of the veto files parameter that it
+ is important to be aware of is Samba's behaviour when
+ trying to delete a directory. If a directory that is
+ to be deleted contains nothing but veto files this
+ deletion will <emphasis>fail</emphasis> unless you also set
+ the <parameter moreinfo="none">delete veto files</parameter> parameter to
+ <parameter moreinfo="none">yes</parameter>.</para>
+
+ <para>Setting this parameter will affect the performance
+ of Samba, as it will be forced to check all files and directories
+ for a match as they are scanned.</para>
+</description>
+<related>hide files</related>
+<related>case sensitive</related>
+
+<value type="default"><comment>No files or directories are vetoed.</comment></value>
+
+<value type="example">
+; Veto any files containing the word Security,
+; any ending in .tmp, and any directory containing the
+; word root.
+veto files = /*Security*/*.tmp/*root*/
+
+; Veto the Apple specific files that a NetAtalk server
+; creates.
+veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
+</value>
+</samba:parameter>