Changeset 94203 in vbox for trunk/doc

Timestamp:

Mar 12, 2022 7:40:19 PM (3 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

150459

Message:

doc/manual,FE/VBoxManage: Convert convertfromraw command to refentry documentation, ​bugref:9186

Location:

trunk/doc/manual

Files:

• Config.kmk (modified) (1 diff)
• en_US/man_VBoxManage-convertfromraw.xml (modified) (2 diffs)
• en_US/user_VBoxManage.xml (modified) (1 diff)

trunk/doc/manual/Config.kmk

@@ -72 +72 @@
         man_VBoxManage-mediumproperty.xml \
         man_VBoxManage-encryptmedium.xml \
-        man_VBoxManage-checkmediumpwd.xml
+        man_VBoxManage-checkmediumpwd.xml \
+        man_VBoxManage-convertfromraw.xml
 
 ## List of user manual XML files.

trunk/doc/manual/en_US/man_VBoxManage-convertfromraw.xml

@@ -20 +20 @@
 <refentry id="vboxmanage-convertfromraw" lang="en">
   <refentryinfo>
-    <pubdate>September 2019</pubdate>
+    <pubdate>$Date$</pubdate>
     <title>VBoxManage convertfromraw</title>
   </refentryinfo>
@@ -32 +32 @@
     <refname>VBoxManage-convertfromraw</refname>
     <refpurpose>convert a raw disk image to a virtual disk image</refpurpose>
-    <refclass>Oracle VM VirtualBox</refclass>
+    <refclass>&product-name;</refclass>
   </refnamediv>
 

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -1097 +1097 @@
   <xi:include href="user_man_VBoxManage-checkmediumpwd.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
 
-  <sect1 id="vboxmanage-convertfromraw">
-
-    <title>VBoxManage convertfromraw</title>
-
-    <para>
-      This command converts a raw disk image to an &product-name; Disk
-      Image (VDI) file. The syntax is as follows:
-    </para>
-
-<screen>VBoxManage convertfromraw   &lt;filename&gt; &lt;outputfile&gt;
-                            [--format VDI|VMDK|VHD]
-                            [--variant Standard,Fixed,Split2G,Stream,ESX]
-                            [--uuid &lt;uuid&gt;]
-VBoxManage convertfromraw   stdin &lt;outputfile&gt; &lt;bytes&gt;
-                            [--format VDI|VMDK|VHD]
-                            [--variant Standard,Fixed,Split2G,Stream,ESX]
-                            [--uuid &lt;uuid&gt;]</screen>
-
-    <para>
-      The parameters are as follows:
-    </para>
-
-    <variablelist>
-
-      <varlistentry>
-        <term>
-          <computeroutput>--bytes</computeroutput>
-        </term>
-
-        <listitem>
-          <para>
-            The size of the image file, in bytes, provided through
-            stdin.
-          </para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term>
-          <computeroutput>--format</computeroutput>
-        </term>
-
-        <listitem>
-          <para>
-            Select the disk image format to create. The default format
-            is VDI. Other options are VMDK and VHD.
-          </para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term>
-          <computeroutput>--variant</computeroutput>
-        </term>
-
-        <listitem>
-          <para>
-            Choose a file format variant for the output file. This is a
-            comma-separated list of variant flags. Not all combinations
-            are supported, and specifying inconsistent flags will result
-            in an error message.
-          </para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term>
-          <computeroutput>--uuid</computeroutput>
-        </term>
-
-        <listitem>
-          <para>
-            Specify the UUID of the output file.
-          </para>
-        </listitem>
-      </varlistentry>
-
-    </variablelist>
-
-    <para>
-      The <command>stdin</command> form of the command forces
-      <command>VBoxManage</command> to read the content of the disk
-      image from standard input. This useful when using the command in a
-      pipe.
-    </para>
-
-    <note>
-      <para>
-        For compatibility with earlier versions of &product-name;, the
-        <command>convertdd</command> command is also supported and
-        mapped internally to the <command>convertfromraw</command>
-        command.
-      </para>
-    </note>
-
-  </sect1>
+  <xi:include href="user_man_VBoxManage-convertfromraw.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
 
   <xi:include href="user_man_VBoxManage-mediumio.xml"       xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />