VirtualBox

source: vbox/trunk/doc/manual/en_US/man_VBoxManage-convertfromraw.xml@ 85704

Last change on this file since 85704 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: 9.7 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 manpage, user manual, usage: VBoxManage convertfromraw
4
5 Copyright (C) 2006-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"
16 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
17<!ENTITY % all.entities SYSTEM "all-entities.ent">
18%all.entities;
19]>
20<refentry id="vboxmanage-convertfromraw" lang="en">
21 <refentryinfo>
22 <pubdate>September 2019</pubdate>
23 <title>VBoxManage convertfromraw</title>
24 </refentryinfo>
25
26 <refmeta>
27 <refentrytitle>VBoxManage-convertfromraw</refentrytitle>
28 <manvolnum>1</manvolnum>
29 </refmeta>
30
31 <refnamediv>
32 <refname>VBoxManage-convertfromraw</refname>
33 <refpurpose>convert a raw disk image to a virtual disk image</refpurpose>
34 <refclass>Oracle VM VirtualBox</refclass>
35 </refnamediv>
36
37 <refsynopsisdiv>
38<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
39 <cmdsynopsis id="synopsis-vboxmanage-convertfromraw-file">
40 <command>VBoxManage convertfromraw</command>
41 <arg choice="req"><replaceable>inputfile</replaceable></arg>
42 <arg choice="req"><replaceable>outputfile</replaceable></arg>
43 <arg>--format=<group choice="plain">
44 <arg choice="plain">VDI</arg>
45 <arg choice="plain">VMDK</arg>
46 <arg choice="plain">VHD</arg>
47 </group></arg>
48 <arg>--uuid=<replaceable>uuid</replaceable></arg>
49 <arg>--variant=Standard,Fixed,Split2G,Stream,ESX</arg>
50 </cmdsynopsis>
51
52 <cmdsynopsis id="synopsis-vboxmanage-convertfromraw-stdin">
53 <command>VBoxManage convertfromraw stdin</command>
54 <arg choice="req"><replaceable>outputfile</replaceable></arg>
55 <arg>--format=<group choice="plain">
56 <arg choice="plain">VDI</arg>
57 <arg choice="plain">VMDK</arg>
58 <arg choice="plain">VHD</arg>
59 </group></arg>
60 <arg>--uuid=<replaceable>uuid</replaceable></arg>
61 <arg>--variant=Standard,Fixed,Split2G,Stream,ESX</arg>
62 </cmdsynopsis>
63 </refsynopsisdiv>
64
65 <refsect1>
66 <title>Description</title>
67 <para>
68 The <command>VBoxManage convertfromraw</command> command enables
69 you to convert a raw disk image to an &product-name; virtual disk
70 image (VDI).
71 </para>
72 <note>
73 <para>
74 For compatibility with earlier versions of &product-name;, you
75 can use the <command>VBoxManage convertdd</command> command
76 instead of the <command>VBoxManage convertfromraw</command>
77 command.
78 </para>
79 </note>
80 <refsect2 id="vboxmanage-convertfromraw-file">
81 <title>Convert a Raw Disk File to a Virtual Disk Image File</title>
82 <remark role="help-copy-synopsis"/>
83 <para>
84 The <command>VBoxManage convertfromraw</command> command
85 converts the specified raw disk image input file to an
86 &product-name; VDI file.
87 </para>
88 <variablelist>
89 <varlistentry>
90 <term><replaceable>inputfile</replaceable></term>
91 <listitem><para>
92 Specifies the name of the raw disk image file to convert.
93 </para></listitem>
94 </varlistentry>
95 <varlistentry>
96 <term><replaceable>outputfile</replaceable></term>
97 <listitem><para>
98 Specifies the name of the file in which to write the VDI
99 output.
100 </para></listitem>
101 </varlistentry>
102 <varlistentry>
103 <term><option>--format=VDI | VMDK | VHD</option></term>
104 <listitem><para>
105 Specifies the format of the disk image to create. Valid
106 values are <literal>VDI</literal>,
107 <literal>VMDK</literal>, and <literal>VHD</literal>. The
108 default format is <literal>VDI</literal>.
109 </para></listitem>
110 </varlistentry>
111 <varlistentry>
112 <term><option>--uuid=<replaceable>uuid</replaceable></option></term>
113 <listitem><para>
114 Specifies the Universally Unique Identifier (UUID) of the
115 output file.
116 </para></listitem>
117 </varlistentry>
118 <varlistentry>
119 <term><option>--variant=Standard,Fixed,Split2G,Stream,ESX</option></term>
120 <listitem><para>
121 Specifies any required file format variants for the output
122 file. This is a comma-separated list of variant values.
123 Following are the valid values:
124 </para><itemizedlist>
125 <listitem><para>
126 <literal>Standard</literal> is the default disk image
127 type, which has a dynamically allocated file size.
128 </para></listitem>
129 <listitem><para>
130 <literal>Fixed</literal> uses a disk image that has a
131 fixed file size.
132 </para></listitem>
133 <listitem><para>
134 <literal>Split2G</literal> indicates that the disk
135 image is split into 2GB segments. This value is for
136 VMDK only.
137 </para></listitem>
138 <listitem><para>
139 <literal>Stream</literal> optimizes the disk image for
140 downloading. This value is for VMDK only.
141 </para></listitem>
142 <listitem><para>
143 <literal>ESX</literal> is used for some VMWare
144 products. This value is for VMDK only.
145 </para></listitem>
146 </itemizedlist><para>
147 Note that not all variant combinations are valid.
148 Specifying incompatible variant values in the list will
149 produce an error message.
150 </para></listitem>
151 </varlistentry>
152 </variablelist>
153 </refsect2>
154 <refsect2 id="vboxmanage-convertfromraw-stdin">
155 <title>Convert Raw Data From Standard Input to a Virtual Disk Image File</title>
156 <remark role="help-copy-synopsis"/>
157 <para>
158 The <command>VBoxManage convertfromraw stdin</command> command
159 reads the content of the disk image from standard input.
160 Consider using this form of the command in a pipe sequence.
161 </para>
162 <variablelist>
163 <varlistentry>
164 <term><replaceable>outputfile</replaceable></term>
165 <listitem><para>
166 Specifies the name of the file in which to write the VDI
167 output.
168 </para></listitem>
169 </varlistentry>
170 <varlistentry>
171 <term><option>--format=VDI | VMDK | VHD</option></term>
172 <listitem><para>
173 Specifies the format of the disk image to create. Valid
174 values are <literal>VDI</literal>,
175 <literal>VMDK</literal>, and <literal>VHD</literal>. The
176 default format is <literal>VDI</literal>.
177 </para></listitem>
178 </varlistentry>
179 <varlistentry>
180 <term><option>--uuid=<replaceable>uuid</replaceable></option></term>
181 <listitem><para>
182 Specifies the UUID of the output file.
183 </para></listitem>
184 </varlistentry>
185 <varlistentry>
186 <term><option>--variant=Standard,Fixed,Split2G,Stream,ESX</option></term>
187 <listitem><para>
188 Specifies any required file format variants for the output
189 file. This is a comma-separated list of variant values.
190 Following are the valid values:
191 </para><itemizedlist>
192 <listitem><para>
193 <literal>Standard</literal> is the default disk image
194 type, which has a dynamically allocated file size.
195 </para></listitem>
196 <listitem><para>
197 <literal>Fixed</literal> uses a disk image that has a
198 fixed file size.
199 </para></listitem>
200 <listitem><para>
201 <literal>Split2G</literal> indicates that the disk
202 image is split into 2GB segments. This value is for
203 VMDK only.
204 </para></listitem>
205 <listitem><para>
206 <literal>Stream</literal> optimizes the disk image for
207 downloading. This value is for VMDK only.
208 </para></listitem>
209 <listitem><para>
210 <literal>ESX</literal> is used for some VMWare
211 products. This value is for VMDK only.
212 </para></listitem>
213 </itemizedlist><para>
214 Note that not all variant combinations are valid.
215 Specifying incompatible variant values in the list will
216 produce an error message.
217 </para></listitem>
218 </varlistentry>
219 </variablelist>
220 </refsect2>
221 </refsect1>
222
223 <refsect1>
224 <title>Examples</title>
225 <remark role="help-scope" condition="GLOBAL" />
226 <para>
227 The following command converts the raw disk image input file
228 <filename>disk01.raw</filename>. The output file is a VDI disk
229 image called <filename>disk02.vdi</filename>.
230 </para>
231<screen>$ VBoxManage convertfromraw disk01.raw disk02.vdi</screen>
232 <para>
233 The following command converts the raw disk image input file
234 <filename>disk01.raw</filename>. The output file is a VMDK disk
235 image called <filename>disk02.vmdk</filename>.
236 </para>
237<screen>$ VBoxManage convertfromraw disk01.raw disk02.vmdk --format VMDK</screen>
238 </refsect1>
239</refentry>
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