From nobody Tue Oct 28 12:17:40 2025 Delivered-To: importer@patchew.org Received-SPF: temperror (zoho.com: Error in retrieving data from DNS) client-ip=208.118.235.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; spf=temperror (zoho.com: Error in retrieving data from DNS) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org Return-Path: Received: from lists.gnu.org (208.118.235.17 [208.118.235.17]) by mx.zohomail.com with SMTPS id 1514256908539328.70898268065855; Mon, 25 Dec 2017 18:55:08 -0800 (PST) Received: from localhost ([::1]:47881 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eTfOQ-0007hx-G7 for importer@patchew.org; Mon, 25 Dec 2017 21:55:02 -0500 Received: from eggs.gnu.org ([2001:4830:134:3::10]:38831) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eTfMW-0006jm-TL for qemu-devel@nongnu.org; Mon, 25 Dec 2017 21:53:06 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eTfMV-0004Rf-Tb for qemu-devel@nongnu.org; Mon, 25 Dec 2017 21:53:04 -0500 Received: from mx1.redhat.com ([209.132.183.28]:53658) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1eTfMR-0004Nr-9q; Mon, 25 Dec 2017 21:52:59 -0500 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 611F383F44; Tue, 26 Dec 2017 02:52:58 +0000 (UTC) Received: from lemon.redhat.com (ovpn-12-61.pek2.redhat.com [10.72.12.61]) by smtp.corp.redhat.com (Postfix) with ESMTP id C02C960C8A; Tue, 26 Dec 2017 02:52:55 +0000 (UTC) From: Fam Zheng To: qemu-devel@nongnu.org Date: Tue, 26 Dec 2017 10:52:46 +0800 Message-Id: <20171226025247.11082-2-famz@redhat.com> In-Reply-To: <20171226025247.11082-1-famz@redhat.com> References: <20171226025247.11082-1-famz@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.27]); Tue, 26 Dec 2017 02:52:58 +0000 (UTC) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 209.132.183.28 Subject: [Qemu-devel] [PATCH v5 1/2] qemu-img.texi: Clean up parameter list X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Kevin Wolf , qemu-block@nongnu.org, kchamart@redhat.com, Max Reitz , stefanha@redhat.com Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail: RSF_6 Z_629925259 SPT_0 Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Split options out of the "@table @var" section and create a "@table @option", then use whitespaces and blank lines consistently. Suggested-by: Kevin Wolf Signed-off-by: Fam Zheng Reviewed-by: Eric Blake Reviewed-by: Kashyap Chamarthy Reviewed-by: Stefan Hajnoczi --- qemu-img.texi | 66 +++++++++++++++++++++++++++++++++++--------------------= ---- 1 file changed, 39 insertions(+), 27 deletions(-) diff --git a/qemu-img.texi b/qemu-img.texi index fdcf120f36..60a0e080c6 100644 --- a/qemu-img.texi +++ b/qemu-img.texi @@ -33,38 +33,14 @@ The following commands are supported: =20 Command parameters: @table @var + @item filename - is a disk image filename - -@item --object @var{objectdef} - -is a QEMU user creatable object definition. See the @code{qemu(1)} manual -page for a description of the object properties. The most common object -type is a @code{secret}, which is used to supply passwords and/or encrypti= on -keys. - -@item --image-opts - -Indicates that the source @var{filename} parameter is to be interpreted as= a -full option string, not a plain filename. This parameter is mutually -exclusive with the @var{-f} parameter. - -@item --target-image-opts - -Indicates that the @var{output_filename} parameter(s) are to be interprete= d as -a full option string, not a plain filename. This parameter is mutually -exclusive with the @var{-O} parameters. It is currently required to also u= se -the @var{-n} parameter to skip image creation. This restriction may be rel= axed -in a future release. +is a disk image filename =20 @item fmt is the disk image format. It is guessed automatically in most cases. See b= elow for a description of the supported disk formats. =20 -@item --backing-chain -will enumerate information about backing files in a disk image chain. Refer -below for further description. - @item size is the disk image size in bytes. Optional suffixes @code{k} or @code{K} (kilobyte, 1024) @code{M} (megabyte, 1024k) and @code{G} (gigabyte, 1024M) @@ -74,42 +50,78 @@ and T (terabyte, 1024G) are supported. @code{b} is ign= ored. is the destination disk image filename =20 @item output_fmt - is the destination format +is the destination format + @item options is a comma separated list of format specific options in a name=3Dvalue format. Use @code{-o ?} for an overview of the options suppor= ted by the used format or see the format descriptions below for details. + @item snapshot_param is param used for internal snapshot, format is 'snapshot.id=3D[ID],snapshot.name=3D[NAME]' or '[ID_OR_NAME]' + @item snapshot_id_or_name is deprecated, use snapshot_param instead =20 +@end table + +@table @option + +@item --object @var{objectdef} +is a QEMU user creatable object definition. See the @code{qemu(1)} manual +page for a description of the object properties. The most common object +type is a @code{secret}, which is used to supply passwords and/or encrypti= on +keys. + +@item --image-opts +Indicates that the source @var{filename} parameter is to be interpreted as= a +full option string, not a plain filename. This parameter is mutually +exclusive with the @var{-f} parameter. + +@item --target-image-opts +Indicates that the @var{output_filename} parameter(s) are to be interprete= d as +a full option string, not a plain filename. This parameter is mutually +exclusive with the @var{-O} parameters. It is currently required to also u= se +the @var{-n} parameter to skip image creation. This restriction may be rel= axed +in a future release. + +@item --backing-chain +will enumerate information about backing files in a disk image chain. Refer +below for further description. + @item -c indicates that target image must be compressed (qcow format only) + @item -h with or without a command shows help and lists the supported formats + @item -p display progress bar (compare, convert and rebase commands only). If the @var{-p} option is not used for a command that supports it, the progress is reported when the process receives a @code{SIGUSR1} or @code{SIGINFO} signal. + @item -q Quiet mode - do not print any output (except errors). There's no progress = bar in case both @var{-q} and @var{-p} options are used. + @item -S @var{size} indicates the consecutive number of bytes that must contain only zeros for qemu-img to create a sparse image during conversion. This value is rou= nded down to the nearest 512 bytes. You may use the common size suffixes like @code{k} for kilobytes. + @item -t @var{cache} specifies the cache mode that should be used with the (destination) file. = See the documentation of the emulator's @code{-drive cache=3D...} option for a= llowed values. + @item -T @var{src_cache} specifies the cache mode that should be used with the source file(s). See the documentation of the emulator's @code{-drive cache=3D...} option for a= llowed values. + @end table =20 Parameters to snapshot subcommand: --=20 2.14.3 From nobody Tue Oct 28 12:17:40 2025 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) client-ip=208.118.235.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) by mx.zohomail.com with SMTPS id 1514257027105167.47481292918292; Mon, 25 Dec 2017 18:57:07 -0800 (PST) Received: from localhost ([::1]:47967 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eTfQN-0000um-20 for importer@patchew.org; Mon, 25 Dec 2017 21:57:03 -0500 Received: from eggs.gnu.org ([2001:4830:134:3::10]:38863) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eTfMY-0006lI-FV for qemu-devel@nongnu.org; Mon, 25 Dec 2017 21:53:09 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eTfMX-0004TS-PZ for qemu-devel@nongnu.org; Mon, 25 Dec 2017 21:53:06 -0500 Received: from mx1.redhat.com ([209.132.183.28]:53592) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1eTfMV-0004Qn-Cm; Mon, 25 Dec 2017 21:53:03 -0500 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 6F89785A07; Tue, 26 Dec 2017 02:53:02 +0000 (UTC) Received: from lemon.redhat.com (ovpn-12-61.pek2.redhat.com [10.72.12.61]) by smtp.corp.redhat.com (Postfix) with ESMTP id DC13C60C8A; Tue, 26 Dec 2017 02:52:58 +0000 (UTC) From: Fam Zheng To: qemu-devel@nongnu.org Date: Tue, 26 Dec 2017 10:52:47 +0800 Message-Id: <20171226025247.11082-3-famz@redhat.com> In-Reply-To: <20171226025247.11082-1-famz@redhat.com> References: <20171226025247.11082-1-famz@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.26]); Tue, 26 Dec 2017 02:53:02 +0000 (UTC) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 209.132.183.28 Subject: [Qemu-devel] [PATCH v5 2/2] qemu-img: Document --force-share / -U X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Kevin Wolf , qemu-block@nongnu.org, kchamart@redhat.com, Max Reitz , stefanha@redhat.com Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail: RSF_0 Z_629925259 SPT_0 Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Signed-off-by: Fam Zheng Reviewed-by: Stefan Hajnoczi Reviewed-by: Kashyap Chamarthy Signed-off-by: Kevin Wolf --- qemu-img.texi | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/qemu-img.texi b/qemu-img.texi index 60a0e080c6..e83e140f7a 100644 --- a/qemu-img.texi +++ b/qemu-img.texi @@ -86,6 +86,15 @@ exclusive with the @var{-O} parameters. It is currently = required to also use the @var{-n} parameter to skip image creation. This restriction may be rel= axed in a future release. =20 +@item --force-share (-U) + +If specified, @code{qemu-img} will open the image with shared permissions, +which makes it less likely to conflict with a running guest's permissions = due +to image locking. For example, this can be used to get the image informati= on +(with 'info' subcommand) when the image is used by a running guest. Note t= hat +this could produce inconsistent results because of concurrent metadata cha= nges, +etc. This option is only allowed when opening images in read-only mode. + @item --backing-chain will enumerate information about backing files in a disk image chain. Refer below for further description. --=20 2.14.3