git.saurik.com Git - apple/libc.git/blame_incremental

... / ...

Commit	Line	Data
	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.12 2001/10/01 16:08:51 ru Exp $
	34	.\"
	35	.Dd May 4, 1995
	36	.Dt GETVFSBYNAME 3
	37	.Os
	38	.Sh NAME
	39	.Nm getvfsbyname
	40	.Nd get information about a filesystem
	41	.Sh LIBRARY
	42	.Lb libc
	43	.Sh SYNOPSIS
	44	.In sys/param.h
	45	.In sys/mount.h
	46	.Ft int
	47	.Fn getvfsbyname "const char name" "struct vfsconf vfc"
	48	.Sh DESCRIPTION
	49	The
	50	.Fn getvfsbyname
	51	function provides access to information about a
	52	filesystem module that is configured in the kernel.
	53	If successful,
	54	the requested filesystem
	55	.Fa vfsconf
	56	is returned in the location pointed to by
	57	.Fa vfc .
	58	The fields in a
	59	.Dq Li struct vfsconf
	60	are defined as follows:
	61	.Pp
	62	.Bl -tag -compact -width vfc_refcount
	63	.It vfc_name
	64	the name of the filesystem
	65	.It vfc_typenum
	66	the filesystem type number assigned by the kernel
	67	.It vfc_refcount
	68	the number of active mount points using the filesystem
	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 sysctl 3 ,
	87	.Xr mount 8 ,
	88	.Xr sysctl 8
	89	.Sh HISTORY
	90	A variant of the
	91	.Fn getvfsbyname
	92	function first appeared in
	93	.Fx 2.0 .