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

Timestamp:

Jul 19, 2019 9:26:18 AM (5 years ago)

Author:

vboxsync

Message:

Changes in the user manual part of VBoxManage related to the Cloud stuff.

Location:

trunk/doc/manual/en_US

Files:

• man_VBoxManage-cloudinstance.xml (modified) (9 diffs)
• man_VBoxManage-cloudlist.xml (modified) (3 diffs)
• man_VBoxManage-cloudprofile.xml (modified) (6 diffs)

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

@@ -27 +27 @@
   <refnamediv>
     <refname>VBoxManage-cloudinstance</refname>
-    <refpurpose>manage the cloud instance</refpurpose>
+    <refpurpose>Manage the cloud instances</refpurpose>
     <refclass>Oracle VM VirtualBox</refclass>
   </refnamediv>
@@ -38 +38 @@
       <arg choice="plain" rep="norepeat">instance</arg>
       <arg choice="plain" rep="norepeat">info</arg>
-      <arg choice="req" rep="norepeat">--id=<replaceable>uuid</replaceable></arg>
+      <arg choice="req" rep="norepeat">--id=<replaceable>unique id</replaceable></arg>
     </cmdsynopsis>
     <cmdsynopsis id="synopsis-vboxmanage-cloudinstance-terminate" sepchar=" ">
@@ -46 +46 @@
       <arg choice="plain" rep="norepeat">instance</arg>
       <arg choice="plain" rep="norepeat">terminate</arg>
-      <arg choice="req" rep="norepeat">--id=<replaceable>uuid</replaceable></arg>
+      <arg choice="req" rep="norepeat">--id=<replaceable>unique id</replaceable></arg>
     </cmdsynopsis>
     <cmdsynopsis id="synopsis-vboxmanage-cloudinstance-start" sepchar=" ">
@@ -54 +54 @@
       <arg choice="plain" rep="norepeat">instance</arg>
       <arg choice="plain" rep="norepeat">start</arg>
-      <arg choice="req" rep="norepeat">--id=<replaceable>uuid</replaceable></arg>
+      <arg choice="req" rep="norepeat">--id=<replaceable>unique id</replaceable></arg>
     </cmdsynopsis>
     <cmdsynopsis id="synopsis-vboxmanage-cloudinstance-pause" sepchar=" ">
@@ -62 +62 @@
       <arg choice="plain" rep="norepeat">instance</arg>
       <arg choice="plain" rep="norepeat">pause</arg>
-      <arg choice="req" rep="norepeat">--id=<replaceable>uuid</replaceable></arg>
+      <arg choice="req" rep="norepeat">--id=<replaceable>unique id</replaceable></arg>
     </cmdsynopsis>
   </refsynopsisdiv>
@@ -68 +68 @@
   <refsect1>
     <title>Description</title>
+
+    <refsect2 id="vboxmanage-cloudinstance-common-options">
+      <title>Common options</title>
+      <remark role="help-scope" condition="GLOBAL"/>
+      <para>The subcommands of <command>cloudinstance</command> implement the standard operations for a cloud instance
+        like start/pause/show/terminate. The next common options must be placed between the "cloud" and  the following sub-commands:</para>
+      <variablelist>
+        <varlistentry>
+          <term>--provider=<replaceable>name</replaceable></term>
+          <listitem><para>Short cloud provider name.</para></listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>--profile=<replaceable>name</replaceable></term>
+          <listitem><para>Cloud profile name. </para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
+
     <refsect2 id="vboxmanage-cloudinstance-info">
       <title>cloud instance info</title>
       <para>
-        Display information about a cloud instance with a specified id
+        Display information about a cloud instance with a specified id.
       </para>
       <variablelist>
         <varlistentry>
-          <term><option>--id</option></term><listitem><para>The unique identifier which fully identify the instance</para></listitem>
+          <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
         </varlistentry>
       </variablelist>
@@ -83 +101 @@
       <title>cloud instance termination</title>
       <para>
-        Delete a cloud instance with a specified id
+        Delete a cloud instance with a specified id.
       </para>
       <variablelist>
         <varlistentry>
-          <term><option>--id</option></term><listitem><para>The unique identifier which fully identify the instance</para></listitem>
+          <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
         </varlistentry>
       </variablelist>
@@ -95 +113 @@
       <title>cloud instance start</title>
       <para>
-        Start a cloud instance with a specified id
+        Start a cloud instance with a specified id.
       </para>
       <variablelist>
         <varlistentry>
-          <term><option>--id</option></term><listitem><para>The unique identifier which fully identify the instance</para></listitem>
+          <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
         </varlistentry>
       </variablelist>
@@ -107 +125 @@
       <title>cloud instance pause</title>
       <para>
-        Pause a cloud instance with a specified id
+        Pause a cloud instance with a specified id.
       </para>
       <variablelist>
         <varlistentry>
-          <term><option>--id</option></term><listitem><para>The unique identifier which fully identify the instance</para></listitem>
+          <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
         </varlistentry>
       </variablelist>

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

@@ -30 +30 @@
   <refnamediv>
     <refname>VBoxManage-cloudlist</refname>
-    <refpurpose>The cloud list command gives information about some standard entities existed in the every Cloud
-    and which can be represented by the list like the list of instances/disk images/networks and etc.</refpurpose>
+    <refpurpose>The cloud list command gives information about some standard entities in the every Cloud
+    and which can be represented by the list like the list of instances/disk images/networks and etc</refpurpose>
     <refclass>Oracle VM VirtualBox</refclass>
   </refnamediv>
@@ -83 +83 @@
       <variablelist>
         <varlistentry>
-          <term>--state=<replaceable>"running/paused/terminated"</replaceable></term>
+          <term>--state<replaceable>"running/paused/terminated"</replaceable></term>
           <listitem>
             <para>The state of cloud instance. The possible states are "running/paused/terminated" at moment.
@@ -109 +109 @@
       <variablelist>
         <varlistentry>
-          <term>--state=<replaceable>"available/disabled/deleted"</replaceable></term>
+          <term>--state<replaceable>"available/disabled/deleted"</replaceable></term>
           <listitem>
             <para>The state of cloud image. The possible states are "available/disabled/deleted" at moment.

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

@@ -28 +28 @@
   <refnamediv>
     <refname>VBoxManage-cloudprofile</refname>
-    <refpurpose>manage the cloud profiles</refpurpose>
+    <refpurpose>Manage the cloud profiles</refpurpose>
     <refclass>Oracle VM VirtualBox</refclass>
   </refnamediv>
@@ -38 +38 @@
         <arg choice="req">--profile=<replaceable>name</replaceable></arg>
         <arg choice="plain">add</arg>
-        <arg>--clouduser=<replaceable>uuid</replaceable></arg>
+        <arg>--clouduser=<replaceable>unique id</replaceable></arg>
         <arg>--fingerprint=<replaceable>MD5 string</replaceable></arg>
         <arg>--keyfile=<replaceable>path</replaceable></arg>
         <arg>--passphrase=<replaceable>string</replaceable></arg>
-        <arg>--tenancy=<replaceable>uuid</replaceable></arg>
-        <arg>--compartment=<replaceable>uuid</replaceable></arg>
+        <arg>--tenancy=<replaceable>unique id</replaceable></arg>
+        <arg>--compartment=<replaceable>unique id</replaceable></arg>
         <arg>--region=<replaceable>string</replaceable></arg>
     </cmdsynopsis>
@@ -51 +51 @@
       <arg choice="req">--profile=<replaceable>name</replaceable></arg>
       <arg choice="plain">update</arg>
-      <arg>--clouduser=<replaceable>uuid</replaceable></arg>
+      <arg>--clouduser=<replaceable>unique id</replaceable></arg>
       <arg>--fingerprint=<replaceable>MD5 string</replaceable></arg>
       <arg>--keyfile=<replaceable>path</replaceable></arg>
       <arg>--passphrase=<replaceable>string</replaceable></arg>
-      <arg>--tenancy=<replaceable>uuid</replaceable></arg>
-      <arg>--compartment=<replaceable>uuid</replaceable></arg>
+      <arg>--tenancy=<replaceable>unique id</replaceable></arg>
+      <arg>--compartment=<replaceable>unique id</replaceable></arg>
       <arg>--region=<replaceable>string</replaceable></arg>
     </cmdsynopsis>
@@ -79 +79 @@
       <title>Common options</title>
       <remark role="help-scope" condition="GLOBAL"/>
-      <para>The subcommands of <command>cloudprofile</command> realize the standard CRUD operations for a cloud profile.
-        The following common options can be placed before the sub-command:</para>
+      <para>The subcommands of <command>cloudprofile</command> implement the standard CRUD operations for a cloud profile.
+        The next common options must be placed between the "cloud" and  the following sub-commands:</para>
       <variablelist>
         <varlistentry>
@@ -101 +101 @@
       <variablelist>
         <varlistentry>
-          <term><option>--clouduser</option></term><listitem><para>The name which fully identify the user in the specified cloud provider</para></listitem>
+          <term><option>--clouduser</option></term><listitem><para>The name which fully identifies the user in the specified cloud provider.</para></listitem>
         </varlistentry>
         <varlistentry>
@@ -140 +140 @@
       <variablelist>
         <varlistentry>
-          <term><option>--clouduser</option></term><listitem><para>The name which fully identify the user in the specified cloud provider</para></listitem>
+          <term><option>--clouduser</option></term><listitem><para>The name which fully identifies the user in the specified cloud provider.</para></listitem>
         </varlistentry>
         <varlistentry>