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