1VFS_FRUIT(8) System Administration tools VFS_FRUIT(8)
2
6 vfs_fruit - Enhanced OS X and Netatalk interoperability
7
9 vfs objects = fruit
10
12 This VFS module is part of the samba(7) suite.
13 The vfs_fruit module provides enhanced compatibility with Apple SMB
15 clients and interoperability with a Netatalk 3 AFP fileserver.
16 The module should be stacked with vfs_catia if enabling character
18 conversion and must be stacked with vfs_streams_xattr, see the example
19 section for the correct config.
20 The module enables alternate data streams (ADS) support for a share,
22 intercepts the OS X special streams "AFP_AfpInfo" and "AFP_Resource"
23 and handles them in a special way. All other named streams are deferred
24 to vfs_streams_xattr which must be loaded together with vfs_fruit.
25 Having shares with ADS support enabled for OS X client is worthwhile
27 because it resembles the behaviour of Apple´s own SMB server
28 implementation and it avoids certain severe performance degradations
29 caused by Samba´s case sensitivity semantics.
30 The OS X metadata and resource fork stream can be stored in a way
32 compatible with Netatalk 3 by setting fruit:resource = file and
33 fruit:metadata = netatalk.
34 OS X maps NTFS illegal characters to the Unicode private range in SMB
36 requests. By setting fruit:encoding = native, all mapped characters are
37 converted to native ASCII characters.
38 Finally, share access modes are optionally checked against Netatalk AFP
40 sharing modes by setting fruit:locking = netatalk.
41 This module is not stackable other then described in this manpage.
43
45 fruit:resource = [ file | xattr | stream ]
46 Controls where the OS X resource fork is stored:
47 · file (default) - use a ._ AppleDouble file compatible with OS X
49 and Netatalk
50 · xattr - use a xattr, requires a filesystem with large xattr
52 support and a file IO API compatible with xattrs, this boils
53 down to Solaris and derived platforms and ZFS
54 · stream - pass the stream on to the next module in the VFS stack
56 fruit:metadata = [ stream | netatalk ]
59 Controls where the OS X metadata stream is stored:
60 · netatalk (default) - use Netatalk compatible xattr
62 · stream - pass the stream on to the next module in the VFS stack
64 fruit:locking = [ netatalk | none ]
67 · none (default) - no cross protocol locking
70 · netatalk - use cross protocol locking with Netatalk
72 fruit:encoding = [ native | private ]
75 Controls how the set of illegal NTFS ASCII character, commonly used
76 by OS X clients, are stored in the filesystem:
77 · private (default) - store characters as encoded by the OS X
79 client: mapped to the Unicode private range
80 · native - store characters with their native ASCII value
82 fruit:aapl = yes | no
85 A global option whether to enable Apple´s SMB2+ extension codenamed
86 AAPL. Default yes. This extension enhances several deficiencies
87 when connecting from Macs:
88 · directory enumeration is enriched with Mac relevant filesystem
90 metadata (UNIX mode, FinderInfo, resource fork size and
91 effective permission), as a result the Mac client doesn´t need
92 to fetch this metadata individuallly per directory entry
93 resulting in an often tremendous performance increase.
94 · The ability to query and modify the UNIX mode of directory
96 entries.
97 There´s a set of per share options that can be used to disable the
99 computation of specific Mac metadata in the directory enumeration
100 context, all are enabled by default:
101 · readdir_attr:aapl_rsize = true | false
103 · readdir_attr:aapl_finder_info = true | false
105 · readdir_attr:aapl_max_access = true | false
107 fruit:nfs_aces = yes | no
110 Whether support for querying and modifying the UNIX mode of
111 directory entries via NFS ACEs is enabled, default yes.
112 fruit:veto_appledouble = yes | no
114 Whether ._ AppleDouble files are vetoed which prevents the client
115 from seing and accessing internal AppleDouble files created by
116 vfs_fruit itself for the purpose of storing a Mac resource fork.
117 Vetoing ._ files may break some applications, eg extracting Mac ZIP
119 archives from Mac clients failes, because they contain ._ files.
120 Setting this option to false will fix this, but the abstraction
121 leak of exposing the internally created ._ files may have other
122 unknown side effects.
123 The default is yes.
125 fruit:copyfile = yes | no
127 Whether to enable OS X specific copychunk ioctl that requests a
128 copy of a whole file along with all attached metadata.
129 WARNING: the copyfile request is blocking the client while the
131 server does the copy.
132 . The default is no.
134
136 [share]
137 vfs objects = catia fruit streams_xattr
138 fruit:resource = file
139 fruit:metadata = netatalk
140 fruit:locking = netatalk
141 fruit:encoding = native
142
144 The original Samba software and related utilities were created by
145 Andrew Tridgell. Samba is now developed by the Samba Team as an Open
146 Source project similar to the way the Linux kernel is developed.
147Samba 4.2 06/19/2018 VFS_FRUIT(8)