diff options
Diffstat (limited to 'share/man/man9/VFS_ROOT.9')
-rw-r--r-- | share/man/man9/VFS_ROOT.9 | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/share/man/man9/VFS_ROOT.9 b/share/man/man9/VFS_ROOT.9 new file mode 100644 index 000000000000..2490cfc0bdad --- /dev/null +++ b/share/man/man9/VFS_ROOT.9 @@ -0,0 +1,67 @@ +.\" -*- 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. +.\" +.\" $FreeBSD$ +.\" +.Dd May 23, 2009 +.Os +.Dt VFS_ROOT 9 +.Sh NAME +.Nm VFS_ROOT +.Nd return the root vnode of a file system +.Sh SYNOPSIS +.In sys/param.h +.In sys/mount.h +.In sys/vnode.h +.Ft int +.Fn VFS_ROOT "struct mount *mp" "int flags" "struct vnode **vpp" +.Sh DESCRIPTION +Return a locked vnode for the root directory of the file system. +.Pp +Its arguments are: +.Bl -tag -width flags +.It Fa mp +The file system. +.It Fa flags +The lock type. +Could be +.Dv LK_EXCLUSIVE +or +.Dv LK_SHARED . +File system is free to ignore the +.Fa flags +argument and instead acquire an exclusive lock. +.It Fa vpp +Return parameter for the root vnode. +.El +.Sh SEE ALSO +.Xr VFS 9 , +.Xr vnode 9 +.Sh AUTHORS +This manual page was written by +.An Doug Rabson . |