svn commit: r271599 - in projects/vxlan: sbin/ifconfig share/man/man4

[Bryan Venteicher]

Author: bryanv
Date: Sun Sep 14 19:34:57 2014
New Revision: 271599
URL: http://svnweb.freebsd.org/changeset/base/271599

Log:
  Add vxlan examples and fix some minor issues

Modified:
  projects/vxlan/sbin/ifconfig/ifconfig.8
  projects/vxlan/share/man/man4/vxlan.4

Modified: projects/vxlan/sbin/ifconfig/ifconfig.8
==============================================================================
--- projects/vxlan/sbin/ifconfig/ifconfig.8	Sun Sep 14 18:55:48 2014	(r271598)
+++ projects/vxlan/sbin/ifconfig/ifconfig.8	Sun Sep 14 19:34:57 2014	(r271599)
@@ -2495,7 +2495,7 @@ The following parameters are used to con
 interfaces.
 .Bl -tag -width indent
 .It Cm vni Ar identifier
-This value is a 16-bit VXLAN Network Identifier (VNI) that identifies the
+This value is a 24-bit VXLAN Network Identifier (VNI) that identifies the
 virtual network segment membership of the interface.
 .It Cm local Ar address
 The source address used in the encapsulating IPv4/IPv6 header.
@@ -2540,7 +2540,7 @@ The maximum number of entries in the for
 The default is 2000.
 .It Cm vxlandev Ar dev
 When the interface is configured in multicast mode, the 
-.Ar Cm dev
+.Cm dev
 interface is used to transmit IP multicast packets.
 .It Cm ttl Ar ttl
 The TTL used in the encapsulating IPv4/IPv6 header.

Modified: projects/vxlan/share/man/man4/vxlan.4
==============================================================================
--- projects/vxlan/share/man/man4/vxlan.4	Sun Sep 14 18:55:48 2014	(r271598)
+++ projects/vxlan/share/man/man4/vxlan.4	Sun Sep 14 19:34:57 2014	(r271599)
@@ -81,7 +81,7 @@ driver creates a pseudo Ethernet network
 that supports the usual network
 .Xr ioctl 2 Ns s
 and is thus can be used with
-.Xr ifconfig 8 .
+.Xr ifconfig 8
 like any other Ethernet interface.
 The
 .Nm
@@ -181,7 +181,39 @@ Alternatively, the
 command may be used to reduce the MTU size on the
 .Nm
 interface to allow the encapsulated frame to fit in the
-physical network current MTU.
+current MTU of the physical network.
+.Sh EXAMPLES
+Create a
+.Nm
+interface in unicast mode
+with the
+.Cm local
+tunnel address of 192.168.100.1,
+and the
+.Cm remote
+tunnel address of 192.168.100.2.
+.Bd -literal -offset indent
+ifconfig vxlan create vni 108 local 192.168.100.1 remote 192.168.100.2
+.Ed
+.Pp
+Create a
+.Nm
+interface in multicast mode,
+with the
+.Cm local
+address of 192.168.10.95,
+and the
+.Cm group
+address of 224.0.2.6.
+The em0 interface will be used to transmit multicast packets.
+.Bd -literal -offset indent
+ifconfig vxlan create vni 42 local 192.168.10.95 group 224.0.2.6 vxlandev em0
+.Ed
+.Pp
+Once created, the
+.Nm
+interface can be configured with
+.Xr ifconfig 8 .
 .Sh SEE ALSO
 .Xr ifconfig 8 ,
 .Xr inet 4 ,