Finish conversion of Locking options
[Samba.git] / docs / docbook / smbdotconf / locking / kerneloplocks.xml
blobf155fddc8fbdb861ae4bb9660bb4a72a460f9167
1 <samba:parameter name="kernel oplocks"
2                  context="G"
3                  xmlns:samba="http://samba.org/common">
4 <listitem>
5         <para>For UNIXes that support kernel based <link linkend="OPLOCKS">
6         <parameter moreinfo="none">oplocks</parameter></link>
7         (currently only IRIX and the Linux 2.4 kernel), this parameter 
8         allows the use of them to be turned on or off.</para>
10         <para>Kernel oplocks support allows Samba <parameter moreinfo="none">oplocks
11         </parameter> to be broken whenever a local UNIX process or NFS operation 
12         accesses a file that <citerefentry><refentrytitle>smbd</refentrytitle>
13         <manvolnum>8</manvolnum></citerefentry> has oplocked. This allows complete 
14         data consistency between SMB/CIFS, NFS and local file access (and is 
15         a <emphasis>very</emphasis> cool feature :-).</para>
17         <para>This parameter defaults to <constant>on</constant>, but is translated
18         to a no-op on systems that no not have the necessary kernel support.
19         You should never need to touch this parameter.</para>
21         <para>See also the <link linkend="OPLOCKS"><parameter moreinfo="none">oplocks</parameter>
22         </link> and <link linkend="LEVEL2OPLOCKS"><parameter moreinfo="none">level2 oplocks
23         </parameter></link> parameters.</para>
24                 
25         <para>Default: <command moreinfo="none">kernel oplocks = yes</command></para>
26 </listitem>
27 </samba:parameter>