Differences between current version and revision by previous author of rename(2).
Other diffs: Previous Major Revision, Previous Revision, or view the Annotated Edit History
| Newer page: | version 2 | Last edited on Monday, March 17, 2003 12:51:49 am | by PerryLorier | |
| Older page: | version 1 | Last edited on Tuesday, June 4, 2002 12:23:45 am | by perry | Revert |
@@ -1,213 +1,52 @@
-RENAME
-!!!RENAME
-NAME
-SYNOPSIS
-DESCRIPTION
-RETURN VALUE
-ERRORS
-CONFORMING TO
-BUGS
-SEE ALSO
-----
!!NAME
+rename - change the name or location of a file
-
-rename - change the name or location of a file
!!SYNOPSIS
+ __#include <stdio.h>__
+ __int rename(const char *__''oldpath''__, const char *__''newpath''__);__
-__#include __
-
-
-__int rename(const char *__''oldpath''__, const char
-*__''newpath''__);__
!!DESCRIPTION
+__rename__ renames a file, moving it between directories if required.
+Any other hard links to the file (as created using link(2)) are unaffected.
-__rename__ renames
a file
, moving it between directories
-if required
.
+If ''newpath'' already exists it will be atomically replaced (subject to
a few conditions - see ERRORS below)
, so that there is no point at which another process
+attempting to access ''newpath'' will find it missing
.
+If ''newpath'' exists but the operation fails for some reason __rename__ guarantees to leave an instance of ''newpath'' in place.
-Any other hard links
to the file (as created using
-link(2)) are unaffected
.
+However, when overwriting there will probably be a window in which both ''oldpath'' and ''newpath'' refer
to the file being renamed
.
+If ''oldpath'' refers to a symbolic link the link is renamed; if ''newpath'' refers to a symbolic link the link will be overwritten.
-If ''newpath'' already exists it will be atomically
-replaced (subject to a few conditions - see ERRORS below),
-so that there is no point at which another process
-attempting to access ''newpath'' will find it
-missing.
-
-
-If ''newpath'' exists but the operation fails for some
-reason __rename__ guarantees to leave an instance of
-''newpath'' in place.
-
-
-However, when overwriting there will probably be a window in
-which both ''oldpath'' and ''newpath'' refer to the
-file being renamed.
-
-
-If ''oldpath'' refers to a symbolic link the link is
-renamed; if ''newpath'' refers to a symbolic link the
-link will be overwritten.
!!RETURN VALUE
+On success, zero is returned. On error, -1 is returned, and ''errno'' is set appropriately.
-
-On success, zero is returned. On error, -1 is returned, and
-''errno'' is set appropriately.
!!ERRORS
+;[EISDIR]: ''newpath'' is an existing directory, but ''oldpath'' is not a directory.
+;[EXDEV]: ''oldpath'' and ''newpath'' are not on the same filesystem.
+;[ENOTEMPTY] or [EEXIST]: ''newpath'' is a non-empty directory, i.e., contains entries other than '.' and '..'.
+;[EBUSY]: The rename fails because ''oldpath'' or ''newpath'' is a directory that is in use by some process (perhaps as current working directory, or as root directory, or because it was open for reading) or is in use by the system (for example as mount point), while the system considers this an error. (Note that there is no requirement to return EBUSY in such cases - there is nothing wrong with doing the rename anyway - but it is allowed to return EBUSY if the system cannot otherwise handle such situations.)
+;[EINVAL]: The new pathname contained a path prefix of the old, or, more generally, an attempt was made to make a directory a subdirectory of itself.
+;[EMLINK]: ''oldpath'' already has the maximum number of links to it, or it was a directory and the directory containing ''newpath'' has the maximum number of links.
+;[ENOTDIR]: A component used as a directory in ''oldpath'' or ''newpath'' is not, in fact, a directory. Or, ''oldpath'' is a directory, and ''newpath'' exists but is not a directory.
+;[EFAULT]: ''oldpath'' or ''newpath'' points outside your accessible address space.
+;[EACCES]: Write access to the directory containing ''oldpath'' or ''newpath'' is not allowed for the process's effective uid, or one of the directories in ''oldpath'' or
+''newpath'' did not allow search (execute) permission, or ''oldpath'' was a directory and did not allow write permission (needed to update the __..__ entry).
+;[EPERM] or [EACCES]: The directory containing ''oldpath'' has the sticky bit set and the process's effective uid is neither that of root nor the uid of the file to be deleted nor that of the directory containing it, or ''newpath'' is an existing file and the directory containing it has the sticky bit set and the process's effective uid is neither that of root nor the uid of the file to be replaced nor that of the directory containing it, or the filesystem containing ''pathname'' does not support renaming of the type requested.
+;[ENAMETOOLONG]: ''oldpath'' or ''newpath'' was too long.
+;[ENOENT]: A directory component in ''oldpath or newpath'' does not exist or is a dangling symbolic link.
+;[ENOMEM]: Insufficient kernel memory was available.
+;[EROFS]: The file is on a read-only filesystem.
+;[ELOOP]: Too many symbolic links were encountered in resolving ''oldpath'' or ''newpath''.
+;[ENOSPC]: The device containing the file has no room for the new directory entry.
-
-__EISDIR__
-
-
-''newpath'' is an existing directory, but ''oldpath''
-is not a directory.
-
-
-__EXDEV__
-
-
-''oldpath'' and ''newpath'' are not on the same
-filesystem.
-
-
-__ENOTEMPTY__ or __EEXIST__
-
-
-''newpath'' is a non-empty directory, i.e., contains
-entries other than
-''
-
-
-__EBUSY__
-
-
-The rename fails because ''oldpath'' or ''newpath'' is
-a directory that is in use by some process (perhaps as
-current working directory, or as root directory, or because
-it was open for reading) or is in use by the system (for
-example as mount point), while the system considers this an
-error. (Note that there is no requirement to return EBUSY in
-such cases - there is nothing wrong with doing the rename
-anyway - but it is allowed to return EBUSY if the system
-cannot otherwise handle such situations.)
-
-
-__EINVAL__
-
-
-The new pathname contained a path prefix of the old, or,
-more generally, an attempt was made to make a directory a
-subdirectory of itself.
-
-
-__EMLINK__
-
-
-''oldpath'' already has the maximum number of links to
-it, or it was a directory and the directory containing
-''newpath'' has the maximum number of links.
-
-
-__ENOTDIR__
-
-
-A component used as a directory in ''oldpath'' or
-''newpath'' is not, in fact, a directory. Or,
-''oldpath'' is a directory, and ''newpath'' exists but
-is not a directory.
-
-
-__EFAULT__
-
-
-''oldpath'' or ''newpath'' points outside your
-accessible address space.
-
-
-__EACCES__
-
-
-Write access to the directory containing ''oldpath'' or
-''newpath'' is not allowed for the process's effective
-uid, or one of the directories in ''oldpath'' or
-''newpath'' did not allow search (execute) permission, or
-''oldpath'' was a directory and did not allow write
-permission (needed to update the __..__
-entry).
-
-
-__EPERM__ or __EACCES__
-
-
-The directory containing ''oldpath'' has the sticky bit
-set and the process's effective uid is neither that of root
-nor the uid of the file to be deleted nor that of the
-directory containing it, or ''newpath'' is an existing
-file and the directory containing it has the sticky bit set
-and the process's effective uid is neither that of root nor
-the uid of the file to be replaced nor that of the directory
-containing it, or the filesystem containing ''pathname''
-does not support renaming of the type
-requested.
-
-
-__ENAMETOOLONG__
-
-
-''oldpath'' or ''newpath'' was too long.
-
-
-__ENOENT__
-
-
-A directory component in ''oldpath or newpath'' does not
-exist or is a dangling symbolic link.
-
-
-__ENOMEM__
-
-
-Insufficient kernel memory was available.
-
-
-__EROFS__
-
-
-The file is on a read-only filesystem.
-
-
-__ELOOP__
-
-
-Too many symbolic links were encountered in resolving
-''oldpath'' or ''newpath''.
-
-
-__ENOSPC__
-
-
-The device containing the file has no room for the new
-directory entry.
!!CONFORMING TO
+[POSIX], 4.3BSD, ANSI C
-
-POSIX, 4.3BSD, ANSI C
!!BUGS
+On NFS filesystems, you can not assume that if the operation failed the file was not renamed. If the server does the rename operation and then crashes, the retransmitted RPC which will be processed when the server is up again causes a failure. The application is expected to deal with this. See link(2) for a similar problem.
-
-On NFS filesystems, you can not assume that if the operation
-failed the file was not renamed. If the server does the
-rename operation and then crashes, the retransmitted RPC
-which will be processed when the server is up again causes a
-failure. The application is expected to deal with this. See
-link(2) for a similar problem.
!!SEE ALSO
-
-
-
-
-----
+link(2), unlink(2), symlink(2), mv(1)
