original/man2/fchmodat.2

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