docs: Clarify description for cache, lock and state directory settings
[sfrench/samba-autobuild/.git] / docs-xml / smbdotconf / misc / cachedirectory.xml
1 <samba:parameter name="cache directory"
2                  context="G"
3                  type="string"
4                  constant="1"
5                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
6 <description>
7         <para>Usually, most of the TDB files are stored in the <parameter
8         moreinfo="none">lock directory</parameter>. Since Samba 3.4.0, it is
9         possible to differentiate between TDB files with persistent data and
10         TDB files with non-persistent data using the
11         <parameter moreinfo="none">state directory</parameter> and the
12         <parameter moreinfo="none">cache directory</parameter> options.
13         </para>
14
15         <para>This option specifies the directory for storing TDB
16         files containing non-persistent data that will be kept across
17         service restarts. The directory should be placed on persistent
18         storage, but the data can be safely deleted by an
19         administrator.
20         </para>
21 </description>
22
23 <value type="default">&pathconfig.CACHEDIR;</value>
24 <value type="example">/var/run/samba/locks/cache</value>
25 </samba:parameter>