manual/LDP_man-pages/original/man2/renameat.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 RENAMEAT 2 2009-12-13 "Linux" "Linux Programmer's Manual"
  27 .SH NAME
  28 renameat \- rename a file relative to directory file descriptors
  29 .SH SYNOPSIS
  30 .nf
  31 .B #include <fcntl.h>           /* Definition of AT_* constants */
  32 .B #include <stdio.h>
  33 .sp
  34 .BI "int renameat(int " olddirfd ", const char *" oldpath ,
  35 .BI "             int " newdirfd ", const char *" newpath );
  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 renameat ():
  44 .br
  45 Since glibc 2.10: _XOPEN_SOURCE >= 700 || _POSIX_C_SOURCE >= 200809L
  46 .br
  47 Before glibc 2.10:
  48 _ATFILE_SOURCE
  49 .SH DESCRIPTION
  50 The
  51 .BR renameat ()
  52 system call operates in exactly the same way as
  53 .BR rename (2),
  54 except for the differences described in this manual page.
  55
  56 If the pathname given in
  57 .I oldpath
  58 is relative, then it is interpreted relative to the directory
  59 referred to by the file descriptor
  60 .I olddirfd
  61 (rather than relative to the current working directory of
  62 the calling process, as is done by
  63 .BR rename (2)
  64 for a relative pathname).
  65
  66 If
  67 .I oldpath
  68 is relative and
  69 .I olddirfd
  70 is the special value
  71 .BR AT_FDCWD ,
  72 then
  73 .I oldpath
  74 is interpreted relative to the current working
  75 directory of the calling process (like
  76 .BR rename (2)).
  77
  78 If
  79 .I oldpath
  80 is absolute, then
  81 .I olddirfd
  82 is ignored.
  83
  84 The interpretation of
  85 .I newpath
  86 is as for
  87 .IR oldpath ,
  88 except that a relative pathname is interpreted relative
  89 to the directory referred to by the file descriptor
  90 .IR newdirfd .
  91 .SH "RETURN VALUE"
  92 On success,
  93 .BR renameat ()
  94 returns 0.
  95 On error, \-1 is returned and
  96 .I errno
  97 is set to indicate the error.
  98 .SH ERRORS
  99 The same errors that occur for
 100 .BR rename (2)
 101 can also occur for
 102 .BR renameat ().
 103 The following additional errors can occur for
 104 .BR renameat ():
 105 .TP
 106 .B EBADF
 107 .I olddirfd
 108 or
 109 .I newdirfd
 110 is not a valid file descriptor.
 111 .TP
 112 .B ENOTDIR
 113 .I oldpath
 114 is relative and
 115 .I olddirfd
 116 is a file descriptor referring to a file other than a directory;
 117 or similar for
 118 .I newpath
 119 and
 120 .I newdirfd
 121 .SH VERSIONS
 122 .BR renameat ()
 123 was added to Linux in kernel 2.6.16.
 124 .SH "CONFORMING TO"
 125 POSIX.1-2008.
 126 .SH NOTES
 127 See
 128 .BR openat (2)
 129 for an explanation of the need for
 130 .BR renameat ().
 131 .SH "SEE ALSO"
 132 .BR openat (2),
 133 .BR rename (2),
 134 .BR path_resolution (7)