Skip to content

Commit ea4a7b8

Browse files
author
fair
committed
Clean up nroff issues. Add more mdoc macro use.
Clarify wording and grammar. Add an EXAMPLE section per PR 17863
1 parent 82a09af commit ea4a7b8

File tree

1 file changed

+92
-21
lines changed

1 file changed

+92
-21
lines changed

share/man/man4/vlan.4

Lines changed: 92 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.\" $NetBSD: vlan.4,v 1.22 2003/04/16 09:59:40 wiz Exp $
1+
.\" $NetBSD: vlan.4,v 1.23 2003/05/07 03:33:49 fair Exp $
22
.\"
33
.\" Copyright (c) 2000 The NetBSD Foundation, Inc.
44
.\" All rights reserved.
@@ -34,7 +34,7 @@
3434
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
3535
.\" POSSIBILITY OF SUCH DAMAGE.
3636
.\"
37-
.Dd March 19, 2003
37+
.Dd May 6, 2003
3838
.Dt VLAN 4
3939
.Os
4040
.Sh NAME
@@ -45,40 +45,67 @@
4545
.Sh DESCRIPTION
4646
The
4747
.Nm
48-
interface provides support for IEEE 802.1Q Virtual LANs. This allows the
48+
interface provides support for
49+
.Tn IEEE
50+
802.1Q Virtual Local Area Networks
51+
.Pq Tn VLAN .
52+
This supports the
4953
trunking of more than one network on a single network interface.
5054
This is particularly useful on routers or on hosts which must be
51-
connected to many different networks.
55+
connected to many different networks through a single physical interface.
5256
.Pp
5357
To use a
5458
.Nm vlan
5559
interface, the administrator must first create the interface and then
56-
specify the VLAN tag and physical interface associated with the VLAN.
60+
specify the
61+
.Tn VLAN
62+
tag
63+
.Po
64+
a 16-bit integer which distinguishes each
65+
.Tn VLAN
66+
from any others
67+
.Pc
68+
and physical interface associated with the
69+
.Tn VLAN .
5770
This can be done by using the
5871
.Xr ifconfig 8
59-
.Sq create ,
60-
.Sq vlan ,
72+
.Ic create ,
73+
.Ic vlan ,
6174
and
62-
.Sq vlanif
63-
subcommands, or
75+
.Ic vlanif
76+
subcommands from a shell command line or script.
77+
From within a C program, use the
78+
.Xr ioctl 2
79+
system call with the
6480
.Dv SIOCSIFCREATE
6581
and
6682
.Dv SIOCSIFVLAN
67-
ioctls.
83+
arguments.
6884
.Pp
69-
To be compatible with others 802.1Q devices, the
85+
To be compatible with other
86+
.Tn IEEE
87+
802.1Q devices, the
7088
.Nm
71-
interface shall support a 1500 bytes MTU, which means that the parent
72-
interface will have to handle frames that are 4 bytes larger than the
73-
Ethernet MTU. Drivers supporting this increased MTU are:
89+
interface supports a 1500 byte
90+
.Tn MTU ,
91+
which means that the parent interface will have to handle packets
92+
that are 4 bytes larger than the original
93+
.Tn Ethernet
94+
standard.
95+
Drivers supporting this increased
96+
.Tn MTU
97+
are:
7498
.Pp
7599
.Bl -dash -compact
76100
.It
77-
drivers using the dp8390 core (such as
101+
drivers using the DP8390 core
102+
.Po
103+
such as
78104
.Xr ec 4 ,
79105
.Xr ne 4 ,
80106
.Xr we 4 ,
81-
and possibly others)
107+
and possibly others
108+
.Pc
82109
.It
83110
.Xr bge 4
84111
.It
@@ -116,10 +143,51 @@ and possibly others)
116143
.El
117144
.Pp
118145
.Nm
119-
can be used with devices not supporting the 802.1Q MTU, but then the MTU of the
146+
can be used with devices not supporting the
147+
.Tn IEEE
148+
802.1Q
149+
.Tn MTU ,
150+
but then the
151+
.Tn MTU
152+
of the
120153
.Nm
121-
interface will be 4 bytes too small and will not interoperate properly with
122-
other 802.1Q devices, unless the MTU of the remote end is also lowered.
154+
interface will be 4 bytes too small and will not interoperate
155+
properly with other
156+
.Tn IEEE
157+
802.1Q devices, unless the
158+
.Tn MTU
159+
of the other hosts on the
160+
.Tn VLAN
161+
are also lowered to match.
162+
.Sh EXAMPLES
163+
The following will create interface
164+
.Sy vlan0
165+
with
166+
.Tn VLAN
167+
tag six, on the
168+
.Tn Ethernet
169+
interface
170+
.Sy tlp0 :
171+
.Bd -literal -offset indent
172+
ifconfig vlan0 create
173+
ifconfig vlan0 vlan 6 vlanif tlp0
174+
.Ed
175+
.Pp
176+
After this set up,
177+
.Tn IP
178+
addresses (and/or other protocols) can be assigned to the
179+
.Sy vlan0
180+
interface.
181+
All other hosts on the
182+
.Tn Ethernet
183+
connected to
184+
.Sy tlp0
185+
which configure a
186+
.Tn VLAN
187+
and use
188+
.Tn VLAN
189+
tag six will see all traffic transmitted through
190+
.Sy vlan0 .
123191
.Sh SEE ALSO
124192
.Xr ifconfig 8
125193
.Sh HISTORY
@@ -136,12 +204,15 @@ driver was integrated by
136204
and
137205
.An Jason R. Thorpe
138206
.Aq thorpej@zembu.com .
139-
It was derived from a VLAN implementation that appeared in
207+
It was derived from a
208+
.Tn VLAN
209+
implementation that appeared in
140210
.Fx
141211
and
142212
.Ox .
143213
.Sh BUGS
144214
The
145215
.Nm
146216
interfaces do not currently inherit changes made to the physical
147-
interfaces's MTU.
217+
interfaces'
218+
.Tn MTU .

0 commit comments

Comments
 (0)