summaryrefslogtreecommitdiffstats
path: root/sbin
diff options
context:
space:
mode:
authoryar <yar@FreeBSD.org>2004-02-21 14:21:18 +0000
committeryar <yar@FreeBSD.org>2004-02-21 14:21:18 +0000
commit44ed42c915c99946ac708aab8960ce671fa01574 (patch)
treeb5a026999f08670bf19f0146b6794aff02df991d /sbin
parent2fbac50c9122d3b5a8630f57facf270add47fcb6 (diff)
downloadFreeBSD-src-44ed42c915c99946ac708aab8960ce671fa01574.zip
FreeBSD-src-44ed42c915c99946ac708aab8960ce671fa01574.tar.gz
We can cross-reference to vlan(4) as long as
the corresponding manpage has been committed. The rest of "vlan" words, which are refering to the technology itself, should be capitalized. MFC after: 1 week
Diffstat (limited to 'sbin')
-rw-r--r--sbin/ifconfig/ifconfig.853
1 files changed, 38 insertions, 15 deletions
diff --git a/sbin/ifconfig/ifconfig.8 b/sbin/ifconfig/ifconfig.8
index ebf9b83..fcf11d1 100644
--- a/sbin/ifconfig/ifconfig.8
+++ b/sbin/ifconfig/ifconfig.8
@@ -377,53 +377,75 @@ Included for
.Tn Solaris
compatibility.
.It Cm vlan Ar vlan_tag
-If the interface is a vlan pseudo interface, set the vlan tag value
+If the interface is a
+.Xr vlan 4
+pseudo interface, set the VLAN tag value
to
.Ar vlan_tag .
This value is a 16-bit number which is used to create an 802.1Q
-vlan header for packets sent from the vlan interface.
+VLAN header for packets sent from the
+.Xr vlan 4
+interface.
Note that
.Cm vlan
and
.Cm vlandev
must both be set at the same time.
.It Cm vlandev Ar iface
-If the interface is a vlan pseudo device, associate physical interface
+If the interface is a
+.Xr vlan 4
+pseudo device, associate physical interface
.Ar iface
with it.
-Packets transmitted through the vlan interface will be
+Packets transmitted through the
+.Xr vlan 4
+interface will be
diverted to the specified physical interface
.Ar iface
-with 802.1Q vlan encapsulation.
+with 802.1Q VLAN encapsulation.
Packets with 802.1Q encapsulation received
-by the parent interface with the correct vlan tag will be diverted to
-the associated vlan pseudo-interface.
-The vlan interface is assigned a
+by the parent interface with the correct VLAN tag will be diverted to
+the associated
+.Xr vlan 4
+pseudo-interface.
+The
+.Xr vlan 4
+interface is assigned a
copy of the parent interface's flags and the parent's ethernet address.
The
.Cm vlandev
and
.Cm vlan
must both be set at the same time.
-If the vlan interface already has
+If the
+.Xr vlan 4
+interface already has
a physical interface associated with it, this command will fail.
To
change the association to another physical interface, the existing
association must be cleared first.
.Pp
Note: if the hardware tagging capability
-is set on the parent interface, the vlan pseudo
+is set on the parent interface, the
+.Xr vlan 4
+pseudo
interface's behavior changes:
-the vlan interface recognizes that the
-parent interface supports insertion and extraction of vlan tags on its
+the
+.Xr vlan 4
+interface recognizes that the
+parent interface supports insertion and extraction of VLAN tags on its
own (usually in firmware) and that it should pass packets to and from
the parent unaltered.
.It Fl vlandev Ar iface
-If the driver is a vlan pseudo device, disassociate the physical interface
+If the driver is a
+.Xr vlan 4
+pseudo device, disassociate the physical interface
.Ar iface
from it.
-This breaks the link between the vlan interface and its parent,
-clears its vlan tag, flags and its link address and shuts the interface down.
+This breaks the link between the
+.Xr vlan 4
+interface and its parent,
+clears its VLAN tag, flags and its link address and shuts the interface down.
.It Cm metric Ar n
Set the routing metric of the interface to
.Ar n ,
@@ -773,6 +795,7 @@ So, such manual deletions are strongly discouraged.
.Sh SEE ALSO
.Xr netstat 1 ,
.Xr netintro 4 ,
+.Xr vlan 4 ,
.\" .Xr eon 5 ,
.Xr rc 8 ,
.Xr routed 8
OpenPOWER on IntegriCloud