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

Timestamp:

Jul 7, 2015 11:03:14 AM (9 years ago)

Author:

vboxsync

Message:

doc/manual: VBoxManage fixes

File:

• trunk/doc/manual/en_US/user_VBoxManage.xml (modified) (6 diffs)

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -1182 +1182 @@
             see <xref linkend="settings-usb" /> for details.</para>
           </listitem>
+          <!-- @todo r=andy Document tracing-* commands -->
         </itemizedlist></para>
 
-        <!-- @todo r=andy Document tracing-* commands -->
+    </sect2>
+
+    <sect2 id="vboxmanage-modifyvm-videocap">
+      <title>Video Capture settings</title>
+
+      <para>The following settings for changing video recording parameters are
+      available through <computeroutput>VBoxManage modifyvm</computeroutput>.
+      <itemizedlist>
+        <listitem>
+          <para><computeroutput>--videocap on|off</computeroutput>:
+          This option enables or disables recording a VM session into a WebM/VP8
+          file. If this option is enabled, recording will start when the VM
+          session is started.</para>
+        </listitem>
+        <listitem>
+          <para><computeroutput>--videocapscreens all|&lt;screen ID&gt;
+          [&lt;screen ID&gt; ...]</computeroutput>: This option allows to specify which screens of
+          the VM are being recorded. Each screen is recorded into a separate file.</para>
+        </listitem>
+        <listitem>
+          <para><computeroutput>--videocapfile &lt;filename&gt;</computeroutput>:
+            This option sets the filename VirtualBox uses to save the recorded content.
+          </para>
+        </listitem>
+        <listitem>
+          <para><computeroutput>--videocapres &lt;width&gt;x&lt;height&gt;</computeroutput>:
+            This option sets the resolution (in pixels) of the recorded video.</para>
+        </listitem>
+        <listitem>
+          <para><computeroutput>--videocaprate &lt;rate&gt;</computeroutput>:
+            This option sets the bitrate in kilobits (kb) per second. Increasing this
+            value makes the video look better for the cost of an increased file size.</para>
+        </listitem>
+        <listitem>
+          <para><computeroutput>--videocapfps &lt;fps&gt;</computeroutput>:
+            This option sets the maximum number of frames per second (FPS) to be
+            recorded. Frames with a higher frequency will be skipped. Reducing this
+            value increases the number of skipped frames and reduces the file size.</para>
+        </listitem>
+        <listitem>
+          <para><computeroutput>--videocapmaxtime &lt;ms&gt;</computeroutput>:
+            This option sets the maximum time in milliseconds the video capturing
+            will be enabled since activation. The capturing stops when the defined
+            time interval has elapsed. If this value is zero the capturing is not
+            limited by time.</para>
+        </listitem>
+        <listitem>
+          <para><computeroutput>--videocapmaxsize &lt;MB&gt;</computeroutput>:
+            This option limits the maximum size of the captured video file (in MB).
+            The capturing stops when the file size has reached the specified size. If
+            this value is zero the capturing will not be limited by file size.</para>
+        </listitem>
+        <listitem>
+          <para><computeroutput>--videocapopts &lt;key=value&gt;
+            [,&lt;key=value&gt; ...]</computeroutput>:
+            This format can be used to specify additional video capturing options.
+            These options only are for advanced users and must be specified in a
+            comma-separated key=value format, e.g.
+            <computeroutput>foo=bar,a=b</computeroutput>.
+          </para>
+        </listitem>
+      </itemizedlist></para>
+
     </sect2>
 
@@ -1844 +1907 @@
 
       <listitem>
-        <para><computeroutput>videocapscreens all|&lt;screen ID&gt; [&lt;screen ID&gt; ...]]</computeroutput>
-        allows to specify which screens of the VM are being recorded. This setting
+        <para><computeroutput>videocapscreens all|&lt;screen ID&gt;
+        [&lt;screen ID&gt; ...]]</computeroutput> allows to specify which screens of
+        the VM are being recorded. This setting
         cannot be changed while video capturing is enabled. Each screen is recorded
         into a separate file.</para>
@@ -1878 +1942 @@
 
       <listitem> <!-- @todo r=andy Clarify time format. -->
-        <para><computeroutput>videocapmaxtime &lt;time&gt;</computeroutput> sets
-        the maximum time the video capturing will take place since activation.
+        <para><computeroutput>videocapmaxtime &lt;ms&gt;</computeroutput> sets
+        the maximum time in milliseconds the video capturing will be enabled
+        since activation.
         The capturing stops when the defined time interval has elapsed. If this
         value is zero the capturing is not limited by time. This setting cannot
@@ -1888 +1953 @@
         <para><computeroutput>videocapmaxsize &lt;MB&gt;</computeroutput> limits
         the maximum size of the captured video file (in MB). The capturing stops
-        when file size has reached the specified size. If this value is zero
+        when the file size has reached the specified size. If this value is zero
         the capturing will not be limited by file size. This setting cannot be
         changed while video capturing is enabled.</para>
@@ -1894 +1959 @@
 
       <listitem>
-        <para><computeroutput>videocapopts &lt;key=value&gt; [&lt;key=value&gt; ...]</computeroutput>
+        <para><computeroutput>videocapopts &lt;key=value&gt;[,&lt;key=value&gt; ...]</computeroutput>
         can be used to specify additional video capturing options. These options
         only are for advanced users and must be specified in a comma-separated
@@ -1910 +1975 @@
 
       <listitem>
-        <para><computeroutput>--plugcpu|unplugcpu
+        <para><computeroutput>plugcpu|unplugcpu
         &lt;id&gt;</computeroutput>: If CPU hot-plugging is enabled, this adds
         a virtual CPU to the virtual machines (or removes one).