summaryrefslogtreecommitdiff
path: root/docs-xml/smbdotconf
diff options
context:
space:
mode:
authorKarolin Seeger <kseeger@samba.org>2009-11-30 11:04:50 +0100
committerKarolin Seeger <kseeger@samba.org>2009-11-30 11:04:50 +0100
commit0003b5fad1dee687bc15dfad9f71b6dfc40556d7 (patch)
tree4c86a530eb6aef07cb00f46562c76cf2c3034ba3 /docs-xml/smbdotconf
parentb4bce76776714815874f78dbe1184072d3943741 (diff)
downloadsamba-0003b5fad1dee687bc15dfad9f71b6dfc40556d7.tar.gz
samba-0003b5fad1dee687bc15dfad9f71b6dfc40556d7.tar.bz2
samba-0003b5fad1dee687bc15dfad9f71b6dfc40556d7.zip
s3:docs: Document "cache directory" and "state directory".
Part of a fix for bug #6890 (Some smb.conf parameters are undocumented). Karolin
Diffstat (limited to 'docs-xml/smbdotconf')
-rw-r--r--docs-xml/smbdotconf/misc/cachedirectory.xml22
-rw-r--r--docs-xml/smbdotconf/misc/statedirectory.xml22
2 files changed, 44 insertions, 0 deletions
diff --git a/docs-xml/smbdotconf/misc/cachedirectory.xml b/docs-xml/smbdotconf/misc/cachedirectory.xml
new file mode 100644
index 0000000000..5216998ae4
--- /dev/null
+++ b/docs-xml/smbdotconf/misc/cachedirectory.xml
@@ -0,0 +1,22 @@
+<samba:parameter name="cache directory"
+ context="G"
+ advanced="1" developer="1"
+ type="string"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>Usually, most of the TDB files are stored in the <parameter
+ moreinfo="none">lock directory</parameter>. Since Samba 3.4.0, it is
+ possible to differentiate between TDB files with persistent data and
+ TDB files with non-persistent data using the
+ <parameter moreinfo="none">state directory</parameter> and the
+ <parameter moreinfo="none">cache directory</parameter> options.
+ </para>
+
+ <para> This option specifies the directory where TDB files containing
+ non-persistent data will be stored.
+ </para>
+</description>
+
+<value type="default">${prefix}/var/locks</value>
+<value type="example">/var/run/samba/locks/cache</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/misc/statedirectory.xml b/docs-xml/smbdotconf/misc/statedirectory.xml
new file mode 100644
index 0000000000..f8cfcdfb1a
--- /dev/null
+++ b/docs-xml/smbdotconf/misc/statedirectory.xml
@@ -0,0 +1,22 @@
+<samba:parameter name="state directory"
+ context="G"
+ advanced="1" developer="1"
+ type="string"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>Usually, most of the TDB files are stored in the
+ <parameter moreinfo="none">lock directory</parameter>. Since
+ Samba 3.4.0, it is possible to differentiate between TDB files
+ with persistent data and TDB files with non-persistent data using
+ the <parameter moreinfo="none">state directory</parameter> and the
+ <parameter moreinfo="none">cache directory</parameter> options.
+ </para>
+
+ <para> This option specifies the directory where TDB files containing
+ persistent data will be stored.
+ </para>
+</description>
+
+<value type="default">${prefix}/var/locks</value>
+<value type="example">/var/run/samba/locks/state</value>
+</samba:parameter>