Page Menu
Home
FreeBSD
Search
Configure Global Search
Log In
Files
F177138457
D61142.1793865875.diff
No One
Temporary
Actions
View File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Authored By
Unknown
Size
10 KB
Referenced Files
None
Subscribers
None
D61142.1793865875.diff
View Options
diff --git a/usr.sbin/bhyve/bhyve.8 b/usr.sbin/bhyve/bhyve.8
--- a/usr.sbin/bhyve/bhyve.8
+++ b/usr.sbin/bhyve/bhyve.8
@@ -3,6 +3,7 @@
.\"
.\" Copyright (c) 2013 Peter Grehan
.\" Copyright (c) 2026 Hans Rosenfeld
+.\" Copyright (c) 2026 The FreeBSD Foundation
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
@@ -26,7 +27,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd October 3, 2026
+.Dd November 2, 2026
.Dt BHYVE 8
.Os
.Sh NAME
@@ -39,7 +40,7 @@
.Sm off
.Fl c\~
.Oo
-.Op Cm cpus=
+.Op Cm cpus Ns \&=
.Ar numcpus
.Oc
.Op Cm ,sockets= Ar n
@@ -49,13 +50,12 @@
.Sm on
.Sm off
.Oo Fl f\~
-.Ar name Cm \&,
-.Oo
-.Cm string No | Cm file
+.Op Cm name =
+.Ar name ,
+.Cm string = Ar data |
+.Cm file = Ar path
.Oc
-.Cm \&= Ar data
.Sm on
-.Oc
.Oo
.Sm off
.Fl G\~
@@ -183,16 +183,20 @@
.Nm
to exit when a guest issues an access to an I/O port that is not emulated.
This is intended for debug purposes and only applies to the amd64 platform.
-.It Fl f Ar name Ns Cm \&, Ns Oo Cm string Ns No | Ns Cm file Ns Oc Ns Cm \&= Ns Ar data
+.Sm off
+.It Fl f\~ Oo Cm name = Oc Ar name , Cm string = Ar data | Cm file = Ar path
+.Sm on
Add a fw_cfg file
.Ar name
to the fw_cfg interface.
-If a
+If
.Cm string
is specified, the fw_cfg file contains the string as data.
-If a
+If
.Cm file
-is specified, bhyve reads the file and adds the file content as fw_cfg data.
+is specified, bhyve reads the file referenced by
+.Ar path
+and adds the file content as fw_cfg data.
.It Fl G Xo
.Sm off
.Oo Cm w Oc
@@ -295,9 +299,11 @@
mode.
In this mode, a guest reboot does not cause the bhyve process to exit.
Instead, bhyve will restart the VM.
-Once the bhyve process exits or is killed, the VM will be destroyed automatically.
-.Pp
-.It Fl n Ar id Ns Cm \&, Ns Ar size Ns Cm \&, Ns Ar cpus Ns Op Cm \&, Ns Ar domain_policy
+Once the bhyve process exits or is killed, the VM will be destroyed
+automatically.
+.Sm off
+.It Fl n\~ Ar id , Ar size , Ar cpus Op , Ar domain_policy
+.Sm on
Configure guest NUMA domains.
This option applies only to the amd64 platform.
.Pp
@@ -649,7 +655,7 @@
Note that semicolons must be escaped or quoted to prevent the shell from
interpreting them.
The backend will provide DHCP and DNS service to the guest.
-.Ss Block storage device backends:
+.Ss Block storage device backends
.Bl -bullet
.Sm off
.It
@@ -902,19 +908,19 @@
.It
.Cm ppt Ar N Oo , Ar passthru-device-options Oc
.It
-.Ns Ar bus Cm \&/ Ar slot Cm \&/ Ar function
+.Ar bus Cm / Ar slot Cm / Ar function
.Op , Ar passthru-device-options
.It
-.Cm pci Ar bus Cm : Ar slot Cm : Ns Ar function
+.Cm pci Ar bus : Ar slot : Ns Ar function
.Op , Ar passthru-device-options
.El
.Sm on
.Pp
-Connect to a PCI device on the host either named ppt
-.Ns Ar N
+Connect to a PCI device on the host either named
+.Cm ppt Ns Ar N
or at the selector described by
-.Ar slot ,
.Ar bus ,
+.Ar slot ,
and
.Ar function
numbers.
@@ -975,7 +981,7 @@
.It
Emergency write is advertised, but no-op at present.
.El
-.Ss Virtio input device backends:
+.Ss Virtio input device backends
.Bl -bullet
.Sm off
.It
@@ -1017,7 +1023,7 @@
.Sm on
.It
.Sm off
-.Cm unix: Ar my/unix.sock
+.Cm unix : Ar my/unix.sock
.Sm on
.El
.Pp
@@ -1221,7 +1227,8 @@
to make
.Nm
dump a configuration file representing the used flags and arguments to
-stdout. You can pipe the output into a file to persist the generated settings.
+stdout.
+You can redirect the output into a file to persist the generated settings.
.Pp
Make sure to remove the
.Ar config.dump
diff --git a/usr.sbin/bhyve/bhyve_config.5 b/usr.sbin/bhyve/bhyve_config.5
--- a/usr.sbin/bhyve/bhyve_config.5
+++ b/usr.sbin/bhyve/bhyve_config.5
@@ -2,6 +2,7 @@
.\"
.\" Copyright (c) 2021 John H. Baldwin <jhb@FreeBSD.org>
.\" Copyright (c) 2026 Hans Rosenfeld
+.\" Copyright (c) 2026 The FreeBSD Foundation
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
@@ -24,7 +25,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd September 17, 2026
+.Dd November 2, 2026
.Dt BHYVE_CONFIG 5
.Os
.Sh NAME
@@ -140,7 +141,8 @@
For backward compatibility bhyve copies them into the guest memory as well.
This can cause problems if the guest uses the in-memory version, since certain
advanced features, such as TPM emulation, are exposed only via fw_cfg.
-Therefore, it is recommended to set this flag to false when running Windows guests.
+Therefore, it is recommended to set this flag to false when running Windows
+guests.
.It Va destroy_on_poweroff Ta bool Ta false Ta
Destroy the VM on guest-initiated power-off.
.It Va gdb.address Ta string Ta localhost Ta
@@ -181,53 +183,74 @@
will write all of its configuration variables to stdout and exit.
No VM will be started.
.It Va bios.vendor Ta string Ta BHYVE Ta
-This value is used for the guest's System Management BIOS System Information structure.
+This value is used for the guest's System Management BIOS System Information
+structure.
.It Va bios.version Ta string Ta 14.0 Ta
-This value is used for the guest's System Management BIOS System Information structure.
+This value is used for the guest's System Management BIOS System Information
+structure.
.It Va bios.release_date Ta string Ta 10/17/2021 Ta
-This value is used for the guest's System Management BIOS System Information structure.
+This value is used for the guest's System Management BIOS System Information
+structure.
.It Va system.family_name Ta string Ta Virtual Machine Ta
Family the computer belongs to.
-This value is used for the guest's System Management BIOS System Information structure.
-.It Va system.manufacturer Ta string Ta FreeBSD Ta
-This value is used for the guest's System Management BIOS System Information structure.
+This value is used for the guest's System Management BIOS System Information
+structure.
+.It Va system.manufacturer Ta string Ta Fx Ta
+This value is used for the guest's System Management BIOS System Information
+structure.
.It Va system.product_name Ta string Ta BHYVE Ta
-This value is used for the guest's System Management BIOS System Information structure.
+This value is used for the guest's System Management BIOS System Information
+structure.
.It Va system.serial_number Ta string Ta None Ta
-This value is used for the guest's System Management BIOS System Information structure.
+This value is used for the guest's System Management BIOS System Information
+structure.
.It Va system.sku Ta string Ta None Ta
Stock keeping unit of the computer.
It's also called product ID or purchase order number.
-This value is used for the guest's System Management BIOS System Information structure.
+This value is used for the guest's System Management BIOS System Information
+structure.
.It Va system.version Ta string Ta 1.0 Ta
-This value is used for the guest's System Management BIOS System Information structure.
-.It Va board.manufacturer Ta string Ta FreeBSD Ta
-This value is used for the guest's System Management BIOS System Information structure.
+This value is used for the guest's System Management BIOS System Information
+structure.
+.It Va board.manufacturer Ta string Ta Fx Ta
+This value is used for the guest's System Management BIOS System Information
+structure.
.It Va board.product_name Ta string Ta BHYVE Ta
-This value is used for the guest's System Management BIOS System Information structure.
+This value is used for the guest's System Management BIOS System Information
+structure.
.It Va board.version Ta string Ta 1.0 Ta
-This value is used for the guest's System Management BIOS System Information structure.
+This value is used for the guest's System Management BIOS System Information
+structure.
.It Va board.serial_number Ta string Ta None Ta
-This value is used for the guest's System Management BIOS System Information structure.
+This value is used for the guest's System Management BIOS System Information
+structure.
.It Va board.asset_tag Ta string Ta None Ta
-This value is used for the guest's System Management BIOS System Information structure.
+This value is used for the guest's System Management BIOS System Information
+structure.
.It Va board.location Ta string Ta None Ta
Describes the board's location within the chassis.
-This value is used for the guest's System Management BIOS System Information structure.
-.It Va chassis.manufacturer Ta string Ta FreeBSD Ta
-This value is used for the guest's System Management BIOS System Information structure.
+This value is used for the guest's System Management BIOS System Information
+structure.
+.It Va chassis.manufacturer Ta string Ta Fx Ta
+This value is used for the guest's System Management BIOS System Information
+structure.
.It Va chassis.version Ta string Ta 1.0 Ta
-This value is used for the guest's System Management BIOS System Information structure.
+This value is used for the guest's System Management BIOS System Information
+structure.
.It Va chassis.serial_number Ta string Ta None Ta
-This value is used for the guest's System Management BIOS System Information structure.
+This value is used for the guest's System Management BIOS System Information
+structure.
.It Va chassis.asset_tag Ta string Ta None Ta
-This value is used for the guest's System Management BIOS System Information structure.
+This value is used for the guest's System Management BIOS System Information
+structure.
.It Va chassis.sku Ta string Ta None Ta
Stock keeping unit of the chassis.
It's also called product ID or purchase order number.
-This value is used for the guest's System Management BIOS System Information structure.
+This value is used for the guest's System Management BIOS System Information
+structure.
.It Va oemstring.N Ta string Ta none Ta
-This value is returned for the guest's Nth System Management BIOS System Information OEM Strings structure.
+This value is returned for the guest's Nth System Management BIOS System
+Information OEM Strings structure.
Configuration can specify up to 255 strings.
.It Va rundir Ta String Ta Pa /var/run/bhyve/ Ta
Path to the runtime directory for
@@ -610,7 +633,7 @@
localhost address is used.
.It Va rfb Ta
.Sm off
-.Cm unix: Ar my/unix.sock Ta Ta
+.Cm unix : Ar my/unix.sock Ta Ta
.Sm on
Alternatively, provide a path to a UNIX domain socket.
.It Va vga Ta string Ta io Ta
@@ -812,7 +835,8 @@
.El
.Ss VirtIO Input Interface Settings
Each VirtIO Input device contains one input event device.
-All input events of the input event device are send to the guest by VirtIO Input interface.
+All input events of the input event device are send to the guest by VirtIO Input
+interface.
VirtIO Input Interfaces support the following variables:
.Bl -column "Name" "Format" "Default"
.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description
File Metadata
Details
Attached
Mime Type
text/plain
Expires
Thu, Nov 5, 8:04 AM (11 h, 4 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
41444591
Default Alt Text
D61142.1793865875.diff (10 KB)
Attached To
Mode
D61142: bhyve: cleanup bhyve(8) and bhyve_config(5)
Attached
Detach File
Event Timeline