From: Ralph Boehme Date: Mon, 23 Jun 2014 15:01:30 +0000 (+0200) Subject: vfs_fruit: add manpage X-Git-Url: http://git.samba.org/?a=commitdiff_plain;h=e4a696b51b73b398246e090b07fd560d2bbd65dd;p=obnox%2Fsamba%2Fsamba-obnox.git vfs_fruit: add manpage Signed-off-by: Ralph Boehme Reviewed-by: Jeremy Allison Reviewed-by: Volker Lendecke --- diff --git a/docs-xml/manpages/vfs_fruit.8.xml b/docs-xml/manpages/vfs_fruit.8.xml new file mode 100644 index 00000000000..500fbec8b4d --- /dev/null +++ b/docs-xml/manpages/vfs_fruit.8.xml @@ -0,0 +1,183 @@ + + + + + + vfs_fruit + 8 + Samba + System Administration tools + 4.1 + + + + + vfs_fruit + Enhanced OS X and Netatalk interoperability + + + + + vfs objects = fruit + + + + + DESCRIPTION + + This VFS module is part of the + samba + 7 suite. + + The vfs_fruit module provides + enhanced compatibility with Apple SMB clients and + interoperability with a Netatalk 3 AFP fileserver. + + The module should be stacked with + vfs_catia if enabling character conversion and + must be stacked with vfs_streams_xattr, see the + example section for the correct config. + + The module enables alternate data streams (ADS) support + for a share, intercepts the OS X special streams "AFP_AfpInfo" + and "AFP_Resource" and handles them in a special way. All + other named streams are deferred to + vfs_streams_xattr which must be loaded + together with vfs_fruit. + + Having shares with ADS support enabled for OS X client + is worthwhile because it resembles the behaviour of Apple's + own SMB server implementation and it avoids certain severe + performance degradations caused by Samba's case sensitivity + semantics. + + The OS X metadata and resource fork stream can be stored + in a way compatible with Netatalk 3 by setting + fruit:resource = file and + fruit:metadata = netatalk. + + OS X maps NTFS illegal characters to the Unicode private + range in SMB requests. By setting fruit:encoding = + native, all mapped characters are converted to + native ASCII characters. + + Finally, share access modes are optionally checked + against Netatalk AFP sharing modes by setting + fruit:locking = netatalk. + + This module is not stackable other then described in + this manpage. + + + + + OPTIONS + + + + + fruit:resource = [ file | xattr | stream ] + + Controls where the OS X resource fork is stored: + + + file (default) - use a ._ + AppleDouble file compatible with OS X and + Netatalk + + xattr - use a + xattr, requires a filesystem with large xattr support + and a file IO API compatible with xattrs, this boils + down to Solaris and derived platforms and + ZFS + + stream - pass the + stream on to the next module in the VFS + stack + + + + + + + fruit:metadata = [ stream | netatalk ] + + Controls where the OS X metadata stream is stored: + + + netatalk (default) - use + Netatalk compatible xattr + + stream - pass the + stream on to the next module in the VFS + stack + + + + + + + fruit:locking = [ netatalk | none ] + + + + none (default) - no + cross protocol locking + + netatalk - use + cross protocol locking with Netatalk + + + + + + + fruit:encoding = [ native | private ] + + + Controls how the set of illegal NTFS ASCII + character, commonly used by OS X clients, are stored in + the filesystem: + + + + private (default) - + store characters as encoded by the OS X client: mapped + to the Unicode private range + + native - store + characters with their native ASCII + value + + + + + + + + + + EXAMPLES + + + + catia fruit streams_xattr + file + netatalk + netatalk + native + + + + + + AUTHOR + + The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed. + + + + diff --git a/docs-xml/wscript_build b/docs-xml/wscript_build index 42c9a85696a..e7c8931ddad 100644 --- a/docs-xml/wscript_build +++ b/docs-xml/wscript_build @@ -60,6 +60,7 @@ manpages=''' manpages/vfs_extd_audit.8 manpages/vfs_fake_perms.8 manpages/vfs_fileid.8 + manpages/vfs_fruit.8 manpages/vfs_full_audit.8 manpages/vfs_gpfs.8 manpages/vfs_linux_xfs_sgid.8