Fix comments:
[dragonfly.git] / share / man / man9 / VFS_VGET.9
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/VFS_VGET.9,v 1.5.2.2 2001/12/17 11:30:18 ru Exp $
28 .\" $DragonFly: src/share/man/man9/VFS_VGET.9,v 1.3 2004/06/01 11:36:53 hmp Exp $
29 .\"
30 .Dd July 24, 1996
31 .Os
32 .Dt VFS_VGET 9
33 .Sh NAME
34 .Nm VFS_VGET
35 .Nd convert an inode number to a vnode
36 .Sh SYNOPSIS
37 .In sys/param.h
38 .In sys/mount.h
39 .In sys/vnode.h
40 .Ft int
41 .Fn VFS_VGET "struct mount *mp" "ino_t ino" "struct vnode **vpp"
42 .Sh DESCRIPTION
43 This converts an inode number into a locked vnode.
44 .Pp
45 Its arguments are:
46 .Bl -tag -width ino
47 .It Ar mp
48 The filesystem.
49 .It Ar ino
50 The inode representing the file.
51 .It Ar vpp
52 Return parameter for the vnode.
53 .El
54 .Pp
55 This is an optional filesystem entrypoint for filesystems which have a
56 unique id number for every file in the filesystem.  It is used
57 internally by the UFS filesystem and also by the NFSv3 server to
58 implement the
59 .Dv READDIRPLUS
60 nfs call.
61 .Pp
62 If the filesystem does not support this call, then it should return
63 .Er EOPNOTSUPP .
64 .Sh SEE ALSO
65 .Xr VFS 9 ,
66 .Xr vnode 9
67 .Sh AUTHORS
68 This man page was written by
69 .An Doug Rabson .