From nobody Wed May 21 16:34:41 2025 X-Original-To: dev-commits-src-main@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 4b2cTF74RQz5wB5T; Wed, 21 May 2025 16:34:41 +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 "R11" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4b2cTF6HWWz3VTS; Wed, 21 May 2025 16:34:41 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1747845281; 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=UhsXFtwP++9wI+JGJinHX2r6bMlsHZ1tc7bhiAEIGmM=; b=TwXXa4uxE3Tklu3mwKOYsX2PjCx+0/coahRkQrPH2p+anz5vxwcD3112irpXlQ1CpFb4/I wVTSUxOWN1JBJQeO0Mn6+Tw+AiRHGee3mmKQpiFv7grATTX5C/YNSmIwAVPQB3yjBoGzJk CQwcejZbtpWDxY3kjPDWs1j8StWP8IBjj4OC5ceNPwqc2t6tpKQnZKowC39WkU500PBKse rf30hUsNeoTFACoeRce2+2pIwfqO4gf8DCqtUA7PweRO3+I01GOh8CqWsf+Pbam9pxZ3CP GydIITOQA6TPFHq/TX7ge7QlWUf3Zqq0bGLpFaE2XNYkPY1uo0rorjxMQoQKoQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1747845281; 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=UhsXFtwP++9wI+JGJinHX2r6bMlsHZ1tc7bhiAEIGmM=; b=MSzOVIN0ozbBA+xXYw7/uU4NPkcUPqQYOEHpilJ0910Eb97LWINKF0DxwMLBkzDl5skLXs DATnnTHb9DEBLt7epljtwfzLXnotYFgj0JhoeT0GxJQUe+i7kbU0ZaNdwX21cwKEovpv6I 8uaA/X77aAFDARISgfGPcNQevtgV05SooDV3aSARNWFywasbL4fUcy7vkoWYrxiWuVI9ka KYC8saj1c49iwmhLvK4Fkxj1U4ot15Y0iFkAXFdCg0l48LrtiKK81vaNjGZU9eTy84KwO8 XW1KE7dNMN5+olYBo/sbUiVAKH2bNznNME+B8Ky7xyEMd9XXNaJptIRziM6qYw== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1747845281; a=rsa-sha256; cv=none; b=wPRLdFP1NRy7Xq4MY5ZFeEndRw8WdaknFfJQOlZ2lm7k/1IGtclWCxAgxE0128uKWhATbT jmjS2YDUoGBE0QgYD8jjul5rLl1TiS6dH1GhZ+P3ciKLbuea7AEKUxUbEpPXX1NOCy29TI rfFcJ7EtOzdHWKBMTx+qWrfTAPiInnT0yAUuJlGn6x8uRnwsXvi2m5MqKValrrJct8T+j2 K/TuCmeQA8TkzDLAhxC+pXj6S0cof/8Qz80aCZZeNhAXVrozejXnoGB1izq0ssoE50YNCr zxUg9VovwwmQNNwxkhZA+NMbwdRCpP1haDTNK3rAMlUr0vFf8IhOA0Um1JRTMw== ARC-Authentication-Results: i=1; mx1.freebsd.org; none 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 4b2cTF5rD7zjYH; Wed, 21 May 2025 16:34:41 +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 54LGYfpJ041119; Wed, 21 May 2025 16:34:41 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 54LGYfpa041116; Wed, 21 May 2025 16:34:41 GMT (envelope-from git) Date: Wed, 21 May 2025 16:34:41 GMT Message-Id: <202505211634.54LGYfpa041116@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Alexander Ziaee Subject: git: 22348fb99938 - main - bhyvectl.8: Polish List-Id: Commit messages for the main branch of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-main List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-main@freebsd.org Sender: owner-dev-commits-src-main@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/main X-Git-Reftype: branch X-Git-Commit: 22348fb999385edaef38ce5e4308f44135f0326c Auto-Submitted: auto-generated The branch main has been updated by ziaee: URL: https://cgit.FreeBSD.org/src/commit/?id=22348fb999385edaef38ce5e4308f44135f0326c commit 22348fb999385edaef38ce5e4308f44135f0326c Author: Alexander Ziaee AuthorDate: 2025-05-21 16:29:39 +0000 Commit: Alexander Ziaee CommitDate: 2025-05-21 16:33:37 +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 --- 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