xref: /dragonfly/share/man/man9/VOP_OLD_LINK.9 (revision 335b9e93)
1.\" Copyright (c) 1996 Doug Rabson
2.\"
3.\" All rights reserved.
4.\"
5.\" This program is free software.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
17.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
20.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26.\"
27.\" $FreeBSD: src/share/man/man9/VOP_LINK.9,v 1.9.2.3 2001/12/17 11:30:18 ru Exp $
28.\"
29.Dd October 13, 2014
30.Dt VOP_OLD_LINK 9
31.Os
32.Sh NAME
33.Nm VOP_OLD_LINK
34.Nd create a new name for a file
35.Sh SYNOPSIS
36.In sys/param.h
37.In sys/vnode.h
38.Ft int
39.Fn VOP_OLD_LINK "struct vnode *dvp" "struct vnode *vp" "struct componentname *cnp"
40.Sh DESCRIPTION
41This links a new name in the specified directory to an existing file.
42.Pp
43Its arguments are:
44.Bl -tag -width 8n
45.It Fa dvp
46the vnode of the directory
47.It Fa vp
48the vnode of the file to be linked
49.It Fa cnp
50pathname information about the file
51.El
52.Pp
53The pathname info must be released on exit.  The directory and
54file vnodes should NOT be released on exit.
55.Sh LOCKS
56The directory,
57.Fa dvp
58is locked on entry and should remain locked on return.
59The file
60.Fa vp
61is not locked on entry and should remain that way on return.
62If your VOP code locks
63.Fa vp ,
64it must be sure to unlock prior to returning.
65.Sh RETURN VALUES
66Zero is returned if the file was linked successfully, otherwise an
67error is returned.
68.Sh ERRORS
69.Bl -tag -width Er
70.It Bq Er EPERM
71the file is immutable
72.El
73.Sh SEE ALSO
74.Xr vnode 9 ,
75.Xr vn_lock 9
76.Sh AUTHORS
77This man page was originally written by
78.An Doug Rabson .
79