xref: /netbsd-src/share/man/man4/vio9p.4 (revision 6f8dc1509fa98d2f403ca646d8d47b18bead7044)
1.\" $NetBSD: vio9p.4,v 1.4 2021/10/21 13:21:53 andvar Exp $
2.\"
3.\" Copyright (c) 2019 Internet Initiative Japan, Inc.
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.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
16.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
19.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25.\" POSSIBILITY OF SUCH DAMAGE.
26.\"
27.Dd October 24, 2019
28.Dt VIO9P 4
29.Os
30.Sh NAME
31.Nm vio9p
32.Nd VirtIO 9p front-end driver
33.Sh SYNOPSIS
34.Cd "vio9p* at virtio?"
35.Sh DESCRIPTION
36In conjunction with
37.Xr mount_9p 8 ,
38the
39.Nm
40driver enables a
41.Nx
42system running as a VM guest to mount an exported file system
43by the host via virtio-9p.
44It exports a 9p end-point of virtio-9p via a character device file for
45.Xr mount_9p 8 .
46.Pp
47Each exported file system is assigned a character device and accessible via
48.Pa /dev/vio9p0 ,
49.Pa /dev/vio9p1
50and so on, respectively, in exporting order by the host.
51.Sh FILES
52.Bl -tag -width XdevXvio9pX -compact
53.It Pa /dev/vio9p?
54.El
55.Sh EXAMPLES
56The following command mounts the first exported file system by the host at
57.Pa /mnt/9p :
58.Bd -literal -offset indent
59# mount_9p -cu /dev/vio9p0 /mnt/9p
60.Ed
61.Sh SEE ALSO
62.Xr virtio 4 ,
63.Xr mount_9p 8
64.Sh HISTORY
65The
66.Nm
67driver first appeared in
68.Nx 10.0 .
69.Sh AUTHORS
70The
71.Nm
72driver was written by
73.An Ryota Ozaki Aq Mt ozaki-r@iij.ad.jp .
74