VirtualBox

Changeset 106001 in vbox


Ignore:
Timestamp:
Sep 10, 2024 11:15:32 AM (8 months ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
164747
Message:

doc/manual/man_VBoxManage-*: Updated a variety of the VBoxManage help
files to improve readability, corrected some typos, and made various
other corrections.

src/VBox/*: Updated some comments and log messages for a variety of
source files to correct the spelling of 'suppress'. A few APIC files
and USB files use 'supress' in variable names or manifest constants but
those were not changed.

Location:
trunk
Files:
55 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/manual/dita-refentry-flat-to-single-topic.xsl

    r99629 r106001  
    7474
    7575  <!--
    76     map: Default operation is to supress all output, except for topic elements
     76    map: Default operation is to suppress all output, except for topic elements
    7777         which are transformed to topicref.
    7878  -->

  • trunk/doc/manual/dita-refentry-link-replacement-xsl-gen.xsl

    r99014 r106001  
    4646
    4747
    48 <!-- Default operation is to supress output -->
     48<!-- Default operation is to suppress output -->
    4949<xsl:template match="node()|@*">
    5050  <xsl:apply-templates/>

  • trunk/doc/manual/docbook-refentry-link-replacement-xsl-gen.xsl

    r105454 r106001  
    4444
    4545
    46 <!-- Default operation is to supress output -->
     46<!-- Default operation is to suppress output -->
    4747<xsl:template match="node()|@*">
    4848  <xsl:apply-templates/>

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

    r99513 r106001  
    113113        The <command>VBoxManage bandwidthctl add</command> command
    114114        creates a bandwidth group for the specified VM. You must specify
    115         whether the bandwidth group is for disks or for networks, and
     115        whether the bandwidth group is for disks or for networks and
    116116        specify the bandwidth limit.
    117117      </para>
    … …  
    134134          <listitem><para>
    135135              Specifies the type of the bandwidth group:
    136               <literal>disk</literal> and <literal>network</literal>.
     136              <literal>disk</literal> or <literal>network</literal>.
    137137              For more information, see
    138138              <xref linkend="storage-bandwidth-limit" /> or
    … …  
    141141        </varlistentry>
    142142        <varlistentry>
    143           <term><option>--limit=<replaceable>bandwidth-limit</replaceable>[k|m|g|K|M|G]</option></term>
     143          <term><option>--limit=<replaceable>bandwidth-limit[k|m|g|K|M|G]</replaceable></option></term>
    144144          <listitem><para>
    145145              Specifies the bandwidth limit for a bandwidth group. The
    … …  
    247247        </varlistentry>
    248248        <varlistentry>
    249           <term><option>--limit=<replaceable>bandwidth-limit</replaceable>[k|m|g|K|M|G]</option></term>
     249          <term><option>--limit=<replaceable>bandwidth-limit[k|m|g|K|M|G]</replaceable></option></term>
    250250          <listitem><para>
    251251              Specifies the bandwidth limit for a bandwidth group. The

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

    r99513 r106001  
    9898        <term><replaceable>uuid</replaceable> | <replaceable>source-medium</replaceable></term>
    9999        <listitem><para>
    100             Specifies the UUID or the absolute or relative file name of
     100            Specifies the UUID or the absolute or relative pathname of
    101101            the source medium to clone. You can specify the UUID of the
    102102            medium only if it is registered. Use the <command>VBoxManage
    … …  
    107107        <term><replaceable>uuid</replaceable> | <replaceable>target-medium</replaceable></term>
    108108        <listitem><para>
    109             Specifies the UUID or the absolute or relative file name of
     109            Specifies the UUID or the absolute or relative pathname of
    110110            the target (clone) medium. You can specify the UUID of the
    111111            target medium only if it is registered. Use the

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

    r102095 r106001  
    268268    </cmdsynopsis>
    269269    <cmdsynopsis id="synopsis-vboxmanage-cloud-network-info">
    270       <command>VBoxManage cloud >network info</command>
     270      <command>VBoxManage cloud network info</command>
    271271      <arg choice="req">--name=<replaceable>string</replaceable></arg>
    272272    </cmdsynopsis>
    … …  
    280280      <title>Common options</title>
    281281      <remark role="help-scope" condition="GLOBAL"/>
    282       <para>The word "cloud" is an umbrella for all commands related to the interconnection with the Cloud.
    283         The next common options must be placed between the "cloud" and  the following sub-commands:</para>
     282      <para>The word <literal>cloud</literal> is an umbrella term for all commands related to
     283        intercommunication with the Cloud.  The following common options must be placed after
     284        the <literal>cloud</literal> argument and before the following sub-commands:</para>
    284285      <variablelist>
    285286        <varlistentry>
    … …  
    299300      <remark role="help-copy-synopsis"/>
    300301      <para>
    301         Displays the list of the instances for a specified compartment.
    302       </para>
    303       <variablelist>
    304         <varlistentry>
    305           <term>--state<replaceable>"running/paused/terminated"</replaceable></term>
     302        Displays a list of the cloud instances for a specified compartment.
     303      </para>
     304      <variablelist>
     305        <varlistentry>
     306          <term>--state=<replaceable>running|paused|terminated</replaceable></term>
    306307          <listitem>
    307             <para>The state of cloud instance. The possible states are "running/paused/terminated" at moment.
    308             If the state isn't provided the list of instances with all possible states is returned.
     308            <para>The state of cloud instance. The possible states are <literal>running</literal>,
     309              <literal>paused</literal>, and <literal>terminated</literal>.
     310              If a state isn't provided a list of instances with all possible states is returned.
    309311            </para>
    310312          </listitem>
    … …  
    314316          <listitem>
    315317            <para>A compartment is the logical container used to organize and isolate cloud resources.
    316             The different cloud providers can have the different names for this entity.
     318              Different cloud providers may use different names for this entity.
    317319            </para>
    318320          </listitem>
    … …  
    329331      <variablelist>
    330332        <varlistentry>
    331           <term>--state=available|disabled|deleted</term>
     333            <term>--state=<replaceable>available|disabled|deleted</replaceable></term>
    332334          <listitem>
    333             <para>The state of cloud image. The possible states are <literal>available</literal>,
    334             <literal>disabled</literal> and <literal>deleted</literal> at moment.
    335             If the state isn't provided the list of images with all possible states is returned.
     335            <para>The state of the cloud image. The possible states are <literal>available</literal>,
     336              <literal>disabled</literal> and <literal>deleted</literal>.
     337              If a state isn't provided a list of images with all possible states is returned.
    336338            </para>
    337339          </listitem>
    … …  
    341343            <listitem>
    342344              <para>A compartment is the logical container used to organize and isolate cloud resources.
    343               The different cloud providers can have the different names for this entity.
     345                Different cloud providers may use different names for this entity.
    344346              </para>
    345347            </listitem>
    … …  
    358360          <term>--filter={instanceId|vnicId|domainName}=<replaceable>string</replaceable></term>
    359361          <listitem>
    360 <!-- @todo r=bird: Use more markup. This'll all be put jumbled together into a single paragraph -->
    361362            <para>Filters are used to narrow down the set of Vnic attachments of interest.
    362             This parameter is repeatible.
    363             The possible filter types are "instanceId" or "vnicId" or "availabilityDomain" at moment.
    364             The form is "type=[value]" and can be repeated.
    365             In instance, "--filter instanceId=ocid1.instance.oc1.iad.anuwcl...js6
    366                           --filter vnicId=ocid1.vnic.oc1.iad.abuwcl...jsm
    367                           --filter domainName=ergw:US-ASHBURN-AD-2".
    368             But in most cases, this is redundant and one filter is enough.
    369             If the filter isn't provided the whole list of vnic attachments for a specified compartment is returned.
     363              This parameter can be specified multiple times.
     364              The possible filter types are <literal>instanceId</literal>, <literal>vnicId</literal>,
     365              or <literal>availabilityDomain</literal>.
     366            </para>
     367            <para>Filters have a syntax of <emphasis role="bold">type=[value]</emphasis> as seen
     368              in the following examples:
     369            </para>
     370            <itemizedlist>
     371              <listitem><para>instanceId=ocid1.instance.oc1.iad.anuwcl...js6</para></listitem>
     372              <listitem><para>vnicId=ocid1.vnic.oc1.iad.abuwcl...jsm</para></listitem>
     373              <listitem><para>domainName=ergw:US-ASHBURN-AD-2</para></listitem>
     374            </itemizedlist>
     375            <para>
     376              If a filter isn't provided the entire list of vnic attachments for a specified
     377              compartment is returned.
    370378            </para>
    371379          </listitem>
    … …  
    375383            <listitem>
    376384              <para>A compartment is the logical container used to organize and isolate cloud resources.
    377               The different cloud providers can have the different names for this entity.
     385                Different cloud providers may use different names for this entity.
    378386              </para>
    379387            </listitem>
    … …  
    387395      <remark role="help-copy-synopsis"/>
    388396      <para>
    389 <!-- @todo r=bird: Use more markup. This'll all be put jumbled together into a single paragraph -->
    390397        Creates new instance in the Cloud.
    391398        There are two standard ways to create an instance in the Cloud:
    392          1. Create an instance from an existing custom image.
    393          2. Create an instance from an existing bootable volume. This bootable volume shouldn't  be attached to any instance.
    394         For the 1st approach next parameters are required: image-id, boot-disk-size.
    395         For the 2nd approach next parameters are required: boot-volume-id.
    396         The rest parameters are common for both cases:
    397          display-name, launch-mode, subnet-id, publicIP, privateIP, shape, domain.
    398       </para>
    399       <variablelist>
    400         <varlistentry>
    401           <term><option>--domain-name</option></term><listitem><para>Cloud domain where new instance is created.</para></listitem>
     399      </para>
     400      <orderedlist>
     401        <listitem><para>Create an instance from an existing custom image.</para></listitem>
     402        <listitem><para>Create an instance from an existing bootable volume. This
     403          bootable volume shouldn't be attached to any instance.</para></listitem>
     404      </orderedlist>
     405      <para>
     406        The first approach requires the following two options: <literal>image-id</literal>,
     407        <literal>boot-disk-size</literal>.
     408        The second approach requires the following option: <literal>boot-volume-id</literal>.
     409      </para>
     410      <para>
     411        The following options are common to both cases:
     412          <literal>display-name</literal>, <literal>launch-mode</literal>,
     413          <literal>subnet-id</literal>, <literal>publicIP</literal>, <literal>privateIP</literal>, <literal>shape</literal>, <literal>domain</literal>.
     414      </para>
     415      <variablelist>
     416        <varlistentry>
     417          <term><option>--domain-name</option></term><listitem><para>Cloud domain where the new instance is to be created.</para></listitem>
    402418        </varlistentry>
    403419        <varlistentry>
    … …  
    408424        </varlistentry>
    409425        <varlistentry>
    410           <term><option>--display-name</option></term><listitem><para>Name for new instance in the Cloud.</para></listitem>
    411         </varlistentry>
    412         <varlistentry>
    413           <term><option>--shape</option></term><listitem><para> The shape of instance, defines the number of CPUs and RAM memory.</para></listitem>
    414         </varlistentry>
    415         <varlistentry>
    416           <term><option>--subnet</option></term><listitem><para> Unique identifier which fully identifies an existing subnet in the Cloud which will be used by the instance.</para></listitem>
    417         </varlistentry>
    418         <varlistentry>
    419           <term><option>--boot-disk-size</option></term><listitem><para> The size of bootable image in GB. Default is 50GB.</para></listitem>
    420         </varlistentry>
    421         <varlistentry>
    422           <term><option>--publicip</option></term><listitem><para>Whether the instance will have a public IP or not.</para></listitem>
     426          <term><option>--display-name</option></term><listitem><para>Name for the new instance in the Cloud.</para></listitem>
     427        </varlistentry>
     428        <varlistentry>
     429          <term><option>--shape</option></term><listitem><para>The shape of the instance which defines the number of CPUs and memory (RAM).</para></listitem>
     430        </varlistentry>
     431        <varlistentry>
     432          <term><option>--subnet</option></term><listitem><para>Unique identifier which fully identifies an existing subnet in the Cloud which will be used by the instance.</para></listitem>
     433        </varlistentry>
     434        <varlistentry>
     435          <term><option>--boot-disk-size</option></term><listitem><para>The size of the bootable image in GB. Default is 50GB.</para></listitem>
     436        </varlistentry>
     437        <varlistentry>
     438          <term><option>--publicip</option></term><listitem><para>Public IP address for the created instance.</para></listitem>
    423439        </varlistentry>
    424440        <varlistentry>
    … …  
    428444          <term><option>--public-ssh-key</option></term>
    429445            <listitem>
    430               <para>Public SSH key used to connect to the instance via SSH.
    431                 This parameter may be repeated if you plan to use more than one key as:
    432 <!-- @todo r=bird: Markup rather than quoting -->
    433                 "--public-ssh-key=firstSSHKey --public-ssh-key=secondSSHKey".
     446              <para>Public SSH key to use to connect to the instance via SSH.
     447                This parameter may be repeated if using more than one key:
     448                <literal>--public-ssh-key=firstSSHKey --public-ssh-key=secondSSHKey</literal>.
    434449              </para>
    435450            </listitem>
    436451        </varlistentry>
    437452        <varlistentry>
    438           <term><option>--launch-mode</option></term><listitem><para>The most known values here may be EMULATED, NATIVE, PARAVIRTUALIZED. </para></listitem>
    439         </varlistentry>
    440         <varlistentry>
    441           <term><option>--cloud-init-script-path</option></term><listitem><para>Absolute path to the user cloud-init script.</para></listitem>
     453          <term><option>--launch-mode</option></term><listitem><para>Supported values are EMULATED, NATIVE, and PARAVIRTUALIZED. </para></listitem>
     454        </varlistentry>
     455        <varlistentry>
     456          <term><option>--cloud-init-script-path</option></term><listitem><para>Absolute path to the cloud-init script.</para></listitem>
    442457        </varlistentry>
    443458      </variablelist>
    … …  
    447462      <title>cloud instance info</title>
    448463      <para>
    449         Display information about a cloud instance with a specified id.
    450       </para>
    451       <variablelist>
    452         <varlistentry>
    453           <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
     464        Display information about a cloud instance with a specified ID.
     465      </para>
     466      <variablelist>
     467        <varlistentry>
     468          <term><option>--id</option></term><listitem><para>Unique identifier which fully identifies the instance in the Cloud.</para></listitem>
    454469        </varlistentry>
    455470      </variablelist>
    … …  
    459474      <title>cloud instance termination</title>
    460475      <para>
    461         Delete a cloud instance with a specified id.
    462       </para>
    463       <variablelist>
    464         <varlistentry>
    465           <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
     476        Delete a cloud instance with a specified ID.
     477      </para>
     478      <variablelist>
     479        <varlistentry>
     480          <term><option>--id</option></term><listitem><para>Unique identifier which fully identifies the instance in the Cloud.</para></listitem>
    466481        </varlistentry>
    467482      </variablelist>
    … …  
    471486      <title>cloud instance start</title>
    472487      <para>
    473         Start a cloud instance with a specified id.
    474       </para>
    475       <variablelist>
    476         <varlistentry>
    477           <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
     488        Start a cloud instance with a specified ID.
     489      </para>
     490      <variablelist>
     491        <varlistentry>
     492          <term><option>--id</option></term><listitem><para>Unique identifier which fully identifies the instance in the Cloud.</para></listitem>
    478493        </varlistentry>
    479494      </variablelist>
    … …  
    483498      <title>cloud instance pause</title>
    484499      <para>
    485         Pause a cloud instance with a specified id.
    486       </para>
    487       <variablelist>
    488         <varlistentry>
    489           <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
     500        Pause a cloud instance with a specified ID.
     501      </para>
     502      <variablelist>
     503        <varlistentry>
     504          <term><option>--id</option></term><listitem><para>Unique identifier which fully identifies the instance in the Cloud.</para></listitem>
    490505        </varlistentry>
    491506      </variablelist>
    … …  
    495510      <title>cloud instance reset</title>
    496511      <para>
    497         Force reset a cloud instance with a specified id.
    498       </para>
    499       <variablelist>
    500         <varlistentry>
    501           <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
     512        Force reset a cloud instance with a specified ID.
     513      </para>
     514      <variablelist>
     515        <varlistentry>
     516          <term><option>--id</option></term><listitem><para>Unique identifier which fully identifies the instance in the Cloud.</para></listitem>
    502517        </varlistentry>
    503518      </variablelist>
    … …  
    507522      <title>cloud instance clone</title>
    508523      <para>
    509         Clone a cloud instance with a specified id. Only works for the instances accessible through VirtualBox.
    510         I.e. Not every instance in the cloud may be cloned.
    511       </para>
    512       <variablelist>
    513         <varlistentry>
    514           <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
    515         </varlistentry>
    516         <varlistentry>
    517           <term><option>--clone-name</option></term><listitem><para>Name for a clone instance</para></listitem>
     524        Clone a cloud instance with the specified ID. Only works for the instances accessible through &product-name;,
     525        i.e., not every instance in the cloud may be cloned.
     526      </para>
     527      <variablelist>
     528        <varlistentry>
     529          <term><option>--id</option></term><listitem><para>Unique identifier which fully identifies the instance in the Cloud.</para></listitem>
     530        </varlistentry>
     531        <varlistentry>
     532          <term><option>--clone-name</option></term><listitem><para>Name for the clone instance</para></listitem>
    518533        </varlistentry>
    519534      </variablelist>
    … …  
    525540      <para>
    526541        Displays the list of the available metrics for the instance.
    527         The returned names must be used with the command "VBoxManage cloud instance metricdata".
    528       </para>
    529       <variablelist>
    530         <varlistentry>
    531           <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
     542        The returned names must be used with the command
     543        <command>VBoxManage cloud instance metricdata</command>.
     544      </para>
     545      <variablelist>
     546        <varlistentry>
     547          <term><option>--id</option></term><listitem><para>Unique identifier which fully identifies the instance in the Cloud.</para></listitem>
    532548        </varlistentry>
    533549      </variablelist>
    … …  
    538554      <remark role="help-copy-synopsis"/>
    539555      <para>
    540         Displays the metric data with the resolution 1 minute for the requested cloud instances.
    541         The timestamps are returned in the format Rfc2822.
    542       </para>
    543       <variablelist>
    544         <varlistentry>
    545           <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
     556        Displays the metric data with the resolution of 1 minute for the requested cloud instances.
     557        The timestamps are returned in the format described in RFC2822.
     558      </para>
     559      <variablelist>
     560        <varlistentry>
     561          <term><option>--id</option></term><listitem><para>Unique identifier which fully identifies the instance in the Cloud.</para></listitem>
    546562        </varlistentry>
    547563        <varlistentry>
    … …  
    552568            <listitem>
    553569                <para>
    554                     History metric point numbers start at 1 and can go backwards as long as history exists.
    555                     Points are counted from the current time to the past. If user only wants the last actual value
    556                     he passes the value "1". If 2 values need to be returned (last and second to last),
    557                     the user passes "2", etc.
     570                  Metric points begin at the current time, which has a value of one, and continue
     571                  into the past with the values increasing.  If only the most recent metric point
     572                  is desired supply the value <literal>1</literal>. If the most recent value and
     573                  the preceding value are desired then supply a value of <literal>2</literal>.
    558574                </para>
    559575            </listitem>
    … …  
    569585        Creates new image in the Cloud.
    570586        There are two standard ways to create an image in the Cloud:
    571         1. Create an image from an object in the Cloud Storage;
    572         2. Create an image from an existing cloud instance.
    573         For the 1st approach next parameters are required:
    574         bucket-name - cloud bucket name where an object is located;
    575         object-name - name of object in the bucket;
    576         display-name - name for new image in the Cloud.
    577         For the 2d approach next parameters are required:
    578         instance-id - Id of instance in the Cloud;
    579         display-name - name for new image in the Cloud.
     587      </para>
     588      <orderedlist>
     589        <listitem><para>Create an image from an object in the Cloud Storage.</para></listitem>
     590        <listitem><para>Create an image from an existing cloud instance.</para></listitem>
     591      </orderedlist>
     592      <para>
     593        For the first approach the following three options are required:
     594        <literal>bucket-name</literal>, <literal>object-name</literal>, and <literal>display-name</literal>.
     595      </para>
     596      <para>
     597        For the second approach the following two options are required:
     598        <literal>instance-id</literal>, <literal>display-name</literal>
    580599      </para>
    581600      <variablelist>
    … …  
    584603        </varlistentry>
    585604        <varlistentry>
    586           <term><option>--bucket-name</option></term><listitem><para>Cloud bucket name where an object is located.</para></listitem>
     605          <term><option>--bucket-name</option></term><listitem><para>The name of the Cloud bucket where the image (object) is located..</para></listitem>
    587606        </varlistentry>
    588607        <varlistentry>
    … …  
    599618      <remark role="help-copy-synopsis"/>
    600619      <para>
    601         Display information about a cloud image with a specified id.
     620        Display information about a cloud image with a specified ID.
    602621      </para>
    603622      <variablelist>
    … …  
    612631      <remark role="help-copy-synopsis"/>
    613632      <para>
    614         Delete an image with a specified id from the Cloud.
     633        Delete an image with a specified ID from the Cloud.
    615634      </para>
    616635      <variablelist>
    … …  
    625644      <remark role="help-copy-synopsis"/>
    626645      <para>
    627         Import an image with a specified id from the Cloud to a local host.
     646        Import an image with the specified ID from the Cloud to a local host.
    628647        The result is an object in the local "temp" folder on the local host.
    629         Possible approach may have two general steps:
    630         1. Create an object from an image in the Cloud Storage;
    631         2. Download the object to the local host.
    632         So the next parameters may be required:
    633         bucket-name - cloud bucket name where the object will be created;
    634         object-name - name of object in the bucket. if parameter "object-name" is absent a displayed image name is used.
    635         If the first step isn't needed only the parameter "id" is required.
    636       </para>
     648        There are two possible approaches when importing from the Cloud:
     649      </para>
     650      <orderedlist>
     651          <listitem><para>Create an object from an image in the Cloud Storage.</para></listitem>
     652          <listitem><para>Download the object to the local host.</para></listitem>
     653      </orderedlist>
    637654      <variablelist>
    638655        <varlistentry>
    … …  
    640657        </varlistentry>
    641658        <varlistentry>
    642           <term><option>--bucket-name</option></term><listitem><para>Cloud bucket name where an object will be created.</para></listitem>
     659          <term><option>--bucket-name</option></term><listitem><para>The name of the Cloud bucket where the object will be created.</para></listitem>
    643660        </varlistentry>
    644661        <varlistentry>
    … …  
    646663            <listitem>
    647664              <para>
    648                 Name of created object in the bucket. The downloaded object will have this name.
     665                Name of the created object in the bucket or the name of the downloaded object.
     666                If no <option>--object-name</option> option is supplied a default image name is used.
    649667              </para>
    650668            </listitem>
    … …  
    657675      <remark role="help-copy-synopsis"/>
    658676      <para>
    659         Export an existing VBox image with a specified uuid from a local host to the Cloud.
     677        Export an existing VBox image with the specified uuid from a local host to the Cloud.
    660678        The result is new image in the Cloud.
    661         Possible approach may have two general steps:
    662         1. Upload VBox image to the Cloud Storage;
    663         2. Create an image from the uploaded object.
    664         So the next parameters may be required:
    665         bucket-name -cloud bucket name where the object will be uploaded;
    666         object-name - name of object in the bucket. If parameter "object-name" is absent the image id is used;
    667         display-name - name for new image in the Cloud.
    668         If the first step isn't needed the parameters "id" and "display-name" are required only.
    669       </para>
    670       <variablelist>
    671         <varlistentry>
    672           <term><option>--id</option></term><listitem><para>Unique identifier of the image in the VirtualBox.</para></listitem>
    673         </varlistentry>
    674         <varlistentry>
    675           <term><option>--display-name</option></term><listitem><para>Name for new image in the Cloud.</para></listitem>
    676         </varlistentry>
    677         <varlistentry>
    678           <term><option>--bucket-name</option></term><listitem><para>Cloud bucket name where the image (object) will be uploaded.</para></listitem>
    679         </varlistentry>
    680         <varlistentry>
    681           <term><option>--object-name</option></term><listitem><para>Name of object in the bucket.</para></listitem>
     679        There are two possible approaches when exporting to the Cloud:
     680      </para>
     681      <orderedlist>
     682          <listitem><para>Upload a VBox image to the Cloud Storage.</para></listitem>
     683          <listitem><para>Create an image from the uploaded object.</para></listitem>
     684      </orderedlist>
     685      <variablelist>
     686        <varlistentry>
     687          <term><option>--id</option></term><listitem><para>Unique identifier of the image in &product-name;.</para></listitem>
     688        </varlistentry>
     689        <varlistentry>
     690          <term><option>--display-name</option></term><listitem><para>The name of the new image in the Cloud.</para></listitem>
     691        </varlistentry>
     692        <varlistentry>
     693          <term><option>--bucket-name</option></term><listitem><para>The name of the Cloud bucket where the image (object) will be uploaded.</para></listitem>
     694        </varlistentry>
     695        <varlistentry>
     696          <term><option>--object-name</option></term><listitem><para>Name of the object in the bucket.</para></listitem>
    682697        </varlistentry>
    683698      </variablelist>
    … …  
    694709      <variablelist>
    695710        <varlistentry>
    696           <term><option>--gateway-os-name</option></term><listitem><para>The name of OS to use for a cloud gateway.</para></listitem>
    697         </varlistentry>
    698         <varlistentry>
    699           <term><option>--gateway-os-version</option></term><listitem><para>The version of OS to use for a cloud gateway.</para></listitem>
    700         </varlistentry>
    701         <varlistentry>
    702           <term><option>--gateway-shape</option></term><listitem><para>The instance shape to use for a cloud gateway. </para></listitem>
    703         </varlistentry>
    704         <varlistentry>
    705         <term><option>--tunnel-network-name</option></term><listitem><para>The name of VCN/subnet to use for tunneling.</para></listitem>
     711          <term><option>--gateway-os-name</option></term><listitem><para>The name of OS to use for the cloud gateway.</para></listitem>
     712        </varlistentry>
     713        <varlistentry>
     714          <term><option>--gateway-os-version</option></term><listitem><para>The version of the OS to use for the cloud gateway.</para></listitem>
     715        </varlistentry>
     716        <varlistentry>
     717          <term><option>--gateway-shape</option></term><listitem><para>The instance shape to use for the cloud gateway. </para></listitem>
     718        </varlistentry>
     719        <varlistentry>
     720        <term><option>--tunnel-network-name</option></term><listitem><para>The name of the VCN/subnet to use for tunneling.</para></listitem>
    706721        </varlistentry>
    707722        <varlistentry>
    … …  
    709724        </varlistentry>
    710725        <varlistentry>
    711           <term><option>--proxy</option></term><listitem><para>The proxy URL to be used in local gateway installation.</para></listitem>
     726          <term><option>--proxy</option></term><listitem><para>The proxy URL to be used in a local gateway installation.</para></listitem>
    712727        </varlistentry>
    713728        <varlistentry>
    … …  
    749764        </varlistentry>
    750765        <varlistentry>
    751           <term><option>--network-id</option></term><listitem><para>The unique identifier of an existing subnet in the cloud.</para></listitem>
     766          <term><option>--network-id</option></term><listitem><para>The unique identifier of an existing subnet in the Cloud.</para></listitem>
    752767        </varlistentry>
    753768        <varlistentry>

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

    r99513 r106001  
    9393      <title>Common options</title>
    9494      <remark role="help-scope" condition="GLOBAL"/>
    95       <para>The subcommands of <command>cloudprofile</command> implement the standard CRUD operations for a cloud profile.
    96         The next common options must be placed between the "cloud" and  the following sub-commands:</para>
     95      <para>The subcommands of <command>cloudprofile</command> implement the standard Create, Read,
     96        Update, and Delete (CRUD) operations for a cloud profile.
     97        The following common options must be placed after the <command>cloudprofile</command> argument and
     98        before the following sub-commands:</para>
    9799      <variablelist>
    98100        <varlistentry>
    … …  
    102104        <varlistentry>
    103105          <term>--profile=<replaceable>name</replaceable></term>
    104           <listitem><para>Cloud profile name. </para></listitem>
     106          <listitem><para>Cloud profile name.</para></listitem>
    105107        </varlistentry>
    106108      </variablelist>
    … …  
    111113      <remark role="help-copy-synopsis"/>
    112114      <para>
    113         Add new cloud profile for a specified cloud provider.
     115        Add a new cloud profile for the specified cloud provider.
    114116      </para>
    115117      <variablelist>
    … …  
    120122        <varlistentry>
    121123          <term><option>--fingerprint=<replaceable>MD5 string</replaceable></option></term>
    122           <listitem><para>Fingerprint for the key pair being used.</para></listitem>
     124          <listitem><para>Fingerprint of the key pair being used.</para></listitem>
    123125        </varlistentry>
    124126        <varlistentry>
    125127          <term><option>--keyfile=<replaceable>path</replaceable></option></term>
    126           <listitem><para>Full path and filename of the private key. </para></listitem>
     128          <listitem><para>Full path and filename of the private key.</para></listitem>
    127129        </varlistentry>
    128130        <varlistentry>
    129131        <term><option>--passphrase=<replaceable>string</replaceable></option></term>
    130         <listitem><para>Passphrase used for the key, if it is encrypted.</para></listitem>
     132        <listitem><para>Passphrase used for the key if it is encrypted.</para></listitem>
    131133      </varlistentry>
    132134      <varlistentry>
    133135        <term><option>--tenancy=<replaceable>unique id</replaceable></option></term>
    134         <listitem><para>ID of your tenancy. </para></listitem>
     136        <listitem><para>ID of your tenancy.</para></listitem>
    135137      </varlistentry>
    136138      <varlistentry>
    … …  
    149151      <remark role="help-copy-synopsis"/>
    150152      <para>
    151         Display information about a cloud profile for a specified cloud provider.
     153        Display information about a cloud profile for the specified cloud provider.
    152154      </para>
    153155    </refsect2>
    … …  
    170172        <varlistentry>
    171173          <term><option>--keyfile=<replaceable>path</replaceable></option></term>
    172           <listitem><para>Full path and filename of the private key. </para></listitem>
     174          <listitem><para>Full path and filename of the private key.</para></listitem>
    173175        </varlistentry>
    174176        <varlistentry>
    175177        <term><option>--passphrase=<replaceable>string</replaceable></option></term>
    176         <listitem><para>Passphrase used for the key, if it is encrypted.</para></listitem>
     178        <listitem><para>Passphrase used for the key if it is encrypted.</para></listitem>
    177179      </varlistentry>
    178180      <varlistentry>
    179181        <term><option>--tenancy=<replaceable>unique id</replaceable></option></term>
    180         <listitem><para>ID of your tenancy. </para></listitem>
     182        <listitem><para>ID of the tenancy.</para></listitem>
    181183      </varlistentry>
    182184      <varlistentry>
    183185        <term><option>--compartment=<replaceable>unique id</replaceable></option></term>
    184         <listitem><para>ID of your compartment.</para></listitem>
     186        <listitem><para>ID of the compartment.</para></listitem>
    185187      </varlistentry>
    186188      <varlistentry>

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

    r99513 r106001  
    123123    </itemizedlist>
    124124    <para>
    125       In addition to managing virtual machines (VMs) with this CLI or
    126       the GUI, you can use the <command>VBoxHeadless</command> CLI to
    127       manage VMs remotely.
    128     </para>
    129     <para>
    130125      The <command>VBoxManage</command> command performs particular
    131126      tasks by using subcommands, such as <command>list</command>,
    … …  
    144139    </para>
    145140    <para>
    146       Note that you must enclose the entire VM name in double quotes if
    147       it contains spaces.
     141      Note that VM names which contain spaces or special characters
     142      must be enclosed in quotes.
    148143    </para>
    149144    <refsect2 id="vboxmanage-common-options">
    … …  
    172167              default.
    173168            </para><para>
    174               You cannot unencrypt encrypted settings. So, if the
    175               settings are encrypted, you must continue to specify the
     169              Settings which have been encrypted are done so using a
     170              one-way encryption algorithm so cannot be decrypted. Thus,
     171              if the settings are encrypted you must include the
    176172              <option>--settingspw</option> or
    177               <option>--settingspwfile</option> option.
     173              <option>--settingspwfile</option> option every time
     174              <command>VBoxManage</command> is used.
    178175            </para><para>
    179176              Only the iSCSI secret is encrypted at this time.
    … …  
    254251    <para>
    255252      Note that you can use the <command>VBoxManage modifyvm</command>
    256       command even when the VM is powered off.
     253      command only for VMs that are powered off.
    257254    </para>
    258255    <para>

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

    r105387 r106001  
    258258        <arg choice="plain"><replaceable>vmname</replaceable></arg>
    259259      </group>
    260       <arg choice="plain">natpf<replaceable>N</replaceable> delete</arg>
     260      <arg choice="plain">natpf<replaceable>N</replaceable>delete</arg>
    261261
    262262      <arg choice="req"><replaceable>rulename</replaceable></arg>
    … …  
    806806      </para>
    807807      <para>
    808         The cold reboot immediately restarts and reboots the guest
     808        A cold reboot immediately restarts and reboots the guest
    809809        operating system (OS). The state of the VM is not saved prior to
    810810        the reset, so data might be lost. This action is equivalent to
    … …  
    831831      </para>
    832832      <para>
    833         When in the powered off state, you can restart the VM. See
     833        The <command>poweroff</command> subcommand places a VM into
     834        the Powered Off state from which you can restart the VM using
    834835        <xref linkend="vboxmanage-startvm" />.
    835836      </para>
    … …  
    851852      </para>
    852853      <para>
    853         When in the saved state, you can restart the VM. It will continue
    854         exactly in the state you saved.
     854        The <command>savestate</command> subcommand places a VM into
     855        the Saved state from which you can restart the VM using
     856        <xref linkend="vboxmanage-startvm" />.  The VM will resume
     857        from the exact point at which it was saved.
    855858      </para>
    856859    </refsect2>
    … …  
    894897      </para>
    895898      <para>
    896         This commands requires Guest Additions to be installed in the VM.
     899        This command requires the &product-name; Guest Additions to be
     900        installed in the VM.
    897901      </para>
    898902    </refsect2>
    … …  
    907911      </para>
    908912      <para>
    909         This commands requires Guest Additions to be installed in the VM.
     913        This command requires the &product-name; Guest Additions to be
     914        installed in the VM.
    910915      </para>
    911916    </refsect2>
    … …  
    975980          </para></listitem>
    976981        <listitem><para>
    977             <literal>nat</literal> specifies that the VM uses network
    978             address translation (NAT).
     982            <literal>nat</literal> specifies that the VM uses Network
     983            Address Translation (NAT).
    979984          </para></listitem>
    980985        <listitem><para>
    … …  
    10151020      </para>
    10161021      <para>
    1017         If you did not configure a file name for the trace file then
     1022        If you do not configure a file name for the trace file then
    10181023        a default one is used, placing it in the VM subdirectory.
    10191024      </para>
    … …  
    10611066      </para>
    10621067      <para>
    1063         Those properties are backend engine-specific, and are different
    1064         between UDP Tunnel and the VDE backend drivers. See
    1065         <xref linkend="network_udp_tunnel" />.
     1068        Those properties are backend engine-specific and are different
     1069        between UDP Tunnel and the Virtual Distributed Ethernet (VDE) backend
     1070        drivers. See <xref linkend="network_udp_tunnel" />.
    10661071      </para>
    10671072    </refsect2>
    … …  
    11741179      </para>
    11751180      <para>
    1176         This feature requires that the &product-name; Guest Additions
    1177         are installed in the VM.
     1181        This feature requires the &product-name; Guest Additions
     1182        to be installed in the VM.
    11781183      </para>
    11791184    </refsect2>
    … …  
    11861191        <replaceable>vmname</replaceable> clipboard filetransfers</command>
    11871192        command specifies if it is possible to transfer files through the
    1188         clipboard between the host and VM, in the direction which is allowed.
    1189         Valid values are <literal>off</literal> and <literal>on</literal>.
    1190         The default value is <literal>off</literal>.
    1191       </para>
    1192       <para>
    1193         This feature requires that the &product-name; Guest Additions
    1194         are installed in the VM.
     1193        clipboard between the host and VM in the direction(s) configured for
     1194        the <command>clipboard mode</command>.  Valid values are
     1195        <literal>off</literal> and <literal>on</literal>.  The default value
     1196        is <literal>off</literal>.
     1197      </para>
     1198      <para>
     1199        This feature requires the &product-name; Guest Additions
     1200        to be installed in the VM.
    11951201      </para>
    11961202    </refsect2>
    … …  
    12101216      </para>
    12111217      <para>
    1212         This feature requires that the &product-name; Guest Additions
    1213         are installed in the VM.
     1218        This feature requires the &product-name; Guest Additions
     1219        to be installed in the VM.
    12141220      </para>
    12151221    </refsect2>
    … …  
    12341240        specifies the port or range of ports to which the VRDE server
    12351241        can bind. The default value is <literal>default</literal> or
    1236         <literal>0</literal>, which is the standard RDP port,
     1242        <literal>0</literal>, which uses the standard RDP port,
    12371243        <literal>3389</literal>.
    12381244      </para>
    12391245      <para>
    1240         Also see the <option>--vrde-port</option> option description in
     1246        See also the <option>--vrde-port</option> option description in
    12411247        <xref linkend="vboxmanage-modifyvm-vrde" />.
    12421248      </para>
    … …  
    12581264            is the standard RDP port, <literal>3389</literal>.
    12591265          </para><para>
    1260             Also see the <option>--vrde-port</option> option description
     1266            See also the <option>--vrde-port</option> option description
    12611267            in <xref linkend="vboxmanage-modifyvm-vrde" />.
    12621268          </para></listitem>
    … …  
    12641270            <literal>TCP/Address</literal> specifies the IP address of
    12651271            the host network interface to which the VRDE server binds.
    1266             When specified, the server accepts to connect only on the
     1272            When specified, the server accepts connections only on the
    12671273            specified host network interface.
    12681274          </para><para>
    1269             Also see the <option>--vrde-address</option> option
     1275            See also the <option>--vrde-address</option> option
    12701276            description in <xref linkend="vboxmanage-modifyvm-vrde" />.
    12711277          </para></listitem>
    … …  
    12751281            channel. Valid values are <literal>1</literal> to enable the
    12761282            video channel and <literal>0</literal> to disable the video
    1277             channel. The default value is <literal>off</literal>. See
     1283            channel. The default value is <literal>0</literal>. See
    12781284            <xref linkend="vrde-videochannel" />.
    12791285          </para></listitem>
    … …  
    13371343            <literal>1</literal> to disable the feature and an empty
    13381344            string (<literal>""</literal>) to enable the feature.
    1339             To reenable the feature, use
     1345            To re-enable the feature, use
    13401346            <literal>Client/DisableClipboard=</literal>. The default
    13411347            value is <literal>1</literal>. See
    … …  
    13471353            values are <literal>1</literal> to disable the feature and
    13481354            an empty string (<literal>""</literal>) to enable the
    1349             feature. To reenable the feature, use
     1355            feature. To re-enable the feature, use
    13501356            <literal>Client/DisableUpstreamAudio=</literal>. The default
    13511357            value is <literal>1</literal>. See
    … …  
    15261532        recording for each screen that you specify is saved to its own
    15271533        file in the machine folder. You cannot modify this setting while
    1528         recording is enabled.
     1534        a screen recording is in progress.
    15291535      </para>
    15301536      <itemizedlist>
    … …  
    15471553        <replaceable>vmname</replaceable> recording filename</command>
    15481554        command specifies the file in which to save the recording. You
    1549         cannot modify this setting while recording is enabled.
     1555        cannot modify this setting while a screen recording is in progress.
    15501556      </para>
    15511557      <para>
    … …  
    15561562
    15571563      <para>
    1558         <command>VBoxManage controlvm <replaceable>vmname</replaceable>
     1564        The <command>VBoxManage controlvm <replaceable>vmname</replaceable>
    15591565        recording videores</command> command specifies the resolution of
    15601566        the recorded video in pixels. You cannot modify this setting
    1561         while recording is enabled.
    1562       </para>
    1563       <para>
    1564         Use the Settings tool to view the video recording settings,
    1565         which are based on the resolution (frame size). See the Frame
    1566         Size field on the Recording tab of the Display page to view the
    1567         default value.
     1567        while a screen recording is in progress.
     1568      </para>
     1569      <para>
     1570        The <emphasis role="bold">Recording</emphasis> settings in the GUI
     1571        which are located in the <emphasis role="bold">Display</emphasis>
     1572        page show the current video recording settings which are based on
     1573        the resolution (frame size). The <emphasis role="bold">Frame Size</emphasis>
     1574        field shows the default value for the recording video resolution.
    15681575      </para>
    15691576      <para>
    … …  
    15851592        The <command>VBoxManage controlvm
    15861593        <replaceable>vmname</replaceable> recording videorate</command>
    1587         command specifies the bit rate,
     1594        command specifies the
    15881595        <replaceable>bit-rate</replaceable>, of the video in kilobits
    15891596        per second. Increasing this value improves the appearance of the
    15901597        video at the cost of an increased file size. You cannot modify
    1591         this setting while recording is enabled.
    1592       </para>
    1593       <para>
    1594         Use the Settings tool to view the video recording settings,
    1595         which are based on the frame size. See the Video Quality field
    1596         on the Recording tab of the Display page to view the default
    1597         value.
     1598        this setting while a VM is running with recording enabled.
     1599      </para>
     1600      <para>
     1601        The <emphasis role="bold">Recording</emphasis> settings in the GUI
     1602        which are located in the <emphasis role="bold">Display</emphasis>
     1603        page show the current video recording settings which are based on
     1604        the resolution (frame size). The <emphasis role="bold">Video Quality</emphasis>
     1605        field shows the default value for the recording video quality.
    15981606      </para>
    15991607
    … …  
    16061614        specified maximum. Increasing the frequency reduces the number
    16071615        of skipped frames and increases the file size. You cannot modify
    1608         this setting while recording is enabled.
    1609       </para>
    1610       <para>
    1611         Use the Settings tool to view the video recording settings,
    1612         which are based on the frame size. See the Frame Rate field on
    1613         the Recording tab of the Display page to view the default value.
     1616        this setting while a VM is running with recording enabled.
     1617      </para>
     1618      <para>
     1619        The <emphasis role="bold">Recording</emphasis> settings in the GUI
     1620        which are located in the <emphasis role="bold">Display</emphasis>
     1621        page show the current video recording settings which are based on
     1622        the resolution (frame size). The <emphasis role="bold">Frame Rate</emphasis>
     1623        field shows the default value for the recording frame rate.
    16141624      </para>
    16151625
    … …  
    16201630        The recording stops after the specified number of seconds
    16211631        elapses. If this value is zero, the recording continues until
    1622         you stop the recording.
     1632        you stop the VM or stop the recording.
    16231633      </para>
    16241634
    … …  
    16291639        recorded video file in megabytes. The recording stops when the
    16301640        file reaches the specified size. If this value is zero, the
    1631         recording continues until you stop the recording. You cannot
    1632         modify this setting while recording is enabled.
     1641        recording continues until you stop the VM or stop the recording.
     1642        You cannot modify this setting while a screen recording is in
     1643        progress.
    16331644      </para>
    16341645
    … …  
    16391650        in a comma-separated keyword-value format. For example,
    16401651        <computeroutput>foo=bar,a=b</computeroutput>. You cannot
    1641         modify this setting while recording is enabled.
     1652        modify this setting while a screen recording is in progress.
    16421653      </para>
    16431654      <para>
    … …  
    16661677            <replaceable>username</replaceable>.
    16671678          </para><para>
    1668             The <option>--passwordfile</option> is mutually exclusive
     1679            The <option>--passwordfile</option> option is mutually exclusive
    16691680            with the <option>--password</option> option.
    16701681          </para></listitem>
    … …  
    16791690            process listing.
    16801691          </remark><para>
    1681             The <option>--password</option> is mutually exclusive with
     1692            The <option>--password</option> option is mutually exclusive with
    16821693            the <option>--passwordfile</option> option.
    16831694          </para></listitem>
    16841695        <listitem><para>
    1685             <option>--allowlocallogin</option> specifies whether to
     1696            <option>--allowlocallogon</option> specifies whether to
    16861697            enable or disable local logins. Valid values are
    16871698            <literal>on</literal> to enable local logins and
    … …  
    17391750              process listing.
    17401751            </remark><para>
    1741               The <option>--password</option> is mutually exclusive with
     1752              The <option>--password</option> option is mutually exclusive with
    17421753              the <option>--passwordfile</option> option.
    17431754            </para></listitem>
    … …  
    17541765              you can read the password from standard input.
    17551766            </para><para>
    1756               The <option>--passwordfile</option> is mutually exclusive
     1767              The <option>--passwordfile</option> option is mutually exclusive
    17571768              with the <option>--password</option> option.
    17581769            </para></listitem>
    … …  
    17901801        The <command>VBoxManage controlvm
    17911802        <replaceable>vmname</replaceable> cpuexecutioncap</command>
    1792         command specifies how the maximum amount of physical CPU time
     1803        command specifies the maximum amount of physical CPU time
    17931804        used by a virtual CPU. Valid values are a percentage between
    17941805        <literal>1</literal> and <literal>100</literal>. A value of
    … …  
    18221833          </para></listitem>
    18231834        <listitem><para>
    1824             <literal>flat</literal> &ndash; Assumes a scheduling
     1835            <literal>flat</literal> &ndash; Uses a scheduling
    18251836            policy which puts the process at the default priority
    18261837            and with all threads at the same priority.
    18271838          </para></listitem>
    18281839        <listitem><para>
    1829             <literal>low</literal> &ndash;  Assumes a scheduling
     1840            <literal>low</literal> &ndash; Uses a scheduling
    18301841            policy which puts the process mostly below the default
    18311842            priority of the host OS.
    18321843          </para></listitem>
    18331844        <listitem><para>
    1834             <literal>normal</literal> &ndash; Assume a scheduling
     1845            <literal>normal</literal> &ndash; Uses a scheduling
    18351846            policy which shares the CPU resources fairly with
    18361847            other processes running with the default priority of
    … …  
    18381849          </para></listitem>
    18391850        <listitem><para>
    1840             <literal>high</literal> &ndash; Assumes a scheduling
     1851            <literal>high</literal> &ndash; Uses a scheduling
    18411852            policy which puts the task above the default priority of
    18421853            the host OS. This policy might easily cause other tasks
    … …  
    18651876      <para>
    18661877        You can specify optional settings in the form of
    1867         semi-colon-separated (<literal>;</literal>) name-value pairs.
     1878        semicolon-separated (<literal>;</literal>) name-value pairs.
    18681879        These properties enable you to configure the emulated webcam
    18691880        device.
    … …  
    18921903              some webcams. If the VM is able to use larger buffers,
    18931904              higher values might reduce CPU load slightly. Note that
    1894               some guest OSes might not suppport higher
     1905              some guest OSes might not support higher
    18951906              <literal>MaxPayloadTransferSize</literal> values.
    18961907            </para></listitem>
    … …  
    19061917        command detaches a webcam from a running VM. Specify the webcam
    19071918        as the absolute path of the webcam on the host OS or as an
    1908         alias. Use the <command>VBoxManage list webcams</command> to
    1909         obtain the webcam alias.
     1919        alias. Use the <command>VBoxManage list webcams</command> command
     1920        to obtain the webcam alias.
    19101921      </para>
    19111922      <para>
    … …  
    19431954        <replaceable>vmname</replaceable> webcam list</command> command
    19441955        lists webcams that are attached to the running VM. The output
    1945         shows a list of absolute paths or aliases that attached the
    1946         webcams to the VM by using the <command>VBoxManage controlvm
     1956        shows a list of absolute paths or aliases of the webcams which
     1957        were attached to the VM using the <command>VBoxManage controlvm
    19471958        <replaceable>vmname</replaceable> webcam attach</command>
    19481959        command.
    … …  
    19501961    </refsect2>
    19511962    <refsect2 id="vboxmanage-controlvm-addencpassword">
    1952       <title>Set an Encryption Password for a Virtual Machine</title>
    1953       <remark role="help-copy-synopsis"/>
     1963      <title>Starting a Virtual Machine with Encrypted Images</title>
     1964      <remark role="help-copy-synopsis"/>
     1965      <para>
     1966        You can encrypt the data stored in the hard disk images used
     1967        by the VM. &product-name; uses the AES algorithm in XTS mode and
     1968        supports 128-bit or 256-bit data encryption keys (DEK). The
     1969        encrypted DEK is stored in the medium properties and is
     1970        decrypted during VM startup when you provide the encryption
     1971        password.
     1972      </para>
     1973      <para>
     1974        Use the <command>VBoxManage encryptmedium</command> command to
     1975        create a DEK encrypted medium. See
     1976        <xref linkend="diskencryption-encryption" />.
     1977      </para>
     1978      <para>
     1979        When a VM which contains one or more encrypted disk images is
     1980        started using the &product-name; GUI a dialog will open to prompt
     1981        the user for the password of each encrypted disk attached to the
     1982        VM.  If the <command>VBoxHeadless</command> frontend is used, the
     1983        VM will be paused as soon as the guest tries to access an encrypted
     1984        disk. The user needs to provide the passwords by using
     1985        <command>addencpassword</command> subcommand.
     1986      </para>
    19541987      <para>
    19551988        The <command>VBoxManage controlvm
    19561989        <replaceable>vmname</replaceable> addencpassword</command>
    1957         command provides the <replaceable>vmname</replaceable> encrypted
    1958         VM with the encryption password to enable a headless start.
    1959         Specify the absolute path of a password file on the host system.
    1960         If <replaceable>filename</replaceable> is <literal>-</literal>,
    1961         <command>VBoxManage</command> prompts for the encryption
    1962         password.
     1990        command provides the encryption password to the VM named
     1991        <replaceable>vmname</replaceable> which contains encrypted disks
     1992        that has been started using the <command>VBoxHeadless</command>
     1993        frontend.  Specify the absolute path of a password file on the
     1994        host system.  If <replaceable>filename</replaceable> is
     1995        <literal>-</literal>, <command>VBoxManage</command> prompts for
     1996        the encryption password.
    19631997      </para>
    19641998      <para>
    … …  
    19722006        addencpassword</command> to provide the password to resume
    19732007        execution on the VM. Use this feature when you do not want to
    1974         store the password in VM memory while the VM is suspended by a
     2008        store the password in VM memory when the VM is suspended by a
    19752009        host suspend event.
    19762010      </para>
    1977       <note>
    1978         <para>
    1979           You can encrypt data stored on hard disk images used by the
    1980           VM. &product-name; uses the AES algorithm in XTS mode and
    1981           supports 128-bit or 256-bit data encryption keys (DEK). The
    1982           encrypted DEK is stored in the medium properties and is
    1983           decrypted during VM startup when you provide the encryption
    1984           password.
    1985         </para>
    1986       </note>
    1987       <para>
    1988         Use the <command>VBoxManage encryptmedium</command> command to
    1989         create a DEK encrypted medium. See
    1990         <xref linkend="diskencryption-encryption" />.
    1991       </para>
    1992       <para>
    1993         The &product-name; GUI prompts you for the encryption password
    1994         when you start an encrypted VM.
    1995       </para>
    1996       <para>
    1997         Use the following command to perform a headless start of an
    1998         encrypted VM:
     2011      <para>
     2012        The following is one way to perform a headless start of VM which
     2013        contains encrypted disk images:
    19992014      </para>
    20002015<screen>
    … …  
    20022017        </screen>
    20032018      <para>
    2004         Then, use the following command to provide the encryption
    2005         password:
     2019        The following command provides the encryption password to the VM
     2020        so that it can resume starting up:
    20062021      </para>
    20072022<screen>
    … …  
    20972112        <replaceable>vmname</replaceable> autostart-enabled</command>
    20982113        command specifies whether to enable or disable automatically
    2099         start the VM at host system boot-up. You must do some host
     2114        starting of the VM at host system boot-up. You must do some host
    21002115        system configuration before you can use this feature.
    21012116        See <xref linkend="autostart" />. Valid values are
    2102         <literal>on</literal>, which enables autostart feature for
     2117        <literal>on</literal>, which enables the autostart feature for
    21032118        the VM and <literal>off</literal>, which disables it. The
    21042119        default value is <literal>off</literal>.

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

    r100019 r106001  
    195195          <term><replaceable>bytes</replaceable></term>
    196196          <listitem><para>
    197               Specifies the capacity of the targe image name. Needs to be
     197              Specifies the capacity of the target image name. This needs to be
    198198              given explicitly, because generally pipes do not support
    199199              querying the overall size of the data stream.
    … …  
    220220              Specifies any required file format variants for the output
    221221              file. This is a comma-separated list of variant values.
    222               Following are the valid values:
     222              The list of valid values is:
    223223            </para><itemizedlist>
    224224              <listitem><para>

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

    r99513 r106001  
    5454      </group>
    5555      <arg choice="plain">dumpvmcore</arg>
    56       <arg>--filename=<replaceable>name</replaceable></arg>
     56      <arg choice="req">--filename=<replaceable>name</replaceable></arg>
    5757    </cmdsynopsis>
    5858    <cmdsynopsis id="synopsis-vboxmanage-debugvm-info">
    … …  
    227227        <varlistentry>
    228228          <term><option>--filename=<replaceable>filename</replaceable></option></term>
    229           <listitem><para>The name of the output file.</para></listitem>
     229          <listitem><para>The name of the output file. This option is required.</para></listitem>
    230230        </varlistentry>
    231231      </variablelist>
    … …  
    255255          <listitem>
    256256            <para>Optional argument string for the info item handler.  Most info items
    257             does not take any extra arguments.  Arguments not recognized are generally
     257            do not take any extra arguments.  Arguments not recognized are generally
    258258            ignored.</para>
    259259          </listitem>
    … …  
    277277      <remark role="help-copy-synopsis"/>
    278278      <para>
    279         Changes the group settings for either debug (<option>--debug</option>)
     279        Changes the group settings for either the debug (<option>--debug</option>)
    280280        or release (<option>--release</option>) logger of the VM process.
    281281      </para>
    282282      <para>
    283         The <replaceable>group-settings</replaceable> are typically strings on the form
     283        The <replaceable>group-settings</replaceable> are typically strings of the form
    284284        <computeroutput>em.e.f.l</computeroutput>, <computeroutput>hm=~0</computeroutput>
    285285        and <computeroutput>-em.f</computeroutput>.  Basic wildcards are supported for
    … …  
    288288      </para>
    289289      <para>
    290         Please do keep in mind that the group settings are applied as modifications
    291         to the current ones.
     290        Please keep in mind that the group settings are applied as modifications
     291        to the current values.
    292292      </para>
    293293      <para>
    … …  
    300300      <remark role="help-copy-synopsis"/>
    301301      <para>
    302         Changes the destination settings for either debug (<option>--debug</option>)
     302        Changes the destination settings for either the debug (<option>--debug</option>)
    303303        or release (<option>--release</option>) logger of the VM process.  For details
    304304        on the destination format, the best source is src/VBox/Runtime/common/log/log.cpp.
    305305      </para>
    306306      <para>
    307         The <replaceable>destinations</replaceable> is one or more mnemonics, optionally
    308         prefixed by "no" to disable them.  Some of them take values after a ":" or "="
    309         separator.  Multiple mnemonics can be separated by space or given as separate
     307        The <replaceable>destinations</replaceable> argument is one or more mnemonics, optionally
     308        prefixed by "no" to disable them.  Some of these take values after a ":" or "="
     309        separator.  Multiple mnemonics can be separated by whitespace or given as separate
    310310        arguments on the command line.
    311311      </para>
    312312      <para>
    313         List of available destination:
     313        List of available destinations:
    314314      </para>
    315315      <variablelist>
    … …  
    318318          <listitem><para>Specifies a log file.  If no filename is given, one will be
    319319              generated based on the current UTC time and VM process name and placed in
    320               the current directory of the VM process.  Note that this will currently not
     320              the current directory of the VM process.  Note that this will not
    321321              have any effect if the log file has already been opened.
    322322          </para></listitem>
    … …  
    325325          <term><option>dir=<replaceable>directory</replaceable>, nodir</option></term>
    326326          <listitem><para>Specifies the output directory for log files.  Note that this
    327               will currently not have any effect if the log file has already been opened.
     327              will not have any effect if the log file has already been opened.
    328328          </para></listitem>
    329329        </varlistentry>
    330330        <varlistentry>
    331331          <term><option>history=<replaceable>count</replaceable>, nohistory</option></term>
    332           <listitem><para>A non-zero value enables log historization, with the value
     332          <listitem><para>A non-zero value enables log rotation, with the value
    333333            specifying how many old log files to keep.
    334334          </para></listitem>
    … …  
    336336        <varlistentry>
    337337          <term><option>histsize=<replaceable>bytes</replaceable></option></term>
    338           <listitem><para>The max size of a log file before it is historized.  Default is infinite.</para></listitem>
     338          <listitem><para>The max size of a log file before it is rotated.  Default is infinite.</para></listitem>
    339339        </varlistentry>
    340340        <varlistentry>
    341341          <term><option>histtime=<replaceable>seconds</replaceable></option></term>
    342           <listitem><para>The max age (in seconds) of a log file before it is historized.  Default is infinite.</para></listitem>
     342          <listitem><para>The max age (in seconds) of a log file before it is rotated.  Default is infinite.</para></listitem>
    343343        </varlistentry>
    344344        <varlistentry>
    … …  
    365365        <varlistentry>
    366366          <term><option>user, nouser</option></term>
    367           <listitem><para>Custom destination which has no meaning to VM processes..</para></listitem>
     367          <listitem><para>Custom destination which has no meaning to VM processes.</para></listitem>
    368368        </varlistentry>
    369369      </variablelist>
    … …  
    377377      <remark role="help-copy-synopsis"/>
    378378      <para>
    379         Changes the flags on either debug (<option>--debug</option>) or release
     379        Changes the flags for either the debug (<option>--debug</option>) or release
    380380        (<option>--release</option>) logger of the VM process.  Please note that the
    381         modifications are applied onto the existing changes, they are not replacing them.
     381        modifications are applied to the existing values, they do not replace them.
    382382      </para>
    383383      <para>
    384384        The <replaceable>flags</replaceable> are a list of flag mnemonics, optionally
    385385        prefixed by a "no", "!", "~" or "-" to negate their meaning.  The "+" prefix
    386         can be used to undo previous negation or use as a separator, though better use
    387         whitespace or separate arguments for that.
    388       </para>
    389       <para>
    390         List of log flag mnemonics, with their counter form where applicable
    391         (asterisk indicates defaults):
     386        can be used to undo a previous negation or as a separator, although it is better
     387        to use whitespace or separate arguments for that.
     388      </para>
     389      <para>
     390        List of log flag mnemonics, with their opposite value where applicable
     391        (an asterisk indicates the default value):
    392392      </para>
    393393      <variablelist>
    … …  
    398398        <varlistentry>
    399399          <term><option>buffered, unbuffered*</option></term>
    400           <listitem><para>Enabling buffering of log output before it hits the destinations.</para></listitem>
     400          <listitem><para>Enables buffering of log output before it hits the destinations.</para></listitem>
    401401        </varlistentry>
    402402        <varlistentry>
    … …  
    423423        <varlistentry>
    424424          <term><option>flagno</option></term>
    425           <listitem><para>Prefix each log line with the numberic flags corresponding to the log statement.</para></listitem>
     425          <listitem><para>Prefix each log line with the numeric flags corresponding to the log statement.</para></listitem>
    426426        </varlistentry>
    427427        <varlistentry>
    … …  
    467467        <varlistentry>
    468468          <term><option>rel, abs*</option></term>
    469           <listitem><para>Selects the whether <computeroutput>ts</computeroutput> and
     469          <listitem><para>Selects whether the <computeroutput>ts</computeroutput> and
    470470              <computeroutput>tsc</computeroutput> prefixes should be displayed as relative to the
    471471              previous log line or as absolute time.</para></listitem>
    … …  
    473473        <varlistentry>
    474474          <term><option>hex*, dec</option></term>
    475           <listitem><para>Selects the whether the <computeroutput>ts</computeroutput> and
     475          <listitem><para>Selects whether the <computeroutput>ts</computeroutput> and
    476476              <computeroutput>tsc</computeroutput> prefixes should be formatted as hexadecimal
    477477              or decimal.</para></listitem>
    … …  
    545545          <term><replaceable>reg-set.reg-name</replaceable></term>
    546546          <listitem>
    547             <para>One of more registers, each having one of the following forms:</para>
     547            <para>One or more registers, each having one of the following forms:</para>
    548548            <orderedlist>
    549549              <listitem><para>register-set.register-name.sub-field</para></listitem>
    … …  
    577577          <term><replaceable>reg-set.reg-name=value</replaceable></term>
    578578          <listitem>
    579             <para>One of more register assignment, each having one of the following forms:</para>
     579            <para>One or more register assignment, each having one of the following forms:</para>
    580580            <orderedlist>
    581581              <listitem><para>register-set.register-name.sub-field=value</para></listitem>

  • trunk/doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xml

    r98103 r106001  
    8989        </varlistentry>        <varlistentry>
    9090          <term>21 - PolicyFilter</term>
    91           <listitem><para>List of IPv4 addresses and masks paris controlling non-local source routing.</para></listitem>
     91          <listitem><para>List of IPv4 addresses and masks pairs controlling non-local source routing.</para></listitem>
    9292        </varlistentry>        <varlistentry>
    9393          <term>22 - MaxDgramReassemblySize</term>
    … …  
    197197        </varlistentry>        <varlistentry>
    198198          <term>69 - SMTPServers</term>
    199           <listitem><para>Space separated list of IPv4 simple mail transport protocol (SMPT) server addresses.</para></listitem>
     199          <listitem><para>Space separated list of IPv4 simple mail transport protocol (SMTP) server addresses.</para></listitem>
    200200        </varlistentry>        <varlistentry>
    201201          <term>70 - POP3Servers</term>
    … …  
    221221        </varlistentry>        <varlistentry>
    222222          <term>78 - SLPDirectoryAgent</term>
    223           <listitem><para>Addresses of one or more service location protocol (SLP) directory agent, and an indicator of whether their use is mandatory. Only accessible using --set-opt-hex.</para></listitem>
     223          <listitem><para>Address of one or more service location protocol (SLP) directory agents, and an indicator of whether their use is mandatory. Only accessible using --set-opt-hex.</para></listitem>
    224224        </varlistentry>        <varlistentry>
    225225          <term>79 - SLPServiceScope</term>
    226           <listitem><para>List of service scopes for the service location protocol (SLP) and whether using the list is mandator. Only accessible using --set-opt-hex.</para></listitem>
     226          <listitem><para>List of service scopes for the service location protocol (SLP) and whether using the list is mandatory. Only accessible using --set-opt-hex.</para></listitem>
    227227        </varlistentry>        <varlistentry>
    228228          <term>119 - DomainSearch</term>

  • trunk/doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xsl

    r98108 r106001  
    3535
    3636
    37 <!-- Default operation is to supress output -->
     37<!-- Default operation is to suppress output -->
    3838<xsl:template match="node()|@*">
    3939  <xsl:apply-templates/>

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

    r99513 r106001  
    6767        <arg rep="repeat">--set-opt-hex=<replaceable>dhcp-opt-no hexstring</replaceable></arg>
    6868        <arg rep="repeat">--force-opt=<replaceable>dhcp-opt-no</replaceable></arg>
    69         <arg rep="repeat">--supress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
     69        <arg rep="repeat">--suppress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
    7070        <arg>--min-lease-time=<replaceable>seconds</replaceable></arg>
    7171        <arg>--default-lease-time=<replaceable>seconds</replaceable></arg>
    … …  
    7878        <arg rep="repeat">--set-opt-hex=<replaceable>dhcp-opt-no hexstring</replaceable></arg>
    7979        <arg rep="repeat">--force-opt=<replaceable>dhcp-opt-no</replaceable></arg>
    80         <arg rep="repeat">--supress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
     80        <arg rep="repeat">--suppress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
    8181        <arg rep="repeat">--incl-mac=<replaceable>address</replaceable></arg>
    8282        <arg rep="repeat">--excl-mac=<replaceable>address</replaceable></arg>
    … …  
    102102        <arg rep="repeat">--set-opt-hex=<replaceable>dhcp-opt-no hexstring</replaceable></arg>
    103103        <arg rep="repeat">--force-opt=<replaceable>dhcp-opt-no</replaceable></arg>
    104         <arg rep="repeat">--supress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
     104        <arg rep="repeat">--suppress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
    105105        <arg>--min-lease-time=<replaceable>seconds</replaceable></arg>
    106106        <arg>--default-lease-time=<replaceable>seconds</replaceable></arg>
    … …  
    114114        <arg rep="repeat">--set-opt-hex=<replaceable>dhcp-opt-no hexstring</replaceable></arg>
    115115        <arg rep="repeat">--force-opt=<replaceable>dhcp-opt-no</replaceable></arg>
    116         <arg rep="repeat">--supress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
     116        <arg rep="repeat">--suppress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
    117117        <arg>--min-lease-time=<replaceable>seconds</replaceable></arg>
    118118        <arg>--default-lease-time=<replaceable>seconds</replaceable></arg>
    … …  
    143143        <arg rep="repeat">--force-opt=<replaceable>dhcp-opt-no</replaceable></arg>
    144144        <arg rep="repeat">--unforce-opt=<replaceable>dhcp-opt-no</replaceable></arg>
    145         <arg rep="repeat">--supress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
    146         <arg rep="repeat">--unsupress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
     145        <arg rep="repeat">--suppress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
     146        <arg rep="repeat">--unsuppress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
    147147        <arg>--min-lease-time=<replaceable>seconds</replaceable></arg>
    148148        <arg>--default-lease-time=<replaceable>seconds</replaceable></arg>
    … …  
    157157        <arg rep="repeat">--force-opt=<replaceable>dhcp-opt-no</replaceable></arg>
    158158        <arg rep="repeat">--unforce-opt=<replaceable>dhcp-opt-no</replaceable></arg>
    159         <arg rep="repeat">--supress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
    160         <arg rep="repeat">--unsupress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
     159        <arg rep="repeat">--suppress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
     160        <arg rep="repeat">--unsuppress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
    161161        <arg rep="repeat">--del-mac=<replaceable>address</replaceable></arg>
    162162        <arg rep="repeat">--incl-mac=<replaceable>address</replaceable></arg>
    … …  
    192192        <arg rep="repeat">--force-opt=<replaceable>dhcp-opt-no</replaceable></arg>
    193193        <arg rep="repeat">--unforce-opt=<replaceable>dhcp-opt-no</replaceable></arg>
    194         <arg rep="repeat">--supress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
    195         <arg rep="repeat">--unsupress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
     194        <arg rep="repeat">--suppress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
     195        <arg rep="repeat">--unsuppress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
    196196        <arg>--min-lease-time=<replaceable>seconds</replaceable></arg>
    197197        <arg>--default-lease-time=<replaceable>seconds</replaceable></arg>
    … …  
    208208        <arg rep="repeat">--force-opt=<replaceable>dhcp-opt-no</replaceable></arg>
    209209        <arg rep="repeat">--unforce-opt=<replaceable>dhcp-opt-no</replaceable></arg>
    210         <arg rep="repeat">--supress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
    211         <arg rep="repeat">--unsupress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
     210        <arg rep="repeat">--suppress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
     211        <arg rep="repeat">--unsuppress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
    212212        <arg>--min-lease-time=<replaceable>seconds</replaceable></arg>
    213213        <arg>--default-lease-time=<replaceable>seconds</replaceable></arg>
    … …  
    260260    <para>
    261261      The <command>dhcpserver</command> commands enable you to control the DHCP
    262        server that is built into VirtualBox.  You may find this useful when
     262       server that is built into &product-name;.  You may find this useful when
    263263       using internal or host-only networking.  Theoretically, you can also
    264264       enable it for a bridged network, but that may cause conflicts with other
    … …  
    275275        <varlistentry>
    276276          <term>--network=<replaceable>netname</replaceable></term>
    277           <listitem><para>The internal network name.  This is the same as you
    278             would use as value to the <command>VBoxManage modifyvm --intnet</command>
    279             option when configuring a VM for internal networking.  Or you see as
    280             VBoxNetworkName in the output from
     277          <listitem><para>The internal network name.  This is the same name you
     278            would supply to the <command>VBoxManage modifyvm --intnet</command>
     279            option when configuring a VM for internal networking.  The internal
     280            network name can be found labelled as
     281            <emphasis role="bold">VBoxNetworkName</emphasis> in the output of
     282            the following commands:
    281283            <command>VBoxManage list intnets</command>,
    282284            <command>VBoxManage list natnets</command>, or
    … …  
    286288        <varlistentry>
    287289          <term>--interface=<replaceable>ifname</replaceable></term>
    288           <listitem><para>The host only interface name.  This would be same value
    289             as you would use for the <command>VBoxManage modifyvm --host-only-adapter</command>
     290          <listitem><para>The host only interface name.  This is the same value
     291            would supply to the <command>VBoxManage modifyvm --host-only-adapter</command>
    290292            option when configuring a VM to use a host-only network.  The value
    291             can also be found in the Name row in <command>VBoxManage list hostonlyifs</command>.
     293            can also be found labelled as <emphasis role="bold">Name</emphasis> in
     294            the output of the <command>VBoxManage list hostonlyifs</command> command.
    292295          </para></listitem>
    293296        </varlistentry>
    … …  
    313316          <listitem><para>The IP address range for the DHCP server to manage.  This
    314317            should not include the address of the DHCP server itself, but it must be
    315             in the same network as it.  The boundraries are inclusive, so both the
    316             lower and upper addresses will be handed out to clients.</para></listitem>
     318            in the same network.  The boundaries are inclusive, so both the lower and
     319            upper addresses will be handed out to clients.</para></listitem>
    317320        </varlistentry>
    318321        <varlistentry>
    … …  
    323326          <term><option>--enable</option>, --disable</term>
    324327          <listitem><para>Whether to enable the DHCP server or disable it.  If not specified,
    325             the server will be created in disabled state and no IP addresses handed out.</para></listitem>
     328            the server will be created in a disabled state and no IP addresses will be handed
     329            out.</para></listitem>
    326330        </varlistentry>
    327331      </variablelist>
    … …  
    333337          <term><option>--global</option></term>
    334338          <listitem><para>Set the configuration scope to global.  Any subsequent
    335             <option>--set-opt</option> options will be apply to all the DHCP clients.</para></listitem>
     339            <option>--set-opt</option> options will be applied to all the DHCP clients.</para></listitem>
    336340        </varlistentry>
    337341        <varlistentry>
    … …  
    343347        <varlistentry>
    344348          <term><option>--nic=<replaceable>1-N</replaceable></option></term>
    345           <listitem><para>Set the configuration scope to a NIC other than first of
    346             the VM specified the in <option>--vm</option>.
     349          <listitem><para>Set the configuration scope to a NIC other than the first NIC of
     350            the VM specified in the <option>--vm</option> option.
    347351          </para></listitem>
    348352        </varlistentry>
    … …  
    370374          <term><option>--set-opt-hex=<replaceable>dhcp-opt-no hexstring</replaceable></option></term>
    371375          <listitem><para>Adds the specified DHCP option number (0-255) and value.  The option value
    372             is specified as a raw series of hex bytes, optionally separated by colons.  No validation
    373             is performed on these by the API or the DHCP server, they will be pass as specified to the
     376            is specified as a raw series of hex bytes optionally separated by colons.  No validation
     377            is performed on these by the API or the DHCP server, they will be passed as specified to the
    374378            client.
    375379          </para></listitem>
    … …  
    377381        <varlistentry>
    378382          <term><option>--force-opt=<replaceable>dhcp-opt-no</replaceable></option></term>
    379           <listitem><para>Forces the specified DHCP option number (0-255) onto to be
    380             sent to the client whether it requested it or not (provided the option is
     383          <listitem><para>Forces the specified DHCP option number (0-255) to be sent
     384            to the client whether it requested it or not (provided the option is
    381385            configured with a value at some level).
    382386          </para></listitem>
    … …  
    385389          <term><option>--suppress-opt=<replaceable>dhcp-opt-no</replaceable></option></term>
    386390          <listitem><para>Prevents the specified DHCP option number (0-255) from being
    387             sent to the client when present in this or a high configuration scope.
     391            sent to the client when present in this or a higher configuration scope.
    388392          </para></listitem>
    389393        </varlistentry>
    … …  
    391395          <term><option>--min-lease-time=<replaceable>seconds</replaceable></option></term>
    392396          <listitem><para>Sets the minimum lease time for the current scope in seconds.
    393             Zero means taking the value from a higher option level or use default.
     397            Zero means taking the value from a higher option level or use the default value.
    394398          </para></listitem>
    395399        </varlistentry>
    … …  
    397401          <term><option>--default-lease-time=<replaceable>seconds</replaceable></option></term>
    398402          <listitem><para>Sets the default lease time for the current scope in seconds.
    399             Zero means taking the value from a higher option level or use default.
     403            Zero means taking the value from a higher option level or use the default value.
    400404          </para></listitem>
    401405        </varlistentry>
    … …  
    474478      <remark role="help-copy-synopsis"/>
    475479      <para>
    476         This modifies an existing DHCP server configuration.  It takes the same
    477         options as the <command>add</command> command with the addition of the following
    478         on scope configuration:
     480        The <command>dhcpserver modify</command> command modifies an existing DHCP server
     481        configuration.  It takes the same options as the <command>add</command> command with
     482        the addition of the following options which have variable configuration scope:
    479483      </para>
    480484      <variablelist>
    … …  
    482486          <term><option>--del-opt=<replaceable>dhcp-opt-no</replaceable></option></term>
    483487          <listitem><para>Counterpart to <option>--set-opt</option> that will cause the specified
    484             DHCP option number (0-255) to be deleted from the server settings.  Like with
     488            DHCP option number (0-255) to be deleted from the server settings.  Similar to
    485489            <option>--set-opt</option> the scope of the deletion is governed by the
    486490            <option>--global</option>, <option>--vm</option>, <option>--mac-address</option>
    … …  
    491495          <term><option>--unforce-opt=<replaceable>dhcp-opt-no</replaceable></option></term>
    492496          <listitem><para>Removes the specified DHCP option number (0-255) from the forced
    493             option list (i.e. the reverse of <option>--force-opt</option>).  Like with
     497            option list (i.e. the reverse of <option>--force-opt</option>).  Similar to
    494498            <option>--set-opt</option> the scope of the deletion is governed by the
    495499            <option>--global</option>, <option>--vm</option>, <option>--mac-address</option>
    … …  
    499503        <varlistentry>
    500504          <term><option>--unsuppress-opt=<replaceable>dhcp-opt-no</replaceable></option></term>
    501           <listitem><para>Removes the specified DHCP option number (0-255) from the supressed
    502             option list (i.e. the reverse of <option>--suppress-opt</option>). Like with
     505          <listitem><para>Removes the specified DHCP option number (0-255) from the suppressed
     506            option list (i.e. the reverse of <option>--suppress-opt</option>). Similar to
    503507            <option>--set-opt</option> the scope of the deletion is governed by the
    504508            <option>--global</option>, <option>--vm</option>, <option>--mac-address</option>

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

    r99513 r106001  
    114114    <para>
    115115      The <command>VBoxManage export</command> command enables you to
    116       export one or more virtual machines (VMs) from &product-name;. You
    117       can export the VM to one of the following:
     116      export one or more virtual machines (VMs) from &product-name; into
     117      to one of the following formats:
    118118    </para>
    119119    <itemizedlist>
    120120      <listitem><para>
    121           <emphasis role="bold">Virtual appliance in OVF
    122           format.</emphasis> Includes the copying of its virtual disk
     121          <emphasis role="bold">A virtual appliance in OVF
     122          format.</emphasis> This includes copying the VM's virtual disk
    123123          images to compressed VMDK.
    124124        </para></listitem>
    125125      <listitem><para>
    126           <emphasis role="bold">Cloud service such as &oci;.</emphasis>
     126          <emphasis role="bold">A cloud service such as &oci;.</emphasis>
    127127          Exports a single VM.
    128128        </para></listitem>
    … …  
    130130    <para>
    131131      For more information about exporting VMs from &product-name;, see
    132       <xref linkend="ovf" />
     132      <xref linkend="ovf" />.
    133133    </para>
    134134    <refsect2 id="vboxmanage-export-ovf">
    … …  
    235235          <term><option>--eula=<replaceable>license-text</replaceable></option></term>
    236236          <listitem><para>
    237               Specifies end-user license text.
     237              Specifies an end-user license text.
    238238            </para></listitem>
    239239        </varlistentry>
    … …  
    277277          <term><option>--vmname=<replaceable>vmname</replaceable></option></term>
    278278          <listitem><para>
    279               Specifies the name of the exported VM.
     279              Specifies the name of the VM to export.
    280280            </para></listitem>
    281281        </varlistentry>

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

    r104688 r106001  
    7171      <para>
    7272        Installs a new extension pack on the system.  This command will fail if an older
    73         version of the same extension pack is already installed.  The
    74         <option>--replace</option> option can be used to uninstall any
    75         old package before the new one is installed.
     73        version of the same extension pack type is already installed and the
     74        <option>--replace</option> isn't supplied.  The <option>--replace</option> option
     75        uninstalls any previously installed extension packs of the same type being installed
     76        before the new extension pack is installed.
    7677      </para>
    7778      <variablelist>
    7879        <varlistentry>
    79           <term><option>--replace</option></term><listitem><para>Uninstall existing extension pack version.</para></listitem>
     80          <term><option>--replace</option></term><listitem><para>Uninstall existing extension
     81          pack before installing the specified extension pack.</para></listitem>
    8082        </varlistentry>
    8183        <varlistentry>
    … …  
    8486            <para>Accept the license text with the given SHA-256 hash value.</para>
    8587            <para>VBoxManage will display the SHA-256 value when performing a manual
    86             installation.  The hash can of course be calculated by looking inside
    87             the extension pack and using sha256sum or similar on the license file.</para>
     88            installation.  The hash can be calculated manually by extracting the license
     89            file from the extension pack using tar(1) and running sha256sum or similar to
     90            generate the hash value.</para>
    8891          </listitem>
    8992        </varlistentry>
    … …  
    103106        Uninstalls an extension pack from the system.  The subcommand will also succeed
    104107        in the case where the specified extension pack is not present on the system.
    105         You can use <computeroutput>VBoxManage list extpacks</computeroutput> to show
     108        You can use <computeroutput>VBoxManage list extpacks</computeroutput> to list
    106109        the names of the extension packs which are currently installed.
    107110      </para>

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

    r102749 r106001  
    371371      <arg>--source=<replaceable>guest-additions.ISO</replaceable></arg>
    372372      <arg>--wait-start</arg>
    373       <arg>-- <arg rep="repeat"><replaceable>argument</replaceable></arg></arg>
     373      <arg>--<arg rep="repeat"><replaceable>argument</replaceable></arg></arg>
    374374    </cmdsynopsis>
    375375
    … …  
    442442        specify an empty password. On OSes such as Windows, you might
    443443        need to adjust the security policy to permit user accounts with
    444         an empty password. In additional, global domain rules might
     444        an empty password. In addition, global domain rules might
    445445        apply and therefore cannot be changed.
    446446      </para>
    … …  
    461461              Specifies the password for the specified user. If you do
    462462              not specify a password on the command line or if the
    463               password file is empty, the specified user needs to have
     463              password is empty, the specified user needs to have
    464464              an empty password.
    465465            </para></listitem>
    … …  
    468468          <term><option>--passwordfile=<replaceable>filename</replaceable></option></term>
    469469          <listitem><para>
    470               Specifies the absolute path to a file on the guest OS that
     470              Specifies the absolute path to a file on the host system that
    471471              contains the password for the specified user. If the
    472472              password file is empty or if you do not specify a password
    … …  
    478478          <term><option>--username=<replaceable>username</replaceable></option></term>
    479479          <listitem><para>
    480               Specifies an existing user on the guest OS that runs the
    481               process. If unspecified, the host user runs the process.
     480              Specifies an existing user in the guest OS that runs the
     481              process. If unspecified, the name of the user on the host
     482              invoking the <command>VBoxManage</command> command will be
     483              used as the username for the guest OS login.
    482484            </para></listitem>
    483485        </varlistentry>
    … …  
    487489      <title>Guest Process Restrictions</title>
    488490      <para>
    489         By default, you can run up to five guest processes
    490         simultaneously. If a new guest process starts and would exceed
    491         this limit, the oldest not-running guest process is discarded to
    492         run the new process. You cannot retrieve output from a discarded
    493         guest process. If all five guest processes are active and
    494         running, attempting to start a new guest process fails.
    495       </para>
    496       <para>
    497         You can modify the guest process execution limit in two ways:
    498       </para>
    499       <itemizedlist>
    500         <listitem><para>
    501             Use the <command>VBoxManage setproperty</command> command to
    502             update the
    503             <literal>/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept</literal>
    504             guest property value.
    505           </para></listitem>
    506         <listitem><para>
    507             Use the <command>VBoxService</command> command and specify
    508             the
    509             <option>--control-procs-max-kept=<replaceable>value</replaceable></option>
    510             option.
    511           </para></listitem>
    512       </itemizedlist>
    513       <para>
    514         After you change the limit, you must restart the guest OS.
    515       </para>
    516       <para>
    517         You can serve an unlimited number guest processes by specifing a
    518         value of <literal>0</literal>, however this action is not
    519         recommended.
     491        By default, you can run up to 255 guest processes simultaneously.
     492        If attempting to start a new guest process would exceed
     493        this limit and there are inactive guest processes then the the
     494        oldest inactive guest process is discarded to run the new process.
     495        You cannot retrieve the output from a discarded guest process. If
     496        all 255 guest processes are active and running, attempting to start
     497        a new guest process fails.
    520498      </para>
    521499    </refsect2>
    522500    <refsect2 id="vboxmanage-guestcontrol-run">
    523       <title>Run a Command on the guest</title>
     501      <title>Run a Command in the guest</title>
    524502      <remark role="help-copy-synopsis"/>
    525503      <para>
    526504        The <command>VBoxManage guestcontrol
    527505        <replaceable>vmname</replaceable> run</command> command enables
    528         you to execute a program on the guest VM. Standard input,
     506        you to execute a program in the guest VM. Standard input,
    529507        standard output, and standard error are redirected from the VM
    530508        to the host system until the program completes.
    … …  
    532510      <note>
    533511        <para>
    534           The Windows OS imposes certain limitations for graphical
    535           applications. See <xref linkend="KnownIssues" />.
     512          Microsoft Windows imposes certain limitations when running
     513          graphical user interface applications launched using
     514          <command>VBoxManage guestcontrol run</command>. See
     515          <xref linkend="KnownIssues" />.
    536516        </para>
    537517      </note>
    … …  
    541521          <listitem><para>
    542522              Specifies the absolute path of the executable program to
    543               run on the guest VM. For example:
     523              run in the guest VM. For example:
    544524              <filename>C:\Windows\System32\calc.exe</filename>.
     525            </para></listitem>
     526        </varlistentry>
     527        <varlistentry>
     528          <term><option>--arg0=<replaceable>alternate-executable-name</replaceable></option></term>
     529          <listitem><para>
     530              Specifies an alternate name (i.e. arg0 or argv[0]) for the
     531              executable being run in the guest.
    545532            </para></listitem>
    546533        </varlistentry>
    … …  
    584571            </para><para>
    585572              Use the
    586               <option>--putenv=<replaceable>NAME</replaceable>=[<replaceable>value</replaceable>]</option>
     573              <option>--putenv=<replaceable>NAME</replaceable>=</option>
    587574              option to unset the environment variable specified by
    588575              <replaceable>NAME</replaceable>.
    … …  
    669656        </varlistentry>
    670657        <varlistentry>
    671           <term><option>--[<replaceable>argument</replaceable>...]</option></term>
    672           <listitem><para>
    673               Specifies the name of the program and any arguments to
    674               pass to the program.
     658          <term><option>-- [<replaceable>argument</replaceable>...]</option></term>
     659          <listitem><para>
     660              Specifies one or more arguments to pass to the program
     661              being run in the guest.
    675662            </para><para>
    676663              Ensure that any command argument that includes spaces is
    … …  
    686673        The <command>VBoxManage guestcontrol
    687674        <replaceable>vmname</replaceable> start</command> command
    688         enables you to execute a guest program until it completes.
     675        enables you to execute a guest program and returns after
     676        the command has been successfully started.  The invoked
     677        command doesn't wait until all data from stdout or stderr
     678        has been read before returning.
    689679      </para>
    690680      <note>
    691681        <para>
    692           The Windows OS imposes certain limitations for graphical
    693           applications. See <xref linkend="KnownIssues" />.
     682          Microsoft Windows imposes certain limitations when running
     683          graphical user interface applications launched using
     684          <command>VBoxManage guestcontrol start</command>. See
     685          <xref linkend="KnownIssues" />.
    694686        </para>
    695687      </note>
    … …  
    970962          <term><literal><replaceable>guest-file</replaceable> [<replaceable>guest-file</replaceable>...]</literal></term>
    971963          <listitem><para>
    972               Specifies an absolute path of one or more file to remove
     964              Specifies an absolute path of one or more files to remove
    973965              from the guest VM. You can use wildcards to specify the
    974966              file names. For example,
    … …  
    14311423    </para>
    14321424  <para>
    1433     The default behavior of argument 0 is to either use
    1434     the value from <option>--exe</option>, or, if not set, the first
    1435     value passed after <option>--</option>.
     1425    The default value of argument 0 (i.e. arg0 or argv[0]) is the value
     1426    from the <option>--exe</option> option unless the <option>--arg0</option>
     1427    option has been supplied.
    14361428  </para>
    14371429  </refsect1>

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

    r99497 r106001  
    110110      are arbitrary name-value string pairs that can be written to and
    111111      read from by either the guest or the host. As a result, these
    112       properties can be used as a low-volume communication channel for
     112      properties can be used as a low-overhead communication channel for
    113113      strings provided that a guest is running and has the Guest
    114114      Additions installed. In addition, the Guest Additions
    … …  
    131131      <title>List All Properties for a Virtual Machine</title>
    132132      <remark role="help-copy-synopsis"/>
    133       <para>
    134133        <!-- @todo the help output doesn't correctly insert a space after the /command tag if it comes last on a line...  -->
     134      <para>
    135135        The <command>VBoxManage guestproperty enumerate</command> command
    136136        lists each guest property and value for the specified
    137         VM. Note that the output is limited if the guest's service is
    138         not updating the properties, for example because the VM is not
    139         running or because the Guest Additions are not installed.
     137        VM. Note that the output is limited if the guest's property
     138        store is not being updated, for example because the VM is not
     139        running or because the &product-name; Guest Additions are not installed.
    140140      </para>
    141141      <variablelist>

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

    r99513 r106001  
    108108            </para><para>
    109109              You cannot use this option with the <option>--ip</option>,
    110               <option>--ipv6</option>, <option>--netmask</option>, and
     110              <option>--ipv6</option>, <option>--netmask</option>, or
    111111              <option>--netmasklengthv6</option> options.
    112112            </para></listitem>
    … …  
    118118            </para><para>
    119119              You cannot use this option with the
    120               <option>--dhcp</option>, <option>--ipv6</option>, and
     120              <option>--dhcp</option>, <option>--ipv6</option>, or
    121121              <option>--netmasklengthv6</option> options.
    122122            </para></listitem>
    … …  
    128128              default value is <literal>255.255.255.0</literal>.
    129129            </para><para>
    130               You can use this option only with the
     130              You can only use this option with the
    131131              <option>--ip</option> option.
    132132            </para></listitem>
    … …  
    138138            </para><para>
    139139              You cannot use this option with the
    140               <option>--dhcp</option>, <option>--ip</option>, and
     140              <option>--dhcp</option>, <option>--ip</option>, or
    141141              <option>--netmask</option> options.
    142142            </para></listitem>
    … …  
    148148              default value is <literal>64</literal>.
    149149            </para><para>
    150               You can use this option only with the
     150              You can only use this option with the
    151151              <option>--ipv6</option> option.
    152152            </para></listitem>
    … …  
    166166        the host-only network.
    167167      </para>
     168      <para>
     169        This command is currently unavailable on Solaris hosts but the
     170        equivalent functionality is to run
     171        <command>ifconfig vboxnet0 plumb</command> as root or with sufficient
     172        privileges.
     173      </para>
    168174    </refsect2>
    169175    <refsect2 id="vboxmanage-hostonlyif-remove">
    … …  
    174180        removes the specified host-only network interface from the host
    175181        OS.
     182      </para>
     183      <para>
     184        This command is currently unavailable on Solaris hosts but the
     185        equivalent functionality is to run
     186        <command>ifconfig vboxnet0 unplumb</command> as root or with sufficient
     187        privileges.
    176188      </para>
    177189      <variablelist>

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

    r99497 r106001  
    6363      <arg>--ostype=<replaceable>ostype</replaceable></arg>
    6464      <arg>--vmname=<replaceable>name</replaceable></arg>
    65       <arg>--settingsfile=<replaceable>file</replaceable></arg>
     65      <arg>--settingsfile=<replaceable>filename</replaceable></arg>
    6666      <arg>--basefolder=<replaceable>folder</replaceable></arg>
    6767      <arg>--group=<replaceable>group</replaceable></arg>
    … …  
    106106    <para>
    107107      The <command>VBoxManage import</command> command imports a virtual
    108       appliance either in OVF format or from a cloud service such as &oci;.
     108      appliance either in OVF format or from a cloud service such as &oci; (OCI).
    109109      The import is performed by copying virtual disk images (by default using
    110110      the VMDK image format) and by creating virtual machines (VMs) in
    … …  
    148148          <listitem><para>
    149149              Performs a dry run of the <command>VBoxManage
    150               import</command> command before you perform the actual
     150              import</command> command instead of performing the actual
    151151              import operation. A dry run operation does the following:
    152152            </para><itemizedlist>
    … …  
    169169          <!-- Does this option really work for cloud import? -->
    170170          <listitem><para>
    171               Enables you to fine tune the import operation.
     171              Enables you to fine-tune the import operation.
    172172            </para><para>
    173173              Valid arguments are as follows:
    … …  
    185185              <listitem><para>
    186186                  <literal>importtovdi</literal>: Specifies that all new
    187                   disk images are in VDI file format.
     187                  disk images are to be created using the VDI file format.
    188188                </para></listitem>
    189189            </itemizedlist></listitem>
    … …  
    200200          <term><option>--vmname=<replaceable>name</replaceable></option></term>
    201201          <listitem><para>
    202               Specifies the name of the VM to be used by &product-name;.
     202              Specifies the name for the imported VM to be used by &product-name;.
    203203            </para></listitem>
    204204        </varlistentry>
    … …  
    236236      <title>OVF / OVA Import Options</title>
    237237      <para>
    238         The following options are specific for importing a virtual appliance
     238        The following options are specific to importing a virtual appliance
    239239        in OVF or OVA format. Such an appliance can contain one or more VMs,
    240240        which requires specifying which VM configuration should be adjusted
    … …  
    258258        </varlistentry>
    259259        <varlistentry>
    260           <term><option>--settingsfile=<replaceable>file</replaceable></option></term>
    261           <listitem><para>
    262               Specifies the name (with or without path) of the VM config
    263               file which will be created as part of the import. Usually
    264               the preferred way is overriding the VM name with
    265               <option>--vmname</option> and if necessary specify the
    266               folder in which to create the VM with
     260          <term><option>--settingsfile=<replaceable>filename</replaceable></option></term>
     261          <listitem><para>
     262              Specifies the filename (as a relative or absolute path) of
     263              the VM config file which will be created as part of the
     264              import. The preferred way to rename the settings file is to
     265              override the VM name using the <option>--vmname</option> option
     266              and if necessary specify the folder in which to create the VM with
    267267              <option>--basefolder</option>.
    268268            </para></listitem>
    … …  
    295295          <term><option>--ignore</option></term>
    296296          <listitem><para>
    297               Ignores the current unit of an imported VM, effectively
    298               removing the associated hardware.
     297              Ignores the hardware associated with the VM specified with
     298              the <option>--unit</option> option when importing the VM,
     299              effectively removing all of its associated hardware.
    299300            </para></listitem>
    300301        </varlistentry>
    … …  
    323324      <title>Cloud Import Options</title>
    324325      <para>
    325         The following options are specific for importing a VM instance
     326        The following options are specific to importing a VM instance
    326327        from a cloud service provider. It always deals with a single VM.
    327328        See <xref linkend="cloud-import-oci" />.

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

    r99513 r106001  
    9393      <title>Common options</title>
    9494      <remark role="help-scope" condition="GLOBAL"/>
    95       <para>The subcommands of <command>mediumio</command> all operate on a medium which need to be specified, optionally
    96         with an encryption password.  The following common options can be placed before or after the sub-command:</para>
     95      <para>The subcommands of <command>mediumio</command> all operate on a medium which must be specified using
     96        one of the following options along with an optional encryption password.  The following common options
     97        can be placed before or after the sub-command:</para>
    9798      <variablelist>
    9899        <varlistentry>
    … …  
    120121      <remark role="help-copy-synopsis"/>
    121122      <para>
    122         Formats a floppy medium with the FAT file system. This will erase the
    123         content of the medium.
     123        Formats a medium with the FAT file system. This will erase the
     124        contents of the medium.
    124125      </para>
    125126      <variablelist>
    … …  
    134135      <remark role="help-copy-synopsis"/>
    135136      <para>
    136         Dumps the medium content to stdout or the specified file.
     137        Dumps the contents of the medium to stdout or the specified file.
    137138      </para>
    138139      <variablelist>

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

    r99498 r106001  
    118118      machines (VMs). For example, you can monitor particular metrics,
    119119      such as the percentage of time CPUs spend executing in user mode
    120       (<literal>CPU/Load/User</literal>) over a specified sampling
     120      (<literal>CPU/Load/User</literal>), over a specified sampling
    121121      period.
    122122    </para>
    123123    <para>
    124       While it runs, the <command>VBoxSVC</command> process collects and
    125       saves the specified metric data internally. The
    126       <command>VBoxSVC</command> process runs until shortly after you
    127       close all VMs and frontends. Use the <command>VBoxManage metrics
    128       query</command> command to retrieve data at any time.
     124      Use the <command>VBoxManage metrics query</command> command to
     125      retrieve data at any time.
    129126    </para>
    130127    <para>
    … …  
    134131    </para>
    135132    <para>
    136       Note that you can enable metric collection only for started VMs.
     133      Note that you can enable metric collection only for running VMs.
    137134      Collected data and collection settings for a VM are discarded when
    138135      the VM shuts down.
    … …  
    141138      <title>Metrics</title>
    142139      <para>
    143         The host and VMs have different sets of associated metrics,
     140        The host and VMs have different sets of associated metrics
    144141        which you can view by running the <command>VBoxManage metrics
    145142        list</command> command.

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

    r99513 r106001  
    9797            specify the UUID only if the medium is registered. Use the
    9898            <command>VBoxManage list hdds</command> command to list the
    99             registered images. You can specfy an absolute or relative
     99            registered images. You can specify an absolute or relative
    100100            path to the medium.
    101101          </para></listitem>
    … …  
    174174        <term><option>--resize=<replaceable>size</replaceable></option></term>
    175175        <listitem><para>
    176             Specifes the new capacity of an existing image in MB. You
     176            Specifies the new capacity of an existing image in MB. You
    177177            can use this option only to expand the capacity of an image.
    178178            You can cannot shrink the capacity of an image.
    179179          </para><para>
    180             Note that you can resize only dynamically allocated disk
     180            Note that you can only resize dynamically allocated disk
    181181            images that use the VDI and VHD formats. This option adjusts
    182182            the <emphasis>logical</emphasis> size of a virtual disk and
    … …  
    198198        <term><option>--resizebyte=<replaceable>size</replaceable></option></term>
    199199        <listitem><para>
    200             Specifes the new capacity of an existing image in bytes.
     200            Specifies the new capacity of an existing image in bytes.
    201201            This option is similar to the <option>--resize</option>
    202202            option, but you specify the size in bytes instead of

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

    r103532 r106001  
    147147
    148148    <para>The "modifynvram" commands are for experts who want to inspect and modify the
    149       UEFI variable store of a virtual machine. Any mistakes done here can bring the virtual
    150       machine in a non working state.</para>
     149      UEFI variable store of a virtual machine. Any mistakes made here can result in
     150      a non-bootable virtual machine.</para>
    151151
    152152    <refsect2 id="vboxmanage-modifynvram-common-options">
    … …  
    167167      <remark role="help-copy-synopsis"/>
    168168      <para>
    169         Iniitalizes the UEFI variable store to a default state. Any previous existing variable
     169        Initalizes the UEFI variable store to a default state. Any previous existing variable
    170170        store is deleted. Use with extreme caution!
    171171      </para>
    … …  
    219219      <variablelist>
    220220        <varlistentry>
    221           <term><option>--enable></option></term>
     221          <term><option>--enable</option></term>
    222222          <listitem><para>Enables UEFI secure boot if the state of the key
    223223            enrolment permits.</para>
    … …  
    225225        </varlistentry>
    226226        <varlistentry>
    227           <term><option>--disable></option></term>
     227          <term><option>--disable</option></term>
    228228          <listitem><para>Disables UEFI secure boot.</para>
    229229          </listitem>
    … …  
    236236      <remark role="help-copy-synopsis"/>
    237237      <para>
    238         Lists all UEFI variables in the virtual machines's store along with their owner UUID.
     238        Lists all UEFI variables in the virtual machine's store along with their owner UUID.
    239239      </para>
    240240    </refsect2>

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

    r105893 r106001  
    22072207              RDP port.
    22082208            </para><para>
    2209               Also see the <option>--vrde-port</option> option
     2209              See also the <option>--vrde-port</option> option
    22102210              description.
    22112211            </para></listitem>
    … …  
    22192219              host network interface at that IP address.
    22202220            </para><para>
    2221               Also see the <option>--vrde-address</option> option
     2221              See also the <option>--vrde-address</option> option
    22222222              description.
    22232223            </para></listitem>
    … …  
    22742274              Disables the display VRDE server feature.
    22752275            </para><para>
    2276               To reenable a feature, assign an empty value. For example,
    2277               to reenable the display feature, specify the
     2276              To re-enable a feature, assign an empty value. For example,
     2277              to re-enable the display feature, specify the
    22782278              <command>VBoxManage modifyvm
    22792279              --vrde-property=Client/DisableDisplay=</command> command.
    … …  
    23022302          <term><option>--vrde-property=Client/DisableClipboard=1</option></term>
    23032303          <listitem><para>
    2304               Disables the clipboard VRDE server feature. To reenable
     2304              Disables the clipboard VRDE server feature. To re-enable
    23052305              the feature, assign an empty value. See
    23062306              <xref linkend="vrde-customization" />.
    … …  
    23112311          <listitem><para>
    23122312              Disables the upstream audio VRDE server feature. To
    2313               reenable the feature, assign an empty value. See
     2313              re-enable the feature, assign an empty value. See
    23142314              <xref linkend="vrde-customization" />.
    23152315            </para></listitem>
    … …  
    23192319          <listitem><para>
    23202320              Disables the RDP device redirection for smart cards VRDE
    2321               server feature. To reenable this feature, assign an empty
     2321              server feature. To re-enable this feature, assign an empty
    23222322              value.
    23232323            </para></listitem>
    … …  
    26062606              default level of <literal>0</literal> indicates that all
    26072607              virtualized features supported by the host are made available
    2608               to the guest. The value <literal>3</literal> supresses most
     2608              to the guest. The value <literal>3</literal> suppresses most
    26092609              features. Values of <literal>1</literal> and <literal>2</literal>
    26102610              represent restrictions in between. The behavior may change
    … …  
    28042804          <listitem><para>
    28052805                This sets one of the 10 dword configuration values. The
    2806                 <replaceable>idx</replaceable> must be in the range 0 thru 9.
     2806                <replaceable>idx</replaceable> must be in the range 0 through 9.
    28072807                The <replaceable>value</replaceable> is limited to 32 bits (dword).
    28082808            </para></listitem>

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

    r99513 r106001  
    105105    <para>
    106106      The <command>VBoxManage natnetwork</command> command enables you
    107       to create, modify and manage a NAT network.
     107      to create, modify, and manage a NAT network.
    108108    </para>
    109109    <para>
    … …  
    127127      <para>
    128128        The <command>VBoxManage natnetwork add</command> command creates
    129         a new internal network interface, and adds a NAT network
     129        a new internal network interface and adds a NAT network
    130130        service. You must use this command before you can attach the VM
    131131        to the NAT network.
    … …  
    162162          <term><option>--dhcp</option></term>
    163163          <listitem><para>
    164               Enables or disables the DHCP server that you specify by
    165               using the <option>--netname</option> option.
     164              Enables or disables the DHCP server specified with
     165              the <option>--netname</option> option.
    166166            </para></listitem>
    167167        </varlistentry>
    … …  
    176176          <term><option>--loopback-4=<replaceable>rule</replaceable></option></term>
    177177          <listitem><para>
    178               Enables an IPv4 loopback interface by using the specified
    179               rule.
     178              Enables an IPv4 loopback interface using the specified rule.
    180179            </para></listitem>
    181180        </varlistentry>
    … …  
    183182          <term><option>--loopback-6=<replaceable>rule</replaceable></option></term>
    184183          <listitem><para>
    185               Enables an IPv6 loopback interface by using the specified
    186               rule.
     184              Enables an IPv6 loopback interface using the specified rule.
    187185            </para></listitem>
    188186        </varlistentry>
    … …  
    190188          <term><option>--port-forward-4=<replaceable>rule</replaceable></option></term>
    191189          <listitem><para>
    192               Enables IPv4 port forwarding by using the rule specified
    193               by <replaceable>rule</replaceable>.
     190              Enables IPv4 port forwarding using the specified rule.
    194191            </para></listitem>
    195192        </varlistentry>
    … …  
    197194          <term><option>--port-forward-6=<replaceable>rule</replaceable></option></term>
    198195          <listitem><para>
    199               Enables IPv6 port forwarding by using the rule specified
    200               by <replaceable>rule</replaceable>.
     196              Enables IPv6 port forwarding using the specified rule.
    201197            </para></listitem>
    202198        </varlistentry>
    … …  
    306302          <term><option>--dhcp</option></term>
    307303          <listitem><para>
    308               Enables or disables the DHCP server that you specify by
    309               using the <option>--netname</option> option.
     304              Enables or disables the DHCP server specified
     305              with the <option>--netname</option> option.
    310306            </para></listitem>
    311307        </varlistentry>
    … …  
    320316          <term><option>--loopback-4=<replaceable>rule</replaceable></option></term>
    321317          <listitem><para>
    322               Enables an IPv4 loopback interface by using the specified
    323               rule.
     318              Enables an IPv4 loopback interface using the specified rule.
    324319            </para></listitem>
    325320        </varlistentry>
    … …  
    327322          <term><option>--loopback-6=<replaceable>rule</replaceable></option></term>
    328323          <listitem><para>
    329               Enables an IPv6 loopback interface by using the specified
    330               rule.
     324              Enables an IPv6 loopback interface using the specified rule.
    331325            </para></listitem>
    332326        </varlistentry>
    … …  
    334328          <term><option>--port-forward-4=<replaceable>rule</replaceable></option></term>
    335329          <listitem><para>
    336               Enables IPv4 port forwarding by using the rule specified
    337               by <replaceable>rule</replaceable>.
     330              Enables IPv4 port forwarding using the specified rule.
    338331            </para></listitem>
    339332        </varlistentry>
    … …  
    341334          <term><option>--port-forward-6=<replaceable>rule</replaceable></option></term>
    342335          <listitem><para>
    343               Enables IPv6 port forwarding by using the rule specified
    344               by <replaceable>rule</replaceable>.
     336              Enables IPv6 port forwarding using the specified rule.
    345337            </para></listitem>
    346338        </varlistentry>

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

    r99513 r106001  
    102102                <literal>off</literal> shares these extensions with
    103103                other hypervisors that run simultaneously. Note that
    104                 disabling this setting has negative performance
     104                sharing these extensions has negative performance
    105105                implications.
    106106              </para></listitem>
    … …  
    112112            Specifies the user language used to translate API messages.
    113113            Valid values are <literal>C</literal>, which means no
    114             translation or language code in form either <literal>ll</literal>
    115             or <literal>ll_CC</literal>, where <literal>ll</literal> is
    116             language 2 letters code in lower case and
    117             <literal>CC</literal> is country 2 letter code in upper case.
     114            translation or a language code in the form of either
     115            <literal>ll</literal> or <literal>ll_CC</literal>, where
     116            <literal>ll</literal> is an ISO 639 two-letter language code and
     117            <literal>CC</literal> an ISO 3166 two-letter country code.  For
     118            example, for Greek in Greece, <literal>ll</literal> is <literal>el</literal>,
     119            and <literal>CC</literal> is <literal>GR</literal>.
    118120          </para></listitem>
    119121      </varlistentry>

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

    r105333 r106001  
    107107    <para>
    108108      Shared folders enable you to share data between the host system
    109       and guests. To use shared folders you must first install the
     109      and guest VMs. To use shared folders you must first install the
    110110      &product-name; Guest Additions software in the guest VM.
    111111    </para>
    … …  
    121121        The <command>VBoxManage sharedfolder add</command> command
    122122        creates a shared folder. The folder you specify is on the host
    123         computer. When configured the contents of the folder on the
    124         host system can be shared with the guest OS.
     123        computer. Once created the contents of the folder on the
     124        host system can be accessed from within the guest OS.
    125125      </para>
    126126      <variablelist>
    … …  
    185185               If left blank (or if the drive letter is already in use), the
    186186               last unused drive letter is used instead (i.e. searching from
    187                <literal>Z:</literal> thru <literal>A:</literal>).
     187               <literal>Z:</literal> through <literal>A:</literal>).
    188188             </para><para>
    189189               For Linux, Solaris and other Unix guests, it must be an absolute

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

    r99513 r106001  
    8383    </itemizedlist>
    8484    <para>
    85       The medium must be specified either by its UUID, if the medium is
     85      The medium must be specified by either its UUID, if the medium is
    8686      registered, or by its filename. Registered images can be listed
    8787      using <command>VBoxManage list hdds</command>, <command>VBoxManage

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

    r99513 r106001  
    8585        <term><option>--certificate=<replaceable>file</replaceable></option></term>
    8686        <listitem><para>File containing the certificate that the OVA should be
    87           signed with.  This can either be in PEM format (base64) or DER (binary),
    88           the command will detect which.</para></listitem>
     87          signed with.  This can be in either PEM format (base64) or DER (binary).
     88          </para></listitem>
    8989      </varlistentry>
    9090      <varlistentry>
    9191        <term><option>--private-key=<replaceable>file</replaceable></option></term>
    92         <listitem><para>The file containing the private key.  This can either be
    93           in PEM (base64) or DER (binary) format, the command will detect
    94           which.</para></listitem>
     92        <listitem><para>The file containing the private key.  This can be in either
     93          PEM (base64) or DER (binary) format.
     94        </para></listitem>
    9595      </varlistentry>
    9696      <varlistentry>
    … …  
    100100      <varlistentry>
    101101        <term><option>--private-key-password=<replaceable>password</replaceable></option></term>
    102         <listitem><para>The private key password. <!-- add warning about visibility --> </para></listitem>
     102        <!-- add warning about visibility -->
     103        <listitem><para>The private key password.</para></listitem>
    103104      </varlistentry>
    104105      <varlistentry>
    105106        <term><option>--digest-type=<replaceable>type</replaceable></option></term>
    106         <listitem>
    107           <para>Select the cryptographic digest algorithm to use in the
    108             signing. Possible values: SHA-256 (default), SHA-512 and SHA-1.</para>
    109           <para>Some older versions of OVFTool and other VMware produces may
    110             require <option>--digest-type=sha-1</option> to accept the OVA.</para>
     107        <listitem><para>Select the cryptographic digest algorithm to use for signing the
     108            OVA file. The possible values are : SHA-256 (default), SHA-512 and SHA-1.</para>
     109          <para>Some older versions of VMware's OVF Tool command line utility and other
     110            VMware products may require the <option>--digest-type=sha-1</option> option.</para>
    111111          </listitem>
    112112      </varlistentry>
    … …  
    119119        <term><option>--intermediate-cert=<replaceable>file</replaceable></option></term>
    120120        <listitem><para>File containing an intermediary certificate that should be
    121           included in the optional PKCS#7/CMS signature.  Like the others, the file can
    122           either be in PEM or DER format.  This option can be repeated to add
    123           multiple intermediate certificates.  This option implies the
    124           <option>--pkcs7</option> option.</para></listitem>
     121          included in the optional PKCS#7/CMS signature.  The file can be in either PEM
     122          format (base64) or DER (binary).  This option can be repeated to add multiple
     123          intermediate certificates.  This option implies the <option>--pkcs7</option> option.
     124        </para></listitem>
    125125      </varlistentry>
    126126      <varlistentry>
    … …  
    135135      <varlistentry>
    136136        <term><option>-v</option>, <option>--verbose</option>, <option>-q</option>, <option>--quiet</option></term>
    137         <listitem><para>Controls the verbositity of the command execution.  The
    138           <option>--verbose</option> option can be used multiple times to get more output.
     137        <listitem><para>Controls the verbosity of the command execution.  The
     138          <option>--verbose</option> option can be specified multiple times to get more output.
    139139          </para></listitem>
    140140      </varlistentry>

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

    r99497 r106001  
    162162    </para>
    163163    <para>
    164       &product-name; uses the snapshot to capture the state of a virtual
     164      &product-name; uses snapshots to capture the state of a virtual
    165165      machine (VM). You can later use the snapshot to revert to the
    166166      state described by the snapshot.
    167167    </para>
    168168    <para>
    169       A snapshot is a complete copy of a VM's settings. If you take the
     169      A snapshot is a complete copy of a VM's settings. If you take a
    170170      snapshot while the VM is running, the snapshot also includes the
    171       VM's state file.
     171      VM's current running state.
    172172    </para>
    173173    <para>
    … …  
    176176      disk that is associated with the host machine. When you restore a
    177177      snapshot, &product-name; uses these differencing files to quickly
    178       reset the contents of the VM's virtual hard disks.
     178      restore the contents of the VM's virtual hard disks.
    179179    </para>
    180180    <para>
    … …  
    202202        for the snapshot and can optionally supply a description. The
    203203        new snapshot is inserted into the snapshots tree as a child of
    204         the current snapshot and then becomes the new current snapshot.
     204        the current snapshot (if the VM has any snapshots) and then
     205        becomes the new current snapshot.
    205206      </para>
    206207      <variablelist>
    … …  
    265266        the VM on which you restore a snapshot is lost. When restored,
    266267        the specified snapshot becomes the new current snapshot and
    267         subsequent snapshots are children of that snapshot.
     268        subsequent snapshots become children of that snapshot.
    268269      </para>
    269270      <variablelist>

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

    r99513 r106001  
    126126    <title>Description</title>
    127127    <para>
    128       The <command>VBoxManage storageattach</command> command enables
    129       you to manage a storage medium that you connected to a storage
    130       controller by using the <command>VBoxManage storagectl</command>
    131       command.
     128      The <command>VBoxManage storageattach</command> command
     129      attaches, modifies, or removes a storage medium connected to a
     130      storage controller that was previously added with the
     131      <command>VBoxManage storagectl</command> command.
    132132    </para>
    133133    <variablelist>
    … …  
    189189                  For a virtual DVD or floppy drive only.
    190190                </para><para>
    191                   Makes the device slot behave like a removeable drive
     191                  Makes the device slot behave like a removable drive
    192192                  into which no media has been inserted.
    193193                </para></listitem>
    … …  
    241241            </varlistentry>
    242242          </variablelist><para>
    243             For removeable media such as floppies and DVDs, you can make
     243            For removable media such as floppies and DVDs, you can make
    244244            configuration changes while a VM is running. Changes to
    245245            devices or hard disk device slots require that the VM be

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

    r102540 r106001  
    164164        <varlistentry>
    165165          <term><option>--install-additions</option>, <option>--no-install-additions</option></term>
    166           <listitem><para>Whether to install the VirtualBox guest additions.  (default: --no-install-addations)</para></listitem>
     166          <listitem><para>Whether to install the VirtualBox guest additions.  (default: --no-install-additions)</para></listitem>
    167167        </varlistentry>
    168168        <varlistentry>
    … …  
    174174          <term><option>--install-txs</option>, <option>--no-install-txs</option></term>
    175175          <listitem>
    176             <para>Whether to install the test execution service (TXS) from the VirtualBox ValidationKit.
     176            <para>Whether to install the Test eXecution Service (TXS) from the VirtualBox ValidationKit.
    177177              This is useful when preparing VMs for testing or similar.  (default: --no-install-txs)</para></listitem>
    178178        </varlistentry>
    … …  
    205205          <term><option>--package-selection-adjustment=<replaceable>keyword</replaceable></option></term>
    206206          <listitem>
    207             <para>Adjustments to the guest OS packages/components selection.  This can be specfied more than once.  Currently
     207            <para>Adjustments to the guest OS packages/components selection.  This can be specified more than once.  Currently
    208208              the only recognized keyword is <computeroutput>minimal</computeroutput> which triggers a minimal installation for
    209209              some of the guest OSes.</para></listitem>
    … …  
    253253          <listitem>
    254254            <para>
    255               List of extra linux kernel parameters to use during the installation. (default: IMachine::OSTypeId dependent)
     255              List of extra Linux kernel parameters to use during the installation. (default: IMachine::OSTypeId dependent)
    256256            </para></listitem>
    257257        </varlistentry>
    … …  
    261261            <para>
    262262              Specifies the UI language for a Windows installation.  The <replaceable>lang</replaceable> is
    263               generally on the form {ll}-{CC}.  See detectedOSLanguages results from <command>VBoxManage unattended detect</command>.
     263              generally of the form {ll}-{CC}.  See the detectedOSLanguages results from <command>VBoxManage unattended detect</command>.
    264264              (default: detectedOSLanguages[0])</para></listitem>
    265265        </varlistentry>

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

    r99513 r106001  
    4242  <refnamediv>
    4343    <refname>VBoxManage-updatecheck</refname>
    44     <refpurpose>Checks for a newer version of VirtualBox</refpurpose>
     44    <refpurpose>Checks for a newer version of &product-name;</refpurpose>
    4545    <refclass>&product-name;</refclass>
    4646  </refnamediv>
    … …  
    7070
    7171    <para>The <command>updatecheck</command> subcommand is used to check if a newer
    72     version of VirtualBox is available.  The two subcommand options of <command>updatecheck</command>
     72    version of &product-name; is available.  The two subcommand options of <command>updatecheck</command>
    7373    are used for modifying or viewing the settings associated with checking for a newer version
    74     of VirtualBox.</para>
     74    of &product-name;.</para>
    7575
    7676    <refsect2 id="vboxmanage-updatecheck-perform">
    … …  
    7878      <remark role="help-copy-synopsis"/>
    7979      <para>
    80         Checks if a newer version of VirtualBox is available.
     80        Checks if a newer version of &product-name; is available.
    8181      </para>
    8282      <variablelist>
    … …  
    9191      <remark role="help-copy-synopsis"/>
    9292      <para>
    93         Displays the current settings used for specifying when to check for a newer version of VirtualBox.
     93        Displays the current settings used for specifying when to check for a newer version of &product-name;.
    9494      </para>
    9595      <variablelist>
    … …  
    104104      <remark role="help-copy-synopsis"/>
    105105      <para>
    106         Modifies the settings used for specifying when to check for a newer version of VirtualBox.
     106        Modifies the settings used for specifying when to check for a newer version of &product-name;.
    107107      </para>
    108108      <variablelist>
    … …  
    115115        <varlistentry>
    116116          <term><option>--channel=stable | withbetas | all</option></term>
    117           <listitem><para>The preferred release type used for determining whether a newer version of VirtualBox is available.  The default is 'stable'.</para>
     117          <listitem><para>The preferred release type used for determining whether a newer version of &product-name; is available.  The default is 'stable'.</para>
    118118          <variablelist>
    119119            <varlistentry>
    120120             <term><option>stable</option></term>
    121              <listitem><para>Checks for newer stable releases (maintenance and minor releases within the same major release) of VirtualBox.</para> </listitem>
     121             <listitem><para>Checks for newer stable releases (maintenance and minor releases within the same major release) of &product-name;.</para> </listitem>
    122122            </varlistentry>
    123123            <varlistentry>
    124124             <term><option>all</option></term>
    125              <listitem><para>Checks for newer stable releases (maintenance and minor releases within the same major release) and major releases of VirtualBox.</para></listitem>
     125             <listitem><para>Checks for newer stable releases (maintenance and minor releases within the same major release) and major releases of &product-name;.</para></listitem>
    126126            </varlistentry>
    127127            <varlistentry>
    128128             <term><option>withbetas</option></term>
    129              <listitem><para>Checks for newer stable releases (maintenance and minor releases within the same major release), major releases, and beta releases of VirtualBox.</para></listitem>
     129             <listitem><para>Checks for newer stable releases (maintenance and minor releases within the same major release), major releases, and beta releases of &product-name;.</para></listitem>
    130130            </varlistentry>
    131131          </variablelist>
    … …  
    134134        <varlistentry>
    135135          <term><option>--frequency=days</option></term>
    136           <listitem><para>Specifies how often in days to check for a newer version of VirtualBox.</para></listitem>
     136          <listitem><para>Specifies how often in days to check for a newer version of &product-name;.</para></listitem>
    137137        </varlistentry>
    138138        <varlistentry>

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

    r99513 r106001  
    6464    <para>
    6565      The <command>VBoxManage usbdevsource</command> command adds a USB
    66       device source and makes it available to the guests on the host
    67       system. You can also use this command to remove the USB device
     66      device source and makes it available to VM guests on the host
     67      system. You can also use this command to remove a USB device
    6868      source.
    6969    </para>
    … …  
    7373      <para>
    7474        The <command>VBoxManage usbdevsource add</command> command adds
    75         a USB device source, which is available to all guests on the
     75        a USB device source, which is then available to all guest VMs on the
    7676        host system.
    7777      </para>
    … …  
    9494              Specifies the USB proxy service backend to use.
    9595            </para><para>
    96               For now only USBIP is supported to specify a remote
    97               server using the USB/IP protocol.
     96            If specifying a remote server over the USB/IP protocol
     97            the only currently supported backend value is USBIP.
    9898            </para></listitem>
    9999        </varlistentry>

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

    r99497 r106001  
    116116    </para>
    117117    <para>
    118       Global filters are applied in a particular order. Only the first
    119       filter that fits a device is applied. For example, the first
    120       global filter makes a specific Kingston memory stick device
    121       available while the second filter ignores all Kingston devices.
    122       The result of applying these filters is that the specific Kingston
    123       memory stick is made available to any machine that has the
    124       appropriate filter, but no other Kingston devices are made
    125       available.
     118      Global filters are applied in sequence based on where they were
     119      located in the list (see the <command>--index</command> option below
     120      for the list ordering details). Only the first filter that matches
     121      a device is applied. For example, if two global filters were created
     122      and the first filter made a specific Kingston memory stick device
     123      available while the second filter ignored all Kingston devices the
     124      result of applying these two filters would be that this specific
     125      Kingston memory stick would made available to any VM but no other
     126      Kingston USB devices would be made available.
    126127    </para>
    127128    <refsect2 id="vboxmanage-usbfilter-common">
    … …  
    143144          <term><option>--action=ignore | hold</option></term>
    144145          <listitem><para>
    145               Specifies whether to permit VMs access to devices that fit
    146               the filter description (<literal>hold</literal>) or to
    147               deny them access (<literal>ignore</literal>). This option
    148               applies only to global filters.
     146              Specifies whether to allow VMs access to devices that match
     147              a USB filter (<literal>hold</literal>) or to deny them access
     148              (<literal>ignore</literal>). This option applies only to global
     149              filters.
    149150            </para></listitem>
    150151        </varlistentry>
    … …  
    152153          <term><option>--active=yes | no</option></term>
    153154          <listitem><para>
    154               Specifies whether the USB filter is active or temporarily
     155              Specifies whether a USB filter is active or temporarily
    155156              disabled. Valid values are <literal>yes</literal>, which
    156157              activates the filter, and <literal>no</literal>, which
    … …  
    213214              device is physically connected to a remote VRDE client or
    214215              to a local host system. This option applies to VM filters
    215               only. The default value is an empty string
    216               (<literal>""</literal>).
    217             </para><remark>
    218               Why is the default value an empty string when valid values
    219               are <literal>yes</literal> or <literal>no</literal>?
    220             </remark></listitem>
     216              only. The default value is <literal>no</literal>.
     217            </para></listitem>
    221218        </varlistentry>
    222219        <varlistentry>
    … …  
    277274        In addition, specify parameters by which to filter. You can use
    278275        the <command>VBoxManage list usbhost</command> command to view
    279         the parameters for devices that are attached to your system.
     276        the parameters of the USB devices that are attached to your system.
    280277      </para>
    281278    </refsect2>
    … …  
    288285        usbfilters</command> command to list global filter indexes and
    289286        the <command>VBoxManage showvminfo</command> command to list
    290         indexes for a specific machine.
     287        indexes for a specific virtual machine.
    291288      </para>
    292289    </refsect2>

  • trunk/doc/manual/en_US/vboxmanage-cmd-overview.xsl

    r99500 r106001  
    6565          <xsl:text> is invoked, only one command can be executed. However, a command
    6666          might support several subcommands which then can be invoked in one single
    67           call. The following sections provide detailed reference information on then
     67          call. The following sections provide detailed reference information on the
    6868          different commands.</xsl:text>
    6969        </xsl:element>

  • trunk/doc/manual/ru_RU/man_VBoxManage-controlvm.xml

    r105387 r106001  
    17601760          </para></listitem>
    17611761        <listitem><para>
    1762             Опция <option>--allowlocallogin</option> позволяет включать или
     1762            Опция <option>--allowlocallogon</option> позволяет включать или
    17631763            отключать локальные входы. Допустимые значения
    17641764            <literal>on</literal> для включения локальных входов и

  • trunk/doc/manual/ru_RU/man_VBoxManage-dhcpserver-dhcpoptions.xml

    r98103 r106001  
    8989        </varlistentry>        <varlistentry>
    9090          <term>21 - PolicyFilter</term>
    91           <listitem><para>List of IPv4 addresses and masks paris controlling non-local source routing.</para></listitem>
     91          <listitem><para>List of IPv4 addresses and masks pairs controlling non-local source routing.</para></listitem>
    9292        </varlistentry>        <varlistentry>
    9393          <term>22 - MaxDgramReassemblySize</term>

  • trunk/doc/manual/ru_RU/man_VBoxManage-dhcpserver.xml

    r103620 r106001  
    6767        <arg rep="repeat">--set-opt-hex=<replaceable>номер-опции-dhcp строка-hex</replaceable></arg>
    6868        <arg rep="repeat">--force-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
    69         <arg rep="repeat">--supress-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
     69        <arg rep="repeat">--suppress-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
    7070        <arg>--min-lease-time=<replaceable>секунды</replaceable></arg>
    7171        <arg>--default-lease-time=<replaceable>секунды</replaceable></arg>
    … …  
    7878        <arg rep="repeat">--set-opt-hex=<replaceable>номер-опции-dhcp строка-hex</replaceable></arg>
    7979        <arg rep="repeat">--force-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
    80         <arg rep="repeat">--supress-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
     80        <arg rep="repeat">--suppress-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
    8181        <arg rep="repeat">--incl-mac=<replaceable>адрес</replaceable></arg>
    8282        <arg rep="repeat">--excl-mac=<replaceable>адрес</replaceable></arg>
    … …  
    102102        <arg rep="repeat">--set-opt-hex=<replaceable>номер-опции-dhcp строка-hex</replaceable></arg>
    103103        <arg rep="repeat">--force-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
    104         <arg rep="repeat">--supress-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
     104        <arg rep="repeat">--suppress-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
    105105        <arg>--min-lease-time=<replaceable>секунды</replaceable></arg>
    106106        <arg>--default-lease-time=<replaceable>секунды</replaceable></arg>
    … …  
    114114        <arg rep="repeat">--set-opt-hex=<replaceable>номер-опции-dhcp строка-hex</replaceable></arg>
    115115        <arg rep="repeat">--force-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
    116         <arg rep="repeat">--supress-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
     116        <arg rep="repeat">--suppress-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
    117117        <arg>--min-lease-time=<replaceable>секунды</replaceable></arg>
    118118        <arg>--default-lease-time=<replaceable>секунды</replaceable></arg>
    … …  
    143143        <arg rep="repeat">--force-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
    144144        <arg rep="repeat">--unforce-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
    145         <arg rep="repeat">--supress-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
    146         <arg rep="repeat">--unsupress-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
     145        <arg rep="repeat">--suppress-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
     146        <arg rep="repeat">--unsuppress-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
    147147        <arg>--min-lease-time=<replaceable>секунды</replaceable></arg>
    148148        <arg>--default-lease-time=<replaceable>секунды</replaceable></arg>
    … …  
    157157        <arg rep="repeat">--force-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
    158158        <arg rep="repeat">--unforce-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
    159         <arg rep="repeat">--supress-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
    160         <arg rep="repeat">--unsupress-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
     159        <arg rep="repeat">--suppress-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
     160        <arg rep="repeat">--unsuppress-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
    161161        <arg rep="repeat">--del-mac=<replaceable>адрес</replaceable></arg>
    162162        <arg rep="repeat">--incl-mac=<replaceable>адрес</replaceable></arg>
    … …  
    192192        <arg rep="repeat">--force-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
    193193        <arg rep="repeat">--unforce-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
    194         <arg rep="repeat">--supress-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
     194        <arg rep="repeat">--suppress-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
    195195        <arg rep="repeat">--unsupress-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
    196196        <arg>--min-lease-time=<replaceable>секунды</replaceable></arg>
    … …  
    208208        <arg rep="repeat">--force-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
    209209        <arg rep="repeat">--unforce-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
    210         <arg rep="repeat">--supress-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
    211         <arg rep="repeat">--unsupress-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
     210        <arg rep="repeat">--suppress-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
     211        <arg rep="repeat">--unsuppress-opt=<replaceable>номер-опции-dhcp</replaceable></arg>
    212212        <arg>--min-lease-time=<replaceable>секунды</replaceable></arg>
    213213        <arg>--default-lease-time=<replaceable>секунды</replaceable></arg>

  • trunk/doc/manual/ru_RU/man_VBoxManage-unattended.xml

    r103620 r106001  
    149149        <varlistentry>
    150150          <term><option>--install-additions</option>, <option>--no-install-additions</option></term>
    151           <listitem><para>Устанавливать ли Дополнения Гостевой ОС VirtualBox.  (по умолчанию: --no-install-addations)</para></listitem>
     151          <listitem><para>Устанавливать ли Дополнения Гостевой ОС VirtualBox.  (по умолчанию: --no-install-additions)</para></listitem>
    152152        </varlistentry>
    153153        <varlistentry>

  • trunk/src/VBox/Additions/solaris/Virtio/Virtio-solaris.h

    r98103 r106001  
    7878struct VirtioRingAvail
    7979{
    80     uint16_t                fFlags;             /* Interrupt supression flag. */
     80    uint16_t                fFlags;             /* Interrupt suppression flag. */
    8181    uint16_t                Index;              /* Index of available ring. */
    8282    uint16_t                aRings[1];          /* Array of indices into descriptor table. */

  • trunk/src/VBox/Devices/Audio/DrvHostAudioPulseAudio.cpp

    r98103 r106001  
    19181918    else
    19191919    {
    1920         LogFunc(("Supressing %Rrc because we wrote %#x bytes\n", rc, cbTotalWritten));
     1920        LogFunc(("Suppressing %Rrc because we wrote %#x bytes\n", rc, cbTotalWritten));
    19211921        rc = VINF_SUCCESS;
    19221922    }
    … …  
    21172117    else
    21182118    {
    2119         LogFunc(("Supressing %Rrc because we're returning %#x bytes\n", rc, cbTotalRead));
     2119        LogFunc(("Suppressing %Rrc because we're returning %#x bytes\n", rc, cbTotalRead));
    21202120        rc = VINF_SUCCESS;
    21212121    }

  • trunk/src/VBox/Devices/Bus/DevIommuIntel.cpp

    r99280 r106001  
    15471547{
    15481548    /*
    1549      * Update the diagnostic reason (even if software wants to supress faults).
     1549     * Update the diagnostic reason (even if software wants to suppress faults).
    15501550     */
    15511551    PDMAR pThis = PDMDEVINS_2_DATA(pDevIns, PDMAR);
    … …  
    16151615{
    16161616    /*
    1617      * Update the diagnostic reason (even if software wants to supress faults).
     1617     * Update the diagnostic reason (even if software wants to suppress faults).
    16181618     */
    16191619    PDMAR pThis = PDMDEVINS_2_DATA(pDevIns, PDMAR);
    … …  
    24462446                    uint64_t const uCtxEntryQword1 = CtxEntry.au64[1];
    24472447
    2448                     /* Note the FPD bit which software can use to supress translation faults from here on in. */
     2448                    /* Note the FPD bit which software can use to suppress translation faults from here on in. */
    24492449                    pMemReqAux->fFpd = RT_BF_GET(uCtxEntryQword0, VTD_BF_0_CONTEXT_ENTRY_FPD);
    24502450

  • trunk/src/VBox/Devices/Network/DevVirtioNet.cpp

    r104432 r106001  
    479479    uint8_t                 fAllUnicast;
    480480
    481     /** No multicast mode - Supresses multicast receive */
     481    /** No multicast mode - Suppresses multicast receive */
    482482    uint8_t                 fNoMulticast;
    483483
    … …  
    485485    uint8_t                 fNoUnicast;
    486486
    487     /** No broadcast mode - Supresses broadcast receive */
     487    /** No broadcast mode - Suppresses broadcast receive */
    488488    uint8_t                 fNoBroadcast;
    489489

  • trunk/src/VBox/Frontends/VBoxManage/VBoxManageDHCPServer.cpp

    r98103 r106001  
    577577                        return errorSyntax(DHCPServer::tr("--unforce-opt does not apply to the 'add' subcommand"));
    578578                    RT_FALL_THROUGH();
    579                 case DHCP_ADDMOD_UNSUPPRESS_OPTION: // --unsupress-opt
     579                case DHCP_ADDMOD_UNSUPPRESS_OPTION: // --unsuppress-opt
    580580                    if (pCtx->pCmdDef->fSubcommandScope == HELP_SCOPE_DHCPSERVER_ADD)
    581581                        return errorSyntax(DHCPServer::tr("--unsuppress-opt does not apply to the 'add' subcommand"));

  • trunk/src/VBox/Frontends/VirtualBox/src/extradata/UIExtraDataDefs.h

    r105887 r106001  
    6060    /** @name Messaging
    6161      * @{ */
    62         /** Holds the list of supressed messages for the Message/Popup center frameworks. */
     62        /** Holds the list of suppressed messages for the Message/Popup center frameworks. */
    6363        SHARED_LIBRARY_STUFF extern const char *GUI_SuppressMessages;
    6464        /** Holds the list of messages for the Message/Popup center frameworks with inverted check-box state. */

  • trunk/src/VBox/Frontends/VirtualBox/src/extradata/UIExtraDataManager.h

    r105363 r106001  
    199199    /** @name Messaging
    200200      * @{ */
    201         /** Returns the list of supressed messages for the Message/Popup center frameworks. */
     201        /** Returns the list of suppressed messages for the Message/Popup center frameworks. */
    202202        QStringList suppressedMessages(const QUuid &uID = GlobalID);
    203         /** Defines the @a list of supressed messages for the Message/Popup center frameworks. */
     203        /** Defines the @a list of suppressed messages for the Message/Popup center frameworks. */
    204204        void setSuppressedMessages(const QStringList &list);
    205205

  • trunk/src/VBox/Main/idl/VirtualBox.xidl

    r105971 r106001  
    76707670
    76717671    <attribute name="CPUIDPortabilityLevel" type="unsigned long">
    7672       <desc>Virtual CPUID portability level, the higher number the fewer newer
    7673         or vendor specific CPU feature is reported to the guest (via the CPUID
     7672      <desc>Virtual CPUID portability level. The higher the number the fewer
     7673        vendor-specific or recent CPU features are reported to the guest (via the CPUID
    76747674        instruction).  The default level of zero (0) means that all virtualized
    7675         features supported by the host is pass thru to the guest.  While the
    7676         three (3) is currently the level supressing the most features.
     7675        features supported by the host are passed through to the guest.  While the
     7676        value of three (3) is currently the level suppressing the most features.
    76777677
    76787678        Exactly which of the CPUID features are left out by the VMM at which

  • trunk/src/VBox/NetworkServices/Dhcpd/Config.cpp

    r98103 r106001  
    748748        throw ConfigFileError(pElmOption, "Bad option name '%s': %Rrc", pszName, rc);
    749749
    750     /* The opional 'encoding' attribute: */
     750    /* The optional 'encoding' attribute: */
    751751    uint32_t u32Enc = 0;            /* XXX: DHCPOptionEncoding_Normal */
    752752    const char *pszEncoding;
    … …  
    783783
    784784/**
    785  * Internal worker for parsing \<ForcedOption\> and \<SupressedOption\> elements
     785 * Internal worker for parsing \<ForcedOption\> and \<SupcressedOption\> elements
    786786 * found under /DHCPServer/Options/, /DHCPServer/Group/ and /DHCPServer/Config/.
    787787 *
    … …  
    833833
    834834    /*
    835      * Forced and supressed options.
     835     * Forced and suppressed options.
    836836     */
    837837    bool const fForced = pElmChild->nameEquals("ForcedOption");
    … …  
    11711171{
    11721172    /*
    1173      * The client typcially requests a list of options.  The list is subject to
    1174      * forced and supressed lists on each configuration level in a_rConfig.  To
     1173     * The client typically requests a list of options.  The list is subject to
     1174     * forced and suppressed lists on each configuration level in a_rConfig.  To
    11751175     * efficiently manage it without resorting to maps, the current code
    11761176     * assembles a C-style array of options on the stack that should be returned

  • trunk/src/VBox/Runtime/common/asn1/asn1-ut-time-decode.cpp

    r98103 r106001  
    7070    {
    7171        /* Work around clever rounding error in DER_CFDateToUTCTime() on OS X.  This also
    72            supresses any attempt at feeding us leap seconds.  If we pass 60 to the
     72           suppresses any attempt at feeding us leap seconds.  If we pass 60 to the
    7373           normalization code will move on to the next min/hour/day, which is wrong both
    7474           for the OS X issue and for unwanted leap seconds.  Leap seconds are not valid

  • trunk/src/VBox/VMM/VMMAll/CPUMAllRegs.cpp

    r105092 r106001  
    992992            }
    993993
    994             /* Intel CPUs supresses the SYSCALL bit when not executing in 64-bit mode: */
     994            /* Intel CPUs suppress the SYSCALL bit when not executing in 64-bit mode: */
    995995            if (   uLeaf == UINT32_C(0x80000001)
    996996                && f64BitMode == false

  • trunk/src/VBox/VMM/VMMAll/IEMAllCImpl.cpp

    r105664 r106001  
    95279527    if ((pDstX87->FSW & X86_FSW_ES) ^ (fOldFsw & X86_FSW_ES))
    95289528        Log11(("iemCImplCommonFpuRestoreEnv: %04x:%08RX64: %s FPU exception (FCW=%#x FSW=%#x -> %#x)\n",
    9529                pVCpu->cpum.GstCtx.cs.Sel, pVCpu->cpum.GstCtx.rip, fOldFsw & X86_FSW_ES ? "Supressed" : "Raised",
     9529               pVCpu->cpum.GstCtx.cs.Sel, pVCpu->cpum.GstCtx.rip, fOldFsw & X86_FSW_ES ? "Suppressed" : "Raised",
    95309530               pDstX87->FCW, fOldFsw, pDstX87->FSW));
    95319531#endif
    … …  
    95699569    if ((pFpuCtx->FSW & X86_FSW_ES) ^ (fOldFsw & X86_FSW_ES))
    95709570        Log11(("fnstenv: %04x:%08RX64: %s FPU exception (FCW=%#x, FSW %#x -> %#x)\n", pVCpu->cpum.GstCtx.cs.Sel, pVCpu->cpum.GstCtx.rip,
    9571                fOldFsw & X86_FSW_ES ? "Supressed" : "Raised", pFpuCtx->FCW, fOldFsw, pFpuCtx->FSW));
     9571               fOldFsw & X86_FSW_ES ? "Suppressed" : "Raised", pFpuCtx->FCW, fOldFsw, pFpuCtx->FSW));
    95729572#endif
    95739573
    … …  
    97219721    if ((pFpuCtx->FSW & X86_FSW_ES) ^ (fOldFsw & X86_FSW_ES))
    97229722        Log11(("fldcw: %04x:%08RX64: %s FPU exception (FCW=%#x, FSW %#x -> %#x)\n", pVCpu->cpum.GstCtx.cs.Sel, pVCpu->cpum.GstCtx.rip,
    9723                fOldFsw & X86_FSW_ES ? "Supressed" : "Raised", pFpuCtx->FCW, fOldFsw, pFpuCtx->FSW));
     9723               fOldFsw & X86_FSW_ES ? "Suppressed" : "Raised", pFpuCtx->FCW, fOldFsw, pFpuCtx->FSW));
    97249724#endif
    97259725

  • trunk/src/VBox/VMM/VMMAll/IEMAllThrdFuncsBltIn.cpp

    r105698 r106001  
    167167       we haven't reused the bits yet, we can still reliably check whether
    168168       we're only here for reasons of pending interrupts and whether these
    169        are supressed by EFLAGS.IF=0 or interrupt shadowing. */
     169       are suppressed by EFLAGS.IF=0 or interrupt shadowing. */
    170170    Assert(!(fVmRaw & (VMCPU_FF_INTERRUPT_APIC | VMCPU_FF_INTERRUPT_PIC)));
    171171    AssertCompile((VMCPU_FF_INTERRUPT_APIC | VMCPU_FF_INTERRUPT_PIC) == 3);

  • trunk/src/VBox/VMM/VMMR0/HMSVMR0.cpp

    r104516 r106001  
    91089108    else
    91099109    {
    9110         /* We use IEMExecOneBypassEx() here as it supresses attempt to continue emulating any
     9110        /* We use IEMExecOneBypassEx() here as it suppresses attempt to continue emulating any
    91119111           instruction(s) when interrupt inhibition is set as part of emulating the VMRUN
    91129112           instruction itself, see @bugref{7243#c126} */
Note: See TracChangeset for help on using the changeset viewer.

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