VirtualBox

Changeset 99161 in vbox for trunk/doc/manual


Ignore:
Timestamp:
Mar 24, 2023 1:29:00 AM (22 months ago)
Author:
vboxsync
Message:

manual/man_*: Corrections. bugref:10302

Location:
trunk/doc/manual/en_US
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/manual/en_US/man_VBoxManage-cloud.xml

    r99136 r99161  
    5555        <arg choice="req">--profile=<replaceable>name</replaceable></arg>
    5656        <sbr/>
    57         <arg choice="plain">list</arg>
    58         <arg choice="plain">instances</arg>
     57        <arg choice="plain">list instances</arg>
    5958        <arg>--state=<replaceable>string</replaceable></arg>
    6059        <arg>--compartment-id=<replaceable>string</replaceable></arg>
    … …  
    6564      <arg choice="req">--profile=<replaceable>name</replaceable></arg>
    6665      <sbr/>
    67       <arg choice="plain">list</arg>
    68       <arg choice="plain">images</arg>
     66      <arg choice="plain">list images</arg>
    6967      <arg choice="req">--compartment-id=<replaceable>string</replaceable></arg>
    7068      <arg>--state=<replaceable>string</replaceable></arg>
    … …  
    7573      <arg choice="req">--profile=<replaceable>name</replaceable></arg>
    7674      <sbr/>
    77       <arg choice="plain">list</arg>
    78       <arg choice="plain">vnicattachments</arg>
     75      <arg choice="plain">list vnicattachments</arg>
    7976      <arg choice="req">--compartment-id=<replaceable>string</replaceable></arg>
    80       <arg>--filter=<replaceable>string</replaceable></arg>
     77      <arg rep="repeat">--filter=<group choice="plain">
     78          <arg choice="plain">instanceId</arg>
     79          <arg choice="plain">vnicId</arg>
     80          <arg choice="plain">availabilityDomain</arg>
     81          </group>=<replaceable>value</replaceable></arg>
    8182    </cmdsynopsis>
    8283
    … …  
    8788       <arg choice="req">--profile=<replaceable>name</replaceable></arg>
    8889       <sbr/>
    89        <arg choice="plain">instance</arg>
    90        <arg choice="plain">create</arg>
     90       <arg choice="plain">instance create</arg>
    9191       <arg choice="req">--domain-name=<replaceable>name</replaceable></arg>
    9292       <group choice="req">
    … …  
    9898       <arg choice="req">--subnet=<replaceable>id</replaceable></arg>
    9999       <arg>--boot-disk-size=<replaceable>size in GB</replaceable></arg>
    100        <arg>--publicip=<replaceable>true/false</replaceable></arg>
     100       <arg>--publicip=<group choice="plain"><arg choice="plain">true</arg><arg choice="plain">false</arg></group></arg>
    101101       <arg>--privateip=<replaceable>IP address</replaceable></arg>
    102102       <arg rep="repeat">--public-ssh-key=<replaceable>key string</replaceable></arg>
    103        <arg>--launch-mode=<replaceable>NATIVE/EMULATED/PARAVIRTUALIZED</replaceable></arg>
     103       <arg>--launch-mode=<group choice="plain">
     104           <arg choice="plain">NATIVE</arg>
     105           <arg choice="plain">EMULATED</arg>
     106           <arg choice="plain">PARAVIRTUALIZED</arg>
     107         </group></arg>
    104108       <arg>--cloud-init-script-path=<replaceable>path to a script</replaceable></arg>
    105109     </cmdsynopsis>
    … …  
    109113       <arg choice="req">--profile=<replaceable>name</replaceable></arg>
    110114       <sbr/>
    111        <arg choice="plain">instance</arg>
    112        <arg choice="plain">info</arg>
     115       <arg choice="plain">instance info</arg>
    113116       <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
    114117     </cmdsynopsis>
    … …  
    118121       <arg choice="req">--profile=<replaceable>name</replaceable></arg>
    119122       <sbr/>
    120        <arg choice="plain">instance</arg>
    121        <arg choice="plain">terminate</arg>
     123       <arg choice="plain">instance terminate</arg>
    122124       <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
    123125     </cmdsynopsis>
    … …  
    127129       <arg choice="req">--profile=<replaceable>name</replaceable></arg>
    128130       <sbr/>
    129        <arg choice="plain">instance</arg>
    130        <arg choice="plain">start</arg>
     131       <arg choice="plain">instance start</arg>
    131132       <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
    132133     </cmdsynopsis>
    … …  
    136137       <arg choice="req">--profile=<replaceable>name</replaceable></arg>
    137138       <sbr/>
    138        <arg choice="plain">instance</arg>
    139        <arg choice="plain">pause</arg>
     139       <arg choice="plain">instance pause</arg>
    140140       <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
    141141     </cmdsynopsis>
    … …  
    145145       <arg choice="req">--profile=<replaceable>name</replaceable></arg>
    146146       <sbr/>
    147        <arg choice="plain">instance</arg>
    148        <arg choice="plain">reset</arg>
     147       <arg choice="plain">instance reset</arg>
    149148       <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
    150149     </cmdsynopsis>
    … …  
    156155          <arg choice="req">--profile=<replaceable>name</replaceable></arg>
    157156          <sbr/>
    158           <arg choice="plain">image</arg>
    159           <arg choice="plain">create</arg>
     157          <arg choice="plain">image create</arg>
    160158          <arg choice="req">--display-name=<replaceable>name</replaceable></arg>
    161159          <arg>--bucket-name=<replaceable>name</replaceable></arg>
    … …  
    168166        <arg choice="req">--profile=<replaceable>name</replaceable></arg>
    169167        <sbr/>
    170         <arg choice="plain">image</arg>
    171         <arg choice="plain">info</arg>
     168        <arg choice="plain">image info</arg>
    172169        <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
    173170      </cmdsynopsis>
    … …  
    177174        <arg choice="req">--profile=<replaceable>name</replaceable></arg>
    178175        <sbr/>
    179         <arg choice="plain">image</arg>
    180         <arg choice="plain">delete</arg>
     176        <arg choice="plain">image delete</arg>
    181177        <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
    182178      </cmdsynopsis>
    … …  
    186182        <arg choice="req">--profile=<replaceable>name</replaceable></arg>
    187183        <sbr/>
    188         <arg choice="plain">image</arg>
    189         <arg choice="plain">import</arg>
     184        <arg choice="plain">image import</arg>
    190185        <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
    191186        <arg>--bucket-name=<replaceable>name</replaceable></arg>
    … …  
    197192        <arg choice="req">--profile=<replaceable>name</replaceable></arg>
    198193        <sbr/>
    199         <arg choice="plain">image</arg>
    200         <arg choice="plain">export</arg>
     194        <arg choice="plain">image export</arg>
    201195        <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
    202196        <arg choice="req">--display-name=<replaceable>name</replaceable></arg>
    … …  
    243237    </cmdsynopsis>
    244238    <cmdsynopsis id="synopsis-vboxmanage-cloud-network-delete">
    245       <command>VBoxManage cloud</command>
    246       <arg choice="plain">network delete</arg>
     239      <command>VBoxManage cloud network delete</command>
    247240      <arg choice="req">--name=<replaceable>string</replaceable></arg>
    248241    </cmdsynopsis>
    249242    <cmdsynopsis id="synopsis-vboxmanage-cloud-network-info">
    250       <command>VBoxManage cloud</command>
    251       <arg choice="plain">network info</arg>
     243      <command>VBoxManage cloud >network info</command>
    252244      <arg choice="req">--name=<replaceable>string</replaceable></arg>
    253245    </cmdsynopsis>
    … …  
    310302      <variablelist>
    311303        <varlistentry>
    312           <term>--state<replaceable>"available/disabled/deleted"</replaceable></term>
     304          <term>--state=available|disabled|deleted</term>
    313305          <listitem>
    314             <para>The state of cloud image. The possible states are "available/disabled/deleted" at moment.
     306            <para>The state of cloud image. The possible states are <literal>available</literal>,
     307            <literal>disabled</literal> and <literal>deleted</literal> at moment.
    315308            If the state isn't provided the list of images with all possible states is returned.
    316309            </para>
    … …  
    336329      <variablelist>
    337330        <varlistentry>
    338           <term>--filter<replaceable>"instanceId/vnicId/domainName=string"</replaceable></term>
     331          <term>--filter={instanceId|vnicId|domainName}=<replaceable>string</replaceable></term>
    339332          <listitem>
     333<!-- @todo r=bird: Use more markup. This'll all be put jumbled together into a single paragraph -->
    340334            <para>Filters are used to narrow down the set of Vnic attachments of interest.
    341335            This parameter is repeatible.
    342             The possible filters are "instanceId" or "vnicId" or "availabilityDomain" at moment.
    343             The form is "instanceId/vnicId/domainName=[string value]" and can be repeated.
     336            The possible filter types are "instanceId" or "vnicId" or "availabilityDomain" at moment.
     337            The form is "type=[value]" and can be repeated.
    344338            In instance, "--filter instanceId=ocid1.instance.oc1.iad.anuwcl...js6
    345339                          --filter vnicId=ocid1.vnic.oc1.iad.abuwcl...jsm
    … …  
    366360      <remark role="help-copy-synopsis"/>
    367361      <para>
     362<!-- @todo r=bird: Use more markup. This'll all be put jumbled together into a single paragraph -->
    368363        Creates new instance in the Cloud.
    369364        There are two standard ways to create an instance in the Cloud:
    … …  
    408403              <para>Public SSH key used to connect to the instance via SSH.
    409404                This parameter may be repeated if you plan to use more than one key as:
     405<!-- @todo r=bird: Markup rather than quoting -->
    410406                "--public-ssh-key=firstSSHKey --public-ssh-key=secondSSHKey".
    411407              </para>

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

    r98103 r99161  
    115115      <variablelist>
    116116        <varlistentry>
    117           <term><option>--clouduser</option></term><listitem><para>The name which fully identifies the user in the specified cloud provider.</para></listitem>
    118         </varlistentry>
    119         <varlistentry>
    120           <term><option>--fingerprint</option></term><listitem><para>Fingerprint for the key pair being used.</para></listitem>
    121         </varlistentry>
    122         <varlistentry>
    123           <term><option>--keyfile</option></term><listitem><para>Full path and filename of the private key. </para></listitem>
    124         </varlistentry>
    125         <varlistentry>
    126         <term><option>--passphrase</option></term><listitem><para>Passphrase used for the key, if it is encrypted.</para></listitem>
    127       </varlistentry>
    128       <varlistentry>
    129         <term><option>--tenancy</option></term><listitem><para>ID of your tenancy. </para></listitem>
    130       </varlistentry>
    131       <varlistentry>
    132         <term><option>--compartment</option></term><listitem><para>ID of your compartment.</para></listitem>
    133       </varlistentry>
    134       <varlistentry>
    135         <term><option>--region</option></term><listitem><para>Region name. Region is where you plan to deploy an application.</para></listitem>
     117          <term><option>--clouduser=<replaceable>unique id</replaceable></option></term>
     118          <listitem><para>The name which fully identifies the user in the specified cloud provider.</para></listitem>
     119        </varlistentry>
     120        <varlistentry>
     121          <term><option>--fingerprint=<replaceable>MD5 string</replaceable></option></term>
     122          <listitem><para>Fingerprint for the key pair being used.</para></listitem>
     123        </varlistentry>
     124        <varlistentry>
     125          <term><option>--keyfile=<replaceable>path</replaceable></option></term>
     126          <listitem><para>Full path and filename of the private key. </para></listitem>
     127        </varlistentry>
     128        <varlistentry>
     129        <term><option>--passphrase=<replaceable>string</replaceable></option></term>
     130        <listitem><para>Passphrase used for the key, if it is encrypted.</para></listitem>
     131      </varlistentry>
     132      <varlistentry>
     133        <term><option>--tenancy=<replaceable>unique id</replaceable></option></term>
     134        <listitem><para>ID of your tenancy. </para></listitem>
     135      </varlistentry>
     136      <varlistentry>
     137        <term><option>--compartment=<replaceable>unique id</replaceable></option></term>
     138        <listitem><para>ID of your compartment.</para></listitem>
     139      </varlistentry>
     140      <varlistentry>
     141        <term><option>--region=<replaceable>string</replaceable></option></term>
     142        <listitem><para>Region name. Region is where you plan to deploy an application.</para></listitem>
    136143      </varlistentry>
    137144      </variablelist>
    … …  
    154161      <variablelist>
    155162        <varlistentry>
    156           <term><option>--clouduser</option></term><listitem><para>The name which fully identifies the user in the specified cloud provider.</para></listitem>
    157         </varlistentry>
    158         <varlistentry>
    159           <term><option>--fingerprint</option></term><listitem><para>Fingerprint for the key pair being used.</para></listitem>
    160         </varlistentry>
    161         <varlistentry>
    162           <term><option>--keyfile</option></term><listitem><para>Full path and filename of the private key. </para></listitem>
    163         </varlistentry>
    164         <varlistentry>
    165         <term><option>--passphrase</option></term><listitem><para>Passphrase used for the key, if it is encrypted.</para></listitem>
    166       </varlistentry>
    167       <varlistentry>
    168         <term><option>--tenancy</option></term><listitem><para>ID of your tenancy. </para></listitem>
    169       </varlistentry>
    170       <varlistentry>
    171         <term><option>--compartment</option></term><listitem><para>ID of your compartment.</para></listitem>
    172       </varlistentry>
    173       <varlistentry>
    174         <term><option>--region</option></term><listitem><para>Region name. Region is where you plan to deploy an application.</para></listitem>
     163          <term><option>--clouduser=<replaceable>unique id</replaceable></option></term>
     164          <listitem><para>The name which fully identifies the user in the specified cloud provider.</para></listitem>
     165        </varlistentry>
     166        <varlistentry>
     167          <term><option>--fingerprint=<replaceable>MD5 string</replaceable></option></term>
     168          <listitem><para>Fingerprint for the key pair being used.</para></listitem>
     169        </varlistentry>
     170        <varlistentry>
     171          <term><option>--keyfile=<replaceable>path</replaceable></option></term>
     172          <listitem><para>Full path and filename of the private key. </para></listitem>
     173        </varlistentry>
     174        <varlistentry>
     175        <term><option>--passphrase=<replaceable>string</replaceable></option></term>
     176        <listitem><para>Passphrase used for the key, if it is encrypted.</para></listitem>
     177      </varlistentry>
     178      <varlistentry>
     179        <term><option>--tenancy=<replaceable>unique id</replaceable></option></term>
     180        <listitem><para>ID of your tenancy. </para></listitem>
     181      </varlistentry>
     182      <varlistentry>
     183        <term><option>--compartment=<replaceable>unique id</replaceable></option></term>
     184        <listitem><para>ID of your compartment.</para></listitem>
     185      </varlistentry>
     186      <varlistentry>
     187        <term><option>--region=<replaceable>string</replaceable></option></term>
     188        <listitem><para>Region name. Region is where you plan to deploy an application.</para></listitem>
    175189      </varlistentry>
    176190      </variablelist>
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette