xref: /freebsd/share/man/man9/VOP_LINK.9 (revision 06c3fb27)
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.Dd July 24, 1996
30.Dt VOP_LINK 9
31.Os
32.Sh NAME
33.Nm VOP_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_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 should
54.Em not
55be released on exit because it is done
56by the caller.
57The directory and file vnodes should
58.Em not
59be released on exit.
60.Sh LOCKS
61.Fn VOP_LINK
62expects the directory and file vnodes to be locked on entry and will leave
63the vnodes locked on return.
64.Sh RETURN VALUES
65Zero is returned if the file was linked successfully, otherwise an
66error is returned.
67.Sh ERRORS
68.Bl -tag -width Er
69.It Bq Er EMLINK
70The file has too many links.
71.It Bq Er EPERM
72The file is immutable.
73.It Bq Er EXDEV
74A hard link is not possible between different file systems.
75.El
76.Sh SEE ALSO
77.Xr vn_lock 9 ,
78.Xr vnode 9
79.Sh AUTHORS
80This manual page was originally written by
81.An Doug Rabson .
82