[56168] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
| 2 | <!--
|
---|
[72949] | 3 | manpage, user manual, usage: VBoxManage mediumio
|
---|
[96300] | 4 | -->
|
---|
| 5 | <!--
|
---|
[98103] | 6 | Copyright (C) 2018-2023 Oracle and/or its affiliates.
|
---|
[56168] | 7 |
|
---|
[96407] | 8 | This file is part of VirtualBox base platform packages, as
|
---|
| 9 | available from https://www.virtualbox.org.
|
---|
| 10 |
|
---|
| 11 | This program is free software; you can redistribute it and/or
|
---|
| 12 | modify it under the terms of the GNU General Public License
|
---|
| 13 | as published by the Free Software Foundation, in version 3 of the
|
---|
| 14 | License.
|
---|
| 15 |
|
---|
| 16 | This program is distributed in the hope that it will be useful, but
|
---|
| 17 | WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
| 18 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
---|
| 19 | General Public License for more details.
|
---|
| 20 |
|
---|
| 21 | You should have received a copy of the GNU General Public License
|
---|
| 22 | along with this program; if not, see <https://www.gnu.org/licenses>.
|
---|
| 23 |
|
---|
| 24 | SPDX-License-Identifier: GPL-3.0-only
|
---|
[96300] | 25 | -->
|
---|
[93803] | 26 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 27 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
|
---|
| 28 | <!ENTITY % all.entities SYSTEM "all-entities.ent">
|
---|
| 29 | %all.entities;
|
---|
| 30 | ]>
|
---|
[72949] | 31 | <refentry id="vboxmanage-mediumio" lang="en">
|
---|
[56168] | 32 | <refentryinfo>
|
---|
| 33 | <pubdate>$Date: 2023-04-21 21:59:02 +0000 (Fri, 21 Apr 2023) $</pubdate>
|
---|
[72949] | 34 | <title>VBoxManage mediumio</title>
|
---|
[56168] | 35 | </refentryinfo>
|
---|
| 36 |
|
---|
| 37 | <refmeta>
|
---|
[72949] | 38 | <refentrytitle>VBoxManage-mediumio</refentrytitle>
|
---|
[56168] | 39 | <manvolnum>1</manvolnum>
|
---|
| 40 | </refmeta>
|
---|
| 41 |
|
---|
| 42 | <refnamediv>
|
---|
[72949] | 43 | <refname>VBoxManage-mediumio</refname>
|
---|
| 44 | <refpurpose>medium content access</refpurpose>
|
---|
[93707] | 45 | <refclass>&product-name;</refclass>
|
---|
[56168] | 46 | </refnamediv>
|
---|
| 47 |
|
---|
| 48 | <refsynopsisdiv>
|
---|
[72949] | 49 | <cmdsynopsis id="synopsis-vboxmanage-mediumio-formatfat"> <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
|
---|
| 50 | <command>VBoxManage mediumio</command>
|
---|
| 51 | <group choice="req">
|
---|
[77361] | 52 | <arg choice="plain">--disk=<replaceable>uuid|filename</replaceable></arg>
|
---|
| 53 | <arg choice="plain">--dvd=<replaceable>uuid|filename</replaceable></arg>
|
---|
| 54 | <arg choice="plain">--floppy=<replaceable>uuid|filename</replaceable></arg>
|
---|
[72949] | 55 | </group>
|
---|
[77176] | 56 | <arg>--password-file=<replaceable>-|filename</replaceable></arg>
|
---|
[72949] | 57 | <arg choice="plain">formatfat</arg>
|
---|
| 58 | <arg>--quick</arg>
|
---|
[56168] | 59 | </cmdsynopsis>
|
---|
[72949] | 60 | <cmdsynopsis id="synopsis-vboxmanage-mediumio-cat">
|
---|
| 61 | <command>VBoxManage mediumio</command>
|
---|
| 62 | <group choice="req">
|
---|
[77361] | 63 | <arg choice="plain">--disk=<replaceable>uuid|filename</replaceable></arg>
|
---|
| 64 | <arg choice="plain">--dvd=<replaceable>uuid|filename</replaceable></arg>
|
---|
| 65 | <arg choice="plain">--floppy=<replaceable>uuid|filename</replaceable></arg>
|
---|
[72949] | 66 | </group>
|
---|
[77176] | 67 | <arg>--password-file=<replaceable>-|filename</replaceable></arg>
|
---|
[72949] | 68 | <arg choice="plain">cat</arg>
|
---|
| 69 | <arg>--hex</arg>
|
---|
| 70 | <arg>--offset=<replaceable>byte-offset</replaceable></arg>
|
---|
| 71 | <arg>--size=<replaceable>bytes</replaceable></arg>
|
---|
| 72 | <arg>--output=<replaceable>-|filename</replaceable></arg>
|
---|
[56168] | 73 | </cmdsynopsis>
|
---|
[74822] | 74 | <cmdsynopsis id="synopsis-vboxmanage-mediumio-stream">
|
---|
| 75 | <command>VBoxManage mediumio</command>
|
---|
| 76 | <group choice="req">
|
---|
[77361] | 77 | <arg choice="plain">--disk=<replaceable>uuid|filename</replaceable></arg>
|
---|
| 78 | <arg choice="plain">--dvd=<replaceable>uuid|filename</replaceable></arg>
|
---|
| 79 | <arg choice="plain">--floppy=<replaceable>uuid|filename</replaceable></arg>
|
---|
[74822] | 80 | </group>
|
---|
[77176] | 81 | <arg>--password-file=<replaceable>-|filename</replaceable></arg>
|
---|
[74822] | 82 | <arg choice="plain">stream</arg>
|
---|
| 83 | <arg>--format=<replaceable>image-format</replaceable></arg>
|
---|
| 84 | <arg>--variant=<replaceable>image-variant</replaceable></arg>
|
---|
| 85 | <arg>--output=<replaceable>-|filename</replaceable></arg>
|
---|
| 86 | </cmdsynopsis>
|
---|
[56168] | 87 | </refsynopsisdiv>
|
---|
| 88 |
|
---|
[99513] | 89 | <refsect1 id="vboxmanage-mediumio-description">
|
---|
[56168] | 90 | <title>Description</title>
|
---|
| 91 |
|
---|
[72949] | 92 | <refsect2 id="vboxmanage-mediumio-common-options">
|
---|
| 93 | <title>Common options</title>
|
---|
| 94 | <remark role="help-scope" condition="GLOBAL"/>
|
---|
| 95 | <para>The subcommands of <command>mediumio</command> all operate on a medium which need to be specified, optionally
|
---|
| 96 | with an encryption password. The following common options can be placed before or after the sub-command:</para>
|
---|
[56168] | 97 | <variablelist>
|
---|
| 98 | <varlistentry>
|
---|
[72949] | 99 | <term>--disk=<replaceable>uuid|filename</replaceable></term>
|
---|
| 100 | <listitem><para>Either the UUID or filename of a harddisk image, e.g. VDI, VMDK, VHD, ++.</para></listitem>
|
---|
[56168] | 101 | </varlistentry>
|
---|
| 102 | <varlistentry>
|
---|
[72949] | 103 | <term>--dvd=<replaceable>uuid|filename</replaceable></term>
|
---|
| 104 | <listitem><para>Either the UUID or filename of a DVD image, e.g. ISO, DMG, CUE.</para></listitem>
|
---|
[56168] | 105 | </varlistentry>
|
---|
[72949] | 106 | <varlistentry>
|
---|
| 107 | <term>--floppy=<replaceable>uuid|filename</replaceable></term>
|
---|
| 108 | <listitem><para>Either the UUID or filename of a floppy image, e.g. IMG.</para></listitem>
|
---|
| 109 | </varlistentry>
|
---|
| 110 | <varlistentry>
|
---|
| 111 | <term>--password-file=<replaceable>-|filename</replaceable></term>
|
---|
| 112 | <listitem><para>The name of a file containing the medium encryption password. If <option>-</option>
|
---|
| 113 | is specified, the password will be read from stdin. </para></listitem>
|
---|
| 114 | </varlistentry>
|
---|
[56168] | 115 | </variablelist>
|
---|
| 116 | </refsect2>
|
---|
| 117 |
|
---|
[72949] | 118 | <refsect2 id="vboxmanage-mediumio-formatfat">
|
---|
| 119 | <title>mediumio formatfat</title>
|
---|
[56466] | 120 | <remark role="help-copy-synopsis"/>
|
---|
[56168] | 121 | <para>
|
---|
[72949] | 122 | Formats a floppy medium with the FAT file system. This will erase the
|
---|
| 123 | content of the medium.
|
---|
[56168] | 124 | </para>
|
---|
| 125 | <variablelist>
|
---|
| 126 | <varlistentry>
|
---|
[72949] | 127 | <term><option>--quick</option></term><listitem><para>Quickformat the medium.</para></listitem>
|
---|
[56168] | 128 | </varlistentry>
|
---|
| 129 | </variablelist>
|
---|
| 130 | </refsect2>
|
---|
| 131 |
|
---|
[72949] | 132 | <refsect2 id="vboxmanage-mediumio-cat">
|
---|
| 133 | <title>mediumio cat</title>
|
---|
[56466] | 134 | <remark role="help-copy-synopsis"/>
|
---|
[56168] | 135 | <para>
|
---|
[72949] | 136 | Dumps the medium content to stdout or the specified file.
|
---|
[56168] | 137 | </para>
|
---|
[72949] | 138 | <variablelist>
|
---|
| 139 | <varlistentry>
|
---|
| 140 | <term><option>--hex</option></term><listitem><para>Dump as hex bytes.</para></listitem>
|
---|
| 141 | </varlistentry>
|
---|
| 142 | <varlistentry>
|
---|
| 143 | <term><option>--offset</option></term><listitem><para>The byte offset in the medium to start.</para></listitem>
|
---|
| 144 | </varlistentry>
|
---|
| 145 | <varlistentry>
|
---|
| 146 | <term><option>--size</option></term><listitem><para>The number of bytes to dump.</para></listitem>
|
---|
| 147 | </varlistentry>
|
---|
| 148 | <varlistentry>
|
---|
| 149 | <term><option>--output</option></term>
|
---|
| 150 | <listitem><para>The output filename. As usual <option>-</option> is take to mean stdout.</para></listitem>
|
---|
| 151 | </varlistentry>
|
---|
| 152 | </variablelist>
|
---|
[56168] | 153 | </refsect2>
|
---|
| 154 |
|
---|
[74822] | 155 | <refsect2 id="vboxmanage-mediumio-stream">
|
---|
| 156 | <title>mediumio stream</title>
|
---|
| 157 | <remark role="help-copy-synopsis"/>
|
---|
| 158 | <para>
|
---|
| 159 | Converts the medium to a streamable format and dumps it to the given output.
|
---|
| 160 | </para>
|
---|
| 161 | <variablelist>
|
---|
| 162 | <varlistentry>
|
---|
| 163 | <term><option>--format</option></term><listitem><para>The format of the destination image.</para></listitem>
|
---|
| 164 | </varlistentry>
|
---|
| 165 | <varlistentry>
|
---|
| 166 | <term><option>--variant</option></term><listitem><para>The medium variant for the destination.</para></listitem>
|
---|
| 167 | </varlistentry>
|
---|
| 168 | <varlistentry>
|
---|
| 169 | <term><option>--output</option></term>
|
---|
| 170 | <listitem><para>The output filename. As usual <option>-</option> is take to mean stdout.</para></listitem>
|
---|
| 171 | </varlistentry>
|
---|
| 172 | </variablelist>
|
---|
| 173 | </refsect2>
|
---|
| 174 |
|
---|
[56168] | 175 | </refsect1>
|
---|
[56171] | 176 |
|
---|
[56168] | 177 | </refentry>
|
---|
| 178 |
|
---|