Document the "fam change notify" and "dmapi support" parameters.
authorJames Peach <jpeach@samba.org>
Thu, 20 Apr 2006 03:15:20 +0000 (03:15 +0000)
committerGerald W. Carter <jerry@samba.org>
Wed, 23 Apr 2008 13:47:18 +0000 (08:47 -0500)
(This used to be commit 2b7935a1a76fd0b300295a89bec89862094c5dc5)

docs/smbdotconf/misc/dmapisupport.xml [new file with mode: 0644]
docs/smbdotconf/misc/famchangenotify.xml [new file with mode: 0644]

diff --git a/docs/smbdotconf/misc/dmapisupport.xml b/docs/smbdotconf/misc/dmapisupport.xml
new file mode 100644 (file)
index 0000000..fbd145d
--- /dev/null
@@ -0,0 +1,29 @@
+<samba:parameter name="dmapi support"
+                 context="S"
+                                type="boolean"
+                 advanced="1" developer="1"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+       <para>This parameter specifies whether Samba should use DMAPI to
+       determine whether a file is offline or not. This would typically
+       be used in conjunction with a hierarchical storage system that
+       automatically migrates files to tape.
+       </para>
+
+       <para>Note that Samba infers the status of a file by examining the
+       events that a DMAPI application has registered interest in. This
+       heuristic is satisfactory for a number of hierarchical storage
+       systems, but there may be system for which it will fail. In this
+       case, Samba may erroneously report files to be offline.
+       </para>
+
+       <para>This parameter is only available if a supported DMAPI
+       implementation was found at compilation time. It will only be used
+       if DMAPI is found to enabled on the system at run time.
+       </para>
+
+       <para>
+       </para>
+</description>
+<value type="default">no</value>
+</samba:parameter>
diff --git a/docs/smbdotconf/misc/famchangenotify.xml b/docs/smbdotconf/misc/famchangenotify.xml
new file mode 100644 (file)
index 0000000..353b06b
--- /dev/null
@@ -0,0 +1,20 @@
+<samba:parameter name="fam change notify"
+                 context="G"
+                                type="boolean"
+                 advanced="1" developer="1"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+       <para>This parameter specifies whether Samba should ask the 
+       FAM daemon change notifications in directories so that
+       SMB clients can refresh whenever the data on the server changes.
+       </para>
+
+       <para>This parameter is only used when your system supports 
+       change notification to user programs, using the FAM daemon. If the FAM
+       daemon is not running, this parameter is automatically disabled. The
+       <parameter moreinfo=none>kernel change notify</parameter>
+       parameter will take precedence if it is also enabled.
+       </para>
+</description>
+<value type="default">yes</value>
+</samba:parameter>