Moving docs tree to docs-xml to make room for generated docs in the release tarball.
[sfrench/samba-autobuild/.git] / docs-xml / smbdotconf / locking / sharemodes.xml
1 <samba:parameter name="share modes"
2         type="boolean"
3                  context="S"
4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
5 <description>
6         <para>This enables or disables the honoring of 
7         the <parameter moreinfo="none">share modes</parameter> during a file open. These 
8         modes are used by clients to gain exclusive read or write access 
9         to a file.</para>
10
11         <para>These open modes are not directly supported by UNIX, so
12         they are simulated using shared memory, or lock files if your 
13         UNIX doesn't support shared memory (almost all do).</para>
14
15         <para>The share modes that are enabled by this option are 
16          <constant>DENY_DOS</constant>, <constant>DENY_ALL</constant>,
17         <constant>DENY_READ</constant>, <constant>DENY_WRITE</constant>,
18         <constant>DENY_NONE</constant> and <constant>DENY_FCB</constant>.
19         </para>
20
21         <para>This option gives full share compatibility and enabled 
22         by default.</para>
23
24         <para>You should <emphasis>NEVER</emphasis> turn this parameter 
25         off as many Windows applications will break if you do so.</para>
26 </description>
27 <value type="default">yes</value>
28 </samba:parameter>