NAME

rename, renameat – change the name or location of a file

SYNOPSIS

#include <stdio.h>

int rename(const char *old, const char *newn);

int renameat(int oldfd, const char *old, int newfd, const char *newn);

DESCRIPTION

The rename() function changes the name of a file. The old argument points to the pathname of the file to be renamed. The newn argument points to the new pathname of the file.

The old and newn arguments shall point to the full pathname of a files.

The renameat() function is currently unimplemented. Unison privide do-nothing stub for it.

RETURN VALUES

On success, zero is returned. On error, -1 is returned, and errno is set appropriately.

ERRORS

This function is a member of Unison’s IOLIB family of functions. IOLIB is implemented as a message passing and generalized interface layer. Each Unison I/O server is responsible for its own error reporting.

For an exact list of error codes returned by a particular server, refer to that server’s documentation in the Unison Programmer’s Guide for each specific platform.

Servers may implement these errors codes in response to this function.

rename() function fails if:

[EACCES]

Write permission is denied for the directory containing old or newn.

[EEXIST]

The link named by newn is already exist.

[ENAMETOOLONG]

old or newn was too long.

[ENOENT]

The link named by old does not exist; or, a directory component in newn does not exist; or, old or newn is an empty string.

[ENOMEM]

Insufficient kernel memory was available.

[EPERM]

Error permission to old or newn names.

[EROFS]

The file is on a read-only file system.

[EBADFSYS]

Bad file system.

[ENOTSUPPORTED]

Function is not supported by current file system.

SEE ALSO

link(), unlink().