1 .\" Copyright (C) Andreas Gruenbacher, February 2001
2 .\" Copyright (C) Silicon Graphics Inc, September 2001
4 .\" %%%LICENSE_START(GPLv2+_DOC_FULL)
5 .\" This is free documentation; you can redistribute it and/or
6 .\" modify it under the terms of the GNU General Public License as
7 .\" published by the Free Software Foundation; either version 2 of
8 .\" the License, or (at your option) any later version.
10 .\" The GNU General Public License's references to "object code"
11 .\" and "executables" are to be interpreted as the output of any
12 .\" document formatting or typesetting system, including
13 .\" intermediate and printed output.
15 .\" This manual is distributed in the hope that it will be useful,
16 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
17 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 .\" GNU General Public License for more details.
20 .\" You should have received a copy of the GNU General Public
21 .\" License along with this manual; if not, see
22 .\" <http://www.gnu.org/licenses/>.
25 .TH SETXATTR 2 2013-01-19 "Linux" "Linux Programmer's Manual"
27 setxattr, lsetxattr, fsetxattr \- set an extended attribute value
31 .B #include <sys/types.h>
32 .B #include <attr/xattr.h>
34 .BI "int setxattr(const char\ *" path ", const char\ *" name ,
35 .BI " const void\ *" value ", size_t " size ", int " flags );
36 .BI "int lsetxattr(const char\ *" path ", const char\ *" name ,
37 .BI " const void\ *" value ", size_t " size ", int " flags );
38 .BI "int fsetxattr(int " fd ", const char\ *" name ,
39 .BI " const void\ *" value ", size_t " size ", int " flags );
43 Extended attributes are
46 pairs associated with inodes (files, directories, symbolic links, etc.).
47 They are extensions to the normal attributes which are associated
48 with all inodes in the system (i.e., the
51 A complete overview of extended attributes concepts can be found in
57 of the extended attribute identified by
59 and associated with the given
71 except in the case of a symbolic link, where the extended attribute is
72 set on the link itself, not the file that it refers to.
77 only the extended attribute is set on the open file referred to by
84 An extended attribute name is a simple null-terminated string.
87 includes a namespace prefix; there may be several, disjoint
88 namespaces associated with an individual inode.
91 of an extended attribute is a chunk of arbitrary textual or
92 binary data of specified length.
96 argument can be used to refine the semantics of the operation.
98 specifies a pure create, which fails if the named
99 attribute exists already.
101 specifies a pure replace operation, which fails if the
102 named attribute does not already exist.
103 By default (no flags), the extended attribute will be created if
104 need be, or will simply replace the value if the attribute exists.
106 On success, zero is returned.
107 On failure, \-1 is returned and
109 is set appropriately.
113 Disk quota limits meant that
114 there is insufficient space remaining to store the extended attribute.
118 was specified, and the attribute exists already.
122 was specified, and the attribute does not exist.
124 is defined to be a synonym for
127 .IR <attr/xattr.h> .)
130 There is insufficient space remaining to store the extended attribute.
133 Extended attributes are not supported by the filesystem, or are disabled,
138 In addition, the errors documented in
142 These system calls have been available on Linux since kernel 2.4;
143 glibc support is provided since version 2.3.
145 These system calls are Linux-specific.
147 .\" Andreas Gruenbacher,
148 .\" .RI < a.gruenbacher@computer.org >
149 .\" and the SGI XFS development team,
150 .\" .RI < linux-xfs@oss.sgi.com >.
151 .\" Please send any bug reports or comments to these addresses.