Next update of VFS modules development guide
[sfrench/samba-autobuild/.git] / docs-xml / smbdotconf / locking / locking.xml
1 <samba:parameter name="locking"
2                                  type="boolean"
3                  context="S"
4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
5 <description>
6         <para>This controls whether or not locking will be 
7         performed by the server in response to lock requests from the 
8         client.</para>
9
10         <para>If <command moreinfo="none">locking = no</command>, all lock and unlock 
11         requests will appear to succeed and all lock queries will report 
12         that the file in question is available for locking.</para>
13
14         <para>If <command moreinfo="none">locking = yes</command>, real locking will be performed 
15         by the server.</para>
16
17         <para>This option <emphasis>may</emphasis> be useful for read-only 
18         filesystems which <emphasis>may</emphasis> not need locking (such as 
19         CDROM drives), although setting this parameter of <constant>no</constant> 
20         is not really recommended even in this case.</para>
21
22         <para>Be careful about disabling locking either globally or in a 
23         specific service, as lack of locking may result in data corruption. 
24         You should never need to set this parameter.</para>
25 </description>
26
27 <value type="boolean">yes</value>
28 </samba:parameter>