From nobody Mon Feb 9 22:19:14 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) client-ip=170.10.129.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1639152476; cv=none; d=zohomail.com; s=zohoarc; b=B8mFs6Jb7fasEpwZXNv/Z3SaPjRwUhptIzC0+UKNidpmB84XP44O9tbJ9GRE0Emt9AKw0ktAeWu9ulPCU494LLXAi9Z7gcUaAkknXsW29i92s2xkIA7QEiPsSgObOtsIOQi8VsG/hCY7o92lYIRTBetQwUtlpZZZ6clVwPhlN8w= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1639152476; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=OeDQ0xZetaoeJSyZMzdo0qKVck0haNgE50jqAWh54cg=; b=geQFgvY5rivCJY7nzz2vWGdZeL1li65WSre0Le+Ql6yjSxHgx2t5Ulgf2T5s5FK+vYSlGvHECRqOGe7/XthHw8Z7/vxIGICelsetkNjWPHhWhehSKGIJsHtdL2d9BOeuergV5xt0PyUHlDxyFMPdh8oJ+VzR+aXnv2LuV8NLaSg= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mx.zohomail.com with SMTPS id 1639152476769238.82292507972522; Fri, 10 Dec 2021 08:07:56 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-135-NX8rPEaJNPCBNMKGhgL0hQ-1; Fri, 10 Dec 2021 11:07:54 -0500 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com [10.5.11.22]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 8855E760C9; Fri, 10 Dec 2021 16:07:48 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 6A78F1001F4D; Fri, 10 Dec 2021 16:07:48 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 3EDC94A700; Fri, 10 Dec 2021 16:07:48 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 1BAG6q30015383 for ; Fri, 10 Dec 2021 11:06:52 -0500 Received: by smtp.corp.redhat.com (Postfix) id C82CC60622; Fri, 10 Dec 2021 16:06:52 +0000 (UTC) Received: from kinshicho.usersys.redhat.com.homenet.telecomitalia.it (unknown [10.40.194.89]) by smtp.corp.redhat.com (Postfix) with ESMTPS id A5BB71B42C for ; Fri, 10 Dec 2021 16:06:51 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1639152475; h=from:from:sender:sender: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: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=OeDQ0xZetaoeJSyZMzdo0qKVck0haNgE50jqAWh54cg=; b=V0MboUAcS0srFwQSelVxRvNrzCLUIi3A23TRm4RDbdevotPJfD2h8d53W3Zc9mYfV3iNnU Xvug3oDCHgdLJJAIXSVvfQH6jYHgBApg/8TdHpawyN7r7Yb340I0gjNOYCd/eOG9g135ht /aBf+jsjytC5c1jNhZwO1raJ7pbOg8Y= X-MC-Unique: NX8rPEaJNPCBNMKGhgL0hQ-1 From: Andrea Bolognani To: libvir-list@redhat.com Subject: [libvirt PATCH 5/6] virt-qemu-run: Improve manual page Date: Fri, 10 Dec 2021 17:06:33 +0100 Message-Id: <20211210160634.366061-6-abologna@redhat.com> In-Reply-To: <20211210160634.366061-1-abologna@redhat.com> References: <20211210160634.366061-1-abologna@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 X-loop: libvir-list@redhat.com X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.84 on 10.5.11.22 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1639152478350100001 Content-Type: text/plain; charset="utf-8" Specifically: * use the correct notation and markup for commands, options and arguments; * rename arguments meta-variables; * document '--help' and '--version' options; * use consistent vertical spacing; * fix a typo. Signed-off-by: Andrea Bolognani Reviewed-by: J=C3=A1n Tomko --- docs/manpages/virt-qemu-run.rst | 53 +++++++++++++++++++-------------- 1 file changed, 31 insertions(+), 22 deletions(-) diff --git a/docs/manpages/virt-qemu-run.rst b/docs/manpages/virt-qemu-run.= rst index 470de93168..a755b7fda9 100644 --- a/docs/manpages/virt-qemu-run.rst +++ b/docs/manpages/virt-qemu-run.rst @@ -11,10 +11,13 @@ Run a standalone QEMU guest =20 .. contents:: =20 + SYNOPSIS =3D=3D=3D=3D=3D=3D=3D=3D =20 -``virt-qemu-run [OPTIONS...] [GUEST-XML]`` +``virt-qemu-run`` [*OPTIONS...*] *GUEST-XML-FILE* +``virt-qemu-run`` *OPTION* + =20 DESCRIPTION =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D @@ -26,50 +29,54 @@ directory tree. When the guest is run with this tool it= is invisible to libvirtd and thus also invisible to other libvirt tools such as virsh. =20 -The virt-qemu-run program will run the QEMU virtual machine, and then -block until the guest OS shuts down, at which point it will exit. +The ``virt-qemu-run`` program will run the QEMU virtual machine, and +then block until the guest OS shuts down, at which point it will +exit. =20 -If the virt-qemu-run program is interrupted (eg Ctrl-C) it will -immediately terminate the virtual machine without giving the guest -OS any opportunity to gracefully shutdown. +If the ``virt-qemu-run`` program is interrupted (eg Ctrl-C) it will +immediately terminate the virtual machine without giving the guest OS +any opportunity to gracefully shutdown. =20 **NOTE: this tool is currently considered experimental.** Its usage and behaviour is still subject to change in future libvirt releases. For further information on its usage consult the `QEMU driver documentation `_. =20 + OPTIONS =3D=3D=3D=3D=3D=3D=3D =20 -``GUEST-XML`` +*GUEST-XML-FILE* =20 The full path to the XML file describing the guest virtual machine to be booted. =20 -``-h``, ``--help`` - -Display the command line help - -``-v``, ``--verbose`` - -Display verbose information about startup - -``-r DIR``, ``--root=3DDIR`` +``-r`` *DIR*, ``--root``\ =3D\ *DIR* =20 Specify the root directory to use for storing state associated with the virtual machine. The caller is responsible for deleting this directory when it is no longer required. =20 If this parameter is omitted, then a random temporary directory -will be created, and its contents be automaticlaly deleted at +will be created, and its contents be automatically deleted at VM shutdown. =20 -``-s XML-FILE,VALUE-FILE``, ``--secret=3DXML-FILE,VALUE-FILE`` +``-s`` *SECRET-XML-FILE*\ ,\ *SECRET-VALUE-FILE*, +``--secret``\ =3D\ *SECRET-XML-FILE*\ ,\ *SECRET-VALUE-FILE* + +Specify a secret to be loaded into the secret driver. +*SECRET-XML-FILE* is a path to the XML description of the secret, +whose UUID should match a secret referenced in the guest domain XML. +*SECRET-VALUE-FILE* is a path containing the raw value of the secret. + +``-h``, ``--help`` + +Display the command line help + +``-v``, ``--verbose`` + +Display verbose information about startup =20 -Specify a secret to be loaded into the secret driver. The ``XML-FILE`` -is a path to the XML description of the secret, whose UUID should -match a secret referenced in the guest domain XML. The ``VALUE-FILE`` -is a path containing the raw value of the secret. =20 EXIT STATUS =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D @@ -77,6 +84,7 @@ EXIT STATUS Upon successful shutdown, an exit status of 0 will be set. Upon failure a non-zero status will be set. =20 + AUTHOR =3D=3D=3D=3D=3D=3D =20 @@ -113,6 +121,7 @@ This is free software; see the source for copying condi= tions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE =20 + SEE ALSO =3D=3D=3D=3D=3D=3D=3D=3D =20 --=20 2.31.1