original/man2/fchownat.2

   1 .\" This manpage is Copyright (C) 2006, Michael Kerrisk
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .TH FCHOWNAT 2 2013-07-21 "Linux" "Linux Programmer's Manual"
  26 .SH NAME
  27 fchownat \- change ownership of a file relative to a directory \
  28 file descriptor
  29 .SH SYNOPSIS
  30 .nf
  31 .B #include <fcntl.h>           /* Definition of AT_* constants */
  32 .B #include <unistd.h>
  33 .sp
  34 .BI "int fchownat(int " dirfd ", const char *" pathname ,
  35 .BI "             uid_t " owner ", gid_t " group ", int " flags );
  36 .fi
  37 .sp
  38 .in -4n
  39 Feature Test Macro Requirements for glibc (see
  40 .BR feature_test_macros (7)):
  41 .in
  42 .sp
  43 .BR fchownat ():
  44 .PD 0
  45 .ad l
  46 .RS 4
  47 .TP 4
  48 Since glibc 2.10:
  49 _XOPEN_SOURCE\ >=\ 700 || _POSIX_C_SOURCE\ >=\ 200809L
  50 .TP
  51 Before glibc 2.10:
  52 _ATFILE_SOURCE
  53 .RE
  54 .ad
  55 .PD
  56 .SH DESCRIPTION
  57 The
  58 .BR fchownat ()
  59 system call operates in exactly the same way as
  60 .BR chown (2),
  61 except for the differences described in this manual page.
  62
  63 If the pathname given in
  64 .I pathname
  65 is relative, then it is interpreted relative to the directory
  66 referred to by the file descriptor
  67 .I dirfd
  68 (rather than relative to the current working directory of
  69 the calling process, as is done by
  70 .BR chown (2)
  71 for a relative pathname).
  72
  73 If
  74 .I pathname
  75 is relative and
  76 .I dirfd
  77 is the special value
  78 .BR AT_FDCWD ,
  79 then
  80 .I pathname
  81 is interpreted relative to the current working
  82 directory of the calling process (like
  83 .BR chown (2)).
  84
  85 If
  86 .I pathname
  87 is absolute, then
  88 .I dirfd
  89 is ignored.
  90
  91 The
  92 .I flags
  93 argument is a bit mask created by ORing together
  94 0 or more of the following values;
  95 .TP
  96 .BR AT_EMPTY_PATH " (since Linux 2.6.39)"
  97 .\" commit 65cfc6722361570bfe255698d9cd4dccaf47570d
  98 If
  99 .I pathname
 100 is an empty string, operate on the file referred to by
 101 .IR dirfd
 102 (which may have been obtained using the
 103 .BR open (2)
 104 .B O_PATH
 105 flag).
 106 In this case,
 107 .I dirfd
 108 can refer to any type of file, not just a directory.
 109
 110 .TP
 111 .B AT_SYMLINK_NOFOLLOW
 112 If
 113 .I pathname
 114 is a symbolic link, do not dereference it:
 115 instead operate on the link itself, like
 116 .BR lchown (2).
 117 (By default,
 118 .BR fchownat ()
 119 dereferences symbolic links, like
 120 .BR chown (2).)
 121 .SH RETURN VALUE
 122 On success,
 123 .BR fchownat ()
 124 returns 0.
 125 On error, \-1 is returned and
 126 .I errno
 127 is set to indicate the error.
 128 .SH ERRORS
 129 The same errors that occur for
 130 .BR chown (2)
 131 can also occur for
 132 .BR fchownat ().
 133 The following additional errors can occur for
 134 .BR fchownat ():
 135 .TP
 136 .B EBADF
 137 .I dirfd
 138 is not a valid file descriptor.
 139 .TP
 140 .B EINVAL
 141 Invalid flag specified in
 142 .IR flags .
 143 .TP
 144 .B ENOTDIR
 145 .I pathname
 146 is relative and
 147 .I dirfd
 148 is a file descriptor referring to a file other than a directory.
 149 .SH VERSIONS
 150 .BR fchownat ()
 151 was added to Linux in kernel 2.6.16;
 152 library support was added to glibc in version 2.4.
 153 .SH CONFORMING TO
 154 POSIX.1-2008.
 155 A similar system call exists on Solaris.
 156 .SH NOTES
 157 See
 158 .BR openat (2)
 159 for an explanation of the need for
 160 .BR fchownat ().
 161 .SH SEE ALSO
 162 .BR chown (2),
 163 .BR openat (2),
 164 .BR path_resolution (7),
 165 .BR symlink (7)