Page Menu
Home
FreeBSD
Search
Configure Global Search
Log In
Files
F133138843
D10014.id26606.diff
No One
Temporary
Actions
View File
Edit File
Delete File
View Transforms
Subscribe
Mute Notifications
Flag For Later
Award Token
Size
3 KB
Referenced Files
None
Subscribers
None
D10014.id26606.diff
View Options
Index: bhyve/bhyve.8
===================================================================
--- bhyve/bhyve.8
+++ bhyve/bhyve.8
@@ -24,7 +24,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd February 27, 2017
+.Dd March 15, 2017
.Dt BHYVE 8
.Os
.Sh NAME
@@ -49,10 +49,13 @@
Parameters such as the number of virtual CPUs, amount of guest memory, and
I/O connectivity can be specified with command-line parameters.
.Pp
-The guest operating system must be loaded with
+If not using a boot ROM, the guest operating system must be loaded with
.Xr bhyveload 8
or a similar boot loader before running
-.Nm .
+.Nm ,
+otherwise, it is enough to run
+.Nm
+with a boot ROM of choice.
.Pp
.Nm
runs until the guest operating system reboots or an unhandled hypervisor
@@ -188,6 +191,10 @@
.It Li lpc
LPC PCI-ISA bridge with COM1 and COM2 16550 serial ports and a boot ROM.
The LPC bridge emulation can only be configured on bus 0.
+.It Li fbuf
+Framebuffer device.
+.It Li xhci
+eXtensible Host Controller Interface (xHCI) USB controller.
.El
.It Op Ar conf
This optional parameter describes the backend for device emulations.
@@ -299,6 +306,74 @@
Emergency write is advertised, but no-op as of now.
.El
.El
+.Pp
+Framebuffer devices:
+.Bl -tag -width 10n
+.It rfb= Ns Ar host:port Ns Oo , Ns w= Ns Ar width Ns ,h= Ns Ar height Oc Ns Oo ,vga= Ns Ar vgaconf Oc Ns Oo Ns ,wait Oc
+.Bl -tag -width 8n
+.It Ar host:port
+A
+.Ar host
+and a
+.Ar port
+VNC should listen on.
+.It Ar width No and Ar height
+A display resolution, width and height, respectively.
+If not specified, a default resolution of 1024x768 pixels will be used.
+Minimal supported resolution is 640x480 pixels.
+.It Ar vgaconf
+Possible values for this option are
+.Dq io
+(default),
+.Dq on
+, and
+.Dq off Ns
+\&.
+PCI graphics cards have a dual personality in that they are
+standard PCI devices with BAR addressing, but may also
+implicitly decode legacy VGA I/O space
+.Pq Ad 0x3c0-3df
+and memory space
+.Pq 64KB at Ad 0xA0000 Ns
+\&. The default
+.Dq io
+option should be used for the guests that attempt to issue BIOS
+calls which result in I/O port queries, and fail to boot if I/O decode is disabled.
+.br
+The
+.Dq on
+option should be used along with the CSM BIOS capability in UEFI
+to boot traditional BIOS guests, so that complete I/O and memory decode
+is present.
+.br
+The
+.Dq off
+option should be used for the UEFI guests that assume that
+VGA adapter is present if they detect the I/O ports.
+An example of such a guest is
+.Ox
+in UEFI mode.
+.br
+Please refer to the
+.Nm
+.Fx
+wiki page (https://wiki.freebsd.org/bhyve)
+for configuration notes of particular guests.
+.It wait
+Instruct
+.Nm
+to only boot upon the initiation of a VNC connection, simplifying the installation
+of operating systems that require immediate keyboard input.
+This can be removed for post-installation use.
+.El
+.El
+.Pp
+xHCI USB devices:
+.Bl -tag -width 10n
+.It Li tablet
+A USB tablet device which provides precise cursor synchronization
+when using VNC.
+.El
.El
.It Fl S
Wire guest memory.
@@ -347,11 +422,12 @@
triple fault
.El
.Sh EXAMPLES
-The guest operating system must have been loaded with
+If not using a boot ROM, the guest operating system must have been loaded with
.Xr bhyveload 8
or a similar boot loader before
.Xr bhyve 4
can be run.
+Otherwise, boot loader is not needed.
.Pp
To run a virtual machine with 1GB of memory, two virtual CPUs, a virtio
block device backed by the
@@ -389,6 +465,21 @@
-l com1,/dev/nmdm0A \\
-A -H -P -m 8G
.Ed
+.Pp
+Run an UEFI virtual machine with a display resolution of 800 by 600 pixels
+that can be accessed via VNC at: 0.0.0.0:5900.
+.Bd -literal -offset indent
+bhyve -c 2 -m 4G -w -H \\
+ -s 0,hostbridge \\
+ -s 3,ahci-cd,/path/to/uefi-OS-install.iso \\
+ -s 4,ahci-hd,disk.img \\
+ -s 5,virtio-net,tap0 \\
+ -s 29,fbuf,tcp=0.0.0.0:5900,w=800,h=600,wait \\
+ -s 30,xhci,tablet \\
+ -s 31,lpc -l com1,stdio \\
+ -l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI.fd \\
+ uefivm
+.Ed
.Sh SEE ALSO
.Xr bhyve 4 ,
.Xr nmdm 4 ,
File Metadata
Details
Attached
Mime Type
text/plain
Expires
Fri, Oct 24, 7:34 AM (18 h, 50 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
24101500
Default Alt Text
D10014.id26606.diff (3 KB)
Attached To
Mode
D10014: bhyve: document fbuf and xhci devices in the manpage
Attached
Detach File
Event Timeline
Log In to Comment