Next update of VFS modules development guide
[tprouty/samba.git] / docs-xml / smbdotconf / filename / hidefiles.xml
1 <samba:parameter name="hide files"
2                                  type="string"
3                  context="S"
4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
5 <description>
6         <para>This is a list of files or directories that are not 
7         visible but are accessible.  The DOS 'hidden' attribute is applied 
8         to any files or directories that match.</para>
9
10         <para>Each entry in the list must be separated by a '/', 
11         which allows spaces to be included in the entry.  '*'
12         and '?' can be used to specify multiple files or directories 
13         as in DOS wildcards.</para>
14
15         <para>Each entry must be a Unix path, not a DOS path and must 
16         not include the Unix directory separator '/'.</para>
17
18         <para>Note that the case sensitivity option is applicable 
19         in hiding files.</para>
20                 
21         <para>Setting this parameter will affect the performance of Samba, 
22         as it will be forced to check all files and directories for a match 
23         as they are scanned.</para>
24
25         <para>
26         The example shown above is based on files that the Macintosh 
27         SMB client (DAVE) available from <ulink url="http://www.thursby.com"> 
28         Thursby</ulink> creates for internal use, and also still hides 
29         all files beginning with a dot.
30         </para>
31
32         <para>
33         An example of us of this parameter is:
34 <programlisting>
35 hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/
36 </programlisting>
37         </para>
38 </description>
39
40 <related>hide dot files</related>
41 <related>veto files</related>
42 <related>case sensitive</related>
43
44 <value type="default"><comment>no file are hidden</comment></value>
45
46 </samba:parameter>