[iproute2,v2,4/4] Update man page to indicate current options

Message ID 20100210114729.14570.6713.stgit@localhost.localdomain
State Accepted, archived
Delegated to: stephen hemminger
Headers show

Commit Message

Jeff Kirsher Feb. 10, 2010, 11:47 a.m.
From: Williams, Mitch A <mitch.a.williams@intel.com>

Signed-off-by: Mitch Williams <mitch.a.williams@intel.com>
Signed-off-by: Jeff Kirsher <jeffrey.t.kirsher@intel.com>

 man/man8/ip.8 |   73 +++++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 files changed, 70 insertions(+), 3 deletions(-)

To unsubscribe from this list: send the line "unsubscribe netdev" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html


diff --git a/man/man8/ip.8 b/man/man8/ip.8
index ccc800f..3efa045 100644
--- a/man/man8/ip.8
+++ b/man/man8/ip.8
@@ -53,7 +53,23 @@  ip \- show / manipulate routing, devices, policy routing and tunnels
 .IR MTU " |"
 .B  netns
-.IR PID " }"
+.IR PID " |"
+.B alias
+.IR NAME  " |"
+.B vf
+.IR NUM " ["
+.B  mac
+.IR LLADDR " ] ["
+.B vlan
+.IR VLANID " [ "
+.B qos
+.IR VLAN-QOS " ] ] ["
+.B rate
+.IR TXRATE " ]"
+.BR " }"
 .ti -8
 .B ip link show
@@ -822,7 +838,9 @@  display and change the state of devices.
 .BI dev " NAME " (default)
-specifies network device to operate on.
+specifies network device to operate on. When configuring SR-IOV Virtual Fuction
+(VF) devices, this keyword should specify the associated Physical Function (PF)
 .BR up " and " down
@@ -884,7 +902,56 @@  the interface is
 .BI netns " PID"
 move the device to the network namespace associated with the process
-.IR "PID" .
+.IR "PID".
+.BI alias " NAME"
+give the device a symbolic name for easy reference.
+.BI vf " NUM"
+specify a Virtual Function device to be configured. The associated PF device
+must be specified using the
+.B dev
+.in +8
+- change the station address for the specified VF. The
+.B vf
+parameter must be specified.
+.BI vlan " VLANID"
+- change the assigned VLAN for the specified VF. When specified, all traffic
+sent from the VF will be tagged with the specified VLAN ID. Incoming traffic
+will be filtered for the specified VLAN ID, and will have all VLAN tags
+stripped before being passed to the VF. Setting this parameter to 0 disables
+VLAN tagging and filtering. The
+.B vf
+parameter must be specified.
+.BI qos " VLAN-QOS"
+- assign VLAN QOS (priority) bits for the VLAN tag. When specified, all VLAN
+tags transmitted by the VF will include the specified priority bits in the
+VLAN tag. If not specified, the value is assumed to be 0. Both the
+.B vf
+.B vlan
+parameters must be specified. Setting both
+.B vlan
+.B qos
+as 0 disables VLAN tagging and filtering for the VF.
+.BI rate " TXRATE"
+- change the allowed transmit bandwidth, in Mbps, for the specified VF.
+Setting this parameter to 0 disables rate limiting. The
+.B vf
+parameter must be specified.
+.in -8
 .B Warning: