VirtualBox

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


Ignore:
Timestamp:
Jul 19, 2016 6:55:07 PM (9 years ago)
Author:
vboxsync
Message:

bugref:6417 further checkins

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

Legend:

Unmodified
Added
Removed

  • trunk/doc/manual/en_US/user_BasicConcepts.xml

    r59933 r62335  
    10101010    select between the OSS, ALSA or the PulseAudio subsystem. On newer Linux
    10111011    distributions, the PulseAudio subsystem should be preferred.</para>
     1012
     1013    <para>Since VirtualBox 5.0 only OSS is supported on Solaris hosts - the "Solaris Audio"
     1014    audio backend is no longer supported on Solaris hosts.</para>
    10121015  </sect1>
    10131016

  • trunk/doc/manual/en_US/user_Installation.xml

    r62238 r62335  
    468468
    469469      <sect3>
    470         <title>Using the alternative installer (VirtualBox.run)</title>
    471 
    472         <para>The alternative installer performs the following steps:</para>
     470        <title>Using the alternative generic installer (VirtualBox.run)</title>
     471
     472        <para>The alternative generic installer performs the following steps:</para>
    473473
    474474        <itemizedlist>

  • trunk/doc/manual/en_US/user_Networking.xml

    r61817 r62335  
    950950            command in Linux guests.</para>
    951951        </listitem>
     952        <listitem>
     953          <para>Perform a full, detailed analysis of network traffic on
     954            the VM's network adaptor using a 3rd party tool such as Wireshark.
     955            To do this, a promiscuous mode policy needs to be used on the
     956            VM's network adaptor. Use of this mode is only possible on
     957            networks: NAT Network, Bridged Adapter, Internal Network and Host-only Adapter.</para>
     958          <para>To setup a promiscuous mode policy, either select from the drop down list
     959            located in the Network Settings dialog for the network adaptor
     960            or use the command line tool <computeroutput>VBoxManage</computeroutput>;
     961            for details, refer to <xref linkend="vboxmanage-modifyvm" />.</para>
     962          <para>Promiscuous mode policies are: </para>
     963          <para><orderedlist>
     964            <listitem>
     965              <para><computeroutput>deny</computeroutput> (default setting) which hides
     966              any traffic not intended for this VM's network adaptor.</para>
     967            </listitem>
     968            <listitem>
     969              <para><computeroutput>allow-vms</computeroutput> which hides all host
     970              traffic from this VM's network adaptor, but allows it to see traffic from/to other
     971              VMs.</para>
     972            </listitem>
     973            <listitem>
     974              <para><computeroutput>allow-all</computeroutput> which removes all
     975              restrictions - this VM's network adaptor sees all traffic.</para>
     976            </listitem>
     977          </orderedlist></para>
     978        </listitem>
    952979        </orderedlist></para>
    953980  </sect1>

  • trunk/doc/manual/en_US/user_VBoxManage.xml

    r62199 r62335  
    470470
    471471          <listitem>
    472             <para><computeroutput>--memory
    473             &lt;memorysize&gt;</computeroutput>: This sets the amount of RAM,
     472            <para><computeroutput>--iconfile &lt;filename&gt;</computeroutput>:
     473            This specifies the absolute path on the host file system for the VirtualBox
     474            icon to be displayed in the VM.</para>
     475          </listitem>
     476
     477          <listitem>
     478            <para><computeroutput>--memory &lt;memorysize&gt;</computeroutput>: This sets the amount of RAM,
    474479            in MB, that the virtual machine should allocate for itself from
    475480            the host. See the remarks in <xref linkend="gui-createvm" /> for
    476481            more information.</para>
     482          </listitem>
     483
     484          <listitem>
     485            <para><computeroutput>--pagefusion on|off</computeroutput>:
     486            Enables/disables (default) the Page Fusion feature. 
     487            The Page Fusion feature minimises memory duplication between VMs with similar
     488            configurations running on the same host.
     489            See <xref linkend="guestadd-pagefusion" /> for details.</para>
    477490          </listitem>
    478491
    … …  
    489502            respectively; see <xref linkend="settings-motherboard" /> for
    490503            details.</para>
     504          </listitem>
     505
     506          <listitem>
     507            <para><computeroutput>--pciattach &lt;host PCI address [@ guest PCI bus address]&gt;</computeroutput>:
     508            Attaches a specified PCI network controller on the host to a PCI bus (can specify) on the guest.
     509            See <xref linkend="pcipassthrough" /> for details. </para>
     510          </listitem>
     511
     512          <listitem>
     513            <para><computeroutput>--pcidetach &lt;host PCI address&gt;</computeroutput>:
     514            Detaches a specified PCI network controller on the host from the attached PCI bus on the guest.
     515            See <xref linkend="pcipassthrough" /> for details. </para>
    491516          </listitem>
    492517
    … …  
    546571
    547572          <listitem>
     573            <para><computeroutput>--cpu-profile &lt;host|intel 80[86|286|386]&gt;</computeroutput>:
     574            Indicate the use of a profile for guest cpu emulation. Specify either one based 
     575            on the host system CPU (host), or one from a number of older Intel
     576            Micro-architectures - 8086, 80286, 80386.</para>
     577          </listitem>
     578
     579          <listitem>
    548580            <para><computeroutput>--hpet on|off</computeroutput>: This
    549581            enables/disables a High Precision Event Timer (HPET) which can
    … …  
    565597            CPU so sometimes this is desired behavior. Works only for non-SMP
    566598            guests.</para>
     599          </listitem>
     600
     601          <listitem>
     602            <para><computeroutput>--apic on|off</computeroutput>:
     603            This setting enables(default)/disables IO APIC. With
     604            I/O APIC, operating systems can use more than 16 interrupt
     605            requests (IRQs) thus avoiding IRQ sharing for improved
     606            reliability. See <xref linkend="settings-motherboard" />.</para>
     607          </listitem>
     608
     609          <listitem>
     610            <para><computeroutput>--x2apic on|off</computeroutput>:
     611            This setting enables(default)/disables CPU x2APIC support.
     612            CPU x2APIC support helps operating systems run more efficiently on high
     613            core count configurations, and optimizes interrupt
     614            distribution in virtualized environments. Disable when using host/guest
     615            operating systems incompatible with x2APIC support.</para>
    567616          </listitem>
    568617
    … …  
    717766
    718767          <listitem>
     768            <para><computeroutput>--graphicscontroller none|vboxvga|vmsvga</computeroutput>: This
     769            option specifies use of a graphics controller, and type chosen from vboxvga or vmsvga.
     770            <xref linkend="settings-motherboard" />).</para>
     771          </listitem>
     772
     773          <listitem>
    719774            <para><computeroutput>--biossystemtimeoffset &lt;ms&gt;</computeroutput>:
    720775            This allows you to set a fixed time offset of the guest relative to
    … …  
    731786
    732787          <listitem>
    733             <para><computeroutput>--firmware efi|bios</computeroutput>:
    734             Specifies which firmware is used to boot particular virtual
    735             machine: EFI or BIOS. Use EFI only if your fully understand what
    736             you're doing.</para>
     788            <para><computeroutput>--firmware bios|efi|efi32|efi64</computeroutput>:
     789            Specifies which firmware to be used to boot the VM:
     790            Available options are BIOS, or one of the EFI options: efi, efi32 or efi64.
     791            Use EFI options with care.</para>
    737792          </listitem>
    738793
    … …  
    883938            <para><computeroutput>--macaddress&lt;1-N&gt;
    884939            auto|&lt;mac&gt;</computeroutput>: With this option you can set
    885             the MAC address of the virtual network card. Normally, each
    886             virtual network card is assigned a random address by VirtualBox at
     940            the MAC address of a particular network adapter on the VM. Normally, each
     941            network adapter is assigned a random address by VirtualBox at
    887942            VM creation.</para>
     943          </listitem>
     944
     945          <listitem>
     946            <para><computeroutput>--mouse &lt;ps2|usb|usbtablet|usbmultitouch&gt;</computeroutput>:
     947            Specifies the mode of the mouse to be used in the VM. Available options are: ps2, usb,
     948            usbtablet, usbmultitouch.
     949            </para>
     950          </listitem>
     951
     952          <listitem>
     953            <para><computeroutput>--keyboard &lt;ps2|usb&gt;</computeroutput>:
     954            Specifies the mode of the keyboard to be used in the VM. Available options are: ps2, usb.
     955            </para>
    888956          </listitem>
    889957
    … …  
    906974            between UDP Tunnel and the VDE backend drivers. For example,
    907975            please see <xref linkend="network_udp_tunnel" />.
     976            </para>
     977          </listitem>
     978
     979          <listitem>
     980            <para><computeroutput>--nicspeed&lt;1-N&gt; &lt;kbps&gt;</computeroutput>:
     981            If generic networking has been enabled for a virtual network card (see the
     982            <computeroutput>--nic</computeroutput> option above; otherwise
     983            this setting has no effect), this mode enables access
     984            to rarely used networking sub-modes, such as VDE network or UDP Tunnel.
     985            This option specifies the throughput rate in KBytes/sec.
    908986            </para>
    909987          </listitem>
    … …  
    9531031              TFTP server address to boot from (please see <xref
    9541032              linkend="nat-adv-tftp" /> for details).</para>
     1033            </listitem>
     1034
     1035            <listitem>
     1036              <para><computeroutput>--nattbindip&lt;1-N&gt;
     1037              &lt;ip;&gt;</computeroutput>: VirtualBox's NAT engine normally routes
     1038              TCP/IP packets through the default interface assigned by the host's
     1039              TCP/IP stack. Use this option to instruct the NAT engine to bind
     1040              to a specified IP address instead. (Please see <xref
     1041              linkend="nat-adv-settings" /> for details).</para>
    9551042            </listitem>
    9561043
    … …  
    10981185
    10991186          <listitem>
    1100             <para><computeroutput>--audio none|null|oss</computeroutput>: With
     1187            <para><computeroutput>--audio none|null|oss|alsa|pulse</computeroutput>: With
    11011188            this option, you can set whether the VM should have audio
    1102             support.</para>
     1189            support, and if so - which type.</para>
     1190          </listitem>
     1191
     1192          <listitem>
     1193            <para><computeroutput>--audiocontroller ac97|hda|sb16</computeroutput>: With
     1194            this option, you can specify the audio controller to be used with this VM.
     1195            </para>
     1196          </listitem>
     1197
     1198          <listitem>
     1199            <para><computeroutput>--audiocodec stac9700|ad1980|stac9221|sb16</computeroutput>: With
     1200            this option, you can specify the audio codec to be used with this VM.
     1201            </para>
    11031202          </listitem>
    11041203
    … …  
    13961495            tracepoints are enabled.</para>
    13971496          </listitem>
     1497          <listitem>
     1498            <para><computeroutput>--tracing-allow-vm-access on|off</computeroutput>:
     1499            Enables/disables(default) VM access to the tracebuffer.</para>
     1500          </listitem>
    13981501        </itemizedlist>
    13991502      </para>
    14001503    </sect2>
    14011504
     1505    <sect2 id="vboxmanage-usbcardreader">
     1506      <title>USB card reader settings</title>
     1507
     1508      <para>The following setting defines access to a USB Card Reader by the guest environment.
     1509      USB card readers are typically used for accessing data on memory cards such as
     1510      CompactFlash (CF), Secure Digital (SD) or MultiMediaCard (MMC).</para>
     1511      <itemizedlist>
     1512          <listitem>
     1513            <para><computeroutput>--usbcardreader on|off</computeroutput>:
     1514            Enables/disables the USB card reader interface.</para>
     1515          </listitem>
     1516      </itemizedlist>
     1517    </sect2>
     1518
     1519    <sect2 id="vboxmanage-autostart">
     1520      <title>Auto starting VMs during host system boot</title>
     1521
     1522      <para>These settings configure the VM autostart feature,
     1523      which automatically starts the VM at host system boot-up.
     1524      Note that there are pre-requisities that need to be addressed before using this feature.
     1525      See <xref lang="" linkend="autostart" /> for more details.</para>
     1526      <itemizedlist>
     1527        <listitem>
     1528          <para><computeroutput>--autostart on|off</computeroutput>:
     1529          Enables/disables VM autostart at host system boot-up, using specified user name.</para>
     1530        </listitem>
     1531        <listitem>
     1532          <para><computeroutput>--autostart-delay &lt;seconds&gt;</computeroutput>:
     1533          Specifies a delay (seconds) following host system boot-up, before VM autostarts.</para>
     1534        </listitem>
     1535      </itemizedlist>
     1536    </sect2>
    14021537  </sect1>
    14031538
    … …  
    17421877      <listitem>
    17431878        <para><computeroutput>nic&lt;1-N&gt;
    1744         null|nat|bridged|intnet|hostonly|generic</computeroutput>: With this, you can
     1879        null|nat|bridged|intnet|hostonly|generic|natnetwork[&lt;devicename&gt;]</computeroutput>: With this, you can
    17451880        set, for each of the VM's virtual network cards, what type of
    17461881        networking should be available. They can be not connected to the host
    … …  
    17501885        virtual machines using internal networking
    17511886        (<computeroutput>intnet</computeroutput>) or host-only networking
    1752         (<computeroutput>hostonly</computeroutput>) or access to rarely used
     1887        (<computeroutput>hostonly</computeroutput>) or natnetwork networking
     1888        (<computeroutput>natnetwork</computeroutput>) or access to rarely used
    17531889        sub-modes
    1754         (<computeroutput>generic</computeroutput>). These options correspond
    1755         to the modes which are described in detail in <xref
     1890        (<computeroutput>generic</computeroutput>).
     1891        These options correspond to the modes which are described in detail in <xref
    17561892        linkend="networkingmodes" />.</para>
    17571893      </listitem>
    … …  
    17991935
    18001936      <listitem>
    1801         <para>The <computeroutput>guestmemoryballoon</computeroutput>
     1937        <para><computeroutput>natpf&lt;1-N&gt;
     1938        [&lt;name&gt;],tcp|udp,[&lt;hostip&gt;],&lt;hostport&gt;,[&lt;guestip&gt;],
     1939        &lt;guestport&gt;</computeroutput>: This option defines a NAT
     1940        port-forwarding rule (please see <xref linkend="natforward"/>
     1941        for details).
     1942        </para>
     1943      </listitem>
     1944
     1945      <listitem>
     1946        <para><computeroutput>natpf&lt;1-N&gt; delete
     1947        &lt;name&gt;</computeroutput>: This option deletes a NAT
     1948        port-forwarding rule (please see <xref linkend="natforward"/>
     1949        for details).</para>
     1950      </listitem>
     1951
     1952      <listitem>
     1953        <para>The <computeroutput>guestmemoryballoon&lt;balloon size in MB&gt;</computeroutput>
    18021954        operation changes the size of the guest memory balloon, that is,
    18031955        memory allocated by the VirtualBox Guest Additions from the guest
    … …  
    18081960
    18091961      <listitem>
    1810         <para><computeroutput>usbattach</computeroutput> and
    1811         <computeroutput>usbdettach</computeroutput> make host USB devices
    1812         visible to the virtual machine on the fly, without the need for
     1962        <para><computeroutput>usbattach&lt;uuid|address&gt; [--capturefile &lt;filename&gt;]</computeroutput></para>
     1963        <para>and <computeroutput>usbdetach &lt;uuid|address&gt; [--capturefile &lt;filename&gt;]</computeroutput>
     1964        make host USB devices visible/invisible to the virtual machine on the fly, without the need for
    18131965        creating filters first. The USB devices can be specified by UUID
    1814         (unique identifier) or by address on the host system.</para>
     1966        (unique identifier) or by address on the host system. Use the --capturefile
     1967        option to specify the absolute path of a file for writing activity logging data.</para>
    18151968
    18161969        <para>You can use <computeroutput>VBoxManage list
    … …  
    18502003      </listitem>
    18512004
     2005      <listitem>
     2006        <para><computeroutput>vrdevideochannelquality
     2007        &lt;percent&gt;</computeroutput>: Sets the image quality for video
     2008        redirection; see <xref lang=""
     2009        linkend="vrde-videochannel" />.</para>
     2010      </listitem>
    18522011
    18532012      <listitem>
    … …  
    19342093      </listitem>
    19352094
    1936       <!-- @todo r=andy Document teleport! -->
     2095      <listitem>
     2096        <para><computeroutput>teleport --host &lt;name&gt; --port &lt;port&gt;</computeroutput>
     2097        can be used to configure a VM as a target for teleporting.
     2098        &lt;name&gt; specifies the virtual machine name. &lt;port&gt; specifies the port on the
     2099        virtual machine which should listen for a teleporting request from another
     2100        virtual machine. It can be any free TCP/IP port number (e.g. 6000);
     2101        See <xref linkend="teleporting" /> for an introduction.</para>
     2102        <itemizedlist>
     2103          <listitem>
     2104            <para><computeroutput>--maxdowntime &lt;msec&gt;</computeroutput>:
     2105            Optional - specifies the maximum downtime (millseconds) for the
     2106            teleporting target VM.</para>
     2107          </listitem>
     2108
     2109          <listitem>
     2110            <para><computeroutput>--password
     2111            &lt;password&gt;</computeroutput>:
     2112            Optional - indicates that the teleporting request will only succeed if the
     2113            source machine specifies the same password as the one given with
     2114            this command.</para>
     2115          </listitem>
     2116
     2117          <listitem>
     2118            <para><computeroutput>--passwordfile
     2119            &lt;password file&gt;</computeroutput>:
     2120            Optional - indicates that the teleporting request will only succeed if the
     2121            source machine specifies the same password as the one specified
     2122            in the file given with this command. Use <computeroutput>stdin</computeroutput>
     2123            to read the password from stdin.</para>
     2124          </listitem>
     2125        </itemizedlist>
     2126      </listitem>
    19372127
    19382128      <listitem>
    … …  
    28983088        </glossentry>
    28993089
    2900 
    29013090        <glossentry>
    29023091          <glossterm><computeroutput>vrdeauthlibrary</computeroutput></glossterm>
    … …  
    31463335      credentials to be specified, the second does not.</para>
    31473336
    3148     <para>The first set of subcommands are of the form:</para>
     3337    <para>The first set of subcommands is of the form:</para>
    31493338    <screen>VBoxManage guestcontrol &lt;uuid|vmname&gt; &lt;sub-command&gt;
    31503339            [--username &lt;name&gt; ]
    … …  
    31683357          <glossterm><computeroutput>&lt;uuid|vmname&gt;</computeroutput></glossterm>
    31693358            <glossdef>
    3170               <para>The VM UUID or VM name. Mandatory.</para>
     3359              <para>Specifies the VM UUID or VM name. Mandatory.</para>
    31713360            </glossdef>
    31723361        </glossentry>
    … …  
    32193408            <glosslist>
    32203409              <glossentry>
    3221                 <glossterm><computeroutput>--exe "&lt;path to executable&gt;"</computeroutput></glossterm>
     3410                <glossterm><computeroutput>&lt;uuid|vmname&gt;</computeroutput></glossterm>
     3411                <glossdef>
     3412                  <para>Specifies the VM UUID or VM name. Mandatory.</para>
     3413                </glossdef>
     3414              </glossentry>
     3415
     3416              <glossentry>
     3417                <glossterm><computeroutput>--exe &lt;path to executable&gt;</computeroutput></glossterm>
    32223418                <glossdef><para>Specifies the absolute path of the executable on the guest OS file system. Mandatory. e.g.:
    32233419                  <computeroutput>C:\Windows\System32\calc.exe</computeroutput>.</para>
    3224                 </glossdef>
    3225               </glossentry>
    3226 
    3227               <glossentry>
    3228                 <glossterm><computeroutput>&lt;uuid|vmname&gt;</computeroutput></glossterm>
    3229                 <glossdef>
    3230                   <para>Specifies the VM UUID or VM name. Mandatory.</para>
    32313420                </glossdef>
    32323421              </glossentry>
    … …  
    32423431
    32433432              <glossentry>
    3244                 <glossterm><computeroutput>-E|--putenv "&lt;NAME&gt;=&lt;VALUE&gt;"
     3433                <glossterm><computeroutput>-E|--putenv &lt;NAME&gt;=&lt;VALUE&gt;
    32453434                </computeroutput></glossterm>
    32463435                <glossdef>
    … …  
    32873476
    32883477              <glossentry>
    3289                 <glossterm><computeroutput>>--no-wait-stderr|--wait-stderr</computeroutput></glossterm>
     3478                <glossterm><computeroutput>--no-wait-stderr|--wait-stderr</computeroutput></glossterm>
    32903479                <glossdef>
    32913480                  <para>Does not wait/waits until the guest process ends and receives its exit code and reason/flags.
    … …  
    33553544
    33563545        <listitem>
    3357           <para><emphasis role="bold"><computeroutput>start</computeroutput></emphasis>,
     3546          <para><emphasis role="bold"><computeroutput>start</computeroutput></emphasis>
    33583547          Executes a guest program until it completes.</para>
    33593548          <screen>VBoxManage guestcontrol &lt;uuid|vmname&gt; start [common-options]
    3360             [--exe &lt;path to executable&gt;] [--timeout &lt;msec&gt;]
    3361             [-E|--putenv &lt;NAME&gt;[=&lt;VALUE&gt;]] [--unquoted-args]
    3362             [--ignore-operhaned-processes] [--profile]
     3549           [--exe &lt;path to executable&gt;] [--timeout &lt;msec&gt;]
     3550           [-E|--putenv &lt;NAME&gt;[=&lt;VALUE&gt;]] [--unquoted-args]
     3551           [--ignore-operhaned-processes] [--profile]
    33633552            -- &lt;program/arg0&gt; [argument1] ... [argumentN]]
    33643553          </screen>
    … …  
    33733562
    33743563              <glossentry>
    3375                 <glossterm><computeroutput>--exe "&lt;path to executable&gt;"</computeroutput></glossterm>
     3564                <glossterm><computeroutput>--exe &lt;path to executable&gt;</computeroutput></glossterm>
    33763565                <glossdef><para>Specifies the absolute path of the executable on the guest OS file system. Mandatory. e.g.:
    33773566                  <computeroutput>C:\Windows\System32\calc.exe</computeroutput></para>
    … …  
    33883577
    33893578              <glossentry>
    3390                 <glossterm><computeroutput>-E|--putenv "&lt;NAME&gt;=&lt;VALUE&gt;"
     3579                <glossterm><computeroutput>-E|--putenv &lt;NAME&gt;=&lt;VALUE&gt;
    33913580                </computeroutput></glossterm>
    33923581                <glossdef>
    … …  
    34133602                <glossterm><computeroutput>--ignore-operhaned-processes</computeroutput></glossterm>
    34143603                <glossdef>
    3415                   <para>Ignores orphaned processes. Not implemented yet. Optional.</para>
     3604                  <para>Ignores orphaned processes. Not yet implemented. Optional.</para>
    34163605                </glossdef>
    34173606              </glossentry>
    … …  
    34203609                <glossterm><computeroutput>--profile</computeroutput></glossterm>
    34213610                <glossdef>
    3422                   <para>Use a profile. Not implemented yet. Optional.</para>
     3611                  <para>Use a profile. Not yet implemented. Optional.</para>
    34233612                </glossdef>
    34243613              </glossentry>
    … …  
    34703659        <listitem>
    34713660          <para><emphasis role="bold"><computeroutput>copyfrom</computeroutput></emphasis>
    3472           This command enables copying of files from the guest to the host file system.
     3661          Copies files from the guest to the host file system.
    34733662          (Note - only with Guest Additions 4.0 or later installed).</para>
    34743663
    34753664          <screen>VBoxManage guestcontrol &lt;uuid|vmname&gt; copyfrom [common-options]
     3665           [--dryrun] [--follow] [--R|recursive]
    34763666            --target-directory &lt;host-dst-dir&gt;
    3477             [--dryrun] [--follow] [--R|recursive]
    34783667            &lt;guest-src0&gt; [&lt;guest-src1&gt; [...]] </screen>
    34793668
    … …  
    34833672                <glossdef>
    34843673                  <para>Specifies the VM UUID or VM name. Mandatory.</para>
     3674                </glossdef>
     3675              </glossentry>
     3676
     3677              <glossentry>
     3678                <glossterm><computeroutput>--dryrun</computeroutput></glossterm>
     3679                <glossdef>
     3680                  <para>Instructs VBoxManage to perform a dry run instead of an actual file copying
     3681                  operation. Optional. </para>
     3682                </glossdef>
     3683              </glossentry>
     3684
     3685              <glossentry>
     3686                <glossterm><computeroutput>--follow</computeroutput></glossterm>
     3687                <glossdef>
     3688                  <para>Enables symlink following on the guest file system. Optional.</para>
     3689                </glossdef>
     3690              </glossentry>
     3691
     3692              <glossentry>
     3693                <glossterm><computeroutput>-R|--recursive</computeroutput></glossterm>
     3694                <glossdef>
     3695                  <para>Enables recursive copying of files/directories from the specified guest file system
     3696                  directory. Optional.</para>
    34853697                </glossdef>
    34863698              </glossentry>
    … …  
    34913703                  <para>Specifies the absolute path of the host file system destination directory. Mandatory. e.g.
    34923704                  <computeroutput>C:\Temp</computeroutput>.</para>
    3493                 </glossdef>
    3494               </glossentry>
    3495 
    3496               <glossentry>
    3497                 <glossterm><computeroutput>--dryrun</computeroutput></glossterm>
    3498                 <glossdef>
    3499                   <para>Instructs VBoxManage to perform a dry run instead of an actual file copying
    3500                   operation. Optional. </para>
    3501                 </glossdef>
    3502               </glossentry>
    3503 
    3504               <glossentry>
    3505                 <glossterm><computeroutput>--follow</computeroutput></glossterm>
    3506                 <glossdef>
    3507                   <para>Enables symlink following on the guest file system. Optional.</para>
    3508                 </glossdef>
    3509               </glossentry>
    3510 
    3511               <glossentry>
    3512                 <glossterm><computeroutput>-R|--recursive</computeroutput></glossterm>
    3513                 <glossdef>
    3514                   <para>Enables recursive copying of files/directories from the specified guest file system
    3515                   directory. Optional.</para>
    35163705                </glossdef>
    35173706              </glossentry>
    … …  
    35313720
    35323721        <listitem>
    3533           <para><emphasis role="bold"><computeroutput>copyto</computeroutput></emphasis>,
    3534           Copies from the host to a guest file system.
     3722          <para><emphasis role="bold"><computeroutput>copyto</computeroutput></emphasis>
     3723          Copies files from the host to the guest file system.
    35353724          (Note - only with Guest Additions 4.0 or later installed).</para>
    35363725
    35373726          <screen>VBoxManage guestcontrol &lt;uuid|vmname&gt; copyto [common-options]
     3727           [--dryrun] [--follow] [--R|recursive]
    35383728            --target-directory &lt;guest-dst&gt;
    3539             [--dryrun] [--follow] [--R|recursive]
    35403729            &lt;host-src0&gt; [&lt;host-src1&gt; [...]] </screen>
    35413730
    … …  
    35453734                <glossdef>
    35463735                  <para>Specifies the VM UUID or VM name. Mandatory.</para>
     3736                </glossdef>
     3737              </glossentry>
     3738
     3739              <glossentry>
     3740                <glossterm><computeroutput>--dryrun</computeroutput></glossterm>
     3741                <glossdef>
     3742                  <para>Instructs VBoxManage to perform a dry run instead of an actual file copying
     3743                  operation. Optional. </para>
     3744                </glossdef>
     3745              </glossentry>
     3746
     3747              <glossentry>
     3748                <glossterm><computeroutput>--follow</computeroutput></glossterm>
     3749                <glossdef>
     3750                  <para>Enables symlink following on the host file system. Optional.</para>
     3751                </glossdef>
     3752              </glossentry>
     3753
     3754              <glossentry>
     3755                <glossterm><computeroutput>-R|--recursive</computeroutput></glossterm>
     3756                <glossdef>
     3757                  <para>Enables recursive copying of files/directories from the specified host file system
     3758                  directory(ies). Optional.</para>
    35473759                </glossdef>
    35483760              </glossentry>
    … …  
    35533765                  <para>Specifies the absolute path of the guest file system destination directory. Mandatory. e.g.
    35543766                  <computeroutput>C:\Temp</computeroutput>.</para>
    3555                 </glossdef>
    3556               </glossentry>
    3557 
    3558               <glossentry>
    3559                 <glossterm><computeroutput>--dryrun</computeroutput></glossterm>
    3560                 <glossdef>
    3561                   <para>Instructs VBoxManage to perform a dry run instead of an actual file copying
    3562                   operation. Optional. </para>
    3563                 </glossdef>
    3564               </glossentry>
    3565 
    3566               <glossentry>
    3567                 <glossterm><computeroutput>--follow</computeroutput></glossterm>
    3568                 <glossdef>
    3569                   <para>Enables symlink following on the host file system. Optional.</para>
    3570                 </glossdef>
    3571               </glossentry>
    3572 
    3573               <glossentry>
    3574                 <glossterm><computeroutput>-R|--recursive</computeroutput></glossterm>
    3575                 <glossdef>
    3576                   <para>Enables recursive copying of files/directories from the specified host file system
    3577                   directory(ies). Optional.</para>
    35783767                </glossdef>
    35793768              </glossentry>
    … …  
    35933782
    35943783        <listitem>
    3595           <para><emphasis role="bold"><computeroutput>md|mkdir|createdir|createdirectory</computeroutput></emphasis>,
     3784          <para><emphasis role="bold"><computeroutput>md|mkdir|createdir|createdirectory</computeroutput></emphasis>
    35963785          Creates one or more directory(ies) on the guest file system.
    35973786          (Note - only with Guest Additions 4.0 or later installed).</para>
    35983787
    3599           <screen>VBoxManage guestcontrol &lt;uuid|vmname&gt;  md|mkdir|createdir|createdirectory
    3600             [common-options ]
     3788          <screen>VBoxManage guestcontrol &lt;uuid|vmname&gt;  md|mkdir|createdir|createdirectory [common-options]
    36013789            [--parents] [--mode &lt;mode&gt;]
    3602             &lt;guest directory&gt; [...] </screen>
     3790            &lt;guest-dir0&gt; [&lt;guest-dir1&gt; [...]] </screen>
    36033791
    36043792          <para>Where the parameters are: <glosslist>
    … …  
    36313819
    36323820              <glossentry>
    3633                 <glossterm><computeroutput>&lt;guest directory&gt;... </computeroutput></glossterm>
    3634                 <glossdef>
    3635                   <para>Specifies list of absolute paths of directory(ies) to be created on
     3821                <glossterm><computeroutput>&lt;guest-dir0&gt; [&lt;guest-dir1&gt; [...]]</computeroutput></glossterm>
     3822                <glossdef>
     3823                  <para>Specifies list of absolute path(s) of directory(ies) to be created on
    36363824                  guest file system. Mandatory.
    3637                   e.g. <computeroutput>D:\Foo\Bar</computeroutput> </para>
     3825                  e.g. <computeroutput>D:\Foo\Bar</computeroutput>.</para>
    36383826                  <para>All parent directories must already exist
    36393827                  unless switch <computeroutput>--parents</computeroutput> used.
    … …  
    36523840          Deletes specified guest file system directories. (Only with installed Guest Additions 4.3.2 and later).</para>
    36533841
    3654           <screen>VBoxManage guestcontrol &lt;uuid|vmname&gt; removedirectory|removedir|rmdir [common-options]
    3655             [--recursive|-R]
    3656             &lt;guest directory&gt;...
     3842          <screen>VBoxManage guestcontrol &lt;uuid|vmname&gt; rmdir|removedir|removedirectory [common-options]
     3843           [--recursive|-R]
     3844            &lt;guest-dir0&gt; [&lt;guest-dir1&gt; [...]]
    36573845          </screen>   
    36583846
    … …  
    36733861
    36743862              <glossentry>
    3675                 <glossterm><computeroutput>&lt;guest directory&gt;...</computeroutput></glossterm>
    3676                 <glossdef>
    3677                   <para>Specifies the absolute path(s) of directory(ies) to be deleted on
    3678                   guest file system. Mandatory. Wildcards are allowed. e.g. <computeroutput>D:\Foo\Bar</computeroutput>. 
     3863                <glossterm><computeroutput>&lt;guest-dir0&gt; [&lt;guest-dir1&gt; [...]]</computeroutput></glossterm>
     3864                <glossdef>
     3865                  <para>Specifies list of the absolute path(s) of directory(ies) to be deleted on
     3866                  guest file system. Mandatory. Wildcards are allowed. e.g. <computeroutput>D:\Foo\*Bar</computeroutput>. 
    36793867                  The specified user must have sufficient rights to delete the
    36803868                  specified directory(ies).</para>
    … …  
    36853873
    36863874        <listitem>
    3687           <para><emphasis role="bold"><computeroutput>removefile|rm</computeroutput></emphasis>
     3875          <para><emphasis role="bold"><computeroutput>rm|removefile</computeroutput></emphasis>
    36883876          Deletes specified files on the guest file system. (Only with installed Guest
    36893877          Additions 4.3.2 and later).</para>
    36903878
    3691           <screen>VBoxManage guestcontrol &lt;uuid|vmname&gt; removefile|rm [common-options]
    3692             [-f|--force]
    3693             &lt;guest file&gt;... </screen>
     3879          <screen>VBoxManage guestcontrol &lt;uuid|vmname&gt; rm|removefile [common-options]
     3880           [-f|--force]
     3881            &lt;guest-file0&gt; [&lt;guest-file1&gt; [...]] </screen>
    36943882
    36953883          <para>Where the parameters are: <glosslist>
    … …  
    37093897
    37103898              <glossentry>
    3711                 <glossterm><computeroutput>&lt;guest file&gt;...</computeroutput></glossterm>
    3712                 <glossdef>
    3713                   <para>Specifies absolute path(s) of file(s) to be deleted on guest file system. Mandatory.
    3714                    Wildcards are allowed. e.g. <computeroutput>D:\Foo\Bar\text.txt</computeroutput>. 
     3899                <glossterm><computeroutput>&lt;guest-file0&gt; [&lt;guest-file1&gt; [...]]</computeroutput></glossterm>
     3900                <glossdef>
     3901                  <para>Specifies list of absolute path(s) of file(s) to be deleted on guest file system. Mandatory.
     3902                   Wildcards are allowed. e.g. <computeroutput>D:\Foo\Bar\text*.txt</computeroutput>. 
    37153903                   The specified user should have sufficient rights to delete the specified file(s).</para>
    37163904                </glossdef>
    … …  
    37263914
    37273915          <screen>VBoxManage guestcontrol &lt;uuid|vmname&gt; mv|move|ren|rename [common-options]
    3728             &lt;source&gt;... &lt;dest&gt; </screen>
     3916           &lt;guest-source0&gt; [&lt;guest-source1&gt; [...]] &lt;guest-dest&gt;</screen>
    37293917
    37303918          <para>Where the parameters are: <glosslist>
    … …  
    37373925
    37383926              <glossentry>
    3739                 <glossterm><computeroutput>&lt;source&gt;... </computeroutput></glossterm>
    3740                 <glossdef>
    3741                   <para>Specifies absolute path(s) of file(s) to be moved on guest file system. Mandatory.
    3742                   Wildcards are allowed. The specified user should  have sufficient rights to
     3927                <glossterm><computeroutput>&lt;guest-source0&gt; [&lt;guest-source1&gt; [...]]</computeroutput></glossterm>
     3928                <glossdef>
     3929                  <para>Specifies absolute path(s) of file(s) and/or single directory to be moved/renamed on guest
     3930                  file system. Mandatory.
     3931                  Wildcards are allowed in file names(s). The specified user should have sufficient rights to
    37433932                  access the specified file(s).</para>
    37443933                </glossdef>
    … …  
    37483937                <glossterm><computeroutput>&lt;dest&gt;</computeroutput></glossterm>
    37493938                <glossdef>
    3750                   <para>Specifies the absolute path of the destination file/directory(ies) to which the file(s)
    3751                   are to be moved. This can be a directory, or a file if only one file to be moved. Mandatory.
     3939                  <para>Specifies the absolute path of the destination file/directory to which the file(s)
     3940                  are to be moved. Mandatory. If only one file to be moved, &lt;dest&gt; can be file or directory,
     3941                  else it must be a directory.
    37523942                  The specified user must have sufficient rights to access the destination file/directory.</para>
    37533943                </glossdef>
    … …  
    37643954
    37653955            <screen>VBoxManage guestcontrol &lt;uuid|vmname&gt; mktemp|createtemp|createtemporary [common-options]
    3766             [--directory] [--secure] [--mode &lt;mode&gt;] [--tmpdir &lt;directory&gt;]
     3956           [--directory] [--secure] [--mode &lt;mode&gt;] [--tmpdir &lt;directory&gt;]
    37673957            &lt;template&gt;
    37683958            </screen>
    … …  
    37903980                  <computeroutput>0755</computeroutput>. Operation fails if it cannot be performed securely.
    37913981                  </para>
     3982                </glossdef>
     3983              </glossentry>
     3984
     3985              <glossentry>
     3986                <glossterm><computeroutput>--mode &lt;mode&gt;</computeroutput></glossterm>
     3987                <glossdef>
     3988                  <para>Specifies the permission mode of the specified directory. Optional.
     3989                  Currently only octal modes (e.g. <computeroutput>0755</computeroutput>)
     3990                  are supported.</para>
    37923991                </glossdef>
    37933992              </glossentry>
    … …  
    38054004
    38064005              <glossentry>
    3807                 <glossterm><computeroutput>--mode &lt;mode&gt;</computeroutput></glossterm>
    3808                 <glossdef>
    3809                   <para>Specifies the permission mode of the specified directory. Optional.
    3810                   Currently only octal modes (e.g. <computeroutput>0755</computeroutput>)
    3811                   are supported.</para>
    3812                 </glossdef>
    3813               </glossentry>
    3814 
    3815               <glossentry>
    38164006                <glossterm><computeroutput>&lt;template&gt;</computeroutput></glossterm>
    38174007                <glossdef>
    … …  
    38254015
    38264016        <listitem>
    3827           <para><emphasis role="bold"><computeroutput>stat</computeroutput></emphasis>,
     4017          <para><emphasis role="bold"><computeroutput>stat</computeroutput></emphasis>
    38284018          Displays file or file system status(es) on the guest.</para>
    38294019
    38304020          <screen>VBoxManage guestcontrol &lt;uuid|vmname&gt; stat [common-options]
    3831             &lt;file1&gt;[... filen] </screen>
     4021           &lt;file0&gt; [&lt;file1&gt; [...]]</screen>
    38324022
    38334023          <para>Where the parameters are: <glosslist>
    … …  
    38404030
    38414031              <glossentry>
    3842                 <glossterm><computeroutput>&lt;file1&gt;[... filen]</computeroutput></glossterm>
    3843                 <glossdef>
    3844                   <para>Specifies absolute path(s) of file(s) on guest file system. Mandatory.
     4032                <glossterm><computeroutput>&lt;file0&gt; [&lt;file1&gt; [...]]</computeroutput></glossterm>
     4033                <glossdef>
     4034                  <para>Specifies absolute path(s) of file(s) and/or file system(s) on guest file system. Mandatory.
    38454035                  e.g. <computeroutput>/home/foo/a.out</computeroutput>.
    38464036                  The specified user should have sufficient rights to access
    3847                   the specified file/file system(s).</para>
     4037                  the specified file(s)/file system(s).</para>
    38484038                </glossdef>
    38494039              </glossentry>
    … …  
    38534043    </para>
    38544044
    3855     <para>The second set of subcommands are of the form:</para>
     4045    <para>The second set of subcommands is of the form:</para>
    38564046    <screen>VBoxManage guestcontrol &lt;uuid|vmname&gt; &lt;sub-command&gt;
    3857             [-v|--verbose] [-q|quiet] ...
     4047           [-v|--verbose] [-q|quiet] ...
    38584048    </screen>
    38594049
    … …  
    38804070    <para>The second set of subcommands: <itemizedlist>
    38814071        <listitem>
    3882           <para><emphasis role="bold"><computeroutput>list</computeroutput></emphasis>,
     4072          <para><emphasis role="bold"><computeroutput>list</computeroutput></emphasis>
    38834073          Lists guest control configuration and status data, e.g. open guest sessions,
    38844074          guest processes and files.</para>
    38854075
    38864076          <screen>VBoxManage guestcontrol &lt;uuid|vmname&gt; list [common-opts]
    3887             &lt;all|sessions|processes|files&gt; </screen>
     4077           &lt;all|sessions|processes|files&gt; </screen>
    38884078
    38894079          <para>Where the parameters are: <glosslist>
    … …  
    38944084              </glossdef>
    38954085            </glossentry>
     4086
    38964087            <glossentry>
    38974088              <glossterm><computeroutput>all|sessions|processes|files</computeroutput></glossterm>
    … …  
    39014092              </glossdef>
    39024093            </glossentry>
     4094
    39034095          </glosslist></para>
    39044096        </listitem>
    39054097
    39064098        <listitem>
    3907           <para><emphasis role="bold"><computeroutput>closeprocess</computeroutput></emphasis>,
    3908           Terminates guest processes (specified by PID(s))running in guest session(s)
     4099          <para><emphasis role="bold"><computeroutput>closeprocess</computeroutput></emphasis>
     4100          Terminates guest processes specified by PID(s))running in guest session(s),
    39094101          specified by the session ID or name(s).</para>
    39104102
    39114103          <screen>VBoxManage guestcontrol &lt;uuid|vmname&gt; closeprocess [common-options]
    3912             --session-id &lt;ID&gt; | --session-name &lt;name or pattern&gt;
    3913           &lt;PID1&gt; [... &lt;PID n&gt;] </screen>
     4104           --session-id &lt;ID&gt; | --session-name &lt;name or pattern&gt;
     4105           &lt;PID0&gt; [&lt;PID1&gt; [...]] </screen>
    39144106
    39154107          <para>Where the parameters are: <glosslist>
    … …  
    39294121
    39304122            <glossentry>
    3931               <glossterm><computeroutput>--session-name</computeroutput></glossterm>
     4123              <glossterm><computeroutput>--session-name &lt;name or pattern&gt;</computeroutput></glossterm>
    39324124              <glossdef>
    39334125                <para>Specifies the guest session by its name, or multiple sessions
    … …  
    39374129
    39384130            <glossentry>
    3939               <glossterm><computeroutput>&lt;PID1&gt; [... &lt;PID n&gt;]</computeroutput></glossterm>
     4131              <glossterm><computeroutput>&lt;PID0&gt; [&lt;PID1&gt; [...]]</computeroutput></glossterm>
    39404132              <glossdef>
    39414133                <para>Specifies a list of process identifiers (PIDs) of guest processes to be terminated. Mandatory.</para>
    … …  
    39464138
    39474139        <listitem>
    3948           <para><emphasis role="bold"><computeroutput>closesession</computeroutput></emphasis>,
     4140          <para><emphasis role="bold"><computeroutput>closesession</computeroutput></emphasis>
    39494141          Closes specified guest sessions, specified either by session ID or name.</para>
    39504142
    39514143          <screen>VBoxManage guestcontrol &lt;uuid|vmname&gt; closesession [common-options]
    3952             --session-id &lt;ID&gt;
    3953           | --session-name &lt;name or pattern&gt;
    3954           | --all </screen>
     4144           --session-id &lt;ID&gt; | --session-name &lt;name or pattern&gt; | --all </screen>
    39554145
    39564146          <para>Where the parameters are: <glosslist>
    … …  
    39634153
    39644154            <glossentry>
    3965               <glossterm><computeroutput>--session-id</computeroutput></glossterm>
     4155              <glossterm><computeroutput>--session-id &lt;ID&gt;</computeroutput></glossterm>
    39664156              <glossdef>
    39674157                <para>Specifies the guest session to be closed by ID. Optional.</para>
    … …  
    39704160
    39714161             <glossentry>
    3972               <glossterm><computeroutput>--session-name</computeroutput></glossterm>
     4162              <glossterm><computeroutput>--session-name &lt;name or pattern&gt;</computeroutput></glossterm>
    39734163              <glossdef>
    39744164                <para>Specifies the guest session to be closed by name. Optional.
    … …  
    39934183
    39944184          <screen>VBoxManage guestcontrol &lt;uuid|vmname&gt; updatega|updateadditions|updateguestadditions [common-options]
    3995             [--source "&lt;New .ISO path&gt;"]
    3996             [--wait-start] [-- [&lt;argument1&gt;] ... [&lt;argumentN&gt;]]</screen>
     4185           [--source &lt;New .ISO path&gt;]
     4186           [--wait-start]
     4187           [-- &lt;argument0&gt; [&lt;argument1&gt; [...]]]</screen>
    39974188
    39984189          <para>Where the parameters are: <glosslist>
    … …  
    40054196
    40064197              <glossentry>
    4007                 <glossterm><computeroutput>--source</computeroutput> "&lt;New ISO path&gt;"</glossterm>
    4008                 <glossdef>
    4009                   <para>Specifies the absolute path on guest file system of ISO file for Guest Additions update. Mandatory.</para>
     4198                <glossterm><computeroutput>--source</computeroutput> &lt;New .ISO path&gt;</glossterm>
     4199                <glossdef>
     4200                  <para>Specifies the absolute path on guest file system of the .ISO file for Guest Additions update. Mandatory.</para>
    40104201                </glossdef>
    40114202              </glossentry>
    … …  
    40234214
    40244215              <glossentry>
    4025                 <glossterm><computeroutput>[-- [&lt;argument1&gt;] ... [&lt;argumentN&gt;]]</computeroutput></glossterm>
     4216                <glossterm><computeroutput>[-- &lt;argument0&gt; [&lt;argument1&gt; [...]]]</computeroutput></glossterm>
    40264217                <glossdef>
    40274218                  <para>Specifies optional command line arguments to be supplied to the Guest Additions
    … …  
    40344225
    40354226        <listitem>
    4036           <para><emphasis role="bold"><computeroutput>watch</computeroutput></emphasis>,
     4227          <para><emphasis role="bold"><computeroutput>watch</computeroutput></emphasis>
    40374228          This subcommand prints current guest control activity.</para>
    40384229
Note: See TracChangeset for help on using the changeset viewer.

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