BSD 4_3_Net_2 release

[unix-history] / usr / src / lib / libc / sys / rename.2

diff --git a/usr/src/lib/libc/sys/rename.2 b/usr/src/lib/libc/sys/rename.2
index 4580dc9..07a168c 100644 (file)
--- a/usr/src/lib/libc/sys/rename.2
+++ b/usr/src/lib/libc/sys/rename.2
@@ -1,164 +1,198 @@
-.\" Copyright (c) 1983 The Regents of the University of California.
+.\" Copyright (c) 1983, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" All rights reserved.
 .\"

-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" Neither the name of the University nor the names of its contributors may
-.\" be used to endorse or promote products derived from this software without
-.\" specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\"    @(#)rename.2    6.6 (Berkeley) 6/23/90
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.

 .\"
 .\"

-.TH RENAME 2 "June 23, 1990"
-.UC 5
-.SH NAME
-rename \- change the name of a file
-.SH SYNOPSIS
-.ft B
-.nf
-rename(from, to)
-char *from, *to;
-.fi
-.ft R
-.SH DESCRIPTION
-.I Rename
+.\"     @(#)rename.2   6.7 (Berkeley) 3/10/91
+.\"
+.Dd March 10, 1991
+.Dt RENAME 2
+.Os BSD 4.2
+.Sh NAME
+.Nm rename
+.Nd change the name of a file
+.Sh SYNOPSIS
+.Fd #include <stdio.h>
+.Ft int
+.Fn rename "const char *from" "const char *to"
+.Sh DESCRIPTION
+.Fn Rename

 causes the link named
 causes the link named

-.I from
+.Fa from

 to be renamed as
 to be renamed as

-.IR to .
+.Fa to .

 If 
 If 

-.I to
-exists, then it is first removed.
+.Fa to
+exists, it is first removed.

 Both 
 Both 

-.I from
+.Fa from

 and
 and

-.I to
+.Fa to

 must be of the same type (that is, both directories or both
 non-directories), and must reside on the same file system.
 must be of the same type (that is, both directories or both
 non-directories), and must reside on the same file system.

-.PP
-.I Rename
+.Pp
+.Fn Rename

 guarantees that an instance of
 guarantees that an instance of

-.I to
+.Fa to

 will always exist, even if the system should crash in
 the middle of the operation.
 will always exist, even if the system should crash in
 the middle of the operation.

-.PP
+.Pp

 If the final component of
 If the final component of

-.I from
+.Fa from

 is a symbolic link,
 the symbolic link is renamed,
 not the file or directory to which it points.
 is a symbolic link,
 the symbolic link is renamed,
 not the file or directory to which it points.

-.SH CAVEAT
+.Sh CAVEAT

 The system can deadlock if a loop in the file system graph is present.
 The system can deadlock if a loop in the file system graph is present.

-This loop takes the form of an entry in directory \*(lqa\*(rq,
-say \*(lqa/foo\*(rq,
-being a hard link to directory \*(lqb\*(rq, and an entry in
-directory \*(lqb\*(rq, say \*(lqb/bar\*(rq, being a hard link
-to directory \*(lqa\*(rq.
+This loop takes the form of an entry in directory
+.Ql Pa a ,
+say
+.Ql Pa a/foo ,
+being a hard link to directory
+.Ql Pa b ,
+and an entry in
+directory
+.Ql Pa b ,
+say
+.Ql Pa b/bar ,
+being a hard link
+to directory
+.Ql Pa a .

 When such a loop exists and two separate processes attempt to
 When such a loop exists and two separate processes attempt to

-perform \*(lqrename a/foo b/bar\*(rq and \*(lqrename b/bar a/foo\*(rq,
+perform
+.Ql rename a/foo b/bar
+and
+.Ql rename b/bar a/foo ,

 respectively, 
 the system may deadlock attempting to lock
 both directories for modification.
 Hard links to directories should be
 replaced by symbolic links by the system administrator.
 respectively, 
 the system may deadlock attempting to lock
 both directories for modification.
 Hard links to directories should be
 replaced by symbolic links by the system administrator.

-.SH "RETURN VALUE"
+.Sh RETURN VALUES

 A 0 value is returned if the operation succeeds, otherwise
 A 0 value is returned if the operation succeeds, otherwise

-.I rename
-returns \-1 and the global variable 
-.I errno
+.Fn rename
+returns -1 and the global variable 
+.Va errno

 indicates the reason for the failure.
 indicates the reason for the failure.

-.SH "ERRORS
-.I Rename
+.Sh ERRORS
+.Fn Rename

 will fail and neither of the argument files will be
 will fail and neither of the argument files will be

-affected if any of the following are true:
-.TP 15
-[EINVAL]
+affected if:
+.Bl -tag -width ENAMETOOLONG
+.It Bq Er EINVAL

 Either pathname contains a character with the high-order bit set.
 Either pathname contains a character with the high-order bit set.

-.TP 15
-[ENAMETOOLONG]
+.It Bq Er ENAMETOOLONG

 A component of either pathname exceeded 255 characters,
 or the entire length of either path name exceeded 1023 characters.
 A component of either pathname exceeded 255 characters,
 or the entire length of either path name exceeded 1023 characters.

-.TP 15
-[ENOENT]
-A component of the \fIfrom\fP path does not exist,
-or a path prefix of \fIto\fP does not exist.
-.TP 15
-[EACCES]
+.It Bq Er ENOENT
+A component of the
+.Fa from
+path does not exist,
+or a path prefix of
+.Fa to
+does not exist.
+.It Bq Er EACCES

 A component of either path prefix denies search permission.
 A component of either path prefix denies search permission.

-.TP 15
-[EACCES]
+.It Bq Er EACCES

 The requested link requires writing in a directory with a mode
 that denies write permission.
 The requested link requires writing in a directory with a mode
 that denies write permission.

-.TP 15
-[EPERM]
-The directory containing \fIfrom\fP is marked sticky,
-and neither the containing directory nor \fIfrom\fP
+.It Bq Er EPERM
+The directory containing
+.Fa from
+is marked sticky,
+and neither the containing directory nor
+.Fa from

 are owned by the effective user ID.
 are owned by the effective user ID.

-.TP 15
-[EPERM]
-The \fIto\fP file exists,
-the directory containing \fIto\fP is marked sticky,
-and neither the containing directory nor \fIto\fP
+.It Bq Er EPERM
+The
+.Fa to
+file exists,
+the directory containing
+.Fa to
+is marked sticky,
+and neither the containing directory nor
+.Fa to

 are owned by the effective user ID.
 are owned by the effective user ID.

-.TP 15
-[ELOOP]
+.It Bq Er ELOOP

 Too many symbolic links were encountered in translating either pathname.
 Too many symbolic links were encountered in translating either pathname.

-.TP 15
-[ENOTDIR]
+.It Bq Er ENOTDIR

 A component of either path prefix is not a directory.
 A component of either path prefix is not a directory.

-.TP 15
-[ENOTDIR]
-.I From
-is a directory, but \fIto\fP is not a directory.
-.TP 15
-[EISDIR]
-.I To
-is a directory, but \fIfrom\fP is not a directory.
-.TP 15
-[EXDEV]
-The link named by \fIto\fP and the file named by \fIfrom\fP
+.It Bq Er ENOTDIR
+.Fa from
+is a directory, but
+.Fa to
+is not a directory.
+.It Bq Er EISDIR
+.Fa to
+is a directory, but
+.Fa from
+is not a directory.
+.It Bq Er EXDEV
+The link named by
+.Fa to
+and the file named by
+.Fa from

 are on different logical devices (file systems).  Note that this error
 code will not be returned if the implementation permits cross-device
 links.
 are on different logical devices (file systems).  Note that this error
 code will not be returned if the implementation permits cross-device
 links.

-.TP 15
-[ENOSPC]
+.It Bq Er ENOSPC

 The directory in which the entry for the new name is being placed
 cannot be extended because there is no space left on the file
 system containing the directory.
 The directory in which the entry for the new name is being placed
 cannot be extended because there is no space left on the file
 system containing the directory.

-.TP 15
-[EDQUOT]
+.It Bq Er EDQUOT

 The directory in which the entry for the new name
 is being placed cannot be extended because the
 user's quota of disk blocks on the file system
 containing the directory has been exhausted.
 The directory in which the entry for the new name
 is being placed cannot be extended because the
 user's quota of disk blocks on the file system
 containing the directory has been exhausted.

-.TP 15
-[EIO]
+.It Bq Er EIO

 An I/O error occurred while making or updating a directory entry.
 An I/O error occurred while making or updating a directory entry.

-.TP 15
-[EROFS]
+.It Bq Er EROFS

 The requested link requires writing in a directory on a read-only file
 system.
 The requested link requires writing in a directory on a read-only file
 system.

-.TP 15
-[EFAULT]
-.I Path
+.It Bq Er EFAULT
+.Em Path

 points outside the process's allocated address space.
 points outside the process's allocated address space.

-.TP 15
-[EINVAL]
-.I From
+.It Bq Er EINVAL
+.Fa From

 is a parent directory of
 is a parent directory of

-.IR to ,
-or an attempt is made to rename ``.'' or ``..''.
-.TP 15
-[ENOTEMPTY]
-.I To
+.Fa to ,
+or an attempt is made to rename
+.Ql \&.
+or
+.Ql \&.. .
+.It Bq Er ENOTEMPTY
+.Fa To

 is a directory and is not empty.
 is a directory and is not empty.

-.SH "SEE ALSO"
-open(2)
+.El
+.Sh SEE ALSO
+.Xr open 2
+.Sh STANDARDS
+.Fn Rename
+conforms to IEEE Std 1003.1-1988
+.Pq Dq Tn POSIX .