xref: /netbsd-src/share/man/man4/vnd.4 (revision 76dfffe33547c37f8bdd446e3e4ab0f3c16cea4b)
1.\"	$NetBSD: vnd.4,v 1.1 1995/12/30 18:10:48 thorpej Exp $
2.\"
3.\" Copyright (c) 1995 Jason R. Thorpe.
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed for the NetBSD Project
17.\"	by Jason R. Thorpe.
18.\" 4. Neither the name of the author nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.Dd December 30, 1995
35.Dt VND 4
36.Os NetBSD
37.Sh NAME
38.Nm vnd
39.Nd Vnode Disk Driver
40.Sh SYNOPSIS
41.Cd "pseudo-device vnd 4"
42.Sh DESCRIPTION
43The
44.Nm
45driver provides a disk-like interface to a file.  This is useful for
46a variety of applications, including swap files and building miniroot
47or floppy disk images.
48.Pp
49This document assumes that you're familiar with how to generate kernels,
50how to properly configure disks and pseudo-devices in a kernel
51configuration file.
52.Pp
53In order to compile in support for the vnd, you must add a line similar
54to the following to your kernel configuration file:
55.Bd -unfilled -offset indent
56pseudo-device	vnd	4	# vnode disk driver
57.Ed
58.Pp
59The count argument is how many
60.Nm vnds
61memory is allocated for a boot time.  In this example, no more than 4
62.Nm vnds
63may be configured.
64.Pp
65There is a run-time utility that is used for configuring
66.Nm vnds .
67See
68.Xr vnconfig 8
69for more information.
70.Sh BUGS
71The
72.Nm
73driver does not work if the file does not reside in a local filesystem.
74.Sh FILES
75/dev/{,r}vnd* - vnd device special files.
76.Pp
77.Sh HISTORY
78The vnode disk driver was originally written at the University of
79Utah.
80.Sh SEE ALSO
81.Xr MAKEDEV 8 ,
82.Xr config 8 ,
83.Xr config.old 8 ,
84.Xr fsck 8 ,
85.Xr mount 8 ,
86.Xr newfs 8 ,
87.Xr vnconfig 8 .
88