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