xref: /freebsd/share/man/man9/VOP_LINK.9 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1fab63cc4SDoug Rabson.\" -*- nroff -*-
2fab63cc4SDoug Rabson.\"
3fab63cc4SDoug Rabson.\" Copyright (c) 1996 Doug Rabson
4fab63cc4SDoug Rabson.\"
5fab63cc4SDoug Rabson.\" All rights reserved.
6fab63cc4SDoug Rabson.\"
7fab63cc4SDoug Rabson.\" This program is free software.
8fab63cc4SDoug Rabson.\"
9fab63cc4SDoug Rabson.\" Redistribution and use in source and binary forms, with or without
10fab63cc4SDoug Rabson.\" modification, are permitted provided that the following conditions
11fab63cc4SDoug Rabson.\" are met:
12fab63cc4SDoug Rabson.\" 1. Redistributions of source code must retain the above copyright
13fab63cc4SDoug Rabson.\"    notice, this list of conditions and the following disclaimer.
14fab63cc4SDoug Rabson.\" 2. Redistributions in binary form must reproduce the above copyright
15fab63cc4SDoug Rabson.\"    notice, this list of conditions and the following disclaimer in the
16fab63cc4SDoug Rabson.\"    documentation and/or other materials provided with the distribution.
17fab63cc4SDoug Rabson.\"
18fab63cc4SDoug Rabson.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
19fab63cc4SDoug Rabson.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20fab63cc4SDoug Rabson.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21fab63cc4SDoug Rabson.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
22fab63cc4SDoug Rabson.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23fab63cc4SDoug Rabson.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24fab63cc4SDoug Rabson.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25fab63cc4SDoug Rabson.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26fab63cc4SDoug Rabson.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27fab63cc4SDoug Rabson.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28fab63cc4SDoug Rabson.\"
29fab63cc4SDoug Rabson.Dd July 24, 1996
30fab63cc4SDoug Rabson.Dt VOP_LINK 9
31*aa12cea2SUlrich Spörlein.Os
32fab63cc4SDoug Rabson.Sh NAME
33fab63cc4SDoug Rabson.Nm VOP_LINK
34fab63cc4SDoug Rabson.Nd create a new name for a file
35fab63cc4SDoug Rabson.Sh SYNOPSIS
3632eef9aeSRuslan Ermilov.In sys/param.h
3732eef9aeSRuslan Ermilov.In sys/vnode.h
38fab63cc4SDoug Rabson.Ft int
39fab63cc4SDoug Rabson.Fn VOP_LINK "struct vnode *dvp" "struct vnode *vp" "struct componentname *cnp"
40fab63cc4SDoug Rabson.Sh DESCRIPTION
41fab63cc4SDoug RabsonThis links a new name in the specified directory to an existing file.
42fab63cc4SDoug Rabson.Pp
43fab63cc4SDoug RabsonIts arguments are:
443136363fSRuslan Ermilov.Bl -tag -width 8n
450640e9e0SHiten Pandya.It Fa dvp
460a57ea7dSRuslan ErmilovThe vnode of the directory.
470640e9e0SHiten Pandya.It Fa vp
480a57ea7dSRuslan ErmilovThe vnode of the file to be linked.
490640e9e0SHiten Pandya.It Fa cnp
500a57ea7dSRuslan ErmilovPathname information about the file.
51fab63cc4SDoug Rabson.El
52fab63cc4SDoug Rabson.Pp
53d962d52aSRuslan ErmilovThe pathname info should
54d962d52aSRuslan Ermilov.Em not
55d962d52aSRuslan Ermilovbe released on exit because it is done
564f0ef111SDon Lewisby the caller.
57d962d52aSRuslan ErmilovThe directory and file vnodes should
58d962d52aSRuslan Ermilov.Em not
59d962d52aSRuslan Ermilovbe released on exit.
60fab63cc4SDoug Rabson.Sh LOCKS
61facc6767SRuslan Ermilov.Fn VOP_LINK
6239473914SDon Lewisexpects the directory and file vnodes to be locked on entry and will leave
6339473914SDon Lewisthe vnodes locked on return.
64fab63cc4SDoug Rabson.Sh RETURN VALUES
65fab63cc4SDoug RabsonZero is returned if the file was linked successfully, otherwise an
66fab63cc4SDoug Rabsonerror is returned.
67fab63cc4SDoug Rabson.Sh ERRORS
68eaa8b244SMike Pritchard.Bl -tag -width Er
694f0ef111SDon Lewis.It Bq Er EMLINK
70cc258457SDon LewisThe file has too many links.
71fab63cc4SDoug Rabson.It Bq Er EPERM
72cc258457SDon LewisThe file is immutable.
734f0ef111SDon Lewis.It Bq Er EXDEV
74cc258457SDon LewisA hard link is not possible between different file systems.
754f0ef111SDon Lewis.El
76fab63cc4SDoug Rabson.Sh SEE ALSO
771c85060aSRuslan Ermilov.Xr vn_lock 9 ,
781c85060aSRuslan Ermilov.Xr vnode 9
79fab63cc4SDoug Rabson.Sh AUTHORS
80571dba6eSHiten PandyaThis manual page was originally written by
81aaf1f16eSPhilippe Charnier.An Doug Rabson .
82