Fix spelling s/opions/options/
[samba.git] / docs-xml / manpages / vfs_fruit.8.xml
index a00f6a9b9e04a2d581e85bb37872ce3a6ba1b457..25833038d96d69df78d518d41302e5b84b066aad 100644 (file)
@@ -7,7 +7,7 @@
        <manvolnum>8</manvolnum>
        <refmiscinfo class="source">Samba</refmiscinfo>
        <refmiscinfo class="manual">System Administration tools</refmiscinfo>
-       <refmiscinfo class="version">4.7</refmiscinfo>
+       <refmiscinfo class="version">&doc.version;</refmiscinfo>
 </refmeta>
 
 
@@ -71,7 +71,7 @@
        against Netatalk AFP sharing modes by setting
        <command>fruit:locking = netatalk</command>.</para>
 
-       <para>This module is not stackable other then described in
+       <para>This module is not stackable other than described in
        this manpage.</para>
 
 </refsect1>
@@ -97,7 +97,7 @@
                Mac relevant filesystem metadata (UNIX mode,
                FinderInfo, resource fork size and effective
                permission), as a result the Mac client doesn't need
-               to fetch this metadata individuallly per directory
+               to fetch this metadata individually per directory
                entry resulting in an often tremendous performance
                increase.</para></listitem>
 
              </itemizedlist>
 
              <para>There's a set of per share options that come into play when
-             <emphasis>fruit:aapl</emphasis> is enabled. These opions, listed
+             <emphasis>fruit:aapl</emphasis> is enabled. These options, listed
              below, can be used to disable the computation of specific Mac
              metadata in the directory enumeration context, all are enabled by
              default:</para>
              specific copychunk ioctl that requests a copy of a whole file
              along with all attached metadata.</para>
              <para>WARNING: the copyfile request is blocking the
-             client while the server does the copy.</para>.
+             client while the server does the copy.</para>
              <para>The default is <emphasis>no</emphasis>.</para>
            </listitem>
          </varlistentry>
 
+         <varlistentry>
+           <term>fruit:zero_file_id = yes | no</term>
+           <listitem>
+             <para>A <emphasis>global</emphasis> option whether to return
+             zero to queries of on-disk file identifier, if the client
+             has negotiated AAPL.</para>
+             <para>Mac applications and / or the Mac SMB
+             client code expect the on-disk file identifier to have the
+             semantics of HFS+ Catalog Node Identifier (CNID). Samba
+             doesn't provide those semantics, and that occasionally cause
+             usability issues or even data loss. Returning a file identifier
+             of zero causes the Mac client to stop using and trusting the
+             file id returned from the server.</para>
+             <para>The default is <emphasis>yes</emphasis>.</para>
+           </listitem>
+         </varlistentry>
+
+         <varlistentry>
+           <term>fruit:model = MacSamba</term>
+           <listitem>
+             <para>This option defines the model string inside the AAPL
+             extension and will determine the appearance of the icon representing the
+             Samba server in the Finder window.</para>
+             <para>The default is <emphasis>MacSamba</emphasis>.</para>
+           </listitem>
+         </varlistentry>
        </variablelist>
 </refsect1>
 
            </listitem>
          </varlistentry>
 
+         <varlistentry>
+           <term>fruit:time machine = [ yes | no ]</term>
+           <listitem>
+             <para>Controls if Time Machine support via the FULLSYNC volume
+             capability is advertised to clients.</para>
+
+             <itemizedlist>
+               <listitem><para><command>yes</command> - Enables Time Machine
+               support for this share. Also registers the share with mDNS in
+               case Samba is built with mDNS support.</para></listitem>
+
+               <listitem><para><command>no (default)</command> Disables
+               advertising Time Machine support.</para></listitem>
+
+             </itemizedlist>
+
+             <para>This option enforces the following settings per share (or
+             for all shares if enabled globally):</para>
+             <itemizedlist>
+               <listitem><para><command>durable handles = yes</command></para></listitem>
+               <listitem><para><command>kernel oplocks = no</command></para></listitem>
+               <listitem><para><command>kernel share modes = no</command></para></listitem>
+               <listitem><para><command>posix locking = no</command></para></listitem>
+             </itemizedlist>
+
+           </listitem>
+         </varlistentry>
+
+         <varlistentry>
+           <term>fruit:time machine max size = SIZE [K|M|G|T|P]</term>
+           <listitem>
+             <para>Useful for Time Machine: limits the reported disksize, thus
+             preventing Time Machine from using the whole real disk space for
+             backup. The option takes a number plus an optional unit.</para>
+             <para><emphasis>IMPORTANT</emphasis>: This is an approximated
+             calculation that only takes into account the contents of Time
+             Machine sparsebundle images. Therefor you <emphasis>MUST
+             NOT</emphasis> use this volume to store other content when using
+             this option, because it would NOT be accounted.</para>
+             <para>The calculation works by reading the band size from the
+             Info.plist XML file of the sparsebundle, reading the bands/
+             directory counting the number of band files, and then multiplying
+             one with the other.</para>
+           </listitem>
+         </varlistentry>
+
          <varlistentry>
            <term>fruit:metadata = [ stream | netatalk ]</term>
            <listitem>