fab63cc413
incomplete and some are just placeholders but I wanted to try to get something at least into 2.2 on the grounds that what I have is a lot better than nothing. I also wanted to commit something which documents the interfaces in 2.2 before I start updating the documentation for 3.0. This is a definite 2.2 candidate and is also relavent to 2.1 if people still care about that branch.
70 lines
2.3 KiB
Groff
70 lines
2.3 KiB
Groff
.\" -*- nroff -*-
|
|
.\"
|
|
.\" Copyright (c) 1996 Doug Rabson
|
|
.\"
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" This program is free software.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
|
|
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|
.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
.\"
|
|
.\" $Id$
|
|
.\"
|
|
.Dd July 24, 1996
|
|
.Os
|
|
.Dt VFS_VGET 9
|
|
.Sh NAME
|
|
.Nm VFS_VGET
|
|
.Nd convert an inode number to a vnode
|
|
.Sh SYNOPSIS
|
|
.Fd #include <sys/mount.h>
|
|
.Fd #include <sys/vnode.h>
|
|
.Ft int
|
|
.Fn VFS_VGET "struct mount *mp" "ino_t ino" "struct vnode **vpp"
|
|
.Sh DESCRIPTION
|
|
This converts an inode number into a locked vnode.
|
|
.Pp
|
|
Its arguments are:
|
|
.Bl -tag -width ino
|
|
.It Ar mp
|
|
The filesystem.
|
|
.It Ar ino
|
|
The inode representing the file.
|
|
.It Ar vpp
|
|
Return parameter for the vnode.
|
|
.El
|
|
.Pp
|
|
This is an optional filesystem entrypoint for filesystems which have a
|
|
unique id number for every file in the filesystem. It is used
|
|
internally by the UFS filesystem and also by the NFSv3 server to
|
|
implement the
|
|
.Dv READDIRPLUS
|
|
nfs call.
|
|
.Pp
|
|
If the filesystem does not support this call, then it should return
|
|
.Dv EOPNOTSUPP .
|
|
.Sh SEE ALSO
|
|
.Xr vnode 9 ,
|
|
.Xr VFS 9
|
|
.Sh AUTHORS
|
|
This man page was written by Doug Rabson.
|
|
|