Move ef.4 from sys/net/ef to share/man/man4.
[dragonfly.git] / share / man / man4 / ef.4
1 .\"
2 .\" Copyright (c) 1999, Boris Popov
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\"
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 .\" SUCH DAMAGE.
25 .\"
26 .\" $FreeBSD: src/sys/modules/if_ef/ef.4,v 1.1.2.2 2001/12/20 17:23:13 ru Exp $
27 .\" $DragonFly: src/share/man/man4/ef.4,v 1.1 2005/11/22 09:36:58 swildner Exp $
28 .\"
29 .Dd June 20, 1999
30 .Dt EF 4
31 .Os
32 .Sh NAME
33 .Nm ef
34 .Nd "pseudo-device driver providing support for multiple ethernet frame types"
35 .Sh SYNOPSIS
36 .Cd "pseudo-device ef"
37 .Sh DESCRIPTION
38 The
39 .Nm
40 pseudo-device driver clones each ethernet type device with four
41 additional interfaces. Each of them capable to send or receive only
42 one predefined frame type.
43 .Pp
44 Names for the new interfaces created by adding
45 .Ar fN
46 suffix to an existing device name. Where
47 .Ar N
48 is a device unit which can have one of the following values:
49 .Bd -literal -offset indent
50 0     interface with an Ethernet_II frame
51 1     interface with a Novell Ethernet_802.3 frame
52 2     interface with an Ethernet_802.2 frame
53 3     interface with an Ethernet_802.2/SNAP frame support.
54 .Ed
55 .Pp
56 For example, device
57 .Ar ed0
58 will be populated with four devices:
59 .Ar ed0f0 ,
60 .Ar ed0f1 ,
61 .Ar ed0f2
62 and
63 .Ar ed0f3 .
64 .Pp
65 After that, each device can be configured as usually:
66 .Dl # ifconfig ed0f1 ipx 0x105
67 This will configure IPX protocol with network number
68 .Ar 0x105
69 and
70 .Ar Ethernet_802.3
71 frame type.
72 .Pp
73 Please note that it is impossible to configure IPX protocol on the 'raw'
74 .Ar ed0
75 device after
76 .Ar if_ef.ko
77 driver loaded.
78 .Sh EXAMPLES
79 The
80 .Nm
81 driver can be loaded via
82 .Xr loader.conf 5
83 file:
84 .Dl if_ef_load="YES"
85 .Pp
86 In this case an ordinary interface configuration commands can be used
87 in the
88 .Xr rc.conf 5
89 file:
90 .Dl network_interfaces="ed2 lo0 tun0 ed2f0 ed2f1"
91 .Dl ifconfig_ed2f0_ipx="ipx 0x101"
92 .Dl ifconfig_ed2f1_ipx="ipx 0x102"
93 .Sh DIAGNOSTICS
94 None.
95 .Sh CAVEATS
96 Avoid to configuring 'raw' ethernet device for IPX protocol after
97 .Nm
98 driver is loaded.
99 .Sh SEE ALSO
100 .Xr ipx 3 ,
101 .Xr ifconfig 8
102 .Sh AUTHORS
103 .An Boris Popov Aq bp@FreeBSD.org .