share/man/man9/VFS_VPTOFH.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_VPTOFH.9,v 1.6.2.1 2001/12/17 11:30:18 ru Exp $
  28 .\"
  29 .Dd July 24, 1996
  30 .Dt VFS_VPTOFH 9
  31 .Os
  32 .Sh NAME
  33 .Nm VFS_VPTOFH
  34 .Nd turn a vnode into an NFS filehandle
  35 .Sh SYNOPSIS
  36 .In sys/param.h
  37 .In sys/mount.h
  38 .In sys/vnode.h
  39 .Ft int
  40 .Fn VFS_VPTOFH "struct vnode *vp" "struct fid *fhp"
  41 .Sh DESCRIPTION
  42 This is used by the NFS server to create an opaque filehandle which
  43 uniquely identifies the file and which can be used by an NFS client
  44 to access the file in the future.
  45 .Pp
  46 Its arguments are:
  47 .Bl -tag -width fhp
  48 .It Fa vp
  49 The vnode to make a filehandle for.
  50 .It Fa fhp
  51 Return parameter for the filehandle.
  52 .El
  53 .Sh SEE ALSO
  54 .Xr VFS 9 ,
  55 .Xr VFS_FHTOVP 9 ,
  56 .Xr vnode 9
  57 .Sh AUTHORS
  58 This man page was written by
  59 .An Doug Rabson .