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