VirtualBox

Ignore:
Timestamp:
Dec 3, 2019 6:44:23 PM (5 years ago)
Author:
vboxsync
Message:

manual: integrate 6.1 drop #10 with minimal manual adjustments (frontmatter for preface and eliminated trailing whitespace)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/manual/en_US/user_GuestAdditions.xml

    r76786 r82350  
    3636      The &product-name; Guest Additions for all supported guest
    3737      operating systems are provided as a single CD-ROM image file which
    38       is called <computeroutput>VBoxGuestAdditions.iso</computeroutput>.
    39       This image file is located in the installation directory of
    40       &product-name;. To install the Guest Additions for a particular
    41       VM, you mount this ISO file in your VM as a virtual CD-ROM and
    42       install from there.
     38      is called <filename>VBoxGuestAdditions.iso</filename>. This image
     39      file is located in the installation directory of &product-name;.
     40      To install the Guest Additions for a particular VM, you mount this
     41      ISO file in your VM as a virtual CD-ROM and install from there.
    4342    </para>
    4443
     
    5655          you with seamless mouse support. You will only have one mouse
    5756          pointer and pressing the Host key is no longer required to
    58           "free" the mouse from being captured by the guest OS. To make
    59           this work, a special mouse driver is installed in the guest
    60           that communicates with the "real" mouse driver on your host
    61           and moves the guest mouse pointer accordingly.
     57          <emphasis>free</emphasis> the mouse from being captured by the
     58          guest OS. To make this work, a special mouse driver is
     59          installed in the guest that communicates with the physical
     60          mouse driver on your host and moves the guest mouse pointer
     61          accordingly.
    6262        </para>
    6363      </listitem>
     
    7171          folder, and &product-name; will make it available to the guest
    7272          operating system as a network share, irrespective of whether
    73           guest actually has a network. See
    74           <xref
    75             linkend="sharedfolders" />.
     73          the guest actually has a network. See
     74          <xref linkend="sharedfolders" />.
    7675        </para>
    7776      </listitem>
     
    118117          <emphasis role="bold">Generic host/guest communication
    119118          channels.</emphasis> The Guest Additions enable you to control
    120           and monitor guest execution. The "guest properties" provide a
    121           generic string-based mechanism to exchange data bits between a
    122           guest and a host, some of which have special meanings for
    123           controlling and monitoring the guest. See
    124           <xref linkend="guestadd-guestprops" />.
     119          and monitor guest execution. The <emphasis>guest
     120          properties</emphasis> provide a generic string-based mechanism
     121          to exchange data bits between a guest and a host, some of
     122          which have special meanings for controlling and monitoring the
     123          guest. See <xref linkend="guestadd-guestprops" />.
    125124        </para>
    126125
     
    148147          differs slightly, the time synchronization service attempts to
    149148          gradually and smoothly adjust the guest time in small
    150           increments to either "catch up" or "lose" time. When the
     149          increments to either catch up or lose time. When the
    151150          difference is too great, for example if a VM paused for hours
    152151          or restored from saved state, the guest time is changed
     
    199198      To disable this update check for the Guest Additions of a given
    200199      virtual machine, set the value of its
    201       <computeroutput>/VirtualBox/GuestAdd/CheckHostVersion</computeroutput>
    202       guest property to <computeroutput>0</computeroutput>. See
     200      <literal>/VirtualBox/GuestAdd/CheckHostVersion</literal> guest
     201      property to <literal>0</literal>. See
    203202      <xref
    204203    linkend="guestadd-guestprops" />.
     
    343342          <listitem>
    344343            <para>
    345               Select <emphasis role="bold">Mount CD/DVD-ROM</emphasis>
     344              Select <emphasis role="bold">Optical Drives</emphasis>
    346345              from the <emphasis role="bold">Devices</emphasis> menu in
    347346              the virtual machine's menu bar and then
    348               <emphasis role="bold">CD/DVD-ROM Image</emphasis>. This
    349               displays the Virtual Media Manager, described in
    350               <xref
    351             linkend="vdis" />.
     347              <emphasis role="bold">Choose/Create a Disk
     348              Image</emphasis>. This displays the Virtual Media Manager,
     349              described in <xref linkend="vdis" />.
    352350            </para>
    353351          </listitem>
     
    358356              <emphasis role="bold">Add</emphasis> and browse your host
    359357              file system for the
    360               <computeroutput>VBoxGuestAdditions.iso</computeroutput>
    361               file.
     358              <filename>VBoxGuestAdditions.iso</filename> file.
    362359            </para>
    363360
     
    368365                  On a Windows host, this file is in the &product-name;
    369366                  installation directory, usually in
    370                   <computeroutput>C:\Program
    371                   files\Oracle\VirtualBox</computeroutput>.
     367                  <filename>C:\Program
     368                  files\Oracle\VirtualBox</filename>.
    372369                </para>
    373370              </listitem>
     
    380377                  <emphasis role="bold">Show Package
    381378                  Contents</emphasis>. The file is located in the
    382                   <computeroutput>Contents/MacOS</computeroutput>
    383                   folder.
     379                  <filename>Contents/MacOS</filename> folder.
    384380                </para>
    385381              </listitem>
     
    388384                <para>
    389385                  On a Linux host, this file is in the
    390                   <computeroutput>additions</computeroutput> folder
    391                   where you installed &product-name;, usually
    392                   <computeroutput>/opt/VirtualBox/</computeroutput>.
     386                  <filename>additions</filename> folder where you
     387                  installed &product-name;, usually
     388                  <filename>/opt/VirtualBox/</filename>.
    393389                </para>
    394390              </listitem>
     
    397393                <para>
    398394                  On Oracle Solaris hosts, this file is in the
    399                   <computeroutput>additions</computeroutput> folder
    400                   where you installed &product-name;, usually
    401                   <computeroutput>/opt/VirtualBox</computeroutput>.
     395                  <filename>additions</filename> folder where you
     396                  installed &product-name;, usually
     397                  <filename>/opt/VirtualBox</filename>.
    402398                </para>
    403399              </listitem>
     
    409405            <para>
    410406              In the Virtual Media Manager, select the ISO file and
    411               click <emphasis role="bold">Select</emphasis> button. This
    412               mounts the ISO file and presents it to your Windows guest
    413               as a CD-ROM.
     407              click the <emphasis role="bold">Add</emphasis> button.
     408              This mounts the ISO file and presents it to your Windows
     409              guest as a CD-ROM.
    414410            </para>
    415411          </listitem>
     
    422418          Additions installation program from the Additions ISO. If the
    423419          Autostart feature has been turned off, choose
    424           <computeroutput>VBoxWindowsAdditions.exe</computeroutput> from
    425           the CD/DVD drive inside the guest to start the installer.
     420          <filename>VBoxWindowsAdditions.exe</filename> from the CD/DVD
     421          drive inside the guest to start the installer.
    426422        </para>
    427423
     
    461457        </para>
    462458
    463         <orderedlist>
     459        <itemizedlist>
    464460
    465461          <listitem>
     
    475471          </listitem>
    476472
    477         </orderedlist>
     473        </itemizedlist>
    478474
    479475        <para>
     
    510506          Installing the code signing certificates on a Windows guest
    511507          can be done automatically. Use the
    512           <computeroutput>VBoxCertUtil.exe</computeroutput> utility from
    513           the <computeroutput>cert</computeroutput> folder on the Guest
    514           Additions installation CD.
     508          <filename>VBoxCertUtil.exe</filename> utility from the
     509          <filename>cert</filename> folder on the Guest Additions
     510          installation CD.
    515511        </para>
    516512
     
    536532            <para>
    537533              Open a command line window on the guest and change to the
    538               <computeroutput>cert</computeroutput> folder on the
    539               &product-name; Guest Additions CD.
     534              <filename>cert</filename> folder on the &product-name;
     535              Guest Additions CD.
    540536            </para>
    541537          </listitem>
     
    577573            driver needs to be installed. To select this driver by
    578574            default, add the command line parameter
    579             <computeroutput>/with_wddm</computeroutput> when invoking
    580             the Windows Guest Additions installer. This is only required
    581             for Vista and Windows 7.
     575            <literal>/with_wddm</literal> when invoking the Windows
     576            Guest Additions installer. This is only required for Vista
     577            and Windows 7.
    582578          </para>
    583579        </note>
     
    616612          a 32-bit system, you must use the appropriate platform
    617613          installer. Use
    618           <computeroutput>VBoxWindowsAdditions-x86.exe</computeroutput>
    619           or
    620           <computeroutput>VBoxWindowsAdditions-amd64.exe</computeroutput>
    621           with the <computeroutput>/extract</computeroutput> parameter.
     614          <filename>VBoxWindowsAdditions-x86.exe</filename> or
     615          <filename>VBoxWindowsAdditions-amd64.exe</filename> with the
     616          <literal>/extract</literal> parameter.
    622617        </para>
    623618
     
    657652        <listitem>
    658653          <para>
    659             Redhat Enterprise Linux as of version 3
     654            Red Hat Enterprise Linux as of version 3
    660655          </para>
    661656        </listitem>
     
    744739          <listitem>
    745740            <para>
    746               Insert the
    747               <computeroutput>VBoxGuestAdditions.iso</computeroutput> CD
     741              Insert the <filename>VBoxGuestAdditions.iso</filename> CD
    748742              file into your Linux guest's virtual CD-ROM drive, as
    749743              described for a Windows guest in
     
    830824          into the virtual CD-ROM drive as described above. Then run the
    831825          installer for the current Guest Additions with the
    832           <computeroutput>uninstall</computeroutput> parameter from the
    833           path that the CD image is mounted on in the guest, as follows:
     826          <literal>uninstall</literal> parameter from the path that the
     827          CD image is mounted on in the guest, as follows:
    834828        </para>
    835829
     
    853847        <para>
    854848          Replace
    855           <computeroutput>/opt/VBoxGuestAdditions-<replaceable>version</replaceable></computeroutput>
     849          <filename>/opt/VBoxGuestAdditions-<replaceable>version</replaceable></filename>
    856850          with the correct Guest Additions installation directory.
    857851        </para>
     
    917911          <listitem>
    918912            <para>
    919               Mount the
    920               <computeroutput>VBoxGuestAdditions.iso</computeroutput>
    921               file as your Oracle Solaris guest's virtual CD-ROM drive,
     913              Mount the <filename>VBoxGuestAdditions.iso</filename> file
     914              as your Oracle Solaris guest's virtual CD-ROM drive,
    922915              exactly the same way as described for a Windows guest in
    923916              <xref
     
    1002995        those for the other platforms. Mount the ISO in OS/2 as
    1003996        described previously. The OS/2 Guest Additions are located in
    1004         the directory <computeroutput>\OS2</computeroutput>.
     997        the directory <filename>\OS2</filename>.
    1005998      </para>
    1006999
    10071000      <para>
    10081001        We do not provide an automatic installer at this time. See the
    1009         <computeroutput>readme.txt</computeroutput> file in the CD-ROM
    1010         directory, which describes how to install the OS/2 Guest
    1011         Additions manually.
     1002        <filename>readme.txt</filename> file in the CD-ROM directory,
     1003        which describes how to install the OS/2 Guest Additions
     1004        manually.
    10121005      </para>
    10131006
     
    10271020      not require networking, only the Guest Additions. Shared folders
    10281021      are supported with Windows 2000 or later, Linux, and Oracle
    1029       Solaris guests. &product-name; release 6.0 includes experimental
    1030       support for Mac OS X and OS/2 guests.
     1022      Solaris guests. &product-name; includes experimental support for
     1023      Mac OS X and OS/2 guests.
    10311024    </para>
    10321025
     
    11041097          the VM is powered off. These can be created using a checkbox
    11051098          in the VirtualBox Manager, or by using the
    1106           <computeroutput>--transient</computeroutput> option of the
    1107           <command>VBoxManage sharedfolder add</command> command.
     1099          <option>--transient</option> option of the <command>VBoxManage
     1100          sharedfolder add</command> command.
    11081101        </para>
    11091102      </listitem>
     
    11161109      read files on the host. By default, shared folders are read-write.
    11171110      Read-only folders can be created using a checkbox in the
    1118       VirtualBox Manager, or with the
    1119       <computeroutput>--readonly</computeroutput> option of the
    1120       <command>VBoxManage sharedfolder add</command> command.
     1111      VirtualBox Manager, or with the <option>--readonly</option> option
     1112      of the <command>VBoxManage sharedfolder add</command> command.
    11211113    </para>
    11221114
     
    11891181
    11901182          <para>
    1191             While <computeroutput>vboxsvr</computeroutput> is a fixed
    1192             name, note that <computeroutput>vboxsrv</computeroutput>
    1193             would also work, replace <replaceable>x:</replaceable> with
    1194             the drive letter that you want to use for the share, and
     1183            While <literal>vboxsvr</literal> is a fixed name, note that
     1184            <literal>vboxsrv</literal> would also work, replace
     1185            <replaceable>x:</replaceable> with the drive letter that you
     1186            want to use for the share, and
    11951187            <replaceable>sharename</replaceable> with the share name
    11961188            specified with <command>VBoxManage</command>.
     
    12071199          <para>
    12081200            To mount a shared folder during boot, add the following
    1209             entry to <computeroutput>/etc/fstab</computeroutput>:
     1201            entry to <filename>/etc/fstab</filename>:
    12101202          </para>
    12111203
     
    12231215            Replace <replaceable>sharename</replaceable>, use a
    12241216            lowercase string, with the share name specified with
    1225             <command>VBoxManage</command> or the GUI. Replace
    1226             <replaceable>mountpoint</replaceable> with the path where
    1227             you want the share to be mounted on the guest, such as
    1228             <computeroutput>/mnt/share</computeroutput>. The usual mount
    1229             rules apply. For example, create this directory first if it
    1230             does not exist yet.
     1217            <command>VBoxManage</command> or the VirtualBox Manager.
     1218            Replace <replaceable>mountpoint</replaceable> with the path
     1219            where you want the share to be mounted on the guest, such as
     1220            <filename>/mnt/share</filename>. The usual mount rules
     1221            apply. For example, create this directory first if it does
     1222            not exist yet.
    12311223          </para>
    12321224
     
    12561248            This option sets the character set used for I/O operations.
    12571249            Note that on Linux guests, if the
    1258             <computeroutput>iocharset</computeroutput> option is not
    1259             specified, then the Guest Additions driver will attempt to
    1260             use the character set specified by the CONFIG_NLS_DEFAULT
    1261             kernel option. If this option is not set either, then UTF-8
    1262             is used.
     1250            <literal>iocharset</literal> option is not specified, then
     1251            the Guest Additions driver will attempt to use the character
     1252            set specified by the CONFIG_NLS_DEFAULT kernel option. If
     1253            this option is not set either, then UTF-8 is used.
    12631254          </para>
    12641255
     
    12721263          <para>
    12731264            The generic mount options, documented in the
    1274             <computeroutput>mount</computeroutput> manual page, apply
    1275             also. Especially useful are the options
    1276             <computeroutput>uid</computeroutput>,
    1277             <computeroutput>gid</computeroutput> and
    1278             <computeroutput>mode</computeroutput>, as they can allow
    1279             access by normal users in read/write mode, depending on the
    1280             settings, even if root has mounted the filesystem.
     1265            <command>mount</command> manual page, apply also. Especially
     1266            useful are the options <literal>uid</literal>,
     1267            <literal>gid</literal> and <literal>mode</literal>, as they
     1268            can allow access by normal users in read/write mode,
     1269            depending on the settings, even if root has mounted the
     1270            filesystem.
    12811271          </para>
    12821272        </listitem>
     
    12941284          <para>
    12951285            As with Windows guests, shared folders can also be accessed
    1296             via UNC using <computeroutput>\\VBoxSF\</computeroutput>,
    1297             <computeroutput>\\VBoxSvr\</computeroutput> or
    1298             <computeroutput>\\VBoxSrv\</computeroutput> as the server
    1299             name and the shared folder name as
    1300             <replaceable>sharename</replaceable>.
     1286            via UNC using <filename>\\VBoxSF\</filename>,
     1287            <filename>\\VBoxSvr\</filename> or
     1288            <filename>\\VBoxSrv\</filename> as the server name and the
     1289            shared folder name as <replaceable>sharename</replaceable>.
    13011290          </para>
    13021291        </listitem>
     
    13321321            <emphasis role="bold">Windows and OS/2 guests.</emphasis>
    13331322            Search for a free drive letter, starting at
    1334             <computeroutput>Z:</computeroutput>. If all drive letters
    1335             are assigned, the folder is not mounted.
     1323            <filename>Z:</filename>. If all drive letters are assigned,
     1324            the folder is not mounted.
    13361325          </para>
    13371326        </listitem>
     
    13411330            <emphasis role="bold">Linux and Oracle Solaris
    13421331            guests.</emphasis> Folders are mounted under the
    1343             <computeroutput>/media</computeroutput> directory. The
    1344             folder name is normalized (no spaces, slashes or colons) and
    1345             is prefixed with <computeroutput>sf_</computeroutput>.
     1332            <filename>/media</filename> directory. The folder name is
     1333            normalized (no spaces, slashes or colons) and is prefixed
     1334            with <filename>sf_</filename>.
    13461335          </para>
    13471336
    13481337          <para>
    13491338            For example, if you have a shared folder called
    1350             <computeroutput>myfiles</computeroutput>, it will appear as
    1351             <computeroutput>/media/sf_myfiles</computeroutput> in the
    1352             guest.
     1339            <filename>myfiles</filename>, it will appear as
     1340            <filename>/media/sf_myfiles</filename> in the guest.
    13531341          </para>
    13541342
    13551343          <para>
    13561344            The guest properties
    1357             <computeroutput>/VirtualBox/GuestAdd/SharedFolders/MountDir</computeroutput>
     1345            <literal>/VirtualBox/GuestAdd/SharedFolders/MountDir</literal>
    13581346            and the more generic
    1359             <computeroutput>/VirtualBox/GuestAdd/SharedFolders/MountPrefix</computeroutput>
     1347            <literal>/VirtualBox/GuestAdd/SharedFolders/MountPrefix</literal>
    13601348            can be used to override the automatic mount directory and
    13611349            prefix. See <xref linkend="guestadd-guestprops" />.
     
    13691357        everyone in a Windows guest, including the guest user. For Linux
    13701358        and Oracle Solaris guests, access is restricted to members of
    1371         the group <computeroutput>vboxsf</computeroutput> and the
    1372         <computeroutput>root</computeroutput> user.
     1359        the group <literal>vboxsf</literal> and the
     1360        <literal>root</literal> user.
    13731361      </para>
    13741362
     
    13831371    <para>
    13841372      &product-name; enables you to drag and drop content from the host
    1385       to the guest, and vice versa. For this to work the latest Guest
    1386       Additions must be installed on the guest.
     1373      to the guest, and vice versa. For this to work the latest version
     1374      of the Guest Additions must be installed on the guest.
    13871375    </para>
    13881376
     
    14391427    <figure id="fig-drag-drop-options">
    14401428      <title>Drag and Drop Menu Options</title>
    1441       <mediaobject>
     1429    <mediaobject>
    14421430        <imageobject>
    14431431          <imagedata align="center" fileref="images/dnd-modes.png"
     
    16171605              <para>
    16181606                3D acceleration with Windows guests requires Windows
    1619                 2000, Windows XP, Vista, or Windows 7. Apart from on
    1620                 Windows 2000 guests, both OpenGL and Direct3D 8/9 are
    1621                 supported on an experimental basis.
     1607                2000 or later. Apart from on Windows 2000 guests, both
     1608                OpenGL and Direct3D 8/9 are supported on an experimental
     1609                basis.
    16221610              </para>
    16231611            </listitem>
     
    16921680        driver must be installed, which is available with the Guest
    16931681        Additions installation. The WDDM driver is not installed by
    1694         default for Vista and Windows 7 guest and must be
     1682        default for Vista and Windows 7 guests and must be
    16951683        <emphasis>manually selected</emphasis> in the Guest Additions
    16961684        installer by clicking <emphasis role="bold">No</emphasis> in the
     
    17011689
    17021690      <para>
    1703         The Aero theme is not enabled by default. To enable it, do the
    1704         following:
    1705       </para>
    1706 
    1707       <itemizedlist>
    1708 
    1709         <listitem>
    1710           <para>
    1711             <emphasis role="bold">Windows Vista guests:</emphasis>
    1712             Right-click on the desktop and select
    1713             <emphasis role="bold">Personalize</emphasis>, then select
    1714             <emphasis role="bold">Windows Color and
    1715             Appearance</emphasis> in the
    1716             <emphasis role="bold">Personalization</emphasis> window. In
    1717             the <emphasis role="bold">Appearance Settings</emphasis>
    1718             dialog, select <emphasis role="bold">Windows Aero</emphasis>
    1719             and click <emphasis role="bold">OK</emphasis>.
    1720           </para>
    1721         </listitem>
    1722 
    1723         <listitem>
    1724           <para>
    1725             <emphasis role="bold">Windows 7 guests:</emphasis>
    1726             Right-click on the desktop and select
    1727             <emphasis role="bold">Personalize</emphasis>. Select any
    1728             Aero theme in the
    1729             <emphasis role="bold">Personalization</emphasis> window.
    1730           </para>
    1731         </listitem>
    1732 
    1733       </itemizedlist>
    1734 
    1735       <para>
    1736         Technically, &product-name; implements this by installing an
    1737         additional hardware 3D driver inside your guest when the Guest
    1738         Additions are installed. This driver acts as a hardware 3D
    1739         driver and reports to the guest operating system that the
    1740         virtual hardware is capable of 3D hardware acceleration. When an
    1741         application in the guest then requests hardware acceleration
    1742         through the OpenGL or Direct3D programming interfaces, these are
    1743         sent to the host through a special communication tunnel
    1744         implemented by &product-name;, and then the
    1745         <emphasis>host</emphasis> performs the requested 3D operation
    1746         using the host's programming interfaces.
     1691        The Aero theme is not enabled by default on Windows. See your
     1692        Windows platform documentation for details of how to enable the
     1693        Aero theme.
     1694      </para>
     1695
     1696      <para>
     1697        Technically, &product-name; implements 3D acceleration by
     1698        installing an additional hardware 3D driver inside the guest
     1699        when the Guest Additions are installed. This driver acts as a
     1700        hardware 3D driver and reports to the guest operating system
     1701        that the virtual hardware is capable of 3D hardware
     1702        acceleration. When an application in the guest then requests
     1703        hardware acceleration through the OpenGL or Direct3D programming
     1704        interfaces, these are sent to the host through a special
     1705        communication tunnel implemented by &product-name;. The
     1706        <emphasis>host</emphasis> then performs the requested 3D
     1707        operation using the host's programming interfaces.
    17471708      </para>
    17481709
     
    18061767        through a special communication tunnel implemented by
    18071768        &product-name;. On the host side, OpenGL is then used to
    1808         implement color space transformation and scaling
     1769        implement color space transformation and scaling.
    18091770      </para>
    18101771
     
    18291790      <listitem>
    18301791        <para>
    1831           Windows guests. Support was added in &product-name; 1.5.
     1792          Windows guests.
    18321793        </para>
    18331794      </listitem>
     
    18361797        <para>
    18371798          Supported Linux or Oracle Solaris guests running the X Window
    1838           System. Support was added with &product-name; 1.6.
     1799          System.
    18391800        </para>
    18401801      </listitem>
     
    18511812    <figure id="fig-seamless-windows">
    18521813      <title>Seamless Windows on a Host Desktop</title>
    1853       <mediaobject>
     1814    <mediaobject>
    18541815        <imageobject>
    18551816          <imagedata align="center" fileref="images/seamless.png" width="14cm" />
     
    19181879      version of the Guest Additions, users that are currently logged
    19191880      into the guest OS, network statistics and more. These predefined
    1920       properties are all prefixed with
    1921       <computeroutput>/VirtualBox/</computeroutput> and organized into a
    1922       hierarchical tree of keys.
     1881      properties are all prefixed with <literal>/VirtualBox/</literal>
     1882      and organized into a hierarchical tree of keys.
    19231883    </para>
    19241884
     
    19401900<screen>$ VBoxManage guestproperty enumerate "Windows Vista III"
    19411901VirtualBox Command Line Management Interface Version <replaceable>version-number</replaceable>
    1942 (C) 2005-2018 Oracle Corporation
     1902(C) 2005-2019 Oracle Corporation
    19431903All rights reserved.
    19441904
     
    19971957    <para>
    19981958      To query the value of a single property, use the
    1999       <computeroutput>get</computeroutput> subcommand as follows:
     1959      <command>get</command> subcommand as follows:
    20001960    </para>
    20011961
    20021962<screen>$ VBoxManage guestproperty get "Windows Vista III" "/VirtualBox/GuestInfo/OS/Product"
    20031963VirtualBox Command Line Management Interface Version <replaceable>version-number</replaceable>
    2004 (C) 2005-2018 Oracle Corporation
     1964(C) 2005-2019 Oracle Corporation
    20051965All rights reserved.
    20061966
     
    20091969    <para>
    20101970      To add or change guest properties from the guest, use the tool
    2011       <computeroutput>VBoxControl</computeroutput>. This tool is
    2012       included in the Guest Additions of &product-name; 2.2 or later.
    2013       When started from a Linux guest, this tool requires root
    2014       privileges for security reasons:
     1971      <command>VBoxControl</command>. This tool is included in the Guest
     1972      Additions. When started from a Linux guest, this tool requires
     1973      root privileges for security reasons.
    20151974    </para>
    20161975
    20171976<screen>$ sudo VBoxControl guestproperty enumerate
    20181977VirtualBox Guest Additions Command Line Management Interface Version <replaceable>version-number</replaceable>
    2019 (C) 2005-2018 Oracle Corporation
     1978(C) 2005-2019 Oracle Corporation
    20201979All rights reserved.
    20211980
     
    20361995
    20371996      <para>
    2038         The properties
    2039         <computeroutput>/VirtualBox/HostInfo/VBoxVer</computeroutput>,
    2040         <computeroutput>/VirtualBox/HostInfo/VBoxVerExt</computeroutput>
    2041         or <computeroutput>/VirtualBox/HostInfo/VBoxRev</computeroutput>
    2042         can be waited on to detect that the VM state was restored from
    2043         saved state or snapshot:
     1997        The properties <literal>/VirtualBox/HostInfo/VBoxVer</literal>,
     1998        <literal>/VirtualBox/HostInfo/VBoxVerExt</literal> or
     1999        <literal>/VirtualBox/HostInfo/VBoxRev</literal> can be waited on
     2000        to detect that the VM state was restored from saved state or
     2001        snapshot:
    20442002      </para>
    20452003
     
    20482006      <para>
    20492007        Similarly the
    2050         <computeroutput>/VirtualBox/HostInfo/ResumeCounter</computeroutput>
    2051         can be used to detect that a VM was resumed from the paused
    2052         state or saved state.
     2008        <literal>/VirtualBox/HostInfo/ResumeCounter</literal> can be
     2009        used to detect that a VM was resumed from the paused state or
     2010        saved state.
    20532011      </para>
    20542012
     
    20702028    <figure id="fig-guest-control-fm">
    20712029      <title>Guest Control File Manager</title>
    2072       <mediaobject>
     2030    <mediaobject>
    20732031        <imageobject>
    20742032          <imagedata align="center" fileref="images/guest-fm.png"
     
    21652123
    21662124    <para>
    2167       The Guest Additions enable starting of applications inside a VM
    2168       from the host system.
    2169     </para>
    2170 
    2171     <para>
    2172       For this to work, the application needs to be installed inside the
     2125      The Guest Additions enable starting of applications inside a guest
     2126      VM from the host system. This feature can be used to automate
     2127      deployment of software within the guest.
     2128    </para>
     2129
     2130    <para>
     2131      For this to work, the application needs to be installed on the
    21732132      guest. No additional software needs to be installed on the host.
    21742133      Additionally, text mode output to stdout and stderr can be shown
     
    21792138
    21802139    <para>
    2181       This feature can be used to automate deployment of software within
    2182       the guest.
    2183     </para>
    2184 
    2185     <para>
    21862140      The Guest Additions for Windows allow for automatic updating. This
    2187       applies for already installed Guest Additions version 4.0 or
    2188       later. Also, copying files from host to the guest as well as
    2189       remotely creating guest directories is available.
     2141      applies for already installed Guest Additions versions. Also,
     2142      copying files from host to the guest as well as remotely creating
     2143      guest directories is available.
    21902144    </para>
    21912145
     
    22342188              Memory ballooning does not work with large pages enabled.
    22352189              To turn off large pages support for a VM, run
    2236               <computeroutput>VBoxManage modifyvm &lt;VM name&gt;
    2237               --largepages off</computeroutput>
     2190              <command>VBoxManage modifyvm
     2191              <replaceable>vmname</replaceable> --largepages
     2192              off</command>
    22382193            </para>
    22392194          </listitem>
     
    23032258      <para>
    23042259        By default, no balloon memory is allocated. This is a VM
    2305         setting, like other <computeroutput>modifyvm</computeroutput>
    2306         settings, and therefore can only be set while the machine is
    2307         shut down. See <xref
     2260        setting, like other <command>modifyvm</command> settings, and
     2261        therefore can only be set while the machine is shut down. See
     2262        <xref
    23082263      linkend="vboxmanage-modifyvm" />.
    23092264      </para>
     
    23412296        efficiently Page Fusion can reduce the amount of host memory
    23422297        that is in use. It therefore works best if all VMs on a host run
    2343         identical operating systems, such as Windows XP Service Pack 2.
    2344         Instead of having a complete copy of each operating system in
    2345         each VM, Page Fusion identifies the identical memory pages in
    2346         use by these operating systems and eliminates the duplicates,
    2347         sharing host memory between several machines. This is called
    2348         <emphasis>deduplication</emphasis>. If a VM tries to modify a
    2349         page that has been shared with other VMs, a new page is
    2350         allocated again for that VM with a copy of the shared page. This
    2351         is called <emphasis>copy on write</emphasis>. All this is fully
    2352         transparent to the virtual machine.
     2298        identical operating systems. Instead of having a complete copy
     2299        of each operating system in each VM, Page Fusion identifies the
     2300        identical memory pages in use by these operating systems and
     2301        eliminates the duplicates, sharing host memory between several
     2302        machines. This is called <emphasis>deduplication</emphasis>. If
     2303        a VM tries to modify a page that has been shared with other VMs,
     2304        a new page is allocated again for that VM with a copy of the
     2305        shared page. This is called <emphasis>copy on write</emphasis>.
     2306        All this is fully transparent to the virtual machine.
    23532307      </para>
    23542308
     
    24112365      <para>
    24122366        You can observe Page Fusion operation using some metrics.
    2413         <computeroutput>RAM/VMM/Shared</computeroutput> shows the total
    2414         amount of fused pages, whereas the per-VM metric
    2415         <computeroutput>Guest/RAM/Usage/Shared</computeroutput> will
    2416         return the amount of fused memory for a given VM. See
    2417         <xref
    2418         linkend="vboxmanage-metrics" /> for information on
    2419         how to query metrics.
     2367        <literal>RAM/VMM/Shared</literal> shows the total amount of
     2368        fused pages, whereas the per-VM metric
     2369        <literal>Guest/RAM/Usage/Shared</literal> will return the amount
     2370        of fused memory for a given VM. See
     2371        <xref linkend="vboxmanage-metrics" /> for information on how to
     2372        query metrics.
    24202373      </para>
    24212374
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