VirtualBox

source: vbox/trunk/doc/manual/en_US/man_VBoxManage-mediumio.xml@ 93585

Last change on this file since 93585 was 82969, checked in by vboxsync, 5 years ago

Copyright year updates - manual ones.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 6.9 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 manpage, user manual, usage: VBoxManage mediumio
4
5 Copyright (C) 2018-2020 Oracle Corporation
6
7 This file is part of VirtualBox Open Source Edition (OSE), as
8 available from http://www.virtualbox.org. This file is free software;
9 you can redistribute it and/or modify it under the terms of the GNU
10 General Public License (GPL) as published by the Free Software
11 Foundation, in version 2 as it comes in the "COPYING" file of the
12 VirtualBox OSE distribution. VirtualBox OSE is distributed in the
13 hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
14 -->
15<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
16<refentry id="vboxmanage-mediumio" lang="en">
17
18 <refentryinfo>
19 <pubdate>$Date: 2020-02-04 10:54:12 +0000 (Tue, 04 Feb 2020) $</pubdate>
20 <title>VBoxManage mediumio</title>
21 </refentryinfo>
22
23 <refmeta>
24 <refentrytitle>VBoxManage-mediumio</refentrytitle>
25 <manvolnum>1</manvolnum>
26 </refmeta>
27
28 <refnamediv>
29 <refname>VBoxManage-mediumio</refname>
30 <refpurpose>medium content access</refpurpose>
31 <refclass>Oracle VM VirtualBox</refclass>
32 </refnamediv>
33
34 <refsynopsisdiv>
35 <cmdsynopsis id="synopsis-vboxmanage-mediumio-formatfat"> <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
36 <command>VBoxManage mediumio</command>
37 <group choice="req">
38 <arg choice="plain">--disk=<replaceable>uuid|filename</replaceable></arg>
39 <arg choice="plain">--dvd=<replaceable>uuid|filename</replaceable></arg>
40 <arg choice="plain">--floppy=<replaceable>uuid|filename</replaceable></arg>
41 </group>
42 <arg>--password-file=<replaceable>-|filename</replaceable></arg>
43 <arg choice="plain">formatfat</arg>
44 <arg>--quick</arg>
45 </cmdsynopsis>
46 <cmdsynopsis id="synopsis-vboxmanage-mediumio-cat">
47 <command>VBoxManage mediumio</command>
48 <group choice="req">
49 <arg choice="plain">--disk=<replaceable>uuid|filename</replaceable></arg>
50 <arg choice="plain">--dvd=<replaceable>uuid|filename</replaceable></arg>
51 <arg choice="plain">--floppy=<replaceable>uuid|filename</replaceable></arg>
52 </group>
53 <arg>--password-file=<replaceable>-|filename</replaceable></arg>
54 <arg choice="plain">cat</arg>
55 <arg>--hex</arg>
56 <arg>--offset=<replaceable>byte-offset</replaceable></arg>
57 <arg>--size=<replaceable>bytes</replaceable></arg>
58 <arg>--output=<replaceable>-|filename</replaceable></arg>
59 </cmdsynopsis>
60 <cmdsynopsis id="synopsis-vboxmanage-mediumio-stream">
61 <command>VBoxManage mediumio</command>
62 <group choice="req">
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>
66 </group>
67 <arg>--password-file=<replaceable>-|filename</replaceable></arg>
68 <arg choice="plain">stream</arg>
69 <arg>--format=<replaceable>image-format</replaceable></arg>
70 <arg>--variant=<replaceable>image-variant</replaceable></arg>
71 <arg>--output=<replaceable>-|filename</replaceable></arg>
72 </cmdsynopsis>
73 </refsynopsisdiv>
74
75 <refsect1>
76 <title>Description</title>
77
78 <refsect2 id="vboxmanage-mediumio-common-options">
79 <title>Common options</title>
80 <remark role="help-scope" condition="GLOBAL"/>
81 <para>The subcommands of <command>mediumio</command> all operate on a medium which need to be specified, optionally
82 with an encryption password. The following common options can be placed before or after the sub-command:</para>
83 <variablelist>
84 <varlistentry>
85 <term>--disk=<replaceable>uuid|filename</replaceable></term>
86 <listitem><para>Either the UUID or filename of a harddisk image, e.g. VDI, VMDK, VHD, ++.</para></listitem>
87 </varlistentry>
88 <varlistentry>
89 <term>--dvd=<replaceable>uuid|filename</replaceable></term>
90 <listitem><para>Either the UUID or filename of a DVD image, e.g. ISO, DMG, CUE.</para></listitem>
91 </varlistentry>
92 <varlistentry>
93 <term>--floppy=<replaceable>uuid|filename</replaceable></term>
94 <listitem><para>Either the UUID or filename of a floppy image, e.g. IMG.</para></listitem>
95 </varlistentry>
96 <varlistentry>
97 <term>--password-file=<replaceable>-|filename</replaceable></term>
98 <listitem><para>The name of a file containing the medium encryption password. If <option>-</option>
99 is specified, the password will be read from stdin. </para></listitem>
100 </varlistentry>
101 </variablelist>
102 </refsect2>
103
104 <refsect2 id="vboxmanage-mediumio-formatfat">
105 <title>mediumio formatfat</title>
106 <remark role="help-copy-synopsis"/>
107 <para>
108 Formats a floppy medium with the FAT file system. This will erase the
109 content of the medium.
110 </para>
111 <variablelist>
112 <varlistentry>
113 <term><option>--quick</option></term><listitem><para>Quickformat the medium.</para></listitem>
114 </varlistentry>
115 </variablelist>
116 </refsect2>
117
118 <refsect2 id="vboxmanage-mediumio-cat">
119 <title>mediumio cat</title>
120 <remark role="help-copy-synopsis"/>
121 <para>
122 Dumps the medium content to stdout or the specified file.
123 </para>
124 <variablelist>
125 <varlistentry>
126 <term><option>--hex</option></term><listitem><para>Dump as hex bytes.</para></listitem>
127 </varlistentry>
128 <varlistentry>
129 <term><option>--offset</option></term><listitem><para>The byte offset in the medium to start.</para></listitem>
130 </varlistentry>
131 <varlistentry>
132 <term><option>--size</option></term><listitem><para>The number of bytes to dump.</para></listitem>
133 </varlistentry>
134 <varlistentry>
135 <term><option>--output</option></term>
136 <listitem><para>The output filename. As usual <option>-</option> is take to mean stdout.</para></listitem>
137 </varlistentry>
138 </variablelist>
139 </refsect2>
140
141 <refsect2 id="vboxmanage-mediumio-stream">
142 <title>mediumio stream</title>
143 <remark role="help-copy-synopsis"/>
144 <para>
145 Converts the medium to a streamable format and dumps it to the given output.
146 </para>
147 <variablelist>
148 <varlistentry>
149 <term><option>--format</option></term><listitem><para>The format of the destination image.</para></listitem>
150 </varlistentry>
151 <varlistentry>
152 <term><option>--variant</option></term><listitem><para>The medium variant for the destination.</para></listitem>
153 </varlistentry>
154 <varlistentry>
155 <term><option>--output</option></term>
156 <listitem><para>The output filename. As usual <option>-</option> is take to mean stdout.</para></listitem>
157 </varlistentry>
158 </variablelist>
159 </refsect2>
160
161 </refsect1>
162
163</refentry>
164
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette