Moving docs tree to docs-xml to make room for generated docs in the release tarball.
[ira/wip.git] / docs-xml / smbdotconf / misc / dmapisupport.xml
1 <samba:parameter name="dmapi support"
2                  context="S"
3                                  type="boolean"
4                  advanced="1" developer="1"
5                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
6 <description>
7         <para>This parameter specifies whether Samba should use DMAPI to
8         determine whether a file is offline or not. This would typically
9         be used in conjunction with a hierarchical storage system that
10         automatically migrates files to tape.
11         </para>
12
13         <para>Note that Samba infers the status of a file by examining the
14         events that a DMAPI application has registered interest in. This
15         heuristic is satisfactory for a number of hierarchical storage
16         systems, but there may be system for which it will fail. In this
17         case, Samba may erroneously report files to be offline.
18         </para>
19
20         <para>This parameter is only available if a supported DMAPI
21         implementation was found at compilation time. It will only be used
22         if DMAPI is found to enabled on the system at run time.
23         </para>
24
25         <para>
26         </para>
27 </description>
28 <value type="default">no</value>
29 </samba:parameter>