summaryrefslogtreecommitdiff
path: root/docs-xml/smbdotconf/filename/vetofiles.xml
diff options
context:
space:
mode:
authorGerald W. Carter <jerry@samba.org>2008-04-22 10:09:40 -0500
committerGerald W. Carter <jerry@samba.org>2008-04-23 08:47:48 -0500
commit8f8a9f01909ba29e2b781310baeeaaddc3f15f0d (patch)
tree90c6b720ad3a7bc815245c0ef28820424f89d658 /docs-xml/smbdotconf/filename/vetofiles.xml
parent197238246389c40edc60c6630d18d6913086e630 (diff)
downloadsamba-8f8a9f01909ba29e2b781310baeeaaddc3f15f0d.tar.gz
samba-8f8a9f01909ba29e2b781310baeeaaddc3f15f0d.tar.bz2
samba-8f8a9f01909ba29e2b781310baeeaaddc3f15f0d.zip
Moving docs tree to docs-xml to make room for generated docs in the release tarball.
(This used to be commit 9f672c26d63955f613088489c6efbdc08b5b2d14)
Diffstat (limited to 'docs-xml/smbdotconf/filename/vetofiles.xml')
-rw-r--r--docs-xml/smbdotconf/filename/vetofiles.xml52
1 files changed, 52 insertions, 0 deletions
diff --git a/docs-xml/smbdotconf/filename/vetofiles.xml b/docs-xml/smbdotconf/filename/vetofiles.xml
new file mode 100644
index 0000000000..48e0c40fff
--- /dev/null
+++ b/docs-xml/smbdotconf/filename/vetofiles.xml
@@ -0,0 +1,52 @@
+<samba:parameter name="veto files"
+ context="S"
+ type="string"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+ <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 <smbconfoption name="case sensitive"/> 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 <smbconfoption name="delete veto files"/>
+ 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>
+
+ <para>
+ Examples of use include:
+<programlisting>
+; 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/
+</programlisting>
+ </para>
+
+</description>
+<related>hide files</related>
+<related>case sensitive</related>
+
+<value type="default">No files or directories are vetoed.</value>
+</samba:parameter>