1.\" -*- nroff -*- 2.\" 3.\" Copyright (c) 1996 Doug Rabson 4.\" 5.\" All rights reserved. 6.\" 7.\" This program is free software. 8.\" 9.\" Redistribution and use in source and binary forms, with or without 10.\" modification, are permitted provided that the following conditions 11.\" are met: 12.\" 1. Redistributions of source code must retain the above copyright 13.\" notice, this list of conditions and the following disclaimer. 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in the 16.\" documentation and/or other materials provided with the distribution. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR 19.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 20.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 21.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT, 22.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 23.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 24.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 25.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 27.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28.\" 29.\" $FreeBSD$ 30.\" 31.Dd July 24, 1996 32.Dt VOP_RENAME 9 33.Os 34.Sh NAME 35.Nm VOP_RENAME 36.Nd rename a file 37.Sh SYNOPSIS 38.In sys/param.h 39.In sys/vnode.h 40.Ft int 41.Fn VOP_RENAME "struct vnode *fdvp" "struct vnode *fvp" "struct componentname *fcnp" "struct vnode *tdvp" "struct vnode *tvp" "struct componentname *tcnp" 42.Sh DESCRIPTION 43This renames a file and possibly changes its parent directory. 44If the destination object exists, it will be removed first. 45.Pp 46Its arguments are: 47.Bl -tag -width fdvp 48.It Fa fdvp 49The vnode of the old parent directory. 50.It Fa fvp 51The vnode of the file to be renamed. 52.It Fa fcnp 53Pathname information about the file's current name. 54.It Fa tdvp 55The vnode of the new parent directory. 56.It Fa tvp 57The vnode of the target file (if it exists). 58.It Fa tcnp 59Pathname information about the file's new name. 60.El 61.Sh LOCKS 62The source directory and file are unlocked but are expected to have their 63ref count bumped on entry. 64The VOP routine is expected to 65.Xr vrele 9 66both prior 67to returning. 68.Pp 69The destination directory and file are locked as well as having their ref 70count bumped. 71The VOP routine is expected to 72.Xr vput 9 73both prior to 74returning. 75.Sh ERRORS 76.Bl -tag -width Er 77.It Bq Er EPERM 78The file is immutable. 79.It Bq Er EXDEV 80It is not possible to rename a file between different file systems. 81.It Bq Er EINVAL 82An attempt was made to rename 83.Pa \&. 84or 85.Pa .. , 86or to perform an operation which would break the directory tree structure. 87.It Bq Er ENOTDIR 88An attempt was made to rename a directory to a file or vice versa. 89.It Bq Er ENOTEMPTY 90An attempt was made to remove a directory which is not empty. 91.El 92.Sh SEE ALSO 93.Xr vnode 9 94.Sh AUTHORS 95This manual page was written by 96.An Doug Rabson . 97