Moving docs tree to docs-xml to make room for generated docs in the release tarball.
[tprouty/samba.git] / docs-xml / smbdotconf / locking / strictlocking.xml
1 <samba:parameter name="strict locking"
2                  context="S"
3                                  type="enum"
4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
5 <description>
6         <para>
7         This is an enumerated type that controls the handling of file locking in the server. When this is set to <constant>yes</constant>,
8         the server will check every read and write access for file locks, and deny access if locks exist. This can be slow on 
9         some systems.
10         </para>
11
12         <para>
13         When strict locking is set to Auto (the default), the server performs file lock checks only on non-oplocked files.
14         As most Windows redirectors perform file locking checks locally on oplocked files this is a good trade off for
15         inproved performance.
16         </para>
17
18         <para>
19         When strict locking is disabled, the server performs file lock checks only when the client explicitly asks for them.
20         </para>
21
22         <para>
23         Well-behaved clients always ask for lock checks when it is important.  So in the vast majority of cases, 
24          <command moreinfo="none">strict locking = Auto</command> or
25          <command moreinfo="none">strict locking = no</command> is acceptable.
26         </para>
27 </description>
28 <value type="default">Auto</value>
29 </samba:parameter>