OSDN Git Service

LDP: Update original to LDP v3.79
[linuxjm/LDP_man-pages.git] / original / man2 / getxattr.2
index 86dfc89..570b9f1 100644 (file)
@@ -1,9 +1,7 @@
-.\"
-.\" Extended attributes system calls manual pages
-.\"
 .\" Copyright (C) Andreas Gruenbacher, February 2001
 .\" Copyright (C) Silicon Graphics Inc, September 2001
 .\"
+.\" %%%LICENSE_START(GPLv2+_DOC_FULL)
 .\" This is free documentation; you can redistribute it and/or
 .\" modify it under the terms of the GNU General Public License as
 .\" published by the Free Software Foundation; either version 2 of
 .\" GNU General Public License for more details.
 .\"
 .\" You should have received a copy of the GNU General Public
-.\" License along with this manual; if not, write to the Free
-.\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
-.\" USA.
+.\" License along with this manual; if not, see
+.\" <http://www.gnu.org/licenses/>.
+.\" %%%LICENSE_END
 .\"
-.TH GETXATTR 2 2001-12-01 "Linux" "Linux Programmer's Manual"
+.TH GETXATTR 2 2014-04-06 "Linux" "Linux Programmer's Manual"
 .SH NAME
 getxattr, lgetxattr, fgetxattr \- retrieve an extended attribute value
 .SH SYNOPSIS
 .fam C
 .nf
 .B #include <sys/types.h>
-.B #include <attr/xattr.h>
+.B #include <sys/xattr.h>
 .sp
 .BI "ssize_t getxattr(const char\ *" path ", const char\ *" name ,
 .BI "                 void\ *" value ", size_t " size );
@@ -60,7 +58,7 @@ of the extended attribute identified by
 .I name
 and associated with the given
 .I path
-in the file system.
+in the filesystem.
 The length of the attribute
 .I value
 is returned.
@@ -100,39 +98,39 @@ The interface is designed to allow guessing of initial buffer
 sizes, and to enlarge buffers when the return value indicates
 that the buffer provided was too small.
 .SH RETURN VALUE
-On success, a positive number is returned indicating the size of the
+On success, a nonnegative number is returned indicating the size of the
 extended attribute value.
 On failure, \-1 is returned and
 .I errno
 is set appropriately.
-.PP
-If the named attribute does not exist, or the process has no access to
-this attribute,
-.I errno
-is set to
-.BR ENOATTR .
-.PP
-If the
+.SH ERRORS
+.TP
+.B ENOATTR
+The named attribute does not exist, or the process has no access to
+this attribute.
+.RB ( ENOATTR
+is defined to be a synonym for
+.BR ENODATA
+in
+.IR <attr/xattr.h> .)
+.TP
+.B ENOTSUP
+Extended attributes are not supported by the filesystem, or are disabled.
+.TP
+.B ERANGE
+The
 .I size
 of the
 .I value
-buffer is too small to hold the result,
-.I errno
-is set to
-.BR ERANGE .
-.PP
-If extended attributes are not supported by the file system, or are disabled,
-.I errno
-is set to
-.BR ENOTSUP .
+buffer is too small to hold the result.
 .PP
-The errors documented for the
+In addition, the errors documented in
 .BR stat (2)
-system call are also applicable here.
+can also occur.
 .SH VERSIONS
 These system calls have been available on Linux since kernel 2.4;
 glibc support is provided since version 2.3.
-.SH "CONFORMING TO"
+.SH CONFORMING TO
 These system calls are Linux-specific.
 .\" .SH AUTHORS
 .\" Andreas Gruenbacher,
@@ -150,3 +148,12 @@ These system calls are Linux-specific.
 .BR stat (2),
 .BR attr (5),
 .BR symlink (7)
+.SH COLOPHON
+This page is part of release 3.79 of the Linux
+.I man-pages
+project.
+A description of the project,
+information about reporting bugs,
+and the latest version of this page,
+can be found at
+\%http://www.kernel.org/doc/man\-pages/.