The branch stable/14 has been updated by ziaee:
URL:
https://cgit.FreeBSD.org/src/commit/?id=b59d777bc7af2ac815d78a4408120e96e7ec8319
commit b59d777bc7af2ac815d78a4408120e96e7ec8319
Author: Alexander Ziaee <zi...@freebsd.org>
AuthorDate: 2025-05-21 16:29:39 +0000
Commit: Alexander Ziaee <zi...@freebsd.org>
CommitDate: 2025-07-04 18:20:02 +0000
bhyvectl.8: Polish
+ Add how to find open VMs in the example, linking `apropos Pa=/dev/vmm`
+ Move note about additional bhyve options after options for flow
+ Reclaim some space by shortening <filename> to <file>
+ Align options list width, tested at MANWIDTH 59 and 80
+ Remove unnecessary roff quoting and tag SPDX
MFC after: 3 days
Reviewed by: carlavilla, markj, mhorne
Approved by: carlavilla, mhorne (mentors)
Differential Revision: https://reviews.freebsd.org/D48401
(cherry picked from commit 22348fb999385edaef38ce5e4308f44135f0326c)
---
usr.sbin/bhyvectl/bhyvectl.8 | 46 ++++++++++++++++++++++++++------------------
1 file changed, 27 insertions(+), 19 deletions(-)
diff --git a/usr.sbin/bhyvectl/bhyvectl.8 b/usr.sbin/bhyvectl/bhyvectl.8
index c5282a98a767..550c4f10d8e6 100644
--- a/usr.sbin/bhyvectl/bhyvectl.8
+++ b/usr.sbin/bhyvectl/bhyvectl.8
@@ -1,3 +1,6 @@
+.\"
+.\" SPDX-License-Identifier: BSD-2-Clause
+.\"
.\" Copyright (c) 2015 Christian Brueffer
.\" All rights reserved.
.\"
@@ -22,12 +25,12 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd May 4, 2020
+.Dd May 8, 2025
.Dt BHYVECTL 8
.Os
.Sh NAME
.Nm bhyvectl
-.Nd "control utility for bhyve instances"
+.Nd control utility for bhyve instances
.Sh SYNOPSIS
.Nm
.Fl -vm= Ns Ar <vmname>
@@ -37,8 +40,8 @@
.Op Fl -inject-nmi
.Op Fl -force-reset
.Op Fl -force-poweroff
-.Op Fl -checkpoint= Ns Ar <filename>
-.Op Fl -suspend= Ns Ar <filename>
+.Op Fl -checkpoint= Ns Ar <file>
+.Op Fl -suspend= Ns Ar <file>
.Sh DESCRIPTION
The
.Nm
@@ -46,17 +49,8 @@ command is a control utility for active
.Xr bhyve 8
virtual machine instances.
.Pp
-.Em Note :
-Most
-.Nm
-flags are intended for querying and setting the state of an active instance.
-These commands are intended for development purposes, and are not documented
here.
-A complete list can be obtained by executing
-.Nm
-without any arguments.
-.Pp
The user-facing options are as follows:
-.Bl -tag -width ".Fl d Ar argument"
+.Bl -tag -width "--checkpoint=<file>"
.It Fl -vm= Ns Ar <vmname>
Operate on the virtual machine
.Ar <vmname> .
@@ -72,24 +66,38 @@ Inject a non-maskable interrupt (NMI) into the VM.
Force the VM to reset.
.It Fl -force-poweroff
Force the VM to power off.
-.It Fl -checkpoint= Ns Ar <filename>
+.It Fl -checkpoint= Ns Ar <file>
Save a snapshot of a virtual machine.
The guest memory contents are saved in the file given in
-.Ar <filename> .
+.Ar <file> .
The guest device and vCPU state are saved in the file
-.Ar <filename>.kern .
-.It Fl -suspend= Ns Ar <filename>
+.Ar <file>.kern .
+.It Fl -suspend= Ns Ar <file>
Save a snapshot of a virtual machine similar to
.Fl -checkpoint .
The virtual machine will terminate after the snapshot has been
saved.
.El
+.Pp
+.Em Note :
+Most
+.Nm
+flags are intended for querying and setting
+the state of an active instance.
+These commands are intended for development purposes,
+and are not documented here.
+A complete list can be obtained by executing
+.Nm
+without any arguments.
.Sh EXIT STATUS
.Ex -std
.Sh EXAMPLES
Destroy the VM called fbsd10:
.Pp
-.Dl "bhyvectl --vm=fbsd10 --destroy"
+.Dl bhyvectl --vm=fbsd10 --destroy
+.Pp
+Running VMs will be visible in
+.Pa /dev/vmm/ .
.Sh COMPATIBILITY
The snapshot file format is not yet stable and is subject to future changes.
Backwards compatibility support for the current snapshot file format is not
