From nobody Fri Jul 4 18:22:54 2025 X-Original-To: dev-commits-src-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4bYhnq0zyHz61jKQ; Fri, 04 Jul 2025 18:22:55 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R10" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4bYhnq0Ny8z3n57; Fri, 04 Jul 2025 18:22:55 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1751653375; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=cD+6cai6Is1k76Tf8YgKI0f1zU8/lktZD6lDHf76eBk=; b=gJgybJmp5p61dzjqbykrwLKUnblHhUnTiaioxBm4idQWpo7Rhoa3lciFywuiRVOPR2G4vx U4W2MN/WRxFIskB00b7AYJ6tPy5lhzkurwK9zZyWjE2lkRyO8+ty+xtGiOPw52zVrVL6nO HW/D/zWJqZTH9MZgB0c5/tUMNHyT0dQCA9Dnbb3nAKVyOMiAYvsAiYiXtpPj5ZjS5vtwbT Hr1RTOqrpRPA+p5LFyoTNbpfCuta6yvlaQ9hizgaJPuzw7T0HMKn9Z0vD/YLEBzB3FzSBo 2NXfCbZR70L1CMGHbIIFO06Y8+uNGYuB1vuIYu0AS/9aw8AvTWZs2S/+3/o7lA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1751653375; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=cD+6cai6Is1k76Tf8YgKI0f1zU8/lktZD6lDHf76eBk=; b=qzJDGrIUfa0yiMdOB88SahRkQfl/U1MJwS1zs56advNRbAtXBE10U/ch4UFeOZIMd9U4NC 2l7kljGbfSMLDC9kQBG40oa41i+MQ5gWMKMsBsv2Z5t7exiX92z85EQXKF8Q1WQ9Zyck3E kwgXBnoW5XBUBswGLx4HAW3HyC9r5gZGYpcqqxgqSEN8fN591mnXO2YuAEntdQgO+wZdNm CWwvb4ItnRV3AvW67t2kt0GUXeZiMHkQ2PCZkGDfl+G+hsF60sRHzGxd0HbKuj6wSBa4jH Pf6HFGxSHzOjOv8oetVUMxkEyPdpr4kIRKAZ9J+Jr0natJrckfe0knzttRLmaA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1751653375; a=rsa-sha256; cv=none; b=iZxbV3PXUyo+p1H1+uYM2UpQ1d5RYR5ZSZg6FTpM1yrpTLv80yHI6knH+r/OPFArM8hZfW U9gbiH0mKXXEEABXAf4++dE8SeKiWqaWPLSr9RkY6OcQnowqsnBJEOK0/O9/TxKRSqjUpX 5cy1SxT0GxKk0q9k9IpFkZShrLSoc+PtMiM7kRD2vhk5NfsmGltOMjqCkaDFV3olLmZltb RohavDan+R7jxOsIQAmMb8jwXQRoNZsrsZ7HptBWNbcfyp5858M1pvFV8MIwvUo4cJcslV H+zx0cq0IXR6qv0EqEUrQEuBTYjjPWvdQ3hE3BJBPNRR8clX6zECHRYD9KaVRw== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4bYhnp75GBz126R; Fri, 04 Jul 2025 18:22:54 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.18.1/8.18.1) with ESMTP id 564IMspA069322; Fri, 4 Jul 2025 18:22:54 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 564IMsm8069319; Fri, 4 Jul 2025 18:22:54 GMT (envelope-from git) Date: Fri, 4 Jul 2025 18:22:54 GMT Message-Id: <202507041822.564IMsm8069319@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org From: Alexander Ziaee Subject: git: b59d777bc7af - stable/14 - bhyvectl.8: Polish List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-all@freebsd.org Sender: owner-dev-commits-src-all@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: ziaee X-Git-Repository: src X-Git-Refname: refs/heads/stable/14 X-Git-Reftype: branch X-Git-Commit: b59d777bc7af2ac815d78a4408120e96e7ec8319 Auto-Submitted: auto-generated The branch stable/14 has been updated by ziaee: URL: https://cgit.FreeBSD.org/src/commit/?id=b59d777bc7af2ac815d78a4408120e96e7ec8319 commit b59d777bc7af2ac815d78a4408120e96e7ec8319 Author: Alexander Ziaee AuthorDate: 2025-05-21 16:29:39 +0000 Commit: Alexander Ziaee 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 to + 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 @@ -37,8 +40,8 @@ .Op Fl -inject-nmi .Op Fl -force-reset .Op Fl -force-poweroff -.Op Fl -checkpoint= Ns Ar -.Op Fl -suspend= Ns Ar +.Op Fl -checkpoint= Ns Ar +.Op Fl -suspend= Ns Ar .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=" .It Fl -vm= Ns Ar Operate on the virtual machine .Ar . @@ -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 +.It Fl -checkpoint= Ns Ar Save a snapshot of a virtual machine. The guest memory contents are saved in the file given in -.Ar . +.Ar . The guest device and vCPU state are saved in the file -.Ar .kern . -.It Fl -suspend= Ns Ar +.Ar .kern . +.It Fl -suspend= Ns Ar 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