svn commit: r245348 - projects/vmxnet/share/man/man4

[Bryan Venteicher]

Author: bryanv
Date: Sat Jan 12 23:46:12 2013
New Revision: 245348
URL: http://svnweb.freebsd.org/changeset/base/245348

Log:
  Adapt the vic(4) man page from OpenBSD
  
  Approved by:	grehan (implicit)

Added:
  projects/vmxnet/share/man/man4/vic.4   (contents, props changed)
Modified:
  projects/vmxnet/share/man/man4/Makefile

Modified: projects/vmxnet/share/man/man4/Makefile
==============================================================================
--- projects/vmxnet/share/man/man4/Makefile	Sat Jan 12 23:44:13 2013	(r245347)
+++ projects/vmxnet/share/man/man4/Makefile	Sat Jan 12 23:46:12 2013	(r245348)
@@ -524,6 +524,7 @@ MAN=	aac.4 \
 	vge.4 \
 	viapm.4 \
 	${_viawd.4} \
+	${_vic.4} \
 	vinum.4 \
 	${_virtio.4} \
 	${_virtio_balloon.4} \
@@ -775,6 +776,7 @@ _spkr.4=	spkr.4
 _tpm.4=		tpm.4
 _urtw.4=	urtw.4
 _viawd.4=	viawd.4
+_vic.4=		vic.4
 _wbwd.4=	wbwd.4
 _wpi.4=		wpi.4
 _xen.4=		xen.4

Added: projects/vmxnet/share/man/man4/vic.4
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ projects/vmxnet/share/man/man4/vic.4	Sat Jan 12 23:46:12 2013	(r245348)
@@ -0,0 +1,120 @@
+.\"	$OpenBSD: src/share/man/man4/vic.4,v 1.21 2008/07/28 19:52:21 brad Exp $
+.\"
+.\" Copyright (c) 2006 Reyk Floeter <reyk at openbsd.org>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd January 12, 2013
+.Dt VIC 4
+.Os
+.Sh NAME
+.Nm vic
+.Nd VMware VMXnet Virtual Interface Controller device
+.Sh SYNOPSIS
+To compile this driver into the kernel,
+place the following line in your
+kernel configuration file:
+.Bd -ragged -offset indent
+.Cd "device vic"
+.Ed
+.Pp
+Alternatively, to load the driver as a
+module at boot time, place the following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+if_vic_load="YES"
+.Ed
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for the VMXnet virtual NIC available in virtual
+machines by VMware.
+It appears as a simple Ethernet device but is actually a virtual network
+interface to the underlying host operating system.
+.Pp
+This driver supports the
+.Ic vmxnet
+driver protocol, as an alternative to the emulated
+.Xr pcn 4
+and
+.Xr em 4
+interfaces also available in the VMware environment.
+The
+.Nm vic
+driver is optimized for the virtual machine, it can provide advanced
+capabilities depending on the underlying host operating system and
+the physical network interface controller of the host.
+.Pp
+The
+.Nm
+driver supports VMware virtual NICs provided by the following products:
+.Pp
+.Bl -bullet -compact -offset indent
+.It
+VMware ESX 2.0 and newer
+.It
+VMware GSX 2.5 and newer
+.It
+VMware Server 1.0 and newer
+.It
+VMware Workstation 4.5 and newer
+.It
+VMware Fusion 1.0 and newer
+.El
+.Pp
+The
+.Nm
+driver supports the following media types:
+.Bl -tag -width autoselect
+.It autoselect
+Enable autoselection of the media type and options.
+The driver always uses the fastest available speed and the media
+options provided by the underlying host of the virtual machine.
+.El
+.Pp
+For more information on configuring this device, see
+.Xr ifconfig 8 .
+.Sh EXAMPLES
+The following entry must be added to the VMware configuration file
+to provide the
+.Nm
+device:
+.Bd -literal -offset indent
+ethernet0.virtualDev = "vmxnet"
+.Ed
+.Sh SEE ALSO
+.Xr arp 4 ,
+.Xr em 4 ,
+.Xr ifconfig 8 ,
+.Xr netintro 4 ,
+.Xr pcn 4 ,
+.Xr vlan 4
+.Sh AUTHORS
+.An -nosplit
+The
+.Nm
+driver was ported from
+.Ox
+by
+.An Bryan Venteicher Aq bryanv at freebsd.org .
+The
+.Ox
+driver was written by
+.An Reyk Floeter Aq reyk at openbsd.org
+and
+.An David Gwynne Aq dlg at openbsd.org .
+.Sh BUGS
+There are tons of bugs in VMware and the underlying host operating systems.
+Please consider that the security of the
+.Fx
+guest can be circumvented by attacking the host environment.