Changeset View
Changeset View
Standalone View
Standalone View
usr.sbin/bhyve/bhyve.8
Show All 18 Lines | ||||||||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |||||||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |||||||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |||||||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |||||||||
.\" SUCH DAMAGE. | .\" SUCH DAMAGE. | |||||||||
.\" | .\" | |||||||||
.\" $FreeBSD$ | .\" $FreeBSD$ | |||||||||
.\" | .\" | |||||||||
.Dd December 11, 2018 | .Dd April 22, 2019 | |||||||||
.Dt BHYVE 8 | .Dt BHYVE 8 | |||||||||
.Os | .Os | |||||||||
.Sh NAME | .Sh NAME | |||||||||
.Nm bhyve | .Nm bhyve | |||||||||
.Nd "run a guest operating system inside a virtual machine" | .Nd "run a guest operating system inside a virtual machine" | |||||||||
.Sh SYNOPSIS | .Sh SYNOPSIS | |||||||||
.Nm | .Nm | |||||||||
.Op Fl abehuwxACHPSWY | .Op Fl abehuwxACHPSWY | |||||||||
▲ Show 20 Lines • Show All 282 Lines • ▼ Show 20 Lines | ||||||||||
.Nm | .Nm | |||||||||
process. | process. | |||||||||
.It Pa /dev/xxx | .It Pa /dev/xxx | |||||||||
Use the host TTY device for serial port I/O. | Use the host TTY device for serial port I/O. | |||||||||
.El | .El | |||||||||
.Pp | .Pp | |||||||||
Boot ROM device: | Boot ROM device: | |||||||||
.Bl -tag -width 10n | .Bl -tag -width 10n | |||||||||
.It Pa romfile | .It Pa romfile Ns Op , Ns Pa varfile | |||||||||
0mpUnsubmitted Done Inline Actions
0mp: | ||||||||||
Map | Map | |||||||||
.Ar romfile | .Ar romfile | |||||||||
in the guest address space reserved for boot firmware. | in the guest address space reserved for boot firmware. | |||||||||
If | ||||||||||
.Ar varfile | ||||||||||
is provided, that file is also mapped in the boot firmware guest | ||||||||||
address space, and any modifications the guest makes will be persisted | ||||||||||
Done Inline ActionsNitpick: "persisted" as a passive may confuse EFL users. Perhaps "written back" or "saved" instead? pauamma_gundo.com: Nitpick: "persisted" as a passive may confuse EFL users. Perhaps "written back" or "saved"… | ||||||||||
Done Inline ActionsGood point! I've changed it to "saved". bcran: Good point! I've changed it to "saved". | ||||||||||
to that file. | ||||||||||
.El | .El | |||||||||
.Pp | .Pp | |||||||||
Pass-through devices: | Pass-through devices: | |||||||||
.Bl -tag -width 10n | .Bl -tag -width 10n | |||||||||
.It Ns Ar slot Ns / Ns Ar bus Ns / Ns Ar function | .It Ns Ar slot Ns / Ns Ar bus Ns / Ns Ar function | |||||||||
Connect to a PCI device on the host at the selector described by | Connect to a PCI device on the host at the selector described by | |||||||||
.Ar slot , | .Ar slot , | |||||||||
.Ar bus , | .Ar bus , | |||||||||
▲ Show 20 Lines • Show All 271 Lines • ▼ Show 20 Lines | ||||||||||
bhyve -c 2 -m 4G -w -H \\ | bhyve -c 2 -m 4G -w -H \\ | |||||||||
-s 0,hostbridge \\ | -s 0,hostbridge \\ | |||||||||
-s 4,ahci-hd,disk.img \\ | -s 4,ahci-hd,disk.img \\ | |||||||||
-s 5,virtio-net,tap0 \\ | -s 5,virtio-net,tap0 \\ | |||||||||
-s 29,fbuf,tcp=[::]:5900,w=800,h=600 \\ | -s 29,fbuf,tcp=[::]:5900,w=800,h=600 \\ | |||||||||
-s 30,xhci,tablet \\ | -s 30,xhci,tablet \\ | |||||||||
-s 31,lpc -l com1,stdio \\ | -s 31,lpc -l com1,stdio \\ | |||||||||
-l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI.fd \\ | -l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI.fd \\ | |||||||||
uefivm | ||||||||||
.Ed | ||||||||||
.Pp | ||||||||||
Run a UEFI virtual machine with a VARS file to save EFI variables. | ||||||||||
Note that | ||||||||||
Done Inline ActionsYou need to break the line at the sentence stop. bcr: You need to break the line at the sentence stop. | ||||||||||
Done Inline ActionsShould bhyve be capitalized here, or is .Nm call more proper. Also I would break the still pretty long for mandoc line at the "so make sure...." rgrimes: Should bhyve be capitalized here, or is .Nm call more proper. Also I would break the still… | ||||||||||
Done Inline ActionsUsed .Nm and split up the sentence. scottph: Used .Nm and split up the sentence. | ||||||||||
.Nm | ||||||||||
will write guest modifications to the given VARS file. | ||||||||||
Be sure to create a per-guest copy of the template VARS file from /usr. | ||||||||||
Done Inline Actions
0mp: | ||||||||||
Done Inline ActionsIt would be nice to stylize /usr with Pa. 0mp: It would be nice to stylize /usr with Pa. | ||||||||||
.Bd -literal -offset indent | ||||||||||
bhyve -c 2 -m 4g -w -H \\ | ||||||||||
-s 0,hostbridge \\ | ||||||||||
-s 31,lpc -p com1,stdio \\ | ||||||||||
-l bootrom,/usr/.../BHYVE_UEFI_CODE.fd,/var/.../BHYVE_UEFI_VARS.fd | ||||||||||
uefivm | uefivm | |||||||||
.Ed | .Ed | |||||||||
.Sh SEE ALSO | .Sh SEE ALSO | |||||||||
.Xr bhyve 4 , | .Xr bhyve 4 , | |||||||||
.Xr nmdm 4 , | .Xr nmdm 4 , | |||||||||
.Xr vmm 4 , | .Xr vmm 4 , | |||||||||
.Xr ethers 5 , | .Xr ethers 5 , | |||||||||
.Xr bhyvectl 8 , | .Xr bhyvectl 8 , | |||||||||
.Xr bhyveload 8 | .Xr bhyveload 8 | |||||||||
Show All 13 Lines |