Changeset 55712 in vbox for trunk/doc

Timestamp:

May 7, 2015 10:21:16 AM (10 years ago)

Author:

vboxsync

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

100122

Message:

doc/manual: document more VBoxManage modifyvm parameters

File:

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

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -788 +788 @@
           <listitem>
             <para><computeroutput>--nic&lt;1-N&gt;
-            none|null|nat|bridged|intnet|hostonly|generic
-            </computeroutput>: With
-            this, you can set, for each of the VM's virtual network cards,
+            none|null|nat|natnetwork|bridged|intnet|hostonly|generic</computeroutput>:
+            With this, you can set, for each of the VM's virtual network cards,
             what type of networking should be available. They can be not
             present (<computeroutput>none</computeroutput>), not connected to
             the host (<computeroutput>null</computeroutput>), use network
             address translation (<computeroutput>nat</computeroutput>),
+            use the new network address translation engine
+            (<computeroutput>natnetwork</computeroutput>),
             bridged networking (<computeroutput>bridged</computeroutput>) or
             communicate with other virtual machines using internal networking
@@ -806 +807 @@
 
           <listitem>
+            <para><computeroutput>--nicpromisc&lt;1-N&gt;
+            deny|allow-vms|allow-all</computeroutput>:
+            This allows you, for each of the VM's virtual network cards, to
+            specify how the promiscious mode is handled. This setting is only
+            relevant for bridged networking.
+            <computeroutput>deny</computeroutput> (default setting) hides
+            any traffic not intended for this VM.
+            <computeroutput>allow-vms</computeroutput> hides all host
+            traffic from this VM but allows the VM to see traffic from/to other
+            VMs.
+            <computeroutput>allow-all</computeroutput> removes this
+            restriction completely.</para>
+          </listitem>
+
+          <listitem>
             <para><computeroutput>--nictype&lt;1-N&gt;
             Am79C970A|Am79C973|82540EM|82543GC|82545EM|virtio</computeroutput>:
@@ -836 +852 @@
           </listitem>
 
+          <listitem>
+            <para><computeroutput>--natnet&lt;1-N&gt;
+            &lt;network&gt;|default</computeroutput>:
+            If the networking type is set to <computeroutput>nat</computeroutput>
+            (not <computeroutput>natnetwork</computeroutput>) then this
+            setting specifies the IP address range to be used for
+            this network. See <xref linkend="changenat" /> for an
+            example.</para>
+          </listitem>
+
+          <listitem>
+            <para><computeroutput>--nat-network&lt;1-N&gt; &lt;network
+            name&gt;</computeroutput>: If the networking type is set to
+            <computeroutput>natnetwork</computeroutput> (not
+            <computeroutput>nat</computeroutput>) then this setting specifies
+            the name of the NAT network this adapter is connected to.</para>
+          </listitem>
+          
+          This allows you to change the address range occupied by
           <listitem>
             <para><computeroutput>--bridgeadapter&lt;1-N&gt;
@@ -1124 +1159 @@
             see <xref linkend="settings-usb" /> for details.</para>
           </listitem>
+
+          <listitem>
+            <para><computeroutput>--usbxhci on|off</computeroutput>: This
+            option enables or disables the VM's virtual USB 3.0 controller;
+            see <xref linkend="settings-usb" /> for details.</para>
+          </listitem>
         </itemizedlist></para>
 
@@ -1145 +1186 @@
 
           <!-- @todo r=andy Document vrdeproperty -->
+
+          <listitem>
+            <para><computeroutput>--vrdeextpack default|&lt;name&gt;</computeroutput>:
+            Allows to specify the library to use for to access the VM
+            remotely. The default is to use the RDP code which is part of the
+            Oracle VM VirtualBox Extension Pack.</para>
+          </listitem>
 
           <listitem>
@@ -1192 +1240 @@
 
           <listitem>
+            <para><computeroutput>--vrdeauthlibrary
+            default|&lt;name&gt;</computeroutput>: This allos to set the
+            library used for RDP authentication, see <xref lang=""
+            linkend="vbox-auth" /> for details.</para>
+          </listitem>
+
+          <listitem>
             <para><computeroutput>--vrdemulticon on|off</computeroutput>: This
             enables multiple connections to the same VRDE server, if the
@@ -1286 +1341 @@
         </itemizedlist></para>
     </sect2>
+    
+    <sect2 id="vboxmanage-modifyvm-debugging">
+      <title>Debugging settings</title>
+
+      <para>The following settings are only relevant for low-level VM
+      debugging. Regular users will never need these settings.<itemizedlist>
+          <listitem>
+            <para><computeroutput>--tracing-enabled on|off</computeroutput>:
+            Enable the tracebuffer. This consumes some memory for the tracebuffer
+            and adds extra overhead.</para>
+          </listitem>
+          <listitem>
+            <para><computeroutput>--tracing-config &lt;config-string&gt;</computeroutput>:
+            Allows to configure tracing. In particular this defines which group of
+            tracepoints are enabled.</para>
+          </listitem>
+        </itemizedlist>
+      </para>
+    </sect2>
+
   </sect1>
 
@@ -1648 +1723 @@
         purposes.</para>
 
-        <para>With <computeroutput>--nictrace&lt;1-N&gt;
+        <para>With <computeroutput>nictrace&lt;1-N&gt;
         on|off</computeroutput>, you can enable network tracing for a
         particular virtual network card.</para>
@@ -1658 +1733 @@
       </listitem>
 
-      <!-- @todo r=andy Document nicpromisc -->
+      <listitem>
+        <para><computeroutput>nicpromisc&lt;1-N&gt;
+        deny|allow-vms|allow-all</computeroutput>:
+        This allows you, for each of the VM's virtual network cards, to
+        specify how the promiscious mode is handled. This setting is only
+        relevant for bridged networking.
+        <computeroutput>deny</computeroutput> (default setting) hides
+        any traffic not intended for this VM.
+        <computeroutput>allow-vms</computeroutput> hides all host
+        traffic from this VM but allows the VM to see traffic from/to other
+        VMs.
+        <computeroutput>allow-all</computeroutput> removes this
+        restriction completely.</para>
+      </listitem>
 
       <listitem>
@@ -1744 +1832 @@
         <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.</para>
+        cannot be changed while video capturing is enabled. Each screen is recorded
+        into a separate file.</para>
       </listitem>