Changeset 74822 in vbox for trunk/doc/manual/en_US

Timestamp:

Oct 12, 2018 6:40:09 PM (6 years ago)

Author:

vboxsync

Message:

Main: bugref:9152 Implement the convertToStream API

File:

• trunk/doc/manual/en_US/man_VBoxManage-mediumio.xml (modified) (2 diffs)

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

@@ -56 +56 @@
       <arg>--offset=<replaceable>byte-offset</replaceable></arg>
       <arg>--size=<replaceable>bytes</replaceable></arg>
+      <arg>--output=<replaceable>-|filename</replaceable></arg>
+    </cmdsynopsis>
+    <cmdsynopsis id="synopsis-vboxmanage-mediumio-stream">
+      <command>VBoxManage mediumio</command>
+      <group choice="req">
+        <arg>--disk=<replaceable>uuid|filename</replaceable></arg>
+        <arg>--dvd=<replaceable>uuid|filename</replaceable></arg>
+        <arg>--floppy=<replaceable>uuid|filename</replaceable></arg>
+      </group>
+      <arg>--password-file<replaceable>-|filename</replaceable></arg>
+      <arg choice="plain">stream</arg>
+      <arg>--format=<replaceable>image-format</replaceable></arg>
+      <arg>--variant=<replaceable>image-variant</replaceable></arg>
       <arg>--output=<replaceable>-|filename</replaceable></arg>
     </cmdsynopsis>
@@ -126 +139 @@
     </refsect2>
 
+    <refsect2 id="vboxmanage-mediumio-stream">
+      <title>mediumio stream</title>
+      <remark role="help-copy-synopsis"/>
+      <para>
+        Converts the medium to a streamable format and dumps it to the given output.
+      </para>
+      <variablelist>
+        <varlistentry>
+          <term><option>--format</option></term><listitem><para>The format of the destination image.</para></listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><option>--variant</option></term><listitem><para>The medium variant for the destination.</para></listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><option>--output</option></term>
+          <listitem><para>The output filename.  As usual <option>-</option> is take to mean stdout.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
+
   </refsect1>