summaryrefslogtreecommitdiffstats
path: root/sbin/etherswitchcfg/etherswitchcfg.8
diff options
context:
space:
mode:
authorbrueffer <brueffer@FreeBSD.org>2014-02-11 13:33:03 +0000
committerbrueffer <brueffer@FreeBSD.org>2014-02-11 13:33:03 +0000
commit222b98b9ae0d7434909f1e5b43c52840864d3112 (patch)
treea64dd88cad66fa6384928ac6f1da339501ca2842 /sbin/etherswitchcfg/etherswitchcfg.8
parent3e89ba0a6aa0b081596853f06081c29c66790242 (diff)
downloadFreeBSD-src-222b98b9ae0d7434909f1e5b43c52840864d3112.zip
FreeBSD-src-222b98b9ae0d7434909f1e5b43c52840864d3112.tar.gz
MFC: r261500
Add a license (1) and do some cleanup. Approved by: Stefan Bethke (original author, by private mail) (1)
Diffstat (limited to 'sbin/etherswitchcfg/etherswitchcfg.8')
-rw-r--r--sbin/etherswitchcfg/etherswitchcfg.840
1 files changed, 36 insertions, 4 deletions
diff --git a/sbin/etherswitchcfg/etherswitchcfg.8 b/sbin/etherswitchcfg/etherswitchcfg.8
index 9cdbdd6..c5b93e9 100644
--- a/sbin/etherswitchcfg/etherswitchcfg.8
+++ b/sbin/etherswitchcfg/etherswitchcfg.8
@@ -1,4 +1,29 @@
+.\" Copyright (c) 2011-2012 Stefan Bethke.
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
.\" $FreeBSD$
+.\"
.Dd September 20, 2013
.Dt ETHERSWITCHCFG 8
.Os
@@ -35,13 +60,14 @@ The
utility is used to configure an Ethernet switch built into the system.
.Nm
accepts a number of options:
+.Pp
.Bl -tag -width ".Fl f" -compact
.It Fl "f control file"
Specifies the
.Xr etherswitch 4
control file that represents the switch to be configured.
It defaults to
-.Li /dev/etherswitch0 .
+.Pa /dev/etherswitch0 .
.It Fl m
When reporting port information, also list available media options for
that port.
@@ -54,6 +80,7 @@ options are omitted.
The config command provides access to global switch configuration
parameters.
It support the following commands:
+.Pp
.Bl -tag -width ".Ar vlan_mode mode" -compact
.It Ar vlan_mode mode
Sets the switch VLAN mode (depends on the hardware).
@@ -74,6 +101,7 @@ To set the register value, use the form instance.register=value.
.Ss port
The port command selects one of the ports of the switch.
It supports the following commands:
+.Pp
.Bl -tag -width ".Ar pvid number" -compact
.It Ar pvid number
Sets the default port VID that is used to process incoming frames that are not tagged.
@@ -88,8 +116,10 @@ for details on
and
.Ar mediaopt .
.El
+.Pp
And the following flags (please note that not all flags
-are supporterd by all switch drivers):
+are supported by all switch drivers):
+.Pp
.Bl -tag -width ".Ar addtag" -compact
.It Ar addtag
Add VLAN tag to each packet sent by the port.
@@ -100,7 +130,7 @@ Strip the VLAN tags from the packets sent by the port.
.It Ar -striptag
Disable the strip VLAN tag option.
.It Ar firstlock
-This options makes the switch port lock on the first MAC address it seems.
+This options makes the switch port lock on the first MAC address it sees.
After that, usually you need to reset the switch to learn different
MAC addresses.
.It Ar -firstlock
@@ -125,6 +155,7 @@ The reg command provides access to the registers of the switch controller.
.Ss vlangroup
The vlangroup command selects one of the VLAN groups for configuration.
It supports the following commands:
+.Pp
.Bl -tag -width ".Ar vlangroup" -compact
.It Ar vlan VID
Sets the VLAN ID (802.1q VID) for this VLAN group.
@@ -142,13 +173,14 @@ to indicate that frames on this port are tagged.
.Sh FILES
.Bl -tag -width /dev/etherswitch? -compact
.It Pa /dev/etherswitch?
-Control file for the ethernet switch driver.
+Control file for the Ethernet switch driver.
.El
.Sh EXAMPLES
Configure VLAN group 1 with a VID of 2 and make ports 0 and 5 its members
while excluding all other ports.
Port 5 will send and receive tagged frames while port 0 will be untagged.
Incoming untagged frames on port 0 are assigned to vlangroup1.
+.Pp
.Dl # etherswitchcfg vlangroup1 vlan 2 members 0,5t port0 pvid 2
.Sh SEE ALSO
.Xr etherswitch 4
OpenPOWER on IntegriCloud