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

Timestamp:

Jun 20, 2012 1:58:29 PM (13 years ago)

Author:

vboxsync

Message:

doc/manual: bandwidth group description brought up to date (#5582)

Location:

trunk/doc/manual/en_US

Files:

• user_Storage.xml (modified) (2 diffs)
• user_VBoxManage.xml (modified) (3 diffs)

trunk/doc/manual/en_US/user_Storage.xml

@@ -814 +814 @@
     <computeroutput>VBoxManage</computeroutput>. The example below creates a
     bandwidth group named "Limit", sets the limit to 20 MB/s and assigns the
-    group to the attached disks of the VM:<screen>VBoxManage bandwidthctl "VM name" --name Limit --add disk --limit 20
+    group to the attached disks of the VM:<screen>VBoxManage bandwidthctl "VM name" add Limit --type disk --limit 20M
 VBoxManage storageattach "VM name" --controller "SATA" --port 0 --device 0 --type hdd
                                    --medium disk1.vdi --bandwidthgroup Limit
@@ -827 +827 @@
     <para>The limits for each group can be changed while the VM is running,
     with changes being picked up immediately. The example below changes the
-    limit for the group created in the example above to 10 MB/s:<screen>VBoxManage bandwidthctl "VM name" --name Limit --limit 10</screen></para>
+    limit for the group created in the example above to 10 MB/s:<screen>VBoxManage bandwidthctl "VM name" set Limit --limit 10M</screen></para>
   </sect1>
 

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -1968 +1968 @@
     <title>VBoxManage bandwidthctl</title>
 
-    <para>This command creates/deletes/modifies bandwidth groups of the given
+    <para>This command creates/deletes/modifies/shows bandwidth groups of the given
     virtual machine:<screen>VBoxManage bandwidthctl    &lt;uuid|vmname&gt;
-                          --name &lt;name&gt;
-                          [--add disk
-                          [--delete]
-                          [--limit MB/s]</screen></para>
-
-    <para>See <xref linkend="storage-bandwidth-limit" /> for an introduction
-    to bandwidth limits. The parameters mean:<glosslist>
+                            add &lt;name&gt; --type disk|network --limit &lt;megabytes per second&gt;[k|m|g|K|M|G] |
+                            set &lt;name&gt; --limit &lt;megabytes per second&gt;[k|m|g|K|M|G] |
+                            remove &lt;name&gt; |
+                            list [--machinereadable]</screen></para>
+
+    <para>The following subcommands are available:<itemizedlist>
+      <listitem>
+        <para><computeroutput>add</computeroutput>, creates a new bandwidth
+          group of given type.</para>
+      </listitem>
+      <listitem>
+        <para><computeroutput>set</computeroutput>, modifies the limit for an
+          existing bandwidth group.</para>
+      </listitem>
+      <listitem>
+        <para><computeroutput>remove</computeroutput>, destroys a bandwidth
+          group.</para>
+      </listitem>
+      <listitem>
+        <para><computeroutput>list</computeroutput>, shows all bandwidth groups
+          defined for the given VM.</para>
+      </listitem>
+    </itemizedlist>
+    </para>
+    <para>The parameters mean:<glosslist>
         <glossentry>
           <glossterm>uuid|vmname</glossterm>
@@ -1994 +2012 @@
 
         <glossentry>
-          <glossterm>add</glossterm>
-
-          <glossdef>
-            <para>Creates a new bandwdith group with the given type.</para>
-          </glossdef>
-        </glossentry>
-
-        <glossentry>
-          <glossterm>delete</glossterm>
-
-          <glossdef>
-            <para>Deletes a bandwdith group if it isn't used anymore.</para>
+          <glossterm>type</glossterm>
+
+          <glossdef>
+            <para>Type of the bandwidth group. Mandatory. Two types are
+              supported: <computeroutput>disk</computeroutput> and
+              <computeroutput>network</computeroutput>. See
+              <xref linkend="storage-bandwidth-limit" /> or
+              <xref linkend="network_bandwidth_limit" /> for a description of a
+              particular type.</para>
           </glossdef>
         </glossentry>
@@ -2013 +2028 @@
 
           <glossdef>
-            <para>Sets the limit for the given group to the specified amount.
-            Can be changed while the VM is running.</para>
-          </glossdef>
-        </glossentry>
-      </glosslist></para>
+            <para>Specifies the limit for the given group. Can be changed
+              while the VM is running. The default unit is megabytes per
+              second. The unit can be changed by specifying one of the
+              following suffixes: <computeroutput>k</computeroutput> for kilobits/s, <computeroutput>m</computeroutput> for megabits/s, <computeroutput>g</computeroutput> for gigabits/s, <computeroutput>K</computeroutput> for kilobytes/s, <computeroutput>M</computeroutput> for megabytes/s, <computeroutput>G</computeroutput> for gigabytes/s</para>
+          </glossdef>
+        </glossentry>
+      </glosslist>
+      <note>
+        <para>To remove a bandwidth group it must not be referenced by any disks
+          or adapters in running VM.</para>
+      </note>
+    </para>
   </sect1>