docs/docbook/smbdotconf/locking/fakeoplocks.xml

   1 <samba:parameter xmlns:samba="http://samba.org/common">
   2                 <term><anchor id="FAKEOPLOCKS"/>fake oplocks (S)</term>
   3                 <listitem><para>Oplocks are the way that SMB clients get permission
   4                 from a server to locally cache file operations. If a server grants
   5                 an oplock (opportunistic lock) then the client is free to assume
   6                 that it is the only one accessing the file and it will aggressively
   7                 cache file data. With some oplock types the client may even cache
   8                 file open/close operations. This can give enormous performance benefits.
   9                 </para>
  10
  11                 <para>When you set <command moreinfo="none">fake oplocks = yes</command>, <ulink url="smbd.8.html"><command moreinfo="none">smbd(8)</command></ulink> will
  12                 always grant oplock requests no matter how many clients are using
  13                 the file.</para>
  14
  15                 <para>It is generally much better to use the real <link linkend="OPLOCKS"><parameter moreinfo="none">oplocks</parameter></link> support rather
  16                 than this parameter.</para>
  17
  18                 <para>If you enable this option on all read-only shares or
  19                 shares that you know will only be accessed from one client at a
  20                 time such as physically read-only media like CDROMs, you will see
  21                 a big performance improvement on many operations. If you enable
  22                 this option on shares where multiple clients may be accessing the
  23                 files read-write at the same time you can get data corruption. Use
  24                 this option carefully!</para>
  25
  26                 <para>Default: <command moreinfo="none">fake oplocks = no</command></para></listitem>
  27                 </samba:parameter>