xref: /openbsd-src/share/man/man9/vhold.9 (revision a28daedfc357b214be5c701aa8ba8adb29a7f1c2)
1.\"     $OpenBSD: vhold.9,v 1.5 2007/05/31 19:20:01 jmc Exp $
2.\"
3.\" Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice(s), this list of conditions and the following disclaimer as
10.\"    the first lines of this file unmodified other than the possible
11.\"    addition of one or more copyright notices.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice(s), 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 COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
17.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19.\" DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
20.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
23.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
26.\" DAMAGE.
27.\"
28.\" $FreeBSD: src/share/man/man9/vhold.9,v 1.2 2001/12/14 09:11:13 ru Exp $
29.\"
30.Dd $Mdocdate: May 31 2007 $
31.Dt VHOLD 9
32.Os
33.Sh NAME
34.Nm vhold
35.Nd acquire a hold on a vnode
36.Sh SYNOPSIS
37.Fd #include <sys/param.h>
38.Fd #include <sys/vnode.h>
39.Ft void
40.Fn vhold "struct vnode *vp"
41.Sh DESCRIPTION
42The
43.Fn vhold
44function increments the
45.Va v_holdcnt
46of the given vnode.
47If the vnode has already been added to the free list and its
48.Va v_holdcnt
49and
50.Va v_usecount
51are both zero, it will be removed from the free list and
52added to the vnode hold list.
53.Sh SEE ALSO
54.Xr vnode 9
55.Sh AUTHORS
56This man page was orignally written by
57.An Chad David Aq davidc@acns.ab.ca
58for
59.Fx .
60