Next update of VFS modules development guide
[sfrench/samba-autobuild/.git] / docs-xml / smbdotconf / filename / vetofiles.xml
1 <samba:parameter name="veto files"
2                  context="S"
3                                  type="string"
4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
5  <description>
6         <para>
7         This is a list of files and directories that are neither visible nor accessible.  Each entry in 
8         the list must be separated by a '/', which allows spaces to be included in the entry. '*' and '?' 
9         can be used to specify multiple files or directories as in DOS wildcards.
10         </para>
11
12         <para>
13         Each entry must be a unix path, not a DOS path and must <emphasis>not</emphasis> include the  
14         unix directory  separator '/'.
15         </para>
16
17         <para>
18         Note that the <smbconfoption name="case sensitive"/> option is applicable in vetoing files.
19         </para>
20                 
21         <para>
22         One feature of the veto files parameter that it is important to be aware of is Samba's behaviour when
23         trying to delete a directory. If a directory that is to be deleted contains nothing but veto files this
24         deletion will <emphasis>fail</emphasis> unless you also set the <smbconfoption name="delete veto files"/> 
25         parameter to <parameter moreinfo="none">yes</parameter>.
26         </para>
27
28         <para>
29         Setting this parameter will affect the performance of Samba, as it will be forced to check all files 
30         and directories for a match as they are scanned.
31         </para>
32
33         <para>
34         Examples of use include:
35 <programlisting>
36 ; Veto any files containing the word Security,
37 ; any ending in .tmp, and any directory containing the
38 ; word root.
39 veto files = /*Security*/*.tmp/*root*/
40
41 ; Veto the Apple specific files that a NetAtalk server
42 ; creates.
43 veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
44 </programlisting>
45         </para>
46
47 </description>
48 <related>hide files</related>
49 <related>case sensitive</related>
50
51 <value type="default">No files or directories are vetoed.</value>
52 </samba:parameter>