Grammar nits & some mdoc fixes, i.e. use ``.Nm fec<RET>node'' consistently

throughout the manpage text.

Reviewed by:	wpaul
This commit is contained in:
Giorgos Keramidas 2006-03-05 15:56:22 +00:00
parent c6ec022631
commit 96aaf2102c

View File

@ -35,47 +35,53 @@
.Sh DESCRIPTION .Sh DESCRIPTION
The The
.Nm fec .Nm fec
node implements Ethernet port trunking using Cisco Fast EtherChannel protocol. node implements Ethernet port trunking using the
Upon creation, node creates a network interface associated with it. .Dq Cisco Fast EtherChannel
protocol.
Upon creation, a
.Nm fec
node creates a network interface associated with it.
Interfaces are named Interfaces are named
.Dq Li fec0 , .Dq Li fec0 ,
.Dq Li fec1 , .Dq Li fec1 ,
etc. etc.
New node takes first available unit. New nodes take the first available unit.
.Sh HOOKS .Sh HOOKS
The The
.Nm fec .Nm fec
node accepts any hooks. node accepts any hooks.
However it does not use them. However it does not use them.
Under normal operation, node should not have any hooks. Under normal operation, a
.Nm fec
node should not have any hooks.
.Sh CONTROL MESSAGES .Sh CONTROL MESSAGES
Interface membership in the FEC group is configured with the following Interface membership in the FEC group is configured with the following
control messages: control messages:
.Bl -tag -width indent .Bl -tag -width indent
.It Dv NGM_FEC_ADD_IFACE Pq Dq Li add_iface .It Dv NGM_FEC_ADD_IFACE Pq Dq Li add_iface
Attach interface to the FEC group. Attach interface to the FEC group.
Target interface name is passed as a string argument. The target interface name is passed as a string argument.
.It Dv NGM_FEC_DEL_IFACE Pq Dq Li del_iface .It Dv NGM_FEC_DEL_IFACE Pq Dq Li del_iface
Remove interface from the trunk. Remove interface from the trunk.
Target interface name is passed as a string argument. The target interface name is passed as a string argument.
.El .El
.Pp .Pp
The following control messages define forwarding method for a node: The following control messages define the forwarding method for a node:
.Bl -tag -width indent .Bl -tag -width indent
.It Dv NGM_FEC_MODE_INET Pq Dq Li set_mode_mac .It Dv NGM_FEC_MODE_INET Pq Dq Li set_mode_mac
Forwarding decisions will be made on destination link layer MAC addresses. Forwarding decisions will be based on the link-layer MAC address of the destination.
.It Dv NGM_FEC_MODE_MAC Pq Dq Li set_mode_inet .It Dv NGM_FEC_MODE_MAC Pq Dq Li set_mode_inet
Forwarding decisions will be made on destination IP addresses. Forwarding decisions will be based on the IP address of the destination.
.El .El
.Sh SHUTDOWN .Sh SHUTDOWN
This node shuts down upon receipt of a This node shuts down upon receipt of a
.Dv NGM_SHUTDOWN .Dv NGM_SHUTDOWN
control message. control message.
.Sh EXAMPLES .Sh EXAMPLES
This example script creates a The following example script creates an
.Nm fec .Nm fec
node, attaches four Ethernet interfaces to it and node, attaches four Ethernet interfaces to it and
sets forwarding method based on IP address: sets the forwarding method to be IP-address based:
.Bd -literal -offset indent .Bd -literal -offset indent
/usr/sbin/ngctl -f- <<-SEQ /usr/sbin/ngctl -f- <<-SEQ
mkpeer fec dummy fec mkpeer fec dummy fec
@ -100,4 +106,4 @@ The
node was written by node was written by
.An "Bill Paul" Aq wpaul@FreeBSD.org . .An "Bill Paul" Aq wpaul@FreeBSD.org .
This manual page was written by This manual page was written by
.An "Gleb Smirnoff" . .An "Gleb Smirnoff" Aq glebius@FreeBSD.org .