git: a2e5bac81e04 - main - bhyve: tidy up bhyve_config.5
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Thu, 30 Jul 2026 16:09:37 UTC
The branch main has been updated by novel:
URL: https://cgit.FreeBSD.org/src/commit/?id=a2e5bac81e045f9991a997733391ddf1f19e40a8
commit a2e5bac81e045f9991a997733391ddf1f19e40a8
Author: Roman Bogorodskiy <novel@FreeBSD.org>
AuthorDate: 2026-07-23 16:16:36 +0000
Commit: Roman Bogorodskiy <novel@FreeBSD.org>
CommitDate: 2026-07-30 16:08:16 +0000
bhyve: tidy up bhyve_config.5
There are few warnings reported by mandoc -Tlint:
bhyve_config.5:255:31: WARNING: new sentence, new line
bhyve_config.5:257:43: WARNING: new sentence, new line
bhyve_config.5:422:2: WARNING: missing section argument: Xr nm_open
bhyve_config.5:469:24: WARNING: skipping no-space macro
bhyve_config.5:483:2: WARNING: wrong number of cells: 2 columns, 4 cells
bhyve_config.5:484:2: WARNING: wrong number of cells: 2 columns, 4 cells
bhyve_config.5:541:24: WARNING: skipping no-space macro
- "new sentence, new line" is a trivial formatting fix.
- "missing section": there is actually no nm_open() manual page,
so use .Nm instead of .Xr for it.
- "no-space macro": format without .Oc and .Ns, similarly to
how it is already done in bhyve.8 for VNC addresses.
- "wrong number of cells": also a trivial fix.
Reviewed by: jhb
Sponsored by: The FreeBSD Foundation
MFC after: 3 days
Differential Revision: https://reviews.freebsd.org/D58415
---
usr.sbin/bhyve/bhyve_config.5 | 28 +++++++++++++++++++---------
1 file changed, 19 insertions(+), 9 deletions(-)
diff --git a/usr.sbin/bhyve/bhyve_config.5 b/usr.sbin/bhyve/bhyve_config.5
index ae84aba1fe57..a12540d054c7 100644
--- a/usr.sbin/bhyve/bhyve_config.5
+++ b/usr.sbin/bhyve/bhyve_config.5
@@ -252,10 +252,10 @@ Inject a general protection fault if a guest accesses a Model Specific
Register (MSR) that is not emulated.
If this is false, writes are ignored and reads return zero.
.It Va x86.verbosemsr Ta bool Ta false Ta
-Enable verbose MSR print out. When this option is true,
-messages related to reading from (rdmsr) and writing to (wrmsr)
-MSRs on virtual CPUs will be printed out. This can be useful for
-debugging purposes.
+Enable verbose MSR print out.
+When this option is true, messages related to reading from (rdmsr)
+and writing to (wrmsr) MSRs on virtual CPUs will be printed out.
+This can be useful for debugging purposes.
.It Va x86.vmexit_on_hlt Ta bool Ta false Ta
Force a VM exit when a guest CPU executes the
.Dv HLT
@@ -419,7 +419,7 @@ bridge as the backend.
The value of
.Va backend
is passed to
-.Xr nm_open
+.Nm nm_open
to connect to a netmap port.
.It slirp
Use the slirp backend to provide a userspace network stack.
@@ -466,7 +466,12 @@ Either the pathname of a character device or
to use standard input and output of the
.Xr bhyve 8
process.
-.It Va tcp Ta Oo Ar IP Ns : Oc Ns Ar port Ta Ta
+.It Va tcp Ta Xo
+.Sm off
+.Op Ar IP Cm \&:
+.Ar port
+.Sm on
+.Xc Ta Ta
TCP address to listen on for remote connections.
The IP address must be given as a numeric address.
IPv6 addresses must be enclosed in square brackets and
@@ -480,8 +485,8 @@ supports scoped identifiers as described in
Values of PCI register.
.Bl -column "device" "Default"
.It Sy Name Ta Sy Default
-.It Va vendor Ta integer Ta 0x1275 Ta
-.It Va device Ta integer Ta 0x1275 Ta
+.It Va vendor Ta 0x1275
+.It Va device Ta 0x1275
.El
.El
.Ss AHCI Controller Settings
@@ -538,7 +543,12 @@ If specified, it must be a unicast MAC address.
.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description
.It Va wait Ta bool Ta false Ta
Wait for a remote connection before starting the VM.
-.It Va rfb Ta Oo Ar IP Ns : Oc Ns Ar port Ta 127.0.0.1:5900 Ta
+.It Va rfb Ta Xo
+.Sm off
+.Op Ar IP Cm \&:
+.Ar port
+.Sm on
+.Xc Ta 127.0.0.1:5900 Ta
TCP address to listen on for remote connections.
The IP address must be given as a numeric address.
IPv6 addresses must be enclosed in square brackets and