1 .\" Copyright (c) 1983, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 4. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" @(#)rename.2 8.1 (Berkeley) 6/4/93
36 .Nd change the name of a file
42 .Fn rename "const char *from" "const char *to"
44 .Fn renameat "int fromfd" "const char *from" "int tofd" "const char *to"
55 exists, it is first removed.
60 must be of the same type (that is, both directories or both
61 non-directories), and must reside on the same file system.
68 already exists, an instance of
70 will always exist, even if the system should crash in
71 the middle of the operation.
73 If the final component of
76 the symbolic link is renamed,
77 not the file or directory to which it points.
81 system call is equivalent to
83 except in the case where either
87 specifies a relative path.
90 is a relative path, the file to be renamed is located
91 relative to the directory associated with the file descriptor
93 instead of the current working directory.
96 is a relative path, the same happens only relative to the directory associated
101 is passed the special value
107 parameter, the current working directory is used in the determination
108 of the file for the respective path parameter.
110 .\"The system can deadlock if a loop in the file system graph is present.
111 .\"This loop takes the form of an entry in directory
115 .\"being a hard link to directory
125 .\"When such a loop exists and two separate processes attempt to
127 .\".Ql rename a/foo b/bar
129 .\".Ql rename b/bar a/foo ,
131 .\"the system may deadlock attempting to lock
132 .\"both directories for modification.
133 .\"Hard links to directories should be
134 .\"replaced by symbolic links by the system administrator.
141 will fail and neither of the argument files will be
144 .It Bq Er ENAMETOOLONG
145 A component of either pathname exceeded 255 characters,
146 or the entire length of either path name exceeded 1023 characters.
155 A component of either path prefix denies search permission.
157 The requested link requires writing in a directory with a mode
158 that denies write permission.
160 The directory pointed at by the
162 argument denies write permission, and the operation would move
163 it to another parent directory.
165 The file pointed at by the
167 argument has its immutable, undeletable or append-only flag set, see the
169 manual page for more information.
171 The parent directory of the file pointed at by the
173 argument has its immutable or append-only flag set.
175 The parent directory of the file pointed at by the
177 argument has its immutable flag set.
179 The directory containing
182 and neither the containing directory nor
184 are owned by the effective user ID.
186 The file pointed at by the
190 the directory containing
193 and neither the containing directory nor
195 are owned by the effective user ID.
197 Too many symbolic links were encountered in translating either pathname.
199 A component of either path prefix is not a directory.
217 and the file named by
219 are on different logical devices (file systems).
221 code will not be returned if the implementation permits cross-device
224 The directory in which the entry for the new name is being placed
225 cannot be extended because there is no space left on the file
226 system containing the directory.
228 The directory in which the entry for the new name
229 is being placed cannot be extended because the
230 user's quota of disk blocks on the file system
231 containing the directory has been exhausted.
233 An I/O error occurred while making or updating a directory entry.
235 The requested link requires writing in a directory on a read-only file
239 points outside the process's allocated address space.
244 is a parent directory of
246 or an attempt is made to rename
254 is a directory and is not empty.
257 In addition to the errors returned by the
266 argument does not specify an absolute path and the
270 nor a valid file descriptor open for searching, or the
272 argument does not specify an absolute path and the
276 nor a valid file descriptor open for searching.
280 argument is not an absolute path and
284 nor a file descriptor associated with a directory, or the
286 argument is not an absolute path and
290 nor a file descriptor associated with a directory.
299 system call is expected to conform to
303 system call follows The Open Group Extended API Set 2 specification.
307 system call appeared in