xnu-2782.30.5.tar.gz

[apple/xnu.git] / bsd / man / man2 / setxattr.2

diff --git a/bsd/man/man2/setxattr.2 b/bsd/man/man2/setxattr.2
index ea5a97649957917b3dfdd6b817dffe18425f6da4..3d5f3c5e6408c4f5e521617edae20fb100e8de87 100644 (file)
--- a/bsd/man/man2/setxattr.2
+++ b/bsd/man/man2/setxattr.2
@@ -1,31 +1,24 @@
 .\"
 .\" Copyright (c) 2004 Apple Computer, Inc. All rights reserved.
 .\"
 .\"
 .\" Copyright (c) 2004 Apple Computer, Inc. All rights reserved.
 .\"

-.\" @APPLE_LICENSE_OSREFERENCE_HEADER_START@
-.\" 
-.\" This file contains Original Code and/or Modifications of Original Code 
-.\" as defined in and that are subject to the Apple Public Source License 
-.\" Version 2.0 (the "License"). You may not use this file except in 
-.\" compliance with the License.  The rights granted to you under the 
-.\" License may not be used to create, or enable the creation or 
-.\" redistribution of, unlawful or unlicensed copies of an Apple operating 
-.\" system, or to circumvent, violate, or enable the circumvention or 
-.\" violation of, any terms of an Apple operating system software license 
-.\" agreement.
+.\" @APPLE_LICENSE_HEADER_START@

 .\"
 .\"

-.\" Please obtain a copy of the License at 
-.\" http://www.opensource.apple.com/apsl/ and read it before using this 
+.\" This file contains Original Code and/or Modifications of Original Code
+.\" as defined in and that are subject to the Apple Public Source License
+.\" Version 2.0 (the 'License'). You may not use this file except in
+.\" compliance with the License. Please obtain a copy of the License at
+.\" http://www.opensource.apple.com/apsl/ and read it before using this

 .\" file.
 .\"
 .\" file.
 .\"

-.\" The Original Code and all software distributed under the License are 
-.\" distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER 
-.\" EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 
-.\" INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 
-.\" FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 
-.\" Please see the License for the specific language governing rights and 
+.\" The Original Code and all software distributed under the License are
+.\" distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+.\" EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
+.\" INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
+.\" FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+.\" Please see the License for the specific language governing rights and

 .\" limitations under the License.
 .\"
 .\" limitations under the License.
 .\"

-.\" @APPLE_LICENSE_OSREFERENCE_HEADER_END@
+.\" @APPLE_LICENSE_HEADER_END@

 .\"
 .Dd Oct 19, 2004
 .Dt SETXATTR 2
 .\"
 .Dd Oct 19, 2004
 .Dt SETXATTR 2


@@ -98,6 +91,26 @@ is identical to
 except that it sets an extended attribute on an open file referenced by
 file descriptor
 .Fa fd .
 except that it sets an extended attribute on an open file referenced by
 file descriptor
 .Fa fd .

+.Sh NOTES
+On some filesystems, such as
+.Dv HFS+ ,
+setting the extended attribute
+.Dv com.apple.ResourceFork
+will update the modification time (``mtime'') of
+the file.
+.Pp
+Due to historical reasons, the
+.Dv XATTR_FINDERINFO_NAME
+(defined to be 
+.Dq com.apple.FinderInfo )
+extended attribute must be 32 bytes; see the
+.Dv ATTR_CMN_FNDRINFO
+section in
+.Xr getattrlist 2 .
+.Pp
+The maximum supported size of extended attribute can be found out using 
+.Xr pathconf 2 
+with _PC_XATTR_SIZE_BITS option.  

 .Sh RETURN VALUES
 On success, 0 is returned.  On failure, -1 is returned and the global
 variable
 .Sh RETURN VALUES
 On success, 0 is returned.  On failure, -1 is returned and the global
 variable


@@ -173,8 +186,9 @@ Not enough space left on the file system.
 .El
 .Sh SEE ALSO
 .Xr getxattr 2 ,
 .El
 .Sh SEE ALSO
 .Xr getxattr 2 ,

+.Xr listxattr 2 ,

 .Xr removexattr 2 ,
 .Xr removexattr 2 ,

-.Xr listxattr 2
+.Xr pathconf 2

 .Sh HISTORY
 .Fn setxattr
 and
 .Sh HISTORY
 .Fn setxattr
 and