xref: /openbsd/share/man/man4/vether.4 (revision fc61954a)
1.\"	$OpenBSD: vether.4,v 1.4 2014/01/20 05:07:49 schwarze Exp $
2.\"
3.\" Copyright (c) 2009 Theo de Raadt <deraadt@openbsd.org>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: January 20 2014 $
18.Dt VETHER 4
19.Os
20.Sh NAME
21.Nm vether
22.Nd virtual Ethernet interface
23.Sh SYNOPSIS
24.Cd "pseudo-device vether"
25.Sh DESCRIPTION
26The
27.Nm
28interface simulates a normal Ethernet interface by encapsulating
29standard network frames with an Ethernet header, specifically
30for use as a member in a
31.Xr bridge 4 .
32.Pp
33To use
34.Nm
35the administrator needs to configure an address onto the interface
36so that packets can be routed to it.
37An Ethernet header will be prepended and, if the
38.Nm
39interface is a member of a
40.Xr bridge 4 ,
41the frame will show up there.
42.Sh SEE ALSO
43.Xr bridge 4 ,
44.Xr inet 4 ,
45.Xr inet6 4 ,
46.Xr hostname.if 5 ,
47.Xr ifconfig 8 ,
48.Xr netstart 8
49.Sh BUGS
50Like
51.Xr tun 4 ,
52the Ethernet address chosen will be partially random, and may
53occasionally collide with another address.
54