release/src/router/vlan/vconfig.8

   1 .TH VCONFIG 8
   2 .\" NAME should be all caps, SECTION should be 1-8, maybe w/ subsection
   3 .\" other parms are allowed: see man(7), man(1)
   4 .SH NAME
   5 vconfig \- VLAN (802.1q) configuration program.
   6 .SH SYNOPSIS
   7 .B vconfig
   8 .I [lots of long options]
   9 .SH "DESCRIPTION"
  10 The
  11 .B vconfig
  12 program allows you to create and remove vlan\-devices on a vlan enabled
  13 kernel. Vlan\-devices are virtual ethernet devices which represents the
  14 virtual lans on the physical lan.
  15 .SH OPTIONS
  16 .TP
  17 .B add [interface\-name] [vlan\-id]
  18 Creates a vlan-device on [interface\-name]. The resulting vlan\-device
  19 will be called according to the nameing convention set.
  20 .TP
  21 .B rem [vlan\-device]
  22 Removes the named vlan\-device.
  23 .TP
  24 .B set_flag [vlan\-device] 0 | 1
  25 When 1, ethernet header reorders are turned on. Dumping the device
  26 will appear as a common ethernet device without vlans. When 0(default)
  27 however, ethernet headers are not reordered, which results in vlan tagged
  28 packets when dumping the device. Usually the default gives no problems,
  29 but some packet filtering programs might have problems with it.
  30 .TP
  31
  32 .B set_egress_map [vlan\-device] [skb\-priority] [vlan\-qos]
  33 This flags that outbound packets with a particular skb\-priority should
  34 be tagged with the particular vlan priority vlan\-qos. The default vlan
  35 priority is 0.
  36 .TP
  37
  38 .B set_ingress_map [vlan\-device] [skb\-priority] [vlan\-qos]
  39 This flags that inbound packets with the particular vlan priority
  40 vlan\-qos should be queued with a particular skb\-priority. The default
  41 skb\-priority is 0.
  42 .TP
  43
  44 .B set_name_type VLAN_PLUS_VID | VLAN_PLUS_VID_NO_PAD | DEV_PLUS_VID | DEV_PLUS_VID_NO_PAD
  45 Sets the way vlan\-device names are created. Use vconfig without arguments
  46 to see the different formats.
  47 .TP
  48
  49 .SH NOTES
  50 VLAN will use Broadcom's NICE interface when the network device supports
  51 it. This is necessary, since usually the hardware of these devices already
  52 removes the vlan tag from the ethernet packet. The set_flag option on
  53 vlan\-devices created on such a physical network device will be ignored.
  54 Dumping the network\-device will show only untagged(non-vlan) traffic,
  55 and dumping the vlan\-devices will only show traffic intended for that
  56 vlan, without the tags.
  57 .br
  58 .SH FILES
  59 .I /proc/net/vlan/config
  60 .br
  61 .I /proc/net/vlan/[vlan\-device]
  62
  63 .SH SEE ALSO
  64 ip(8), ifconfig(8)
  65 .SH AUTHORS
  66 This manual page was written by Ard van Breemen <ard@kwaak.net>
  67 .br
  68 The vlan patch is written by Ben Greear <greearb@candelatech.com>