Next update of VFS modules development guide
[kai/samba.git] / docs / smbdotconf / filename / vetooplockfiles.xml
1 <samba:parameter name="veto oplock files"
2                  context="S"
3                                  type="string"
4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
5  <description>
6         <para>
7         This parameter is only valid when the <smbconfoption name="oplocks"/>
8         parameter is turned on for a share. It allows the Samba administrator
9         to selectively turn off the granting of oplocks on selected files that
10         match a wildcarded list, similar to the wildcarded list used in the
11         <smbconfoption name="veto files"/> parameter.
12         </para>
13
14
15         <para>
16         You might want to do this on files that you know will be heavily contended 
17         for by clients. A good example of this is in the NetBench SMB benchmark 
18         program, which causes heavy client contention for files ending in 
19         <filename moreinfo="none">.SEM</filename>. To cause Samba not to grant 
20         oplocks on these files you would use the line (either in the [global] 
21         section or in the section for the particular NetBench share.
22         </para>
23
24         <para>
25         An example of use is:
26 <programlisting>
27 veto oplock files = /.*SEM/
28 </programlisting>
29         </para>
30 </description>
31 <value type="default"><comment>No files are vetoed for oplock grants</comment></value>
32 </samba:parameter>