Page MenuHomeFreeBSD
Files F108576550

D48401.diff
No OneTemporary
Actions

D48401.diff
View Options

diff --git a/usr.sbin/bhyvectl/bhyvectl.8 b/usr.sbin/bhyvectl/bhyvectl.8
--- 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 January 6, 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>
@@ -46,54 +49,61 @@
.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> .
+.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 <file> .
+The guest device and vCPU state are saved in the file
+.Ar <file>.kern .
.It Fl -create
Create the specified VM.
.It Fl -destroy
Destroy the specified VM.
+.It Fl -force-poweroff
+Force the VM to power off.
+.It Fl -force-reset
+Force the VM to reset.
.It Fl -get-stats
Retrieve statistics for the specified VM.
.It Fl -inject-nmi
Inject a non-maskable interrupt (NMI) into the VM.
-.It Fl -force-reset
-Force the VM to reset.
-.It Fl -force-poweroff
-Force the VM to power off.
-.It Fl -checkpoint= Ns Ar <filename>
-Save a snapshot of a virtual machine.
-The guest memory contents are saved in the file given in
-.Ar <filename> .
-The guest device and vCPU state are saved in the file
-.Ar <filename>.kern .
-.It Fl -suspend= Ns Ar <filename>
+.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
-guaranteed when future changes are made.
+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 guaranteed when future changes are made.
.Sh SEE ALSO
.Xr bhyve 8 ,
.Xr bhyveload 8

File Metadata

Mime Type
text/plain
Expires
Mon, Jan 27, 1:19 PM (4 h, 54 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
16095489
Default Alt Text
D48401.diff (3 KB)

Event Timeline