source: vendor/current/docs/manpages/vfs_streams_xattr.8

Last change on this file was 989, checked in by Silvan Scherrer, 9 years ago

Samba Server: update vendor to version 4.4.7

File size: 3.2 KB
RevLine 
[860]1'\" t
2.\" Title: vfs_streams_xattr
3.\" Author: [see the "AUTHOR" section]
[988]4.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
[989]5.\" Date: 10/25/2016
[860]6.\" Manual: System Administration tools
[988]7.\" Source: Samba 4.4
[860]8.\" Language: English
9.\"
[989]10.TH "VFS_STREAMS_XATTR" "8" "10/25/2016" "Samba 4\&.4" "System Administration tools"
[860]11.\" -----------------------------------------------------------------
12.\" * Define some portability stuff
13.\" -----------------------------------------------------------------
14.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15.\" http://bugs.debian.org/507673
16.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18.ie \n(.g .ds Aq \(aq
19.el .ds Aq '
20.\" -----------------------------------------------------------------
21.\" * set default formatting
22.\" -----------------------------------------------------------------
23.\" disable hyphenation
24.nh
25.\" disable justification (adjust text to left margin only)
26.ad l
27.\" -----------------------------------------------------------------
28.\" * MAIN CONTENT STARTS HERE *
29.\" -----------------------------------------------------------------
30.SH "NAME"
31vfs_streams_xattr \- Store alternate data streams in posix xattrs
32.SH "SYNOPSIS"
33.HP \w'\ 'u
34vfs objects = streams_xattr
35.SH "DESCRIPTION"
36.PP
37This VFS module is part of the
38\fBsamba\fR(7)
39suite\&.
40.PP
41The
42vfs_streams_xattr
[988]43enables storing of NTFS alternate data streams in the file system\&. As a normal posix file system does not support the concept of multiple data streams per file, the streams_xattr module stores the data in posix extended attributes (xattrs)\&. The name of these attributes by default is user\&.DosStream\&."ADS\-NAME"\&. The prefix "user\&.DosStream\&." can be changed with the module option
44streams_xattr:prefix, but be aware that this will also expose those ADS over the SMB extended attributes interface\&.
[860]45.PP
46The file system that is shared with this module enabled must support xattrs\&.
47.PP
48Please note that most file systems have severe limitations on the size of xattrs\&. So this module might work for applications like IE that stores small zone information in streams but will fail for applications that store serious amounts of data in ADSs\&.
[988]49.PP
50CAUTION: Make sure to set "kernel oplocks = no" in smb\&.conf if if you use this module because this combination is currently broken\&. See Bug 7537 for details\&.
51.SH "OPTIONS"
52.PP
53streams_xattr:prefix = STRING
54.RS 4
55Name prefix used when storing an ADS in an xattr, defaults to
56user\&.DosStream\&.\&. Changing this will also expose ADS over the SMB extended attributes interface\&.
57.RE
58.PP
59streams_xattr:store_stream_type = [yes|no]
60.RS 4
61Whether the xattr names for Alternate Data Streams of type "$DATA" are suffixed by the stream type string ":$DATA"\&. The default is
62yes\&.
63.RE
[860]64.SH "EXAMPLES"
65.sp
66.if n \{\
67.RS 4
68.\}
69.nf
70 \fI[share]\fR
71 \m[blue]\fBvfs objects = streams_xattr\fR\m[]
72.fi
73.if n \{\
74.RE
75.\}
76.SH "AUTHOR"
77.PP
78The 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\&.
Note: See TracBrowser for help on using the repository browser.