lib/libc/gen/getvfsbyname.3

   1 .\" Copyright (c) 1995
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)kvm_getvfsbyname.3  8.3 (Berkeley) 5/4/95
  29 .\" $FreeBSD: src/lib/libc/gen/getvfsbyname.3,v 1.7.2.5 2001/12/14 18:33:51 ru Exp $
  30 .\" $DragonFly: src/lib/libc/gen/getvfsbyname.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
  31 .\"
  32 .Dd May 4, 1995
  33 .Dt GETVFSBYNAME 3
  34 .Os
  35 .Sh NAME
  36 .Nm getvfsbyname
  37 .Nd get information about a filesystem
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In sys/param.h
  42 .In sys/mount.h
  43 .Ft int
  44 .Fn getvfsbyname "const char *name" "struct vfsconf *vfc"
  45 .Sh DESCRIPTION
  46 The
  47 .Fn getvfsbyname
  48 function provides access to information about a
  49 filesystem module that is configured in the kernel.
  50 If successful,
  51 the requested filesystem
  52 .Fa vfsconf
  53 is returned in the location pointed to by
  54 .Fa vfc .
  55 The fields in a
  56 .Dq Li struct vfsconf
  57 are defined as follows:
  58 .Pp
  59 .Bl -tag -compact -width vfc_refcount
  60 .It vfc_name
  61 the name of the filesystem
  62 .It vfc_typenum
  63 the filesystem type number assigned by the kernel
  64 .It vfc_refcount
  65 the number of active mount points using the filesystem
  66 .It vfc_flags
  67 flag bits as described in
  68 .Xr getvfsent 3
  69 .El
  70 .Sh RETURN VALUES
  71 .Rv -std getvfsbyname
  72 .Sh ERRORS
  73 The following errors may be reported:
  74 .Bl -tag -width Er
  75 .It Bq Er EFAULT
  76 The
  77 .Fa vfc
  78 pointer contains an invalid address.
  79 .It Bq Er ENOENT
  80 The
  81 .Fa name
  82 specifies a filesystem that is unknown or not configured in the kernel.
  83 .El
  84 .Sh SEE ALSO
  85 .Xr mount 2 ,
  86 .Xr getvfsent 3 ,
  87 .Xr sysctl 3 ,
  88 .Xr mount 8 ,
  89 .Xr sysctl 8
  90 .Sh HISTORY
  91 A variant of the
  92 .Fn getvfsbyname
  93 function first appeared in
  94 .Fx 2.0 .