docs/docbook/smbdotconf/locking/fakeoplocks.xml

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