Add new framework for smb.conf(5). Please read README before trying to compile.
[Samba/gebeck_regimport.git] / docs / docbook / smbdotconf / locking / kerneloplocks.xml
blob98513fdd1e92ba3ebd212ffa15965c1989da8c84
1 <samba:parameter xmlns:samba="http://samba.org/common">
2                 <term><anchor id="KERNELOPLOCKS"/>kernel oplocks (G)</term>
3                 <listitem><para>For UNIXes that support kernel based <link linkend="OPLOCKS"><parameter moreinfo="none">oplocks</parameter></link>
4                 (currently only IRIX and the Linux 2.4 kernel), this parameter 
5                 allows the use of them to be turned on or off.</para>
7                 <para>Kernel oplocks support allows Samba <parameter moreinfo="none">oplocks
8                 </parameter> to be broken whenever a local UNIX process or NFS operation 
9                 accesses a file that <citerefentry><refentrytitle>smbd</refentrytitle>
10                 <manvolnum>8</manvolnum></citerefentry> has oplocked. This allows complete 
11                 data consistency between SMB/CIFS, NFS and local file access (and is 
12                 a <emphasis>very</emphasis> cool feature :-).</para>
14                 <para>This parameter defaults to <constant>on</constant>, but is translated
15                 to a no-op on systems that no not have the necessary kernel support.
16                 You should never need to touch this parameter.</para>
18                 <para>See also the <link linkend="OPLOCKS"><parameter moreinfo="none">oplocks</parameter>
19                 </link> and <link linkend="LEVEL2OPLOCKS"><parameter moreinfo="none">level2 oplocks
20                 </parameter></link> parameters.</para>
21                 
22                 <para>Default: <command moreinfo="none">kernel oplocks = yes</command></para>
23                 </listitem>
24                 </samba:parameter>