docs-xml/smbdotconf/locking/fakeoplocks.xml

   1 <samba:parameter name="fake oplocks"
   2                                  type="boolean"
   3                  context="S"
   4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
   5 <description>
   6         <para>Oplocks are the way that SMB clients get permission
   7         from a server to locally cache file operations. If a server grants
   8         an oplock (opportunistic lock) then the client is free to assume
   9         that it is the only one accessing the file and it will aggressively
  10         cache file data. With some oplock types the client may even cache
  11         file open/close operations. This can give enormous performance benefits.
  12         </para>
  13
  14         <para>When you set <command moreinfo="none">fake oplocks = yes</command>, <citerefentry>
  15         <refentrytitle>smbd</refentrytitle><manvolnum>8</manvolnum></citerefentry> will
  16         always grant oplock requests no matter how many clients are using the file.</para>
  17
  18         <para>It is generally much better to use the real <smbconfoption name="oplocks"/> 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 </description>
  29 <value type="default">no</value>
  30 </samba:parameter>