Changeset 82350 in vbox for trunk/doc/manual/en_US/user_GuestAdditions.xml
- Timestamp:
- Dec 3, 2019 6:44:23 PM (5 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/doc/manual/en_US/user_GuestAdditions.xml
r76786 r82350 36 36 The &product-name; Guest Additions for all supported guest 37 37 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. 43 42 </para> 44 43 … … 56 55 you with seamless mouse support. You will only have one mouse 57 56 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. 62 62 </para> 63 63 </listitem> … … 71 71 folder, and &product-name; will make it available to the guest 72 72 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" />. 76 75 </para> 77 76 </listitem> … … 118 117 <emphasis role="bold">Generic host/guest communication 119 118 channels.</emphasis> The Guest Additions enable you to control 120 and monitor guest execution. The "guest properties" provide a121 generic string-based mechanism to exchange data bits between a122 guest and a host, some of which have special meanings for123 controlling and monitoring the guest. See124 <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" />. 125 124 </para> 126 125 … … 148 147 differs slightly, the time synchronization service attempts to 149 148 gradually and smoothly adjust the guest time in small 150 increments to either "catch up" or "lose"time. When the149 increments to either catch up or lose time. When the 151 150 difference is too great, for example if a VM paused for hours 152 151 or restored from saved state, the guest time is changed … … 199 198 To disable this update check for the Guest Additions of a given 200 199 virtual machine, set the value of its 201 < computeroutput>/VirtualBox/GuestAdd/CheckHostVersion</computeroutput>202 guest property to <computeroutput>0</computeroutput>. See200 <literal>/VirtualBox/GuestAdd/CheckHostVersion</literal> guest 201 property to <literal>0</literal>. See 203 202 <xref 204 203 linkend="guestadd-guestprops" />. … … 343 342 <listitem> 344 343 <para> 345 Select <emphasis role="bold"> Mount CD/DVD-ROM</emphasis>344 Select <emphasis role="bold">Optical Drives</emphasis> 346 345 from the <emphasis role="bold">Devices</emphasis> menu in 347 346 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" />. 352 350 </para> 353 351 </listitem> … … 358 356 <emphasis role="bold">Add</emphasis> and browse your host 359 357 file system for the 360 <computeroutput>VBoxGuestAdditions.iso</computeroutput> 361 file. 358 <filename>VBoxGuestAdditions.iso</filename> file. 362 359 </para> 363 360 … … 368 365 On a Windows host, this file is in the &product-name; 369 366 installation directory, usually in 370 < computeroutput>C:\Program371 files\Oracle\VirtualBox</ computeroutput>.367 <filename>C:\Program 368 files\Oracle\VirtualBox</filename>. 372 369 </para> 373 370 </listitem> … … 380 377 <emphasis role="bold">Show Package 381 378 Contents</emphasis>. The file is located in the 382 <computeroutput>Contents/MacOS</computeroutput> 383 folder. 379 <filename>Contents/MacOS</filename> folder. 384 380 </para> 385 381 </listitem> … … 388 384 <para> 389 385 On a Linux host, this file is in the 390 < computeroutput>additions</computeroutput> folder391 where youinstalled &product-name;, usually392 < computeroutput>/opt/VirtualBox/</computeroutput>.386 <filename>additions</filename> folder where you 387 installed &product-name;, usually 388 <filename>/opt/VirtualBox/</filename>. 393 389 </para> 394 390 </listitem> … … 397 393 <para> 398 394 On Oracle Solaris hosts, this file is in the 399 < computeroutput>additions</computeroutput> folder400 where youinstalled &product-name;, usually401 < computeroutput>/opt/VirtualBox</computeroutput>.395 <filename>additions</filename> folder where you 396 installed &product-name;, usually 397 <filename>/opt/VirtualBox</filename>. 402 398 </para> 403 399 </listitem> … … 409 405 <para> 410 406 In the Virtual Media Manager, select the ISO file and 411 click <emphasis role="bold">Select</emphasis> button. This412 mounts the ISO file and presents it to your Windows guest413 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. 414 410 </para> 415 411 </listitem> … … 422 418 Additions installation program from the Additions ISO. If the 423 419 Autostart feature has been turned off, choose 424 < computeroutput>VBoxWindowsAdditions.exe</computeroutput> from425 the CD/DVDdrive 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. 426 422 </para> 427 423 … … 461 457 </para> 462 458 463 < orderedlist>459 <itemizedlist> 464 460 465 461 <listitem> … … 475 471 </listitem> 476 472 477 </ orderedlist>473 </itemizedlist> 478 474 479 475 <para> … … 510 506 Installing the code signing certificates on a Windows guest 511 507 can be done automatically. Use the 512 < computeroutput>VBoxCertUtil.exe</computeroutput> utility from513 the <computeroutput>cert</computeroutput> folder on the Guest514 Additionsinstallation CD.508 <filename>VBoxCertUtil.exe</filename> utility from the 509 <filename>cert</filename> folder on the Guest Additions 510 installation CD. 515 511 </para> 516 512 … … 536 532 <para> 537 533 Open a command line window on the guest and change to the 538 < computeroutput>cert</computeroutput> folder on the539 &product-name;Guest Additions CD.534 <filename>cert</filename> folder on the &product-name; 535 Guest Additions CD. 540 536 </para> 541 537 </listitem> … … 577 573 driver needs to be installed. To select this driver by 578 574 default, add the command line parameter 579 < computeroutput>/with_wddm</computeroutput> when invoking580 the Windows Guest Additions installer. This is only required581 for Vistaand 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. 582 578 </para> 583 579 </note> … … 616 612 a 32-bit system, you must use the appropriate platform 617 613 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. 622 617 </para> 623 618 … … 657 652 <listitem> 658 653 <para> 659 Red hat Enterprise Linux as of version 3654 Red Hat Enterprise Linux as of version 3 660 655 </para> 661 656 </listitem> … … 744 739 <listitem> 745 740 <para> 746 Insert the 747 <computeroutput>VBoxGuestAdditions.iso</computeroutput> CD 741 Insert the <filename>VBoxGuestAdditions.iso</filename> CD 748 742 file into your Linux guest's virtual CD-ROM drive, as 749 743 described for a Windows guest in … … 830 824 into the virtual CD-ROM drive as described above. Then run the 831 825 installer for the current Guest Additions with the 832 < computeroutput>uninstall</computeroutput> parameter fromthe833 path that theCD 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: 834 828 </para> 835 829 … … 853 847 <para> 854 848 Replace 855 < computeroutput>/opt/VBoxGuestAdditions-<replaceable>version</replaceable></computeroutput>849 <filename>/opt/VBoxGuestAdditions-<replaceable>version</replaceable></filename> 856 850 with the correct Guest Additions installation directory. 857 851 </para> … … 917 911 <listitem> 918 912 <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, 922 915 exactly the same way as described for a Windows guest in 923 916 <xref … … 1002 995 those for the other platforms. Mount the ISO in OS/2 as 1003 996 described previously. The OS/2 Guest Additions are located in 1004 the directory < computeroutput>\OS2</computeroutput>.997 the directory <filename>\OS2</filename>. 1005 998 </para> 1006 999 1007 1000 <para> 1008 1001 We do not provide an automatic installer at this time. See the 1009 < computeroutput>readme.txt</computeroutput> file in the CD-ROM1010 directory, which describes how to install the OS/2 Guest1011 Additionsmanually.1002 <filename>readme.txt</filename> file in the CD-ROM directory, 1003 which describes how to install the OS/2 Guest Additions 1004 manually. 1012 1005 </para> 1013 1006 … … 1027 1020 not require networking, only the Guest Additions. Shared folders 1028 1021 are supported with Windows 2000 or later, Linux, and Oracle 1029 Solaris guests. &product-name; release 6.0 includes experimental1030 support forMac OS X and OS/2 guests.1022 Solaris guests. &product-name; includes experimental support for 1023 Mac OS X and OS/2 guests. 1031 1024 </para> 1032 1025 … … 1104 1097 the VM is powered off. These can be created using a checkbox 1105 1098 in the VirtualBox Manager, or by using the 1106 < computeroutput>--transient</computeroutput> option of the1107 <command>VBoxManagesharedfolder add</command> command.1099 <option>--transient</option> option of the <command>VBoxManage 1100 sharedfolder add</command> command. 1108 1101 </para> 1109 1102 </listitem> … … 1116 1109 read files on the host. By default, shared folders are read-write. 1117 1110 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. 1121 1113 </para> 1122 1114 … … 1189 1181 1190 1182 <para> 1191 While < computeroutput>vboxsvr</computeroutput> is a fixed1192 name, note that <computeroutput>vboxsrv</computeroutput>1193 would also work, replace <replaceable>x:</replaceable> with1194 the drive letter that youwant to use for the share, and1183 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 1195 1187 <replaceable>sharename</replaceable> with the share name 1196 1188 specified with <command>VBoxManage</command>. … … 1207 1199 <para> 1208 1200 To mount a shared folder during boot, add the following 1209 entry to < computeroutput>/etc/fstab</computeroutput>:1201 entry to <filename>/etc/fstab</filename>: 1210 1202 </para> 1211 1203 … … 1223 1215 Replace <replaceable>sharename</replaceable>, use a 1224 1216 lowercase string, with the share name specified with 1225 <command>VBoxManage</command> or the GUI. Replace1226 <replaceable>mountpoint</replaceable> with the path where1227 you want the share to be mounted on the guest, such as1228 < computeroutput>/mnt/share</computeroutput>. The usual mount1229 rules apply. For example, create this directory first if it1230 doesnot 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. 1231 1223 </para> 1232 1224 … … 1256 1248 This option sets the character set used for I/O operations. 1257 1249 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. 1263 1254 </para> 1264 1255 … … 1272 1263 <para> 1273 1264 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. 1281 1271 </para> 1282 1272 </listitem> … … 1294 1284 <para> 1295 1285 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>. 1301 1290 </para> 1302 1291 </listitem> … … 1332 1321 <emphasis role="bold">Windows and OS/2 guests.</emphasis> 1333 1322 Search for a free drive letter, starting at 1334 < computeroutput>Z:</computeroutput>. If all drive letters1335 are assigned,the folder is not mounted.1323 <filename>Z:</filename>. If all drive letters are assigned, 1324 the folder is not mounted. 1336 1325 </para> 1337 1326 </listitem> … … 1341 1330 <emphasis role="bold">Linux and Oracle Solaris 1342 1331 guests.</emphasis> Folders are mounted under the 1343 < computeroutput>/media</computeroutput> directory. The1344 folder name is normalized (no spaces, slashes or colons) and1345 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>. 1346 1335 </para> 1347 1336 1348 1337 <para> 1349 1338 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. 1353 1341 </para> 1354 1342 1355 1343 <para> 1356 1344 The guest properties 1357 < computeroutput>/VirtualBox/GuestAdd/SharedFolders/MountDir</computeroutput>1345 <literal>/VirtualBox/GuestAdd/SharedFolders/MountDir</literal> 1358 1346 and the more generic 1359 < computeroutput>/VirtualBox/GuestAdd/SharedFolders/MountPrefix</computeroutput>1347 <literal>/VirtualBox/GuestAdd/SharedFolders/MountPrefix</literal> 1360 1348 can be used to override the automatic mount directory and 1361 1349 prefix. See <xref linkend="guestadd-guestprops" />. … … 1369 1357 everyone in a Windows guest, including the guest user. For Linux 1370 1358 and Oracle Solaris guests, access is restricted to members of 1371 the group < computeroutput>vboxsf</computeroutput> and the1372 < computeroutput>root</computeroutput> user.1359 the group <literal>vboxsf</literal> and the 1360 <literal>root</literal> user. 1373 1361 </para> 1374 1362 … … 1383 1371 <para> 1384 1372 &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 Guest1386 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. 1387 1375 </para> 1388 1376 … … 1439 1427 <figure id="fig-drag-drop-options"> 1440 1428 <title>Drag and Drop Menu Options</title> 1441 1429 <mediaobject> 1442 1430 <imageobject> 1443 1431 <imagedata align="center" fileref="images/dnd-modes.png" … … 1617 1605 <para> 1618 1606 3D acceleration with Windows guests requires Windows 1619 2000 , Windows XP, Vista, or Windows 7. Apart from on1620 Windows 2000 guests, both OpenGL and Direct3D 8/9 are1621 supported on an experimentalbasis.1607 2000 or later. Apart from on Windows 2000 guests, both 1608 OpenGL and Direct3D 8/9 are supported on an experimental 1609 basis. 1622 1610 </para> 1623 1611 </listitem> … … 1692 1680 driver must be installed, which is available with the Guest 1693 1681 Additions installation. The WDDM driver is not installed by 1694 default for Vista and Windows 7 guest and must be1682 default for Vista and Windows 7 guests and must be 1695 1683 <emphasis>manually selected</emphasis> in the Guest Additions 1696 1684 installer by clicking <emphasis role="bold">No</emphasis> in the … … 1701 1689 1702 1690 <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. 1747 1708 </para> 1748 1709 … … 1806 1767 through a special communication tunnel implemented by 1807 1768 &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. 1809 1770 </para> 1810 1771 … … 1829 1790 <listitem> 1830 1791 <para> 1831 Windows guests. Support was added in &product-name; 1.5.1792 Windows guests. 1832 1793 </para> 1833 1794 </listitem> … … 1836 1797 <para> 1837 1798 Supported Linux or Oracle Solaris guests running the X Window 1838 System. Support was added with &product-name; 1.6.1799 System. 1839 1800 </para> 1840 1801 </listitem> … … 1851 1812 <figure id="fig-seamless-windows"> 1852 1813 <title>Seamless Windows on a Host Desktop</title> 1853 1814 <mediaobject> 1854 1815 <imageobject> 1855 1816 <imagedata align="center" fileref="images/seamless.png" width="14cm" /> … … 1918 1879 version of the Guest Additions, users that are currently logged 1919 1880 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. 1923 1883 </para> 1924 1884 … … 1940 1900 <screen>$ VBoxManage guestproperty enumerate "Windows Vista III" 1941 1901 VirtualBox Command Line Management Interface Version <replaceable>version-number</replaceable> 1942 (C) 2005-201 8Oracle Corporation1902 (C) 2005-2019 Oracle Corporation 1943 1903 All rights reserved. 1944 1904 … … 1997 1957 <para> 1998 1958 To query the value of a single property, use the 1999 <com puteroutput>get</computeroutput> subcommand as follows:1959 <command>get</command> subcommand as follows: 2000 1960 </para> 2001 1961 2002 1962 <screen>$ VBoxManage guestproperty get "Windows Vista III" "/VirtualBox/GuestInfo/OS/Product" 2003 1963 VirtualBox Command Line Management Interface Version <replaceable>version-number</replaceable> 2004 (C) 2005-201 8Oracle Corporation1964 (C) 2005-2019 Oracle Corporation 2005 1965 All rights reserved. 2006 1966 … … 2009 1969 <para> 2010 1970 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. 2015 1974 </para> 2016 1975 2017 1976 <screen>$ sudo VBoxControl guestproperty enumerate 2018 1977 VirtualBox Guest Additions Command Line Management Interface Version <replaceable>version-number</replaceable> 2019 (C) 2005-201 8Oracle Corporation1978 (C) 2005-2019 Oracle Corporation 2020 1979 All rights reserved. 2021 1980 … … 2036 1995 2037 1996 <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: 2044 2002 </para> 2045 2003 … … 2048 2006 <para> 2049 2007 Similarly the 2050 < computeroutput>/VirtualBox/HostInfo/ResumeCounter</computeroutput>2051 can be used to detect that a VM was resumed from the paused2052 s tate 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. 2053 2011 </para> 2054 2012 … … 2070 2028 <figure id="fig-guest-control-fm"> 2071 2029 <title>Guest Control File Manager</title> 2072 2030 <mediaobject> 2073 2031 <imageobject> 2074 2032 <imagedata align="center" fileref="images/guest-fm.png" … … 2165 2123 2166 2124 <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 2173 2132 guest. No additional software needs to be installed on the host. 2174 2133 Additionally, text mode output to stdout and stderr can be shown … … 2179 2138 2180 2139 <para> 2181 This feature can be used to automate deployment of software within2182 the guest.2183 </para>2184 2185 <para>2186 2140 The Guest Additions for Windows allow for automatic updating. This 2187 applies for already installed Guest Additions version 4.0 or2188 later. Also, copying files from host to the guest as well as2189 remotely creatingguest 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. 2190 2144 </para> 2191 2145 … … 2234 2188 Memory ballooning does not work with large pages enabled. 2235 2189 To turn off large pages support for a VM, run 2236 <computeroutput>VBoxManage modifyvm <VM name> 2237 --largepages off</computeroutput> 2190 <command>VBoxManage modifyvm 2191 <replaceable>vmname</replaceable> --largepages 2192 off</command> 2238 2193 </para> 2239 2194 </listitem> … … 2303 2258 <para> 2304 2259 By default, no balloon memory is allocated. This is a VM 2305 setting, like other <com puteroutput>modifyvm</computeroutput>2306 settings, and therefore can only be set while the machine is2307 shut down. See<xref2260 setting, like other <command>modifyvm</command> settings, and 2261 therefore can only be set while the machine is shut down. See 2262 <xref 2308 2263 linkend="vboxmanage-modifyvm" />. 2309 2264 </para> … … 2341 2296 efficiently Page Fusion can reduce the amount of host memory 2342 2297 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. 2353 2307 </para> 2354 2308 … … 2411 2365 <para> 2412 2366 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. 2420 2373 </para> 2421 2374
Note:
See TracChangeset
for help on using the changeset viewer.