share/man/man9/VFS_VPTOFH.9

   1 .\" -*- nroff -*-
   2 .\"
   3 .\" Copyright (c) 1996 Doug Rabson
   4 .\"
   5 .\" All rights reserved.
   6 .\"
   7 .\" This program is free software.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  19 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  22 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 .\"
  29 .\" $FreeBSD: src/share/man/man9/VFS_VPTOFH.9,v 1.6.2.1 2001/12/17 11:30:18 ru Exp $
  30 .\" $DragonFly: src/share/man/man9/VFS_VPTOFH.9,v 1.3 2003/07/27 05:36:06 hmp Exp $
  31 .\"
  32 .Dd July 24, 1996
  33 .Os
  34 .Dt VFS_VPTOFH 9
  35 .Sh NAME
  36 .Nm VFS_VPTOFH
  37 .Nd turn a vnode into an NFS filehandle
  38 .Sh SYNOPSIS
  39 .In sys/param.h
  40 .In sys/mount.h
  41 .In sys/vnode.h
  42 .Ft int
  43 .Fn VFS_VPTOFH "struct vnode *vp" "struct fid *fhp"
  44 .Sh DESCRIPTION
  45 This is used by the NFS server to create an opaque filehandle which
  46 uniquely identifies the file and which can be used by an NFS client
  47 to access the file in the future.
  48 .Pp
  49 Its arguments are:
  50 .Bl -tag -width fhp
  51 .It Fa vp
  52 The vnode to make a filehandle for.
  53 .It Fa fhp
  54 Return parameter for the filehandle.
  55 .El
  56 .Sh SEE ALSO
  57 .Xr VFS 9 ,
  58 .Xr VFS_FHTOVP 9 ,
  59 .Xr vnode 9
  60 .Sh AUTHORS
  61 This man page was written by
  62 .An Doug Rabson .