Browse Source

qemu-img.texi: Describe human-readable info output

Ideally, it should be self-explanatory.  However, keys like "disk size"
arguably really are not self-explanatory.  In any case, there is no harm
in going into a some more detail here.

Signed-off-by: Max Reitz <mreitz@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
master
Max Reitz 1 month ago
parent
commit
4db4390ef3
1 changed files with 41 additions and 0 deletions
  1. 41
    0
      qemu-img.texi

+ 41
- 0
qemu-img.texi View File

@@ -428,6 +428,47 @@ The command can output in the format @var{ofmt} which is either @code{human} or
428 428
 @code{json}.  The JSON output is an object of QAPI type @code{ImageInfo}; with
429 429
 @code{--backing-chain}, it is an array of @code{ImageInfo} objects.
430 430
 
431
+@code{--output=human} reports the following information (for every image in the
432
+chain):
433
+@table @var
434
+@item image
435
+The image file name
436
+
437
+@item file format
438
+The image format
439
+
440
+@item virtual size
441
+The size of the guest disk
442
+
443
+@item disk size
444
+How much space the image file occupies on the host file system (may be shown as
445
+0 if this information is unavailable, e.g. because there is no file system)
446
+
447
+@item cluster_size
448
+Cluster size of the image format, if applicable
449
+
450
+@item encrypted
451
+Whether the image is encrypted (only present if so)
452
+
453
+@item cleanly shut down
454
+This is shown as @code{no} if the image is dirty and will have to be
455
+auto-repaired the next time it is opened in qemu.
456
+
457
+@item backing file
458
+The backing file name, if present
459
+
460
+@item backing file format
461
+The format of the backing file, if the image enforces it
462
+
463
+@item Snapshot list
464
+A list of all internal snapshots
465
+
466
+@item Format specific information
467
+Further information whose structure depends on the image format.  This section
468
+is a textual representation of the respective @code{ImageInfoSpecific*} QAPI
469
+object (e.g. @code{ImageInfoSpecificQCow2} for qcow2 images).
470
+@end table
471
+
431 472
 @item map [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [--output=@var{ofmt}] [-U] @var{filename}
432 473
 
433 474
 Dump the metadata of image @var{filename} and its backing file chain.

Loading…
Cancel
Save