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 2006-04-10 "Linux 2.6.16" "Linux Programmer's Manual"
  27 .SH NAME
  28 renameat \- rename a file relative to directory file descriptors
  29 .SH SYNOPSIS
  30 .nf
  31 .B #define _ATFILE_SOURCE
  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 .SH DESCRIPTION
  38 The
  39 .BR renameat ()
  40 system call operates in exactly the same way as
  41 .BR rename (2),
  42 except for the differences described in this manual page.
  43
  44 If the pathname given in
  45 .I oldpath
  46 is relative, then it is interpreted relative to the directory
  47 referred to by the file descriptor
  48 .IR olddirfd
  49 (rather than relative to the current working directory of
  50 the calling process, as is done by
  51 .BR rename (2)
  52 for a relative pathname).
  53
  54 If
  55 .I oldpath
  56 is relative and
  57 .I olddirfd
  58 is the special value
  59 .BR AT_FDCWD ,
  60 then
  61 .I oldpath
  62 is interpreted relative to the current working
  63 directory of the calling process (like
  64 .BR rename (2)).
  65
  66 If
  67 .IR oldpath
  68 is absolute, then
  69 .I olddirfd
  70 is ignored.
  71
  72 The interpretation of
  73 .I newpath
  74 is as for
  75 .IR oldpath ,
  76 except that a relative pathname is interpreted relative
  77 to the directory referred to by the file descriptor
  78 .IR newdirfd .
  79 .SH "RETURN VALUE"
  80 On success,
  81 .BR renameat ()
  82 returns 0.
  83 On error, \-1 is returned and
  84 .I errno
  85 is set to indicate the error.
  86 .SH ERRORS
  87 The same errors that occur for
  88 .BR rename (2)
  89 can also occur for
  90 .BR renameat ().
  91 The following additional errors can occur for
  92 .BR renameat ():
  93 .TP
  94 .B EBADF
  95 .I olddirfd
  96 or
  97 .I newdirfd
  98 is not a valid file descriptor.
  99 .TP
 100 .B ENOTDIR
 101 .I oldpath
 102 is relative and
 103 .I olddirfd
 104 is a file descriptor referring to a file other than a directory;
 105 or similar for
 106 .I newpath
 107 and
 108 .IR newdirfd
 109 .SH NOTES
 110 See
 111 .BR openat (2)
 112 for an explanation of the need for
 113 .BR renameat ().
 114 .SH "CONFORMING TO"
 115 This system call is non-standard but is proposed
 116 for inclusion in a future revision of POSIX.1.
 117 .SH VERSIONS
 118 .BR renameat ()
 119 was added to Linux in kernel 2.6.16.
 120 .SH "SEE ALSO"
 121 .BR openat (2),
 122 .BR rename (2),
 123 .BR path_resolution (2)