original/man2/removexattr.2

   1 .\"
   2 .\" Extended attributes system calls manual pages
   3 .\"
   4 .\" Copyright (C) Andreas Gruenbacher, February 2001
   5 .\" Copyright (C) Silicon Graphics Inc, September 2001
   6 .\"
   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.
  11 .\"
  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.
  16 .\"
  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.
  21 .\"
  22 .\" You should have received a copy of the GNU General Public
  23 .\" License along with this manual; if not, write to the Free
  24 .\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
  25 .\" USA.
  26 .\"
  27 .TH REMOVEXATTR 2 2001-12-01 "Linux" "Linux Programmer's Manual"
  28 .SH NAME
  29 removexattr, lremovexattr, fremovexattr \- remove an extended attribute
  30 .SH SYNOPSIS
  31 .fam C
  32 .nf
  33 .B #include <sys/types.h>
  34 .B #include <attr/xattr.h>
  35 .sp
  36 .BI "int removexattr(const char\ *" path ", const char\ *" name );
  37 .BI "int lremovexattr(const char\ *" path ", const char\ *" name );
  38 .BI "int fremovexattr(int " fd ", const char\ *" name );
  39 .fi
  40 .fam T
  41 .SH DESCRIPTION
  42 Extended attributes are
  43 .IR name :\c
  44 value pairs associated with inodes (files, directories, symbolic links, etc.).
  45 They are extensions to the normal attributes which are associated
  46 with all inodes in the system (i.e., the
  47 .BR stat (2)
  48 data).
  49 A complete overview of extended attributes concepts can be found in
  50 .BR attr (5).
  51 .PP
  52 .BR removexattr ()
  53 removes the extended attribute identified by
  54 .I name
  55 and associated with the given
  56 .I path
  57 in the file system.
  58 .PP
  59 .BR lremovexattr ()
  60 is identical to
  61 .BR removexattr (),
  62 except in the case of a symbolic link, where the extended attribute is
  63 removed from the link itself, not the file that it refers to.
  64 .PP
  65 .BR fremovexattr ()
  66 is identical to
  67 .BR removexattr (),
  68 only the extended attribute is removed from the open file referred to by
  69 .I fd
  70 (as returned by
  71 .BR open (2))
  72 in place of
  73 .IR path .
  74 .PP
  75 An extended attribute name is a simple null-terminated string.
  76 The
  77 .I name
  78 includes a namespace prefix; there may be several, disjoint
  79 namespaces associated with an individual inode.
  80 .SH RETURN VALUE
  81 On success, zero is returned.
  82 On failure, \-1 is returned and
  83 .I errno
  84 is set appropriately.
  85 .PP
  86 If the named attribute does not exist,
  87 .I errno
  88 is set to
  89 .BR ENOATTR .
  90 .PP
  91 If extended attributes are not supported by the file system, or are disabled,
  92 .I errno
  93 is set to
  94 .BR ENOTSUP .
  95 .PP
  96 The errors documented for the
  97 .BR stat (2)
  98 system call are also applicable here.
  99 .SH VERSIONS
 100 These system calls have been available on Linux since kernel 2.4;
 101 glibc support is provided since version 2.3.
 102 .SH "CONFORMING TO"
 103 These system calls are Linux-specific.
 104 .\" .SH AUTHORS
 105 .\" Andreas Gruenbacher,
 106 .\" .RI < a.gruenbacher@computer.org >
 107 .\" and the SGI XFS development team,
 108 .\" .RI < linux-xfs@oss.sgi.com >.
 109 .\" Please send any bug reports or comments to these addresses.
 110 .SH SEE ALSO
 111 .BR getfattr (1),
 112 .BR setfattr (1),
 113 .BR getxattr (2),
 114 .BR listxattr (2),
 115 .BR open (2),
 116 .BR setxattr (2),
 117 .BR stat (2),
 118 .BR attr (5),
 119 .BR symlink (7)