docs-xml/smbdotconf/filename/vetofiles.xml

   1 <samba:parameter name="veto files"
   2                  context="S"
   3                  type="string"
   4                  substitution="1"
   5                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
   6  <description>
   7         <para>
   8         This is a list of files and directories that are neither visible nor accessible.  Each entry in
   9         the list must be separated by a '/', which allows spaces to be included in the entry. '*' and '?'
  10         can be used to specify multiple files or directories as in DOS wildcards.
  11         </para>
  12
  13         <para>
  14         <smbconfoption name="veto files"/> can also be used as a
  15         parametric option where NAME in</para>
  16
  17         <para>
  18         veto files : NAME =
  19         </para>
  20
  21         <para>
  22         specifies a user or group name with the same syntax as
  23         <smbconfoption name="valid users"/>. This parametric form can
  24         be specified multiple times for different users or
  25         groups. This means that &quot;veto files : NAME&quot; set both
  26         in the [global] and the share section add up, whereas normally
  27         options set in a share section overwrite the default in the
  28         [global] section.
  29         </para>
  30
  31         <para>
  32         Each filename must be a unix path, not a DOS path and must
  33         <emphasis>not</emphasis> include the
  34         unix directory  separator '/'.
  35         </para>
  36
  37         <para>
  38         Note that the <smbconfoption name="case sensitive"/> option is applicable in vetoing files.
  39         </para>
  40
  41         <para>
  42         One feature of the veto files parameter that it is important to be aware of is Samba's behaviour when
  43         trying to delete a directory. If a directory that is to be deleted contains nothing but veto files this
  44         deletion will <emphasis>fail</emphasis> unless you also set the <smbconfoption name="delete veto files"/>
  45         parameter to <parameter moreinfo="none">yes</parameter>.
  46         </para>
  47
  48         <para>
  49         Setting this parameter will affect the performance of Samba, as it will be forced to check all files
  50         and directories for a match as they are scanned.
  51         </para>
  52
  53         <para>
  54         Examples of use include:
  55 <programlisting>
  56 ; Veto any files containing the word Security,
  57 ; any ending in .tmp, and any directory containing the
  58 ; word root.
  59 veto files = /*Security*/*.tmp/*root*/
  60
  61 ; Veto some files for anyone and some files for specific users and groups
  62 veto files = /vetoforall1/
  63 veto files : USER = /vetotoforuser/
  64 veto files : GROUP = /vetoforgroup/
  65 veto files : UNIVERSITY\Alumnis = /somefile.txt/
  66 veto files : john@university.org = /anotherfile.txt/
  67 veto files : S-1-5-21-123-456-789-1000 = /secretfile.txt/
  68
  69 ; Veto the Apple specific files that a NetAtalk server
  70 ; creates.
  71 veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
  72 </programlisting>
  73         </para>
  74
  75 </description>
  76 <related>hide files</related>
  77 <related>case sensitive</related>
  78
  79 <value type="default"><comment>No files or directories are vetoed</comment></value>
  80 </samba:parameter>