add section on VM networking. more to come, this is a starting point for

further documentation.

diff --git a/usr.sbin/vmctl/vmctl.8 b/usr.sbin/vmctl/vmctl.8
index 64b4ad5..e1f5f5f 100644 (file)
--- a/usr.sbin/vmctl/vmctl.8
+++ b/usr.sbin/vmctl/vmctl.8
@@ -1,4 +1,4 @@
-.\"    $OpenBSD: vmctl.8,v 1.10 2016/01/03 23:03:30 mlarkin Exp $
+.\"    $OpenBSD: vmctl.8,v 1.11 2016/08/18 00:06:32 mlarkin Exp $
 .\"
 .\" Copyright (c) 2015 Mike Larkin <mlarkin@openbsd.org>
 .\"
@@ -14,7 +14,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: January 3 2016 $
+.Dd $Mdocdate: August 18 2016 $
 .Dt VMCTL 8
 .Os
 .Sh NAME
@@ -110,6 +110,24 @@ The VMM subsystem could not be enabled or disabled as requested.
 .It
 A requested VM-based operation could not be completed.
 .El
+.Sh VM NETWORKING
+If the -i option is specified during VM start, a corresponding number
+of host-side
+.Xr tap 4
+interfaces will be allocated and mapped to the
+.Xr vio 4
+interfaces inside the guest VM. This
+.Xr tap 4 /
+.Xr vio 4
+interface mapping allows guest network traffic to be manipulated by
+the host. Any valid host-side interface configuration may be performed
+on these
+.Xr tap 4
+interfaces, such as bridging (via
+.Xr bridge 4
+), or using
+.Xr pf 4
+nat-to rules to create private or host-side NATed networks, as desired.
 .Sh EXAMPLES
 Create a 4.5 Gigabyte disk image, disk.img:
 .Dl $ vmctl create disk.img -s 4.5G
@@ -126,7 +144,11 @@ Terminate VM number 1:
 .Xr vmm 4 ,
 .Xr vm.conf 5 ,
 .Xr rc.conf 8 ,
-.Xr vmd 8
+.Xr vmd 8 ,
+.Xr vio 4 ,
+.Xr tap 4 ,
+.Xr bridge 4 ,
+.Xr pf 4
 .Sh HISTORY
 The
 .Nm