1 .\" Extended attributes system calls manual pages
3 .\" Copyright (C) Andreas Gruenbacher, February 2001
4 .\" Copyright (C) Silicon Graphics Inc, September 2001
6 .\" %%%LICENSE_START(GPLv2+_doc_full)
7 .\" This is free documentation; you can redistribute it and/or
8 .\" modify it under the terms of the GNU General Public License as
9 .\" published by the Free Software Foundation; either version 2 of
10 .\" the License, or (at your option) any later version.
12 .\" The GNU General Public License's references to "object code"
13 .\" and "executables" are to be interpreted as the output of any
14 .\" document formatting or typesetting system, including
15 .\" intermediate and printed output.
17 .\" This manual is distributed in the hope that it will be useful,
18 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
19 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 .\" GNU General Public License for more details.
22 .\" You should have received a copy of the GNU General Public
23 .\" License along with this manual; if not, see
24 .\" <http://www.gnu.org/licenses/>.
27 .TH GETXATTR 2 2013-01-19 "Linux" "Linux Programmer's Manual"
29 getxattr, lgetxattr, fgetxattr \- retrieve an extended attribute value
33 .B #include <sys/types.h>
34 .B #include <attr/xattr.h>
36 .BI "ssize_t getxattr(const char\ *" path ", const char\ *" name ,
37 .BI " void\ *" value ", size_t " size );
38 .BI "ssize_t lgetxattr(const char\ *" path ", const char\ *" name ,
39 .BI " void\ *" value ", size_t " size );
40 .BI "ssize_t fgetxattr(int " fd ", const char\ *" name ,
41 .BI " void\ *" value ", size_t " size );
45 Extended attributes are
48 pairs associated with inodes (files, directories, symbolic links, etc.).
49 They are extensions to the normal attributes which are associated
50 with all inodes in the system (i.e., the
53 A complete overview of extended attributes concepts can be found in
59 of the extended attribute identified by
61 and associated with the given
64 The length of the attribute
71 except in the case of a symbolic link, where the link itself is
72 interrogated, not the file that it refers to.
77 only the open file referred to by
81 is interrogated in place of
86 is a simple null-terminated string.
87 The name includes a namespace prefix; there may be several, disjoint
88 namespaces associated with an individual inode.
89 The value of an extended attribute is a chunk of arbitrary textual or
90 binary data of specified length.
94 zero can be passed into these calls to return the current size of the
95 named extended attribute, which can be used to estimate the size of a
96 buffer which is sufficiently large to hold the value associated with
97 the extended attribute.
99 The interface is designed to allow guessing of initial buffer
100 sizes, and to enlarge buffers when the return value indicates
101 that the buffer provided was too small.
103 On success, a positive number is returned indicating the size of the
104 extended attribute value.
105 On failure, \-1 is returned and
107 is set appropriately.
111 The named attribute does not exist, or the process has no access to
114 is defined to be a synonym for
117 .IR <attr/xattr.h> .)
120 Extended attributes are not supported by the file system, or are disabled.
127 buffer is too small to hold the result.
129 In addition, the errors documented in
133 These system calls have been available on Linux since kernel 2.4;
134 glibc support is provided since version 2.3.
136 These system calls are Linux-specific.
138 .\" Andreas Gruenbacher,
139 .\" .RI < a.gruenbacher@computer.org >
140 .\" and the SGI XFS development team,
141 .\" .RI < linux-xfs@oss.sgi.com >.
142 .\" Please send any bug reports or comments to these addresses.