Differential D54742 Diff 170313 usr.sbin/bhyve/bhyve.8

Changeset View

Standalone View

usr.sbin/bhyve/bhyve.8

	Show All 19 Lines
	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL			.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS			.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	.\" 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.
	.\"			.\"
	.Dd January 5, 2026			.Dd January 23, 2026
	.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 aCDeHhMPSuWwxY			.Op Fl aCDeHhMPSuWwxY
	▲ Show 20 Lines • Show All 75 Lines • ▼ Show 20 Lines
	On amd64, the			On amd64, the
	.Pa edk2-bhyve			.Pa edk2-bhyve
	package provides a UEFI firmware that can be used to boot the guest;			package provides a UEFI firmware that can be used to boot the guest;
	on arm64 the			on arm64 the
	.Pa u-boot-bhyve-arm64			.Pa u-boot-bhyve-arm64
	package provides a U-Boot image that can be used to boot the guest.			package provides a U-Boot image that can be used to boot the guest.
	.Pp			.Pp
	.Nm			.Nm
	runs until the guest operating system reboots or an unhandled hypervisor			runs until the guest operating system reboots (if
	exit is detected.			.Ql monitor
				mode is not enabled) or halts, or an unhandled hypervisor exit is
				detected.
				.Pp
				Generally
				.Nm
				must be run by the super-user, but users belonging to the
				.Va vmm
				group can create and run virtual machines as well.
				See
				.Xr vmm 4 .
				When run by an unprivileged user,
				.Nm
				must have access to any required resources such as disk images or
				network devices.
				PCI passthrough cannot be used by unprivileged users.
	.Sh OPTIONS			.Sh OPTIONS
	.Bl -tag -width 10n			.Bl -tag -width 10n
	.It Fl a			.It Fl a
	The guest's local APIC is configured in xAPIC mode.			The guest's local APIC is configured in xAPIC mode.
	This option only applies to the amd64 platform.			This option only applies to the amd64 platform.
	xAPIC mode is the default setting so this option is redundant.			xAPIC mode is the default setting so this option is redundant.
	It will be deprecated in a future version.			It will be deprecated in a future version.
	.It Fl C			.It Fl C
	▲ Show 20 Lines • Show All 470 Lines • ▼ Show 20 Lines
	.Ar NAME			.Ar NAME
	must comply with			must comply with
	.Xr netgraph 4			.Xr netgraph 4
	addressing rules.			addressing rules.
	.Pp			.Pp
	The			The
	.Cm slirp			.Cm slirp
	backend can be used to provide a NATed network to the guest.			backend can be used to provide a NATed network to the guest.
	This backend has poor performance but does not require any network			This backend has limited performance but does not require any network
	configuration on the host system.			configuration on the host system and can be used by unprivileged users.
	It depends on the			It depends on the
	.Pa net/libslirp			.Pa net/libslirp
	port.			port.
	If the			If the
	.Cm open			.Cm open
	keyword is set, the guest will be able to make outbound network			keyword is set, the guest will be able to make outbound network
	connections, and			connections, and
	.Nm			.Nm
	▲ Show 20 Lines • Show All 733 Lines • Show Last 20 Lines