Debian Codegraph @

upstream/opensuse-tumbleweed/man8/vfs_streams_xattr.8

raw
1 '\" t
2 .\" Title: vfs_streams_xattr
3 .\" Author: [see the "AUTHOR" section]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 05/26/2026
6 .\" Manual: System Administration tools
7 .\" Source: Samba 4.23.8-git.477.f78166bceedSUSE-oS16.9-x86_64
8 .\" Language: English
9 .\"
10 .TH "VFS_STREAMS_XATTR" "8" "05/26/2026" "Samba 4\&.23\&.8\-git\&.477\&.f78166bcee" "System Administration tools"
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"
31 vfs_streams_xattr \- Store alternate data streams in posix xattrs
32 .SH "SYNOPSIS"
33 .HP \w'\ 'u
34 vfs objects = streams_xattr
35 .SH "DESCRIPTION"
36 .PP
37 This VFS module is part of the
38 \fBsamba\fR(7)
39 suite\&.
40 .PP
41 The
42 vfs_streams_xattr
43 enables 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
44 streams_xattr:prefix, but be aware that this will also expose those ADS over the SMB extended attributes interface\&.
45 .PP
46 The file system that is shared with this module enabled must support xattrs\&.
47 .PP
48 Please 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\&.
49 .SH "OPTIONS"
50 .PP
51 streams_xattr:prefix = STRING
52 .RS 4
53 Name prefix used when storing an ADS in an xattr, defaults to
54 user\&.DosStream\&.\&. Changing this will also expose ADS over the SMB extended attributes interface\&.
55 .RE
56 .PP
57 streams_xattr:store_stream_type = [yes|no]
58 .RS 4
59 Whether the xattr names for Alternate Data Streams of type "$DATA" are suffixed by the stream type string ":$DATA"\&. The default is
60 yes\&.
61 .RE
62 .SH "EXAMPLES"
63 .sp
64 .if n \{\
65 .RS 4
66 .\}
67 .nf
68 \fI[share]\fR
69 \m[blue]\fBvfs objects = streams_xattr\fR\m[]
70 .fi
71 .if n \{\
72 .RE
73 .\}
74 .SH "AUTHOR"
75 .PP
76 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\&.