diff options
Diffstat (limited to 'doc/manual/en_US/man_VBoxManage-showmediuminfo.xml')
| -rw-r--r-- | doc/manual/en_US/man_VBoxManage-showmediuminfo.xml | 142 |
1 files changed, 142 insertions, 0 deletions
diff --git a/doc/manual/en_US/man_VBoxManage-showmediuminfo.xml b/doc/manual/en_US/man_VBoxManage-showmediuminfo.xml new file mode 100644 index 00000000..55d06f33 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-showmediuminfo.xml @@ -0,0 +1,142 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + manpage, user manual, usage: VBoxManage showmediuminfo +--> +<!-- + Copyright (C) 2006-2023 Oracle and/or its affiliates. + + This file is part of VirtualBox base platform packages, as + available from https://www.virtualbox.org. + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation, in version 3 of the + License. + + This program is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, see <https://www.gnu.org/licenses>. + + SPDX-License-Identifier: GPL-3.0-only +--> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[ +<!ENTITY % all.entities SYSTEM "all-entities.ent"> +%all.entities; +]> +<refentry id="vboxmanage-showmediuminfo" lang="en"> + <refentryinfo> + <pubdate>$Date: 2023-01-17 15:15:46 +0100 (Tue, 17 Jan 2023) $</pubdate> + <title>VBoxManage showmediuminfo</title> + </refentryinfo> + + <refmeta> + <refentrytitle>VBoxManage-showmediuminfo</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>VBoxManage-showmediuminfo</refname> + <refpurpose>show information about a medium</refpurpose> + <refclass>&product-name;</refclass> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis id="synopsis-vboxmanage-showmediuminfo"> +<!-- The 'id' is mandatory and must start with 'synopsis-'. --> + <command>VBoxManage showmediuminfo</command> + <group> + <arg choice="plain">disk</arg> + <arg choice="plain">dvd</arg> + <arg choice="plain">floppy</arg> + </group> + <group choice="req"> + <arg choice="plain"><replaceable>uuid</replaceable></arg> + <arg choice="plain"><replaceable>filename</replaceable></arg> + </group> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + <para> + The <command>VBoxManage showmediuminfo</command> command shows the + following information about a medium: + </para> + <itemizedlist> + <listitem><para> + Size + </para></listitem> + <listitem><para> + Size on disk + </para></listitem> + <listitem><para> + Type + </para></listitem> + <listitem><para> + In use by virtual machines (VMs) + </para></listitem> + </itemizedlist> + <para> + The medium must be specified either by its UUID, if the medium is + registered, or by its filename. Registered images can be listed + using <command>VBoxManage list hdds</command>, <command>VBoxManage + list dvds</command>, or <command>VBoxManage list + floppies</command>, as appropriate. + </para> + <para> + For backward compatibility, you can also use the + <command>showvdiinfo</command> command to obtain information about + the medium. + </para> + <variablelist> + <varlistentry> + <term><literal>disk</literal> | <literal>dvd</literal> | <literal>floppy</literal></term> + <listitem><para> + Specifies the type of medium. Valid values are + <literal>disk</literal> (hard drive), + <literal>dvd</literal>, or <literal>floppy</literal>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><replaceable>uuid</replaceable> | <replaceable>filename</replaceable></term> + <listitem><para> + Specifies the Universally Unique Identifier (UUID) or + absolute path name of the medium or image. + </para><para> + If the medium is registered, you can specify the UUID. You + can also list registered images by using the + <command>VBoxManage list hdds</command>, <command>VBoxManage + list dvds</command>, or <command>VBoxManage list + floppies</command> command. + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Examples</title> + <remark role="help-scope" condition="GLOBAL" /> + <para> + The following command shows information about the + <filename>disk01.vdi</filename> disk image: + </para> +<screen>$ VBoxManage showmediuminfo disk01.vdi</screen> + <para> + The following command shows information about the + <filename>floppy01.img</filename> floppy disk image. + </para> +<screen>$ VBoxManage showmediuminfo floppy floppy01.img</screen> + </refsect1> + + <refsect1> + <title>See Also</title> + <para> + <xref linkend="vboxmanage-list" /> + </para> + </refsect1> +</refentry> |