- Timestamp:
- Dec 9, 2018 4:48:36 PM (6 years ago)
- Location:
- trunk/doc/manual
- Files:
-
- 7 added
- 33 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/doc/manual/Config.kmk
r73488 r76078 57 57 VBOX_XML_ENTITIES ?= $(VBOX_PATH_MANUAL_OUTBASE)/all-entities.ent 58 58 59 # xsltproc with the catalog trick if applicable. 59 # xsltproc with the catalog trick if applicable (set XML_DEBUG_CATALOG to 60 # non-zero value to debug file/uri resolution through the catalogs, using 61 # one of them is enough, they show the same information). 60 62 ifdef VBOX_XML_CATALOG 61 VBOX_XSLTPROC_WITH_CAT = $(REDIRECT) -E "XML_CATALOG_FILES=$(VBOX_XML_CATALOG)" $1 -- \63 VBOX_XSLTPROC_WITH_CAT = $(REDIRECT) -E "XML_CATALOG_FILES=$(VBOX_XML_CATALOG)" -E "XML_DEBUG_CATALOG=" $1 -- \ 62 64 $(VBOX_XSLTPROC) --nonet --xinclude $(VBOX_XSLTPROC_OPTS) 63 VBOX_XMLLINT_WITH_CAT = $(REDIRECT) -E "XML_CATALOG_FILES=$(VBOX_XML_CATALOG)" - - \65 VBOX_XMLLINT_WITH_CAT = $(REDIRECT) -E "XML_CATALOG_FILES=$(VBOX_XML_CATALOG)" -E "XML_DEBUG_CATALOG=" -- \ 64 66 $(VBOX_XMLLINT) --nonet --xinclude --noout $(VBOX_XMLLINT_OPTS) 65 67 else … … 161 163 ' <delegateSystem systemIdStartString="$(VBOX_PATH_MANUAL_SRC)" catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_MANUAL)"/>' \ 162 164 ' <delegateURI uriStartString="$(VBOX_PATH_MANUAL_SRC)" catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_MANUAL)"/>' \ 165 ' <delegateURI uriStartString="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_SRC)" catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_MANUAL)"/>' \ 163 166 ' <delegateURI uriStartString="$(VBOX_PATH_MANUAL_OUTBASE)" catalog="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_XML_CATALOG_MANUAL)"/>' \ 164 167 '</catalog>' … … 209 212 '<!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd">' \ 210 213 '<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">' \ 214 ' <system systemId="$(VBOX_PATH_MANUAL_SRC)/common/oracle-accessibility-en.xml" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_SRC)/en_US/oracle-accessibility-en.xml"/>' \ 215 ' <system systemId="$(VBOX_PATH_MANUAL_SRC)/common/oracle-legal-notices/oracle-support-en.xml" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_SRC)/en_US/oracle-support-en.xml"/>' \ 211 216 ' <system systemId="$(VBOX_PATH_MANUAL_SRC)/en_US/user_ChangeLogImpl.xml" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_SRC)/user_ChangeLogImpl.xml"/>' \ 212 217 ' <system systemId="$(VBOX_PATH_MANUAL_SRC)/en_US/user_VBoxManage_CommandsOverview.xml" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_OUTBASE)/user_VBoxManage_CommandsOverview.xml"/>' \ … … 219 224 ' <system systemId="$(VBOX_PATH_MANUAL_SRC)/en_US/SDKRef_apiref.xml" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef_apiref.xml"/>' \ 220 225 ' <system systemId="$(VBOX_PATH_MANUAL_SRC)/en_US/all-entities.ent" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_OUTBASE)/all-entities.ent"/>' \ 226 ' <uri name="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_SRC)/en_US/all-entities.ent" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_MANUAL_OUTBASE)/all-entities.ent"/>' \ 221 227 ' <system systemId="$(VBOX_PATH_MANUAL_SRC)/html/docbook.xsl" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK)/html/docbook.xsl"/>' \ 222 228 ' <system systemId="$(VBOX_PATH_MANUAL_SRC)/html/chunk.xsl" uri="file://$(VBOX_FILE_URL_MAYBE_SLASH)$(VBOX_PATH_DOCBOOK)/html/chunk.xsl"/>' \ … … 232 238 $(call MSG_L1,Creating entities $@) 233 239 $(QUIET)$(APPEND) -tn "$@" \ 240 '<!-- Entities for product names -->' \ 241 '<!ENTITY product-version "$(VBOX_VERSION_STRING)">' \ 242 '<!ENTITY product-name "Oracle VM VirtualBox">' \ 243 '<!ENTITY oci "Oracle Cloud Infrastructure">' \ 244 '' \ 245 '<!-- VBox placeholder entities -->' \ 234 246 '<!ENTITY VBOX_PRODUCT SYSTEM "$(VBOX_PATH_MANUAL_SRC)/ent-vbox-product.xml" >' \ 235 247 '<!ENTITY VBOX_VERSION_MAJOR "$(VBOX_VERSION_MAJOR)" >' \ … … 238 250 '<!ENTITY VBOX_VERSION_STRING "$(VBOX_VERSION_STRING)" >' \ 239 251 '<!ENTITY VBOX_VENDOR "$(VBOX_VENDOR)" >' \ 240 '<!ENTITY VBOX_C_YEAR "$(VBOX_C_YEAR)" >' 252 '<!ENTITY VBOX_C_YEAR "$(VBOX_C_YEAR)" >' \ 253 '' \ 254 '<!-- Entities for OTN -->' \ 255 '<!ENTITY otn-base-url "https://www.oracle.com/technetwork">' \ 256 '<!ENTITY otn-doc-tab "&otn-base-url;/server-storage/virtualbox/documentation/index.html">' 241 257 242 258 endif # VBOX_XML_ENTITIES -
trunk/doc/manual/Makefile.kmk
r73276 r76078 177 177 VBOX_MANUAL_XML_FILES = \ 178 178 UserManual.xml \ 179 user_Preface.xml \ 179 180 user_Introduction.xml \ 180 181 user_Installation.xml \ … … 194 195 user_ThirdParty.xml \ 195 196 user_PrivacyPolicy.xml \ 196 user_Glossary.xml 197 user_Glossary.xml \ 198 oracle-accessibility-en.xml \ 199 oracle-support-en.xml 197 200 198 201 VBOX_MANUAL_XML_FILES_COMMON = \ -
trunk/doc/manual/docbook2latex.xsl
r73276 r76078 289 289 <xsl:param name="texcmd" select="concat('\',name(..))"/> 290 290 <xsl:param name="refid" select="../@id"/> 291 <xsl:param name="role" select="../@role"/> 291 292 292 293 <xsl:call-template name="xsltprocNewlineOutputHack"/> 294 <xsl:if test="$texcmd='\chapter' and $role='frontmatter'"> 295 <xsl:text>\frontmatter
</xsl:text> 296 </xsl:if> 297 <xsl:if test="$texcmd='\chapter' and ../preceding-sibling::*[1][@role='frontmatter']"> 298 <xsl:text>\mainmatter
</xsl:text> 299 </xsl:if> 293 300 <xsl:choose> 294 301 <xsl:when test="$refid"> … … 325 332 <xsl:when test="name(..)='chapter'"> 326 333 <xsl:call-template name="title-wrapper"/> 334 </xsl:when> 335 <xsl:when test="name(..)='sect1' and ../../@role='frontmatter'"> 336 <xsl:call-template name="title-wrapper"> 337 <xsl:with-param name="texcmd">\section*</xsl:with-param> 338 </xsl:call-template> 327 339 </xsl:when> 328 340 <xsl:when test="name(..)='sect1'"> -
trunk/doc/manual/en_US/UserManual.xml
r73276 r76078 9 9 <!-- VBox bookinfo section --> 10 10 11 12 11 <bookinfo> 12 13 13 <title>&VBOX_PRODUCT;</title> 14 14 … … 16 16 17 17 <edition>Version 18 18 &VBOX_VERSION_STRING;</edition> 19 19 20 <corpauthor> Oracle Corporation</corpauthor>20 <corpauthor>&VBOX_VENDOR;</corpauthor> 21 21 22 <address>http s://www.virtualbox.org</address>22 <address>http://www.virtualbox.org</address> 23 23 24 24 <copyright> … … 26 26 <year>2004-&VBOX_C_YEAR;</year> 27 27 28 <holder> Oracle Corporation</holder>28 <holder>&VBOX_VENDOR;</holder> 29 29 30 30 </copyright> 31 31 32 32 </bookinfo> 33 34 35 <xi:include href="user_Preface.xml" 36 xmlns:xi="http://www.w3.org/2001/XInclude" /> 33 37 34 38 <xi:include href="user_Introduction.xml" -
trunk/doc/manual/en_US/user_AdvancedTopics.xml
r75137 r76078 9 9 <title>Advanced Topics</title> 10 10 11 <sect1 id="vboxsdl">12 13 <title>VBoxSDL, The Simplified VM Displayer</title>14 15 <sect2 id="vboxsdl-intro">16 17 <title>Introduction</title>18 19 <para>20 VBoxSDL is a simple graphical user interface (GUI) that lacks21 the nice point-and-click support of the main GUI, VirtualBox.22 VBoxSDL is currently primarily used internally for debugging23 VirtualBox and therefore not officially supported. But you may24 find it useful for environments where the virtual machines are25 not necessarily controlled by the same person that uses the26 virtual machine.27 </para>28 29 <note>30 <para>31 VBoxSDL is not available on the Mac OS X host platform.32 </para>33 </note>34 35 <para>36 As shown in the following screenshot, VBoxSDL provides a simple37 window that contains only the "pure" virtual machine, without38 menus or other controls to click and with no additional39 indicators of virtual machine activity.40 </para>41 42 <para>43 <mediaobject>44 <imageobject>45 <imagedata align="center" fileref="images/vbox-sdl.png"46 width="10cm" />47 </imageobject>48 </mediaobject>49 </para>50 51 <para>52 To start a virtual machine with VBoxSDL instead of the53 VirtualBox GUI, enter the following on a command line:54 </para>55 56 <screen>VBoxSDL --startvm <vm></screen>57 58 <para>59 where <computeroutput><vm></computeroutput> is the name or60 UUID of an existing virtual machine.61 </para>62 63 </sect2>64 65 <sect2 id="vboxsdl-secure-label">66 67 <title>Secure Labeling with VBoxSDL</title>68 69 <para>70 When running guest operating systems in full screen mode, the71 guest operating system usually has control over the whole72 screen. This could present a security risk as the guest73 operating system might fool the user into thinking that it is74 either a different system, which might have a higher security75 level, or it might present messages on the screen that appear to76 stem from the host operating system.77 </para>78 79 <para>80 In order to protect the user against the above mentioned81 security risks, the secure labeling feature has been developed.82 Secure labeling is currently available only for VBoxSDL. When83 enabled, a portion of the display area is reserved for a label84 in which a user defined message is displayed. The label height85 is set to 20 pixels in VBoxSDL. The label font color and86 background color can be optionally set as hexadecimal RGB color87 values. The following syntax is used to enable secure labeling:88 </para>89 90 <screen>VBoxSDL --startvm "VM name"91 --securelabel --seclabelfnt ~/fonts/arial.ttf92 --seclabelsiz 14 --seclabelfgcol 00FF00 --seclabelbgcol 00FFFF</screen>93 94 <para>95 In addition to enabling secure labeling, a TrueType font has to96 be supplied. To use another font size than 12 point use the97 parameter <computeroutput>--seclabelsiz</computeroutput>.98 </para>99 100 <para>101 The label text can be set with:102 </para>103 104 <screen>VBoxManage setextradata "VM name" "VBoxSDL/SecureLabel" "The Label"</screen>105 106 <para>107 Changing this label will take effect immediately.108 </para>109 110 <para>111 Typically, full screen resolutions are limited to certain112 standard geometries such as 1024 x 768. Increasing this by113 twenty lines is not usually feasible, so in most cases, VBoxSDL114 will chose the next higher resolution, such as 1280 x 1024 and115 the guest's screen will not cover the whole display surface. If116 VBoxSDL is unable to choose a higher resolution, the secure117 label will be painted on top of the guest's screen surface. In118 order to address the problem of the bottom part of the guest119 screen being hidden, VBoxSDL can provide custom video modes to120 the guest that are reduced by the height of the label. For121 Windows guests and recent Solaris and Linux guests, the122 VirtualBox Guest Additions automatically provide the reduced123 video modes. Additionally, the VESA BIOS has been adjusted to124 duplicate its standard mode table with adjusted resolutions. The125 adjusted mode IDs can be calculated using the following formula:126 </para>127 128 <screen>reduced_modeid = modeid + 0x30</screen>129 130 <para>131 For example, in order to start Linux with 1024 x 748 x 16, the132 standard mode 0x117 (1024 x 768 x 16) is used as a base. The133 Linux video mode kernel parameter can then be calculated using:134 </para>135 136 <screen>vga = 0x200 | 0x117 + 0x30137 vga = 839</screen>138 139 <para>140 The reason for duplicating the standard modes instead of only141 supplying the adjusted modes is that most guest operating142 systems require the standard VESA modes to be fixed and refuse143 to start with different modes.144 </para>145 146 <para>147 When using the X.org VESA driver, custom modelines have to be148 calculated and added to the configuration, usually in149 <literal>/etc/X11/xorg.conf</literal>. A handy tool to determine150 modeline entries can be found at:151 <ulink152 url="http://www.tkk.fi/Misc/Electronics/faq/vga2rgb/calc.html">http://www.tkk.fi/Misc/Electronics/faq/vga2rgb/calc.html</ulink>.153 </para>154 155 </sect2>156 157 <sect2 id="vboxsdl-modifier-release">158 159 <title>Releasing Modifiers with VBoxSDL on Linux</title>160 161 <para>162 When switching from a X virtual terminal (VT) to another VT163 using Ctrl-Alt-F<replaceable>x</replaceable> while the VBoxSDL164 window has the input focus, the guest will receive Ctrl and Alt165 keypress events without receiving the corresponding key release166 events. This is an architectural limitation of Linux. In order167 to reset the modifier keys, it is possible to send168 <computeroutput>SIGUSR1</computeroutput> to the VBoxSDL main169 thread, the first entry in the170 <computeroutput>ps</computeroutput> list. For example, when171 switching away to another VT and saving the virtual machine from172 this terminal, the following sequence can be used to make sure173 the VM is not saved with stuck modifiers:174 </para>175 176 <screen>kill -usr1 <pid>177 VBoxManage controlvm "Windows 2000" savestate</screen>178 179 </sect2>180 181 </sect1>182 183 11 <sect1 id="autologon"> 184 12 185 <title>Automated Guest Log ons</title>186 187 <para> 188 VirtualBox provides Guest Addition modules for Windows, Linux, and189 Solaris to enable automated logons on the guest.13 <title>Automated Guest Logins</title> 14 15 <para> 16 &product-name; provides Guest Addition modules for Windows, Linux, 17 and Oracle Solaris to enable automated logins on the guest. 190 18 </para> 191 19 192 20 <para> 193 21 When a guest operating system is running in a virtual machine, it 194 might be desirable to perform coordinated and automated log ons195 using credentials from a master log on system. Credentials are user22 might be desirable to perform coordinated and automated logins 23 using credentials from a master login system. Credentials are user 196 24 name, password, and domain name, where each value might be empty. 197 25 </para> … … 199 27 <sect2 id="autologon_win"> 200 28 201 <title>Automated Windows Guest Log ons</title>202 203 <para> 204 Since Windows NT, Windows has provided a modular system log on29 <title>Automated Windows Guest Logins</title> 30 31 <para> 32 Since Windows NT, Windows has provided a modular system login 205 33 subsystem, called Winlogon, which can be customized and extended 206 34 by means of so-called GINA (Graphical Identification and 207 35 Authentication) modules. With Windows Vista and Windows 7, the 208 36 GINA modules were replaced with a new mechanism called 209 credential providers. The VirtualBox Guest Additions for Windows 210 come with both, a GINA and a credential provider module, and 211 therefore enable any Windows guest to perform automated logons. 212 </para> 213 214 <para> 215 To activate the VirtualBox GINA or credential provider module, 216 install the Guest Additions using the command line switch 217 <computeroutput>/with_autologon</computeroutput>. All the 37 credential providers. The &product-name; Guest Additions for 38 Windows come with both, a GINA and a credential provider module, 39 and therefore enable any Windows guest to perform automated 40 logins. 41 </para> 42 43 <para> 44 To activate the &product-name; GINA or credential provider 45 module, install the Guest Additions using the command line 46 switch <computeroutput>/with_autologon</computeroutput>. All the 218 47 following manual steps required for installing these modules 219 48 will be then done by the installer. … … 221 50 222 51 <para> 223 To manually install the VirtualBoxGINA module, extract the52 To manually install the &product-name; GINA module, extract the 224 53 Guest Additions as shown in 225 54 <xref linkend="windows-guest-file-extraction" /> and copy the … … 227 56 Windows <computeroutput>SYSTEM32</computeroutput> directory. 228 57 Then, in the registry, create the following key with a value of 229 <computeroutput>VBoxGINA.dll</computeroutput> .:58 <computeroutput>VBoxGINA.dll</computeroutput>: 230 59 </para> 231 60 … … 234 63 <note> 235 64 <para> 236 The VirtualBox GINA module is implemented as a wrapper around237 the standard Windows GINA module,65 The &product-name; GINA module is implemented as a wrapper 66 around the standard Windows GINA module, 238 67 <computeroutput>MSGINA.DLL</computeroutput>. As a result, it 239 68 may not work correctly with third party GINA modules. … … 242 71 243 72 <para> 244 To manually install the VirtualBox credential provider module,245 extract the Guest Additions as shown in73 To manually install the &product-name; credential provider 74 module, extract the Guest Additions as shown in 246 75 <xref 247 76 linkend="windows-guest-file-extraction" /> and copy … … 249 78 the Windows <computeroutput>SYSTEM32</computeroutput> directory. 250 79 In the registry, create the following keys: 80 </para> 251 81 252 82 <screen>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\ 253 83 Authentication\Credential Providers\{275D3BCC-22BB-4948-A7F6-3A3054EBA92B} 254 84 255 85 HKEY_CLASSES_ROOT\CLSID\{275D3BCC-22BB-4948-A7F6-3A3054EBA92B} 256 86 257 87 HKEY_CLASSES_ROOT\CLSID\{275D3BCC-22BB-4948-A7F6-3A3054EBA92B}\InprocServer32</screen> 258 </para>259 88 260 89 <para> … … 280 109 <para> 281 110 While the VM is running, the credentials can be queried by the 282 VirtualBox logon modules, GINA or credential provider, using the283 VirtualBox Guest Additions device driver. When Windows is in284 <emphasis>logged out</emphasis> mode, the logon modules will285 constantly poll for credentials and if they are present, a logon286 will be attempted. After retrieving the credentials, the logon287 modules will erase them so that the above command will have to288 be repeated for subsequent logons.111 &product-name; login modules, GINA or credential provider, using 112 the &product-name; Guest Additions device driver. When Windows 113 is in <emphasis>logged out</emphasis> mode, the login modules 114 will constantly poll for credentials and if they are present, a 115 login will be attempted. After retrieving the credentials, the 116 login modules will erase them so that the above command will 117 have to be repeated for subsequent logins. 289 118 </para> 290 119 … … 307 136 <para> 308 137 For <emphasis role="bold">Windows XP guests.</emphasis> The 309 log on subsystem needs to be configured to use the classic310 log on dialog as the VirtualBox GINA module does not support311 the XP-style welcome dialog.138 login subsystem needs to be configured to use the classic 139 login dialog, as the &product-name; GINA module does not 140 support the XP-style welcome dialog. 312 141 </para> 313 142 </listitem> … … 315 144 <listitem> 316 145 <para> 317 <emphasis role="bold">Windows Vista, Windows 7, and Windows318 8 guests.</emphasis> The logon subsystem does not support319 the so-called Secure Attention Sequence,146 <emphasis role="bold">Windows Vista, Windows 7, Windows 8, 147 and Windows 10 guests.</emphasis> The login subsystem does 148 not support the so-called Secure Attention Sequence, 320 149 <computeroutput>Ctrl+Alt+Del</computeroutput>. As a result, 321 150 the guest's group policy settings need to be changed to not … … 330 159 <listitem> 331 160 <para> 332 Auto -logon handling of the built-in161 Automatic login handling of the built-in 333 162 <emphasis role="bold">Windows Remote Desktop 334 163 Service</emphasis>, formerly known as Terminal Services, is … … 344 173 345 174 <para> 346 The following command forces VirtualBox to keep the credentials 347 after they were read by the guest and on VM reset: 175 The following command forces &product-name; to keep the 176 credentials after they were read by the guest and on VM reset: 177 </para> 348 178 349 179 <screen>VBoxManage setextradata "Windows XP" VBoxInternal/Devices/VMMDev/0/Config/KeepCredentials 1</screen> 350 180 181 <para> 351 182 Note that this is a potential security risk, as a malicious 352 183 application running on the guest could request this information … … 358 189 <sect2 id="autologon_unix"> 359 190 360 <title>Automated Linux and Unix Guest Logons</title> 361 362 <para> 363 Starting with version 3.2, VirtualBox provides a custom PAM 364 module (Pluggable Authentication Module) which can be used to 365 perform automated guest logons on platforms which support this 366 framework. Virtually all modern Linux and Unix distributions 367 rely on PAM. 368 </para> 369 370 <para> 371 For automated logons on Ubuntu, or Ubuntu-derived, distributions 372 using LightDM as the display manager, see 191 <title>Automated Linux and UNIX Guest Logins</title> 192 193 <para> 194 &product-name; provides a custom PAM module (Pluggable 195 Authentication Module) which can be used to perform automated 196 guest logins on platforms which support this framework. 197 Virtually all modern Linux and UNIX distributions rely on PAM. 198 </para> 199 200 <para> 201 For automated logins on Ubuntu, or Ubuntu-derived, distributions 202 using LightDM as the display manager. See 373 203 <xref linkend="autologon_unix_lightdm" />. 374 204 </para> … … 413 243 For example, to use <computeroutput>pam_vbox.so</computeroutput> 414 244 with a Ubuntu Linux guest OS and the GNOME Desktop Manager (GDM) 415 to log on users automatically with the credentials passed by the245 to log in users automatically with the credentials passed by the 416 246 host, configure the guest OS as follows: 417 247 </para> … … 450 280 <computeroutput>use_first_pass</computeroutput> for 451 281 <computeroutput>pam_unix2.so</computeroutput> is needed in 452 order to pass the credentials from the VirtualBox module to453 t he shadow database authentication module. For Ubuntu, this454 needs to be added to282 order to pass the credentials from the &product-name; module 283 to the shadow database authentication module. For Ubuntu, 284 this needs to be added to 455 285 <computeroutput>/etc/pam.d/common-auth</computeroutput>, to 456 286 the end of the line referencing 457 287 <computeroutput>pam_unix.so</computeroutput>. This argument 458 288 tells the PAM module to use credentials already present in 459 the stack, such as the ones provided by the VirtualBox PAM460 module.289 the stack, such as the ones provided by the &product-name; 290 PAM module. 461 291 </para> 462 292 </listitem> … … 480 310 <note> 481 311 <para> 482 By default, pam_vbox will not wait for credentials to arrive 483 from the host. When a login prompt is shown, for example by 484 GDM/KDM or the text console, and pam_vbox does not yet have 485 credentials it does not wait until they arrive. Instead the 486 next module in the PAM stack, depending on the PAM 487 configuration, will have the chance for authentication. 312 By default, <computeroutput>pam_vbox</computeroutput> will not 313 wait for credentials to arrive from the host. When a login 314 prompt is shown, for example by GDM/KDM or the text console, 315 and pam_vbox does not yet have credentials it does not wait 316 until they arrive. Instead the next module in the PAM stack, 317 depending on the PAM configuration, will have the chance for 318 authentication. 488 319 </para> 489 320 </note> 490 321 491 322 <para> 492 Starting with VirtualBox 4.1.4 pam_vboxsupports various guest493 property parameters which all residein323 <computeroutput>pam_vbox</computeroutput> supports various guest 324 property parameters that are located in 494 325 <computeroutput>/VirtualBox/GuestAdd/PAM/</computeroutput>. 495 326 These parameters allow pam_vbox to wait for credentials to be … … 579 410 <sect3 id="autologon_unix_lightdm"> 580 411 581 <title>VirtualBox Greeter for Ubuntu/LightDM</title> 582 583 <para> 584 Starting with version 4.2.12, VirtualBox comes with an own 585 greeter module named vbox-greeter which can be used with 586 LightDM 1.0.1 or later. LightDM is the default display manager 587 since Ubuntu 10.11 and therefore also can be used for 588 automated guest logons. 589 </para> 590 591 <para> 592 vbox-greeter does not need the pam_vbox module described above 593 in order to function. It comes with its own authentication 594 mechanism provided by LightDM. However, to provide maximum of 595 flexibility both modules can be used together on the same 596 guest. 597 </para> 598 599 <para> 600 As with the pam_vbox module, vbox-greeter is shipped as part 601 of the Guest Additions but it is not installed or activated on 602 the guest OS by default. To install vbox-greeter automatically 603 upon Guest Additions installation, use the 412 <title>&product-name; Greeter for Ubuntu/LightDM</title> 413 414 <para> 415 &product-name; comes with an own greeter module, named 416 vbox-greeter. The module can be used with LightDM 1.0.1 or 417 later. LightDM is the default display manager since Ubuntu 418 10.11 and therefore also can be used for automated guest 419 logins. 420 </para> 421 422 <para> 423 vbox-greeter does not need the 424 <computeroutput>pam_vbox</computeroutput> module described 425 above in order to function. It comes with its own 426 authentication mechanism provided by LightDM. However, to 427 provide maximum of flexibility both modules can be used 428 together on the same guest. 429 </para> 430 431 <para> 432 As with the <computeroutput>pam_vbox</computeroutput> module, 433 vbox-greeter is shipped as part of the Guest Additions but it 434 is not installed or activated on the guest OS by default. To 435 install vbox-greeter automatically upon Guest Additions 436 installation, use the 604 437 <computeroutput>--with-autologon</computeroutput> switch when 605 438 starting the VBoxLinuxAdditions.run file: … … 613 446 to be copied from 614 447 <computeroutput>/opt/VBoxGuestAdditions-<version>/other/</computeroutput> 615 to the <computeroutput>xgreeters</computeroutput> directory ,616 usually448 to the <computeroutput>xgreeters</computeroutput> directory 449 This is usually 617 450 <computeroutput>/usr/share/xgreeters/</computeroutput>. Please 618 451 refer to your guest OS documentation for the correct LightDM … … 622 455 <para> 623 456 The vbox-greeter module itself already was installed by the 624 VirtualBoxGuest Additions installer and resides in457 &product-name; Guest Additions installer and resides in 625 458 <computeroutput>/usr/sbin/</computeroutput>. To enable 626 459 vbox-greeter as the standard greeter module, the file … … 629 462 </para> 630 463 631 <para>632 464 <screen>[SeatDefaults] 633 465 greeter-session=vbox-greeter</screen> 634 </para>635 466 636 467 <note> … … 733 564 <para> 734 565 <computeroutput>Theme/LogonDialog/BackgroundColor</computeroutput>: 735 Hexadecimal RRGGBB color for the log on dialog background.566 Hexadecimal RRGGBB color for the login dialog background. 736 567 This property must be set read-only for the guest 737 568 (<computeroutput>RDONLYGUEST</computeroutput>). … … 742 573 <para> 743 574 <computeroutput>Theme/LogonDialog/ButtonColor</computeroutput>: 744 Hexadecimal RRGGBB background color for the log on dialog575 Hexadecimal RRGGBB background color for the login dialog 745 576 button. This property must be set read-only for the guest 746 577 (<computeroutput>RDONLYGUEST</computeroutput>). … … 784 615 785 616 <para> 786 Starting with VirtualBox 3.2.2, the Guest Additions offer a way787 to launch a system preparation on the guest operating system in788 an automated way, controlledfrom the host system. See617 The Guest Additions offer a way to launch a system preparation 618 on the guest operating system in an automated way, controlled 619 from the host system. See 789 620 <xref linkend="guestadd-guestcontrol" /> for details of how to 790 621 use this feature with the special identifier … … 834 665 <sect1 id="adv-config-linux-guest"> 835 666 836 <title>Advanced Configuration for Linux and Solaris Guests</title>667 <title>Advanced Configuration for Linux and Oracle Solaris Guests</title> 837 668 838 669 <sect2 id="linux-guest-manual-setup"> … … 841 672 842 673 <para> 843 The VirtualBoxGuest Additions contain several different674 The &product-name; Guest Additions contain several different 844 675 drivers. If for any reason you do not wish to set them all up, 845 676 you can install the Guest Additions using the following command: … … 866 697 To setup the time synchronization service, add the service 867 698 vboxadd-service to the default runlevel. To set up the X11 and 868 OpenGL part of the Guest Additions, run the command 699 OpenGL part of the Guest Additions, run the following command: 700 </para> 869 701 870 702 <screen> rcvboxadd-x11 setup</screen> 871 703 704 <para> 872 705 You do not need to enable any services for this. 873 706 </para> … … 875 708 <para> 876 709 To recompile the guest kernel modules, use this command: 710 </para> 877 711 878 712 <screen> rcvboxadd setup</screen> 879 713 714 <para> 880 715 After compilation you should reboot your guest to ensure that 881 716 the new modules are actually used. … … 896 731 897 732 <para> 898 The VirtualBox Guest Additions include the following drivers for899 X.Org versions:733 The &product-name; Guest Additions include the following drivers 734 for X.Org versions: 900 735 </para> 901 736 … … 947 782 load the vboxvideo driver. Many recent X server versions look 948 783 for it automatically if they see that they are running in 949 VirtualBox. For an optimal user experience the guest kernel784 &product-name;. For an optimal user experience the guest kernel 950 785 drivers must be loaded and the Guest Additions tool VBoxClient 951 786 must be running as a client in the X session. For mouse … … 960 795 961 796 <para> 962 The VirtualBoxguest graphics driver can use any graphics797 The &product-name; guest graphics driver can use any graphics 963 798 configuration for which the virtual resolution fits into the 964 799 virtual video memory allocated to the virtual machine, minus a … … 977 812 978 813 <para> 979 With pre-1.3 X Servers you can also add your own modes to the X980 server configuration file. You simply need to add them to the981 "Modes" list in the "Display" subsection of the "Screen"982 section. For example, the following section has a custom983 2048x800 resolution mode added:814 With X Servers before version 1.3, you can also add your own 815 modes to the X server configuration file. You simply need to add 816 them to the "Modes" list in the "Display" subsection of the 817 "Screen" section. For example, the following section has a 818 custom 2048x800 resolution mode added: 984 819 </para> 985 820 … … 1005 840 <para> 1006 841 With virtual machines running modern server operating systems, 1007 VirtualBox supports CPU hot-plugging. 1008 1009 <footnote> 1010 1011 <para> 1012 Support for CPU hot-plugging was introduced with VirtualBox 1013 3.2. 1014 </para> 1015 1016 </footnote> 1017 1018 Whereas on a physical computer this would mean that a CPU can be 1019 added or removed while the machine is running, VirtualBox supports 1020 adding and removing virtual CPUs while a virtual machine is 1021 running. 842 &product-name; supports CPU hot-plugging. 843 </para> 844 845 <para> 846 On a physical computer CPU hot-plugging would mean that a CPU can 847 be added or removed while the machine is running. &product-name; 848 supports adding and removing of virtual CPUs while a virtual 849 machine is running. 1022 850 </para> 1023 851 1024 852 <para> 1025 853 CPU hot-plugging works only with guest operating systems that 1026 support it. So far this applies only to Linux and Windows Server1027 2008 x64 Data Center Edition. Windows supports only hot-add while1028 Linux supports hot-add and hot-remove but to use this feature with1029 more than 8 CPUs a 64bit Linux guest is required.1030 </para> 1031 1032 <para> 1033 At this time, CPU hot-plugging requires using the VBoxManage854 support the feature. So far this applies only to Linux and Windows 855 Server. Windows supports only hot-add, while Linux supports 856 hot-add and hot-remove. To use this feature with more than 8 CPUs, 857 a 64-bit Linux guest is required. 858 </para> 859 860 <para> 861 CPU hot-plugging is done using the <command>VBoxManage</command> 1034 862 command-line interface. First, hot-plugging needs to be enabled 1035 863 for a virtual machine: 864 </para> 1036 865 1037 866 <screen>VBoxManage modifyvm "VM name" --cpuhotplug on</screen> 1038 </para> 1039 1040 <para> 1041 After that, the <computeroutput>--cpus</computeroutput> option 1042 specifies the maximum number of CPUs that the virtual machine can 867 868 <para> 869 The <computeroutput>--cpus</computeroutput> option is used to 870 specify the maximum number of CPUs that the virtual machine can 1043 871 have: 872 </para> 1044 873 1045 874 <screen>VBoxManage modifyvm "VM name" --cpus 8</screen> 1046 875 876 <para> 1047 877 When the VM is off, you can then add and remove virtual CPUs with 1048 878 the <computeroutput>modifyvm --plugcpu</computeroutput> and 1049 879 <computeroutput>--unplugcpu</computeroutput> subcommands, which 1050 take the number of the virtual CPU as a parameter, like this: 880 take the number of the virtual CPU as a parameter, as follows: 881 </para> 1051 882 1052 883 <screen>VBoxManage modifyvm "VM name" --plugcpu 3 1053 884 VBoxManage modifyvm "VM name" --unplugcpu 3</screen> 1054 885 886 <para> 1055 887 Note that CPU 0 can never be removed. 1056 888 </para> … … 1059 891 While the VM is running, CPUs can be added and removed with the 1060 892 <computeroutput>controlvm plugcpu</computeroutput> and 1061 <computeroutput>unplugcpu</computeroutput> commands instead: 893 <computeroutput>unplugcpu</computeroutput> commands instead, as 894 follows: 895 </para> 1062 896 1063 897 <screen>VBoxManage controlvm "VM name" plugcpu 3 1064 898 VBoxManage controlvm "VM name" unplugcpu 3</screen> 1065 </para>1066 899 1067 900 <para> … … 1094 927 1095 928 <para> 1096 When running on Linux hosts, with a recent enough kernel, at least 1097 version <computeroutput>2.6.31</computeroutput>, experimental host 1098 PCI devices passthrough is available. 1099 1100 <footnote> 1101 1102 <para> 1103 Experimental support for PCI passthrough was introduced with 1104 VirtualBox 4.1. 1105 </para> 1106 1107 </footnote> 929 When running on Linux hosts with a kernel version later than 930 <computeroutput>2.6.31</computeroutput>, experimental host PCI 931 devices passthrough is available. 1108 932 </para> 1109 933 1110 934 <note> 1111 935 <para> 1112 The PCI passthrough module is shipped as a VirtualBox extension1113 package, which must be installed separately. See936 The PCI passthrough module is shipped as a &product-name; 937 extension package, which must be installed separately. See 1114 938 <xref 1115 939 linkend="intro-installing" />. … … 1118 942 1119 943 <para> 1120 Essentially this feature allows a guest to directly use physical1121 PCI devices on the host, even if host does not have drivers for1122 this particular device. Both, regular PCI and some PCI Express1123 cards, are supported. AGP and certain PCI Express cards are not1124 supported at the moment if they rely on Graphics Address Remapping1125 Table (GART) unit programming for texture management as it does1126 rather non-trivial operations with pages remapping interfering1127 withIOMMU. This limitation may be lifted in future releases.1128 </para> 1129 1130 <para> 1131 To be fully functional, PCI passthrough support in VirtualBox944 This feature enables a guest to directly use physical PCI devices 945 on the host, even if host does not have drivers for this 946 particular device. Both, regular PCI and some PCI Express cards, 947 are supported. AGP and certain PCI Express cards are not supported 948 at the moment if they rely on Graphics Address Remapping Table 949 (GART) unit programming for texture management as it does rather 950 non-trivial operations with pages remapping interfering with 951 IOMMU. This limitation may be lifted in future releases. 952 </para> 953 954 <para> 955 To be fully functional, PCI passthrough support in &product-name; 1132 956 depends upon an IOMMU hardware unit which is not yet too widely 1133 957 available. If the device uses bus mastering, for example it … … 1209 1033 next step is to select the PCI card and attach it to the guest. To 1210 1034 figure out the list of available PCI devices, use the 1211 <computeroutput>lspci</computeroutput> command. The output will 1212 look as follows: 1035 <command>lspci</command> command. The output will look as follows: 1213 1036 </para> 1214 1037 … … 1242 1065 different PCI address to the card attached during runtime, so 1243 1066 those addresses only apply to the address of the card at the 1244 moment of attachment (host), and during BIOS PCI init (guest). 1067 moment of attachment on the host, and during BIOS PCI init on the 1068 guest. 1245 1069 </para> 1246 1070 … … 1294 1118 1295 1119 <para> 1296 VirtualBox 4.3 includes an experimental feature which allows a1297 guest to use a host webcam. This complements the general USB1298 passthrough support which was the typical way of using host1299 webcams in earlier versions. The webcam passthrough support can1300 handle non-USB video sources in theory, but this is completely1301 untested.1120 &product-name; 4.3 includes an experimental feature which 1121 enables a guest to use a host webcam. This complements the 1122 general USB passthrough support which was the typical way of 1123 using host webcams in earlier versions. The webcam passthrough 1124 support can handle non-USB video sources in theory, but this is 1125 completely untested. 1302 1126 </para> 1303 1127 1304 1128 <note> 1305 1129 <para> 1306 The webcam passthrough module is shipped as part of the Oracle1307 VM VirtualBoxextension pack, which must be installed1130 The webcam passthrough module is shipped as part of the 1131 &product-name; extension pack, which must be installed 1308 1132 separately. See <xref 1309 1133 linkend="intro-installing" />. … … 1312 1136 1313 1137 <para> 1314 The host webcam can be attached to the VM using Devices menu in 1315 the VM menu bar. The Webcams menu contains a list of available 1316 video input devices on the host. Clicking on a webcam name 1317 attaches or detaches the corresponding host device. 1318 </para> 1319 1320 <para> 1321 The VBoxManage command line tool can be used to enable webcam 1322 passthrough. Please see the host-specific sections below for 1323 additional details. The following commands are available: 1138 The host webcam can be attached to the VM using the 1139 <emphasis role="bold">Devices</emphasis> menu in the VM menu 1140 bar. The <emphasis role="bold">Webcams</emphasis> menu contains 1141 a list of available video input devices on the host. Clicking on 1142 a webcam name attaches or detaches the corresponding host 1143 device. 1144 </para> 1145 1146 <para> 1147 The <command>VBoxManage</command> command line tool can be used 1148 to enable webcam passthrough. Please see the host-specific 1149 sections below for additional details. The following commands 1150 are available: 1324 1151 </para> 1325 1152 … … 1350 1177 <listitem> 1351 1178 <para> 1352 Attach a webcam to a running VM: 1179 Attach a webcam to a running VM, as follows: 1180 </para> 1353 1181 1354 1182 <screen>VBoxManage controlvm "VM name" webcam attach [host_path|alias [settings]]</screen> 1355 1183 1356 This will attach a USB webcam device to the guest. 1184 <para> 1185 This attaches a USB webcam device to the guest. 1357 1186 </para> 1358 1187 … … 1396 1225 <listitem> 1397 1226 <para> 1398 Detach a webcam from a running VM: 1227 Detach a webcam from a running VM, as follows: 1228 </para> 1399 1229 1400 1230 <screen>VBoxManage controlvm "VM name" webcam detach [host_path|alias]</screen> 1401 </para>1402 1231 </listitem> 1403 1232 1404 1233 <listitem> 1405 1234 <para> 1406 List the webcams attached to a running VM: 1235 List the webcams attached to a running VM, as follows: 1236 </para> 1407 1237 1408 1238 <screen>VBoxManage controlvm "VM name" webcam list</screen> 1409 1239 1240 <para> 1410 1241 The output contains the path or alias which was used in the 1411 <com puteroutput>webcam attach</computeroutput> command for1412 each attachedwebcam.1242 <command>webcam attach</command> command for each attached 1243 webcam. 1413 1244 </para> 1414 1245 </listitem> … … 1448 1279 <sect2 id="webcam-linux-hosts"> 1449 1280 1450 <title>Linux and Solaris Hosts</title>1281 <title>Linux and Oracle Solaris Hosts</title> 1451 1282 1452 1283 <para> … … 1479 1310 1480 1311 <para> 1481 Apart from the standard VESA resolutions, the VirtualBox VESA1482 BIOS allows you to add up to 16 custom video modes which will be1483 reported to the guest operating system. When using Windows1484 guests with the VirtualBox Guest Additions, a custom graphics1485 driver will be used instead of the fallback VESA solution so1486 this information does not apply.1312 Apart from the standard VESA resolutions, the &product-name; 1313 VESA BIOS enables you to add up to 16 custom video modes which 1314 will be reported to the guest operating system. When using 1315 Windows guests with the &product-name; Guest Additions, a custom 1316 graphics driver will be used instead of the fallback VESA 1317 solution so this information does not apply. 1487 1318 </para> 1488 1319 … … 1490 1321 Additional video modes can be configured for each VM using the 1491 1322 extra data facility. The extra data key is called 1492 < literal>CustomVideoMode<x></literal> with1493 < literal>x</literal> being a number from 1 to 16. Please note1494 that modes will be read from 1 until either the following number1495 is not defined or 16 is reached. The following example adds a1496 video mode that corresponds to the native display resolution of1497 many notebook computers:1323 <computeroutput>CustomVideoMode<x></computeroutput> with 1324 <computeroutput>x</computeroutput> being a number from 1 to 16. 1325 Please note that modes will be read from 1 until either the 1326 following number is not defined or 16 is reached. The following 1327 example adds a video mode that corresponds to the native display 1328 resolution of many notebook computers: 1498 1329 </para> 1499 1330 … … 1502 1333 <para> 1503 1334 The VESA mode IDs for custom video modes start at 1504 < literal>0x160</literal>. In order to use the above defined1505 custom video mode, the following command line has be supplied to1506 Linux:1335 <computeroutput>0x160</computeroutput>. In order to use the 1336 above defined custom video mode, the following command line has 1337 to be supplied to Linux: 1507 1338 </para> 1508 1339 … … 1511 1342 1512 1343 <para> 1513 For guest operating systems with VirtualBox Guest Additions, a 1514 custom video mode can be set using the video mode hint feature. 1344 For guest operating systems with &product-name; Guest Additions, 1345 a custom video mode can be set using the video mode hint 1346 feature. 1515 1347 </para> 1516 1348 … … 1524 1356 <para> 1525 1357 When guest systems with the Guest Additions installed are 1526 started using the graphical frontend, the normal VirtualBox1358 started using the graphical frontend, the normal &product-name; 1527 1359 application, they will not be allowed to use screen resolutions 1528 1360 greater than the host's screen size unless the user manually 1529 1361 resizes them by dragging the window, switching to full screen or 1530 seamless mode or sending a video mode hint using VBoxManage. 1531 This behavior is what most users will want, but if you have 1532 different needs, it is possible to change it by issuing one of 1533 the following commands from the command line: 1362 seamless mode or sending a video mode hint using 1363 <command>VBoxManage</command>. This behavior is what most users 1364 will want, but if you have different needs, it is possible to 1365 change it by issuing one of the following commands from the 1366 command line: 1534 1367 </para> 1535 1368 … … 1566 1399 1567 1400 <para> 1568 Starting with version 1.4, as an alternative to using virtual1569 disk images as described in <xref linkend="storage" />,1570 VirtualBox can also present either entire physical hard disks or1571 selected partitions asvirtual disks to virtual machines.1572 </para> 1573 1574 <para> 1575 With VirtualBox, this type of access is called <emphasis>raw1576 hard disk access</emphasis>. It allows a guest operating system1401 As an alternative to using virtual disk images as described in 1402 <xref linkend="storage" />, &product-name; can also present 1403 either entire physical hard disks or selected partitions as 1404 virtual disks to virtual machines. 1405 </para> 1406 1407 <para> 1408 With &product-name;, this type of access is called <emphasis>raw 1409 hard disk access</emphasis>. It enables a guest operating system 1577 1410 to access its virtual hard disk without going through the host 1578 1411 OS file system. The actual performance difference for image … … 1607 1440 regular virtual disk image. For example, you can use the 1608 1441 VirtualBox Manager, see <xref linkend="vdis" />, or 1609 <com puteroutput>VBoxManage</computeroutput> to assign the image1610 to a virtualmachine.1442 <command>VBoxManage</command> to assign the image to a virtual 1443 machine. 1611 1444 </para> 1612 1445 … … 1630 1463 On a Linux host, to create an image that represents an entire 1631 1464 physical hard disk which will not contain any actual data, as 1632 this will all be stored on the physical disk, use the command 1465 this will all be stored on the physical disk, use the 1466 following command: 1467 </para> 1633 1468 1634 1469 <screen>VBoxManage internalcommands createrawvmdk -filename /path/to/file.vmdk 1635 1470 -rawdisk /dev/sda</screen> 1636 1471 1637 This creates the image <code>/path/to/file.vmdk</code>, which 1472 <para> 1473 This creates the image 1474 <computeroutput>/path/to/file.vmdk</computeroutput>, which 1638 1475 must be an absolute path. All data will be read and written 1639 from <co de>/dev/sda</code>.1476 from <computeroutput>/dev/sda</computeroutput>. 1640 1477 </para> 1641 1478 1642 1479 <para> 1643 1480 On a Windows host, instead of the above device specification, 1644 use e.g. <code>\\.\PhysicalDrive0</code>. On a Mac OS X host, 1645 instead of the above device specification use e.g. 1646 <code>/dev/disk1</code>. Note that on OS X you can only get 1647 access to an entire disk if no volume is mounted from it. 1481 for example use 1482 <computeroutput>\\.\PhysicalDrive0</computeroutput>. On a Mac 1483 OS X host, instead of the above device specification use for 1484 example <computeroutput>/dev/disk1</computeroutput>. Note that 1485 on OS X you can only get access to an entire disk if no volume 1486 is mounted from it. 1648 1487 </para> 1649 1488 … … 1660 1499 automatically attach the newly created image to a virtual 1661 1500 machine. This can be done as follows: 1501 </para> 1662 1502 1663 1503 <screen>VBoxManage storageattach WindowsXP --storagectl "IDE Controller" 1664 1504 --port 0 --device 0 --type hdd --medium /path/to/file.vmdk</screen> 1665 1505 1506 <para> 1666 1507 When this is done the selected virtual machine will boot from 1667 1508 the specified physical disk. … … 1701 1542 except for the additional 1702 1543 <computeroutput>-partitions</computeroutput> parameter. This 1703 example would create the image <code>/path/to/file.vmdk</code> 1704 (which, again, must be absolute), and partitions 1 and 5 of 1705 <code>/dev/sda</code> would be made accessible to the guest. 1706 </para> 1707 1708 <para> 1709 VirtualBox uses the same partition numbering as your Linux 1544 example would create the image 1545 <computeroutput>/path/to/file.vmdk</computeroutput>, which 1546 must be absolute, and partitions 1 and 5 of 1547 <computeroutput>/dev/sda</computeroutput> would be made 1548 accessible to the guest. 1549 </para> 1550 1551 <para> 1552 &product-name; uses the same partition numbering as your Linux 1710 1553 host. As a result, the numbers given in the above example 1711 1554 would refer to the first primary partition and the first … … 1715 1558 <para> 1716 1559 On a Windows host, instead of the above device specification, 1717 use e.g. <code>\\.\PhysicalDrive0</code>. On a Mac OS X host, 1718 instead of the above device specification use 1719 <code>/dev/disk1</code>, for example. Note that on OS X you 1720 can only use partitions which are not mounted. Eject the 1721 respective volume first. Partition numbers are the same on 1722 Linux, Windows, and Mac OS X hosts. 1560 use for example 1561 <computeroutput>\\.\PhysicalDrive0</computeroutput>. On a Mac 1562 OS X host, instead of the above device specification use 1563 <computeroutput>/dev/disk1</computeroutput>, for example. Note 1564 that on OS X you can only use partitions which are not 1565 mounted. Eject the respective volume first. Partition numbers 1566 are the same on Linux, Windows, and Mac OS X hosts. 1723 1567 </para> 1724 1568 1725 1569 <para> 1726 1570 The numbers for the list of partitions can be taken from the 1727 output of 1571 output of the following command: 1572 </para> 1728 1573 1729 1574 <screen>VBoxManage internalcommands listpartitions -rawdisk /dev/sda</screen> 1730 1575 1576 <para> 1731 1577 The output lists the partition types and sizes to give the 1732 1578 user enough information to identify the partitions necessary … … 1757 1603 When used from a virtual machine, the image will then refer 1758 1604 not to the entire disk, but only to the individual partitions. 1759 In this example, <code>/dev/sda1</code> and 1760 <code>/dev/sda5</code>. As a consequence, read/write access is 1761 only required for the affected partitions, not for the entire 1762 disk. During creation however, read-only access to the entire 1763 disk is required to obtain the partitioning information. 1605 In this example, <computeroutput>/dev/sda1</computeroutput> 1606 and <computeroutput>/dev/sda5</computeroutput>. As a 1607 consequence, read/write access is only required for the 1608 affected partitions, not for the entire disk. During creation 1609 however, read-only access to the entire disk is required to 1610 obtain the partitioning information. 1764 1611 </para> 1765 1612 … … 1768 1615 code of the created image. For example, to replace the Linux 1769 1616 boot loader that is used on the host by another boot loader. 1770 This allows for example the guest to boot directly to Windows,1771 while the host boots Linux from the "same" disk. For this1772 purpose the <computeroutput>-mbr</computeroutput> parameter is1773 p rovided. It specifies a file name from which to take the MBR1774 code. The partition table is not modified at all, so a MBR1775 file from a system with totally different partitioning can be1776 used. An example of this is:1617 This enables for example the guest to boot directly to 1618 Windows, while the host boots Linux from the "same" disk. For 1619 this purpose the <computeroutput>-mbr</computeroutput> 1620 parameter is provided. It specifies a file name from which to 1621 take the MBR code. The partition table is not modified at all, 1622 so a MBR file from a system with totally different 1623 partitioning can be used. An example of this is: 1777 1624 </para> 1778 1625 … … 1799 1646 1800 1647 <para> 1801 VirtualBoxreports vendor product data for its virtual hard1648 &product-name; reports vendor product data for its virtual hard 1802 1649 disks which consist of hard disk serial number, firmware 1803 1650 revision and model number. These can be changed using the … … 1863 1710 <sect2 id="iscsi-intnet"> 1864 1711 1865 <title>Access iSCSI Targets viaInternal Networking</title>1866 1867 <para> 1868 As an experimental feature, VirtualBox allows for accessingan1869 iSCSI target running in a virtual machine which is configured 1870 for usingInternal Networking mode. See1712 <title>Access iSCSI Targets Using Internal Networking</title> 1713 1714 <para> 1715 As an experimental feature, &product-name; enables access to an 1716 iSCSI target running in a virtual machine which is configured to 1717 use Internal Networking mode. See 1871 1718 <xref linkend="storage-iscsi" />, 1872 1719 <xref linkend="network_internal" />, and … … 1897 1744 Finally the iSCSI disk must be attached with the 1898 1745 <computeroutput>--intnet</computeroutput> option to tell the 1899 iSCSI initiator to use internal networking: 1746 iSCSI initiator to use internal networking, as follows: 1747 </para> 1900 1748 1901 1749 <screen>VBoxManage storageattach ... --medium iscsi 1902 1750 --server 10.0.9.30 --target iqn.2008-12.com.sun:sampletarget --intnet</screen> 1903 </para>1904 1751 1905 1752 <para> … … 1926 1773 1927 1774 <para> 1928 Starting with version 1.4, VirtualBox provided support for virtual 1929 serial ports, which, at the time, was rather complicated to set up 1930 with a sequence of <computeroutput>VBoxManage 1931 setextradata</computeroutput> statements. Since version 1.5, that 1932 way of setting up serial ports is no longer necessary and 1775 In legacy releases, &product-name; provided support for virtual 1776 serial ports. This was rather complicated to set up, requiring a 1777 sequence of <command>VBoxManage setextradata</command> statements. 1778 That method of setting up serial ports is no longer necessary and 1933 1779 <emphasis>deprecated.</emphasis> To set up virtual serial ports, 1934 use the methods described in <xref 1935 linkend="serialports" />. 1780 use the methods described in <xref linkend="serialports" />. 1936 1781 </para> 1937 1782 1938 1783 <note> 1939 1784 <para> 1940 For backwards compatibility, the old1785 For backwards compatibility, the legacy 1941 1786 <computeroutput>setextradata</computeroutput> statements, whose 1942 1787 description is retained below from the old version of the … … 1949 1794 1950 1795 <para> 1951 The old sequence of configuring a serial port used the following1952 commands:1796 The legacy sequence of configuring a serial port used the 1797 following commands: 1953 1798 </para> 1954 1799 … … 1977 1822 <computeroutput>Location</computeroutput> can be chosen more 1978 1823 freely. Local domain sockets can be placed anywhere, provided the 1979 user running VirtualBox has the permission to create a new file in1980 the directory. The final command above defines that VirtualBox1981 acts as a server. It creates the named pipe itself instead of1982 connecting to an already existing one.1824 user running &product-name; has the permission to create a new 1825 file in the directory. The final command above defines that 1826 &product-name; acts as a server. It creates the named pipe itself 1827 instead of connecting to an already existing one. 1983 1828 </para> 1984 1829 … … 1987 1832 <sect1 id="changenat"> 1988 1833 1989 <title>Fine Tuning the VirtualBoxNAT Engine</title>1834 <title>Fine Tuning the &product-name; NAT Engine</title> 1990 1835 1991 1836 <sect2 id="nat-address-config"> … … 2030 1875 2031 1876 <para> 2032 For network booting in NAT mode, by default VirtualBox uses a2033 built-in TFTP server at the IP address 10.0.2.4. This default1877 For network booting in NAT mode, by default &product-name; uses 1878 a built-in TFTP server at the IP address 10.0.2.4. This default 2034 1879 behavior should work fine for typical remote-booting scenarios. 2035 1880 However, it is possible to change the boot server IP and the 2036 1881 location of the boot image with the following commands: 1882 </para> 2037 1883 2038 1884 <screen>VBoxManage modifyvm "VM name" --nattftpserver1 10.0.2.2 2039 1885 VBoxManage modifyvm "VM name" --nattftpfile1 /srv/tftp/boot/MyPXEBoot.pxe</screen> 2040 </para>2041 1886 2042 1887 </sect2> … … 2047 1892 2048 1893 <para> 2049 The VirtualBox NAT stack performance is often determined by its2050 i nteraction with the host's TCP/IP stack and the size of several2051 buffers (<computeroutput>SO_RCVBUF</computeroutput> and2052 <computeroutput>SO_SNDBUF</computeroutput> ). For certain setups1894 The &product-name; NAT stack performance is often determined by 1895 its interaction with the host's TCP/IP stack and the size of 1896 several buffers, <computeroutput>SO_RCVBUF</computeroutput> and 1897 <computeroutput>SO_SNDBUF</computeroutput>. For certain setups 2053 1898 users might want to adjust the buffer size for a better 2054 1899 performance. This can by achieved using the following commands, 2055 1900 where values are in kilobytes and can range from 8 to 1024: 1901 </para> 2056 1902 2057 1903 <screen>VBoxManage modifyvm "VM name" --natsettings1 16000,128,128,0,0</screen> 2058 1904 1905 <para> 2059 1906 This example illustrates tuning the NAT settings. The first 2060 1907 parameter is the MTU, then the size of the socket's send buffer … … 2077 1924 2078 1925 <para> 2079 By default, VirtualBox's NAT engine will route TCP/IP packets 2080 through the default interface assigned by the host's TCP/IP 2081 stack. The technical reason for this is that the NAT engine uses 2082 sockets for communication. If you want to change this behavior, 2083 you can tell the NAT engine to bind to a particular IP address 2084 instead. Use the following command: 1926 By default, &product-name;'s NAT engine will route TCP/IP 1927 packets through the default interface assigned by the host's 1928 TCP/IP stack. The technical reason for this is that the NAT 1929 engine uses sockets for communication. If you want to change 1930 this behavior, you can tell the NAT engine to bind to a 1931 particular IP address instead. For example, use the following 1932 command: 1933 </para> 2085 1934 2086 1935 <screen>VBoxManage modifyvm "VM name" --natbindip1 "10.45.0.2"</screen> 2087 </para>2088 1936 2089 1937 <para> 2090 1938 After this, all outgoing traffic will be sent through the 2091 interface with the IP address 10.45.0.2. Please make sure that 2092 this interface is up and running prior to this assignment. 1939 interface with the IP address 10.45.0.2. Ensure that this 1940 interface is up and running before changing the NAT bind 1941 address. 2093 1942 </para> 2094 1943 … … 2120 1969 offers a list of registered DNS servers of the host. If for some 2121 1970 reason you need to hide this DNS server list and use the host's 2122 resolver settings, thereby forcing the VirtualBox NAT engine to2123 intercept DNS requests and forward them to host's resolver, use2124 the following command:1971 resolver settings, thereby forcing the &product-name; NAT engine 1972 to intercept DNS requests and forward them to host's resolver, 1973 use the following command: 2125 1974 </para> 2126 1975 … … 2142 1991 In some cases it might be useful to intercept the name 2143 1992 resolving mechanism, providing a user-defined IP address on a 2144 particular DNS request. The intercepting mechanism allows the1993 particular DNS request. The intercepting mechanism enables the 2145 1994 user to map not only a single host but domains and even more 2146 1995 complex naming conventions if required. … … 2209 2058 protocols might need a more transparent behavior or may depend 2210 2059 on the real port number the packet was sent from. It is possible 2211 to change the NAT mode via the VBoxManage frontend with the 2212 following commands: 2060 to change the NAT mode using the <command>VBoxManage</command> 2061 frontend with the following commands: 2062 </para> 2213 2063 2214 2064 <screen>VBoxManage modifyvm "VM name" --nataliasmode1 proxyonly</screen> 2215 2065 2216 and2217 2218 2066 <screen>VBoxManage modifyvm "Linux Guest" --nataliasmode1 sameports</screen> 2219 2067 2068 <para> 2220 2069 The first example disables aliasing and switches NAT into 2221 2070 transparent mode, the second example enforces preserving of port … … 2232 2081 2233 2082 <para> 2234 The DMI data that VirtualBox provides to guests can be changed for2235 a specific VM. Use the following commands to configure the DMI2083 The DMI data that &product-name; provides to guests can be changed 2084 for a specific VM. Use the following commands to configure the DMI 2236 2085 BIOS information. In case your VM is configured to use EFI 2237 firmware you need to replace <code>pcbios</code> by 2238 <code>efi</code> in the keys. 2086 firmware you need to replace 2087 <computeroutput>pcbios</computeroutput> by 2088 <computeroutput>efi</computeroutput> in the keys. 2239 2089 </para> 2240 2090 … … 2347 2197 2348 2198 <para> 2349 If a DMI string is not set, the default value of VirtualBoxis2199 If a DMI string is not set, the default value of &product-name; is 2350 2200 used. To set an empty string use 2351 2201 <computeroutput>"<EMPTY>"</computeroutput>. … … 2370 2220 information of the host to the guest to prevent Windows from 2371 2221 asking for a new product key. On Linux hosts, the DMI BIOS 2372 information can be obtained with: 2222 information can be obtained with the following command: 2223 </para> 2373 2224 2374 2225 <screen>dmidecode -t0</screen> 2375 2226 2376 The DMI system information can be obtained with: 2227 <para> 2228 The DMI system information can be obtained as follows: 2229 </para> 2377 2230 2378 2231 <screen>dmidecode -t1</screen> 2379 </para>2380 2232 2381 2233 </sect1> … … 2386 2238 2387 2239 <para> 2388 VirtualBox can be configured to present up to four custom ACPI tables 2389 to the guest. A command such as the following can be used to configure 2390 custom ACPI tables (note that CustomTable1, CustomTable2, and 2391 CustomTable3 are available in addition to CustomTable0): 2240 &product-name; can be configured to present up to four custom ACPI 2241 tables to the guest. A command such as the following can be used 2242 to configure custom ACPI tables. Note that CustomTable1, 2243 CustomTable2, and CustomTable3 are available in addition to 2244 CustomTable0. 2392 2245 </para> 2393 2246 … … 2396 2249 2397 2250 <para> 2398 Configuring custom ACPI tables can for example avoid the need to 2399 ask for a new product key in Windows Vista/7/8 and later guests. 2400 </para> 2401 2402 <para> 2403 On Linux hosts, one of the system's ACPI tables can be read from 2404 <filename>/sys/firmware/acpi/tables/</filename>. 2251 Configuring custom ACPI tables can for example avoid the need for 2252 asking for a new product key on Windows Vista, Windows 7, Windows 2253 8 and later guests. On Linux hosts, one of the system's ACPI 2254 tables can be read from 2255 <computeroutput>/sys/firmware/acpi/tables/</computeroutput>. 2405 2256 </para> 2406 2257 … … 2417 2268 2418 2269 <para> 2419 By default, VirtualBox keeps all sources of time visible to the2420 guest synchronized to a single time source, the monotonic host2421 time. This reflects the assumptions of many guest operating2270 By default, &product-name; keeps all sources of time visible to 2271 the guest synchronized to a single time source, the monotonic 2272 host time. This reflects the assumptions of many guest operating 2422 2273 systems, which expect all time sources to reflect "wall clock" 2423 2274 time. In special circumstances it may be useful however to make … … 2478 2329 that any time synchronization mechanism will frequently try to 2479 2330 resynchronize the guest clock with the reference clock, which is 2480 the host clock if the VirtualBoxGuest Additions are active.2331 the host clock if the &product-name; Guest Additions are active. 2481 2332 Therefore any time synchronization should be disabled if the 2482 2333 rate of the guest clock is changed as described above. See … … 2491 2342 2492 2343 <para> 2493 The VirtualBox Guest Additions ensure that the guest's system2494 time is synchronized with the host time. There are several2495 parameters which can be tuned. The parameters can be set for a2496 specific VM using the following command:2344 The &product-name; Guest Additions ensure that the guest's 2345 system time is synchronized with the host time. There are 2346 several parameters which can be tuned. The parameters can be set 2347 for a specific VM using the following command: 2497 2348 </para> 2498 2349 … … 2604 2455 <para> 2605 2456 Set the time after the VM was restored from a saved state 2606 when passing 1 as parameter (default). Disable by passing2607 0. In the latter case, the time will be adjusted smoothly2608 which can take a long time.2457 when passing 1 as parameter. This is the default. Disable 2458 by passing 0. In the latter case, the time will be 2459 adjusted smoothly, which can take a long time. 2609 2460 </para> 2610 2461 </listitem> … … 2625 2476 2626 2477 <para> 2627 Once installed and started, the VirtualBox Guest Additions will2628 try to synchronize the guest time with the host time. This can2629 be prevented by forbidding the guest service from reading the2630 host clock:2478 Once installed and started, the &product-name; Guest Additions 2479 will try to synchronize the guest time with the host time. This 2480 can be prevented by forbidding the guest service from reading 2481 the host clock: 2631 2482 </para> 2632 2483 … … 2639 2490 <sect1 id="vboxbowsolaris11"> 2640 2491 2641 <title>Installing the Alternate Bridged Networking Driver on Solaris 11 hosts</title> 2642 2643 <para> 2644 Starting with VirtualBox 4.1, VirtualBox ships a new network 2645 filter driver that utilizes Solaris 11's Crossbow functionality. 2646 By default, this new driver is installed for Solaris 11 hosts 2647 (builds 159 and above) that has support for it. 2492 <title>Installing the Alternate Bridged Networking Driver on Oracle Solaris 11 2493 hosts</title> 2494 2495 <para> 2496 &product-name; includes a network filter driver that utilizes 2497 Oracle Solaris 11's Crossbow functionality. By default, this new 2498 driver is installed for Oracle Solaris 11 hosts, builds 159 and 2499 above, that have support for it. 2648 2500 </para> 2649 2501 … … 2651 2503 To force installation of the older STREAMS based network filter 2652 2504 driver, execute as root the following command before installing 2653 the VirtualBoxpackage:2505 the &product-name; package: 2654 2506 </para> 2655 2507 … … 2659 2511 To force installation of the Crossbow based network filter driver, 2660 2512 execute as root the following command before installing the 2661 VirtualBoxpackage:2513 &product-name; package: 2662 2514 </para> 2663 2515 … … 2665 2517 2666 2518 <para> 2667 To check which driver is currently being used by VirtualBox,2519 To check which driver is currently being used by &product-name;, 2668 2520 execute: 2669 2521 </para> … … 2672 2524 2673 2525 <para> 2674 If the output contains "vboxbow", it indicates VirtualBox is using2675 the Crossbow network filter driver, while the name "vboxflt"2526 If the output contains "vboxbow", it indicates &product-name; is 2527 using the Crossbow network filter driver, while the name "vboxflt" 2676 2528 indicates usage of the older STREAMS network filter. 2677 2529 </para> … … 2681 2533 <sect1 id="vboxbowvnictemplates"> 2682 2534 2683 <title>VirtualBox VNIC Templates for VLANs on Solaris 11 Hosts</title> 2684 2685 <para> 2686 VirtualBox supports Virtual Network Interface (VNIC) templates for 2687 configuring VMs over VLANs. 2688 2689 <footnote> 2690 2691 <para> 2692 Support for Crossbow based bridged networking was introduced 2693 with VirtualBox 4.1 and requires Solaris 11 build 159 or 2694 above. 2695 </para> 2696 2697 </footnote> 2698 2699 A VirtualBox VNIC template is a VNIC whose name starts with 2700 "vboxvnic_template". The string is case-sensitive. 2701 </para> 2702 2703 <para> 2704 On Solaris 11 hosts, a VNIC template may be used to specify the 2705 VLAN ID to use while bridging over a network link. 2706 2707 <footnote> 2708 2709 <para> 2710 When Crossbow based bridged networking is used. 2711 </para> 2712 2713 </footnote> 2714 </para> 2715 2716 <para> 2717 Here is an example of how to use a VNIC template to configure a VM 2718 over a VLAN. Create a VirtualBox VNIC template, by executing as 2719 root: 2535 <title>&product-name; VNIC Templates for VLANs on Oracle Solaris 11 Hosts</title> 2536 2537 <para> 2538 &product-name; supports Virtual Network Interface (VNIC) templates 2539 for configuring VMs over VLANs. An &product-name; VNIC template is 2540 a VNIC whose name starts with 2541 <computeroutput>vboxvnic_template</computeroutput>. The string is 2542 case-sensitive. 2543 </para> 2544 2545 <para> 2546 On Oracle Solaris 11 hosts, when Crossbow-based bridged networking 2547 is used, a VNIC template may be used to specify the VLAN ID to use 2548 while bridging over a network link. 2549 </para> 2550 2551 <para> 2552 The following is an example of how to use a VNIC template to 2553 configure a VM over a VLAN. Create an &product-name; VNIC 2554 template, by executing as root: 2720 2555 </para> 2721 2556 … … 2727 2562 across host reboots, skip the <computeroutput>-t</computeroutput> 2728 2563 parameter in the above command. You may check the current state of 2729 links using: 2730 </para> 2731 2732 <para> 2564 links using the following command: 2565 </para> 2566 2733 2567 <screen>$ dladm show-link 2734 2568 LINK CLASS MTU STATE BRIDGE OVER … … 2740 2574 LINK OVER SPEED MACADDRESS MACADDRTYPE VID 2741 2575 vboxvnic_template0 nge0 1000 2:8:20:25:12:75 random 23</screen> 2742 </para>2743 2576 2744 2577 <para> 2745 2578 Once the VNIC template is created, any VMs that need to be on VLAN 2746 23 over the interface "nge0" can be configured to bridge using2747 this VNIC template.2579 23 over the interface <computeroutput>nge0</computeroutput> can be 2580 configured to bridge using this VNIC template. 2748 2581 </para> 2749 2582 … … 2753 2586 configuration but rather inherited from the VNIC template while 2754 2587 starting the VM. The VNIC template itself can be modified anytime 2755 using <computeroutput>dladm</computeroutput>.2588 using the <command>dladm</command> command. 2756 2589 </para> 2757 2590 2758 2591 <para> 2759 2592 VNIC templates can be created with additional properties such as 2760 bandwidth limits, CPU fanout etc. Refer to your Solaris network2761 documentation on how to accomplish this. These additional2593 bandwidth limits, CPU fanout etc. Refer to your Oracle Solaris 2594 network documentation on how to accomplish this. These additional 2762 2595 properties, if any, are also applied to VMs which bridge using the 2763 2596 VNIC template. … … 2768 2601 <sect1 id="addhostonlysolaris"> 2769 2602 2770 <title>Configuring Multiple Host-Only Network Interfaces on Solaris Hosts</title> 2771 2772 <para> 2773 By default VirtualBox provides you with one host-only network 2774 interface. Adding more host-only network interfaces on Solaris 2775 hosts requires manual configuration. Here is how to add another 2776 host-only network interface. 2603 <title>Configuring Multiple Host-Only Network Interfaces on Oracle Solaris 2604 Hosts</title> 2605 2606 <para> 2607 By default &product-name; provides you with one host-only network 2608 interface. Adding more host-only network interfaces on Oracle 2609 Solaris hosts requires manual configuration. Here is how to add 2610 another host-only network interface. 2777 2611 </para> 2778 2612 … … 2815 2649 2816 2650 <para> 2817 On Solaris 11.1 and newer hosts you may want to rename the default2818 vanity interface name. To check what name has been assigned,2819 execute:2651 On Oracle Solaris 11.1 and newer hosts you may want to rename the 2652 default vanity interface name. To check what name has been 2653 assigned, execute: 2820 2654 </para> 2821 2655 … … 2849 2683 are using NWAM <computeroutput>/etc/nwam/llp</computeroutput> and 2850 2684 add the appropriate entries to set the netmask and static IP for 2851 each of those interfaces. The VirtualBox installer only updates2852 these configuration files for the one "vboxnet0" interface it2853 creates by default.2685 each of those interfaces. The &product-name; installer only 2686 updates these configuration files for the one "vboxnet0" interface 2687 it creates by default. 2854 2688 </para> 2855 2689 … … 2858 2692 <sect1 id="solariscodedumper"> 2859 2693 2860 <title>Configuring the VirtualBox CoreDumper onSolaris Hosts</title>2861 2862 <para> 2863 VirtualBoxis capable of producing its own core files for2694 <title>Configuring the &product-name; CoreDumper on Oracle Solaris Hosts</title> 2695 2696 <para> 2697 &product-name; is capable of producing its own core files for 2864 2698 extensive debugging when things go wrong. Currently this is only 2865 available on Solaris hosts.2866 </para> 2867 2868 <para> 2869 The VirtualBoxCoreDumper can be enabled using the following2699 available on Oracle Solaris hosts. 2700 </para> 2701 2702 <para> 2703 The &product-name; CoreDumper can be enabled using the following 2870 2704 command: 2871 2705 </para> 2872 2706 2873 <para>2874 2707 <screen>VBoxManage setextradata "VM name" VBoxInternal2/CoreDumpEnabled 1</screen> 2875 </para>2876 2708 2877 2709 <para> 2878 2710 You can specify which directory to use for core dumps with this 2879 command: 2880 </para> 2881 2882 <para> 2711 command, as follows: 2712 </para> 2713 2883 2714 <screen>VBoxManage setextradata "VM name" VBoxInternal2/CoreDumpDir <path-to-directory></screen> 2884 2715 2716 <para> 2885 2717 Make sure the directory you specify is on a volume with sufficient 2886 free space and that the VirtualBoxprocess has sufficient2718 free space and that the &product-name; process has sufficient 2887 2719 permissions to write files to this directory. If you skip this 2888 2720 command and do not specify any core dump directory, the current 2889 directory of the VirtualBox executable will be used. This would2890 most likely fail when writing cores as they are protected with2891 root permissions. It is recommended you explicitly set a core dump2892 d irectory.2893 </para> 2894 2895 <para> 2896 You must specify when the VirtualBoxCoreDumper should be2721 directory of the &product-name; executable will be used. This 2722 would most likely fail when writing cores as they are protected 2723 with root permissions. It is recommended you explicitly set a core 2724 dump directory. 2725 </para> 2726 2727 <para> 2728 You must specify when the &product-name; CoreDumper should be 2897 2729 triggered. This is done using the following commands: 2898 2730 </para> 2899 2731 2900 <para>2901 2732 <screen>VBoxManage setextradata "VM name" VBoxInternal2/CoreDumpReplaceSystemDump 1 2902 2733 VBoxManage setextradata "VM name" VBoxInternal2/CoreDumpLive 1</screen> 2903 2734 2735 <para> 2904 2736 At least one of the above two commands will have to be provided if 2905 you have enabled the VirtualBoxCoreDumper.2737 you have enabled the &product-name; CoreDumper. 2906 2738 </para> 2907 2739 … … 2909 2741 Setting <computeroutput>CoreDumpReplaceSystemDump</computeroutput> 2910 2742 sets up the VM to override the host's core dumping mechanism and 2911 in the event of any crash only the VirtualBoxCoreDumper would2743 in the event of any crash only the &product-name; CoreDumper would 2912 2744 produce the core file. 2913 2745 </para> … … 2918 2750 <computeroutput>SIGUSR2</computeroutput> signal. After producing 2919 2751 the core file, the VM will not be terminated and will continue to 2920 run. You can thus take cores of the VM process using :2921 </para>2922 2923 <para> 2752 run. You can thus take cores of the VM process using the following 2753 command: 2754 </para> 2755 2924 2756 <screen>kill -s SIGUSR2 <VM-process-id></screen> 2925 </para> 2926 2927 <para>2928 Core files produced by the VirtualBox CoreDumper are of theform2757 2758 <para> 2759 Core files produced by the &product-name; CoreDumper are of the 2760 form 2929 2761 <computeroutput>core.vb.<ProcessName>.<ProcessID></computeroutput>, 2930 2762 for example … … 2936 2768 <sect1 id="vboxandsolzvmm"> 2937 2769 2938 <title> VirtualBox andSolaris Kernel Zones</title>2939 2940 <para> 2941 Solaris kernel zones on x86-based systems make use of2942 hardware-assisted virtualization features like VirtualBox does.2943 However, for kernel zones and VirtualBox to share this hardware2944 resource, they need to co-operate.2945 </para> 2946 2947 <para> 2948 By default, due to performance reasons, VirtualBox acquires the2949 hardware-assisted virtualization resource (VT-x/AMD-V) globally on2950 the host machine and uses it until the last VirtualBox VM that2951 requires it is powered off. This prevents other software from2952 using VT-x/AMD-V during the time VirtualBox has taken control of2953 it.2954 </para> 2955 2956 <para> 2957 VirtualBoxcan be instructed to relinquish use of2770 <title>&product-name; and Oracle Solaris Kernel Zones</title> 2771 2772 <para> 2773 Oracle Solaris kernel zones on x86-based systems make use of 2774 hardware-assisted virtualization features like &product-name; 2775 does. However, for kernel zones and &product-name; to share this 2776 hardware resource, they need to cooperate. 2777 </para> 2778 2779 <para> 2780 By default, due to performance reasons, &product-name; acquires 2781 the hardware-assisted virtualization resource (VT-x/AMD-V) 2782 globally on the host machine and uses it until the last 2783 &product-name; VM that requires it is powered off. This prevents 2784 other software from using VT-x/AMD-V during the time 2785 &product-name; has taken control of it. 2786 </para> 2787 2788 <para> 2789 &product-name; can be instructed to relinquish use of 2958 2790 hardware-assisted virtualization features when not executing guest 2959 2791 code, thereby allowing kernel zones to make use of them. To do 2960 this, shutdown all VirtualBoxVMs and execute the following2792 this, shutdown all &product-name; VMs and execute the following 2961 2793 command: 2962 2794 </para> … … 2966 2798 <para> 2967 2799 This command needs to be executed only once as the setting is 2968 stored as part of the global VirtualBox settings which will 2969 continue to persist across host-reboots and VirtualBox upgrades. 2800 stored as part of the global &product-name; settings which will 2801 continue to persist across host-reboots and &product-name; 2802 upgrades. 2970 2803 </para> 2971 2804 … … 2974 2807 <sect1 id="guitweaks"> 2975 2808 2976 <title>Locking Down the VirtualBoxGUI</title>2809 <title>Locking Down the &product-name; GUI</title> 2977 2810 2978 2811 <sect2 id="customize-vm-manager"> 2979 2812 2980 <title>Customizing the V MManager</title>2813 <title>Customizing the VirtualBox Manager</title> 2981 2814 2982 2815 <para> 2983 2816 There are several advanced customization settings for locking 2984 down the VirtualBox manager. Locking down means removing some2817 down the VirtualBox Manager. Locking down means removing some 2985 2818 features that the user should not see. 2986 2819 </para> 2987 2820 2988 <para>2989 2821 <screen>VBoxManage setextradata global GUI/Customizations OPTION[,OPTION...]</screen> 2990 </para>2991 2822 2992 2823 <para> … … 3004 2835 <listitem> 3005 2836 <para> 3006 Do not allow users to start the VirtualBox manager. Trying2837 Do not allow users to start the VirtualBox Manager. Trying 3007 2838 to do so will show a window containing a proper error 3008 2839 message. … … 3038 2869 3039 2870 <para> 3040 To disable any of these VM manager customizations do 2871 To disable any of these VM manager customizations use the 2872 following command: 2873 </para> 3041 2874 3042 2875 <screen>VBoxManage setextradata global GUI/Customizations</screen> 3043 </para>3044 2876 3045 2877 </sect2> … … 3084 2916 <listitem> 3085 2917 <para> 3086 Do not allow the user to open the settings dialog for a 2918 Do not allow the user to open the 2919 <emphasis role="bold">Settings</emphasis> dialog for a 3087 2920 certain VM. 3088 2921 </para> … … 3132 2965 <para> 3133 2966 Please note that these settings would not prevent the user from 3134 reconfiguring the VM by <computeroutput>VBoxManage3135 modifyvm</com puteroutput>.2967 reconfiguring the VM by using <command>VBoxManage 2968 modifyvm</command>. 3136 2969 </para> 3137 2970 … … 3163 2996 <listitem> 3164 2997 <para> 3165 Do not show the <emphasis >General</emphasis> settings3166 pane.2998 Do not show the <emphasis role="bold">General</emphasis> 2999 settings pane. 3167 3000 </para> 3168 3001 </listitem> … … 3176 3009 <listitem> 3177 3010 <para> 3178 Do not show the <emphasis>Input</emphasis> settings pane. 3011 Do not show the <emphasis role="bold">Input</emphasis> 3012 settings pane. 3179 3013 </para> 3180 3014 </listitem> … … 3188 3022 <listitem> 3189 3023 <para> 3190 Do not show the <emphasis>Update</emphasis> settings pane. 3024 Do not show the <emphasis role="bold">Update</emphasis> 3025 settings pane. 3191 3026 </para> 3192 3027 </listitem> … … 3200 3035 <listitem> 3201 3036 <para> 3202 Do not show the <emphasis >Language</emphasis> settings3203 pane.3037 Do not show the <emphasis role="bold">Language</emphasis> 3038 settings pane. 3204 3039 </para> 3205 3040 </listitem> … … 3213 3048 <listitem> 3214 3049 <para> 3215 Do not show the <emphasis >Display</emphasis> settings3216 pane.3050 Do not show the <emphasis role="bold">Display</emphasis> 3051 settings pane. 3217 3052 </para> 3218 3053 </listitem> … … 3226 3061 <listitem> 3227 3062 <para> 3228 Do not show the <emphasis >Network</emphasis> settings3229 pane.3063 Do not show the <emphasis role="bold">Network</emphasis> 3064 settings pane. 3230 3065 </para> 3231 3066 </listitem> … … 3239 3074 <listitem> 3240 3075 <para> 3241 Do not show the <emphasis>Extensions</emphasis> settings3242 pane.3076 Do not show the 3077 <emphasis role="bold">Extensions</emphasis> settings pane. 3243 3078 </para> 3244 3079 </listitem> … … 3252 3087 <listitem> 3253 3088 <para> 3254 Do not show the <emphasis>Proxy</emphasis> settings pane. 3089 Do not show the <emphasis role="bold">Proxy</emphasis> 3090 settings pane. 3255 3091 </para> 3256 3092 </listitem> … … 3305 3141 <listitem> 3306 3142 <para> 3307 Do not show the <emphasis >Machine</emphasis> menu in the3308 VM window.3143 Do not show the <emphasis role="bold">Machine</emphasis> 3144 menu in the VM window. 3309 3145 </para> 3310 3146 </listitem> … … 3318 3154 <listitem> 3319 3155 <para> 3320 Do not show the <emphasis >View</emphasis> menu in the VM3321 window.3156 Do not show the <emphasis role="bold">View</emphasis> menu 3157 in the VM window. 3322 3158 </para> 3323 3159 </listitem> … … 3331 3167 <listitem> 3332 3168 <para> 3333 Do not show the <emphasis >Devices</emphasis> menu in the3334 VM window.3169 Do not show the <emphasis role="bold">Devices</emphasis> 3170 menu in the VM window. 3335 3171 </para> 3336 3172 </listitem> … … 3344 3180 <listitem> 3345 3181 <para> 3346 Do not show the <emphasis >Help</emphasis> menu in the VM3347 window.3182 Do not show the <emphasis role="bold">Help</emphasis> menu 3183 in the VM window. 3348 3184 </para> 3349 3185 </listitem> … … 3357 3193 <listitem> 3358 3194 <para> 3359 Do not show the <emphasis >Debug</emphasis> menu in the VM3360 window. The debug menu is only visible if the GUI was3361 started with special command line parameters or3362 environment variable settings.3195 Do not show the <emphasis role="bold">Debug</emphasis> 3196 menu in the VM window. The Debug menu is only visible if 3197 the GUI was started with special command line parameters 3198 or environment variable settings. 3363 3199 </para> 3364 3200 </listitem> … … 3377 3213 You can also disable, or blacklist, certain menu actions of 3378 3214 certain menus. Use the following command to disable certain 3379 actions of the <emphasis >Application</emphasis> menu. This is3380 only available on Mac OS X hosts.3215 actions of the <emphasis role="bold">Application</emphasis> 3216 menu. This is only available on Mac OS X hosts. 3381 3217 </para> 3382 3218 … … 3409 3245 <listitem> 3410 3246 <para> 3411 Do not show the <emphasis >About</emphasis> menu item in3412 this menu.3247 Do not show the <emphasis role="bold">About</emphasis> 3248 menu item in this menu. 3413 3249 </para> 3414 3250 </listitem> … … 3426 3262 <para> 3427 3263 Use the following command to disable certain actions of the 3428 <emphasis >Machine</emphasis> menu:3264 <emphasis role="bold">Machine</emphasis> menu: 3429 3265 </para> 3430 3266 … … 3457 3293 <listitem> 3458 3294 <para> 3459 Do not show the <emphasis >Settings</emphasis> menu item in3460 this menu.3295 Do not show the <emphasis role="bold">Settings</emphasis> 3296 menu item in this menu. 3461 3297 </para> 3462 3298 </listitem> … … 3470 3306 <listitem> 3471 3307 <para> 3472 Do not show the <emphasis >Take Snapshot</emphasis> menu3473 item in this menu.3308 Do not show the <emphasis role="bold">Take 3309 Snapshot</emphasis> menu item in this menu. 3474 3310 </para> 3475 3311 </listitem> … … 3483 3319 <listitem> 3484 3320 <para> 3485 Do not show the <emphasis >Take Screenshot</emphasis> menu3486 item in this menu.3321 Do not show the <emphasis role="bold">Take 3322 Screenshot</emphasis> menu item in this menu. 3487 3323 </para> 3488 3324 </listitem> … … 3496 3332 <listitem> 3497 3333 <para> 3498 Do not show the <emphasis >Session Information</emphasis>3499 menu item in this menu.3334 Do not show the <emphasis role="bold">Session 3335 Information</emphasis> menu item in this menu. 3500 3336 </para> 3501 3337 </listitem> … … 3509 3345 <listitem> 3510 3346 <para> 3511 Do not show the <emphasis >Disable Mouse3347 Do not show the <emphasis role="bold">Disable Mouse 3512 3348 Integration</emphasis> menu item in this menu. 3513 3349 </para> … … 3522 3358 <listitem> 3523 3359 <para> 3524 Do not show the <emphasis >Insert Ctrl+Alt+Del</emphasis>3525 menu item in this menu.3360 Do not show the <emphasis role="bold">Insert 3361 Ctrl+Alt+Del</emphasis> menu item in this menu. 3526 3362 </para> 3527 3363 </listitem> … … 3535 3371 <listitem> 3536 3372 <para> 3537 Do not show the <emphasis >Insert3373 Do not show the <emphasis role="bold">Insert 3538 3374 Ctrl+Alt+Backspace</emphasis> menu item in this menu. 3539 3375 Available on X11 hosts only. … … 3549 3385 <listitem> 3550 3386 <para> 3551 Do not show the <emphasis >Pause</emphasis> menu item in3552 this menu.3387 Do not show the <emphasis role="bold">Pause</emphasis> 3388 menu item in this menu. 3553 3389 </para> 3554 3390 </listitem> … … 3562 3398 <listitem> 3563 3399 <para> 3564 Do not show the <emphasis >Reset</emphasis> menu item in3565 this menu.3400 Do not show the <emphasis role="bold">Reset</emphasis> 3401 menu item in this menu. 3566 3402 </para> 3567 3403 </listitem> … … 3575 3411 <listitem> 3576 3412 <para> 3577 Do not show the <emphasis >Save the machine3413 Do not show the <emphasis role="bold">Save the machine 3578 3414 state</emphasis> menu item in this menu. 3579 3415 </para> … … 3588 3424 <listitem> 3589 3425 <para> 3590 Do not show the <emphasis >ACPI Shutdown</emphasis> menu3591 item in this menu.3426 Do not show the <emphasis role="bold">ACPI 3427 Shutdown</emphasis> menu item in this menu. 3592 3428 </para> 3593 3429 </listitem> … … 3601 3437 <listitem> 3602 3438 <para> 3603 Do not show the <emphasis >Power Off the machine</emphasis>3604 m enu item in this menu.3439 Do not show the <emphasis role="bold">Power Off the 3440 machine</emphasis> menu item in this menu. 3605 3441 </para> 3606 3442 </listitem> … … 3618 3454 <para> 3619 3455 Use the following command to disable certain actions of the 3620 <emphasis >View</emphasis> menu:3456 <emphasis role="bold">View</emphasis> menu: 3621 3457 </para> 3622 3458 … … 3649 3485 <listitem> 3650 3486 <para> 3651 Do not show the <emphasis >Switch to Fullscreen</emphasis>3652 menu item in this menu.3487 Do not show the <emphasis role="bold">Switch to 3488 Fullscreen</emphasis> menu item in this menu. 3653 3489 </para> 3654 3490 </listitem> … … 3662 3498 <listitem> 3663 3499 <para> 3664 Do not show the <emphasis >Switch to Seamless3500 Do not show the <emphasis role="bold">Switch to Seamless 3665 3501 Mode</emphasis> menu item in this menu. 3666 3502 </para> … … 3675 3511 <listitem> 3676 3512 <para> 3677 Do not show the <emphasis >Switch to Scaled Mode</emphasis>3678 menu item in this menu.3513 Do not show the <emphasis role="bold">Switch to Scaled 3514 Mode</emphasis> menu item in this menu. 3679 3515 </para> 3680 3516 </listitem> … … 3688 3524 <listitem> 3689 3525 <para> 3690 Do not show the <emphasis >Auto-resize Guest3526 Do not show the <emphasis role="bold">Auto-resize Guest 3691 3527 Display</emphasis> menu item in this menu. 3692 3528 </para> … … 3701 3537 <listitem> 3702 3538 <para> 3703 Do not show the <emphasis >Adjust Window Size</emphasis>3704 menu item in this menu.3539 Do not show the <emphasis role="bold">Adjust Window 3540 Size</emphasis> menu item in this menu. 3705 3541 </para> 3706 3542 </listitem> … … 3714 3550 <listitem> 3715 3551 <para> 3716 Do not show the <emphasis>Multiscreen</emphasis> menu item 3717 in this menu. Only visible in full screen/seamless mode. 3552 Do not show the 3553 <emphasis role="bold">Multiscreen</emphasis> menu item in 3554 this menu. Only visible in full screen/seamless mode. 3718 3555 </para> 3719 3556 </listitem> … … 3731 3568 <para> 3732 3569 Use the following command to disable certain actions of the 3733 <emphasis >View</emphasis> menu:3570 <emphasis role="bold">View</emphasis> menu: 3734 3571 </para> 3735 3572 … … 3739 3576 where <computeroutput>OPTION</computeroutput> is one of the 3740 3577 following keywords to disable actions in the 3741 <emphasis >Devices</emphasis> menu:3578 <emphasis role="bold">Devices</emphasis> menu: 3742 3579 </para> 3743 3580 … … 3763 3600 <listitem> 3764 3601 <para> 3765 Do not show the <emphasis >CD/DVD Devices</emphasis> menu3766 item in this menu.3602 Do not show the <emphasis role="bold">CD/DVD 3603 Devices</emphasis> menu item in this menu. 3767 3604 </para> 3768 3605 </listitem> … … 3776 3613 <listitem> 3777 3614 <para> 3778 Do not show the <emphasis >Floppy Devices</emphasis> menu3779 item in this menu.3615 Do not show the <emphasis role="bold">Floppy 3616 Devices</emphasis> menu item in this menu. 3780 3617 </para> 3781 3618 </listitem> … … 3789 3626 <listitem> 3790 3627 <para> 3791 Do not show the <emphasis >USB Devices</emphasis> menu item3792 in this menu.3628 Do not show the <emphasis role="bold">USB 3629 Devices</emphasis> menu item in this menu. 3793 3630 </para> 3794 3631 </listitem> … … 3802 3639 <listitem> 3803 3640 <para> 3804 Do not show the <emphasis >Shared Clipboard</emphasis> menu3805 item in this menu.3641 Do not show the <emphasis role="bold">Shared 3642 Clipboard</emphasis> menu item in this menu. 3806 3643 </para> 3807 3644 </listitem> … … 3815 3652 <listitem> 3816 3653 <para> 3817 Do not show the <emphasis >Drag and Drop</emphasis> menu3818 item in this menu.3654 Do not show the <emphasis role="bold">Drag and 3655 Drop</emphasis> menu item in this menu. 3819 3656 </para> 3820 3657 </listitem> … … 3828 3665 <listitem> 3829 3666 <para> 3830 Do not show the <emphasis >Network Settings...</emphasis>3831 menu item in this menu.3667 Do not show the <emphasis role="bold">Network 3668 Settings...</emphasis> menu item in this menu. 3832 3669 </para> 3833 3670 </listitem> … … 3841 3678 <listitem> 3842 3679 <para> 3843 Do not show the <emphasis >Shared Folders3680 Do not show the <emphasis role="bold">Shared Folders 3844 3681 Settings...</emphasis> menu item in this menu. 3845 3682 </para> … … 3854 3691 <listitem> 3855 3692 <para> 3856 Do not show the <emphasis >Remove Display</emphasis> menu3857 item in this menu.3693 Do not show the <emphasis role="bold">Remove 3694 Display</emphasis> menu item in this menu. 3858 3695 </para> 3859 3696 </listitem> … … 3867 3704 <listitem> 3868 3705 <para> 3869 Do not show the <emphasis >Insert Guest Additions CD3870 image...</emphasis> menu item in this menu.3706 Do not show the <emphasis role="bold">Insert Guest 3707 Additions CD image...</emphasis> menu item in this menu. 3871 3708 </para> 3872 3709 </listitem> … … 3884 3721 <para> 3885 3722 Use the following command to disable certain actions of the 3886 <emphasis >View</emphasis> menu:3723 <emphasis role="bold">View</emphasis> menu: 3887 3724 </para> 3888 3725 … … 3917 3754 <listitem> 3918 3755 <para> 3919 Do not show the <emphasis>Statistics...</emphasis> menu 3920 item in this menu. 3756 Do not show the 3757 <emphasis role="bold">Statistics...</emphasis> menu item 3758 in this menu. 3921 3759 </para> 3922 3760 </listitem> … … 3930 3768 <listitem> 3931 3769 <para> 3932 Do not show the <emphasis >Command Line...</emphasis> menu3933 item in this menu.3770 Do not show the <emphasis role="bold">Command 3771 Line...</emphasis> menu item in this menu. 3934 3772 </para> 3935 3773 </listitem> … … 3943 3781 <listitem> 3944 3782 <para> 3945 Do not show the <emphasis>Logging...</emphasis> menu item 3946 in this menu. 3783 Do not show the 3784 <emphasis role="bold">Logging...</emphasis> menu item in 3785 this menu. 3947 3786 </para> 3948 3787 </listitem> … … 3956 3795 <listitem> 3957 3796 <para> 3958 Do not show the <emphasis >Show Log...</emphasis> menu item3959 in this menu.3797 Do not show the <emphasis role="bold">Show 3798 Log...</emphasis> menu item in this menu. 3960 3799 </para> 3961 3800 </listitem> … … 3973 3812 <para> 3974 3813 Use the following command to disable certain actions of the 3975 <emphasis >View</emphasis> menu:3814 <emphasis role="bold">View</emphasis> menu: 3976 3815 </para> 3977 3816 … … 3981 3820 where <computeroutput>OPTION</computeroutput> is one of the 3982 3821 following keywords to disable actions in the 3983 <emphasis >Help</emphasis> menu, which is normally completely3984 disabled:3822 <emphasis role="bold">Help</emphasis> menu, which is normally 3823 completely disabled: 3985 3824 </para> 3986 3825 … … 4006 3845 <listitem> 4007 3846 <para> 4008 Do not show the <emphasis>Contents...</emphasis> menu item 4009 in this menu. 3847 Do not show the 3848 <emphasis role="bold">Contents...</emphasis> menu item in 3849 this menu. 4010 3850 </para> 4011 3851 </listitem> … … 4019 3859 <listitem> 4020 3860 <para> 4021 Do not show the <emphasis >VirtualBox Web3861 Do not show the <emphasis role="bold">VirtualBox Web 4022 3862 Site...</emphasis> menu item in this menu. 4023 3863 </para> … … 4032 3872 <listitem> 4033 3873 <para> 4034 Do not show the <emphasis >Reset All Warnings</emphasis>4035 menu item in this menu.3874 Do not show the <emphasis role="bold">Reset All 3875 Warnings</emphasis> menu item in this menu. 4036 3876 </para> 4037 3877 </listitem> … … 4045 3885 <listitem> 4046 3886 <para> 4047 Do not show the <emphasis >Network Operations3887 Do not show the <emphasis role="bold">Network Operations 4048 3888 Manager</emphasis> menu item in this menu. 4049 3889 </para> … … 4058 3898 <listitem> 4059 3899 <para> 4060 Do not show the <emphasis >About</emphasis> menu item in4061 this menu. Only for non-Mac OS X hosts.3900 Do not show the <emphasis role="bold">About</emphasis> 3901 menu item in this menu. Only for non-Mac OS X hosts. 4062 3902 </para> 4063 3903 </listitem> … … 4071 3911 <listitem> 4072 3912 <para> 4073 Do not show the <emphasis>Contents...</emphasis> menu item 4074 in this menu. 3913 Do not show the 3914 <emphasis role="bold">Contents...</emphasis> menu item in 3915 this menu. 4075 3916 </para> 4076 3917 </listitem> … … 4084 3925 <listitem> 4085 3926 <para> 4086 Do not show the <emphasis>Contents...</emphasis> menu item 4087 in this menu. 3927 Do not show the 3928 <emphasis role="bold">Contents...</emphasis> menu item in 3929 this menu. 4088 3930 </para> 4089 3931 </listitem> … … 4331 4173 To disable all Host key combinations, open the preferences and 4332 4174 change the Host key to None. This might be useful when using 4333 VirtualBoxin a kiosk mode.4175 &product-name; in a kiosk mode. 4334 4176 </para> 4335 4177 … … 4352 4194 <thead> 4353 4195 <row> 4354 <entry><emphasis role="bold">Action</emphasis></entry> 4355 <entry><emphasis role="bold">Default Key</emphasis></entry> 4356 <entry><emphasis role="bold">Action</emphasis></entry> 4196 <entry><para> 4197 <emphasis role="bold">Action</emphasis> 4198 </para></entry> 4199 <entry><para> 4200 <emphasis role="bold">Default Key</emphasis> 4201 </para></entry> 4202 <entry><para> 4203 <emphasis role="bold">Action</emphasis> 4204 </para></entry> 4357 4205 </row> 4358 4206 </thead> 4359 4207 <tbody> 4360 4208 <row> 4361 <entry><computeroutput>TakeSnapshot</computeroutput></entry> 4362 <entry>T</entry> 4363 <entry>Take a snapshot</entry> 4209 <entry><para> 4210 <computeroutput>TakeSnapshot</computeroutput> 4211 </para></entry> 4212 <entry><para> 4213 T 4214 </para></entry> 4215 <entry><para> 4216 Take a snapshot 4217 </para></entry> 4364 4218 </row> 4365 4219 <row> 4366 <entry><computeroutput>TakeScreenshot</computeroutput></entry> 4367 <entry>E</entry> 4368 <entry>Take a screenshot</entry> 4220 <entry><para> 4221 <computeroutput>TakeScreenshot</computeroutput> 4222 </para></entry> 4223 <entry><para> 4224 E 4225 </para></entry> 4226 <entry><para> 4227 Take a screenshot 4228 </para></entry> 4369 4229 </row> 4370 4230 <row> 4371 <entry><computeroutput>MouseIntegration</computeroutput></entry> 4372 <entry>I</entry> 4373 <entry>Toggle mouse integration</entry> 4231 <entry><para> 4232 <computeroutput>MouseIntegration</computeroutput> 4233 </para></entry> 4234 <entry><para> 4235 I 4236 </para></entry> 4237 <entry><para> 4238 Toggle mouse integration 4239 </para></entry> 4374 4240 </row> 4375 4241 <row> 4376 <entry><computeroutput>TypeCAD</computeroutput></entry> 4377 <entry>Del</entry> 4378 <entry>Inject Ctrl+Alt+Del</entry> 4242 <entry><para> 4243 <computeroutput>TypeCAD</computeroutput> 4244 </para></entry> 4245 <entry><para> 4246 Del 4247 </para></entry> 4248 <entry><para> 4249 Inject Ctrl+Alt+Del 4250 </para></entry> 4379 4251 </row> 4380 4252 <row> 4381 <entry><computeroutput>TypeCABS</computeroutput></entry> 4382 <entry>Backspace</entry> 4383 <entry>Inject Ctrl+Alt+Backspace</entry> 4253 <entry><para> 4254 <computeroutput>TypeCABS</computeroutput> 4255 </para></entry> 4256 <entry><para> 4257 Backspace 4258 </para></entry> 4259 <entry><para> 4260 Inject Ctrl+Alt+Backspace 4261 </para></entry> 4384 4262 </row> 4385 4263 <row> 4386 <entry><computeroutput>Pause</computeroutput></entry> 4387 <entry>P</entry> 4388 <entry>Pause the VM</entry> 4264 <entry><para> 4265 <computeroutput>Pause</computeroutput> 4266 </para></entry> 4267 <entry><para> 4268 P 4269 </para></entry> 4270 <entry><para> 4271 Pause the VM 4272 </para></entry> 4389 4273 </row> 4390 4274 <row> 4391 <entry><computeroutput>Reset</computeroutput></entry> 4392 <entry>R</entry> 4275 <entry><para> 4276 <computeroutput>Reset</computeroutput> 4277 </para></entry> 4278 <entry><para> 4279 R 4280 </para></entry> 4393 4281 <entry>Hard reset the guest</entry> 4394 4282 </row> 4395 4283 <row> 4396 <entry><computeroutput>SaveState</computeroutput></entry> 4397 <entry></entry> 4398 <entry>Save the VM state and terminate the VM</entry> 4284 <entry><para> 4285 <computeroutput>SaveState</computeroutput> 4286 </para></entry> 4287 <entry><para></para></entry> 4288 <entry><para> 4289 Save the VM state and terminate the VM 4290 </para></entry> 4399 4291 </row> 4400 4292 <row> 4401 <entry><computeroutput>Shutdown</computeroutput></entry> 4402 <entry>H</entry> 4403 <entry>Press the (virtual) ACPI power button</entry> 4293 <entry><para> 4294 <computeroutput>Shutdown</computeroutput> 4295 </para></entry> 4296 <entry><para> 4297 H 4298 </para></entry> 4299 <entry><para> 4300 Press the virtual ACPI power button 4301 </para></entry> 4404 4302 </row> 4405 4303 <row> 4406 <entry><computeroutput>PowerOff</computeroutput></entry> 4407 <entry></entry> 4408 <entry>Power the VM off, without saving the state</entry> 4304 <entry><para> 4305 <computeroutput>PowerOff</computeroutput> 4306 </para></entry> 4307 <entry><para></para></entry> 4308 <entry><para> 4309 Power off the VM without saving the state 4310 </para></entry> 4409 4311 </row> 4410 4312 <row> 4411 <entry><computeroutput>Close</computeroutput></entry> 4412 <entry>Q</entry> 4413 <entry>Show the VM close dialog</entry> 4313 <entry><para> 4314 <computeroutput>Close</computeroutput> 4315 </para></entry> 4316 <entry><para> 4317 Q 4318 </para></entry> 4319 <entry><para> 4320 Show the Close VM dialog 4321 </para></entry> 4414 4322 </row> 4415 4323 <row> 4416 <entry><computeroutput>FullscreenMode</computeroutput></entry> 4417 <entry>F</entry> 4418 <entry>Switch the VM into full screen</entry> 4324 <entry><para> 4325 <computeroutput>FullscreenMode</computeroutput> 4326 </para></entry> 4327 <entry><para> 4328 F 4329 </para></entry> 4330 <entry><para> 4331 Switch the VM into full screen mode 4332 </para></entry> 4419 4333 </row> 4420 4334 <row> 4421 <entry><computeroutput>SeamlessMode</computeroutput></entry> 4422 <entry>L</entry> 4423 <entry>Switch the VM into seamless mode</entry> 4335 <entry><para> 4336 <computeroutput>SeamlessMode</computeroutput> 4337 </para></entry> 4338 <entry><para> 4339 L 4340 </para></entry> 4341 <entry><para> 4342 Switch the VM into seamless mode 4343 </para></entry> 4424 4344 </row> 4425 4345 <row> 4426 <entry><computeroutput>ScaleMode</computeroutput></entry> 4427 <entry>C</entry> 4428 <entry>Switch the VM into scale mode</entry> 4346 <entry><para> 4347 <computeroutput>ScaleMode</computeroutput> 4348 </para></entry> 4349 <entry><para> 4350 C 4351 </para></entry> 4352 <entry><para> 4353 Switch the VM into scaled mode 4354 </para></entry> 4429 4355 </row> 4430 4356 <row> 4431 <entry><computeroutput>GuestAutoResize</computeroutput></entry> 4432 <entry>G</entry> 4433 <entry>Automatically resize the guest window</entry> 4357 <entry><para> 4358 <computeroutput>GuestAutoResize</computeroutput> 4359 </para></entry> 4360 <entry><para> 4361 G 4362 </para></entry> 4363 <entry><para> 4364 Automatically resize the guest window 4365 </para></entry> 4434 4366 </row> 4435 4367 <row> 4436 <entry><computeroutput>WindowAdjust</computeroutput></entry> 4437 <entry>A</entry> 4438 <entry>Immediately resize the guest window</entry> 4368 <entry><para> 4369 <computeroutput>WindowAdjust</computeroutput> 4370 </para></entry> 4371 <entry><para> 4372 A 4373 </para></entry> 4374 <entry><para> 4375 Immediately resize the guest window 4376 </para></entry> 4439 4377 </row> 4440 4378 <row> 4441 <entry><computeroutput>PopupMenu</computeroutput></entry> 4442 <entry>Home</entry> 4443 <entry>Show popup menu in full screen / seaml. mode</entry> 4379 <entry><para> 4380 <computeroutput>PopupMenu</computeroutput> 4381 </para></entry> 4382 <entry><para> 4383 Home 4384 </para></entry> 4385 <entry><para> 4386 Show the popup menu in full screen mode and seamless 4387 mode 4388 </para></entry> 4444 4389 </row> 4445 4390 <row> 4446 <entry><computeroutput>SettingsDialog</computeroutput></entry> 4447 <entry>S</entry> 4448 <entry>Open the VM settings dialog</entry> 4391 <entry><para> 4392 <computeroutput>SettingsDialog</computeroutput> 4393 </para></entry> 4394 <entry><para> 4395 S 4396 </para></entry> 4397 <entry><para> 4398 Open the VM Settings dialog 4399 </para></entry> 4449 4400 </row> 4450 4401 <row> 4451 <entry><computeroutput>InformationDialog</computeroutput></entry> 4452 <entry>N</entry> 4453 <entry>Show the VM information window</entry> 4402 <entry><para> 4403 <computeroutput>InformationDialog</computeroutput> 4404 </para></entry> 4405 <entry><para> 4406 N 4407 </para></entry> 4408 <entry><para> 4409 Show the VM Session Information window 4410 </para></entry> 4454 4411 </row> 4455 4412 <row> 4456 <entry><computeroutput>NetworkAdaptersDialog</computeroutput></entry> 4457 <entry></entry> 4458 <entry>Show the VM network adapters dialog</entry> 4413 <entry><para> 4414 <computeroutput>NetworkAdaptersDialog</computeroutput> 4415 </para></entry> 4416 <entry><para></para></entry> 4417 <entry><para> 4418 Show the VM Network Adapters dialog 4419 </para></entry> 4459 4420 </row> 4460 4421 <row> 4461 <entry><computeroutput>SharedFoldersDialog</computeroutput></entry> 4462 <entry></entry> 4463 <entry>Show the VM shared folders dialog</entry> 4422 <entry><para> 4423 <computeroutput>SharedFoldersDialog</computeroutput> 4424 </para></entry> 4425 <entry><para></para></entry> 4426 <entry><para> 4427 Show the VM Shared Folders dialog 4428 </para></entry> 4464 4429 </row> 4465 4430 <row> 4466 <entry><computeroutput>InstallGuestAdditions</computeroutput></entry> 4467 <entry>D</entry> 4468 <entry>Mount the ISO containing the Guest Additions</entry> 4431 <entry><para> 4432 <computeroutput>InstallGuestAdditions</computeroutput> 4433 </para></entry> 4434 <entry><para> 4435 D 4436 </para></entry> 4437 <entry><para> 4438 Mount the ISO containing the Guest Additions 4439 </para></entry> 4469 4440 </row> 4470 4441 </tbody> … … 4473 4444 4474 4445 <para> 4475 To disable the full screen mode as well as the seamless mode, 4476 use the following command: 4446 To disable full screen mode and seamless mode, use the following 4447 command: 4448 </para> 4477 4449 4478 4450 <screen>VBoxManage setextradata global GUI/Input/MachineShortcuts "FullscreenMode=None,SeamlessMode=None"</screen> 4479 </para>4480 4451 4481 4452 </sect2> … … 4487 4458 <para> 4488 4459 You can disallow, or blacklist, certain actions when terminating 4489 a VM. To disallow specific actions, type: 4490 </para> 4491 4492 <para> 4460 a VM. To disallow specific actions, use the following command: 4461 </para> 4462 4493 4463 <screen>VBoxManage setextradata "VM name" GUI/RestrictedCloseActions OPTION[,OPTION...]</screen> 4494 </para>4495 4464 4496 4465 <para> … … 4583 4552 contrast to the setting decribed in the previous section, this 4584 4553 setting allows only one action when the user terminates the VM. 4585 No exit menu is shown. 4586 </para> 4587 4588 <para> 4554 No exit menu is shown. Use the following command: 4555 </para> 4556 4589 4557 <screen>VBoxManage setextradata "VM name" GUI/DefaultCloseAction ACTION</screen> 4590 </para>4591 4558 4592 4559 <para> … … 4681 4648 4682 4649 <para> 4683 This behavior can be configured: 4684 </para> 4685 4686 <para> 4650 This behavior can be configured as follows: 4651 </para> 4652 4687 4653 <screen>VBoxManage setextradata "VM name" GUI/GuruMeditationHandler MODE</screen> 4688 </para>4689 4654 4690 4655 <para> … … 4752 4717 guest window and the guest expects relative mouse coordinates at 4753 4718 this time. This happens if the pointing device is configured as 4754 PS/2 mouse and the guest has not yet started the VirtualBox4719 PS/2 mouse and the guest has not yet started the &product-name; 4755 4720 Guest Additions. For instance, the guest is booting or the Guest 4756 4721 Additions are not installed, or if the pointing device is … … 4763 4728 <para> 4764 4729 The default behavior is sometimes not desired. Therefore it can 4765 be configured: 4766 </para> 4767 4768 <para> 4730 be configured as follows: 4731 </para> 4732 4769 4733 <screen>VBoxManage setextradata "VM name" GUI/MouseCapturePolicy MODE</screen> 4770 </para>4771 4734 4772 4735 <para> … … 4827 4790 4828 4791 <para> 4829 As of version 4.3.16, VirtualBox uses special window manager 4830 facilities to switch a multi-screen machine to full-screen on a 4831 multi-monitor host system. However, not all window managers 4832 provide these facilities correctly, so VirtualBox can be told to 4833 use the old method of switching to full-screen mode instead 4834 using the command: 4835 </para> 4836 4837 <para> 4792 &product-name; uses special window manager facilities to switch 4793 a multi-screen machine to full-screen on a multi-monitor host 4794 system. However, not all window managers provide these 4795 facilities correctly. &product-name; can be configured to use a 4796 legacy method of switching to full-screen mode instead, by using 4797 the command: 4798 </para> 4799 4838 4800 <screen>VBoxManage setextradata global GUI/Fullscreen/LegacyMode true</screen> 4839 </para> 4840 4841 <para> 4842 You can go back to the new method using the command: 4843 </para> 4844 4845 <para> 4801 4802 <para> 4803 You can go back to the default method by using the following 4804 command: 4805 </para> 4806 4846 4807 <screen>VBoxManage setextradata global GUI/Fullscreen/LegacyMode</screen> 4847 </para>4848 4808 4849 4809 <para> … … 4857 4817 <sect1 id="vboxwebsrv-daemon"> 4858 4818 4859 <title>Starting the VirtualBoxWeb Service Automatically</title>4860 4861 <para> 4862 The VirtualBoxweb service,4819 <title>Starting the &product-name; Web Service Automatically</title> 4820 4821 <para> 4822 The &product-name; web service, 4863 4823 <computeroutput>vboxwebsrv</computeroutput>, is used for 4864 controlling VirtualBox remotely. It is documented in detail in the4865 VirtualBoxSoftware Development Kit (SDK). See4824 controlling &product-name; remotely. It is documented in detail in 4825 the &product-name; Software Development Kit (SDK). See 4866 4826 <xref linkend="VirtualBoxAPI" />. As the client base using this 4867 4827 interface is growing, we added start scripts for the various 4868 4828 operation systems we support. The following sections describe how 4869 to use them. The VirtualBoxweb service is never started4829 to use them. The &product-name; web service is never started 4870 4830 automatically as a result of a standard installation. 4871 4831 </para> … … 4873 4833 <sect2 id="vboxwebsrv-linux"> 4874 4834 4875 <title>Linux: Starting the Web Service viainit</title>4835 <title>Linux: Starting the Web Service With init</title> 4876 4836 4877 4837 <para> … … 4886 4846 example: <computeroutput>VBOXWEB_HOST</computeroutput> and 4887 4847 <computeroutput>VBOXWEB_PORT</computeroutput>. 4888 4889 <table id="table-websrv-config-params"> 4890 <title>Web Service Configuration Parameters</title> 4891 <tgroup cols="3"> 4892 <thead> 4893 <row> 4894 <entry><emphasis role="bold">Parameter</emphasis></entry> 4895 <entry><emphasis role="bold">Description</emphasis></entry> 4896 <entry><emphasis role="bold">Default</emphasis></entry> 4897 </row> 4898 </thead> 4899 <tbody> 4900 <row> 4901 <entry><computeroutput>USER</computeroutput></entry> 4902 <entry>The user as which the web service runs</entry> 4903 <entry></entry> 4904 </row> 4905 <row> 4906 <entry><computeroutput>HOST</computeroutput></entry> 4907 <entry>The host to bind the web service to</entry> 4908 <entry>localhost</entry> 4909 </row> 4910 <row> 4911 <entry><computeroutput>PORT</computeroutput></entry> 4912 <entry>The port to bind the web service to</entry> 4913 <entry>18083</entry> 4914 </row> 4915 <row> 4916 <entry><computeroutput>SSL_KEYFILE</computeroutput></entry> 4917 <entry>Server key and certificate file, PEM format</entry> 4918 <entry></entry> 4919 </row> 4920 <row> 4921 <entry><computeroutput>SSL_PASSWORDFILE</computeroutput></entry> 4922 <entry>File name for password to server key</entry> 4923 <entry></entry> 4924 </row> 4925 <row> 4926 <entry><computeroutput>SSL_CACERT</computeroutput></entry> 4927 <entry>CA certificate file, PEM format</entry> 4928 <entry></entry> 4929 </row> 4930 <row> 4931 <entry><computeroutput>SSL_CAPATH</computeroutput></entry> 4932 <entry>CA certificate path</entry> 4933 <entry></entry> 4934 </row> 4935 <row> 4936 <entry><computeroutput>SSL_DHFILE</computeroutput></entry> 4937 <entry>DH file name or DH key length in bits</entry> 4938 <entry></entry> 4939 </row> 4940 <row> 4941 <entry><computeroutput>SSL_RANDFILE</computeroutput></entry> 4942 <entry>File containing seed for random number generator</entry> 4943 <entry></entry> 4944 </row> 4945 <row> 4946 <entry><computeroutput>TIMEOUT</computeroutput></entry> 4947 <entry>Session timeout in seconds; 0 disables timeouts</entry> 4948 <entry>300</entry> 4949 </row> 4950 <row> 4951 <entry><computeroutput>CHECK_INTERVAL</computeroutput></entry> 4952 <entry>Frequency of timeout checks in seconds</entry> 4953 <entry>5</entry> 4954 </row> 4955 <row> 4956 <entry><computeroutput>THREADS</computeroutput></entry> 4957 <entry>Maximum number of worker threads to run in parallel</entry> 4958 <entry>100</entry> 4959 </row> 4960 <row> 4961 <entry><computeroutput>KEEPALIVE</computeroutput></entry> 4962 <entry>Maximum number of requests before a socket will be closed</entry> 4963 <entry>100</entry> 4964 </row> 4965 <row> 4966 <entry><computeroutput>ROTATE</computeroutput></entry> 4967 <entry>Number of log files; 0 disables log rotation</entry> 4968 <entry>10</entry> 4969 </row> 4970 <row> 4971 <entry><computeroutput>LOGSIZE</computeroutput></entry> 4972 <entry>Maximum size of a log file in bytes to trigger rotation</entry> 4973 <entry>1MB</entry> 4974 </row> 4975 <row> 4976 <entry><computeroutput>LOGINTERVAL</computeroutput></entry> 4977 <entry>Maximum time interval in seconds to trigger log rotation</entry> 4978 <entry>1 day</entry> 4979 </row> 4980 </tbody> 4981 </tgroup> 4982 </table> 4983 </para> 4848 </para> 4849 4850 <table id="table-websrv-config-params"> 4851 <title>Web Service Configuration Parameters</title> 4852 <tgroup cols="3"> 4853 <thead> 4854 <row> 4855 <entry><para> 4856 <emphasis role="bold">Parameter</emphasis> 4857 </para></entry> 4858 <entry><para> 4859 <emphasis role="bold">Description</emphasis> 4860 </para></entry> 4861 <entry><para> 4862 <emphasis role="bold">Default</emphasis> 4863 </para></entry> 4864 </row> 4865 </thead> 4866 <tbody> 4867 <row> 4868 <entry><para> 4869 <computeroutput>USER</computeroutput> 4870 </para></entry> 4871 <entry><para> 4872 The user which the web service runs as 4873 </para></entry> 4874 <entry><para></para></entry> 4875 </row> 4876 <row> 4877 <entry><para> 4878 <computeroutput>HOST</computeroutput> 4879 </para></entry> 4880 <entry><para> 4881 The host to bind the web service to 4882 </para></entry> 4883 <entry><para> 4884 localhost 4885 </para></entry> 4886 </row> 4887 <row> 4888 <entry><para> 4889 <computeroutput>PORT</computeroutput> 4890 </para></entry> 4891 <entry><para> 4892 The port to bind the web service to 4893 </para></entry> 4894 <entry><para> 4895 18083 4896 </para></entry> 4897 </row> 4898 <row> 4899 <entry><para> 4900 <computeroutput>SSL_KEYFILE</computeroutput> 4901 </para></entry> 4902 <entry><para> 4903 Server key and certificate file, in PEM format 4904 </para></entry> 4905 <entry><para></para></entry> 4906 </row> 4907 <row> 4908 <entry><para> 4909 <computeroutput>SSL_PASSWORDFILE</computeroutput> 4910 </para></entry> 4911 <entry><para> 4912 File name for password to server key 4913 </para></entry> 4914 <entry><para></para></entry> 4915 </row> 4916 <row> 4917 <entry><para> 4918 <computeroutput>SSL_CACERT</computeroutput> 4919 </para></entry> 4920 <entry><para> 4921 CA certificate file, in PEM format 4922 </para></entry> 4923 <entry><para></para></entry> 4924 </row> 4925 <row> 4926 <entry><para> 4927 <computeroutput>SSL_CAPATH</computeroutput> 4928 </para></entry> 4929 <entry><para> 4930 CA certificate path 4931 </para></entry> 4932 <entry><para></para></entry> 4933 </row> 4934 <row> 4935 <entry><para> 4936 <computeroutput>SSL_DHFILE</computeroutput> 4937 </para></entry> 4938 <entry><para> 4939 DH file name or DH key length in bits 4940 </para></entry> 4941 <entry><para></para></entry> 4942 </row> 4943 <row> 4944 <entry><para> 4945 <computeroutput>SSL_RANDFILE</computeroutput> 4946 </para></entry> 4947 <entry><para> 4948 File containing seed for random number generator 4949 </para></entry> 4950 <entry><para></para></entry> 4951 </row> 4952 <row> 4953 <entry><para> 4954 <computeroutput>TIMEOUT</computeroutput> 4955 </para></entry> 4956 <entry><para> 4957 Session timeout in seconds, 0 disables timeouts 4958 </para></entry> 4959 <entry><para> 4960 300 4961 </para></entry> 4962 </row> 4963 <row> 4964 <entry><para> 4965 <computeroutput>CHECK_INTERVAL</computeroutput> 4966 </para></entry> 4967 <entry><para> 4968 Frequency of timeout checks in seconds 4969 </para></entry> 4970 <entry><para> 4971 5 4972 </para></entry> 4973 </row> 4974 <row> 4975 <entry><para> 4976 <computeroutput>THREADS</computeroutput> 4977 </para></entry> 4978 <entry><para> 4979 Maximum number of worker threads to run in parallel 4980 </para></entry> 4981 <entry><para> 4982 100 4983 </para></entry> 4984 </row> 4985 <row> 4986 <entry><para> 4987 <computeroutput>KEEPALIVE</computeroutput> 4988 </para></entry> 4989 <entry><para> 4990 Maximum number of requests before a socket will be 4991 closed 4992 </para></entry> 4993 <entry><para> 4994 100 4995 </para></entry> 4996 </row> 4997 <row> 4998 <entry><para> 4999 <computeroutput>ROTATE</computeroutput> 5000 </para></entry> 5001 <entry><para> 5002 Number of log files, 0 disables log rotation 5003 </para></entry> 5004 <entry><para> 5005 10 5006 </para></entry> 5007 </row> 5008 <row> 5009 <entry><para> 5010 <computeroutput>LOGSIZE</computeroutput> 5011 </para></entry> 5012 <entry><para> 5013 Maximum log file size to trigger rotation, in bytes 5014 </para></entry> 5015 <entry><para> 5016 1MB 5017 </para></entry> 5018 </row> 5019 <row> 5020 <entry><para> 5021 <computeroutput>LOGINTERVAL</computeroutput> 5022 </para></entry> 5023 <entry><para> 5024 Maximum time interval to trigger log rotation, in 5025 seconds 5026 </para></entry> 5027 <entry><para> 5028 1 day 5029 </para></entry> 5030 </row> 5031 </tbody> 5032 </tgroup> 5033 </table> 4984 5034 4985 5035 <para> … … 4987 5037 <computeroutput>SSL_KEYFILE</computeroutput> enables the SSL/TLS 4988 5038 support. Using encryption is strongly encouraged, as otherwise 4989 everything (including passwords)is transferred in clear text.5039 everything, including passwords, is transferred in clear text. 4990 5040 </para> 4991 5041 … … 4994 5044 <sect2 id="vboxwebsrv-solaris"> 4995 5045 4996 <title> Solaris: Starting the Web Service viaSMF</title>4997 4998 <para> 4999 On Solaris hosts, the VirtualBox web service daemon is5000 i ntegrated into the SMF framework. You can change the5046 <title>Oracle Solaris: Starting the Web Service With SMF</title> 5047 5048 <para> 5049 On Oracle Solaris hosts, the &product-name; web service daemon 5050 is integrated into the SMF framework. You can change the 5001 5051 parameters, but do not have to if the defaults below already 5002 5052 match your needs: 5053 </para> 5003 5054 5004 5055 <screen>svccfg -s svc:/application/virtualbox/webservice:default setprop config/host=localhost 5005 5056 svccfg -s svc:/application/virtualbox/webservice:default setprop config/port=18083 5006 5057 svccfg -s svc:/application/virtualbox/webservice:default setprop config/user=root</screen> 5007 </para>5008 5058 5009 5059 <para> 5010 5060 <xref linkend="table-websrv-config-params"/> showing the 5011 parameter names and defaults also applies for Solaris. The5012 parameter names must be changed to lowercase and a prefix of5061 parameter names and defaults also applies for Oracle Solaris. 5062 The parameter names must be changed to lowercase and a prefix of 5013 5063 <computeroutput>config/</computeroutput> has to be added. For 5014 5064 example: <computeroutput>config/user</computeroutput> or … … 5016 5066 any change, do not forget to run the following command to put 5017 5067 the changes into effect immediately: 5068 </para> 5018 5069 5019 5070 <screen>svcadm refresh svc:/application/virtualbox/webservice:default</screen> 5020 </para>5021 5071 5022 5072 <para> 5023 5073 If you forget the above command then the previous settings are 5024 5074 used when enabling the service. Check the current property 5025 settings with: 5075 settings as follows: 5076 </para> 5026 5077 5027 5078 <screen>svcprop -p config svc:/application/virtualbox/webservice:default</screen> 5028 </para>5029 5079 5030 5080 <para> 5031 5081 When everything is configured correctly you can start the 5032 VirtualBox web service with the following command: 5082 &product-name; web service with the following command: 5083 </para> 5033 5084 5034 5085 <screen>svcadm enable svc:/application/virtualbox/webservice:default</screen> 5035 </para> 5036 5037 <para> 5038 For more information about SMF, please refer to the Solaris 5039 documentation. 5086 5087 <para> 5088 For more information about SMF, please refer to the Oracle 5089 Solaris documentation. 5040 5090 </para> 5041 5091 … … 5044 5094 <sect2 id="vboxwebsrv-osx"> 5045 5095 5046 <title>Mac OS X: Starting the Web Service vialaunchd</title>5047 5048 <para> 5049 On Mac OS X, launchd is used to start the VirtualBox webservice.5050 An example configuration file can be found in5096 <title>Mac OS X: Starting the Web Service With launchd</title> 5097 5098 <para> 5099 On Mac OS X, launchd is used to start the &product-name; 5100 webservice. An example configuration file can be found in 5051 5101 <computeroutput>$HOME/Library/LaunchAgents/org.virtualbox.vboxwebsrv.plist</computeroutput>. 5052 5102 It can be enabled by changing the … … 5055 5105 <computeroutput>false</computeroutput>. To manually start the 5056 5106 service use the following command: 5107 </para> 5057 5108 5058 5109 <screen>launchctl load ~/Library/LaunchAgents/org.virtualbox.vboxwebsrv.plist</screen> 5059 5110 5111 <para> 5060 5112 For additional information on how launchd services could be 5061 5113 configured see: … … 5073 5125 <sect1 id="vboxwatchdog"> 5074 5126 5075 <title>VirtualBox Watchdog</title> 5076 5077 <para> 5078 Starting with VirtualBox 4.2 the memory ballooning service 5079 formerly known as <computeroutput>VBoxBalloonCtrl</computeroutput> 5080 was renamed to VBoxWatchdog, which now incorporates several host 5081 services that are meant to be run in a server environment. 5082 </para> 5083 5084 <para> 5085 These services are as follows: 5127 <title>&product-name; Watchdog</title> 5128 5129 <para> 5130 The memory ballooning service, formerly known as 5131 <computeroutput>VBoxBalloonCtrl</computeroutput>, was renamed to 5132 VBoxWatchdog. This service now incorporates the following host 5133 services that are meant to be run in a server environment: 5086 5134 </para> 5087 5135 … … 5090 5138 <listitem> 5091 5139 <para> 5092 Memory ballooning control, which automatically takes care of a5093 VM's configured memory balloon. See5094 <xref linkend="guestadd-balloon" />. This service is useful5095 for server environments where VMs may dynamically require more5096 or less memory during runtime.5140 <emphasis role="bold">Memory ballooning control.</emphasis> 5141 This service automatically takes care of a VM's configured 5142 memory balloon. See <xref linkend="guestadd-balloon" />. This 5143 service is useful for server environments where VMs may 5144 dynamically require more or less memory during runtime. 5097 5145 </para> 5098 5146 … … 5108 5156 <listitem> 5109 5157 <para> 5110 Host isolation detection, which provides a way to detect5111 whether the host cannot reach the specific VirtualBox server5112 instance anymore and take appropriate actions, such as5113 shutting down, saving the current state or even powering down5114 c ertain VMs.5158 <emphasis role="bold">Host isolation detection.</emphasis> 5159 This service provides a way to detect whether the host cannot 5160 reach the specific &product-name; server instance anymore and 5161 take appropriate actions, such as shutting down, saving the 5162 current state or even powering down certain VMs. 5115 5163 </para> 5116 5164 </listitem> … … 5119 5167 5120 5168 <para> 5121 All configuration values can be either specified via command line5122 or global extradata, whereas command line values always have a5123 higher priority when set. Some of the configuration values also be5124 specified on a per-VM basis. So the overall lookup order is:5125 command line, per-VM basis extradata (if available), global5169 All configuration values can be either specified using the command 5170 line or global extradata, whereas command line values always have 5171 a higher priority when set. Some of the configuration values also 5172 be specified on a per-VM basis. So the overall lookup order is: 5173 command line, per-VM basis extradata if available, global 5126 5174 extradata. 5127 5175 </para> … … 5139 5187 <para> 5140 5188 To set up the memory ballooning control the maximum ballooning 5141 size a VM can reach needs to be set. This can be specified via 5142 the command line with: 5189 size a VM can reach needs to be set. This can be specified using 5190 the command line, as follows: 5191 </para> 5143 5192 5144 5193 <screen>--balloon-max <Size in MB></screen> 5145 5194 5146 or on a per-VM basis extradata value with: 5195 <para> 5196 Using a per-VM basis extradata value, as follows: 5197 </para> 5147 5198 5148 5199 <screen>VBoxManage setextradata <VM-Name> VBoxInternal2/Watchdog/BalloonCtrl/BalloonSizeMax <Size in MB></screen> 5149 5200 5150 or using a global extradata value with: 5201 <para> 5202 Using a global extradata value, as follows: 5203 </para> 5151 5204 5152 5205 <screen>VBoxManage setextradata global VBoxInternal2/Watchdog/BalloonCtrl/BalloonSizeMax <Size in MB></screen> 5153 5206 5154 <note> 5155 <para> 5156 If no maximum ballooning size is specified by at least one 5157 of the parameters above, no ballooning will be performed at 5158 all. 5159 </para> 5160 </note> 5161 </para> 5162 5163 <para> 5164 Setting the ballooning increment in MB can be either done via 5165 command line with: 5207 <note> 5208 <para> 5209 If no maximum ballooning size is specified by at least one of 5210 the parameters above, no ballooning will be performed at all. 5211 </para> 5212 </note> 5213 5214 <para> 5215 Setting the ballooning increment in MB can be either done using 5216 command line, as follows: 5217 </para> 5166 5218 5167 5219 <screen>--balloon-inc <Size in MB></screen> 5168 5220 5169 or using a global extradata value with: 5221 <para> 5222 Using a global extradata value, as follows: 5223 </para> 5170 5224 5171 5225 <screen>VBoxManage setextradata global VBoxInternal2/Watchdog/BalloonCtrl/BalloonIncrementMB <Size in MB></screen> 5172 5226 5227 <para> 5173 5228 The default ballooning increment is 256 MB if not specified. 5174 5229 </para> … … 5176 5231 <para> 5177 5232 The same options apply for a ballooning decrement. Using the 5178 command line with: 5233 command line, as follows: 5234 </para> 5179 5235 5180 5236 <screen>--balloon-dec <Size in MB></screen> 5181 5237 5182 or using a global extradata value with: 5238 <para> 5239 Using a global extradata value, as follows: 5240 </para> 5183 5241 5184 5242 <screen>VBoxManage setextradata global VBoxInternal2/Watchdog/BalloonCtrl/BalloonDecrementMB <Size in MB></screen> 5185 5243 5244 <para> 5186 5245 The default ballooning decrement is 128 MB if not specified. 5187 5246 </para> 5188 5247 5189 5248 <para> 5190 To define the lower limit in MB a balloon can be the command 5191 line with: 5249 The lower limit in MB for a balloon can be defined using the 5250 command line, as follows: 5251 </para> 5192 5252 5193 5253 <screen>--balloon-lower-limit <Size in MB></screen> 5194 5254 5195 can be used or using a global extradata value with: 5255 <para> 5256 Using a global extradata value, as follows: 5257 </para> 5196 5258 5197 5259 <screen>VBoxManage setextradata global VBoxInternal2/Watchdog/BalloonCtrl/BalloonLowerLimitMB <Size in MB></screen> 5198 5260 5199 is available. Default lower limit is 128 if not specified. 5261 <para> 5262 The default lower limit is 128 MB if not specified. 5200 5263 </para> 5201 5264 … … 5208 5271 <para> 5209 5272 To detect whether a host is being isolated, that is, the host 5210 cannot reach the VirtualBox server instance anymore, the host5211 needs to set an alternating value to a global extradata value5212 within a time period. If this value is not set within that time5213 period a timeout occurred and the so-called host isolation5273 cannot reach the &product-name; server instance anymore, the 5274 host needs to set an alternating value to a global extradata 5275 value within a time period. If this value is not set within that 5276 time period a timeout occurred and the so-called host isolation 5214 5277 response will be performed to the VMs handled. Which VMs are 5215 5278 handled can be controlled by defining VM groups and assigning … … 5220 5283 5221 5284 <para> 5222 To set the groups handled by the host isolation detection via 5285 Set the groups handled by the host isolation detection using the 5286 following command line: 5287 </para> 5288 5289 <screen>--apimon-groups=<string[,stringN]></screen> 5290 5291 <para> 5292 Using a global extradata value, as follows: 5293 </para> 5294 5295 <screen>VBoxManage setextradata global VBoxInternal2/Watchdog/APIMonitor/Groups <string[,stringN]></screen> 5296 5297 <para> 5298 Set the host isolation timeout using the following command line: 5299 </para> 5300 5301 <screen>--apimon-isln-timeout=<ms></screen> 5302 5303 <para> 5304 Using a global extradata value, as follows: 5305 </para> 5306 5307 <screen>VBoxManage setextradata global VBoxInternal2/Watchdog/APIMonitor/IsolationTimeoutMS <ms></screen> 5308 5309 <para> 5310 Set the actual host isolation response using the following 5223 5311 command line: 5224 5225 <screen>--apimon-groups=<string[,stringN]></screen> 5226 5227 or using a global extradata value with: 5228 5229 <screen>VBoxManage setextradata global VBoxInternal2/Watchdog/APIMonitor/Groups <string[,stringN]></screen> 5230 </para> 5231 5232 <para> 5233 To set the host isolation timeout via command line: 5234 5235 <screen>--apimon-isln-timeout=<ms></screen> 5236 5237 or using a global extradata value with: 5238 5239 <screen>VBoxManage setextradata global VBoxInternal2/Watchdog/APIMonitor/IsolationTimeoutMS <ms></screen> 5240 </para> 5241 5242 <para> 5243 To set the actual host isolation response via command line: 5312 </para> 5244 5313 5245 5314 <screen>--apimon-isln-response=<cmd></screen> 5246 5315 5247 or using a global extradata value with: 5316 <para> 5317 Using a global extradata value, as follows: 5318 </para> 5248 5319 5249 5320 <screen>VBoxManage setextradata global VBoxInternal2/Watchdog/APIMonitor/IsolationResponse <cmd></screen> 5250 5321 5322 <para> 5251 5323 The following response commands are available: 5252 5324 </para> … … 5311 5383 <sect2 id="vboxwatchdog-linux"> 5312 5384 5313 <title>Linux: Starting the Watchdog Service viainit</title>5385 <title>Linux: Starting the Watchdog Service With init</title> 5314 5386 5315 5387 <para> … … 5334 5406 <computeroutput>VBOXBALLOONCTRL_INTERVAL</computeroutput> can 5335 5407 still be used. 5336 5337 <table id="table-vboxwatchdog-config-params"> 5338 <title>VirtualBox Watchdog Configuration Parameters</title> 5339 <tgroup cols="3"> 5340 <thead> 5341 <row> 5342 <entry><emphasis role="bold">Parameter</emphasis></entry> 5343 <entry><emphasis role="bold">Description</emphasis></entry> 5344 <entry><emphasis role="bold">Default</emphasis></entry> 5345 </row> 5346 </thead> 5347 <tbody> 5348 <row> 5349 <entry><computeroutput>USER</computeroutput></entry> 5350 <entry>The user as which the watchdog service runs</entry> 5351 <entry></entry> 5352 </row> 5353 <row> 5354 <entry><computeroutput>ROTATE</computeroutput></entry> 5355 <entry>Number of log files; 0 disables log rotation</entry> 5356 <entry>10</entry> 5357 </row> 5358 <row> 5359 <entry><computeroutput>LOGSIZE</computeroutput></entry> 5360 <entry>Maximum size of a log file in bytes to trigger rotation</entry> 5361 <entry>1MB</entry> 5362 </row> 5363 <row> 5364 <entry><computeroutput>LOGINTERVAL</computeroutput></entry> 5365 <entry>Maximum time interval in seconds to trigger log rotation</entry> 5366 <entry>1 day</entry> 5367 </row> 5368 <row> 5369 <entry><computeroutput>BALLOON_INTERVAL</computeroutput></entry> 5370 <entry>Interval for checking the balloon size (msec)</entry> 5371 <entry>30000</entry> 5372 </row> 5373 <row> 5374 <entry><computeroutput>BALLOON_INCREMENT</computeroutput></entry> 5375 <entry>Balloon size increment (MByte)</entry> 5376 <entry>256</entry> 5377 </row> 5378 <row> 5379 <entry><computeroutput>BALLOON_DECREMENT</computeroutput></entry> 5380 <entry>Balloon size decrement (MByte)</entry> 5381 <entry>128</entry> 5382 </row> 5383 <row> 5384 <entry><computeroutput>BALLOON_LOWERLIMIT</computeroutput></entry> 5385 <entry>Balloon size lower limit (MByte)</entry> 5386 <entry>64</entry> 5387 </row> 5388 <row> 5389 <entry><computeroutput>BALLOON_SAFETYMARGIN</computeroutput></entry> 5390 <entry>Free memory required for decreasing the balloon size (MByte)</entry> 5391 <entry>1024</entry> 5392 </row> 5393 </tbody> 5394 </tgroup> 5395 </table> 5396 </para> 5408 </para> 5409 5410 <table id="table-vboxwatchdog-config-params"> 5411 <title>&product-name; Watchdog Configuration Parameters</title> 5412 <tgroup cols="3"> 5413 <thead> 5414 <row> 5415 <entry><para> 5416 <emphasis role="bold">Parameter</emphasis> 5417 </para></entry> 5418 <entry><para> 5419 <emphasis role="bold">Description</emphasis> 5420 </para></entry> 5421 <entry><para> 5422 <emphasis role="bold">Default</emphasis> 5423 </para></entry> 5424 </row> 5425 </thead> 5426 <tbody> 5427 <row> 5428 <entry><para> 5429 <computeroutput>USER</computeroutput> 5430 </para></entry> 5431 <entry><para> 5432 The user which the watchdog service runs as 5433 </para></entry> 5434 <entry><para></para></entry> 5435 </row> 5436 <row> 5437 <entry><para> 5438 <computeroutput>ROTATE</computeroutput> 5439 </para></entry> 5440 <entry><para> 5441 Number of log files, 0 disables log rotation 5442 </para></entry> 5443 <entry><para> 5444 10 5445 </para></entry> 5446 </row> 5447 <row> 5448 <entry><para> 5449 <computeroutput>LOGSIZE</computeroutput> 5450 </para></entry> 5451 <entry><para> 5452 Maximum log file size to trigger rotation, in bytes 5453 </para></entry> 5454 <entry><para> 5455 1MB 5456 </para></entry> 5457 </row> 5458 <row> 5459 <entry><para> 5460 <computeroutput>LOGINTERVAL</computeroutput> 5461 </para></entry> 5462 <entry><para> 5463 Maximum time interval to trigger log rotation, in 5464 seconds 5465 </para></entry> 5466 <entry><para> 5467 1 day 5468 </para></entry> 5469 </row> 5470 <row> 5471 <entry><para> 5472 <computeroutput>BALLOON_INTERVAL</computeroutput> 5473 </para></entry> 5474 <entry><para> 5475 Interval for checking the balloon size, in 5476 milliseconds 5477 </para></entry> 5478 <entry><para> 5479 30000 5480 </para></entry> 5481 </row> 5482 <row> 5483 <entry><para> 5484 <computeroutput>BALLOON_INCREMENT</computeroutput> 5485 </para></entry> 5486 <entry><para> 5487 Balloon size increment, in megabytes 5488 </para></entry> 5489 <entry><para> 5490 256 5491 </para></entry> 5492 </row> 5493 <row> 5494 <entry><para> 5495 <computeroutput>BALLOON_DECREMENT</computeroutput> 5496 </para></entry> 5497 <entry><para> 5498 Balloon size decrement, in megabytes 5499 </para></entry> 5500 <entry><para> 5501 128 5502 </para></entry> 5503 </row> 5504 <row> 5505 <entry><para> 5506 <computeroutput>BALLOON_LOWERLIMIT</computeroutput> 5507 </para></entry> 5508 <entry><para> 5509 Balloon size lower limit, in megabytes 5510 </para></entry> 5511 <entry><para> 5512 64 5513 </para></entry> 5514 </row> 5515 <row> 5516 <entry><para> 5517 <computeroutput>BALLOON_SAFETYMARGIN</computeroutput> 5518 </para></entry> 5519 <entry><para> 5520 Free memory required for decreasing the balloon size, 5521 in megabytes 5522 </para></entry> 5523 <entry><para> 5524 1024 5525 </para></entry> 5526 </row> 5527 </tbody> 5528 </tgroup> 5529 </table> 5397 5530 5398 5531 </sect2> … … 5400 5533 <sect2 id="vboxwatchdog-solaris"> 5401 5534 5402 <title> Solaris: Starting the Watchdog Service viaSMF</title>5403 5404 <para> 5405 On Solaris hosts, the VirtualBox watchdog service daemon is5406 integrated into the SMF framework. You can change the5535 <title>Oracle Solaris: Starting the Watchdog Service With SMF</title> 5536 5537 <para> 5538 On Oracle Solaris hosts, the &product-name; watchdog service 5539 daemon is integrated into the SMF framework. You can change the 5407 5540 parameters, but do not have to if the defaults already match 5408 5541 your needs: … … 5416 5549 <para> 5417 5550 <xref linkend="table-vboxwatchdog-config-params"/> also applies 5418 for Solaris. The parameter names must be changed to lowercase5419 and a prefix of <computeroutput>config/</computeroutput> has to5420 be added. For example:5421 <computeroutput>config/user</computeroutput> or5551 for Oracle Solaris. The parameter names must be changed to 5552 lowercase and a prefix of 5553 <computeroutput>config/</computeroutput> has to be added. For 5554 example: <computeroutput>config/user</computeroutput> or 5422 5555 <computeroutput>config/balloon_safetymargin</computeroutput>. If 5423 5556 you made any change, do not forget to run the following command 5424 5557 to put the changes into effect immediately: 5558 </para> 5425 5559 5426 5560 <screen>svcadm refresh svc:/application/virtualbox/balloonctrl:default</screen> 5427 </para>5428 5561 5429 5562 <para> 5430 5563 If you forget the above command then the previous settings will 5431 5564 be used when enabling the service. Check the current property 5432 settings with: 5565 settings with the following command: 5566 </para> 5433 5567 5434 5568 <screen>svcprop -p config svc:/application/virtualbox/balloonctrl:default</screen> 5435 </para>5436 5569 5437 5570 <para> 5438 5571 When everything is configured correctly you can start the 5439 VirtualBox watchdog service with the following command: 5572 &product-name; watchdog service with the following command: 5573 </para> 5440 5574 5441 5575 <screen>svcadm enable svc:/application/virtualbox/balloonctrl:default</screen> 5442 </para> 5443 5444 <para> 5445 For more information about SMF, please refer to the Solaris 5446 documentation. 5576 5577 <para> 5578 For more information about SMF, please refer to the Oracle 5579 Solaris documentation. 5447 5580 </para> 5448 5581 … … 5456 5589 5457 5590 <para> 5458 Starting with VirtualBox 4.2.0 there is another extension pack,5459 <code>VNC</code>, which is open source and replaces the previous5460 integration of the VNC remote access protocol. Thisis5461 experimental code, and will be initially available in the5462 VirtualBox source code package only. It is to a large portion code5463 contributed by users, and isnot supported in any way by Oracle.5591 Another extension pack called VNC is available. This extension 5592 pack is open source and replaces the previous integration of the 5593 VNC remote access protocol. This is experimental code, and is 5594 initially available in the &product-name; source code package 5595 only. It is to a large portion code contributed by users, and is 5596 not supported in any way by Oracle. 5464 5597 </para> 5465 5598 … … 5473 5606 5474 5607 <para> 5475 It is possible to install both the Oracle VM VirtualBox Extension 5476 Pack and VNC, but only one VRDE module can be active at any time. 5477 The following command switches to the VNC VRDE module in VNC: 5608 It is possible to install both the &product-name; Extension Pack 5609 and VNC, but only one VRDE module can be active at any time. The 5610 following command switches to the VNC VRDE module in VNC: 5611 </para> 5478 5612 5479 5613 <screen>VBoxManage setproperty vrdeextpack VNC</screen> 5480 </para>5481 5614 5482 5615 <para> … … 5488 5621 other choice than having a clear-text password in the VM 5489 5622 configuration, which can be set with the following command: 5623 </para> 5490 5624 5491 5625 <screen>VBoxManage modifyvm "VM name" --vrdeproperty VNCPassword=secret</screen> 5492 </para>5493 5626 5494 5627 <para> … … 5496 5629 should be removed when a VM configuration is passed to another 5497 5630 person, for whatever purpose. Some VNC servers claim to have 5498 "encrypted"passwords in the configuration. This is not true5499 encryption, it is only concealing the passwords, which is exactly5500 as secure asclear-text passwords.5631 encrypted passwords in the configuration. This is not true 5632 encryption, it is only concealing the passwords, which is only as 5633 secure as using clear-text passwords. 5501 5634 </para> 5502 5635 5503 5636 <para> 5504 5637 The following command switches back to VRDP, if installed: 5505 5506 <screen>VBoxManage setproperty vrdeextpack "Oracle VM VirtualBox Extension Pack"</screen> 5507 </para>5638 </para> 5639 5640 <screen>VBoxManage setproperty vrdeextpack "&product-name; Extension Pack"</screen> 5508 5641 5509 5642 </sect1> … … 5514 5647 5515 5648 <para> 5516 Starting with VirtualBox 4.2.0 it is possible to start VMs 5517 automatically during system boot on Linux, Solaris and Mac OS X 5518 for all users. 5649 You can start VMs automatically during system boot on Linux, 5650 Oracle Solaris, and Mac OS X platforms for all users. 5519 5651 </para> 5520 5652 5521 5653 <sect2 id="autostart-linux"> 5522 5654 5523 <title>Linux: Starting the Autostart Service viainit</title>5655 <title>Linux: Starting the Autostart Service With init</title> 5524 5656 5525 5657 <para> … … 5549 5681 </para> 5550 5682 5551 <para>5552 5683 <screen> 5553 5684 # Default policy is to deny starting a VM, the other option is "allow". … … 5567 5698 } 5568 5699 </screen> 5569 </para>5570 5700 5571 5701 <para> 5572 5702 Every user who wants to enable autostart for individual machines 5573 has to set the path to the autostart database directory with 5703 has to set the path to the autostart database directory with the 5704 following command: 5705 </para> 5574 5706 5575 5707 <screen>VBoxManage setproperty autostartdbpath <Autostart directory></screen> 5576 </para>5577 5708 5578 5709 </sect2> … … 5580 5711 <sect2 id="autostart-solaris"> 5581 5712 5582 <title>Solaris: Starting the Autostart Service via SMF</title> 5583 5584 <para> 5585 On Solaris hosts, the VirtualBox autostart daemon is integrated 5586 into the SMF framework. To enable it you have to point the 5587 service to an existing configuration file which has the same 5588 format as on Linux, see <xref linkend="autostart-linux" />. For 5589 example: 5713 <title>Oracle Solaris: Starting the Autostart Service With SMF</title> 5714 5715 <para> 5716 On Oracle Solaris hosts, the &product-name; autostart daemon is 5717 integrated into the SMF framework. To enable it you have to 5718 point the service to an existing configuration file which has 5719 the same format as on Linux, see 5720 <xref linkend="autostart-linux" />. For example: 5721 </para> 5590 5722 5591 5723 <screen>svccfg -s svc:/application/virtualbox/autostart:default setprop \ 5592 5724 config/config=/etc/vbox/autostart.cfg</screen> 5593 </para>5594 5725 5595 5726 <para> 5596 5727 When everything is configured correctly you can start the 5597 VirtualBox autostart service with the following command: 5728 &product-name; autostart service with the following command: 5729 </para> 5598 5730 5599 5731 <screen>svcadm enable svc:/application/virtualbox/autostart:default</screen> 5600 </para> 5601 5602 <para> 5603 For more information about SMF, please refer to the Solaris 5604 documentation. 5732 5733 <para> 5734 For more information about SMF, please refer to the Oracle 5735 Solaris documentation. 5605 5736 </para> 5606 5737 … … 5609 5740 <sect2 id="autostart-osx"> 5610 5741 5611 <title>Mac OS X: Starting the Autostart Service vialaunchd</title>5612 5613 <para> 5614 On Mac OS X, launchd is used to start the VirtualBox autostart5615 service. An example configuration file can be found in5742 <title>Mac OS X: Starting the Autostart Service With launchd</title> 5743 5744 <para> 5745 On Mac OS X, launchd is used to start the &product-name; 5746 autostart service. An example configuration file can be found in 5616 5747 <computeroutput>/Applications/VirtualBox.app/Contents/MacOS/org.virtualbox.vboxautostart.plist</computeroutput>. 5617 5748 To enable the service copy the file to … … 5622 5753 second parameter to an existing configuration file which has the 5623 5754 same format as on Linux, see <xref linkend="autostart-linux" />. 5755 </para> 5756 5757 <para> 5624 5758 To manually start the service use the following command: 5759 </para> 5625 5760 5626 5761 <screen>launchctl load /Library/LaunchDaemons/org.virtualbox.vboxautostart.plist</screen> 5627 5762 5628 For additional information on how launchd services could be 5763 <para> 5764 For additional information on how launchd services can be 5629 5765 configured see: 5630 5766 </para> … … 5641 5777 <sect1 id="vboxexpertstoragemgmt"> 5642 5778 5643 <title> VirtualBoxExpert Storage Management</title>5644 5645 <para> 5646 In case the snapshot model of VirtualBox is not sufficient it is5647 possible to enable a special mode which makes it possible to5779 <title>&product-name; Expert Storage Management</title> 5780 5781 <para> 5782 In case the snapshot model of &product-name; is not sufficient it 5783 is possible to enable a special mode which makes it possible to 5648 5784 reconfigure storage attachments while the VM is paused. The user 5649 5785 has to make sure that the disk data stays consistent to the guest … … 5673 5809 5674 5810 <para> 5675 Some host power management events are handled by VirtualBox. The5676 actual behavior depends on the platform:5811 Some host power management events are handled by &product-name;. 5812 The actual behavior depends on the platform: 5677 5813 </para> 5678 5814 … … 5688 5824 <para> 5689 5825 This event is currently only handled on Windows hosts and Mac 5690 OS X hosts. When this event is generated, VirtualBoxwill5826 OS X hosts. When this event is generated, &product-name; will 5691 5827 pause all running VMs. 5692 5828 </para> … … 5701 5837 <para> 5702 5838 This event is currently only handled on Windows hosts and Mac 5703 OS X hosts. When this event is generated, VirtualBoxwill5839 OS X hosts. When this event is generated, &product-name; will 5704 5840 resume all VMs which are where paused before. 5705 5841 </para> … … 5715 5851 <para> 5716 5852 This event is currently only handled on Windows hosts and Mac 5717 OS X hosts. When this event is generated, VirtualBox will save5718 the state and terminate all VMs in preparation of a potential5719 host powerdown.5853 OS X hosts. When this event is generated, &product-name; will 5854 save the state and terminate all VMs in preparation of a 5855 potential host powerdown. 5720 5856 </para> 5721 5857 … … 5754 5890 To provide SSE 4.1/SSE 4.2 support to guests, the host CPU has to 5755 5891 implement these instruction sets. The instruction sets are exposed 5756 to guests by default, but it is possible to disable the instructions 5757 for certain guests using the following commands:</para> 5892 to guests by default, but it is possible to disable the 5893 instructions for certain guests by using the following commands: 5894 </para> 5895 5758 5896 <screen>VBoxManage setextradata "VM name" VBoxInternal/CPUM/IsaExts/SSE4.1 0 5759 5897 VBoxManage setextradata "VM name" VBoxInternal/CPUM/IsaExts/SSE4.2 0</screen> 5760 5898 5761 5899 <para> 5762 These are a per-VM settings which are turned onby default.5900 These are per-VM settings which are enabled by default. 5763 5901 </para> 5764 5902 … … 5767 5905 <sect1 id="hidledssync"> 5768 5906 5769 <title>Support for Keyboard Indicator sSynchronization</title>5770 5771 <para> 5772 This feature makes the host keyboard lights match those of the5773 virtual machine's emulated keyboard when the machine window is5774 selected. It is currently implemented for Mac OS X and Windows5775 hosts. The feature is enabled by default (on a supported host OS),5776 but can be disabled using the following command:5777 </para> 5778 5779 <screen>VBoxManage setextradata "VM name" GUI/HidLedsSync "0"</screen>5780 5781 <para> 5782 This is a per-VM setting and itis enabled by default.5907 <title>Support for Keyboard Indicator Synchronization</title> 5908 5909 <para> 5910 This feature makes the host keyboard indicators (LEDs) match those 5911 of the VM's emulated keyboard when the machine window is active. 5912 It is currently implemented for Mac OS X and Windows hosts. This 5913 feature is enabled by default on supported host OSes. You can 5914 disable this feature by running the following command: 5915 </para> 5916 5917 <screen>VBoxManage setextradata "VM name" GUI/HidLedsSync 0</screen> 5918 5919 <para> 5920 This is a per-VM setting, which is enabled by default. 5783 5921 </para> 5784 5922 … … 5790 5928 5791 5929 <para> 5792 Starting with VirtualBox 5.0 it is possible to capture USB traffic5793 for single USB devices or on the root hub level which captures the5794 t raffic of all USB devices attached to the root hub. VirtualBox5795 stores the traffic in a format which is compatible with Wireshark.5796 To capture the traffic of a specific USB device it must be5797 attached to the VM with VBoxManageusing the following command:5930 You can capture USB traffic for single USB devices or on the root 5931 hub level, which captures the traffic of all USB devices attached 5932 to the root hub. &product-name; stores the traffic in a format 5933 which is compatible with Wireshark. To capture the traffic of a 5934 specific USB device it must be attached to the VM with 5935 <command>VBoxManage</command> using the following command: 5798 5936 </para> 5799 5937 … … 5823 5961 5824 5962 <para> 5825 VirtualBoxships a simple heartbeat service. Once the Guest5963 &product-name; ships a simple heartbeat service. Once the Guest 5826 5964 Additions are active, the guest sends frequent heartbeat pings to 5827 5965 the host. If the guest stops sending the heartbeat pings without … … 5836 5974 interval</emphasis> defines the time between two heartbeat pings. 5837 5975 The default value is 2 seconds, that is, the heartbeat service of 5838 the VirtualBox Guest Additions will send a heartbeat ping every 5839 two seconds. The value in nanoseconds can be configured like this: 5976 the &product-name; Guest Additions will send a heartbeat ping 5977 every two seconds. The value in nanoseconds can be configured like 5978 this: 5840 5979 </para> 5841 5980 … … 5870 6009 5871 6010 <para> 5872 Starting with VirtualBox 5.0, it is possible to encrypt the data 5873 stored in hard disk images transparently for the guest. It does 5874 not depend on a specific image format to be used. Images which 5875 have the data encrypted are not portable between VirtualBox and 5876 other virtualization software. 5877 </para> 5878 5879 <para> 5880 VirtualBox uses the AES algorithm in XTS mode and supports 128-bit 5881 or 256-bit data encryption keys (DEK). The DEK is stored encrypted 5882 in the medium properties and is decrypted during VM startup by 5883 entering a password which was chosen when the image was encrypted. 6011 &product-name; enables you to transparently encrypt the data 6012 stored in hard disk images for the guest. It does not depend on a 6013 specific image format to be used. Images which have the data 6014 encrypted are not portable between &product-name; and other 6015 virtualization software. 6016 </para> 6017 6018 <para> 6019 &product-name; uses the AES algorithm in XTS mode and supports 6020 128-bit or 256-bit data encryption keys (DEK). The DEK is stored 6021 encrypted in the medium properties and is decrypted during VM 6022 startup by entering a password which was chosen when the image was 6023 encrypted. 5884 6024 </para> 5885 6025 … … 5905 6045 <listitem> 5906 6046 <para> 5907 This feature is part of the Oracle VM VirtualBox Extension5908 Pack, which needs to be installed. Otherwise disk encryption5909 isunavailable.6047 This feature is part of the &product-name; Extension Pack, 6048 which needs to be installed. Otherwise disk encryption is 6049 unavailable. 5910 6050 </para> 5911 6051 </listitem> … … 5942 6082 <para> 5943 6083 When encrypting or decrypting the images, the password is 5944 passed in clear text via the VirtualBox API. This needs to5945 be kept in mind, especially when using third party API5946 clients which make use of the webservice where the password5947 might be transmitted over the network. The use of HTTPS is5948 mandatory in such a case.6084 passed in clear text using the &product-name; API. This 6085 needs to be kept in mind, especially when using third party 6086 API clients which make use of the webservice where the 6087 password might be transmitted over the network. The use of 6088 HTTPS is mandatory in such a case. 5949 6089 </para> 5950 6090 </listitem> … … 5954 6094 Encrypting images with differencing images is only possible 5955 6095 if there are no snapshots or a linear chain of snapshots. 5956 This limitation may be addressed in a future VirtualBox6096 This limitation may be addressed in a future &product-name; 5957 6097 version. 5958 6098 </para> … … 5969 6109 <para> 5970 6110 Encrypting disk images can be done either using the GUI or 5971 VBoxManage. While the GUI is easier to use, it works on a per VM 5972 basis and encrypts all disk images attached to the specific VM. 5973 With VBoxManage one can encrypt individual images, including all 5974 differencing images. To encrypt an unencrypted medium with 5975 VBoxManage, use: 6111 <command>VBoxManage</command>. While the GUI is easier to use, 6112 it works on a per VM basis and encrypts all disk images attached 6113 to the specific VM. With <command>VBoxManage</command> one can 6114 encrypt individual images, including all differencing images. To 6115 encrypt an unencrypted medium with 6116 <command>VBoxManage</command>, use: 5976 6117 </para> 5977 6118 … … 5980 6121 5981 6122 <para> 5982 To supply the encryption password point VBoxManage to the file5983 where the password is stored or specify5984 <computeroutput>-</computeroutput> to let VBoxManage ask you for5985 the password on the command line.6123 To supply the encryption password point 6124 <command>VBoxManage</command> to the file where the password is 6125 stored or specify <option>-</option> to let VBoxManage ask you 6126 for the password on the command line. 5986 6127 </para> 5987 6128 … … 6014 6155 used, the VM will be paused as soon as the guest tries to access 6015 6156 an encrypted disk. The user needs to provide the passwords 6016 through VBoxManage using the following command: 6157 through <command>VBoxManage</command> using the following 6158 command: 6017 6159 </para> 6018 6160 … … 6041 6183 In some circumstances it might be required to decrypt previously 6042 6184 encrypted images. This can be done in the GUI for a complete VM 6043 or using VBoxManage with the following command: 6185 or using <command>VBoxManage</command> with the following 6186 command: 6044 6187 </para> 6045 6188 … … 6163 6306 6164 6307 <para> 6165 Value: Hyper-V vendor signature reported viaCPUID to the6308 Value: Hyper-V vendor signature reported by CPUID to the 6166 6309 guest 6167 6310 </para> … … 6175 6318 <para> 6176 6319 Specify the Hyper-V vendor signature which is exposed to the 6177 guest viaCPUID. For debugging Microsoft Windows guests, it6320 guest by CPUID. For debugging Microsoft Windows guests, it 6178 6321 is required the hypervisor reports the Microsoft vendor. 6179 6322 </para> … … 6222 6365 6223 6366 <para> 6224 Specify whether to expose the "VS#1" (virtualization6225 service) interface to the guest. This interface is required6226 fordebugging Microsoft Windows 10 32-bit guests, but is6367 Specify whether to expose the VS#1 virtualization service 6368 interface to the guest. This interface is required for 6369 debugging Microsoft Windows 10 32-bit guests, but is 6227 6370 optional for other Windows versions. 6228 6371 </para> … … 6238 6381 <para> 6239 6382 Windows supports debugging over a serial cable, USB, IEEE 1394 6240 Firewire, and Ethernet (only Windows 8 and later). USB and6241 IEEE 1394 are not applicable for virtual machines, and6242 Ethernet requires Windows 8 or later. While serial connection6243 is universally usable, it isslow.6383 Firewire, and Ethernet. USB and IEEE 1394 are not applicable 6384 for virtual machines, and Ethernet requires Windows 8 or 6385 later. While a serial connection is universally usable, it is 6386 slow. 6244 6387 </para> 6245 6388 … … 6263 6406 <para> 6264 6407 A VM configured for Hyper-V paravirtualization running a 6265 Windows Vista or newer Windows guest. You maycheck the6266 effective paravirtualization provider for your VM fromthe6267 output of the following VBoxManage command:6268 </para>6269 6270 <para> 6408 Windows Vista or newer Windows guest. You can check the 6409 effective paravirtualization provider for your VM with the 6410 output of the following <command>VBoxManage</command> 6411 command: 6412 </para> 6413 6271 6414 <screen>VBoxManage showvminfo "VM name"</screen> 6272 </para>6273 6415 </listitem> 6274 6416 … … 6287 6429 debugging with a Windows 7 or Vista guest, copy the file 6288 6430 <computeroutput>kdvm.dll</computeroutput> from a Windows 6289 8.0 installation 6290 6291 <footnote> 6292 6293 <para> 6294 Only Windows 8.0 ships 6295 <computeroutput>kdvm.dll</computeroutput>. Windows 8.1 6296 and newer Windows versions do not. 6297 </para> 6298 6299 </footnote> 6300 6301 . This file is typically located in 6431 8.0 installation. This file is typically located in 6302 6432 <computeroutput>C:\Windows\System32</computeroutput>. Copy 6303 6433 it to the same location in your Windows 7/Vista guest. … … 6305 6435 which matches your guest OS. 6306 6436 </para> 6437 6438 <note> 6439 <para> 6440 Only Windows 8.0 ships 6441 <computeroutput>kdvm.dll</computeroutput>. Windows 8.1 6442 and newer Windows versions do not. 6443 </para> 6444 </note> 6307 6445 </listitem> 6308 6446 … … 6323 6461 <listitem> 6324 6462 <para> 6325 Enable the debug options by executing the following 6326 VBoxManage command: 6327 </para> 6328 6329 <para> 6463 Enable the debug options with the following 6464 <command>VBoxManage</command> command: 6465 </para> 6466 6330 6467 <screen>VBoxManage modifyvm "VM name" --paravirtdebug "enabled=1"</screen> 6331 </para>6332 6468 6333 6469 <para> … … 6335 6471 your host machine on UDP port 50000. However, if you need 6336 6472 to run the debugger on a remote machine you may specify 6337 the remote address and port here. For example:: 6338 </para> 6339 6340 <para> 6473 the remote address and port here. For example: 6474 </para> 6475 6341 6476 <screen>VBoxManage modifyvm "VM name" --paravirtdebug "enabled=1,address=192.168.32.1,port=55000"</screen> 6342 </para>6343 6477 6344 6478 <para> … … 6367 6501 </para> 6368 6502 6369 <para>6370 6503 <screen>bcdedit /dbgsettings net hostip:5.5.5.5 port:50000 key:1.2.3.4</screen> 6371 </para>6372 6504 </listitem> 6373 6505 … … 6377 6509 </para> 6378 6510 6379 <para>6380 6511 <screen>bcdedit /set loadoptions host_ip=5.5.5.5,host_port=50000,encryption_key=1.2.3.4</screen> 6381 6512 6382 6513 <screen>bcdedit /set dbgtransport kdvm.dll</screen> 6383 </para>6384 6514 6385 6515 <para> 6386 6516 The IP address and port in the 6387 <com puteroutput>bcdedit</computeroutput> command are6388 ignored when using the Hyper-V debug transport. Any6389 valid IP and a port number greater than 49151 and6390 lower than 65536can be entered.6517 <command>bcdedit</command> command are ignored when 6518 using the Hyper-V debug transport. Any valid IP and a 6519 port number greater than 49151 and lower than 65536 6520 can be entered. 6391 6521 </para> 6392 6522 6393 6523 <para> 6394 The encryption key in the 6395 <computeroutput>bcdedit</computeroutput> command is 6396 relevant and must be valid. The key "1.2.3.4" used in 6397 the above example is valid and may be used if security 6398 is not a concern. If you do not specify any encryption 6399 key, <computeroutput>bcdedit</computeroutput> will 6400 generate one for you and you will need to copy this 6401 key to later enter in Microsoft WinDbg on the remote 6402 end. This encryption key is used to encrypt the debug 6403 data exchanged between Windows and the debugger. 6524 The encryption key in the <command>bcdedit</command> 6525 command is relevant and must be valid. The key 6526 "1.2.3.4" used in the above example is valid and may 6527 be used if security is not a concern. If you do not 6528 specify any encryption key, <command>bcdedit</command> 6529 will generate one for you and you will need to copy 6530 this key to later enter in Microsoft WinDbg on the 6531 remote end. This encryption key is used to encrypt the 6532 debug data exchanged between Windows and the debugger. 6404 6533 </para> 6405 6534 </listitem> … … 6407 6536 <listitem> 6408 6537 <para> 6409 Execute one or more of the following commands to6410 enable debugging for the appropriate phase or6411 component ofyour Windows guest:6538 Run one or more of the following commands to enable 6539 debugging for the appropriate phase or component of 6540 your Windows guest: 6412 6541 </para> 6413 6542 6543 <screen>bcdedit /set debug on</screen> 6544 6545 <screen>bcdedit /set bootdebug on</screen> 6546 6547 <screen>bcdedit /set {bootmgr} bootdebug on</screen> 6548 6414 6549 <para> 6415 <screen>bcdedit /set debug on</screen> 6416 6417 <screen>bcdedit /set bootdebug on</screen> 6418 6419 <screen>bcdedit /set {bootmgr} bootdebug on</screen> 6420 </para> 6421 6422 <para> 6423 Please note that the 6424 <computeroutput>bootdebug</computeroutput> options are 6425 only effective on Windows 8 or newer when using the 6426 Hyper-V debug transport. Refer to Microsoft Windows 6427 documentation for detailed explanation of 6428 <computeroutput>bcdedit</computeroutput> options. 6550 Please note that the <command>bootdebug</command> 6551 options are only effective on Windows 8 or newer when 6552 using the Hyper-V debug transport. Refer to Microsoft 6553 Windows documentation for detailed explanation of 6554 <command>bcdedit</command> options. 6429 6555 </para> 6430 6556 </listitem> … … 6442 6568 From the <emphasis role="bold">File</emphasis> menu, 6443 6569 select <emphasis role="bold">Kernel Debug</emphasis>. On 6444 the NET tab, specify the UDP port number you used in the 6570 the <emphasis role="bold">NET</emphasis> tab, specify the 6571 UDP port number you used in the 6445 6572 <computeroutput>paravirtdebug</computeroutput> options. If 6446 6573 you did not specify any, leave it as 50000. Ensure that … … 6450 6577 6451 6578 <para> 6452 In the Keyfield, enter6579 In the <emphasis role="bold">Key</emphasis> field, enter 6453 6580 <computeroutput>1.2.3.4</computeroutput> or the encryption 6454 6581 key from the <computeroutput>bcdedit</computeroutput> … … 6459 6586 Click <emphasis role="bold">OK</emphasis> to start 6460 6587 listening for connections. Microsoft WinDbg typically 6461 shows a "Waiting to reconnect" message during this phase. 6462 </para> 6463 6464 <para> 6465 Alternatively, launch WinDbg from the command line to 6466 directly start a debug session: 6588 shows a Waiting to Reconnect message during this phase. 6589 </para> 6590 6591 <para> 6592 Alternatively, to directly start a debug session, run 6593 WinDbg from the command line as follows : 6594 </para> 6467 6595 6468 6596 <screen>windbg.exe -k net:port=50000,key=1.2.3.4</screen> 6469 6597 6470 Please refer to the WinDbg documentation for complete 6471 command line syntax. 6598 <para> 6599 See the WinDbg documentation for the complete command line 6600 syntax. 6472 6601 </para> 6473 6602 </listitem> … … 6495 6624 As an experimental feature, primarily due to being limited to 6496 6625 Linux host only and unknown Linux distribution coverage, 6497 VirtualBox supports passing through the PC speaker to the host.6498 The PC speaker, sometimes called the system speaker, is a way to6499 produce audible feedback such as beeps without the need for6626 &product-name; supports passing through the PC speaker to the 6627 host. The PC speaker, sometimes called the system speaker, is a 6628 way to produce audible feedback such as beeps without the need for 6500 6629 regular audio and sound card support. 6501 6630 </para> 6502 6631 6503 6632 <para> 6504 The PC speaker passthrough feature in VirtualBoxhandles beeps6633 The PC speaker passthrough feature in &product-name; handles beeps 6505 6634 only. Advanced PC speaker use by the VM, such as PCM audio, will 6506 6635 not work, resulting in undefined host behavior. … … 6508 6637 6509 6638 <para> 6510 Producing beeps on Linux is a very complex topic. VirtualBox6639 Producing beeps on Linux is a very complex topic. &product-name; 6511 6640 offers a collection of options, in an attempt to make this work 6512 6641 deterministically and reliably on as many Linux distributions and … … 6520 6649 <thead> 6521 6650 <row> 6522 <entry><emphasis role="bold">Code</emphasis></entry> 6523 <entry><emphasis role="bold">Device</emphasis></entry> 6524 <entry><emphasis role="bold">Notes</emphasis></entry> 6651 <entry><para> 6652 <emphasis role="bold">Code</emphasis> 6653 </para></entry> 6654 <entry><para> 6655 <emphasis role="bold">Device</emphasis> 6656 </para></entry> 6657 <entry><para> 6658 <emphasis role="bold">Notes</emphasis> 6659 </para></entry> 6525 6660 </row> 6526 6661 </thead> 6527 6662 <tbody> 6528 6663 <row> 6529 <entry>1</entry> 6530 <entry><computeroutput>/dev/input/ by-path/platform- 6531 pcspkr-event-spkr</computeroutput></entry> 6532 <entry>Direct host PC speaker use.</entry> 6664 <entry><para> 6665 1 6666 </para></entry> 6667 <entry><para> 6668 <computeroutput>/dev/input/by-path/platform- 6669 pcspkr-event-spkr</computeroutput> 6670 </para></entry> 6671 <entry><para> 6672 Direct host PC speaker use. 6673 </para></entry> 6533 6674 </row> 6534 6675 <row> 6535 <entry>2</entry> 6676 <entry><para> 6677 2 6678 </para></entry> 6536 6679 <entry><computeroutput>/dev/tty</computeroutput></entry> 6537 <entry>Uses the terminal association of the VM process. VM needs to be started 6538 on a virtual console.</entry> 6680 <entry><para> 6681 Uses the terminal association of the VM process. VM 6682 needs to be started on a virtual console. 6683 </para></entry> 6539 6684 </row> 6540 6685 <row> 6541 <entry>3</entry> 6542 <entry><computeroutput>/dev/tty0</computeroutput> or 6543 <computeroutput>/dev/vc/0</computeroutput></entry> 6544 <entry>Can only be used by user <computeroutput>root</computeroutput> or users 6545 with capability 6546 <computeroutput>cap_sys_tty_config</computeroutput></entry> 6686 <entry><para> 6687 3 6688 </para></entry> 6689 <entry><para> 6690 <computeroutput>/dev/tty0</computeroutput> or 6691 <computeroutput>/dev/vc/0</computeroutput> 6692 </para></entry> 6693 <entry><para> 6694 Can only be used by user 6695 <computeroutput>root</computeroutput> or users with 6696 <computeroutput>cap_sys_tty_config</computeroutput> 6697 capability. 6698 </para></entry> 6547 6699 </row> 6548 6700 <row> 6549 <entry>9</entry> 6550 <entry>user specified console or evdev device path</entry> 6551 <entry>Like 1-3, just with a custom device path.</entry> 6701 <entry><para> 6702 9 6703 </para></entry> 6704 <entry><para> 6705 A user-specified console or evdev device path. 6706 </para></entry> 6707 <entry><para> 6708 As for codes 1 to 3, but with a custom device path. 6709 </para></entry> 6552 6710 </row> 6553 6711 <row> 6554 <entry>70</entry> 6555 <entry><computeroutput>/dev/tty</computeroutput></entry> 6556 <entry>Standard beep only. Loses frequency and length. See code 2.</entry> 6712 <entry><para> 6713 70 6714 </para></entry> 6715 <entry><para> 6716 <computeroutput>/dev/tty</computeroutput> 6717 </para></entry> 6718 <entry><para> 6719 Standard beep only. Loses frequency and length. See code 6720 2. 6721 </para></entry> 6557 6722 </row> 6558 6723 <row> 6559 <entry>79</entry> 6560 <entry>user specified terminal device path</entry> 6561 <entry>Like 70, just with a custom device path.</entry> 6724 <entry><para> 6725 79 6726 </para></entry> 6727 <entry><para> 6728 A user-specified terminal device path. 6729 </para></entry> 6730 <entry><para> 6731 As for code 70, but with a custom device path. 6732 </para></entry> 6562 6733 </row> 6563 6734 <row> 6564 <entry>100</entry> 6565 <entry>all of the above</entry> 6566 <entry>Tries all above codes.</entry> 6735 <entry><para> 6736 100 6737 </para></entry> 6738 <entry><para> 6739 All of the above. 6740 </para></entry> 6741 <entry><para> 6742 Tries all the available codes. 6743 </para></entry> 6567 6744 </row> 6568 6745 </tbody> … … 6572 6749 <para> 6573 6750 To enable PC speaker passthrough use the following command: 6751 </para> 6574 6752 6575 6753 <screen>VBoxManage setextradata "VM name" "VBoxInternal/Devices/i8254/0/Config/PassthroughSpeaker" N</screen> 6576 6754 6755 <para> 6577 6756 Replace <computeroutput>N</computeroutput> with the code 6578 6757 representing the case you want to use. Changing this setting will … … 6592 6771 <para> 6593 6772 Enabling PC speaker passthrough for the VM is usually the simple 6594 part. The real difficulty is making sure that VirtualBoxcan6773 part. The real difficulty is making sure that &product-name; can 6595 6774 access the necessary device, because in a typical Linux install 6596 6775 most of them can only be accessed by user 6597 6776 <computeroutput>root</computeroutput>. You should follow the 6598 preferred way to persistently change this, e.g.by referring to6777 preferred way to persistently change this, such as by referring to 6599 6778 your distribution's documentation. Since there are countless Linux 6600 6779 distribution variants, we can only give the general hints that … … 6608 6787 <para> 6609 6788 Sometimes additional rules are applied by the kernel to limit 6610 access (e.g. that the VM process must have the same controlling6611 terminal as the device configured to be used for beeping,6612 something which is often very difficult to achieve for GUI6613 applications such as VirtualBox). The table above contains some6614 hints, but generallyrefer to the Linux documentation.6789 access. For example, that the VM process must have the same 6790 controlling terminal as the device configured to be used for 6791 beeping, something which is often very difficult to achieve for 6792 GUI applications such as &product-name;. The table above contains 6793 some hints, but in general refer to the Linux documentation. 6615 6794 </para> 6616 6795 … … 6623 6802 Check if the beeps are audible if you connect speakers to your 6624 6803 sound card. Today almost all systems have one. Finally, check if 6625 the audio mixer control has a channel named "beep" (could be6626 hidden in the mixer settings )and that it is not muted.6804 the audio mixer control has a channel named "beep", which could be 6805 hidden in the mixer settings, and that it is not muted. 6627 6806 </para> 6628 6807 … … 6634 6813 6635 6814 <para> 6636 Starting with 5.1.0, VirtualBox supports passing through USB6637 devices which are exposed over the network using the USB over IP6638 protocol without the need to configure the client side provided by6639 the kernel and usbip tools. Furthermore, this feature works with6640 VirtualBox running on any supported host, rather than just Linux6641 alone, as isthe case with the official client.6815 &product-name; supports passing through USB devices which are 6816 exposed over the network using the USB over IP protocol without 6817 the need to configure the client side provided by the kernel and 6818 usbip tools. Furthermore, this feature works with &product-name; 6819 running on any supported host, rather than just Linux alone, as is 6820 the case with the official client. 6642 6821 </para> 6643 6822 … … 6646 6825 server exporting the devices must be added with the following 6647 6826 command: 6827 </para> 6648 6828 6649 6829 <screen>VBoxManage usbdevsource add "Unique name" --backend "USBIP" --address "Device server[:port]"</screen> 6650 6830 6831 <para> 6651 6832 USB devices exported on the device server are then accessible 6652 through the GUI or VBoxManage, like any USB devices attached6653 locally. This can be used multiple times to access different6654 device servers.6833 through the GUI or <command>VBoxManage</command>, like any USB 6834 devices attached locally. This can be used multiple times to 6835 access different device servers. 6655 6836 </para> 6656 6837 6657 6838 <para> 6658 6839 To remove a device server, the following command can be used: 6840 </para> 6659 6841 6660 6842 <screen>VBoxManage usbdevsource remove "Unique name"</screen> 6661 </para>6662 6843 6663 6844 <sect2 id="usbip-setup-server"> … … 6674 6855 The particular installation method for the necessary tools 6675 6856 depends on which distribution is used. For example, for Debian 6676 based systems -the following command should be used to install6857 based systems, the following command should be used to install 6677 6858 the required tools: 6859 </para> 6678 6860 6679 6861 <screen>apt-get install usbip-utils</screen> 6680 </para>6681 6862 6682 6863 <para> 6683 6864 To check whether the necessary tools are already installed use 6684 6865 the following command: 6866 </para> 6685 6867 6686 6868 <screen> 6687 6869 $ usbip list -l 6688 6870 </screen> 6689 </para>6690 6871 6691 6872 <para> 6692 6873 This should produce output similar to that shown in the example 6693 6874 below: 6875 </para> 6694 6876 6695 6877 <screen> … … 6700 6882 Logitech, Inc. : Unifying Receiver (046d:c52b) 6701 6883 </screen> 6702 </para>6703 6884 6704 6885 <para> … … 6706 6887 started as <computeroutput>root</computeroutput> using the 6707 6888 following command: 6889 </para> 6708 6890 6709 6891 <screen>usbipd -D</screen> 6710 6892 6893 <para> 6711 6894 Refer to the documentation for the installed distribution to 6712 6895 determine how to start the service when the system boots. … … 6715 6898 <para> 6716 6899 By default, no device on the server is exported. This must be 6717 done manually for each device. To export a device use: 6900 done manually for each device. To export a device use the 6901 following command: 6902 </para> 6718 6903 6719 6904 <screen>usbip bind -b "bus identifier"</screen> 6720 6905 6721 To export the multicard reader from above, for example - use: 6906 <para> 6907 To export the multicard reader in the previous example: 6908 </para> 6722 6909 6723 6910 <screen>usbip bind -b 4-2</screen> 6724 </para>6725 6911 6726 6912 </sect2> … … 6745 6931 </sect1> 6746 6932 6747 <xi:include href="user_isomakercmd-man.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> 6933 <sect1 id="hyperv-support"> 6934 6935 <title>Using Hyper-V with &product-name;</title> 6936 6937 <para> 6938 &product-name; can be used on a Windows host where Hyper-V is 6939 running. This is an experimental feature. 6940 </para> 6941 6942 <para> 6943 No configuration is required. &product-name; detects Hyper-V 6944 automatically and uses Hyper-V as the virtualization engine for 6945 the host. The CPU icon in the VM window status bar indicates that 6946 Hyper-V is being used. 6947 </para> 6948 6949 <note> 6950 <para> 6951 When using this feature, you might experience significant 6952 &product-name; performance degradation on some host systems. 6953 </para> 6954 </note> 6955 6956 </sect1> 6957 6958 <sect1 id="nested-virt"> 6959 6960 <title>Nested Virtualization</title> 6961 6962 <para> 6963 &product-name; supports <emphasis>nested virtualization</emphasis> 6964 on host systems that run AMD CPUs. This feature enables the 6965 passthrough of hardware virtualization functions to the guest VM. 6966 That means that you can install a hypervisor, such as 6967 &product-name; or KVM, on an &product-name; guest. You can then 6968 create and run VMs within the guest VM. 6969 </para> 6970 6971 <para> 6972 You can enable the nested virtualization feature in one of the 6973 following ways: 6974 </para> 6975 6976 <itemizedlist> 6977 6978 <listitem> 6979 <para> 6980 From the VirtualBox Manager, select the 6981 <emphasis role="bold">Enable Nested VT-x/AMD-V</emphasis> 6982 check box on the <emphasis role="bold">System</emphasis> tab. 6983 To disable the feature, deselect the check box. 6984 </para> 6985 </listitem> 6986 6987 <listitem> 6988 <para> 6989 Use the <option>--nested-hw-virt</option> option of the 6990 <command>VBoxManage modifyvm</command> command to enable or 6991 disable nested virtualization. See 6992 <xref linkend="vboxmanage-modifyvm"/>. 6993 </para> 6994 </listitem> 6995 6996 </itemizedlist> 6997 6998 </sect1> 6999 7000 <xi:include href="user_isomakercmd-man.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" /> 6748 7001 6749 7002 </chapter> -
trunk/doc/manual/en_US/user_BasicConcepts.xml
r75137 r76078 10 10 11 11 <para> 12 Whereas <xref linkend="Introduction" /> gave you a quick13 introduction to VirtualBox and how to get your first virtual machine14 running, the following chapter describes in detail how to configure15 virtual machines.12 This chapter provides detailed steps for configuring an 13 &product-name; virtual machine (VM). For an introduction to 14 &product-name; and steps to get your first virtual machine running, 15 see <xref linkend="Introduction" />. 16 16 </para> 17 17 18 18 <para> 19 You have considerable latitude in deciding what virtual hardware 20 will be provided to the guest. The virtual hardware can be used for 21 communicating with the host system or with other guests. For 22 instance, if you provide VirtualBox with the image of a CD-ROM in an 23 ISO file, VirtualBox can present this image to a guest system as if 24 it were a physical CD-ROM. Similarly, you can give a guest system 25 access to the real network via its virtual network card, and, if you 26 so choose, give the host system, other guests, or computers on the 27 Internet access to the guest system. 19 You have considerable latitude when deciding what virtual hardware 20 to provide to the guest. Use virtual hardware to communicate with 21 the host system or with other guests. For example, you can use 22 virtual hardware in the following ways: 28 23 </para> 29 24 25 <itemizedlist> 26 27 <listitem> 28 <para> 29 Have &product-name; present an ISO CD-ROM image to a guest 30 system as if it were a physical CD-ROM. 31 </para> 32 </listitem> 33 34 <listitem> 35 <para> 36 Provide a guest system access to the physical network through 37 its virtual network card. 38 </para> 39 </listitem> 40 41 <listitem> 42 <para> 43 Provide the host system, other guests, and computers on the 44 Internet access to the guest system. 45 </para> 46 </listitem> 47 48 </itemizedlist> 49 30 50 <sect1 id="guestossupport"> 31 51 … … 33 53 34 54 <para> 35 Since VirtualBox is designed to provide a generic virtualization36 environment for x86 systems, it may run operating systems of any37 kind, even those not listed here. However, the focus is to38 optimize VirtualBox for thefollowing guest systems:55 Because &product-name; is designed to provide a generic 56 virtualization environment for x86 systems, it can run operating 57 systems (OSes) of any kind. However, &product-name; focuses on the 58 following guest systems: 39 59 </para> 40 60 … … 46 66 </para> 47 67 48 <para> 49 All versions, editions and service packs are fully supported. 50 However, there are some issues with older service packs. We 51 recommend that you install service pack 6a. Guest Additions 52 are available with a limited feature set. 53 </para> 68 <itemizedlist> 69 70 <listitem> 71 <para> 72 Fully supports all versions, editions, and service packs. 73 Note that you might encounter issues with some older 74 service packs, so install at least service pack 6a. 75 </para> 76 </listitem> 77 78 <listitem> 79 <para> 80 Guest Additions are available with a limited feature set. 81 </para> 82 </listitem> 83 84 </itemizedlist> 54 85 </listitem> 55 86 56 87 <listitem> 57 88 <para> 58 <emphasis role="bold">Windows 2000/XP/Server 2003/Vista/Server 59 2008/7/8/8.1/10 RTM 10240/Server 2012:</emphasis> 60 </para> 61 62 <para> 63 All versions, editions and service packs are fully supported, 64 including 64-bit versions, under the preconditions listed 65 below. Guest Additions are available. Windows 8 and later 66 requires hardware virtualization to be enabled. 67 </para> 89 <emphasis role="bold">Windows 2000, Windows XP, Windows Server 90 2003, Windows Vista, Windows Server 2008, Windows 7, Windows 91 8, Windows 8.1, Windows 10 RTM 10240, Windows Server 92 2012:</emphasis> 93 </para> 94 95 <itemizedlist> 96 97 <listitem> 98 <para> 99 Fully supports all versions, editions, and service packs, 100 including 64-bit versions under the preconditions for 101 MS-DOS, Windows 3.x, Windows 95, Windows 98, and Windows 102 ME. 103 </para> 104 </listitem> 105 106 <listitem> 107 <para> 108 Note that you must enable hardware virtualization when 109 running at least Windows 8. 110 </para> 111 </listitem> 112 113 <listitem> 114 <para> 115 Guest Additions are available. 116 </para> 117 </listitem> 118 119 </itemizedlist> 68 120 </listitem> 69 121 70 122 <listitem> 71 123 <para> 72 <emphasis role="bold">DOS/Windows 3.x/95/98/ME:</emphasis> 73 </para> 74 75 <para> 76 Limited testing has been performed. Use beyond legacy 77 installation mechanisms is not recommended. Guest Additions 78 are not available. 79 </para> 124 <emphasis role="bold">MS-DOS, Windows 3.x, Windows 95, Windows 125 98, Windows ME:</emphasis> 126 </para> 127 128 <itemizedlist> 129 130 <listitem> 131 <para> 132 Limited testing has been performed. 133 </para> 134 </listitem> 135 136 <listitem> 137 <para> 138 Use beyond legacy installation mechanisms is not 139 recommended. 140 </para> 141 </listitem> 142 143 <listitem> 144 <para> 145 Guest Additions are not available. 146 </para> 147 </listitem> 148 149 </itemizedlist> 80 150 </listitem> 81 151 … … 95 165 </para> 96 166 97 <para> 98 All versions and editions are fully supported, both 32-bit and 99 64-bit. Guest Additions are available. 100 </para> 101 102 <para> 103 We strongly recommend using a Linux kernel version of 2.6.13 104 or later for best performance. 105 </para> 167 <itemizedlist> 168 169 <listitem> 170 <para> 171 Fully supports all versions and editions, both 32-bit and 172 64-bit. 173 </para> 174 </listitem> 175 176 <listitem> 177 <para> 178 For best performance, use at least Linux kernel version 179 2.6.13. 180 </para> 181 </listitem> 182 183 <listitem> 184 <para> 185 Guest Additions are available. 186 </para> 187 </listitem> 188 189 </itemizedlist> 106 190 107 191 <note> … … 109 193 Certain Linux kernel releases have bugs that prevent them 110 194 from executing in a virtual environment. See 111 <xref 112 linkend="ts_linux-buggy" />. 195 <xref linkend="ts_linux-buggy" />. 113 196 </para> 114 197 </note> … … 120 203 </para> 121 204 122 <para> 123 All versions and editions are fully supported, both 32-bit and 124 64-bit. Guest Additions are available. 125 </para> 205 <itemizedlist> 206 207 <listitem> 208 <para> 209 Fully supports all versions and editions, both 32-bit and 210 64-bit. 211 </para> 212 </listitem> 213 214 <listitem> 215 <para> 216 Guest Additions are available. 217 </para> 218 </listitem> 219 220 </itemizedlist> 126 221 </listitem> 127 222 128 223 <listitem> 129 224 <para> 130 <emphasis role="bold"> Solaris 10u6 and higher, Solaris 11, 131 including Solaris 11 Express:</emphasis> 132 </para> 133 134 <para> 135 Fully supported. 64-bit, prior to Solaris 11 11/11, and also 136 32 32-bit. Guest Additions are available. 137 </para> 225 <emphasis role="bold"> Oracle Solaris 10 and Oracle Solaris 226 11:</emphasis> 227 </para> 228 229 <itemizedlist> 230 231 <listitem> 232 <para> 233 Fully supports all versions starting with Oracle Solaris 234 10 8/08 and Oracle Solaris 11. 235 </para> 236 </listitem> 237 238 <listitem> 239 <para> 240 Supports 64-bit prior to Oracle Solaris 11 11/11, and 241 32-bit. 242 </para> 243 </listitem> 244 245 <listitem> 246 <para> 247 Guest Additions are available. 248 </para> 249 </listitem> 250 251 </itemizedlist> 138 252 </listitem> 139 253 … … 143 257 </para> 144 258 145 <para> 146 Requires hardware virtualization to be enabled. Limited 147 support. Guest Additions are not available yet. 148 </para> 259 <itemizedlist> 260 261 <listitem> 262 <para> 263 Limited support. 264 </para> 265 </listitem> 266 267 <listitem> 268 <para> 269 Note that you must enable hardware virtualization when 270 running FreeBSD. 271 </para> 272 </listitem> 273 274 <listitem> 275 <para> 276 Guest Additions are not available. 277 </para> 278 </listitem> 279 280 </itemizedlist> 149 281 </listitem> 150 282 … … 154 286 </para> 155 287 156 <para> 157 Requires hardware virtualization to be enabled. Versions 3.7 158 and later are supported. Guest Additions are not available 159 yet. 160 </para> 288 <itemizedlist> 289 290 <listitem> 291 <para> 292 Supports at least version 3.7. 293 </para> 294 </listitem> 295 296 <listitem> 297 <para> 298 Note that you must enable hardware virtualization when 299 running OpenBSD. 300 </para> 301 </listitem> 302 303 <listitem> 304 <para> 305 Guest Additions are not available. 306 </para> 307 </listitem> 308 309 </itemizedlist> 161 310 </listitem> 162 311 … … 166 315 </para> 167 316 168 <para> 169 Requires hardware virtualization to be enabled. We officially 170 support MCP2 only. Other OS/2 versions may or may not work. 171 Guest Additions are available with a limited feature set. See 172 <xref linkend="KnownIssues" />. 173 </para> 317 <itemizedlist> 318 319 <listitem> 320 <para> 321 Only MCP2 is supported. Other OS/2 versions might not 322 work. 323 </para> 324 </listitem> 325 326 <listitem> 327 <para> 328 Note that you must enable hardware virtualization when 329 running OS/2 Warp 4.5. 330 </para> 331 </listitem> 332 333 <listitem> 334 <para> 335 Guest Additions are available with a limited feature set. 336 See <xref linkend="KnownIssues" />. 337 </para> 338 </listitem> 339 340 </itemizedlist> 174 341 </listitem> 175 342 … … 179 346 </para> 180 347 181 <para> 182 VirtualBox 3.2 added experimental support for Mac OS X guests, 183 but this comes with restrictions. See 184 <xref linkend="intro-macosxguests"/> and also 185 <xref linkend="KnownIssues" />. 186 </para> 348 <itemizedlist> 349 350 <listitem> 351 <para> 352 &product-name; 3.2 added experimental support for Mac OS X 353 guests, with restrictions. See 354 <xref linkend="intro-macosxguests"/> and 355 <xref linkend="KnownIssues" />. 356 </para> 357 </listitem> 358 359 <listitem> 360 <para> 361 Guest Additions are not available. 362 </para> 363 </listitem> 364 365 </itemizedlist> 187 366 </listitem> 188 367 … … 194 373 195 374 <para> 196 Starting with version 3.2, VirtualBox has experimental support 197 for Mac OS X guests. This allows you to install and execute 198 unmodified versions of Mac OS X on supported host hardware. 199 </para> 200 201 <para> 202 Whereas competing solutions perform modifications to the Mac OS 203 X install DVDs, such as a different boot loader and replaced 204 files, VirtualBox is the first product to provide the modern PC 205 architecture expected by OS X without requiring any "hacks". 206 </para> 207 208 <para> 209 You should be aware of a number of important issues before 210 attempting to install a Mac OS X guest: 375 &product-name; enables you to install and execute unmodified 376 versions of Mac OS X guests on supported host hardware. Note 377 that this feature is experimental and thus unsupported. 378 </para> 379 380 <para> 381 &product-name; is the first product to provide the modern PC 382 architecture expected by OS X without requiring any of the 383 modifications used by competing virtualization solutions. For 384 example, some competing solutions perform modifications to the 385 Mac OS X install DVDs, such as a different boot loader and 386 replaced files. 387 </para> 388 389 <para> 390 Be aware of the following important issues before you attempt to 391 install a Mac OS X guest: 211 392 </para> 212 393 … … 218 399 <emphasis role="bold">both license and technical 219 400 restrictions</emphasis> that limit its use to certain 220 hardware and usage scenarios. It is important that you221 understand and obeythese restrictions.222 </para> 223 224 <para> 225 In particular, for most versions of Mac OS X, Apple226 prohibits installing themon non-Apple hardware.401 hardware and usage scenarios. You must understand and comply 402 with these restrictions. 403 </para> 404 405 <para> 406 In particular, Apple prohibits the installation of most 407 versions of Mac OS X on non-Apple hardware. 227 408 </para> 228 409 229 410 <para> 230 411 These license restrictions are also enforced on a technical 231 level. Mac OS X verifies whetherit is running on Apple232 hardware , and most DVDs that come with Apple hardware even233 check for anexact model. These restrictions are234 <emphasis>not</emphasis> circumvented by VirtualBoxand412 level. Mac OS X verifies that it is running on Apple 413 hardware. Most DVDs that accompany Apple hardware check for 414 the exact model. These restrictions are 415 <emphasis>not</emphasis> circumvented by &product-name; and 235 416 continue to apply. 236 417 </para> … … 239 420 <listitem> 240 421 <para> 241 Only <emphasis role="bold">CPUs</emphasis> known and tested 242 by Apple are supported. As a result, if your Intel CPU is 243 newer than the build of Mac OS X, or if you have a non-Intel 244 CPU, it will most likely panic during bootup with an 245 "Unsupported CPU" exception. It is generally best to use the 246 Mac OS X DVD that came with your Apple hardware. 247 </para> 248 </listitem> 249 250 <listitem> 251 <para> 252 The Mac OS X installer expects the harddisk to be 253 <emphasis role="bold">partitioned</emphasis> so when it does 254 not offer a selection, you have to start the Disk Utility 255 from the Tools menu and partition the hard disk. Then close 256 the Disk Utility and proceed with the installation. 257 </para> 258 </listitem> 259 260 <listitem> 261 <para> 262 In addition, as Mac OS X support in VirtualBox is currently 263 still experimental, see also <xref linkend="KnownIssues" />. 422 Only <emphasis role="bold">CPUs</emphasis> that are known 423 and tested by Apple are supported. As a result, if your 424 Intel CPU is newer than the Mac OS X build, or if you have a 425 non-Intel CPU, you will likely encounter a panic during 426 bootup with an "Unsupported CPU" exception. 427 </para> 428 429 <para> 430 Ensure that you use the Mac OS X DVD that comes with your 431 Apple hardware. 432 </para> 433 </listitem> 434 435 <listitem> 436 <para> 437 The Mac OS X installer expects the hard disk to be 438 <emphasis>partitioned</emphasis>. So, the installer will not 439 offer a partition selection to you. Before you can install 440 the software successfully, start the Disk Utility from the 441 Tools menu and partition the hard disk. Close the Disk 442 Utility and proceed with the installation. 443 </para> 444 </listitem> 445 446 <listitem> 447 <para> 448 In addition, Mac OS X support in &product-name; is an 449 experimental feature. See <xref linkend="KnownIssues" />. 264 450 </para> 265 451 </listitem> … … 274 460 275 461 <para> 276 VirtualBox supports 64-bit guest operating systems, even on 277 32-bit host operating systems, 278 279 <footnote> 280 281 <para> 282 64-bit guest support was added with VirtualBox 2.0; support 283 for 64-bit guests on 32-bit hosts was added with VirtualBox 284 2.1. 285 </para> 286 287 </footnote> 288 289 provided that the following conditions are met: 462 &product-name; enables you to run 64-bit guest OSes even on a 463 32-bit host OS. To run a 64-bit guest OS on a 32-bit host 464 system, ensure that you meet the following conditions: 290 465 </para> 291 466 … … 294 469 <listitem> 295 470 <para> 296 You need a 64-bit processor withhardware virtualization471 You need a 64-bit processor that has hardware virtualization 297 472 support. See <xref linkend="hwvirt" />. 298 473 </para> … … 302 477 <para> 303 478 You must enable hardware virtualization for the particular 304 VM for which you want 64-bit support. Software 305 virtualization is not supported for 64-bit VMs. 306 </para> 307 </listitem> 308 309 <listitem> 310 <para> 311 If you want to use 64-bit guest support on a 32-bit host 312 operating system, you must also select a 64-bit operating 313 system for the particular VM. Since supporting 64 bits on 314 32-bit hosts incurs additional overhead, VirtualBox only 315 enables this support upon explicit request. 316 </para> 317 318 <para> 319 On 64-bit hosts, which typically come with hardware 320 virtualization support, 64-bit guest operating systems are 321 always supported regardless of settings. So you can simply 322 install a 64-bit operating system in the guest. 479 VM that requires 64-bit support. Software virtualization is 480 not supported for 64-bit VMs. 481 </para> 482 </listitem> 483 484 <listitem> 485 <para> 486 To use 64-bit guest support on a 32-bit host OS, you must 487 select a 64-bit OS for the particular VM. Since supporting 488 64 bits on 32-bit hosts incurs additional overhead, 489 &product-name; only enables this support only upon explicit 490 request. 491 </para> 492 493 <para> 494 64-bit hosts typically come with hardware virtualization 495 support. So, you can install a 64-bit guest OS in the guest 496 regardless of the settings. 323 497 </para> 324 498 </listitem> … … 326 500 </itemizedlist> 327 501 328 <para> 329 <warning> 330 <para> 331 On any host, you should enable <emphasis role="bold">I/O 332 APIC</emphasis> for virtual machines that you intend to use 333 in 64-bit mode. This is especially true for 64-bit Windows 334 VMs. See <xref linkend="settings-general-advanced" />. In 335 addition, for 64-bit Windows guests, you should make sure 336 that the VM uses the <emphasis role="bold">Intel networking 337 device</emphasis>, since there is no 64-bit driver support 338 for the AMD PCNet card. See 339 <xref 340 linkend="nichardware" />. 341 </para> 342 </warning> 343 </para> 344 345 <para> 346 If you use the <emphasis role="bold">Create VM </emphasis> 347 wizard of the VirtualBox graphical user interface, see 348 <xref linkend="gui-createvm" />, VirtualBox will automatically 349 use the correct settings for each selected 64-bit operating 350 system type. 502 <warning> 503 <para> 504 Be sure to enable <emphasis role="bold">I/O APIC</emphasis> 505 for virtual machines that you intend to use in 64-bit mode. 506 This is especially true for 64-bit Windows VMs. See 507 <xref linkend="settings-general-advanced" />. For 64-bit 508 Windows guests, ensure that the VM uses the 509 <emphasis role="bold">Intel networking device</emphasis> 510 because there is no 64-bit driver support for the AMD PCNet 511 card. See <xref linkend="nichardware" />. 512 </para> 513 </warning> 514 515 <para> 516 If you use the <emphasis role="bold">Create VM</emphasis> wizard 517 of the &product-name; graphical user interface (GUI), 518 &product-name; automatically uses the correct settings for each 519 selected 64-bit OS type. See <xref linkend="gui-createvm" />. 351 520 </para> 352 521 … … 360 529 361 530 <para> 362 VirtualBox is able to automatically install a guest by providing 363 the installation medium as well as a few parameters like the name 364 of the default user. 365 </para> 366 367 <para> 368 To perform an unattended guest installation, a VM has to be 369 prepared. A VM can be created using the GUI as described in 370 <xref 371 linkend="gui-createvm" /> or by using VBoxManage as 372 described in <xref linkend="vboxmanage-createvm" />. In general 373 it's sufficient to chose the type of the guest operating system 374 and to use the proposed defaults for that operating system. See 375 the following sections on how to change the VM settings for 376 certain needs. 377 </para> 378 379 <para> 380 After the VM was created, the VM has to be prepared for unattended 381 guest execution use VBoxManage, see 382 <xref 383 linkend="vboxmanage-unattended" />. During this step 384 VirtualBox scans the installation medium and changes certain 385 parameters for a seamless installation as a guest running on 386 VirtualBox. 387 </para> 388 389 <para> 390 Once the preparation phase was successfully finished, the VM can 391 be started either from the GUI or from VBoxManage, see 392 <xref 393 linkend="vboxmanage-startvm" />. The VM will now perform 394 the automatic installation. Please note that the boot order was 395 changed during the preparation phase by giving the virtual hard 396 disk the highest priority. As the disk is normally empty before an 397 automatic installation is started, the VM will boot from the 398 virtual DVD drive as next available boot medium and the 399 installation will start. If, for some reason, the virtual hard 400 disk contains a bootable operating system then the installation 401 will not start unless the boot order was manually changed by 402 pressing F12 during the BIOS splash screen. 403 </para> 531 &product-name; is able to install a guest operating system 532 automatically. You only need to provide the installation medium 533 and a few other parameters, such as the name of the default user. 534 </para> 535 536 <para> 537 Performing an unattended guest installation involves the following 538 steps: 539 </para> 540 541 <itemizedlist> 542 543 <listitem> 544 <para> 545 <emphasis role="bold">Create a new VM.</emphasis> You can use 546 either of the following to do this: 547 </para> 548 549 <itemizedlist> 550 551 <listitem> 552 <para> 553 The VirtualBox Manager, see 554 <xref linkend="gui-createvm" />. 555 </para> 556 </listitem> 557 558 <listitem> 559 <para> 560 The <command>VBoxManage</command> command, see 561 <xref linkend="vboxmanage-createvm" />. 562 </para> 563 </listitem> 564 565 </itemizedlist> 566 567 <para> 568 For the new VM, you can usually just choose the type of the 569 guest operating system and accept the default settings for 570 that operating system. The following sections in this chapter 571 describe how to change the settings for a VM. 572 </para> 573 </listitem> 574 575 <listitem> 576 <para> 577 <emphasis role="bold">Prepare the VM for unattended guest 578 installation.</emphasis> Use the <command>VBoxManage 579 unattended</command> command, see 580 <xref linkend="vboxmanage-unattended" />. 581 </para> 582 583 <para> 584 During this step, &product-name; scans the installation medium 585 and changes certain parameters to ensure a seamless 586 installation as a guest running on &product-name;. 587 </para> 588 </listitem> 589 590 <listitem> 591 <para> 592 <emphasis role="bold">Start the VM.</emphasis> You can use the 593 VirtualBox Manager or the <command>VBoxManage 594 startvm</command> command. 595 </para> 596 597 <para> 598 When you start the VM, the unattended installation is 599 performed automatically. 600 </para> 601 602 <para> 603 Note that the boot order is changed during the preparation 604 step, giving the virtual hard disk the highest priority. As 605 this disk is normally empty before an automatic installation 606 is started, the VM will instead boot from the virtual DVD 607 drive as next available boot medium and the installation will 608 start. If the virtual hard disk contains a bootable operating 609 system, then the installation will not start. The boot order 610 must be manually changed, by pressing F12 during the BIOS 611 splash screen. 612 </para> 613 </listitem> 614 615 </itemizedlist> 616 617 <para> 618 <xref linkend="unattended-guest-install-example"/> describes how 619 to perform an unattended guest installation for an Oracle Linux 620 guest. 621 </para> 622 623 <sect2 id="unattended-guest-install-example"> 624 625 <title>An Example of Unattended Guest Installation</title> 626 627 <para> 628 The following example shows how to perform an unattended guest 629 installation for an Oracle Linux virtual machine. The example 630 uses various <command>VBoxManage</command> commands to prepare 631 the guest VM. The <command>VBoxManage unattended 632 install</command> command is then used to install and configure 633 the guest operating system. 634 </para> 635 636 <orderedlist> 637 638 <listitem> 639 <para> 640 Create the virtual machine. 641 </para> 642 643 <screen># VM="ol7-autoinstall" 644 # VBoxManage list ostypes 645 # VBoxManage createvm --name $VM --ostype "Oracle_64" --register</screen> 646 647 <para> 648 Note the following: 649 </para> 650 651 <itemizedlist> 652 653 <listitem> 654 <para> 655 The variable $VM represents the name of the VM. 656 </para> 657 </listitem> 658 659 <listitem> 660 <para> 661 The <command>VBoxManage list ostypes</command> command 662 lists the guest operating systems supported by 663 &product-name;, including the name used for each 664 operating system in the <command>VBoxManage</command> 665 commands. 666 </para> 667 </listitem> 668 669 <listitem> 670 <para> 671 A 64-bit Oracle Linux 7 VM is created and registered 672 with &product-name;. 673 </para> 674 </listitem> 675 676 <listitem> 677 <para> 678 The VM has a unique UUID. 679 </para> 680 </listitem> 681 682 <listitem> 683 <para> 684 An XML settings file is generated. 685 </para> 686 </listitem> 687 688 </itemizedlist> 689 </listitem> 690 691 <listitem> 692 <para> 693 Create a virtual hard disk and storage devices for the VM. 694 </para> 695 696 <screen># VBoxManage createhd --filename /VirtualBox/$VM/$VM.vdi --size 32768 697 # VBoxManage storagectl $VM --name "SATA Controller" --add sata --controller IntelAHCI 698 # VBoxManage storageattach $VM --storagectl "SATA Controller" --port 0 --device 0 \ 699 --type hdd --medium /VirtualBox/$VM/$VM.vdi 700 # VBoxManage storagectl $VM --name "IDE Controller" --add ide 701 # VBoxManage storageattach $VM --storagectl "IDE Controller" --port 0 --device 0 \ 702 --type dvddrive --medium /u01/Software/OL/OracleLinux-R7-U6-Server-x86_64-dvd.iso</screen> 703 704 <para> 705 Note the following: 706 </para> 707 708 <itemizedlist> 709 710 <listitem> 711 <para> 712 A 32768 MB virtual hard disk is created. 713 </para> 714 </listitem> 715 716 <listitem> 717 <para> 718 A SATA storage controller is created and the virtual 719 hard disk is attached. 720 </para> 721 </listitem> 722 723 <listitem> 724 <para> 725 An IDE storage controller for a virtual DVD drive is 726 created and an Oracle Linux installation ISO is 727 attached. 728 </para> 729 </listitem> 730 731 </itemizedlist> 732 </listitem> 733 734 <listitem> 735 <para> 736 (Optional) Configure some settings for the VM. 737 </para> 738 739 <screen># VBoxManage modifyvm $VM --ioapic on 740 # VBoxManage modifyvm $VM --boot1 dvd --boot2 disk --boot3 none --boot4 none 741 # VBoxManage modifyvm $VM --memory 8192 --vram 128</screen> 742 743 <para> 744 Note the following: 745 </para> 746 747 <itemizedlist> 748 749 <listitem> 750 <para> 751 I/O APIC is enabled for the motherboard of the VM. 752 </para> 753 </listitem> 754 755 <listitem> 756 <para> 757 The boot order for the VM is configured. 758 </para> 759 </listitem> 760 761 <listitem> 762 <para> 763 8192 MB of RAM and 128 MB of video RAM are allocated to 764 the VM. 765 </para> 766 </listitem> 767 768 </itemizedlist> 769 </listitem> 770 771 <listitem> 772 <para> 773 Perform an unattended install of the operating system. 774 </para> 775 776 <screen># VBoxManage unattended install $VM \ 777 --iso=/u01/Software/OL/OracleLinux-R7-U6-Server-x86_64-dvd.iso \ 778 --user=<replaceable>login</replaceable> --full-user-name=<replaceable>name</replaceable> --password <replaceable>password</replaceable> \ 779 --install-additions --time-zone=CET</screen> 780 781 <para> 782 Note the following: 783 </para> 784 785 <itemizedlist> 786 787 <listitem> 788 <para> 789 An Oracle Linux ISO is specified as the installation 790 ISO. 791 </para> 792 </listitem> 793 794 <listitem> 795 <para> 796 Specify a login name, full name, and login password for 797 a default user on the guest operating system. 798 </para> 799 800 <para> 801 The specified password is also used for the root user 802 account on the guest. 803 </para> 804 </listitem> 805 806 <listitem> 807 <para> 808 The Guest Additions are installed on the VM. 809 </para> 810 </listitem> 811 812 <listitem> 813 <para> 814 The time zone for the guest operating system is set to 815 Central European Time (CET). 816 </para> 817 </listitem> 818 819 </itemizedlist> 820 </listitem> 821 822 <listitem> 823 <para> 824 Start the virtual machine. 825 </para> 826 827 <para> 828 This step completes the unattended install process. 829 </para> 830 831 <screen># VBoxManage startvm $VM --type headless</screen> 832 833 <para> 834 The VM is started in headless mode. The VirtualBox Manager 835 window is not displayed. 836 </para> 837 </listitem> 838 839 <listitem> 840 <para> 841 (Optional) Update the guest operating system to use the 842 latest Oracle Linux packages. 843 </para> 844 845 <para> 846 On the guest VM, run the following command: 847 </para> 848 849 <screen># yum update</screen> 850 </listitem> 851 852 </orderedlist> 853 854 </sect2> 404 855 405 856 </sect1> … … 410 861 411 862 <para> 412 VirtualBox virtualizes nearly all hardware of the host. Depending413 on a VM's configuration, the guest will see the following virtual414 hardware:863 &product-name; virtualizes nearly all hardware of the host. 864 Depending on a VM's configuration, the guest will see the 865 following virtual hardware: 415 866 </para> 416 867 … … 420 871 <para> 421 872 <emphasis role="bold">Input devices.</emphasis> By default, 422 VirtualBox emulates a standard PS/2 keyboard and mouse. These423 devices are supported by almost all past and present operating424 systems.425 </para> 426 427 <para> 428 In addition, VirtualBox can provide virtual USB input devices429 to avoid having to capture mouse and keyboard, as described in430 <xref873 &product-name; emulates a standard PS/2 keyboard and mouse. 874 These devices are supported by almost all past and present 875 operating systems. 876 </para> 877 878 <para> 879 In addition, &product-name; can provide virtual USB input 880 devices to avoid having to capture mouse and keyboard, as 881 described in <xref 431 882 linkend="keyb_mouse_normal" />. 432 883 </para> … … 435 886 <listitem> 436 887 <para> 437 <emphasis role="bold">Graphics.</emphasis> The VirtualBox438 graphics device (sometimes referred to as VGA device) is,439 unlike nearly all other emulated devices, not based on any440 physical counterpart. It is a simple, synthetic device which888 <emphasis role="bold">Graphics.</emphasis> The &product-name; 889 graphics device, sometimes referred to as a VGA device, is not 890 based on any physical counterpart. This is unlike nearly all 891 other emulated devices. It is a simple, synthetic device which 441 892 provides compatibility with standard VGA and several extended 442 893 registers used by the VESA BIOS Extensions (VBE). … … 446 897 <listitem> 447 898 <para> 448 <emphasis role="bold">Storage.</emphasis> VirtualBox currently449 emulates the standard ATA interface found on Intel PIIX3/PIIX4450 chips, the SATA (AHCI) interface, and two SCSI adapters (LSI451 Logic and BusLogic). See899 <emphasis role="bold">Storage.</emphasis> &product-name; 900 currently emulates the standard ATA interface found on Intel 901 PIIX3/PIIX4 chips, the SATA (AHCI) interface, and two SCSI 902 adapters (LSI Logic and BusLogic). See 452 903 <xref linkend="harddiskcontrollers" /> for details. Whereas 453 providing one of these would be enough for VirtualBoxby904 providing one of these would be enough for &product-name; by 454 905 itself, this multitude of storage adapters is required for 455 906 compatibility with other hypervisors. Windows is particularly … … 470 921 <listitem> 471 922 <para> 472 <emphasis role="bold">USB.</emphasis> VirtualBoxemulates923 <emphasis role="bold">USB.</emphasis> &product-name; emulates 473 924 three USB host controllers: xHCI, EHCI, and OHCI. While xHCI 474 925 handles all USB transfer speeds, only guest operating systems … … 480 931 <para> 481 932 Older operating systems typically support OHCI and EHCI. The 482 two controllers are needed because OHCI only handles USB low-483 and full-speed devices (both USB 1.x and 2.0), while EHCI only484 handles high-speed devices (USB 2.0 only).933 two controllers are needed because OHCI only handles USB 934 low-speed and full-speed devices (both USB 1.x and 2.0), while 935 EHCI only handles high-speed devices (USB 2.0 only). 485 936 </para> 486 937 … … 488 939 The emulated USB controllers do not communicate directly with 489 940 devices on the host but rather with a virtual USB layer which 490 abstracts the USB protocol and allows the use of remote USB941 abstracts the USB protocol and enables the use of remote USB 491 942 devices. 492 943 </para> … … 496 947 <para> 497 948 <emphasis role="bold">Audio.</emphasis> See 498 <xref 499 linkend="settings-audio" />. 949 <xref linkend="settings-audio" />. 500 950 </para> 501 951 </listitem> … … 510 960 511 961 <para> 512 In the Settingswindow, under962 In the <emphasis role="bold">Settings</emphasis> window, under 513 963 <emphasis role="bold">General</emphasis>, you can configure the 514 964 most fundamental aspects of the virtual machine such as memory and 515 essential hardware. There are three tabs: Basic, Advanced and 516 Description. 965 essential hardware. The following tabs are available. 517 966 </para> 518 967 … … 522 971 523 972 <para> 524 In the Basic tab of the General settings category, you can find 525 these settings: 973 In the <emphasis role="bold">Basic</emphasis> tab of the 974 <emphasis role="bold">General</emphasis> settings category, you 975 can find these settings: 526 976 </para> 527 977 … … 532 982 <emphasis role="bold">Name:</emphasis> The name under which 533 983 the VM is shown in the list of VMs in the main window. Under 534 this name, VirtualBox also saves the VM's configuration 535 files. By changing the name, VirtualBox renames these files 536 as well. As a result, you can only use characters which are 537 allowed in your host operating system's file names. 538 </para> 539 540 <para> 541 Note that internally, VirtualBox uses unique identifiers 984 this name, &product-name; also saves the VM's configuration 985 files. By changing the name, &product-name; renames these 986 files as well. As a result, you can only use characters 987 which are allowed in your host operating system's file 988 names. 989 </para> 990 991 <para> 992 Note that internally, &product-name; uses unique identifiers 542 993 (UUIDs) to identify virtual machines. You can display these 543 with <computeroutput>VBoxManage</computeroutput>. 544 </para> 545 </listitem> 546 547 <listitem> 548 <para> 549 <emphasis role="bold">Operating system/version:</emphasis> 550 The type of the guest operating system that is, or will be, 551 installed in the VM. This is the same setting that was 552 specified in the "New Virtual Machine" wizard. See 553 <xref 554 linkend="gui-createvm" />. 994 with <command>VBoxManage</command>. 995 </para> 996 </listitem> 997 998 <listitem> 999 <para> 1000 <emphasis role="bold">Type:</emphasis> The type of the guest 1001 operating system for the VM. This is the same setting that 1002 is specified in the <emphasis role="bold">New Virtual 1003 Machine</emphasis> wizard. See 1004 <xref linkend="gui-createvm" />. 555 1005 </para> 556 1006 … … 563 1013 </listitem> 564 1014 1015 <listitem> 1016 <para> 1017 <emphasis role="bold">Version:</emphasis> The version of the 1018 guest operating system for the VM. This is the same setting 1019 that is specified in the <emphasis role="bold">New Virtual 1020 Machine</emphasis> wizard. See 1021 <xref linkend="gui-createvm" />. 1022 </para> 1023 </listitem> 1024 565 1025 </itemizedlist> 566 1026 … … 572 1032 573 1033 <para> 574 The following settings are available in the Advanced tab: 1034 The following settings are available in the 1035 <emphasis role="bold">Advanced</emphasis> tab: 575 1036 </para> 576 1037 … … 580 1041 <para> 581 1042 <emphasis role="bold">Snapshot Folder:</emphasis> By 582 default, VirtualBox saves snapshot data together with your 583 other VirtualBox configuration data. See 584 <xref 585 linkend="vboxconfigdata" />. With this 586 setting, you can specify any other folder for each VM. 1043 default, &product-name; saves snapshot data together with 1044 your other &product-name; configuration data. See 1045 <xref linkend="vboxconfigdata" />. With this setting, you 1046 can specify any other folder for each VM. 587 1047 </para> 588 1048 </listitem> … … 594 1054 system should be shared with that of your host. If you 595 1055 select <emphasis role="bold">Bidirectional</emphasis>, then 596 VirtualBoxwill always make sure that both clipboards1056 &product-name; will always make sure that both clipboards 597 1057 contain the same data. If you select 598 1058 <emphasis role="bold">Host to Guest</emphasis> or 599 1059 <emphasis role="bold">Guest to Host</emphasis>, then 600 VirtualBoxwill only ever copy clipboard data in one1060 &product-name; will only ever copy clipboard data in one 601 1061 direction. 602 1062 </para> 603 1063 604 1064 <para> 605 Clipboard sharing requires that the VirtualBoxGuest1065 Clipboard sharing requires that the &product-name; Guest 606 1066 Additions be installed. In such a case, this setting has no 607 1067 effect. See <xref linkend="guestadditions" />. … … 609 1069 610 1070 <para> 611 The shared clipboard is disabled by default. See612 <xref linkend="security_clipboard"/> for an explanation.613 This setting can be changed at any time using the "Shared614 Clipboard" menu item in the "Devices" menu of the virtual615 machine.1071 For security reasons, the shared clipboard is disabled by 1072 default. This setting can be changed at any time using the 1073 <emphasis role="bold">Shared Clipboard</emphasis> menu item 1074 in the <emphasis role="bold">Devices</emphasis> menu of the 1075 virtual machine. 616 1076 </para> 617 1077 </listitem> … … 635 1095 Drag and drop is disabled by default. This setting can be 636 1096 changed at any time using the <emphasis role="bold">Drag 637 and Drop</emphasis> menu item in the Devices menu of the 1097 and Drop</emphasis> menu item in the 1098 <emphasis role="bold">Devices</emphasis> menu of the 638 1099 virtual machine. 639 1100 </para> … … 642 1103 <para> 643 1104 See <xref linkend="guestadd-dnd"/>. 644 645 <footnote>646 647 <para>648 Experimental support for drag and drop was added with649 VirtualBox 4.2.650 </para>651 652 </footnote>653 1105 </para> 654 1106 </listitem> … … 663 1115 664 1116 <para> 665 Here you can enter any description for your virtual machine, if 666 you want. This has no effect on the functionality of the 667 machine, but you may find this space useful to note down things 668 like the configuration of a virtual machine and the software 669 that has been installed into it. 670 </para> 671 672 <para> 673 To insert a line break into the description text field, press 674 <emphasis>Shift+Enter</emphasis>. 1117 On the <emphasis role="bold">Description</emphasis> tab you can 1118 enter a description for your virtual machine. This has no effect 1119 on the functionality of the machine, but you may find this space 1120 useful to note down things such as the configuration of a 1121 virtual machine and the software that has been installed into 1122 it. 1123 </para> 1124 1125 <para> 1126 To insert a line break into the 1127 <emphasis role="bold">Description</emphasis> text field, press 1128 Shift+Enter. 675 1129 </para> 676 1130 677 1131 </sect2> 678 1132 1133 <sect2 id="settings-disk-encryption"> 1134 1135 <title>Disk Encryption Tab</title> 1136 1137 <para> 1138 The <emphasis role="bold">Disk Encryption</emphasis> tab enables 1139 you to encrypt disks that are attached to the virtual machine. 1140 </para> 1141 1142 <para> 1143 To enable disk encryption, select the 1144 <emphasis role="bold">Enable Disk Encryption</emphasis> check 1145 box. 1146 </para> 1147 1148 <para> 1149 Settings are available to configure the cipher used for 1150 encryption and the encryption password. 1151 </para> 1152 1153 </sect2> 1154 679 1155 </sect1> 680 1156 … … 684 1160 685 1161 <para> 686 The System category groups various settings that are related to 687 the basic hardware that is presented to the virtual machine. 1162 The <emphasis role="bold">System</emphasis> category groups 1163 various settings that are related to the basic hardware that is 1164 presented to the virtual machine. 688 1165 </para> 689 1166 … … 697 1174 </note> 698 1175 1176 <para> 1177 The following tabs are available. 1178 </para> 1179 699 1180 <sect2 id="settings-motherboard"> 700 1181 … … 702 1183 703 1184 <para> 704 On the Motherboard tab, you can influence virtual hardware that 705 would normally be on the motherboard of a real computer. 1185 On the <emphasis role="bold">Motherboard</emphasis> tab, you can 1186 configure virtual hardware that would normally be on the 1187 motherboard of a real computer. 706 1188 </para> 707 1189 … … 710 1192 <listitem> 711 1193 <para> 712 <emphasis role="bold">Base memory:</emphasis> Sets the1194 <emphasis role="bold">Base Memory:</emphasis> Sets the 713 1195 amount of RAM that is allocated and given to the VM when it 714 1196 is running. The specified amount of memory will be requested … … 717 1199 start the VM and will not be available to the host while the 718 1200 VM is running. This is the same setting that was specified 719 in the "New Virtual Machine" wizard, as described in720 <xref linkend="gui-createvm" />.1201 in the <emphasis role="bold">New Virtual Machine</emphasis> 1202 wizard, as described in <xref linkend="gui-createvm" />. 721 1203 </para> 722 1204 … … 731 1213 <listitem> 732 1214 <para> 733 <emphasis role="bold">Boot order:</emphasis> Determines the1215 <emphasis role="bold">Boot Order:</emphasis> Determines the 734 1216 order in which the guest operating system will attempt to 735 1217 boot from the various virtual boot devices. Analogous to a 736 real PC's BIOS setting, VirtualBox can tell a guest OS to737 start from the virtual floppy, the virtual CD/DVD drive, the738 virtual hard drive (each of these as defined by the other VM739 settings), the network, or none of these.1218 real PC's BIOS setting, &product-name; can tell a guest OS 1219 to start from the virtual floppy, the virtual CD/DVD drive, 1220 the virtual hard drive (each of these as defined by the 1221 other VM settings), the network, or none of these. 740 1222 </para> 741 1223 742 1224 <para> 743 1225 If you select <emphasis role="bold">Network</emphasis>, the 744 VM will attempt to boot from a network viathe PXE1226 VM will attempt to boot from a network using the PXE 745 1227 mechanism. This needs to be configured in detail on the 746 command line. See 747 <xref 748 linkend="vboxmanage-modifyvm" />. 1228 command line. See <xref linkend="vboxmanage-modifyvm" />. 749 1229 </para> 750 1230 </listitem> … … 753 1233 <para> 754 1234 <emphasis role="bold">Chipset:</emphasis> You can select 755 which chipset will be presented to the virtual machine. 756 Before VirtualBox 4.0, PIIX3 was the only available option757 here. For modern guest operating systems such as Mac OS X,758 that old chipset is no longer well supported. As a result,759 VirtualBox 4.0 introduced an emulation of the more modern760 ICH9 chipset, which supports PCI express, three PCI buses,761 PCI-to-PCI bridges and Message Signaled Interrupts (MSI).762 This allows modern operating systems to address more PCI763 devices and no longer requires IRQ sharing. Using the ICH9764 chipset it is also possible to configure up to 36 network765 cards, up to 8 network adapters with PIIX3. Note that the766 ICH9 support is experimental and not recommended for guest767 operating systems which do not require it.1235 which chipset will be presented to the virtual machine. In 1236 legacy versions of &product-name;, PIIX3 was the only 1237 available option. For modern guest operating systems such as 1238 Mac OS X, that old chipset is no longer well supported. As a 1239 result, &product-name; supports an emulation of the more 1240 modern ICH9 chipset, which supports PCI express, three PCI 1241 buses, PCI-to-PCI bridges and Message Signaled Interrupts 1242 (MSI). This enables modern operating systems to address more 1243 PCI devices and no longer requires IRQ sharing. Using the 1244 ICH9 chipset it is also possible to configure up to 36 1245 network cards, up to 8 network adapters with PIIX3. Note 1246 that the ICH9 support is experimental and not recommended 1247 for guest operating systems which do not require it. 768 1248 </para> 769 1249 </listitem> … … 774 1254 default virtual pointing devices for older guests is the 775 1255 traditional PS/2 mouse. If set to <emphasis>USB 776 tablet</emphasis>, VirtualBox reports to the virtual machine777 that a USB tablet device is present and communicates mouse778 events to the virtual machine through this device. The third779 setting is a <emphasis>USB Multi-Touch Tablet</emphasis>780 which is suited for recent Windows guests.1256 tablet</emphasis>, &product-name; reports to the virtual 1257 machine that a USB tablet device is present and communicates 1258 mouse events to the virtual machine through this device. The 1259 third setting is a <emphasis>USB Multi-Touch 1260 Tablet</emphasis> which is suited for recent Windows guests. 781 1261 </para> 782 1262 … … 784 1264 Using the virtual USB tablet has the advantage that 785 1265 movements are reported in absolute coordinates, instead of 786 as relative position changes. This allows VirtualBoxto1266 as relative position changes. This enables &product-name; to 787 1267 translate mouse events over the VM window into tablet events 788 1268 without having to "capture" the mouse in the guest as 789 described in 790 <xref 791 linkend="keyb_mouse_normal" />. This 1269 described in <xref linkend="keyb_mouse_normal" />. This 792 1270 makes using the VM less tedious even if Guest Additions are 793 1271 not installed. 794 795 <footnote>796 797 <para>798 The virtual USB tablet was added with VirtualBox 3.2.799 Depending on the guest operating system selected, this800 is now enabled by default for new virtual machines.801 </para>802 803 </footnote>804 1272 </para> 805 1273 </listitem> … … 836 1304 <para> 837 1305 All Windows operating systems starting with Windows 2000 838 install different kernels depending on whether an I/O APIC839 is available. As with ACPI, the I/O APIC therefore1306 install different kernels, depending on whether an I/O 1307 APIC is available. As with ACPI, the I/O APIC therefore 840 1308 <emphasis>must not be turned off after 841 1309 installation</emphasis> of a Windows guest OS. Turning it … … 856 1324 <listitem> 857 1325 <para> 858 <emphasis role="bold">Hardware clock in UTC time:</emphasis>859 If checked, VirtualBox will report the system time in UTC860 format to the guest instead of local (host) time. This861 affects how the virtual real-time clock (RTC) operates and862 may be useful for Unix-like guest operating systems, which863 typically expect the hardware clock to be set to UTC.1326 <emphasis role="bold">Hardware Clock in UTC Time:</emphasis> 1327 If selected, &product-name; will report the system time in 1328 UTC format to the guest instead of the local (host) time. 1329 This affects how the virtual real-time clock (RTC) operates 1330 and may be useful for UNIX-like guest operating systems, 1331 which typically expect the hardware clock to be set to UTC. 864 1332 </para> 865 1333 </listitem> … … 870 1338 In addition, you can turn off the <emphasis role="bold">Advanced 871 1339 Configuration and Power Interface (ACPI)</emphasis> which 872 VirtualBox presents to the guest operating system by default. 1340 &product-name; presents to the guest operating system by 1341 default. 1342 </para> 1343 1344 <para> 873 1345 ACPI is the current industry standard to allow operating systems 874 1346 to recognize hardware, configure motherboards and other devices 875 1347 and manage power. As all modern PCs contain this feature and 876 1348 Windows and Linux have been supporting it for years, it is also 877 enabled by default in VirtualBox. It can only be turned off on 878 the command line. See 879 <xref 880 linkend="vboxmanage-modifyvm" />. 1349 enabled by default in &product-name;. ACPI can only be turned 1350 off using the command line. See 1351 <xref linkend="vboxmanage-modifyvm" />. 881 1352 </para> 882 1353 … … 884 1355 <para> 885 1356 All Windows operating systems starting with Windows 2000 886 install different kernels depending on whether ACPI is887 available , so ACPI <emphasis>must not be turned off</emphasis>888 after installation of a Windows guest OS. Turning it on after889 installation will have no effect however.1357 install different kernels, depending on whether ACPI is 1358 available. This means that ACPI <emphasis>must not be turned 1359 off</emphasis> after installation of a Windows guest OS. 1360 However, turning it on after installation will have no effect. 890 1361 </para> 891 1362 </warning> … … 898 1369 899 1370 <para> 900 On the Processor tab, you can set how many virtual 901 <emphasis role="bold">CPU cores</emphasis> the guest operating 902 systems should see. Starting with version 3.0, VirtualBox 903 supports symmetrical multiprocessing (SMP) and can present up to 904 32 virtual CPU cores to each virtual machine. 905 </para> 906 907 <para> 908 You should not, however, configure virtual machines to use more 909 CPU cores than are available physically (real cores, no 910 hyperthreads). 911 </para> 912 913 <para> 914 On this tab you can also set the <emphasis role="bold">CPU 915 execution cap</emphasis>. This setting limits the amount of time 916 a host CPU spends to emulate a virtual CPU. The default setting 917 is 100% meaning that there is no limitation. A setting of 50% 918 implies a single virtual CPU can use up to 50% of a single host 919 CPU. Note that limiting the execution time of the virtual CPUs 920 may induce guest timing problems. 921 </para> 922 923 <para> 924 In addition, the <emphasis role="bold">Enable PAE/NX</emphasis> 925 setting determines whether the PAE and NX capabilities of the 926 host CPU will be exposed to the virtual machine. PAE stands for 927 "Physical Address Extension". Normally, if enabled and supported 928 by the operating system, then even a 32-bit x86 CPU can access 929 more than 4 GB of RAM. This is made possible by adding another 4 930 bits to memory addresses, so that with 36 bits, up to 64 GB can 931 be addressed. Some operating systems, such as Ubuntu Server, 932 require PAE support from the CPU and cannot be run in a virtual 933 machine without it. 934 </para> 1371 On the <emphasis role="bold">Processor</emphasis> tab, you can 1372 configure settings for the CPU used by the virtual machine. 1373 </para> 1374 1375 <itemizedlist> 1376 1377 <listitem> 1378 <para> 1379 <emphasis role="bold">Processor(s):</emphasis> Sets the 1380 number of virtual CPU cores the guest operating systems can 1381 see. &product-name; supports symmetrical multiprocessing 1382 (SMP) and can present up to 32 virtual CPU cores to each 1383 virtual machine. 1384 </para> 1385 1386 <para> 1387 You should not configure virtual machines to use more CPU 1388 cores than are available physically. This includes real 1389 cores, with no hyperthreads. 1390 </para> 1391 </listitem> 1392 1393 <listitem> 1394 <para> 1395 <emphasis role="bold">Execution Cap:</emphasis> Configures 1396 the CPU execution cap. This limits the amount of time a host 1397 CPU spends to emulate a virtual CPU. The default setting is 1398 100%, meaning that there is no limitation. A setting of 50% 1399 implies a single virtual CPU can use up to 50% of a single 1400 host CPU. Note that limiting the execution time of the 1401 virtual CPUs may cause guest timing problems. 1402 </para> 1403 1404 <para> 1405 A warning is displayed at the bottom of the Processor tab if 1406 an Execution Cap setting is made that may affect system 1407 performance. 1408 </para> 1409 </listitem> 1410 1411 <listitem> 1412 <para> 1413 <emphasis role="bold">Enable PAE/NX:</emphasis> Determines 1414 whether the PAE and NX capabilities of the host CPU will be 1415 exposed to the virtual machine. To enable this feature, 1416 select the <emphasis role="bold">Extended 1417 Features</emphasis> check box. 1418 </para> 1419 1420 <para> 1421 PAE stands for Physical Address Extension. Normally, if 1422 enabled and supported by the operating system, then even a 1423 32-bit x86 CPU can access more than 4 GB of RAM. This is 1424 made possible by adding another 4 bits to memory addresses, 1425 so that with 36 bits, up to 64 GB can be addressed. Some 1426 operating systems, such as Ubuntu Server, require PAE 1427 support from the CPU and cannot be run in a virtual machine 1428 without it. 1429 </para> 1430 </listitem> 1431 1432 </itemizedlist> 935 1433 936 1434 <para> 937 1435 With virtual machines running modern server operating systems, 938 VirtualBoxalso supports CPU hot-plugging. For details, see1436 &product-name; also supports CPU hot-plugging. For details, see 939 1437 <xref linkend="cpuhotplug" />. 940 1438 </para> … … 947 1445 948 1446 <para> 949 On this page, you can determine whether and how VirtualBox 950 should use hardware virtualization extensions that your host CPU 951 may support. This is the case with most CPUs built after 2006. 952 </para> 953 954 <para> 955 You can select for each virtual machine individually whether 956 VirtualBox should use software or hardware virtualization. 957 958 <footnote> 959 960 <para> 961 Prior to VirtualBox version 2.2, software virtualization was 962 the default; starting with version 2.2, VirtualBox will 963 enable hardware virtualization by default for new virtual 964 machines that you create. Existing virtual machines are not 965 automatically changed for compatibility reasons, and the 966 default can of course be changed for each virtual machine. 967 </para> 968 969 </footnote> 970 </para> 971 972 <para> 973 In most cases, the default settings will be fine; VirtualBox 974 will have picked sensible defaults depending on the operating 975 system that you selected when you created the virtual machine. 976 In certain situations, however, you may want to change these 977 preconfigured defaults. 978 </para> 979 980 <para> 981 Advanced users may be interested in technical details about 982 software vs. hardware virtualization. See 983 <xref 984 linkend="hwvirt" />. 985 </para> 986 987 <para> 988 If your host's CPU supports the <emphasis role="bold">nested 989 paging</emphasis> (AMD-V) or 990 <emphasis role="bold">EPT</emphasis> (Intel VT-x) features, then 991 you can expect a significant performance increase by enabling 992 nested paging in addition to hardware virtualization. For 993 technical details, see <xref linkend="nestedpaging" />. 994 </para> 995 996 <para> 997 Starting with version 5.0, VirtualBox provides 998 paravirtualization interfaces to improve time-keeping accuracy 999 and performance of guest operating systems. The options 1000 available are documented under the 1001 <computeroutput>paravirtprovider</computeroutput> option in 1002 <xref linkend="vboxmanage-modifyvm" />. For further details on 1003 the paravirtualization providers, see 1004 <xref linkend="gimproviders" />. 1447 On this tab, you can configure &product-name; to use hardware 1448 virtualization extensions that your host CPU supports. 1449 </para> 1450 1451 <itemizedlist> 1452 1453 <listitem> 1454 <para> 1455 <emphasis role="bold">Paravirtualization 1456 Interface:</emphasis> &product-name; provides 1457 paravirtualization interfaces to improve time-keeping 1458 accuracy and performance of guest operating systems. The 1459 options available are documented under the 1460 <computeroutput>paravirtprovider</computeroutput> option in 1461 <xref linkend="vboxmanage-modifyvm" />. For further details 1462 on the paravirtualization providers, see 1463 <xref linkend="gimproviders" />. 1464 </para> 1465 </listitem> 1466 1467 <listitem> 1468 <para> 1469 <emphasis role="bold">Hardware Virtualization:</emphasis> 1470 You can select for each virtual machine individually whether 1471 &product-name; should use software or hardware 1472 virtualization. 1473 </para> 1474 1475 <itemizedlist> 1476 1477 <listitem> 1478 <para> 1479 <emphasis role="bold">Enable VT-x/AMD-V:</emphasis> 1480 Enables Intel VT-x and AMD-V hardware extensions if the 1481 host CPU supports them. 1482 </para> 1483 </listitem> 1484 1485 <listitem> 1486 <para> 1487 <emphasis role="bold">Enable Nested Paging:</emphasis> 1488 If the host CPU supports the nested paging (AMD-V) or 1489 EPT (Intel VT-x) features, then you can expect a 1490 significant performance increase by enabling nested 1491 paging in addition to hardware virtualization. For 1492 technical details, see <xref linkend="nestedpaging" />. 1493 </para> 1494 </listitem> 1495 1496 </itemizedlist> 1497 1498 <para> 1499 Advanced users may be interested in technical details about 1500 software versus hardware virtualization. See 1501 <xref linkend="hwvirt" />. 1502 </para> 1503 </listitem> 1504 1505 </itemizedlist> 1506 1507 <para> 1508 In most cases, the default settings on the 1509 <emphasis role="bold">Acceleration</emphasis> tab will work 1510 well. &product-name; selects sensible defaults, depending on the 1511 operating system that you selected when you created the virtual 1512 machine. In certain situations, however, you may want to change 1513 the preconfigured defaults. 1005 1514 </para> 1006 1515 … … 1013 1522 <title>Display Settings</title> 1014 1523 1015 <itemizedlist> 1016 1017 <listitem> 1018 <para> 1019 <emphasis role="bold">Video memory size:</emphasis> Sets the 1020 size of the memory provided by the virtual graphics card 1021 available to the guest, in MB. As with the main memory, the 1022 specified amount will be allocated from the host's resident 1023 memory. Based on the amount of video memory, higher 1024 resolutions and color depths may be available. 1025 </para> 1026 1027 <para> 1028 The GUI will show a warning if the amount of video memory is 1029 too small to be able to switch the VM into full screen mode. 1030 The minimum value depends on the number of virtual monitors, 1031 the screen resolution and the color depth of the host display 1032 as well as of the activation of <emphasis>3D 1033 acceleration</emphasis> and <emphasis>2D video 1034 acceleration</emphasis>. A rough estimate is (<emphasis>color 1035 depth</emphasis> / 8) x <emphasis>vertical pixels</emphasis> x 1036 <emphasis>horizontal pixels</emphasis> x <emphasis>number of 1037 screens</emphasis> = <emphasis>number of bytes</emphasis>. 1038 Like said above, there might be extra memory required for any 1039 activated display acceleration setting. 1040 </para> 1041 </listitem> 1042 1043 <listitem> 1044 <para> 1045 <emphasis role="bold">Monitor count:</emphasis> With this 1046 setting VirtualBox can provide more than one virtual monitor 1047 to a virtual machine. If a guest operating system, such as 1048 Windows, supports multiple attached monitors, VirtualBox can 1049 pretend that multiple virtual monitors are present. 1050 1051 <footnote> 1052 1053 <para> 1054 Multiple monitor support was added with VirtualBox 3.2. 1055 </para> 1056 1057 </footnote> 1058 1059 Up to eight such virtual monitors are supported. 1060 </para> 1061 1062 <para> 1063 The output of the multiple monitors are displayed on the host 1064 in multiple VM windows which are running side by side. 1065 </para> 1066 1067 <para> 1068 However, in full screen and seamless mode, they use the 1069 available physical monitors attached to the host. As a result, 1070 for full screen and seamless modes to work with multiple 1071 monitors, you will need at least as many physical monitors as 1072 you have virtual monitors configured, or VirtualBox will 1073 report an error. You can configure the relationship between 1074 guest and host monitors using the view menu by pressing Host 1075 key + Home when you are in full screen or seamless mode. 1076 </para> 1077 1078 <para> 1079 See also <xref linkend="KnownIssues" />. 1080 </para> 1081 </listitem> 1082 1083 <listitem> 1084 <para> 1085 <emphasis role="bold">Enable 3D acceleration:</emphasis> If a 1086 virtual machine has Guest Additions installed, you can select 1087 here whether the guest should support accelerated 3D graphics. 1088 See <xref linkend="guestadd-3d" />. 1089 </para> 1090 </listitem> 1091 1092 <listitem> 1093 <para> 1094 <emphasis role="bold">Enable 2D video acceleration:</emphasis> 1095 If a virtual machine with Microsoft Windows has Guest 1096 Additions installed, you can select here whether the guest 1097 should support accelerated 2D video graphics. See 1098 <xref 1099 linkend="guestadd-2d" />. 1100 </para> 1101 </listitem> 1102 1103 <listitem> 1104 <para> 1105 <emphasis role="bold">Remote display:</emphasis> On the 1106 <emphasis role="bold">Remote Display</emphasis> tab, if the 1107 VirtualBox Remote Display Extension (VRDE) is installed, you 1108 can enable the VRDP server that is built into VirtualBox. This 1109 enables you to connect to the console of the virtual machine 1110 remotely with any standard RDP viewer, such as 1111 <computeroutput>mstsc.exe</computeroutput> that comes with 1112 Microsoft Windows. On Linux and Solaris systems you can use 1113 the standard open source 1114 <computeroutput>rdesktop</computeroutput> program. These 1115 features are described in <xref linkend="vrde" />. 1116 </para> 1117 </listitem> 1118 1119 <listitem> 1120 <para> 1121 <emphasis role="bold">Capture:</emphasis> On the 1122 <emphasis role="bold">Capture</emphasis> tab you can 1123 enable video and audio capturing, as well as changing related options 1124 for this VM. Note that these features can also be enabled/disabled 1125 while the VM is being executed. 1126 </para> 1127 </listitem> 1128 1129 </itemizedlist> 1524 <para> 1525 The following tabs are available for configuring the display for a 1526 virtual machine. 1527 </para> 1528 1529 <sect2 id="settings-screen"> 1530 1531 <title>Screen Tab</title> 1532 1533 <itemizedlist> 1534 1535 <listitem> 1536 <para> 1537 <emphasis role="bold">Video Memory:</emphasis> Sets the size 1538 of the memory provided by the virtual graphics card 1539 available to the guest, in MB. As with the main memory, the 1540 specified amount will be allocated from the host's resident 1541 memory. Based on the amount of video memory, higher 1542 resolutions and color depths may be available. 1543 </para> 1544 1545 <para> 1546 The GUI will show a warning if the amount of video memory is 1547 too small to be able to switch the VM into full screen mode. 1548 The minimum value depends on the number of virtual monitors, 1549 the screen resolution and the color depth of the host 1550 display as well as on the use of <emphasis>3D 1551 acceleration</emphasis> and <emphasis>2D video 1552 acceleration</emphasis>. A rough estimate is 1553 (<emphasis>color depth</emphasis> / 8) x <emphasis>vertical 1554 pixels</emphasis> x <emphasis>horizontal pixels</emphasis> x 1555 <emphasis>number of screens</emphasis> = <emphasis>number of 1556 bytes</emphasis>. Extra memory may be required if display 1557 acceleration is used. 1558 </para> 1559 </listitem> 1560 1561 <listitem> 1562 <para> 1563 <emphasis role="bold">Monitor Count:</emphasis> With this 1564 setting, &product-name; can provide more than one virtual 1565 monitor to a virtual machine. If a guest operating system 1566 supports multiple attached monitors, &product-name; can 1567 pretend that multiple virtual monitors are present. Up to 1568 eight such virtual monitors are supported. 1569 </para> 1570 1571 <para> 1572 The output of the multiple monitors are displayed on the 1573 host in multiple VM windows which are running side by side. 1574 However, in full screen and seamless mode, they use the 1575 available physical monitors attached to the host. As a 1576 result, for full screen and seamless modes to work with 1577 multiple monitors, you will need at least as many physical 1578 monitors as you have virtual monitors configured, or 1579 &product-name; will report an error. 1580 </para> 1581 1582 <para> 1583 You can configure the relationship between guest and host 1584 monitors using the <emphasis role="bold">View</emphasis> 1585 menu by pressing Host key + Home when you are in full screen 1586 or seamless mode. 1587 </para> 1588 1589 <para> 1590 See also <xref linkend="KnownIssues" />. 1591 </para> 1592 </listitem> 1593 1594 <listitem> 1595 <para> 1596 <emphasis role="bold">Scale Factor:</emphasis> Enables 1597 scaling of the display size. For multiple monitor displays, 1598 you can set the scale factor for individual monitors, or 1599 globally for all of the monitors. Use the slider to select a 1600 scaling factor up to 200%. 1601 </para> 1602 1603 <para> 1604 You can set a default scale factor for all VMs. Use the 1605 <emphasis role="bold">Display</emphasis> tab in the Global 1606 Settings dialogs. 1607 </para> 1608 </listitem> 1609 1610 <listitem> 1611 <para> 1612 <emphasis role="bold">Enable 3D Acceleration:</emphasis> If 1613 a virtual machine has Guest Additions installed, you can 1614 select here whether the guest should support accelerated 3D 1615 graphics. See <xref linkend="guestadd-3d" />. 1616 </para> 1617 </listitem> 1618 1619 <listitem> 1620 <para> 1621 <emphasis role="bold">Enable 2D Video 1622 Acceleration:</emphasis> If a virtual machine with Microsoft 1623 Windows has Guest Additions installed, you can select here 1624 whether the guest should support accelerated 2D video 1625 graphics. See <xref linkend="guestadd-2d" />. 1626 </para> 1627 </listitem> 1628 1629 <listitem> 1630 <para> 1631 <emphasis role="bold">Graphics Controller:</emphasis> 1632 Specifies the graphics adapter type used by the VM. The 1633 following options are available: 1634 </para> 1635 1636 <itemizedlist> 1637 1638 <listitem> 1639 <para> 1640 <emphasis role="bold">VBoxSVGA:</emphasis> The default 1641 graphics controller for new VMs that use Linux or 1642 Windows 7 or later. Requires the Guest Additions. 1643 </para> 1644 </listitem> 1645 1646 <listitem> 1647 <para> 1648 <emphasis role="bold">VBoxVGA:</emphasis> Used for 1649 legacy guest operating systems. This was the default 1650 graphics controller in previous releases. 1651 </para> 1652 1653 <para> 1654 For Windows versions before Windows 7, this is the 1655 default option. Does not require the Guest Additions. 1656 </para> 1657 </listitem> 1658 1659 <listitem> 1660 <para> 1661 <emphasis role="bold">VMSVGA:</emphasis> Used to emulate 1662 a VMware SVGA graphic device. Requires the Guest 1663 Additions. 1664 </para> 1665 </listitem> 1666 1667 <listitem> 1668 <para> 1669 <emphasis role="bold">None:</emphasis> Do not emulate a 1670 graphics adapter type. 1671 </para> 1672 </listitem> 1673 1674 </itemizedlist> 1675 </listitem> 1676 1677 </itemizedlist> 1678 1679 </sect2> 1680 1681 <sect2 id="settings-remote-display"> 1682 1683 <title>Remote Display Tab</title> 1684 1685 <para> 1686 On the <emphasis role="bold">Remote Display</emphasis> tab, if 1687 the VirtualBox Remote Display Extension (VRDE) is installed, you 1688 can enable the VRDP server that is built into &product-name;. 1689 This enables you to connect to the console of the virtual 1690 machine remotely with any standard RDP viewer, such as 1691 <command>mstsc.exe</command> that comes with Microsoft Windows. 1692 On Linux and Oracle Solaris systems you can use the standard 1693 open source <command>rdesktop</command> program. These features 1694 are described in <xref linkend="vrde" />. 1695 </para> 1696 1697 <itemizedlist> 1698 1699 <listitem> 1700 <para> 1701 <emphasis role="bold">Enable Server:</emphasis> Select this 1702 check box and configure settings for the remote display 1703 connection. 1704 </para> 1705 </listitem> 1706 1707 </itemizedlist> 1708 1709 </sect2> 1710 1711 <sect2 id="settings-capture"> 1712 1713 <title>Recording Tab</title> 1714 1715 <remark> 1716 Renamed to Recording tab? Check against RC version. 1717 </remark> 1718 1719 <para> 1720 On the <emphasis role="bold">Recording</emphasis> tab you can 1721 enable video and audio recording for a virtual machine and 1722 change related settings. Note that these features can be enabled 1723 and disabled while a VM is running. 1724 </para> 1725 1726 <itemizedlist> 1727 1728 <listitem> 1729 <para> 1730 <emphasis role="bold">Enable Capture:</emphasis> Select this 1731 check box and select a <emphasis role="bold">Capture 1732 Mode</emphasis> option. 1733 </para> 1734 </listitem> 1735 1736 <listitem> 1737 <para> 1738 <emphasis role="bold">Capture Mode:</emphasis> You can 1739 choose to record video, audio, or both video and audio. 1740 </para> 1741 1742 <para> 1743 Some settings on the 1744 <emphasis role="bold">Recording</emphasis> tab may be grayed 1745 out, depending on the <emphasis role="bold">Capture 1746 Mode</emphasis> setting. 1747 </para> 1748 </listitem> 1749 1750 <listitem> 1751 <para> 1752 <emphasis role="bold">File Path:</emphasis> The file where 1753 the recording is saved. 1754 </para> 1755 </listitem> 1756 1757 <listitem> 1758 <para> 1759 <emphasis role="bold">Frame Size:</emphasis> The video 1760 resolution of the recorded video, in pixels. The drop-down 1761 list enables you to select from common frame sizes. 1762 </para> 1763 </listitem> 1764 1765 <listitem> 1766 <para> 1767 <emphasis role="bold">Frame Rate:</emphasis> Use the slider 1768 to set the maximum number of video frames per second (FPS) 1769 to record. Frames that have a higher frequency are skipped. 1770 Increasing this value reduces the number of skipped frames 1771 and increases the file size. 1772 </para> 1773 </listitem> 1774 1775 <listitem> 1776 <para> 1777 <emphasis role="bold">Quality:</emphasis> Use the slider to 1778 set the the bit rate of the video in kilobits per second. 1779 Increasing this value improves the appearance of the video 1780 at the cost of an increased file size. 1781 </para> 1782 </listitem> 1783 1784 <listitem> 1785 <para> 1786 <emphasis role="bold">Audio Quality:</emphasis> Use the 1787 slider to set the quality of the audio recording. Increasing 1788 this value improves the audio quality at the cost of an 1789 increased file size. 1790 </para> 1791 </listitem> 1792 1793 <listitem> 1794 <para> 1795 <emphasis role="bold">Screens:</emphasis> For a multiple 1796 monitor display, you can select which screens to record 1797 video from. 1798 </para> 1799 </listitem> 1800 1801 </itemizedlist> 1802 1803 <para> 1804 As you adjust the video and audio recording settings, the 1805 approximate output file size for a five minute video is shown. 1806 </para> 1807 1808 </sect2> 1130 1809 1131 1810 </sect1> … … 1136 1815 1137 1816 <para> 1138 The Storage category in the VM settings enables you to connect 1139 virtual hard disk, CD/DVD, and floppy images and drives to your 1140 virtual machine. 1141 </para> 1142 1143 <para> 1144 In a real PC, so-called "storage controllers" connect physical 1145 disk drives to the rest of the computer. Similarly, VirtualBox 1146 presents virtual storage controllers to a virtual machine. Under 1147 each controller, the virtual devices, such as hard disks, CD/DVD 1148 or floppy drives, attached to the controller are shown. 1149 1150 <note> 1151 <para> 1152 This section can only give you a quick introduction to the 1153 VirtualBox storage settings. Since VirtualBox gives you an 1154 enormous wealth of options in this area, we have dedicated an 1155 entire chapter of this User Manual to explaining all the 1156 details. See <xref 1157 linkend="storage" />. 1158 </para> 1159 </note> 1160 </para> 1817 The <emphasis role="bold">Storage</emphasis> category in the VM 1818 settings enables you to connect virtual hard disk, CD/DVD, and 1819 floppy images and drives to your virtual machine. 1820 </para> 1821 1822 <para> 1823 In a real PC, so-called <emphasis>storage controllers</emphasis> 1824 connect physical disk drives to the rest of the computer. 1825 Similarly, &product-name; presents virtual storage controllers to 1826 a virtual machine. Under each controller, the virtual devices, 1827 such as hard disks, CD/DVD or floppy drives, attached to the 1828 controller are shown. 1829 </para> 1830 1831 <note> 1832 <para> 1833 This section gives a quick introduction to the &product-name; 1834 storage settings. See <xref linkend="storage" /> for a full 1835 description of the available storage settings in &product-name;. 1836 </para> 1837 </note> 1161 1838 1162 1839 <para> … … 1166 1843 </para> 1167 1844 1168 <para> 1845 <figure id="fig-storage-settings"> 1846 <title>Storage Settings for a Virtual Machine</title> 1169 1847 <mediaobject> 1170 1848 <imageobject> … … 1173 1851 </imageobject> 1174 1852 </mediaobject> 1175 </ para>1853 </figure> 1176 1854 1177 1855 <para> 1178 1856 Depending on the guest operating system type that you selected 1179 when you created the VM, the typical layout of storage devices in1180 a new VM is as follows:1857 when you created the VM, a new VM includes the following storage 1858 devices: 1181 1859 </para> 1182 1860 … … 1185 1863 <listitem> 1186 1864 <para> 1187 You will see an <emphasis role="bold">IDE 1188 controller</emphasis>, to which a virtual CD/DVD drive has 1189 been attached to the "secondary master" port of the IDE 1190 controller. 1865 <emphasis role="bold">IDE controller.</emphasis> A virtual 1866 CD/DVD drive is attached to the secondary master port of the 1867 IDE controller. 1191 1868 </para> 1192 1869 </listitem> … … 1194 1871 <listitem> 1195 1872 <para> 1196 You will also see a <emphasis role="bold">SATA1197 controller</emphasis>, which is a more modern type of storage1198 controller for higher hard disk data throughput, to which the1199 virtual hard disks are attached. Initially you will normally1200 have one such virtual disk, but as you can see in the above1201 screenshot, you can have more than one. Each is represented by1202 a disk image file, VDI files in this case.1873 <emphasis role="bold">SATA controller.</emphasis> This is a 1874 modern type of storage controller for higher hard disk data 1875 throughput, to which the virtual hard disks are attached. 1876 Initially you will normally have one such virtual disk, but as 1877 shown in the previous screenshot, you can have more than one. 1878 Each is represented by a disk image file, such as a VDI file 1879 in this example. 1203 1880 </para> 1204 1881 </listitem> … … 1207 1884 1208 1885 <para> 1209 If you created your VM with an older version of VirtualBox, the1210 default storage layout may differ. You might then only have an IDE1211 controller to which both the CD/DVD drive and the hard disks have1212 been attached. This might also apply if you selected an older1886 If you created your VM with an older version of &product-name;, 1887 the default storage layout may differ. You might then only have an 1888 IDE controller to which both the CD/DVD drive and the hard disks 1889 have been attached. This might also apply if you selected an older 1213 1890 operating system type when you created the VM. Since older 1214 1891 operating systems do not support SATA without additional drivers, 1215 VirtualBox will make sure that no such devices are present 1216 initially. See <xref 1217 linkend="harddiskcontrollers" />. 1218 </para> 1219 1220 <para> 1221 VirtualBox also provides a <emphasis role="bold">floppy 1892 &product-name; will make sure that no such devices are present 1893 initially. See <xref linkend="harddiskcontrollers" />. 1894 </para> 1895 1896 <para> 1897 &product-name; also provides a <emphasis>floppy 1222 1898 controller</emphasis>. You cannot add devices other than floppy 1223 1899 drives to this controller. Virtual floppy drives, like virtual … … 1243 1919 CD/DVD or floppy drive</emphasis>, select the storage 1244 1920 controller to which it should be added (IDE, SATA, SCSI, SAS, 1245 floppy controller) and then click onthe1921 floppy controller) and then click the 1246 1922 <emphasis role="bold">Add Disk</emphasis> button below the 1247 1923 tree. You can then either select <emphasis role="bold">Add … … 1261 1937 <listitem> 1262 1938 <para> 1263 You can then select to which 1264 <emphasis 1265 role="bold">device 1939 You can then select to which <emphasis role="bold">device 1266 1940 slot</emphasis> of the controller the virtual disk should 1267 1941 be connected to. IDE controllers have four slots which 1268 have traditionally been called "primary master", "primary1269 slave ", "secondary master" and "secondary slave". By1270 contrast, SATA and SCSI controllers offer you up to 301271 slots to which virtual devices can be attached.1942 have traditionally been called primary master, primary 1943 slave, secondary master, and secondary slave. By contrast, 1944 SATA and SCSI controllers offer you up to 30 slots for 1945 attaching virtual devices. 1272 1946 </para> 1273 1947 </listitem> … … 1291 1965 displays the <emphasis role="bold">Create New 1292 1966 Disk</emphasis> wizard, described in 1293 <xref 1294 linkend="gui-createvm" />. 1967 <xref linkend="gui-createvm" />. 1968 </para> 1969 1970 <para> 1971 For virtual floppy drives, a dialog enables you to 1972 create and format a new floppy disk image 1973 automatically. 1295 1974 </para> 1296 1975 1297 1976 <para> 1298 1977 For details on the image file types that are 1299 supported, see 1300 <xref 1301 linkend="vdidetails" />. 1978 supported, see <xref linkend="vdidetails" />. 1302 1979 </para> 1303 1980 </listitem> … … 1334 2011 1335 2012 <para> 1336 If you want to write (burn) CDs or DVDs using the1337 host drive, you need to also enable the2013 If you want to write, or burn, CDs or DVDs using 2014 the host drive, you need to also enable the 1338 2015 <emphasis role="bold">Passthrough</emphasis> 1339 2016 option. See <xref linkend="storage-cds" />. … … 1344 2021 <para> 1345 2022 If you select <emphasis role="bold">Remove Disk 1346 from Virtual Drive</emphasis>, VirtualBoxwill2023 from Virtual Drive</emphasis>, &product-name; will 1347 2024 present an empty CD/DVD drive to the guest into 1348 2025 which no media has been inserted. … … 1372 2049 <para> 1373 2050 Removable media, such as CD/DVDs and floppies, can be changed 1374 while the guest is running. Since the Settings dialog is not 1375 available at that time, you can also access these settings from 1376 the <emphasis role="bold">Devices</emphasis> menu of your virtual 2051 while the guest is running. Since the 2052 <emphasis role="bold">Settings</emphasis> dialog is not available 2053 at that time, you can also access these settings from the 2054 <emphasis role="bold">Devices</emphasis> menu of your virtual 1377 2055 machine window. 1378 2056 </para> … … 1385 2063 1386 2064 <para> 1387 The Audio section in a virtual machine's Settings window 1388 determines whether the VM will see a sound card connected, and 1389 whether the audio output should be heard on the host system. 1390 </para> 1391 1392 <para> 1393 If audio is enabled for a guest, you can choose between the 1394 emulation of an Intel AC'97 controller, an Intel HD Audio 1395 controller 1396 1397 <footnote> 1398 1399 <para> 1400 Intel HD Audio support was added with VirtualBox 4.0 because 1401 Windows 7 and later (as well as 64-bit Windows Vista) do not 1402 support the Intel AC'97 controller out of the box. 1403 </para> 1404 1405 </footnote> 1406 1407 or a SoundBlaster 16 card. In any case, you can select what audio 1408 driver VirtualBox will use on the host. 1409 </para> 1410 1411 <para> 1412 On a Linux host, depending on your host configuration, you can 1413 also select between the OSS, ALSA, or the PulseAudio subsystem. On 1414 newer Linux distributions, the PulseAudio subsystem should be 1415 preferred. 1416 </para> 1417 1418 <para> 1419 Since VirtualBox 5.0 only OSS is supported on Solaris hosts. The 1420 "Solaris Audio" audio backend is no longer supported on Solaris 1421 hosts. 1422 </para> 2065 The <emphasis role="bold">Audio</emphasis> section in a virtual 2066 machine's <emphasis role="bold">Settings</emphasis> window 2067 determines whether the VM will detect a connected sound card, and 2068 if the audio output should be played on the host system. 2069 </para> 2070 2071 <para> 2072 To enable audio for a guest, select the 2073 <emphasis role="bold">Enable Audio</emphasis> check box. The 2074 following settings are available: 2075 </para> 2076 2077 <itemizedlist> 2078 2079 <listitem> 2080 <para> 2081 <emphasis role="bold">Host Audio Driver:</emphasis> The audio 2082 driver that &product-name; uses on the host. On a Linux host, 2083 depending on your host configuration, you can select between 2084 the OSS, ALSA, or the PulseAudio subsystem. On newer Linux 2085 distributions, the PulseAudio subsystem is preferred. 2086 </para> 2087 2088 <para> 2089 Only OSS is supported on Oracle Solaris hosts. The Oracle 2090 Solaris Audio audio backend is no longer supported on Oracle 2091 Solaris hosts. 2092 </para> 2093 </listitem> 2094 2095 <listitem> 2096 <para> 2097 <emphasis role="bold">Audio Controller:</emphasis> You can 2098 choose between the emulation of an Intel AC'97 controller, an 2099 Intel HD Audio controller, or a SoundBlaster 16 card. 2100 </para> 2101 </listitem> 2102 2103 <listitem> 2104 <para> 2105 <emphasis role="bold">Enable Audio Output:</emphasis> Enables 2106 audio output only for the VM. 2107 </para> 2108 </listitem> 2109 2110 <listitem> 2111 <para> 2112 <emphasis role="bold">Enable Audio Input:</emphasis> Enables 2113 audio input only for the VM. 2114 </para> 2115 </listitem> 2116 2117 </itemizedlist> 1423 2118 1424 2119 </sect1> … … 1429 2124 1430 2125 <para> 1431 The Network section in a virtual machine's Settings window enables 1432 you to configure how VirtualBox presents virtual network cards to 1433 your VM, and how they operate. 1434 </para> 1435 1436 <para> 1437 When you first create a virtual machine, VirtualBox by default 2126 The <emphasis role="bold">Network</emphasis> section in a virtual 2127 machine's <emphasis role="bold">Settings</emphasis> window enables 2128 you to configure how &product-name; presents virtual network cards 2129 to your VM, and how they operate. 2130 </para> 2131 2132 <para> 2133 When you first create a virtual machine, &product-name; by default 1438 2134 enables one virtual network card and selects the Network Address 1439 2135 Translation (NAT) mode for it. This way the guest can connect to … … 1444 2140 1445 2141 <para> 1446 This default setup is good for the majority of VirtualBox users.1447 However, VirtualBox is extremely flexible in how it can virtualize1448 networking. It supports many virtual network cards per virtual1449 machine, the first four of which can be configured in detail in1450 the Manager window. Additional network cards can be configured on1451 the command line with VBoxManage.1452 </para>1453 1454 <para> 1455 Because of the vast array of options available, we have dedicated1456 an entire chapter of this manual to discussing networking1457 configuration. See <xref linkend="networkingdetails" />.2142 This default setup is good for the majority of &product-name; 2143 users. However, &product-name; is extremely flexible in how it can 2144 virtualize networking. It supports many virtual network cards per 2145 virtual machine. The first four virtual network cards can be 2146 configured in detail in the VirtualBox Manager window. Additional 2147 network cards can be configured using the 2148 <command>VBoxManage</command> command. 2149 </para> 2150 2151 <para> 2152 Many networking options are available. See 2153 <xref linkend="networkingdetails" /> for more information. 1458 2154 </para> 1459 2155 … … 1465 2161 1466 2162 <para> 1467 VirtualBox fully supports virtual serial ports in a virtual 1468 machine in an easy-to-use manner. 1469 1470 <footnote> 1471 1472 <para> 1473 Serial port support was added with VirtualBox 1.5. 1474 </para> 1475 1476 </footnote> 2163 &product-name; supports the use of virtual serial ports in a 2164 virtual machine. 1477 2165 </para> 1478 2166 … … 1486 2174 1487 2175 <para> 1488 While serial ports are no longer as ubiquitousas they used to be,2176 While serial ports are no longer as common as they used to be, 1489 2177 there are still some important uses left for them. For example, 1490 2178 serial ports can be used to set up a primitive network over a … … 1499 2187 <para> 1500 2188 If a virtual serial port is enabled, the guest operating system 1501 sees a standard 16550A compatible UART device. Both receiving and1502 transmitting data is supported. How this virtual serial port is1503 then connected to the host is configurable, and the details depend1504 on your host operating system.1505 </para>1506 1507 < para>1508 You can use either the graphical user interface or the 1509 command-line <computeroutput>VBoxManage</computeroutput> tool to1510 set up virtual serial ports. For the latter, see1511 < xref1512 linkend="vboxmanage-modifyvm" /> for information on the1513 <computeroutput>--uart</computeroutput> and1514 <computeroutput>--uartmode</computeroutput> options.1515 </para>1516 1517 <para> 1518 In either case, you can configure up to four virtual serial ports1519 per virtual machine. For each such device, you will need to1520 determinethe following:2189 sees a standard 16550A compatible UART device. Other UART types 2190 can be configured using the <command>VBoxManage modifyvm</command> 2191 command. Both receiving and transmitting data is supported. How 2192 this virtual serial port is then connected to the host is 2193 configurable, and the details depend on your host operating 2194 system. 2195 </para> 2196 2197 <para> 2198 You can use either the Settings tabs or the 2199 <command>VBoxManage</command> command to set up virtual serial 2200 ports. For the latter, see <xref linkend="vboxmanage-modifyvm" /> 2201 for information on the <computeroutput>--uart</computeroutput>, 2202 <computeroutput>--uartmode</computeroutput> and 2203 <computeroutput>--uarttype</computeroutput> options. 2204 </para> 2205 2206 <para> 2207 You can configure up to four virtual serial ports per virtual 2208 machine. For each device, you must set the following: 1521 2209 </para> 1522 2210 … … 1525 2213 <listitem> 1526 2214 <para> 1527 What kind of serial port the virtual machine should see, by 1528 selecting an I/O base address and interrupt (IRQ). For these, 1529 we recommend you use the traditional values, as follows: 1530 1531 <footnote> 1532 1533 <para> 1534 See, for example, 1535 <ulink 2215 <emphasis role="bold">Port Number:</emphasis> This determines 2216 the serial port that the virtual machine should see. For best 2217 results, use the traditional values as follows: 2218 </para> 2219 2220 <itemizedlist> 2221 2222 <listitem> 2223 <para> 2224 COM1: I/O base 0x3F8, IRQ 4 2225 </para> 2226 </listitem> 2227 2228 <listitem> 2229 <para> 2230 COM2: I/O base 0x2F8, IRQ 3 2231 </para> 2232 </listitem> 2233 2234 <listitem> 2235 <para> 2236 COM3: I/O base 0x3E8, IRQ 4 2237 </para> 2238 </listitem> 2239 2240 <listitem> 2241 <para> 2242 COM4: I/O base 0x2E8, IRQ 3 2243 </para> 2244 </listitem> 2245 2246 </itemizedlist> 2247 2248 <para> 2249 You can also configure a user-defined serial port. Enter an 2250 I/O base address and interrupt (IRQ). 2251 </para> 2252 2253 <para> 2254 See also 2255 <ulink 1536 2256 url="http://en.wikipedia.org/wiki/COM_(hardware_interface)">http://en.wikipedia.org/wiki/COM_(hardware_interface)</ulink>. 1537 </para> 1538 1539 </footnote> 2257 </para> 2258 </listitem> 2259 2260 <listitem> 2261 <para> 2262 <emphasis role="bold">Port Mode:</emphasis> What the virtual 2263 port is connected to. For each virtual serial port, you have 2264 the following options: 1540 2265 </para> 1541 2266 … … 1544 2269 <listitem> 1545 2270 <para> 1546 COM1: I/O base 0x3F8, IRQ 4 1547 </para> 1548 </listitem> 1549 1550 <listitem> 1551 <para> 1552 COM2: I/O base 0x2F8, IRQ 3 1553 </para> 1554 </listitem> 1555 1556 <listitem> 1557 <para> 1558 COM3: I/O base 0x3E8, IRQ 4 1559 </para> 1560 </listitem> 1561 1562 <listitem> 1563 <para> 1564 COM4: I/O base 0x2E8, IRQ 3 1565 </para> 1566 </listitem> 1567 1568 </itemizedlist> 1569 </listitem> 1570 1571 <listitem> 1572 <para> 1573 Then, you will need to determine what this virtual port should 1574 be connected to. For each virtual serial port, you have the 1575 following options: 1576 </para> 1577 1578 <itemizedlist> 1579 1580 <listitem> 1581 <para> 1582 You can configure the virtual serial port to be 1583 "disconnected". This means that the guest will see the 1584 device, but it will behave as if no cable had been 1585 connected to it. 1586 </para> 1587 </listitem> 1588 1589 <listitem> 1590 <para> 1591 You can connect the virtual serial port to a physical 1592 serial port on your host. On a Windows host, this will be 1593 a name like <computeroutput>COM1</computeroutput>. On 1594 Linux or Solaris hosts, it will be a device node like 1595 <computeroutput>/dev/ttyS0</computeroutput>. VirtualBox 1596 will then simply redirect all data received from and sent 1597 to the virtual serial port to the physical device. 1598 </para> 1599 </listitem> 1600 1601 <listitem> 1602 <para> 1603 You can tell VirtualBox to connect the virtual serial port 1604 to a software pipe on the host. This depends on your host 2271 <emphasis role="bold">Disconnected:</emphasis> The guest 2272 will see the device, but it will behave as if no cable had 2273 been connected to it. 2274 </para> 2275 </listitem> 2276 2277 <listitem> 2278 <para> 2279 <emphasis role="bold">Host Device:</emphasis> Connects the 2280 virtual serial port to a physical serial port on your 2281 host. On a Windows host, this will be a name like 2282 <computeroutput>COM1</computeroutput>. On Linux or Oracle 2283 Solaris hosts, it will be a device node like 2284 <computeroutput>/dev/ttyS0</computeroutput>. 2285 &product-name; will then simply redirect all data received 2286 from and sent to the virtual serial port to the physical 2287 device. 2288 </para> 2289 </listitem> 2290 2291 <listitem> 2292 <para> 2293 <emphasis role="bold">Host Pipe:</emphasis> Configure 2294 &product-name; to connect the virtual serial port to a 2295 software pipe on the host. This depends on your host 1605 2296 operating system, as follows: 1606 2297 </para> … … 1622 2313 <listitem> 1623 2314 <para> 1624 On a Mac, Linux, or Solaris host, a local domain1625 socket is used instead. The socket filename must be1626 chosen such that the user running VirtualBox has1627 sufficient privileges to create and write to it. The1628 <computeroutput>/tmp</computeroutput> directory is1629 often a good candidate.2315 On a Mac, Linux, or Oracle Solaris host, a local 2316 domain socket is used instead. The socket filename 2317 must be chosen such that the user running 2318 &product-name; has sufficient privileges to create and 2319 write to it. The <computeroutput>/tmp</computeroutput> 2320 directory is often a good candidate. 1630 2321 </para> 1631 2322 … … 1642 2333 1643 2334 <para> 1644 In this case, you can configure whether VirtualBox should1645 create the named pipe (or, on non-Windows hosts, the local1646 domain socket) itself or whether VirtualBox should assume1647 that the pipe or socket exists already. With the1648 <com puteroutput>VBoxManage</computeroutput> command-line1649 options, this is referred to as "server" or "client"mode,2335 In this case, you can configure whether &product-name; 2336 should create the named pipe, or the local domain socket 2337 non-Windows hosts, itself or whether &product-name; should 2338 assume that the pipe or socket exists already. With the 2339 <command>VBoxManage</command> command-line options, this 2340 is referred to as server mode or client mode, 1650 2341 respectively. 1651 2342 </para> … … 1654 2345 For a direct connection between two virtual machines, 1655 2346 corresponding to a null-modem cable, simply configure one 1656 VM to create a pipe/socket and another to attach to it. 1657 </para> 1658 </listitem> 1659 1660 <listitem> 1661 <para> 1662 You can send the virtual serial port output to a file. 1663 This option is very useful for capturing diagnostic output 1664 from a guest. Any file may be used for this purpose, as 1665 long as the user running VirtualBox has sufficient 1666 privileges to create and write to the file. 1667 </para> 1668 </listitem> 1669 1670 <listitem> 1671 <para> 1672 TCP Socket: Useful for forwarding serial traffic over 1673 TCP/IP, acting as a server, or it can act as a TCP client 1674 connecting to other servers. It allows a remote machine to 1675 directly connect to the guest's serial port via TCP. 2347 VM to create a pipe or socket and another to attach to it. 2348 </para> 2349 </listitem> 2350 2351 <listitem> 2352 <para> 2353 <emphasis role="bold">Raw File:</emphasis> Send the 2354 virtual serial port output to a file. This option is very 2355 useful for capturing diagnostic output from a guest. Any 2356 file may be used for this purpose, as long as the user 2357 running &product-name; has sufficient privileges to create 2358 and write to the file. 2359 </para> 2360 </listitem> 2361 2362 <listitem> 2363 <para> 2364 <emphasis role="bold">TCP Socket:</emphasis> Useful for 2365 forwarding serial traffic over TCP/IP, acting as a server, 2366 or it can act as a TCP client connecting to other servers. 2367 This option enables a remote machine to directly connect 2368 to the guest's serial port using TCP. 1676 2369 </para> 1677 2370 … … 1680 2373 <listitem> 1681 2374 <para> 1682 TCP Server: Uncheck the <emphasis>Connect to existing 1683 pipe/socket</emphasis> checkbox and specify the 1684 <emphasis role="bold"><computeroutput>port</computeroutput></emphasis> 1685 number. Typically 23 or 2023. Note that on UNIX-like 2375 <emphasis role="bold">TCP Server:</emphasis> Deselect 2376 the <emphasis role="bold">Connect to Existing 2377 Pipe/Socket</emphasis> check box and specify the port 2378 number in the 2379 <emphasis role="bold">Path/Address</emphasis> field. 2380 This is typically 23 or 2023. Note that on UNIX-like 1686 2381 systems you will have to use a port a number greater 1687 2382 than 1024 for regular users. … … 1690 2385 <para> 1691 2386 The client can use software such as 1692 <com puteroutput>PuTTY</computeroutput> or the1693 <com puteroutput>telnet</computeroutput> command line1694 t ool to access the TCP Server.2387 <command>PuTTY</command> or the 2388 <command>telnet</command> command line tool to access 2389 the TCP Server. 1695 2390 </para> 1696 2391 </listitem> … … 1698 2393 <listitem> 1699 2394 <para> 1700 TCP Client: To create a virtual null-modem cable over 1701 the Internet or LAN, the other side can connect via 1702 TCP by specifying 1703 <computeroutput>hostname:port</computeroutput>. The 1704 TCP socket will act in client mode if you check the 1705 <emphasis role="bold">Connect to existing 1706 pipe/socket</emphasis> checkbox. 2395 <emphasis role="bold">TCP Client:</emphasis> To create 2396 a virtual null-modem cable over the Internet or LAN, 2397 the other side can connect using TCP by specifying 2398 <computeroutput>hostname:port</computeroutput> in the 2399 <emphasis role="bold">Path/Address</emphasis> field. 2400 The TCP socket will act in client mode if you select 2401 the <emphasis role="bold">Connect to Existing 2402 Pipe/Socket</emphasis> check box. 1707 2403 </para> 1708 2404 </listitem> … … 1719 2415 Up to four serial ports can be configured per virtual machine, but 1720 2416 you can pick any port numbers out of the above. However, serial 1721 ports cannot reliably share interrupts ; if both ports are to be2417 ports cannot reliably share interrupts. If both ports are to be 1722 2418 used at the same time, they must use different interrupt levels, 1723 2419 for example COM1 and COM2, but not COM1 and COM3. … … 1735 2431 1736 2432 <para> 1737 The USB section in a virtual machine's Settings window enables 1738 you to configure VirtualBox's sophisticated USB support. 1739 </para> 1740 1741 <para> 1742 VirtualBox can enable virtual machines to access the USB devices 1743 on your host directly. To achieve this, VirtualBox presents the 1744 guest operating system with a virtual USB controller. As soon as 1745 the guest system starts using a USB device, it will appear as 1746 unavailable on the host. 2433 The <emphasis role="bold">USB</emphasis> section in a virtual 2434 machine's <emphasis role="bold">Settings</emphasis> window 2435 enables you to configure &product-name;'s sophisticated USB 2436 support. 2437 </para> 2438 2439 <para> 2440 &product-name; can enable virtual machines to access the USB 2441 devices on your host directly. To achieve this, &product-name; 2442 presents the guest operating system with a virtual USB 2443 controller. As soon as the guest system starts using a USB 2444 device, it will appear as unavailable on the host. 1747 2445 </para> 1748 2446 … … 1753 2451 <para> 1754 2452 Be careful with USB devices that are currently in use on 1755 the host !For example, if you allow your guest to connect2453 the host. For example, if you allow your guest to connect 1756 2454 to your USB hard disk that is currently mounted on the 1757 2455 host, when the guest is activated, it will be disconnected … … 1763 2461 <listitem> 1764 2462 <para> 1765 Solaris hosts have a few known limitations regarding USB1766 support. See <xref linkend="KnownIssues" />.2463 Oracle Solaris hosts have a few known limitations 2464 regarding USB support. See <xref linkend="KnownIssues" />. 1767 2465 </para> 1768 2466 </listitem> … … 1773 2471 <para> 1774 2472 In addition to allowing a guest access to your local USB 1775 devices, VirtualBox even allows your guests to connect to remote 1776 USB devices by use of the VirtualBox Remote Desktop Extension 1777 (VRDE). See <xref linkend="usb-over-rdp" />. 1778 </para> 1779 1780 <para> 1781 In the Settings dialog, you can first configure whether USB is 1782 available in the guest at all, and then choose the level of USB 1783 support: OHCI for USB 1.1, EHCI (which will also enable OHCI) 1784 for USB 2.0, or xHCI for all USB speeds. 1785 </para> 1786 1787 <note> 1788 <para> 1789 The xHCI and EHCI controllers are shipped as a VirtualBox 1790 extension package, which must be installed separately. See 1791 <xref 1792 linkend="intro-installing" />. 1793 </para> 1794 </note> 1795 1796 <para> 1797 When USB support is enabled for a VM, you can determine in 1798 detail which devices will be automatically attached to the 1799 guest. For this, you can create so-called "filters" by 1800 specifying certain properties of the USB device. USB devices 1801 with a matching filter will be automatically passed to the guest 1802 once they are attached to the host. USB devices without a 1803 matching filter can be passed manually to the guest, for example 1804 by using the <emphasis role="bold">Devices</emphasis>, 1805 <emphasis role="bold">USB</emphasis> menu. 1806 </para> 1807 1808 <para> 1809 Clicking on the <emphasis role="bold">+</emphasis> button to the 1810 right of the <emphasis role="bold">USB Device Filters</emphasis> 1811 window creates a new filter. You can give the filter a name, for 1812 later reference, and specify the filter criteria. The more 1813 criteria you specify, the more precisely devices will be 1814 selected. For instance, if you specify only a vendor ID of 046d, 1815 all devices produced by Logitech will be available to the guest. 1816 If you fill in all fields, on the other hand, the filter will 1817 only apply to a particular device model from a particular 1818 vendor, and not even to other devices of the same type with a 1819 different revision and serial number. 1820 </para> 1821 1822 <para> 1823 In detail, the following criteria are available: 2473 devices, &product-name; even enables your guests to connect to 2474 remote USB devices by use of the VirtualBox Remote Desktop 2475 Extension (VRDE). See <xref linkend="usb-over-rdp" />. 2476 </para> 2477 2478 <para> 2479 To enable USB for a VM, select the <emphasis role="bold">Enable 2480 USB Controller</emphasis> check box. The following settings are 2481 available: 1824 2482 </para> 1825 2483 … … 1828 2486 <listitem> 1829 2487 <para> 1830 <emphasis role="bold">Vendor and product ID</emphasis>. With 1831 USB, each vendor of USB products carries an identification 1832 number that is unique world-wide, called the 1833 <emphasis>vendor ID</emphasis>. Similarly, each line of 1834 products is assigned a <emphasis>product ID</emphasis> 1835 number. Both numbers are commonly written in hexadecimal 1836 (that is, they are composed of the numbers 0-9 and the 1837 letters A-F), and a colon separates the vendor from the 1838 product ID. For example, 1839 <computeroutput>046d:c016</computeroutput> stands for 1840 Logitech as a vendor, and the M-UV69a Optical Wheel Mouse 1841 product. 1842 </para> 1843 1844 <para> 1845 Alternatively, you can also specify 1846 <emphasis 1847 role="bold">Manufacturer</emphasis> and 1848 <emphasis 1849 role="bold">Product</emphasis> by name. 1850 </para> 1851 1852 <para> 1853 To list all the USB devices that are connected to your host 1854 machine with their respective vendor IDs and product IDs, 1855 use the following command: 2488 <emphasis role="bold">USB Controller:</emphasis> Selects a 2489 controller with the specified level of USB support, as 2490 follows: 2491 </para> 2492 2493 <itemizedlist> 2494 2495 <listitem> 2496 <para> 2497 OHCI for USB 1.1 2498 </para> 2499 </listitem> 2500 2501 <listitem> 2502 <para> 2503 EHCI for USB 2.0. This also enables OHCI. 2504 </para> 2505 </listitem> 2506 2507 <listitem> 2508 <para> 2509 xHCI for USB 3.0. This supports all USB speeds. 2510 </para> 2511 </listitem> 2512 2513 </itemizedlist> 2514 2515 <note> 2516 <para> 2517 The xHCI and EHCI controllers are shipped as an 2518 &product-name; extension package, which must be installed 2519 separately. See <xref linkend="intro-installing" />. 2520 </para> 2521 </note> 2522 </listitem> 2523 2524 <listitem> 2525 <para> 2526 <emphasis role="bold">USB Device Filters:</emphasis> When 2527 USB support is enabled for a VM, you can determine in detail 2528 which devices will be automatically attached to the guest. 2529 For this, you can create filters by specifying certain 2530 properties of the USB device. USB devices with a matching 2531 filter will be automatically passed to the guest once they 2532 are attached to the host. USB devices without a matching 2533 filter can be passed manually to the guest, for example by 2534 using the <emphasis role="bold">Devices</emphasis>, 2535 <emphasis role="bold">USB</emphasis> menu. 2536 </para> 2537 2538 <para> 2539 Clicking on the <emphasis role="bold">+</emphasis> button to 2540 the right of the <emphasis role="bold">USB Device 2541 Filters</emphasis> window creates a new filter. You can give 2542 the filter a name, for later reference, and specify the 2543 filter criteria. The more criteria you specify, the more 2544 precisely devices will be selected. For instance, if you 2545 specify only a vendor ID of 046d, all devices produced by 2546 Logitech will be available to the guest. If you fill in all 2547 fields, on the other hand, the filter will only apply to a 2548 particular device model from a particular vendor, and not 2549 even to other devices of the same type with a different 2550 revision and serial number. 2551 </para> 2552 2553 <para> 2554 In detail, the following criteria are available: 2555 </para> 2556 2557 <itemizedlist> 2558 2559 <listitem> 2560 <para> 2561 <emphasis role="bold">Vendor and Product ID.</emphasis> 2562 With USB, each vendor of USB products carries an 2563 identification number that is unique world-wide, called 2564 the <emphasis>vendor ID</emphasis>. Similarly, each line 2565 of products is assigned a <emphasis>product 2566 ID</emphasis> number. Both numbers are commonly written 2567 in hexadecimal, and a colon separates the vendor from 2568 the product ID. For example, 2569 <computeroutput>046d:c016</computeroutput> stands for 2570 Logitech as a vendor, and the M-UV69a Optical Wheel 2571 Mouse product. 2572 </para> 2573 2574 <para> 2575 Alternatively, you can also specify 2576 <emphasis role="bold">Manufacturer</emphasis> and 2577 <emphasis role="bold">Product</emphasis> by name. 2578 </para> 2579 2580 <para> 2581 To list all the USB devices that are connected to your 2582 host machine with their respective vendor IDs and 2583 product IDs, use the following command: 2584 </para> 1856 2585 1857 2586 <screen>VBoxManage list usbhost</screen> 1858 </para> 1859 1860 <para> 1861 On Windows, you can also see all USB devices that are 1862 attached to your system in the Device Manager. On Linux, you 1863 can use the <computeroutput>lsusb</computeroutput> command. 1864 </para> 1865 </listitem> 1866 1867 <listitem> 1868 <para> 1869 <emphasis role="bold">Serial number</emphasis>. While vendor 1870 ID and product ID are quite specific to identify USB 1871 devices, if you have two identical devices of the same brand 1872 and product line, you will also need their serial numbers to 1873 filter them out correctly. 1874 </para> 1875 </listitem> 1876 1877 <listitem> 1878 <para> 1879 <emphasis role="bold">Remote</emphasis>. This setting 1880 specifies whether the device will be local only, remote only 1881 (such as over VRDP), or either. 2587 2588 <para> 2589 On Windows, you can also see all USB devices that are 2590 attached to your system in the Device Manager. On Linux, 2591 you can use the <command>lsusb</command> command. 2592 </para> 2593 </listitem> 2594 2595 <listitem> 2596 <para> 2597 <emphasis role="bold">Serial Number.</emphasis> While 2598 vendor ID and product ID are quite specific to identify 2599 USB devices, if you have two identical devices of the 2600 same brand and product line, you will also need their 2601 serial numbers to filter them out correctly. 2602 </para> 2603 </listitem> 2604 2605 <listitem> 2606 <para> 2607 <emphasis role="bold">Remote.</emphasis> This setting 2608 specifies whether the device will be local only, remote 2609 only, such as over VRDP, or either. 2610 </para> 2611 </listitem> 2612 2613 </itemizedlist> 2614 2615 <para> 2616 On a Windows host, you will need to unplug and reconnect a 2617 USB device to use it after creating a filter for it. 2618 </para> 2619 2620 <para> 2621 As an example, you could create a new USB filter and specify 2622 a vendor ID of 046d for Logitech, Inc, a manufacturer index 2623 of 1, and "not remote". Then any USB devices on the host 2624 system produced by Logitech, Inc with a manufacturer index 2625 of 1 will be visible to the guest system. 2626 </para> 2627 2628 <para> 2629 Several filters can select a single device. For example, a 2630 filter which selects all Logitech devices, and one which 2631 selects a particular webcam. 2632 </para> 2633 2634 <para> 2635 You can deactivate filters without deleting them by 2636 deselecting the check box next to the filter name. 1882 2637 </para> 1883 2638 </listitem> … … 1885 2640 </itemizedlist> 1886 2641 1887 <para>1888 On a Windows host, you will need to unplug and reconnect a USB1889 device to use it after creating a filter for it.1890 </para>1891 1892 <para>1893 As an example, you could create a new USB filter and specify a1894 vendor ID of 046d (Logitech, Inc), a manufacturer index of 1,1895 and "not remote". Then any USB devices on the host system1896 produced by Logitech, Inc with a manufacturer index of 1 will be1897 visible to the guest system.1898 </para>1899 1900 <para>1901 Several filters can select a single device. For example, a1902 filter which selects all Logitech devices, and one which selects1903 a particular webcam.1904 </para>1905 1906 <para>1907 You can deactivate filters without deleting them by clicking in1908 the checkbox next to the filter name.1909 </para>1910 1911 2642 </sect2> 1912 2643 … … 1917 2648 <para> 1918 2649 On Windows hosts, a kernel mode device driver provides USB proxy 1919 support. It implements both a USB monitor, which allows1920 VirtualBox to capture devices when they are plugged in, and a1921 USB device driver to claim USB devices for a particular virtual1922 machine. As opposed to VirtualBox versions before 1.4.0, system1923 reboots are no longer necessary after installing the driver.1924 Also, you no longer need to replug devices for VirtualBox to1925 claim them.1926 </para> 1927 1928 <para> 1929 On newer Linux hosts, VirtualBox accesses USB devices through1930 special files in the file system. When VirtualBox is installed,1931 these are made available to all users in the2650 support. It implements both a USB monitor, which enables 2651 &product-name; to capture devices when they are plugged in, and 2652 a USB device driver to claim USB devices for a particular 2653 virtual machine. As opposed to &product-name; versions before 2654 1.4.0, system reboots are no longer necessary after installing 2655 the driver. Also, you no longer need to replug devices for 2656 &product-name; to claim them. 2657 </para> 2658 2659 <para> 2660 On newer Linux hosts, &product-name; accesses USB devices 2661 through special files in the file system. When &product-name; is 2662 installed, these are made available to all users in the 1932 2663 <computeroutput>vboxusers</computeroutput> system group. In 1933 2664 order to be able to access USB from guest systems, make sure … … 1938 2669 On older Linux hosts, USB devices are accessed using the 1939 2670 <computeroutput>usbfs</computeroutput> file system. Therefore, 1940 the user executing VirtualBox needs read and write permission to 1941 the USB file system. Most distributions provide a group (e.g. 1942 <computeroutput>usbusers</computeroutput>) which the VirtualBox 1943 user needs to be added to. Also, VirtualBox can only proxy to 1944 virtual machines USB devices which are not claimed by a Linux 1945 host USB driver. The <computeroutput>Driver=</computeroutput> 1946 entry in <computeroutput>/proc/bus/usb/devices</computeroutput> 1947 will show you which devices are currently claimed. See also 2671 the user executing &product-name; needs read and write 2672 permission to the USB file system. Most distributions provide a 2673 group, such as <computeroutput>usbusers</computeroutput>, which 2674 the &product-name; user needs to be added to. Also, 2675 &product-name; can only proxy to virtual machines USB devices 2676 which are not claimed by a Linux host USB driver. The 2677 <computeroutput>Driver=</computeroutput> entry in 2678 <computeroutput>/proc/bus/usb/devices</computeroutput> will show 2679 you which devices are currently claimed. See also 1948 2680 <xref 1949 2681 linkend="ts_usb-linux" /> for details about … … 1962 2694 Shared folders enable you to easily exchange data between a 1963 2695 virtual machine and your host. This feature requires that the 1964 VirtualBox Guest Additions be installed in a virtual machine and1965 is described in detail in <xref linkend="sharedfolders" />.2696 &product-name; Guest Additions be installed in a virtual machine 2697 and is described in detail in <xref linkend="sharedfolders" />. 1966 2698 </para> 1967 2699 … … 1973 2705 1974 2706 <para> 1975 The User Interface section allows you to change certain aspects of 1976 the user interface of this VM. 2707 The <emphasis role="bold">User Interface</emphasis> section 2708 enables you to change certain aspects of the user interface of 2709 this VM. 1977 2710 </para> 1978 2711 … … 1983 2716 <emphasis role="bold">Menu Bar:</emphasis> This widget enables 1984 2717 you to disable menus by clicking on the menu to release it, 1985 menu entries by unchecking the checkbox of the entry to1986 disable it and the complete menu bar by unchecking the1987 rightmost check box.2718 menu entries by deselecting the check box of the entry to 2719 disable it and the complete menu bar by deselecting the 2720 rightmost check box. 1988 2721 </para> 1989 2722 </listitem> … … 1992 2725 <para> 1993 2726 <emphasis role="bold">Mini ToolBar:</emphasis> In full screen 1994 or seamless mode, VirtualBox can display a small toolbar that1995 contains some of the items that are normally available from1996 the virtual machine's menu bar. This toolbar reduces itself to1997 a small gray line unless you move the mouse over it. With the1998 toolbar, you can return from full screen or seamless mode,1999 control machine execution or enable certain devices. If you do2000 not want to see the toolbar, disable this setting.2727 or seamless mode, &product-name; can display a small toolbar 2728 that contains some of the items that are normally available 2729 from the virtual machine's menu bar. This toolbar reduces 2730 itself to a small gray line unless you move the mouse over it. 2731 With the toolbar, you can return from full screen or seamless 2732 mode, control machine execution or enable certain devices. If 2733 you do not want to see the toolbar, disable this setting. 2001 2734 </para> 2002 2735 … … 2010 2743 <para> 2011 2744 <emphasis role="bold">Status Bar:</emphasis> This widget 2012 allows you to disable icons on the status bar by unchecking2013 the check box of an icon to disable it, to rearrange icons by2745 enables you to disable icons on the status bar by deselecting 2746 the check box of an icon to disable it, to rearrange icons by 2014 2747 dragging and dropping the icon, and to disable the complete 2015 status bar by unchecking the leftmost checkbox.2748 status bar by deselecting the leftmost check box. 2016 2749 </para> 2017 2750 </listitem> … … 2026 2759 2027 2760 <para> 2028 Starting with release 3.1, VirtualBox includes experimental2029 support for the Extensible Firmware Interface (EFI), which is a2030 new industry standard intended to eventually replace the legacy2031 BIOS as the primary interface for bootstrapping computers and2032 certain system serviceslater.2033 </para> 2034 2035 <para> 2036 By default, VirtualBoxuses the BIOS firmware for virtual2761 &product-name; includes experimental support for the Extensible 2762 Firmware Interface (EFI), which is a new industry standard 2763 intended to eventually replace the legacy BIOS as the primary 2764 interface for bootstrapping computers and certain system services 2765 later. 2766 </para> 2767 2768 <para> 2769 By default, &product-name; uses the BIOS firmware for virtual 2037 2770 machines. To use EFI for a given virtual machine, you can enable 2038 EFI in the machine's Settings dialog. See2039 <xref linkend="settings-motherboard" />. Alternatively, use the2040 <computeroutput>VBoxManage</computeroutput> command line interface2041 asfollows:2771 EFI in the machine's <emphasis role="bold">Settings</emphasis> 2772 dialog. See <xref linkend="settings-motherboard"/>. Alternatively, 2773 use the <command>VBoxManage</command> command line interface as 2774 follows: 2042 2775 </para> 2043 2776 … … 2051 2784 2052 2785 <para> 2053 One notable user of EFI is Apple 's Mac OS X, but more recent2054 Linuxes and Windows, starting with Vista, offer special versions2055 that can be booted using EFI as well.2056 </para> 2057 2058 <para> 2059 Another possible use of EFI in VirtualBoxis development and2786 One notable user of EFI is Apple Mac OS X. More recent Linux 2787 versions and Windows releases, starting with Vista, also offer 2788 special versions that can be booted using EFI. 2789 </para> 2790 2791 <para> 2792 Another possible use of EFI in &product-name; is development and 2060 2793 testing of EFI applications, without booting any OS. 2061 2794 </para> 2062 2795 2063 2796 <para> 2064 Note that the VirtualBox EFI support is experimental and will be2065 enhanced as EFI matures and becomes more widespread. Mac OS X,2797 Note that the &product-name; EFI support is experimental and will 2798 be enhanced as EFI matures and becomes more widespread. Mac OS X, 2066 2799 Linux, and newer Windows guests are known to work fine. Windows 7 2067 guests are unable to boot with the VirtualBox EFI implementation. 2800 guests are unable to boot with the &product-name; EFI 2801 implementation. 2068 2802 </para> 2069 2803 … … 2076 2810 Protocol) and UGA (Universal Graphics Adapter). Modern operating 2077 2811 systems, such as Mac OS X, generally use GOP, while some older 2078 ones still use UGA. VirtualBox provides a configuration option2079 to control the graphics resolution for both interfaces, making2080 the difference mostly irrelevant for users.2812 ones still use UGA. &product-name; provides a configuration 2813 option to control the graphics resolution for both interfaces, 2814 making the difference mostly irrelevant for users. 2081 2815 </para> 2082 2816 … … 2084 2818 The default resolution is 1024x768. To select a graphics 2085 2819 resolution for EFI, use the following 2086 <com puteroutput>VBoxManage</computeroutput> command:2820 <command>VBoxManage</command> command: 2087 2821 </para> 2088 2822 … … 2473 3207 If this list of default resolution does not cover your needs, 2474 3208 see <xref linkend="customvesa" />. Note that the color depth 2475 value specified in a custom video mode must be specified (8, 16,2476 24 and 32 are accepted), but it is silently assumed to be 32 by2477 EFI.3209 value specified in a custom video mode must be specified. Color 3210 depths of 8, 16, 24, and 32 are accepted. EFI assumes a color 3211 depth of 32 by default. 2478 3212 </para> 2479 3213 … … 2496 3230 "VBoxInternal2/EfiBootArgs" extradata can be passed to a VM in 2497 3231 order to set the "boot-args" variable. To change the "boot-args" 2498 EFI variable: 3232 EFI variable, use the following command: 3233 </para> 2499 3234 2500 3235 <screen>VBoxManage setextradata "VM name" VBoxInternal2/EfiBootArgs <value></screen> 2501 </para>2502 3236 2503 3237 </sect2> -
trunk/doc/manual/en_US/user_ChangeLog.xml
r73276 r76078 5 5 %all.entities; 6 6 ]> 7 <chapter id="ChangeLog"> 7 8 8 <chapter id="ChangeLog">9 9 <title>Change Log</title> 10 10 11 <para>This section summarizes the changes between VirtualBox versions. Note 12 that this change log is not exhaustive and not all changes are listed.</para> 11 <para> 12 This section summarizes the changes between VirtualBox versions. 13 Note that this change log is not exhaustive and not all changes are 14 listed. 15 </para> 13 16 14 <para>VirtualBox version numbers consist of three numbers separated by dots 15 where the first and second number represent the major version and the 3rd number 16 the minor version. Minor version numbers of official releases are always even. 17 An odd minor version number represents an internal development or test build. 18 In addition, each build contains a revision number.</para> 17 <para> 18 VirtualBox version numbers consist of three numbers separated by 19 dots where the first and second number represent the major version 20 and the third number the minor version. Minor version numbers of 21 official releases are always even. An odd minor version number 22 represents an internal development or test build. In addition, each 23 build contains a revision number. 24 </para> 19 25 20 26 <xi:include href="user_ChangeLogImpl.xml" xpointer="xpointer(/chapter/*)" … … 22 28 23 29 <sect1 id="change-log-older"> 24 <title>Older Change Log Details</title> 25 <para>With VirtualBox 5.0, changelog information for versions before 4.3 26 was removed in order to save space. To access this information, please 27 consult the User Manual of VirtualBox version 4.3 or earlier.</para> 30 31 <title>Change Logs for Legacy Versions</title> 32 33 <para> 34 To view the change log for a legacy version of VirtualBox see the 35 documentation for the relevant VirtualBox release. 36 </para> 37 38 <para> 39 Change logs are also available at: 40 </para> 41 42 <para> 43 <ulink url="https://www.virtualbox.org/wiki/Changelog">https://www.virtualbox.org/wiki/Changelog</ulink>. 44 </para> 45 28 46 </sect1> 29 47 -
trunk/doc/manual/en_US/user_Frontends.xml
r73276 r76078 14 14 15 15 <para> 16 VirtualBox can display virtual machines remotely, meaning that a17 virtual machine can execute on one computer even though the16 &product-name; can display virtual machines remotely, meaning that 17 a virtual machine can execute on one computer even though the 18 18 machine will be displayed on a second computer, and the machine 19 19 will be controlled from there as well, as if the virtual machine … … 22 22 23 23 <para> 24 For maximum flexibility, starting with VirtualBox 4.0, VirtualBox 25 implements remote machine display through a generic extension 26 interface, the VirtualBox Remote Desktop Extension (VRDE). The 27 base open source VirtualBox package only provides this interface, 28 while implementations can be supplied by third parties with 29 VirtualBox extension packages, which must be installed separately 30 from the base package. See 31 <xref 32 linkend="intro-installing" />. 24 For maximum flexibility, &product-name; implements remote machine 25 display through a generic extension interface called the 26 VirtualBox Remote Desktop Extension (VRDE). The base open source 27 &product-name; package only provides this interface, while 28 implementations can be supplied by third parties with 29 &product-name; extension packages, which must be installed 30 separately from the base package. See 31 <xref linkend="intro-installing" />. 33 32 </para> 34 33 35 34 <para> 36 35 Oracle provides support for the VirtualBox Remote Display Protocol 37 (VRDP) in such a VirtualBox extension package. When this package38 is installed, VirtualBox versions 4.0 and later support VRDP the39 s ame way as binary (non-open source) versions of VirtualBox before40 4.0 did.36 (VRDP) in such an &product-name; extension package. When this 37 package is installed, &product-name; versions 4.0 and later 38 support VRDP the same way as binary, non-open source, versions of 39 &product-name; before 4.0 did. 41 40 </para> 42 41 … … 50 49 Even when the extension is installed, the VRDP server is disabled 51 50 by default. It can easily be enabled on a per-VM basis either in 52 the VirtualBox Manager in the Display settings, see53 < xref54 linkend="settings-display" />, or with55 <com puteroutput>VBoxManage</computeroutput>:51 the VirtualBox Manager in the 52 <emphasis role="bold">Display</emphasis> settings, see 53 <xref linkend="settings-display" />, or with the 54 <command>VBoxManage</command> command, as follows: 56 55 </para> 57 56 … … 70 69 71 70 <para> 72 The port can be changed either in the Display settings of the 73 graphical user interface or with 74 <computeroutput>--vrdeport</computeroutput> option of the 75 <computeroutput>VBoxManage modifyvm</computeroutput> command. You 76 can specify a comma-separated list of ports or ranges of ports. 77 Use a dash between two port numbers to specify a range. The VRDP 78 server will bind to <emphasis>one</emphasis> of the available 79 ports from the specified list. For example, 80 <computeroutput>VBoxManage modifyvm "VM name" --vrdeport 81 5000,5010-5012</computeroutput> will configure the server to bind 82 to one of the ports 5000, 5010, 5011, or 5012. See 83 <xref 84 linkend="vboxmanage-modifyvm-vrde" />. 71 The port can be changed either in the 72 <emphasis role="bold">Display</emphasis> settings of the graphical 73 user interface or with the <option>--vrdeport</option> option of 74 the <command>VBoxManage modifyvm</command> command. You can 75 specify a comma-separated list of ports or ranges of ports. Use a 76 dash between two port numbers to specify a range. The VRDP server 77 will bind to <emphasis>one</emphasis> of the available ports from 78 the specified list. For example, <computeroutput>VBoxManage 79 modifyvm "VM name" --vrdeport 5000,5010-5012</computeroutput> will 80 configure the server to bind to one of the ports 5000, 5010, 5011, 81 or 5012. See <xref linkend="vboxmanage-modifyvm-vrde" />. 85 82 </para> 86 83 87 84 <para> 88 85 The actual port used by a running VM can be either queried with 89 the <computeroutput>VBoxManage showvminfo</computeroutput> command 90 or seen in the GUI on the Runtime tab of the Session Information 91 dialog, which is accessible via the Machine menu of the VM window. 92 </para> 93 94 <para> 95 Support for IPv6 has been implemented in VirtualBox 4.3. If the 96 host OS supports IPv6 the VRDP server will automatically listen 97 for IPv6 connections in addition to IPv4. 86 the <command>VBoxManage showvminfo</command> command or seen in 87 the GUI on the <emphasis role="bold">Runtime</emphasis> tab of the 88 <emphasis role="bold">Session Information</emphasis> dialog, which 89 is accessible from the <emphasis role="bold">Machine</emphasis> 90 menu of the VM window. 91 </para> 92 93 <para> 94 Support for IPv6 has been implemented in &product-name; 4.3. If 95 the host OS supports IPv6 the VRDP server will automatically 96 listen for IPv6 connections in addition to IPv4. 98 97 </para> 99 98 … … 120 119 <para> 121 120 On Windows, you can use the Microsoft Terminal Services 122 Connector, <computeroutput>mstsc.exe</computeroutput>, that 123 is included with Windows. Press the 124 <emphasis role="bold">Windows key + R</emphasis>, to display 125 the Run dialog. Enter <command>mstsc</command> to start the 126 program. You can also find the program in 127 <emphasis role="bold">Start</emphasis>, 121 Connector, <command>mstsc.exe</command>, that is included 122 with Windows. Press the Windows key + R, to display the 123 <emphasis role="bold">Run</emphasis> dialog. Enter 124 <command>mstsc</command> to start the program. You can also 125 find the program in <emphasis role="bold">Start</emphasis>, 128 126 <emphasis role="bold">All Programs</emphasis>, 129 127 <emphasis role="bold">Accessories</emphasis>, 130 128 <emphasis role="bold">Remote Desktop Connection</emphasis>. 131 If you use the Run dialog, you can type in options directly.132 For example:129 If you use the <emphasis role="bold">Run</emphasis> dialog, 130 you can enter options directly. For example: 133 131 </para> 134 132 … … 158 156 <computeroutput>localhost</computeroutput> and 159 157 <computeroutput>127.0.0.1</computeroutput> might not 160 work using <com puteroutput>mstsc.exe</computeroutput>.161 Instead, theaddress158 work using <command>mstsc.exe</command>. Instead, the 159 address 162 160 <computeroutput>127.0.0.2[:3389]</computeroutput> has 163 161 to be used. … … 172 170 <para> 173 171 On other systems, you can use the standard open source 174 <com puteroutput>rdesktop</computeroutput> program. This175 ships with most Linux distributions, but VirtualBox also176 comes with a modified variant of rdesktop for remote USB177 support. See <xref178 linkend="usb-over-rdp" />.179 </para> 180 181 <para>182 With rdesktop, use a command line such asthe following:172 <command>rdesktop</command> program. This ships with most 173 Linux distributions, but &product-name; also comes with a 174 modified variant of <command>rdesktop</command> for remote 175 USB support. See <xref linkend="usb-over-rdp" />. 176 </para> 177 178 <para> 179 With <command>rdesktop</command>, use a command line such as 180 the following: 183 181 </para> 184 182 … … 200 198 <listitem> 201 199 <para> 200 The Remmina remote desktop client can be used with VRDP. 201 This application is included with some Linux distributions, 202 such as Debian and Ubuntu. 203 </para> 204 </listitem> 205 206 <listitem> 207 <para> 202 208 If you run the KDE desktop, you can use 203 209 <computeroutput>krdc</computeroutput>, the KDE RDP viewer. A … … 218 224 <para> 219 225 With Sun Ray thin clients you can use 220 <com puteroutput>uttsc</computeroutput>, which is part of the221 Sun Ray Windows Connector package. See the Sun Ray222 d ocumentation for details.226 <command>uttsc</command>, which is part of the Sun Ray 227 Windows Connector package. See the Sun Ray documentation for 228 details. 223 229 </para> 224 230 </listitem> … … 240 246 all your VMs are supposed to run remotely over VRDP, then it is 241 247 pointless to have a graphical user interface on the server at 242 all. This is especially true for Linux or Solaris hosts, as the243 VirtualBox manager comes with dependencies on the Qt and SDL244 libraries. This is inconvenient if you would rather not have the245 X Window system on your server at all.246 </para> 247 248 <para> 249 VirtualBoxtherefore comes with a front-end called248 all. This is especially true for Linux or Oracle Solaris hosts, 249 as the VirtualBox Manager comes with dependencies on the Qt and 250 SDL libraries. This is inconvenient if you would rather not have 251 the X Window system on your server at all. 252 </para> 253 254 <para> 255 &product-name; therefore comes with a front-end called 250 256 <computeroutput>VBoxHeadless</computeroutput>, which produces no 251 257 visible output on the host at all, but still can deliver VRDP 252 258 data. This front-end has no dependencies on the X Window system 253 on Linux and Solaris hosts. 254 255 <footnote> 256 257 <para> 258 Before VirtualBox 1.6, the headless server was called 259 <computeroutput>VBoxVRDP</computeroutput>. For the sake of 260 backwards compatibility, the VirtualBox installation still 261 installs an executable with that name as well. 262 </para> 263 264 </footnote> 265 </para> 259 on Linux and Oracle Solaris hosts. 260 </para> 261 262 <note> 263 <para> 264 Before &product-name; 1.6, the headless server was called 265 <computeroutput>VBoxVRDP</computeroutput>. For the sake of 266 backwards compatibility, the &product-name; installation still 267 installs an executable with that name as well. 268 </para> 269 </note> 266 270 267 271 <para> … … 275 279 <listitem> 276 280 <para> 277 Use the <computeroutput>VBoxManage</computeroutput> command, 278 as follows: 281 Use the <command>VBoxManage</command> command, as follows: 279 282 </para> 280 283 … … 283 286 <para> 284 287 The <computeroutput>--type</computeroutput> option causes 285 VirtualBoxto use288 &product-name; to use 286 289 <computeroutput>VBoxHeadless</computeroutput> as the 287 290 front-end to the internal virtualization engine, instead of … … 292 295 <listitem> 293 296 <para> 294 Use the <computeroutput>VBoxHeadless</computeroutput> 295 command, as follows: 297 Use the <command>VBoxHeadless</command> command, as follows: 296 298 </para> 297 299 … … 300 302 <para> 301 303 This way of starting the VM helps troubleshooting problems 302 reported by <com puteroutput>VBoxManage startvm303 </computeroutput>, because you can sometimes see more304 detailed error messages, especially for early failures305 before the VM execution is started. In normal situations306 <computeroutput>VBoxManage startvm</computeroutput> is307 preferred, since it runs the VM directly as a background308 process which has to be done explicitly when directly309 starting<computeroutput>VBoxHeadless</computeroutput>.304 reported by <command>VBoxManage startvm</command>, because 305 you can sometimes see more detailed error messages, 306 especially for early failures before the VM execution is 307 started. In normal situations <command>VBoxManage 308 startvm</command> is preferred, since it runs the VM 309 directly as a background process which has to be done 310 explicitly when directly starting with 311 <computeroutput>VBoxHeadless</computeroutput>. 310 312 </para> 311 313 </listitem> … … 314 316 <para> 315 317 Start <computeroutput>VBoxHeadless</computeroutput> from the 316 VirtualBox Manager GUI, by holding the Shift key when318 VirtualBox Manager GUI, by pressing the Shift key when 317 319 starting a virtual machine or by selecting 318 320 <emphasis role="bold">Headless Start</emphasis> from the … … 324 326 325 327 <para> 326 Since VirtualBox version 5.0, when you use 327 <computeroutput>VBoxHeadless</computeroutput> to start a VM, the 328 VRDP server will be enabled according to the VM configuration. 329 You can override the VM's setting using 328 When you use the <computeroutput>VBoxHeadless</computeroutput> 329 command to start a VM, the VRDP server will be enabled according 330 to the VM configuration. You can override the VM's setting using 330 331 <computeroutput>--vrde</computeroutput> command line parameter. 331 To enable the VRDP server start the VM like this: 332 To enable the VRDP server, start the VM as follows: 333 </para> 332 334 333 335 <screen>VBoxHeadless --startvm <uuid|name> --vrde on</screen> 334 336 337 <para> 335 338 To disable the VRDP server: 339 </para> 336 340 337 341 <screen>VBoxHeadless --startvm <uuid|name> --vrde off</screen> 338 342 343 <para> 339 344 To have the VRDP server enabled depending on the VM 340 configuration, as the other front-ends would, you can use: 345 configuration, as for other front-ends: 346 </para> 341 347 342 348 <screen>VBoxHeadless --startvm <uuid|name> --vrde config</screen> 343 349 344 This command is the same as: 350 <para> 351 This command is the same as the following: 352 </para> 345 353 346 354 <screen>VBoxHeadless --startvm <uuid|name></screen> 347 </para> 348 349 <para> 350 If you start the VM with <computeroutput>VBoxManage 351 startvm</computeroutput> then the configuration settings of the 352 VM are always used. 355 356 <para> 357 If you start the VM with <command>VBoxManage startvm</command> 358 then the configuration settings of the VM are always used. 353 359 </para> 354 360 … … 372 378 <listitem> 373 379 <para> 374 VirtualBoxon a server machine with a supported host375 operating system. The VirtualBox extension pack for the VRDP376 server must be installed, see <xref linkend="vrde"/>. The377 procedures assume a Linux server is used.380 &product-name; on a server machine with a supported host 381 operating system. The &product-name; Extension Pack for the 382 VRDP server must be installed, see <xref linkend="vrde"/>. 383 The procedures assume a Linux server is used. 378 384 </para> 379 385 </listitem> … … 407 413 <para> 408 414 Note that on the server machine, since we will only use the 409 headless server, Qt, SDL, and the X Window system are not 410 required. 415 headless server, Qt and the X Window system are not required. 411 416 </para> 412 417 … … 424 429 If you do not specify 425 430 <computeroutput>--register</computeroutput>, you will have 426 to manually use the 427 <computeroutput>registervm</computeroutput> commandlater.431 to manually use the <command>registervm</command> command 432 later. 428 433 </para> 429 434 … … 500 505 <para> 501 506 Start the virtual machine using the 502 <com puteroutput>VBoxHeadless</computeroutput> command:507 <command>VBoxHeadless</command> command: 503 508 </para> 504 509 … … 534 539 535 540 <para> 536 As a special feature additional to the VRDP support, VirtualBox537 also supports remote USB devices over the wire. That is, the538 VirtualBox guest that runs on one computer can access the USB539 devices of the remote computer on which the VRDP data is being540 d isplayed the same way as USB devices that are connected to the541 actual host. This allows for running virtual machines on a542 VirtualBox host that acts as a server, where a client can543 connect from elsewhere that needs only a network adapter and a544 display capable of running an RDP viewer. When USB devices are545 plugged into the client, the remote VirtualBox server can access546 them.541 As a special feature additional to the VRDP support, 542 &product-name; also supports remote USB devices over the wire. 543 That is, an &product-name; guest that runs on one computer can 544 access the USB devices of the remote computer on which the VRDP 545 data is being displayed the same way as USB devices that are 546 connected to the actual host. This enables running of virtual 547 machines on an &product-name; host that acts as a server, where 548 a client can connect from elsewhere that needs only a network 549 adapter and a display capable of running an RDP viewer. When USB 550 devices are plugged into the client, the remote &product-name; 551 server can access them. 547 552 </para> 548 553 … … 556 561 <para> 557 562 Accessing remote USB devices is only possible if the RDP client 558 supports this extension. On Linux and Solaris hosts, the559 VirtualBox installation provides a suitable VRDP client called560 <computeroutput>rdesktop-vrdp</computeroutput>. Recent versions561 of <computeroutput>uttsc</computeroutput>, a client tailored for562 the use with Sun Ray thin clients, also support accessing remote563 USB devices. RDP clients for other platforms will be provided in564 future VirtualBoxversions.563 supports this extension. On Linux and Oracle Solaris hosts, the 564 &product-name; installation provides a suitable VRDP client 565 called <command>rdesktop-vrdp</command>. Recent versions of 566 <command>uttsc</command>, a client tailored for the use with Sun 567 Ray thin clients, also support accessing remote USB devices. RDP 568 clients for other platforms will be provided in future 569 &product-name; versions. 565 570 </para> 566 571 567 572 <para> 568 573 To make a remote USB device available to a VM, 569 <com puteroutput>rdesktop-vrdp</computeroutput> should be started570 as follows:574 <command>rdesktop-vrdp</command> should be started as follows: 575 </para> 571 576 572 577 <screen>rdesktop-vrdp -r usb -a 16 -N my.host.address</screen> 573 578 574 Please refer to <xref linkend="ts_usb-linux" /> for further 575 details on how to properly set up the permissions for USB 576 devices. Furthermore it is advisable to disable automatic 577 loading of any host driver on the remote host which might work 578 on USB devices to ensure that the devices are accessible by the 579 RDP client. If the setup was properly done on the remote host, 580 plug/unplug events are visible on the VBox.log file of the VM. 579 <para> 580 See <xref linkend="ts_usb-linux" /> for further details on how 581 to properly set up the permissions for USB devices. Furthermore 582 it is advisable to disable automatic loading of any host driver 583 on the remote host which might work on USB devices to ensure 584 that the devices are accessible by the RDP client. If the setup 585 was properly done on the remote host, plug and unplug events are 586 visible in the VBox.log file of the VM. 581 587 </para> 582 588 … … 588 594 589 595 <para> 590 For each virtual machine that is remotely accessible viaRDP,596 For each virtual machine that is remotely accessible using RDP, 591 597 you can individually determine if and how client connections are 592 authenticated. For this, use <computeroutput>VBoxManage 593 modifyvm</computeroutput> command with the 594 <computeroutput>--vrdeauthtype</computeroutput> option. See 595 <xref 596 linkend="vboxmanage-modifyvm" />. The following 597 methods of authentication are available: 598 authenticated. For this, use the <command>VBoxManage 599 modifyvm</command> command with the 600 <option>--vrdeauthtype</option> option. See 601 <xref linkend="vboxmanage-modifyvm" />. The following methods of 602 authentication are available: 598 603 </para> 599 604 … … 613 618 The <emphasis role="bold">external</emphasis> method 614 619 provides external authentication through a special 615 authentication library. VirtualBox ships with two special616 authentication libraries:620 authentication library. &product-name; ships with two 621 special authentication libraries: 617 622 </para> 618 623 … … 652 657 authenticates users against the host's directory 653 658 service. 654 655 <footnote>656 657 <para>658 Support for Mac OS X was added in version 3.2.659 </para>660 661 </footnote>662 659 </para> 663 660 </listitem> … … 718 715 <computeroutput>extradata</computeroutput> section 719 716 the password needs to be written, is a plain text 720 file, VirtualBox uses hashes to encrypt passwords.721 The following command must be used:717 file, &product-name; uses hashes to encrypt 718 passwords. The following command must be used: 722 719 </para> 723 720 … … 746 743 747 744 <para> 748 You then use VBoxManage setextradata to store this 749 value in the machine's 750 <computeroutput>extradata</computeroutput> section. 745 You then use <command>VBoxManage 746 setextradata</command> to store this value in the 747 machine's <computeroutput>extradata</computeroutput> 748 section. 751 749 </para> 752 750 … … 789 787 In addition to the methods described above, you can replace the 790 788 default external authentication module with any other module. 791 For this, VirtualBox provides a well-defined interface that 792 allows you to write your own authentication module. This is 793 described in detail in the VirtualBox Software Development Kit 794 (SDK) reference. See <xref 795 linkend="VirtualBoxAPI" />. 789 For this, &product-name; provides a well-defined interface that 790 enables you to write your own authentication module. This is 791 described in detail in the &product-name; Software Development 792 Kit (SDK) reference. See <xref linkend="VirtualBoxAPI" />. 796 793 </para> 797 794 … … 820 817 perform any checks in order to verify the identity of the 821 818 server it connects to. Since user credentials can be 822 obtained using a "man in the middle"(MITM) attack, RDP4819 obtained using a man in the middle (MITM) attack, RDP4 823 820 authentication is insecure and should generally not be used. 824 821 </para> … … 875 872 Security is accepted. The client must support TLS. 876 873 </para> 874 875 <para> 876 The OpenSSL library version determines which versions of 877 TLS are supported. The &product-name; clients include at 878 least Version 1.1.0 of the OpenSSL library. This library 879 supports TLS versions 1.0, 1.1, and 1.2. Some clients 880 might include newer versions of the OpenSSL library and 881 thus support additional TLS versions. 882 </para> 877 883 </listitem> 878 884 … … 880 886 881 887 <para> 882 For example, the following command allows a client to use888 For example, the following command enables a client to use 883 889 either Standard or Enhanced RDP Security connection: 884 890 </para> … … 946 952 <para> 947 953 As the client that connects to the server determines what type 948 of encryption will be used, with rdesktop, the Linux RDP viewer, 949 use the <computeroutput>-4</computeroutput> or 954 of encryption will be used, with <command>rdesktop</command>, 955 the Linux RDP viewer, use the 956 <computeroutput>-4</computeroutput> or 950 957 <computeroutput>-5</computeroutput> options. 951 958 </para> … … 958 965 959 966 <para> 960 The VRDP server of VirtualBoxsupports multiple simultaneous967 The VRDP server of &product-name; supports multiple simultaneous 961 968 connections to the same running VM from different clients. All 962 969 connected clients see the same screen output and share a mouse … … 968 975 <para> 969 976 The following command enables multiple connection mode: 977 </para> 970 978 971 979 <screen>VBoxManage modifyvm "VM name" --vrdemulticon on</screen> 972 </para>973 980 974 981 </sect2> … … 981 988 To access two or more remote VM displays you have to enable the 982 989 VRDP multiconnection mode. See 983 <xref 984 linkend="vrde-multiconnection" />. 990 <xref linkend="vrde-multiconnection"/>. 985 991 </para> 986 992 987 993 <para> 988 994 The RDP client can select the virtual monitor number to connect 989 to using the <computeroutput>domain</computeroutput> log on995 to using the <computeroutput>domain</computeroutput> login 990 996 parameter (<computeroutput>-d</computeroutput>). If the 991 997 parameter ends with <computeroutput>@</computeroutput> followed 992 by a number, VirtualBoxinterprets this number as the screen998 by a number, &product-name; interprets this number as the screen 993 999 index. The primary guest screen is selected with 994 1000 <computeroutput>@1</computeroutput>, the first secondary screen … … 998 1004 <para> 999 1005 The Microsoft RDP6 client does not let you specify a separate 1000 domain name. Instead, use1006 domain name. Instead, enter 1001 1007 <computeroutput>domain\username</computeroutput> in the 1002 < computeroutput>Username:</computeroutput> field. For example,1008 <emphasis role="bold">Username</emphasis> field. For example, 1003 1009 <computeroutput>@2\name</computeroutput>. 1004 1010 <computeroutput>name</computeroutput> must be supplied, and must … … 1015 1021 1016 1022 <para> 1017 Starting with VirtualBox 3.2, the VRDP server can redirect video 1018 streams from the guest to the RDP client. Video frames are 1019 compressed using the JPEG algorithm allowing a higher 1020 compression ratio than standard RDP bitmap compression methods. 1021 It is possible to increase the compression ratio by lowering the 1022 video quality. 1023 The VRDP server can redirect video streams from the guest to the 1024 RDP client. Video frames are compressed using the JPEG algorithm 1025 allowing a higher compression ratio than standard RDP bitmap 1026 compression methods. It is possible to increase the compression 1027 ratio by lowering the video quality. 1023 1028 </para> 1024 1029 … … 1040 1045 <para> 1041 1046 The following command enables video redirection: 1047 </para> 1042 1048 1043 1049 <screen>VBoxManage modifyvm "VM name" --vrdevideochannel on</screen> 1044 </para>1045 1050 1046 1051 <para> … … 1049 1054 numbers mean lower quality but higher compression. The quality 1050 1055 can be changed using the following command: 1056 </para> 1051 1057 1052 1058 <screen>VBoxManage modifyvm "VM name" --vrdevideochannelquality 75</screen> 1053 </para>1054 1059 1055 1060 </sect2> … … 1060 1065 1061 1066 <para> 1062 With VirtualBox 4.0it is possible to disable display output,1067 With &product-name; it is possible to disable display output, 1063 1068 mouse and keyboard input, audio, remote USB, or clipboard 1064 1069 individually in the VRDP server. … … 1066 1071 1067 1072 <para> 1068 The following commands change corresponding server settings:1073 The following commands change the corresponding server settings: 1069 1074 </para> 1070 1075 … … 1077 1082 1078 1083 <para> 1079 To reenable a feature use a similar command without the trailing 1080 1. For example: 1084 To reenable a feature, use a similar command without the 1085 trailing 1. For example: 1086 </para> 1081 1087 1082 1088 <screen>VBoxManage modifyvm "VM name" --vrdeproperty Client/DisableDisplay=</screen> 1083 </para>1084 1085 <para>1086 These properties were introduced with VirtualBox 3.2.10.1087 However, in the 3.2.x series, it was necessary to use the1088 following commands to alter these settings instead:1089 </para>1090 1091 <screen>VBoxManage setextradata "VM name" "VRDP/Feature/Client/DisableDisplay" 11092 VBoxManage setextradata "VM name" "VRDP/Feature/Client/DisableInput" 11093 VBoxManage setextradata "VM name" "VRDP/Feature/Client/DisableUSB" 11094 VBoxManage setextradata "VM name" "VRDP/Feature/Client/DisableAudio" 11095 VBoxManage setextradata "VM name" "VRDP/Feature/Client/DisableClipboard" 1</screen>1096 1097 <para>1098 To reenable a feature use a similar command without the trailing1099 1. For example:1100 1101 <screen>VBoxManage setextradata "VM name" "VRDP/Feature/Client/DisableDisplay"</screen>1102 </para>1103 1089 1104 1090 </sect2> … … 1111 1097 1112 1098 <para> 1113 Starting with version 3.1, VirtualBox supports1114 <emphasis>teleporting</emphasis>. Teleporting is moving a virtual1115 machine over a network from one VirtualBox host to another, while1116 the virtual machine is running. This works regardless of the host1117 operating system that is running on the hosts. You can teleport1118 virtual machines betweenSolaris and Mac hosts, for example.1099 &product-name; supports <emphasis>teleporting</emphasis>. 1100 Teleporting is moving a virtual machine over a network from one 1101 &product-name; host to another, while the virtual machine is 1102 running. This works regardless of the host operating system that 1103 is running on the hosts. You can teleport virtual machines between 1104 Oracle Solaris and Mac hosts, for example. 1119 1105 </para> 1120 1106 … … 1145 1131 <para> 1146 1132 On the target host, you must configure a virtual machine in 1147 VirtualBoxwith exactly the same hardware settings as the1133 &product-name; with exactly the same hardware settings as the 1148 1134 machine on the source that you want to teleport. This does not 1149 1135 apply to settings which are merely descriptive, such as the VM … … 1161 1147 CD/DVD images. This means that they either use the same iSCSI 1162 1148 targets or that the storage resides somewhere on the network 1163 and both hosts have access to it viaNFS or SMB/CIFS.1149 and both hosts have access to it using NFS or SMB/CIFS. 1164 1150 </para> 1165 1151 … … 1183 1169 machine to wait for a teleport request to arrive when it is 1184 1170 started, instead of actually attempting to start the machine. 1185 This is done with the following VBoxManage command: 1171 This is done with the following <command>VBoxManage</command> 1172 command: 1186 1173 </para> 1187 1174 … … 1194 1181 number to be used on both the source and the target hosts. For 1195 1182 example, use 6000. See 1196 <xref 1197 linkend="vboxmanage-modifyvm-teleport" />. 1183 <xref linkend="vboxmanage-modifyvm-teleport" />. 1198 1184 </para> 1199 1185 </listitem> … … 1218 1204 <para> 1219 1205 where <computeroutput><sourcevmname></computeroutput> is 1220 the name of the virtual machine on the source host (the1221 machine that is currently running),1206 the name of the virtual machine on the source host, which is 1207 the machine that is currently running. 1222 1208 <computeroutput><targethost></computeroutput> is the 1223 1209 host or IP name of the target host on which the machine is … … 1225 1211 <computeroutput><port></computeroutput> must be the same 1226 1212 number as specified in the command on the target host. See 1227 <xref 1228 linkend="vboxmanage-controlvm" />. 1213 <xref linkend="vboxmanage-controlvm" />. 1229 1214 </para> 1230 1215 </listitem> … … 1245 1230 application software that is highly optimized to run on a 1246 1231 particular CPU without correctly checking that certain CPU 1247 features are actually present. VirtualBoxfilters what CPU1232 features are actually present. &product-name; filters what CPU 1248 1233 capabilities are presented to the guest operating system. 1249 1234 Advanced users can attempt to restrict these virtual CPU 1250 capabilities with the <computeroutput>VBoxManage --modifyvm1235 capabilities with the <computeroutput>VBoxManage modifyvm 1251 1236 --cpuid</computeroutput> command. See 1252 <xref 1253 linkend="vboxmanage-modifyvm-teleport" />. 1237 <xref linkend="vboxmanage-modifyvm-teleport" />. 1254 1238 </para> 1255 1239 </note> -
trunk/doc/manual/en_US/user_Glossary.xml
r73276 r76078 18 18 Advanced Configuration and Power Interface, an industry 19 19 specification for BIOS and hardware extensions to configure PC 20 hardware and perform power management. Windows 2000 and higher21 as well as Linux 2.4 and higher support ACPI. Windows can only20 hardware and perform power management. Windows 2000 and later, 21 as well as Linux 2.4 and later support ACPI. Windows can only 22 22 enable or disable ACPI support at installation time. 23 23 </para> … … 77 77 systems also contain an I/O APIC (input output APIC) as a 78 78 separate chip which provides more than 16 IRQs. Windows 2000 79 and higher use a different kernel if they detect an I/O APIC80 during installation. Therefore an I/O APIC must not be removed81 after installation.79 and later use a different kernel if they detect an I/O APIC 80 during installation. Therefore, an I/O APIC must not be 81 removed after installation. 82 82 </para> 83 83 … … 115 115 personal computers which is responsible of initializing the 116 116 hardware after the computer has been turned on and then 117 booting an operating system. VirtualBoxships with its own117 booting an operating system. &product-name; ships with its own 118 118 virtual BIOS that runs when a virtual machine is started. 119 119 </para> … … 135 135 <para> 136 136 Microsoft Component Object Model, a programming infrastructure 137 for modular software. COM allows applications to provide137 for modular software. COM enables applications to provide 138 138 application programming interfaces which can be accessed from 139 139 various other programming languages and applications. 140 VirtualBoxmakes use of COM both internally and externally to140 &product-name; makes use of COM both internally and externally to 141 141 provide a comprehensive API to 3rd party developers. 142 142 </para> … … 157 157 158 158 <para> 159 Dynamic Host Configuration Protocol. This allows a networking159 Dynamic Host Configuration Protocol. This enables a networking 160 160 device in a network to acquire its IP address and other 161 161 networking details automatically, in order to avoid having to 162 162 configure all devices in a network with fixed IP addresses. 163 VirtualBoxhas a built-in DHCP server that delivers an IP163 &product-name; has a built-in DHCP server that delivers an IP 164 164 addresses to a virtual machine when networking is configured 165 165 to NAT. See <xref … … 219 219 <para> 220 220 Graphical User Interface. Commonly used as an antonym to a 221 "command line interface". In the context of VirtualBox, we221 "command line interface". In the context of &product-name;, we 222 222 sometimes refer to the main graphical 223 223 <computeroutput>VirtualBox</computeroutput> program as the 224 224 "GUI", to differentiate it from the 225 <com puteroutput>VBoxManage</computeroutput> interface.225 <command>VBoxManage</command> interface. 226 226 </para> 227 227 … … 316 316 As opposed to traditional pin-based interrupts, with MSI, a 317 317 small amount of data can accompany the actual interrupt 318 message. This reduces the amount of hardware pins required ,318 message. This reduces the amount of hardware pins required and 319 319 allows for more interrupts and better performance. 320 320 </para> … … 339 339 target IP addresses of network packets according to specific 340 340 rules. Commonly employed by routers and firewalls to shield an 341 internal network from the Internet, VirtualBoxcan use NAT to341 internal network from the Internet, &product-name; can use NAT to 342 342 easily share a host's physical networking hardware with its 343 343 virtual machines. See <xref … … 380 380 381 381 <para> 382 Physical Address Extension. This allows accessingmore than 4383 GB of RAM even in 32-bit environments. See382 Physical Address Extension. This enables access to more than 4 383 GB of RAM, even in 32-bit environments. See 384 384 <xref 385 385 linkend="settings-general-advanced" />. … … 435 435 transferred in both directions. Typically graphics updates and 436 436 audio are sent from the remote machine and keyboard and mouse 437 input events are sent from the client. A VirtualBoxextension437 input events are sent from the client. An &product-name; extension 438 438 package by Oracle provides VRDP, an enhanced implementation of 439 439 the relevant standards which is largely compatible with … … 535 535 A widely used file format for archiving. Originally, this 536 536 stood for Tape ARchive and was already supported by very early 537 U nixversions for backing up data on tape. The file format is537 UNIX versions for backing up data on tape. The file format is 538 538 still widely used today. For example, with OVF archives using 539 539 an <computeroutput>.ova</computeroutput> file extension. See … … 561 561 and letters which can be computed dynamically and is 562 562 guaranteed to be unique. Generally, it is used as a global 563 handle to identify entities. VirtualBoxmakes use of UUIDs to563 handle to identify entities. &product-name; makes use of UUIDs to 564 564 identify VMs, Virtual Disk Images (VDI files), and other 565 565 entities. … … 581 581 582 582 <para> 583 Virtual Machine. A virtual computer that VirtualBoxenables583 Virtual Machine. A virtual computer that &product-name; enables 584 584 you to run on top of your actual hardware. See 585 585 <xref … … 596 596 597 597 <para> 598 Virtual Machine Manager. The component of VirtualBoxthat598 Virtual Machine Manager. The component of &product-name; that 599 599 controls VM execution. See 600 600 <xref linkend="technical-components" /> for a list of 601 VirtualBoxcomponents.601 &product-name; components. 602 602 </para> 603 603 … … 612 612 <para> 613 613 VirtualBox Remote Desktop Extension. This interface is built 614 into VirtualBox to allow VirtualBoxextension packages to615 supply remote access to virtual machines. A VirtualBox614 into &product-name; to allow &product-name; extension packages to 615 supply remote access to virtual machines. An &product-name; 616 616 extension package by Oracle provides VRDP support. See 617 617 <xref linkend="vrde" />. … … 688 688 Mozilla Cross Platform Component Object Model, a programming 689 689 infrastructure developed by the Mozilla browser project which 690 is similar to Microsoft COM and allows applications to provide691 a modular programming interface. VirtualBox makes use of XPCOM692 o n Linux both internally and externally to provide a690 is similar to Microsoft COM and enables applications to 691 provide a modular programming interface. &product-name; makes use 692 of XPCOM on Linux both internally and externally to provide a 693 693 comprehensive API to third-party developers. 694 694 </para> -
trunk/doc/manual/en_US/user_GuestAdditions.xml
r75946 r76078 10 10 11 11 <para> 12 The previous chapter covered getting started with VirtualBoxand12 The previous chapter covered getting started with &product-name; and 13 13 installing operating systems in a virtual machine. For any serious 14 and interactive use, the VirtualBox Guest Additions will make your15 life much easier by providing closer integration between host and16 guest and improving the interactive performance of guest systems.17 This chapter describes the Guest Additions in detail.14 and interactive use, the &product-name; Guest Additions will make 15 your life much easier by providing closer integration between host 16 and guest and improving the interactive performance of guest 17 systems. This chapter describes the Guest Additions in detail. 18 18 </para> 19 19 … … 28 28 consist of device drivers and system applications that optimize 29 29 the guest operating system for better performance and usability. 30 See <xref 31 linkend="guestossupport" /> for details on what32 guest operating systems are fully supported with Guest Additions33 by VirtualBox.34 </para> 35 36 <para>37 The VirtualBox Guest Additions for all supported guest operating38 systems are provided as a single CD-ROM image file which is called39 <computeroutput>VBoxGuestAdditions.iso</computeroutput>. This40 image file is located in the installation directory of VirtualBox.41 To install the Guest Additions for a particular VM, you mount this42 ISO file in your VM as a virtual CD-ROM andinstall from there.30 See <xref linkend="guestossupport" /> for details on what guest 31 operating systems are fully supported with Guest Additions by 32 &product-name;. 33 </para> 34 35 <para> 36 The &product-name; Guest Additions for all supported guest 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. 43 43 </para> 44 44 … … 68 68 an easy way to exchange files between the host and the guest. 69 69 Much like ordinary Windows network shares, you can tell 70 VirtualBoxto treat a certain host directory as a shared71 folder, and VirtualBoxwill make it available to the guest70 &product-name; to treat a certain host directory as a shared 71 folder, and &product-name; will make it available to the guest 72 72 operating system as a network share, irrespective of whether 73 73 guest actually has a network. See … … 80 80 <para> 81 81 <emphasis role="bold">Better video support.</emphasis> While 82 the virtual graphics card which VirtualBox emulates for any83 guest operating system provides all the basic features, the84 custom video drivers that are installed with the Guest82 the virtual graphics card which &product-name; emulates for 83 any guest operating system provides all the basic features, 84 the custom video drivers that are installed with the Guest 85 85 Additions provide you with extra high and non-standard video 86 86 modes, as well as accelerated video performance. … … 88 88 89 89 <para> 90 In addition, with Windows, Linux, and Solaris guests, you can91 resize the virtual machine's window if the Guest Additions are92 installed. The video resolution in the guest will be93 automatically adjusted, as if you had manually entered an94 a rbitrary resolution in the guest's display settings. See95 < xref96 90 In addition, with Windows, Linux, and Oracle Solaris guests, 91 you can resize the virtual machine's window if the Guest 92 Additions are installed. The video resolution in the guest 93 will be automatically adjusted, as if you had manually entered 94 an arbitrary resolution in the guest's 95 <emphasis role="bold">Display</emphasis> settings. See 96 <xref linkend="intro-resize-window" />. 97 97 </para> 98 98 … … 100 100 If the Guest Additions are installed, 3D graphics and 2D video 101 101 for guest applications can be accelerated. See 102 <xref 103 linkend="guestadd-video" />. 102 <xref linkend="guestadd-video" />. 104 103 </para> 105 104 </listitem> … … 135 134 <para> 136 135 <emphasis role="bold">Time synchronization.</emphasis> With 137 the Guest Additions installed, VirtualBox can ensure that the138 guest's system time is better synchronized with that of the139 host.136 the Guest Additions installed, &product-name; can ensure that 137 the guest's system time is better synchronized with that of 138 the host. 140 139 </para> 141 140 … … 143 142 For various reasons, the time in the guest might run at a 144 143 slightly different rate than the time on the host. The host 145 could be receiving updates via NTP and its own time might not146 run linearly. A VM could also be paused, which stops the flow147 of time in the guest for a shorter or longer period of time.148 When the wall clock time between the guest and host only144 could be receiving updates through NTP and its own time might 145 not run linearly. A VM could also be paused, which stops the 146 flow of time in the guest for a shorter or longer period of 147 time. When the wall clock time between the guest and host only 149 148 differs slightly, the time synchronization service attempts to 150 149 gradually and smoothly adjust the guest time in small … … 173 172 <listitem> 174 173 <para> 175 <emphasis role="bold">Automated log ons.</emphasis> Also called174 <emphasis role="bold">Automated logins.</emphasis> Also called 176 175 credentials passing. See <xref linkend="autologon" />. 177 176 </para> … … 181 180 182 181 <para> 183 Each version of VirtualBox, even minor releases, ship with their 184 own version of the Guest Additions. While the interfaces through 185 which the VirtualBox core communicates with the Guest Additions 186 are kept stable so that Guest Additions already installed in a VM 187 should continue to work when VirtualBox is upgraded on the host, 188 for best results, it is recommended to keep the Guest Additions at 189 the same version. 190 </para> 191 192 <para> 193 Starting with VirtualBox 3.1, the Windows and Linux Guest 194 Additions therefore check automatically whether they have to be 195 updated. If the host is running a newer VirtualBox version than 196 the Guest Additions, a notification with further instructions is 197 displayed in the guest. 182 Each version of &product-name;, even minor releases, ship with 183 their own version of the Guest Additions. While the interfaces 184 through which the &product-name; core communicates with the Guest 185 Additions are kept stable so that Guest Additions already 186 installed in a VM should continue to work when &product-name; is 187 upgraded on the host, for best results, it is recommended to keep 188 the Guest Additions at the same version. 189 </para> 190 191 <para> 192 The Windows and Linux Guest Additions therefore check 193 automatically whether they have to be updated. If the host is 194 running a newer &product-name; version than the Guest Additions, a 195 notification with further instructions is displayed in the guest. 198 196 </para> 199 197 … … 215 213 <para> 216 214 Guest Additions are available for virtual machines running 217 Windows, Linux, Solaris, or OS/2. The following sections describe218 the specifics of each variant in detail.215 Windows, Linux, Oracle Solaris, or OS/2. The following sections 216 describe the specifics of each variant in detail. 219 217 </para> 220 218 … … 224 222 225 223 <para> 226 The VirtualBoxWindows Guest Additions are designed to be224 The &product-name; Windows Guest Additions are designed to be 227 225 installed in a virtual machine running a Windows operating 228 226 system. The following versions of Windows guests are supported: … … 298 296 299 297 <para> 300 In the Devices menu in the virtual machine's menu bar, 301 VirtualBox has a menu item <emphasis role="bold">Insert Guest 302 Additions CD Image</emphasis>, which mounts the Guest 303 Additions ISO file inside your virtual machine. A Windows 304 guest should then automatically start the Guest Additions 305 installer, which installs the Guest Additions into your 306 Windows guest. Other guest operating systems, or if automatic 307 start of software on CD is disabled, need a manual start of 298 In the <emphasis role="bold">Devices</emphasis> menu in the 299 virtual machine's menu bar, &product-name; has a menu item 300 <emphasis role="bold">Insert Guest Additions CD 301 Image</emphasis>, which mounts the Guest Additions ISO file 302 inside your virtual machine. A Windows guest should then 303 automatically start the Guest Additions installer, which 304 installs the Guest Additions on your Windows guest. 305 </para> 306 307 <para> 308 For other guest operating systems, or if automatic start of 309 software on a CD is disabled, you need to do a manual start of 308 310 the installer. 309 311 </para> … … 313 315 For the basic Direct3D acceleration to work in a Windows 314 316 guest, you have to install the WDDM video driver available 315 for Windows Vista or higher. 316 317 <footnote> 318 319 <para> 320 An experimental WDDM driver was added with VirtualBox 321 4.1. 322 </para> 323 324 </footnote> 325 326 For Windows 8 and higher only the WDDM Direct3D video driver 317 for Windows Vista or later. 318 </para> 319 320 <para> 321 For Windows 8 and later, only the WDDM Direct3D video driver 327 322 is available. For basic Direct3D acceleration to work in 328 323 Windows XP guests, you have to install the Guest Additions … … 349 344 <para> 350 345 Select <emphasis role="bold">Mount CD/DVD-ROM</emphasis> 351 from the Devices menu in the virtual machine's menu bar 352 and then <emphasis role="bold">CD/DVD-ROM 353 Image</emphasis>. This displays the Virtual Media Manager, 354 described in <xref 346 from the <emphasis role="bold">Devices</emphasis> menu in 347 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 355 351 linkend="vdis" />. 356 352 </para> … … 370 366 <listitem> 371 367 <para> 372 On a Windows host, this file is in the VirtualBox368 On a Windows host, this file is in the &product-name; 373 369 installation directory, usually in 374 370 <computeroutput>C:\Program … … 380 376 <para> 381 377 On Mac OS X hosts, this file is in the application 382 bundle of VirtualBox. Right-click on the VirtualBox 383 icon in Finder and choose <emphasis role="bold">Show 384 Package Contents</emphasis>. The file is located in 385 the <computeroutput>Contents/MacOS</computeroutput> 378 bundle of &product-name;. Right-click on the 379 &product-name; icon in Finder and choose 380 <emphasis role="bold">Show Package 381 Contents</emphasis>. The file is located in the 382 <computeroutput>Contents/MacOS</computeroutput> 386 383 folder. 387 384 </para> … … 392 389 On a Linux host, this file is in the 393 390 <computeroutput>additions</computeroutput> folder 394 where you installed VirtualBox, usually391 where you installed &product-name;, usually 395 392 <computeroutput>/opt/VirtualBox/</computeroutput>. 396 393 </para> … … 399 396 <listitem> 400 397 <para> 401 On Solaris hosts, this file is in the398 On Oracle Solaris hosts, this file is in the 402 399 <computeroutput>additions</computeroutput> folder 403 where you installed VirtualBox, usually400 where you installed &product-name;, usually 404 401 <computeroutput>/opt/VirtualBox</computeroutput>. 405 402 </para> … … 422 419 <para> 423 420 Unless you have the Autostart feature disabled in your Windows 424 guest, Windows will now autostart the VirtualBoxGuest421 guest, Windows will now autostart the &product-name; Guest 425 422 Additions installation program from the Additions ISO. If the 426 423 Autostart feature has been turned off, choose … … 468 465 <listitem> 469 466 <para> 470 VirtualBoxGraphics Adapter467 &product-name; Graphics Adapter 471 468 </para> 472 469 </listitem> … … 474 471 <listitem> 475 472 <para> 476 VirtualBoxSystem Device473 &product-name; System Device 477 474 </para> 478 475 </listitem> … … 493 490 494 491 <para> 495 As a prerequisite for avoid popups while performing an496 unattended installation of the VirtualBox Guest Additions, the497 c ode signing certificates used to sign the drivers needs to be498 installed in the right certificates stores in the guest499 system. Failing to do this will cause a typical windows500 installation to pop up a dialog asking whether its allowable501 to install eachdriver.492 To avoid popups when performing an unattended installation of 493 the &product-name; Guest Additions, the code signing 494 certificates used to sign the drivers needs to be installed in 495 the correct certificate stores on the guest operating system. 496 Failure to do this will cause a typical Windows installation 497 to display multiple dialogs asking whether you want to install 498 a particular driver. 502 499 </para> 503 500 504 501 <note> 505 502 <para> 506 On some Windows versions like Windows 2000 and Windows XP507 the user intervention popups mentioned above always will be503 On some Windows versions, such as Windows 2000 and Windows 504 XP, the user intervention popups mentioned above are always 508 505 displayed, even after importing the Oracle certificates. 509 506 </para> … … 511 508 512 509 <para> 513 Since VirtualBox 4.2, installing the code signing certificates 514 on a Windows guest can be done in an automated fashion using 515 the <computeroutput>VBoxCertUtil.exe</computeroutput> utility 516 found on the Guest Additions installation CD in the 517 <computeroutput>cert</computeroutput> folder: 510 Installing the code signing certificates on a Windows guest 511 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. 515 </para> 516 517 <para> 518 Use the following steps: 518 519 </para> 519 520 … … 528 529 <listitem> 529 530 <para> 530 Mount the VirtualBoxGuest Additions .ISO.531 Mount the &product-name; Guest Additions .ISO. 531 532 </para> 532 533 </listitem> … … 536 537 Open a command line window on the guest and change to the 537 538 <computeroutput>cert</computeroutput> folder on the 538 VirtualBoxGuest Additions CD.539 &product-name; Guest Additions CD. 539 540 </para> 540 541 </listitem> … … 557 558 558 559 <para> 559 Prior to VirtualBox 4.2 the code signing certificates need to 560 be imported in more manual style using the 561 <computeroutput>certutil.exe</computeroutput> utility, which 562 is shipped since Windows Vista. For Windows versions before 563 Vista you need to download and install 564 <computeroutput>certutil.exe</computeroutput> manually. Since 565 the certificates are not accompanied on the VirtualBox Guest 566 Additions CD-ROM prior to 4.2, these need to get extracted 567 from a signed VirtualBox executable first. 568 </para> 569 570 <para> 571 In the following examples the required certificates are 572 extracted from the VirtualBox Windows Guest Additions 573 installer on the CD-ROM. 574 </para> 575 576 <para> 577 For a VeriSign Code Signing CA certificate, do the following: 578 </para> 579 580 <orderedlist> 581 582 <listitem> 583 <para> 584 Open the Windows Explorer. 585 </para> 586 </listitem> 587 588 <listitem> 589 <para> 590 Right click on 591 VBoxWindowsAdditions-<replaceable>arch</replaceable>.exe, 592 and choose <emphasis role="bold">Properties</emphasis>. 593 </para> 594 </listitem> 595 596 <listitem> 597 <para> 598 Go to the Digital Signatures tab, choose 599 <emphasis role="bold">Oracle Corporation</emphasis> and 600 click on <emphasis role="bold">Details</emphasis>. 601 </para> 602 </listitem> 603 604 <listitem> 605 <para> 606 On the General tab, click on <emphasis role="bold">View 607 Certificate</emphasis>. 608 </para> 609 </listitem> 610 611 <listitem> 612 <para> 613 On the Certification Path tab, select 614 <emphasis role="bold">VeriSign Class 3 Public Primary 615 CA</emphasis>. 616 </para> 617 </listitem> 618 619 <listitem> 620 <para> 621 Click <emphasis role="bold">View Certificate</emphasis>. 622 </para> 623 </listitem> 624 625 <listitem> 626 <para> 627 On the Details tab, click <emphasis role="bold">Copy to 628 File</emphasis>. 629 </para> 630 </listitem> 631 632 <listitem> 633 <para> 634 In the displayed wizard choose <emphasis role="bold">DER 635 Encoded Binary X.509 (.CER)</emphasis> and save the 636 certificate file to a local path. Close the wizard. 637 </para> 638 </listitem> 639 640 <listitem> 641 <para> 642 Close the certificate dialog for Verisign Class 3 Code 643 Signing 2010 CA. 644 </para> 645 </listitem> 646 647 </orderedlist> 648 649 <para> 650 For an Oracle Corporation CA certificate, do the following: 651 </para> 652 653 <orderedlist> 654 655 <listitem> 656 <para> 657 Open the Windows Explorer. 658 </para> 659 </listitem> 660 661 <listitem> 662 <para> 663 Right-click on 664 VBoxWindowsAdditions-<replaceable>arch</replaceable>.exe 665 and choose <emphasis role="bold">Properties</emphasis>. 666 </para> 667 </listitem> 668 669 <listitem> 670 <para> 671 Go to the Digital Signatures tab, choose 672 <emphasis role="bold">Oracle Corporation</emphasis> and 673 click on <emphasis role="bold">Details</emphasis>. 674 </para> 675 </listitem> 676 677 <listitem> 678 <para> 679 On the General tab, click on <emphasis role="bold">View 680 Certificate</emphasis>. 681 </para> 682 </listitem> 683 684 <listitem> 685 <para> 686 On the Details tab, click on <emphasis role="bold">Copy to 687 File</emphasis>. 688 </para> 689 </listitem> 690 691 <listitem> 692 <para> 693 In the displayed wizard choose <emphasis role="bold">DER 694 Encoded Binary X.509 (.CER)</emphasis> and save the 695 certificate file to a local path. Close the wizard 696 </para> 697 </listitem> 698 699 <listitem> 700 <para> 701 Close the certificate dialog for Oracle Corporation. 702 </para> 703 </listitem> 704 705 </orderedlist> 706 707 <para> 708 After exporting the two certificates above they can be 709 imported into the certificate store using the 710 <computeroutput>certutil.exe</computeroutput> utility, as 711 follows: 712 </para> 713 714 <screen>certutil -addstore -f Root "<Path to 715 exported certificate file>"</screen> 716 717 <para> 718 In order to allow for completely unattended guest 719 installations, you can specify a command line parameter to the 720 install launcher: 560 To allow for completely unattended guest installations, you 561 can specify a command line parameter to the install launcher: 721 562 </para> 722 563 … … 725 566 <para> 726 567 This automatically installs the right files and drivers for 727 the corresponding platform, 32-bit or 64-bit.568 the corresponding platform, either 32-bit or 64-bit. 728 569 </para> 729 570 … … 760 601 <sect3 id="windows-guest-file-extraction"> 761 602 762 <title>Manual file Extraction</title>603 <title>Manual File Extraction</title> 763 604 764 605 <para> 765 606 If you would like to install the files and drivers manually, 766 607 you can extract the files from the Windows Guest Additions 767 setup as follows 608 setup as follows: 768 609 </para> 769 610 … … 790 631 791 632 <para> 792 Like the Windows Guest Additions, the VirtualBox Guest Additions 793 for Linux are a set of device drivers and system applications 794 which may be installed in the guest operating system. 633 Like the Windows Guest Additions, the &product-name; Guest 634 Additions for Linux are a set of device drivers and system 635 applications which may be installed in the guest operating 636 system. 795 637 </para> 796 638 … … 848 690 <para> 849 691 Note that some Linux distributions already come with all or part 850 of the VirtualBox Guest Additions. You may choose to keep the851 distribution's version of the Guest Additions but these are692 of the &product-name; Guest Additions. You may choose to keep 693 the distribution's version of the Guest Additions but these are 852 694 often not up to date and limited in functionality, so we 853 695 recommend replacing them with the Guest Additions that come with 854 VirtualBox. The VirtualBox Linux Guest Additions installer tries855 to detect existing installation and replace them but depending856 on how the distribution integrates the Guest Additions, this may857 require some manual interaction. It is highly recommended to858 take a snapshot of the virtual machine before replacing859 pre-installed Guest Additions.696 &product-name;. The &product-name; Linux Guest Additions 697 installer tries to detect an existing installation and replace 698 them but depending on how the distribution integrates the Guest 699 Additions, this may require some manual interaction. It is 700 highly recommended to take a snapshot of the virtual machine 701 before replacing preinstalled Guest Additions. 860 702 </para> 861 703 … … 865 707 866 708 <para> 867 The VirtualBox Guest Additions for Linux are provided on the868 same virtual CD-ROM file as the Guest Additions for Windows.869 See <xref linkend="mountingadditionsiso"/>. They also come870 with an installation program that guides you through the setup871 process. However, due to the significant differences between872 Linux distributions, installation may be slightly more complex873 when compared to Windows.709 The &product-name; Guest Additions for Linux are provided on 710 the same virtual CD-ROM file as the Guest Additions for 711 Windows. See <xref linkend="mountingadditionsiso"/>. They also 712 come with an installation program that guides you through the 713 setup process. However, due to the significant differences 714 between Linux distributions, installation may be slightly more 715 complex when compared to Windows. 874 716 </para> 875 717 … … 885 727 guest system for building external kernel modules. This 886 728 works as described in 887 <xref 888 linkend="externalkernelmodules" />, 889 except that this step must be performed in your Linux 729 <xref linkend="externalkernelmodules" />, except that this 730 step must be performed in your Linux 890 731 <emphasis>guest</emphasis> instead of on a Linux host 891 732 system. … … 907 748 file into your Linux guest's virtual CD-ROM drive, as 908 749 described for a Windows guest in 909 <xref 910 linkend="mountingadditionsiso" />. 750 <xref linkend="mountingadditionsiso" />. 911 751 </para> 912 752 </listitem> … … 930 770 931 771 <para> 932 In Linux and Solaris guests, VirtualBox graphics and mouse933 integration goes through the X Window System. VirtualBox can934 use the X.Org variant of the system, or XFree86 version 4.3935 which is identical to the first X.Org release. During the936 installation process, the X.Org display server will be set up937 to use the graphics and mouse drivers which come with the938 Guest Additions.772 In Linux and Oracle Solaris guests, &product-name; graphics 773 and mouse integration goes through the X Window System. 774 &product-name; can use the X.Org variant of the system, or 775 XFree86 version 4.3 which is identical to the first X.Org 776 release. During the installation process, the X.Org display 777 server will be set up to use the graphics and mouse drivers 778 which come with the Guest Additions. 939 779 </para> 940 780 941 781 <para> 942 782 After installing the Guest Additions into a fresh installation 943 of a supported Linux distribution or Solaris system, many944 unsupported systems will work correctly too, the guest's945 graphics mode will change to fit the size of the VirtualBox946 window on the host when it is resized. You can also ask the947 guest system to switch to a particular resolution by sending a948 video mode hint using the949 <com puteroutput>VBoxManage</computeroutput> tool.783 of a supported Linux distribution or Oracle Solaris system, 784 many unsupported systems will work correctly too, the guest's 785 graphics mode will change to fit the size of the 786 &product-name; window on the host when it is resized. You can 787 also ask the guest system to switch to a particular resolution 788 by sending a video mode hint using the 789 <command>VBoxManage</command> tool. 950 790 </para> 951 791 … … 988 828 virtual machine and wish to remove it without installing new 989 829 ones, you can do so by inserting the Guest Additions CD image 990 into the virtual CD-ROM drive as described above and running991 theinstaller for the current Guest Additions with the830 into the virtual CD-ROM drive as described above. Then run the 831 installer for the current Guest Additions with the 992 832 <computeroutput>uninstall</computeroutput> parameter from the 993 path that the CD image is mounted on in the guest: 833 path that the CD image is mounted on in the guest, as follows: 834 </para> 994 835 995 836 <screen>sh ./VBoxLinuxAdditions.run uninstall</screen> 996 </para>997 837 998 838 <para> … … 1006 846 1007 847 <para> 1008 Starting with version 3.1.0, you can uninstall the Additions 1009 as follows: 848 You can uninstall the Additions as follows: 1010 849 </para> 1011 850 … … 1024 863 <sect2 id="additions-solaris"> 1025 864 1026 <title>Guest Additions for Solaris</title> 1027 1028 <para> 1029 Like the Windows Guest Additions, the VirtualBox Guest Additions 1030 for Solaris take the form of a set of device drivers and system 1031 applications which may be installed in the guest operating 1032 system. 1033 </para> 1034 1035 <para> 1036 The following Solaris distributions are officially supported: 865 <title>Guest Additions for Oracle Solaris</title> 866 867 <para> 868 Like the Windows Guest Additions, the &product-name; Guest 869 Additions for Oracle Solaris take the form of a set of device 870 drivers and system applications which may be installed in the 871 guest operating system. 872 </para> 873 874 <para> 875 The following Oracle Solaris distributions are officially 876 supported: 1037 877 </para> 1038 878 … … 1041 881 <listitem> 1042 882 <para> 1043 Solaris 11, includingSolaris 11 Express1044 </para> 1045 </listitem> 1046 1047 <listitem> 1048 <para> 1049 Solaris 10 u5 and higher883 Oracle Solaris 11, including Oracle Solaris 11 Express 884 </para> 885 </listitem> 886 887 <listitem> 888 <para> 889 Oracle Solaris 10 4/08 and later 1050 890 </para> 1051 891 </listitem> … … 1060 900 <sect3 id="additions-solaris-install"> 1061 901 1062 <title>Installing the Solaris Guest Additions</title>1063 1064 <para> 1065 The VirtualBox Guest Additions for Solaris are provided on the1066 same ISO CD-ROM as the Additions for Windows and Linux. They1067 come with an installation program that guides you through the1068 setup process.902 <title>Installing the Oracle Solaris Guest Additions</title> 903 904 <para> 905 The &product-name; Guest Additions for Oracle Solaris are 906 provided on the same ISO CD-ROM as the Additions for Windows 907 and Linux. They come with an installation program that guides 908 you through the setup process. 1069 909 </para> 1070 910 … … 1079 919 Mount the 1080 920 <computeroutput>VBoxGuestAdditions.iso</computeroutput> 1081 file as your Solaris guest's virtual CD-ROM drive, exactly1082 the same way as described for a Windows guest in921 file as your Oracle Solaris guest's virtual CD-ROM drive, 922 exactly the same way as described for a Windows guest in 1083 923 <xref 1084 924 linkend="mountingadditionsiso" />. … … 1087 927 <para> 1088 928 If the CD-ROM drive on the guest does not get mounted, as 1089 seen with some versions of Solaris 10, run the following1090 command as root:929 seen with some versions of Oracle Solaris 10, run the 930 following command as root: 1091 931 </para> 1092 932 … … 1118 958 <sect3 id="additions-solaris-uninstall"> 1119 959 1120 <title>Uninstalling the Solaris Guest Additions</title> 1121 1122 <para> 1123 The Solaris Guest Additions can be safely removed by removing 1124 the package from the guest. Open a root terminal session and 1125 run the following command: 1126 </para> 1127 1128 <para> 960 <title>Uninstalling the Oracle Solaris Guest Additions</title> 961 962 <para> 963 The Oracle Solaris Guest Additions can be safely removed by 964 removing the package from the guest. Open a root terminal 965 session and run the following command: 966 </para> 967 1129 968 <screen>pkgrm SUNWvboxguest</screen> 1130 </para>1131 969 1132 970 </sect3> … … 1134 972 <sect3 id="additions-solaris-updating"> 1135 973 1136 <title>Updating the Solaris Guest Additions</title>974 <title>Updating the Oracle Solaris Guest Additions</title> 1137 975 1138 976 <para> … … 1152 990 1153 991 <para> 1154 VirtualBox also ships with a set of drivers that improve running 1155 OS/2 in a virtual machine. Due to restrictions of OS/2 itself, 1156 this variant of the Guest Additions has a limited feature set. 1157 See <xref 1158 linkend="KnownIssues" /> for details. 992 &product-name; also ships with a set of drivers that improve 993 running OS/2 in a virtual machine. Due to restrictions of OS/2 994 itself, this variant of the Guest Additions has a limited 995 feature set. See <xref 996 linkend="KnownIssues" /> for 997 details. 1159 998 </para> 1160 999 … … 1182 1021 1183 1022 <para> 1184 With the <emphasis>shared folders</emphasis> feature of VirtualBox, you 1185 can access files of your host system from within the guest system. This 1186 is similar how you would use network shares in Windows networks, except 1187 that shared folders do not require networking, only the Guest Additions. 1188 Shared Folders are supported with Windows 2000 or later, Linux, and 1189 Solaris guests. (There are also experimental support for Mac OS X and 1190 OS/2 guests shipping with VirtualBox 6.0.) 1191 </para> 1192 1193 <para> 1194 Shared folders physically reside on the <emphasis>host</emphasis> and are 1195 then shared with the guest, which uses a special file system driver in 1196 the Guest Addition to talk to the host. For Windows guests, shared 1197 folders are implemented as a pseudo-network redirector. For Linux and 1198 Solaris guests, the Guest Additions provide a virtual file system. 1199 </para> 1200 1201 <para> 1202 To share a host folder with a virtual machine in VirtualBox, you 1203 must specify the path of that folder and choose a <emphasis>share name</emphasis> 1204 for it. This happens on the host. In the guest you then uses the name 1205 connect to it and access the files. 1023 With the <emphasis>shared folders</emphasis> feature of 1024 &product-name;, you can access files of your host system from 1025 within the guest system. This is similar to how you would use 1026 network shares in Windows networks, except that shared folders do 1027 not require networking, only the Guest Additions. Shared folders 1028 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. 1031 </para> 1032 1033 <para> 1034 Shared folders physically reside on the <emphasis>host</emphasis> 1035 and are then shared with the guest, which uses a special file 1036 system driver in the Guest Additions to talk to the host. For 1037 Windows guests, shared folders are implemented as a pseudo-network 1038 redirector. For Linux and Oracle Solaris guests, the Guest 1039 Additions provide a virtual file system. 1040 </para> 1041 1042 <para> 1043 To share a host folder with a virtual machine in &product-name;, 1044 you must specify the path of the folder and choose a 1045 <emphasis>share name</emphasis> that the guest can use to access 1046 the shared folder. This happens on the host. In the guest you can 1047 then use the share name to connect to it and access files. 1206 1048 </para> 1207 1049 … … 1225 1067 <para> 1226 1068 If a VM is not currently running, you can configure shared 1227 folders in the virtual machine's Settings dialog. 1069 folders in the virtual machine's 1070 <emphasis role="bold">Settings</emphasis> dialog. 1228 1071 </para> 1229 1072 </listitem> … … 1232 1075 <para> 1233 1076 From the command line, you can create shared folders using 1234 VBoxManage, as follows:1077 <command>VBoxManage</command>, as follows: 1235 1078 </para> 1236 1079 … … 1248 1091 </para> 1249 1092 1250 < orderedlist>1093 <itemizedlist> 1251 1094 1252 1095 <listitem> 1253 1096 <para> 1254 Permanent shares that are saved with the VM settings.1097 Permanent shares, that are saved with the VM settings. 1255 1098 </para> 1256 1099 </listitem> … … 1258 1101 <listitem> 1259 1102 <para> 1260 Transient shares that are added at runtime and disappear when the VM 1261 is powered off. There is a checkbox for this in the GUI and 1262 VBoxManage has a <computeroutput>--transient</computeroutput> option 1263 for it. 1103 Transient shares, that are added at runtime and disappear when 1104 the VM is powered off. These can be created using a checkbox 1105 in the VirtualBox Manager, or by using the 1106 <computeroutput>--transient</computeroutput> option of the 1107 <command>VBoxManage sharedfolder add</command> command. 1264 1108 </para> 1265 1109 </listitem> 1266 1110 1267 </orderedlist> 1268 1269 <para> 1270 Shared folders can either be read-write or read-only, meaning the guest 1271 is either allowed to both read and write or just read files on the host. 1272 There is a checkbox for read-only in the GUI, default being read-write, 1273 and similarly a <computeroutput>--readonly</computeroutput> option for 1274 VBoxManage. 1275 </para> 1276 1277 <para> 1278 Starting with version 4.0, VirtualBox shared folders also support 1279 symbolic links (<emphasis>symlinks</emphasis>), under the 1280 following conditions: 1281 </para> 1282 1283 <orderedlist> 1111 </itemizedlist> 1112 1113 <para> 1114 Shared folders can either be read-write or read-only. This means 1115 that the guest is either allowed to both read and write, or just 1116 read files on the host. By default, shared folders are read-write. 1117 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. 1121 </para> 1122 1123 <para> 1124 &product-name; shared folders also support symbolic links, also 1125 called <emphasis>symlinks</emphasis>, under the following 1126 conditions: 1127 </para> 1128 1129 <itemizedlist> 1284 1130 1285 1131 <listitem> 1286 1132 <para> 1287 1133 The host operating system must support symlinks. For example, 1288 a Mac OS X, Linux, or Solaris host is required.1134 a Mac OS X, Linux, or Oracle Solaris host is required. 1289 1135 </para> 1290 1136 </listitem> … … 1292 1138 <listitem> 1293 1139 <para> 1294 Currently only Linux and Solaris Guest Additions support1295 s ymlinks.1140 Currently only Linux and Oracle Solaris Guest Additions 1141 support symlinks. 1296 1142 </para> 1297 1143 </listitem> … … 1308 1154 </listitem> 1309 1155 1310 </ orderedlist>1156 </itemizedlist> 1311 1157 1312 1158 <sect2 id="sf_mount_manual"> … … 1328 1174 and look for the folder in <emphasis role="bold">My 1329 1175 Networking Place</emphasis>s, <emphasis role="bold">Entire 1330 Network</emphasis>, <emphasis role="bold"> VirtualBox Shared1331 Folders</emphasis>. By right-clicking on a shared folder and1332 selecting <emphasis role="bold">Map Network Drive</emphasis>1333 from the menu that pops up, you can assign a drive letter to1334 that shared folder.1176 Network</emphasis>, <emphasis role="bold">&product-name; 1177 Shared Folders</emphasis>. By right-clicking on a shared 1178 folder and selecting <emphasis role="bold">Map Network 1179 Drive</emphasis> from the menu that pops up, you can assign 1180 a drive letter to that shared folder. 1335 1181 </para> 1336 1182 … … 1348 1194 the drive letter that you want to use for the share, and 1349 1195 <replaceable>sharename</replaceable> with the share name 1350 specified with <com puteroutput>VBoxManage</computeroutput>.1196 specified with <command>VBoxManage</command>. 1351 1197 </para> 1352 1198 </listitem> … … 1369 1215 <listitem> 1370 1216 <para> 1371 In a Solaris guest, use the following command:1217 In a Oracle Solaris guest, use the following command: 1372 1218 </para> 1373 1219 … … 1377 1223 Replace <replaceable>sharename</replaceable>, use a 1378 1224 lowercase string, with the share name specified with 1379 <com puteroutput>VBoxManage</computeroutput> or the GUI.1380 Replace <replaceable>mountpoint</replaceable> with the path1381 whereyou want the share to be mounted on the guest, such as1225 <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 1382 1228 <computeroutput>/mnt/share</computeroutput>. The usual mount 1383 1229 rules apply. For example, create this directory first if it … … 1387 1233 <para> 1388 1234 Here is an example of mounting the shared folder for the 1389 user jack on Solaris:1235 user jack on Oracle Solaris: 1390 1236 </para> 1391 1237 … … 1401 1247 <para> 1402 1248 Beyond the standard options supplied by the 1403 <com puteroutput>mount</computeroutput> command, the1404 following areavailable:1249 <command>mount</command> command, the following are 1250 available: 1405 1251 </para> 1406 1252 … … 1438 1284 <listitem> 1439 1285 <para> 1440 In an OS/2 guest, use VBoxControl to manage shared folders: 1286 In an OS/2 guest, use the <command>VBoxControl</command> 1287 command to manage shared folders. For example: 1441 1288 </para> 1442 1289 1443 1290 <screen>VBoxControl sharedfolder use D: MyShareName 1444 VBoxControl sharedfolder unuse D: 1291 VBoxControl sharedfolder unuse D: 1445 1292 VBoxControl sharedfolder list</screen> 1446 1293 1447 <para>Like for Windows guests, shared folders can also be accessed via 1448 UNC using <computeroutput>\\VBoxSF\</computeroutput>, 1294 <para> 1295 As with Windows guests, shared folders can also be accessed 1296 via UNC using <computeroutput>\\VBoxSF\</computeroutput>, 1449 1297 <computeroutput>\\VBoxSvr\</computeroutput> or 1450 <computeroutput>\\VBoxSrv\</computeroutput> as the server name and 1451 the shared folder name as share. 1298 <computeroutput>\\VBoxSrv\</computeroutput> as the server 1299 name and the shared folder name as 1300 <replaceable>sharename</replaceable>. 1452 1301 </para> 1453 1302 </listitem> … … 1462 1311 1463 1312 <para> 1464 VirtualBox provides the option to mount shared folders 1465 automatically. When automatic mounting is enabled for a shared 1466 folder, the guest additions service will mount it for you. A 1467 preferred drive letter (Windows, OS/2) or mount point directory 1468 (Linux, Solaris) can also be specified if desired.</para> 1469 1470 <para> 1471 When no drive letter or mount point is given, or should it be 1472 in use already, an alternative location will be found 1473 1474 the service will search for an alternative 1475 location depending on the guest OS:</para> 1313 &product-name; provides the option to mount shared folders 1314 automatically. When automatic mounting is enabled for a shared 1315 folder, the Guest Additions service will mount it for you 1316 automatically. For Windows or OS/2, a preferred drive letter can 1317 also be specified. For Linux or Oracle Solaris, a mount point 1318 directory can also be specified. 1319 </para> 1320 1321 <para> 1322 If a drive letter or mount point is not specified, or is in use 1323 already, an alternative location is found by the Guest Additions 1324 service. The service searches for an alternative location 1325 depending on the guest OS, as follows: 1326 </para> 1476 1327 1477 1328 <itemizedlist> … … 1479 1330 <listitem> 1480 1331 <para> 1481 <emphasis role="bold">Windows and OS/2 guests:</emphasis> 1482 Search for a free drive letter starting at 1483 <computeroutput>Z:</computeroutput>. If all drive letter are 1484 assigned, the folder will not be mounted. 1485 </para> 1486 </listitem> 1487 1488 <listitem> 1489 <para> 1490 <emphasis role="bold">Linux and Solaris guests:</emphasis> 1491 Folders are mounted under the <computeroutput>/media</computeroutput> 1492 directory. The folder name is normalized (no spaces, slashes, 1493 colons) and prefixed with <computeroutput>sf_</computeroutput>. 1494 Say you have a shared folder called <computeroutput>myfiles</computeroutput> 1495 it will appear as <computeroutput>/media/sf_myfiles</computeroutput> in the guest. 1332 <emphasis role="bold">Windows and OS/2 guests.</emphasis> 1333 Search for a free drive letter, starting at 1334 <computeroutput>Z:</computeroutput>. If all drive letters 1335 are assigned, the folder is not mounted. 1336 </para> 1337 </listitem> 1338 1339 <listitem> 1340 <para> 1341 <emphasis role="bold">Linux and Oracle Solaris 1342 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>. 1346 </para> 1347 1348 <para> 1349 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. 1496 1353 </para> 1497 1354 1498 1355 <para> 1499 1356 The guest properties 1500 <computeroutput>/VirtualBox/GuestAdd/SharedFolders/MountDir</computeroutput> and 1357 <computeroutput>/VirtualBox/GuestAdd/SharedFolders/MountDir</computeroutput> 1358 and 1501 1359 <computeroutput>/VirtualBox/GuestAdd/SharedFolders/MountPrefix</computeroutput> 1502 can be used override the automatic mount directory and prefix.1503 See <xref linkend="guestadd-guestprops" />.1504 </para> 1505 1506 </listitem> 1360 can be used to override the automatic mount directory and 1361 prefix. See <xref linkend="guestadd-guestprops" />. 1362 </para> 1363 </listitem> 1364 1507 1365 </itemizedlist> 1508 1366 1509 1367 <para> 1510 Access to an automatically mounted shared folder is granted to everyone 1511 in a Windows guest, that includes the Guest user. For Linux and Solaris 1512 guests the access is restricted to members of the group 1513 <computeroutput>vboxsf</computeroutput> and <computeroutput>root</computeroutput>. 1368 Access to an automatically mounted shared folder is granted to 1369 everyone in a Windows guest, including the guest user. For Linux 1370 and Oracle Solaris guests, access is restricted to members of 1371 the group <computeroutput>vboxsf</computeroutput> and the 1372 <computeroutput>root</computeroutput> user. 1514 1373 </para> 1515 1374 … … 1523 1382 1524 1383 <para> 1525 Starting with version 5.0, VirtualBox enables you to drag and drop1526 content from the host to the guest, and vice versa. For this to1527 work the latest GuestAdditions must be installed on the guest.1384 &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. 1528 1387 </para> 1529 1388 … … 1531 1390 Drag and drop transparently allows copying or opening files, 1532 1391 directories, and even certain clipboard formats from one end to 1533 the other. for example, from the host to the guest or from the1392 the other. For example, from the host to the guest or from the 1534 1393 guest to the host. You then can perform drag and drop operations 1535 1394 between the host and a VM, as it would be a native drag and drop … … 1543 1402 most common one, XDND, is supported for now. Applications using 1544 1403 other protocols, such as Motif or OffiX, will not be recognized by 1545 VirtualBox.1404 &product-name;. 1546 1405 </para> 1547 1406 … … 1553 1412 Transferring data from the source to the target can be done in 1554 1413 various ways, such as copying, moving, or linking. 1555 1556 <footnote> 1557 1558 <para> 1559 At the moment only copying of data is supported. Moving or 1560 linking is not yet implemented. 1561 </para> 1562 1563 </footnote> 1564 </para> 1414 </para> 1415 1416 <note> 1417 <para> 1418 At the moment only copying of data is supported. Moving or 1419 linking is not yet implemented. 1420 </para> 1421 </note> 1565 1422 1566 1423 <para> … … 1574 1431 For security reasons drag and drop can be configured at runtime on 1575 1432 a per-VM basis either using the <emphasis role="bold">Drag and 1576 Drop</emphasis> menu item in the "Devices" menu of the virtual 1577 machine or VBoxManage. The following modes are available: 1578 </para> 1579 1580 <para> 1433 Drop</emphasis> menu item in the 1434 <emphasis role="bold">Devices</emphasis> menu of the virtual 1435 machine, as shown below, or the <command>VBoxManage</command>. 1436 </para> 1437 1438 <figure id="fig-drag-drop-options"> 1439 <title>Drag and Drop Menu Options</title> 1581 1440 <mediaobject> 1582 1441 <imageobject> … … 1585 1444 </imageobject> 1586 1445 </mediaobject> 1446 </figure> 1447 1448 <para> 1449 The following drag and drop modes are available: 1587 1450 </para> 1588 1451 … … 1592 1455 <para> 1593 1456 <emphasis role="bold">Disabled.</emphasis> Disables the drag 1594 and drop feature entirely. This is the default when creating 1595 new VM s.1457 and drop feature entirely. This is the default when creating a 1458 new VM. 1596 1459 </para> 1597 1460 </listitem> … … 1614 1477 <para> 1615 1478 <emphasis role="bold">Bidirectional.</emphasis> Enables drag 1616 and drop operations in both directions . From from the host to1617 theguest, and from the guest to the host.1479 and drop operations in both directions: from the host to the 1480 guest, and from the guest to the host. 1618 1481 </para> 1619 1482 </listitem> … … 1630 1493 1631 1494 <para> 1632 To use VBoxManage for controlling the current drag and drop mode, 1633 see <xref 1634 linkend="vboxmanage" />. The commands 1635 <computeroutput>modifyvm</computeroutput> and 1636 <computeroutput>controlvm</computeroutput> allow setting of the 1637 VM's current drag and drop mode via the command line. 1495 To use the <command>VBoxManage</command> command to control the 1496 current drag and drop mode, see <xref linkend="vboxmanage" />. The 1497 <command>modifyvm</command> and <command>controlvm</command> 1498 commands enable setting of a VM's current drag and drop mode from 1499 the command line. 1638 1500 </para> 1639 1501 … … 1643 1505 1644 1506 <para> 1645 As VirtualBox can run on a variety of host operating systems and1646 a lso supports a wide range of guests, certain data formats must1647 be translated after transfer. This is so that the target1507 As &product-name; can run on a variety of host operating systems 1508 and also supports a wide range of guests, certain data formats 1509 must be translated after transfer. This is so that the target 1648 1510 operating system, which receiving the data, is able to handle 1649 1511 them in an appropriate manner. … … 1660 1522 1661 1523 <para> 1662 The following formats are handled by the VirtualBoxdrag and1524 The following formats are handled by the &product-name; drag and 1663 1525 drop service: 1664 1526 </para> … … 1704 1566 UAC-elevated (User Account Control) programs and 1705 1567 non-UAC-elevated programs is not allowed. If you start 1706 VirtualBox with Administrator privileges then drag and drop will1707 not work with Windows Explorer, which runs with regular user1708 privileges by default.1568 &product-name; with Administrator privileges then drag and drop 1569 will not work with Windows Explorer, which runs with regular 1570 user privileges by default. 1709 1571 </para> 1710 1572 … … 1722 1584 1723 1585 <para> 1724 The VirtualBox Guest Additions contain experimental hardware 3D 1725 support for Windows, Linux, and Solaris guests. 1726 1727 <footnote> 1728 1729 <para> 1730 OpenGL support for Windows guests was added with VirtualBox 1731 2.1; support for Linux and Solaris followed with VirtualBox 1732 2.2. With VirtualBox 3.0, Direct3D 8/9 support was added for 1733 Windows guests. OpenGL 2.0 is now supported as well. With 1734 VirtualBox 4.1 Windows Aero theme support is added for 1735 Windows Vista and Windows 7 guests (experimental) 1736 </para> 1737 1738 </footnote> 1586 The &product-name; Guest Additions contain experimental hardware 1587 3D support for Windows, Linux, and Oracle Solaris guests. 1739 1588 </para> 1740 1589 … … 1743 1592 uses 3D features through the OpenGL or Direct3D 8/9 programming 1744 1593 interfaces, instead of emulating them in software, which would 1745 be slow, VirtualBox will attempt to use your host's 3D hardware.1746 This works for all supported host platforms, provided that your1747 host operating system can make use of your accelerated 3D1748 hardware in the first place.1594 be slow, &product-name; will attempt to use your host's 3D 1595 hardware. This works for all supported host platforms, provided 1596 that your host operating system can make use of your accelerated 1597 3D hardware in the first place. 1749 1598 </para> 1750 1599 … … 1758 1607 <listitem> 1759 1608 <para> 1760 It is only available for certain Windows, Linux, and Solaris1761 guests. In particular:1609 It is only available for certain Windows, Linux, and Oracle 1610 Solaris guests. In particular: 1762 1611 </para> 1763 1612 … … 1767 1616 <para> 1768 1617 3D acceleration with Windows guests requires Windows 1769 2000, Windows XP, Vista or Windows 7. Both OpenGL and1770 Direct3D 8/9 (not with Windows 2000) are supported1771 (experimental).1618 2000, Windows XP, Vista, or Windows 7. Apart from on 1619 Windows 2000 guests, both OpenGL and Direct3D 8/9 are 1620 supported on an experimental basis. 1772 1621 </para> 1773 1622 </listitem> … … 1775 1624 <listitem> 1776 1625 <para> 1777 OpenGL on Linux requires kernel 2.6.27 and higher as 1778 well as X.org server version 1.5 and higher. Ubuntu 1779 10.10 and Fedora 14 have been tested and confirmed as 1780 working. 1626 OpenGL on Linux requires kernel 2.6.27 or later, as well 1627 as X.org server version 1.5 or later. Ubuntu 10.10 and 1628 Fedora 14 have been tested and confirmed as working. 1781 1629 </para> 1782 1630 </listitem> … … 1784 1632 <listitem> 1785 1633 <para> 1786 OpenGL on Solaris guests requires X.org server version1787 1.5 and higher.1634 OpenGL on Oracle Solaris guests requires X.org server 1635 version 1.5 or later. 1788 1636 </para> 1789 1637 </listitem> … … 1800 1648 <para> 1801 1649 For the basic Direct3D acceleration to work in a Windows 1802 Guest, VirtualBox needs to replace Windows system files in1803 the virtual machine. As a result, the Guest Additions1804 installation program offers Direct3D acceleration as an1805 option that must be explicitly enabled. Also, you must1806 install the Guest Additions in Safe Mode. This does1807 <emphasis>not</emphasis> apply to the WDDM Direct3D video1808 driver available for Vista and higher. See1809 <xref linkend="KnownIssues" /> for details.1650 Guest, &product-name; needs to replace Windows system 1651 files in the virtual machine. As a result, the Guest 1652 Additions installation program offers Direct3D 1653 acceleration as an option that must be explicitly enabled. 1654 Also, you must install the Guest Additions in Safe Mode. 1655 This does <emphasis>not</emphasis> apply to the WDDM 1656 Direct3D video driver available for Windows Vista and 1657 later. See <xref linkend="KnownIssues" /> for details. 1810 1658 </para> 1811 1659 </note> … … 1824 1672 <para> 1825 1673 Untrusted guest systems should not be allowed to use 1826 VirtualBox's 3D acceleration features, just as untrusted1827 host software should not be allowed to use 3D1674 &product-name;'s 3D acceleration features, just as 1675 untrusted host software should not be allowed to use 3D 1828 1676 acceleration. Drivers for 3D hardware are generally too 1829 1677 complex to be made properly secure and any software which … … 1831 1679 operating system running them. In addition, enabling 3D 1832 1680 acceleration gives the guest direct access to a large body 1833 of additional program code in the VirtualBox host process1834 which it might conceivably be able to use to crash the1835 virtual machine.1681 of additional program code in the &product-name; host 1682 process which it might conceivably be able to use to crash 1683 the virtual machine. 1836 1684 </para> 1837 1685 </note> … … 1841 1689 1842 1690 <para> 1843 To enable Aero theme support, the VirtualBox WDDM video driver1844 must be installed, which is available with the Guest Additions1845 installation. The WDDM driver is not installed by default for1846 Vista and Windows 7 guest and must be <emphasis>manually1847 selected</emphasis> in the Guest Additions installer by clicking1848 <emphasis role="bold">No</emphasis> in the1691 To enable Aero theme support, the &product-name; WDDM video 1692 driver must be installed, which is available with the Guest 1693 Additions installation. The WDDM driver is not installed by 1694 default for Vista and Windows 7 guest and must be 1695 <emphasis>manually selected</emphasis> in the Guest Additions 1696 installer by clicking <emphasis role="bold">No</emphasis> in the 1849 1697 <emphasis role="bold">Would You Like to Install Basic Direct3D 1850 1698 Support</emphasis> dialog displayed when the Direct3D feature is … … 1865 1713 <emphasis role="bold">Personalize</emphasis>, then select 1866 1714 <emphasis role="bold">Windows Color and 1867 Appearance</emphasis> in the Personalization window. In the 1868 Appearance Settings dialog, select 1869 <emphasis role="bold">Windows Aero</emphasis> and click 1870 <emphasis role="bold">OK</emphasis>. 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>. 1871 1720 </para> 1872 1721 </listitem> … … 1877 1726 Right-click on the desktop and select 1878 1727 <emphasis role="bold">Personalize</emphasis>. Select any 1879 Aero theme in the Personalization window. 1728 Aero theme in the 1729 <emphasis role="bold">Personalization</emphasis> window. 1880 1730 </para> 1881 1731 </listitem> … … 1884 1734 1885 1735 <para> 1886 Technically, VirtualBoximplements this by installing an1736 Technically, &product-name; implements this by installing an 1887 1737 additional hardware 3D driver inside your guest when the Guest 1888 1738 Additions are installed. This driver acts as a hardware 3D 1889 1739 driver and reports to the guest operating system that the 1890 (virtual) hardware is capable of 3D hardware acceleration. When1891 a n application in the guest then requests hardware acceleration1740 virtual hardware is capable of 3D hardware acceleration. When an 1741 application in the guest then requests hardware acceleration 1892 1742 through the OpenGL or Direct3D programming interfaces, these are 1893 1743 sent to the host through a special communication tunnel 1894 implemented by VirtualBox, and then the1744 implemented by &product-name;, and then the 1895 1745 <emphasis>host</emphasis> performs the requested 3D operation 1896 viathe host's programming interfaces.1746 using the host's programming interfaces. 1897 1747 </para> 1898 1748 … … 1904 1754 1905 1755 <para> 1906 Starting with version 3.1, the VirtualBox Guest Additions 1907 contain experimental hardware 2D video acceleration support for 1908 Windows guests. 1756 The &product-name; Guest Additions contain experimental hardware 1757 2D video acceleration support for Windows guests. 1909 1758 </para> 1910 1759 … … 1912 1761 With this feature, if an application such as a video player 1913 1762 inside your Windows VM uses 2D video overlays to play a movie 1914 clip, then VirtualBoxwill attempt to use your host's video1763 clip, then &product-name; will attempt to use your host's video 1915 1764 acceleration hardware instead of performing overlay stretching 1916 1765 and color conversion in software, which would be slow. This … … 1929 1778 <listitem> 1930 1779 <para> 1931 Only available for Windows guests (XP or later). 1780 Only available for Windows guests, running Windows XP or 1781 later. 1932 1782 </para> 1933 1783 </listitem> … … 1952 1802 1953 1803 <para> 1954 Technically, VirtualBoximplements this by exposing video1804 Technically, &product-name; implements this by exposing video 1955 1805 overlay DirectDraw capabilities in the Guest Additions video 1956 1806 driver. The driver sends all overlay commands to the host 1957 1807 through a special communication tunnel implemented by 1958 VirtualBox. On the host side, OpenGL is then used to implement1959 color space transformation and scaling1808 &product-name;. On the host side, OpenGL is then used to 1809 implement color space transformation and scaling 1960 1810 </para> 1961 1811 … … 1970 1820 <para> 1971 1821 With the <emphasis>seamless windows</emphasis> feature of 1972 VirtualBox, you can have the windows that are displayed within a1973 virtual machine appear side by side next to the windows of your1822 &product-name;, you can have the windows that are displayed within 1823 a virtual machine appear side by side next to the windows of your 1974 1824 host. This feature is supported for the following guest operating 1975 1825 systems, provided that the Guest Additions are installed: … … 1980 1830 <listitem> 1981 1831 <para> 1982 Windows guests (support added with VirtualBox 1.5)1832 Windows guests. Support was added in &product-name; 1.5. 1983 1833 </para> 1984 1834 </listitem> … … 1986 1836 <listitem> 1987 1837 <para> 1988 Supported Linux or Solaris guests running the X Window System1989 (added with VirtualBox 1.6)1838 Supported Linux or Oracle Solaris guests running the X Window 1839 System. Support was added with &product-name; 1.6. 1990 1840 </para> 1991 1841 </listitem> … … 1994 1844 1995 1845 <para> 1996 After seamless windows are enabled, VirtualBoxsuppresses the1846 After seamless windows are enabled, &product-name; suppresses the 1997 1847 display of the desktop background of your guest, allowing you to 1998 1848 run the windows of your guest operating system seamlessly next to … … 2000 1850 </para> 2001 1851 2002 <mediaobject> 2003 <imageobject> 2004 <imagedata align="center" fileref="images/seamless.png" width="14cm" /> 2005 </imageobject> 2006 </mediaobject> 1852 <figure id="fig-seamless-windows"> 1853 <title>Seamless Windows on a Host Desktop</title> 1854 <mediaobject> 1855 <imageobject> 1856 <imagedata align="center" fileref="images/seamless.png" width="14cm" /> 1857 </imageobject> 1858 </mediaobject> 1859 </figure> 2007 1860 2008 1861 <para> … … 2023 1876 2024 1877 <para> 2025 Starting with version 2.1, VirtualBox enables requesting of2026 certain properties from a running guest, provided that the2027 VirtualBox Guest Additions are installed and the VM is running.2028 This provides the followingadvantages:1878 &product-name; enables requests of some properties from a running 1879 guest, provided that the &product-name; Guest Additions are 1880 installed and the VM is running. This provides the following 1881 advantages: 2029 1882 </para> 2030 1883 … … 2034 1887 <para> 2035 1888 A number of predefined VM characteristics are automatically 2036 maintained by VirtualBox and can be retrieved on the host. For2037 example, to monitor VM performance and statistics.1889 maintained by &product-name; and can be retrieved on the host. 1890 For example, to monitor VM performance and statistics. 2038 1891 </para> 2039 1892 </listitem> … … 2049 1902 2050 1903 <para> 2051 To accomplish this, VirtualBox establishes a private communication2052 c hannel between the VirtualBox Guest Additions and the host, and2053 software on both sides can use this channel to exchange string2054 data for arbitrary purposes. Guest properties are simply string2055 keys to which a value is attached. They can be set, or written to,2056 by either the host and the guest. They can also be read from both2057 sides.1904 To accomplish this, &product-name; establishes a private 1905 communication channel between the &product-name; Guest Additions 1906 and the host, and software on both sides can use this channel to 1907 exchange string data for arbitrary purposes. Guest properties are 1908 simply string keys to which a value is attached. They can be set, 1909 or written to, by either the host and the guest. They can also be 1910 read from both sides. 2058 1911 </para> 2059 1912 … … 2061 1914 In addition to establishing the general mechanism of reading and 2062 1915 writing values, a set of predefined guest properties is 2063 automatically maintained by the VirtualBoxGuest Additions to1916 automatically maintained by the &product-name; Guest Additions to 2064 1917 allow for retrieving interesting guest data such as the guest's 2065 1918 exact operating system and service pack level, the installed … … 2074 1927 Some of this runtime information is shown when you select 2075 1928 <emphasis role="bold">Session Information Dialog</emphasis> from a 2076 virtual machine's Machinemenu.2077 </para> 2078 2079 <para> 2080 A more flexible way to use this channel is viathe2081 <com puteroutput>VBoxManage guestproperty</computeroutput> command.2082 See <xref linkend="vboxmanage-guestproperty" />. For example, to2083 have<emphasis>all</emphasis> the available guest properties for a1929 virtual machine's <emphasis role="bold">Machine</emphasis> menu. 1930 </para> 1931 1932 <para> 1933 A more flexible way to use this channel is with the 1934 <command>VBoxManage guestproperty</command> command. See 1935 <xref linkend="vboxmanage-guestproperty" />. For example, to have 1936 <emphasis>all</emphasis> the available guest properties for a 2084 1937 given running VM listed with their respective values, use this 2085 1938 command: … … 2158 2011 To add or change guest properties from the guest, use the tool 2159 2012 <computeroutput>VBoxControl</computeroutput>. This tool is 2160 included in the Guest Additions of VirtualBox 2.2 or later. When2161 started from a Linux guest, this tool requires root privileges for2162 security reasons:2013 included in the Guest Additions of &product-name; 2.2 or later. 2014 When started from a Linux guest, this tool requires root 2015 privileges for security reasons: 2163 2016 </para> 2164 2017 … … 2175 2028 2176 2029 <para> 2177 For more complex needs, you can use the VirtualBoxprogramming2030 For more complex needs, you can use the &product-name; programming 2178 2031 interfaces. See <xref linkend="VirtualBoxAPI" />. 2179 2032 </para> … … 2181 2034 </sect1> 2182 2035 2036 <sect1 id="guestadd-gc-file-manager"> 2037 2038 <title>Guest Control File Manager</title> 2039 2040 <para> 2041 The Guest Control File Manager is a feature of the Guest Additions 2042 that enables easy copying and moving of files between a guest and 2043 the host system. 2044 </para> 2045 2046 <para> 2047 Other file management operations are supported, such as creating 2048 new folders and renaming files or deleting files. 2049 </para> 2050 2051 <figure id="fig-guest-control-fm"> 2052 <title>Guest Control File Manager</title> 2053 <mediaobject> 2054 <imageobject> 2055 <imagedata align="center" fileref="images/guest-fm.png" 2056 width="10cm" /> 2057 </imageobject> 2058 </mediaobject> 2059 </figure> 2060 2061 <para> 2062 The Guest Control File Manager works by mounting the host file 2063 system. Guest users must authenticate and create a guest session 2064 before they can transfer files. 2065 </para> 2066 2067 <sect2 id="guestadd-gc-file-manager-using"> 2068 2069 <title>Using the Guest Control File Manager</title> 2070 2071 <para> 2072 The following steps describe how to use the Guest Control File 2073 Manager. 2074 </para> 2075 2076 <orderedlist> 2077 2078 <listitem> 2079 <para> 2080 Display the Guest Control File Manager. 2081 </para> 2082 2083 <para> 2084 In the guest VM, select 2085 <emphasis role="bold">Machine</emphasis>, 2086 <emphasis role="bold">File Manager</emphasis>. 2087 </para> 2088 2089 <para> 2090 The Guest Control File Manager is displayed. Files on the 2091 host system are shown in the left pane. 2092 </para> 2093 </listitem> 2094 2095 <listitem> 2096 <para> 2097 Create a guest session. 2098 </para> 2099 2100 <para> 2101 In the panel at the bottom of the Guest Control File 2102 Manager, enter authentication credentials for a user on the 2103 guest system. 2104 </para> 2105 2106 <para> 2107 Click <emphasis role="bold">Create Session</emphasis>. 2108 </para> 2109 2110 <para> 2111 The guest VM file system is shown in the right pane of the 2112 Guest Control File Manager. 2113 </para> 2114 </listitem> 2115 2116 <listitem> 2117 <para> 2118 Transfer files between the guest and the host. 2119 </para> 2120 2121 <para> 2122 Use the file transfer icons to copy or move files between 2123 the guest and host. 2124 </para> 2125 2126 <para> 2127 You can copy and move files from guest to host, or from host 2128 to guest. 2129 </para> 2130 </listitem> 2131 2132 <listitem> 2133 <para> 2134 Close down the Guest Control File Manager. 2135 </para> 2136 2137 <para> 2138 Click <emphasis role="bold">Close</emphasis>. The guest 2139 session is ended and the Guest Control File Manager is 2140 closed down. 2141 </para> 2142 </listitem> 2143 2144 </orderedlist> 2145 2146 </sect2> 2147 2148 </sect1> 2149 2183 2150 <sect1 id="guestadd-guestcontrol"> 2184 2151 2185 <title>Guest Control </title>2186 2187 <para> 2188 Starting with version 3.2, the Guest Additions of VirtualBox allow2189 starting applications inside a VMfrom the host system.2152 <title>Guest Control of Applications</title> 2153 2154 <para> 2155 The Guest Additions enable starting of applications inside a VM 2156 from the host system. 2190 2157 </para> 2191 2158 … … 2205 2172 2206 2173 <para> 2207 Starting with version 4.0, the Guest Additions for Windows allow 2208 for automatic updating. This applies for already installed Guest 2209 Additions version 4.0 or later. Also, copying files from host to 2210 the guest as well as remotely creating guest directories is 2211 available. 2212 </para> 2213 2214 <para> 2215 To use these features, use the VirtualBox command line. See 2216 <xref 2217 linkend="vboxmanage-guestcontrol" />. 2174 The Guest Additions for Windows allow for automatic updating. This 2175 applies for already installed Guest Additions version 4.0 or 2176 later. Also, copying files from host to the guest as well as 2177 remotely creating guest directories is available. 2178 </para> 2179 2180 <para> 2181 To use these features, use the &product-name; command line. See 2182 <xref linkend="vboxmanage-guestcontrol" />. 2218 2183 </para> 2219 2184 … … 2237 2202 2238 2203 <para> 2239 Starting with version 3.2, the Guest Additions of VirtualBox can2240 change the amount of host memory that a VM uses while the2241 machine is running. Because of how this is implemented, this2242 feature is called <emphasis>memoryballooning</emphasis>.2204 The Guest Additions can change the amount of host memory that a 2205 VM uses, while the machine is running. Because of how this is 2206 implemented, this feature is called <emphasis>memory 2207 ballooning</emphasis>. 2243 2208 </para> 2244 2209 … … 2248 2213 <listitem> 2249 2214 <para> 2250 VirtualBoxsupports memory ballooning only on 64-bit2215 &product-name; supports memory ballooning only on 64-bit 2251 2216 hosts. It is not supported on Mac OS X hosts. 2252 2217 </para> … … 2274 2239 2275 2240 <para> 2276 When memory ballooning is requested, the VirtualBoxGuest2241 When memory ballooning is requested, the &product-name; Guest 2277 2242 Additions, which run inside the guest, allocate physical memory 2278 2243 from the guest operating system on the kernel level and lock … … 2280 2245 not use that memory any longer. No guest applications can 2281 2246 allocate it, and the guest kernel will not use it either. 2282 VirtualBoxcan then reuse this memory and give it to another2247 &product-name; can then reuse this memory and give it to another 2283 2248 virtual machine. 2284 2249 </para> … … 2286 2251 <para> 2287 2252 The memory made available through the ballooning mechanism is 2288 only available for reuse by VirtualBox. It is2253 only available for reuse by &product-name;. It is 2289 2254 <emphasis>not</emphasis> returned as free memory to the host. 2290 2255 Requesting balloon memory from a running guest will therefore … … 2301 2266 <para> 2302 2267 At this time, memory ballooning is only supported through 2303 VBoxManage. Use the following command to increase or decrease2304 the size of the memory balloon within a running virtual machine2305 that has Guest Additions installed:2268 <command>VBoxManage</command>. Use the following command to 2269 increase or decrease the size of the memory balloon within a 2270 running virtual machine that has Guest Additions installed: 2306 2271 </para> 2307 2272 … … 2320 2285 requested from the VM every time after it has started up with 2321 2286 the following command: 2287 </para> 2322 2288 2323 2289 <screen>VBoxManage modifyvm "VM name" --guestmemoryballoon n</screen> 2324 </para>2325 2290 2326 2291 <para> … … 2345 2310 2346 2311 <para> 2347 In a server environment running several similar VMs, for example 2348 with identical operating systems, on the same host, lots of 2349 memory pages are identical. VirtualBox's Page Fusion technology, 2350 introduced with VirtualBox 3.2, is a novel technique to 2351 efficiently identify these identical memory pages and share them 2352 between multiple VMs. 2312 In a server environment running several similar VMs on the same 2313 host, lots of memory pages are identical. For example, if the 2314 VMs are using identical operating systems. &product-name;'s Page 2315 Fusion technology can efficiently identify these identical 2316 memory pages and share them between multiple VMs. 2353 2317 </para> 2354 2318 2355 2319 <note> 2356 2320 <para> 2357 VirtualBox supports Page Fusion only on 64-bit hosts, and it2358 i s not supported on Mac OS X hosts. Page Fusion currently2321 &product-name; supports Page Fusion only on 64-bit hosts, and 2322 it is not supported on Mac OS X hosts. Page Fusion currently 2359 2323 works only with Windows 2000 and later guests. 2360 2324 </para> … … 2391 2355 <para> 2392 2356 Traditional hypervisors scan <emphasis>all</emphasis> guest 2393 memory and compute checksums (hashes) for every single2394 memory page. Then, they look for pages with identical hashes2395 and compare the entire content of those pages. If two pages2396 p roduce the same hash, it is very likely that the pages are2397 identical in content. This process can take rather long,2398 especially if the system is not idling. As a result, the2399 additional memory only becomes available after a significant2400 amount of time, such as hours or sometimes days. Even worse,2401 this kind of page sharing algorithm generally consumes2402 significant CPU resources and increases the virtualization2403 overhead by 10 to 20%.2404 </para> 2405 2406 <para> 2407 Page Fusion in VirtualBox uses logic in the VirtualBox Guest2408 Additions to quickly identify memory cells that are most2409 likely identical across VMs. It can therefore achieve most2410 of the possible savings of page sharing almost immediately2411 and with almost no overhead.2357 memory and compute checksums, also called hashes, for every 2358 single memory page. Then, they look for pages with identical 2359 hashes and compare the entire content of those pages. If two 2360 pages produce the same hash, it is very likely that the 2361 pages are identical in content. This process can take rather 2362 long, especially if the system is not idling. As a result, 2363 the additional memory only becomes available after a 2364 significant amount of time, such as hours or sometimes days. 2365 Even worse, this kind of page sharing algorithm generally 2366 consumes significant CPU resources and increases the 2367 virtualization overhead by 10 to 20%. 2368 </para> 2369 2370 <para> 2371 Page Fusion in &product-name; uses logic in the 2372 &product-name; Guest Additions to quickly identify memory 2373 cells that are most likely identical across VMs. It can 2374 therefore achieve most of the possible savings of page 2375 sharing almost immediately and with almost no overhead. 2412 2376 </para> 2413 2377 </listitem> … … 2427 2391 <para> 2428 2392 At this time, Page Fusion can only be controlled with 2429 VBoxManage, and only while a VM is shut down. To enable Page2430 Fusion for a VM, use the following command:2393 <command>VBoxManage</command>, and only while a VM is shut down. 2394 To enable Page Fusion for a VM, use the following command: 2431 2395 </para> 2432 2396 … … 2448 2412 Enabling Page Fusion might indirectly increase the chances for 2449 2413 malicious guests to successfully attack other VMs running on 2450 the same host. See <xref linkend="pot-insecure"/>. 2414 the same host. 2415 2416 <!--See <xref linkend="pot-insecure"/>.--> 2451 2417 </para> 2452 2418 </note> -
trunk/doc/manual/en_US/user_Installation.xml
r73276 r76078 8 8 9 9 <title>Installation Details</title> 10 11 10 <para> 12 As installation of VirtualBox varies depending on your host 13 operating system, we provide installation instructions in four 14 separate chapters for Windows, Mac OS X, Linux and Solaris, 15 respectively. 11 As installation of &product-name; varies depending on your host 12 operating system, the following sections provide installation 13 instructions for Windows, Mac OS X, Linux, and Oracle Solaris. 16 14 </para> 17 15 … … 32 30 33 31 <para> 34 In addition, Windows Installer 1.1 or higher must be present on32 In addition, Windows Installer 1.1 or later must be present on 35 33 your system. This should be the case if you have all recent 36 34 Windows updates installed. … … 44 42 45 43 <para> 46 The VirtualBoxinstallation can be started in either of the44 The &product-name; installation can be started in either of the 47 45 following ways: 48 46 </para> … … 76 74 77 75 <para> 78 Using either way displays the installation Welcome dialog and 79 enables you to choose where to install VirtualBox, and which 80 components to install. In addition to the VirtualBox 81 application, the following components are available: 76 Using either way displays the installation 77 <emphasis role="bold">Welcome</emphasis> dialog and enables you 78 to choose where to install &product-name;, and which components to 79 install. In addition to the &product-name; application, the 80 following components are available: 82 81 </para> 83 82 … … 88 87 <emphasis role="bold">USB support.</emphasis> This package 89 88 contains special drivers for your Windows host that 90 VirtualBoxrequires to fully support USB devices inside your89 &product-name; requires to fully support USB devices inside your 91 90 virtual machines. 92 91 </para> … … 97 96 <emphasis role="bold">Networking.</emphasis> This package 98 97 contains extra networking drivers for your Windows host that 99 VirtualBoxneeds to support Bridged Networking. This enables98 &product-name; needs to support Bridged Networking. This enables 100 99 your VM's virtual network cards to be accessed from other 101 100 machines on your physical network. … … 106 105 <para> 107 106 <emphasis role="bold">Python support.</emphasis> This 108 package contains Python scripting support for the VirtualBox107 package contains Python scripting support for the &product-name; 109 108 API, see <xref linkend="VirtualBoxAPI" />. For this to work, 110 109 an already working Windows Python installation on the system … … 120 119 <note> 121 120 <para> 122 Python version at least 2.6 is required. Since VirtualBox121 Python version at least 2.6 is required. Since &product-name; 123 122 5.1, Python 3 is also supported. 124 123 </para> … … 132 131 about unsigned drivers, or similar. Click 133 132 <emphasis role="bold">Continue</emphasis> for these warnings, as 134 otherwise VirtualBoxmight not function correctly after133 otherwise &product-name; might not function correctly after 135 134 installation. 136 135 </para> 137 136 138 137 <para> 139 The installer will create a VirtualBoxgroup in the Windows140 Start menu, which allows you to launch the application and141 access its documentation.142 </para> 143 144 <para> 145 With standard settings, VirtualBoxwill be installed for all138 The installer will create a &product-name; group in the Windows 139 <emphasis role="bold">Start</emphasis> menu, which enables you 140 to launch the application and access its documentation. 141 </para> 142 143 <para> 144 With standard settings, &product-name; will be installed for all 146 145 users on the local system. If this is not wanted, you must 147 146 invoke the installer by first extracting as follows: … … 152 151 <para> 153 152 Then, run either of the following commands on the extracted .MSI 154 files. This will install VirtualBoxonly for the current user.153 files. This will install &product-name; only for the current user. 155 154 </para> 156 155 … … 160 159 161 160 <para> 162 If you do not want to install all features of VirtualBox, you161 If you do not want to install all features of &product-name;, you 163 162 can set the optional <computeroutput>ADDLOCAL</computeroutput> 164 163 parameter to explicitly name the features to be installed. The … … 175 174 <listitem> 176 175 <para> 177 Main binaries of VirtualBox. 178 179 <note> 180 <para> 181 This feature must not be absent, since it contains the 182 minimum set of files to have working VirtualBox 183 installation. 184 </para> 185 </note> 176 Main binaries of &product-name;. 186 177 </para> 178 179 <note> 180 <para> 181 This feature must not be absent, since it contains the 182 minimum set of files to have working &product-name; 183 installation. 184 </para> 185 </note> 187 186 </listitem> 188 187 </varlistentry> … … 250 249 <para> 251 250 Python version at least 2.6 is required. Since 252 VirtualBox5.1, Python 3 is also supported.251 &product-name; 5.1, Python 3 is also supported. 253 252 </para> 254 253 </note> … … 293 292 294 293 <para> 295 As VirtualBoxuses the standard Microsoft Windows installer,296 VirtualBoxcan be safely uninstalled at any time. Click the294 As &product-name; uses the standard Microsoft Windows installer, 295 &product-name; can be safely uninstalled at any time. Click the 297 296 program entry in the <emphasis role="bold">Add/Remove 298 297 Programs</emphasis> list in the Windows Control Panel. … … 317 316 318 317 <para> 319 Public properties can be specified viaMSI API, to control318 Public properties can be specified with the MSI API, to control 320 319 additional behavior and features of the Windows host installer. 321 320 Use either of the following commands: … … 338 337 339 338 <para> 340 Specifies whether or not a VirtualBoxicon on the desktop339 Specifies whether or not an &product-name; icon on the desktop 341 340 should be created. 342 341 </para> … … 354 353 355 354 <para> 356 Specifies whether or not a VirtualBoxicon in the Quick355 Specifies whether or not an &product-name; icon in the Quick 357 356 Launch Bar should be created. 358 357 </para> … … 372 371 Specifies whether or not the file extensions .vbox, 373 372 .vbox-extpack, .ovf, .ova, .vdi, .vmdk, .vhd and .vdd should 374 be associated with VirtualBox. Files of these types then375 will be opened with VirtualBox.373 be associated with &product-name;. Files of these types then 374 will be opened with &product-name;. 376 375 </para> 377 376 … … 388 387 389 388 <para> 390 Specifies whether or not VirtualBox should be startedright389 Specifies whether to start &product-name; right 391 390 after successful installation. 392 391 </para> … … 413 412 414 413 <para> 415 For Mac OS X hosts, VirtualBox ships in a disk image416 (<computeroutput>dmg</computeroutput>) file. Perform the417 following steps to install on a Mac OS X host:414 For Mac OS X hosts, &product-name; ships in a 415 <computeroutput>dmg</computeroutput> disk image file. Perform 416 the following steps to install on a Mac OS X host: 418 417 </para> 419 418 … … 437 436 <listitem> 438 437 <para> 439 This will start the installer, which allows you to select440 where to install VirtualBox.438 This will start the installer, which enables you to select 439 where to install &product-name;. 441 440 </para> 442 441 </listitem> … … 445 444 446 445 <para> 447 After installation, you can find a VirtualBoxicon in the446 After installation, you can find an &product-name; icon in the 448 447 "Applications" folder in the Finder. 449 448 </para> … … 456 455 457 456 <para> 458 To uninstall VirtualBox, open the disk image457 To uninstall &product-name;, open the disk image 459 458 <computeroutput>dmg</computeroutput> file and double-click on 460 459 the uninstall icon shown. … … 468 467 469 468 <para> 470 To perform a non-interactive installation of VirtualBoxyou can469 To perform a non-interactive installation of &product-name; you can 471 470 use the command line version of the installer application. 472 471 </para> 473 472 474 473 <para> 475 Mount the disk image (<computeroutput>dmg</computeroutput>)476 file, as described in the installation procedure, or use the477 followingcommand line:474 Mount the <computeroutput>dmg</computeroutput> disk image file, 475 as described in the installation procedure, or use the following 476 command line: 478 477 </para> 479 478 … … 507 506 You will need to install the following packages on your Linux 508 507 system before starting the installation. Some systems will do 509 this for you automatically when you install VirtualBox.508 this for you automatically when you install &product-name;. 510 509 </para> 511 510 … … 514 513 <listitem> 515 514 <para> 516 Qt 5.3.2 or higher. Qt 5.6.2 or higher is recommended.517 </para> 518 </listitem> 519 520 <listitem> 521 <para> 522 SDL 1.2.7 or higher. This graphics library is typically515 Qt 5.3.2 or later. Qt 5.6.2 or later is recommended. 516 </para> 517 </listitem> 518 519 <listitem> 520 <para> 521 SDL 1.2.7 or later. This graphics library is typically 523 522 called <computeroutput>libsdl</computeroutput> or similar. 524 523 </para> … … 530 529 <para> 531 530 These packages are only required if you want to run the 532 VirtualBoxgraphical user interfaces. In particular,531 &product-name; graphical user interfaces. In particular, 533 532 <computeroutput>VirtualBox</computeroutput>, the graphical 534 VirtualBox manager, requires both Qt and SDL. 535 <computeroutput>VBoxSDL</computeroutput>, the simplified GUI, 536 requires only SDL. If you only want to run 537 <computeroutput>VBoxHeadless</computeroutput>, neither Qt nor 538 SDL are required. 533 VirtualBox Manager, requires both Qt and SDL. 534 If you only want to run <command>VBoxHeadless</command>, 535 neither Qt nor SDL are required. 539 536 </para> 540 537 </note> … … 544 541 <sect2 id="externalkernelmodules"> 545 542 546 <title>The VirtualBoxDriver Modules</title>543 <title>The &product-name; Driver Modules</title> 547 544 548 545 <para> 549 546 In order to run other operating systems in virtual machines 550 alongside your main operating system, VirtualBoxneeds to547 alongside your main operating system, &product-name; needs to 551 548 integrate very tightly into the system. To do this it installs a 552 549 driver module called <computeroutput>vboxdrv</computeroutput> … … 554 551 the part of the operating system which controls your processor 555 552 and physical hardware. Without this kernel module, you can still 556 use the VirtualBox manager to configure virtual machines, but553 use the VirtualBox Manager to configure virtual machines, but 557 554 they will not start. It also installs network drivers called 558 555 <computeroutput>vboxnetflt</computeroutput> and … … 577 574 list includes some instructions for common distributions. For 578 575 most of them you may want to start by finding the version name 579 of your kernel, using the command <com puteroutput>uname580 -r</computeroutput> in a terminal. The instructions assume that581 you have not changed too much from the original installation,582 particularly not installed a different kernel type. If you have,583 then you willneed to determine yourself what to set up.576 of your kernel, using the command <command>uname -r</command> in 577 a terminal. The instructions assume that you have not changed 578 too much from the original installation, particularly not 579 installed a different kernel type. If you have, then you will 580 need to determine yourself what to set up. 584 581 </para> 585 582 … … 642 639 643 640 <para> 644 VirtualBoxis available in a number of package formats native to645 various common Linux distributions >See646 <xref linkend="hostossupport" 641 &product-name; is available in a number of package formats native to 642 various common Linux distributions. See 643 <xref linkend="hostossupport"/>. In addition, there is an 647 644 alternative generic installer (.run) which should work on most 648 645 Linux distributions. The generic installer packages are built on 649 EL5 systems and thus require reasonably old versions of glibc 650 (version 2.5)and other system libraries.646 EL5 systems and thus require reasonably old versions of glibc, 647 such as version 2.5, and other system libraries. 651 648 </para> 652 649 653 650 <sect3 id="install-linux-debian-ubuntu"> 654 651 655 <title>Installing VirtualBoxfrom a Debian/Ubuntu Package</title>652 <title>Installing &product-name; from a Debian/Ubuntu Package</title> 656 653 657 654 <para> … … 693 690 694 691 <para> 695 Once VirtualBoxhas been successfully installed and692 Once &product-name; has been successfully installed and 696 693 configured, you can start it by clicking 697 <emphasis role="bold">VirtualBox</emphasis> in your Start menu698 or from the command line. See699 <xref linkend="startingvboxonlinux" />.694 <emphasis role="bold">VirtualBox</emphasis> in your 695 <emphasis role="bold">Start</emphasis> menu or from the 696 command line. See <xref linkend="startingvboxonlinux" />. 700 697 </para> 701 698 … … 715 712 <listitem> 716 713 <para> 717 Unpacks the application files to the target directory, 718 719 <screen>/opt/VirtualBox/</screen> 720 721 which cannot be changed. 714 Unpacks the application files to the target directory 715 <computeroutput>/opt/VirtualBox/</computeroutput>, which 716 cannot be changed. 722 717 </para> 723 718 </listitem> … … 725 720 <listitem> 726 721 <para> 727 Builds and installs the VirtualBoxkernel modules:722 Builds and installs the &product-name; kernel modules: 728 723 <computeroutput>vboxdrv</computeroutput>, 729 724 <computeroutput>vboxnetflt</computeroutput>, and … … 735 730 <para> 736 731 Creates <computeroutput>/sbin/rcvboxdrv</computeroutput>, 737 an init script to start the VirtualBoxkernel module.732 an init script to start the &product-name; kernel module. 738 733 </para> 739 734 </listitem> … … 753 748 <computeroutput>/opt/VirtualBox/VBox</computeroutput> 754 749 which does some sanity checks and dispatches to the actual 755 executables: <computeroutput>VirtualBox</computeroutput>, 756 <computeroutput>VBoxSDL</computeroutput>, 757 <computeroutput>VBoxVRDP</computeroutput>, 758 <computeroutput>VBoxHeadless</computeroutput> and 759 <computeroutput>VBoxManage</computeroutput> 750 executables: <command>VirtualBox</command>, 751 <command>VBoxVRDP</command>, 752 <command>VBoxHeadless</command> and 753 <command>VBoxManage</command>. 760 754 </para> 761 755 </listitem> … … 784 778 <computeroutput>install</computeroutput> or 785 779 <computeroutput>uninstall</computeroutput> as the first 786 parameter. For example ;780 parameter. For example: 787 781 </para> 788 782 … … 790 784 791 785 <para> 792 Or if you do not have the 793 <computeroutput>sudo</computeroutput> command available, run794 the following as root instead:786 Or if you do not have the <command>sudo</command> command 787 available, run the following as root instead: 788 </para> 795 789 796 790 <screen>./VirtualBox.run install</screen> 797 </para>798 791 799 792 <para> … … 808 801 <note> 809 802 <para> 810 The <computeroutput>usermod</computeroutput> command of some 811 older Linux distributions does not support the 812 <computeroutput>-a</computeroutput> option, which adds the 813 user to the given group without affecting membership of 814 other groups. In this case, find out the current group 815 memberships with the <computeroutput>groups</computeroutput> 816 command and add all these groups in a comma-separated list 817 to the command line after the 818 <computeroutput>-G</computeroutput> option. For example: 803 The <command>usermod</command> command of some older Linux 804 distributions does not support the <option>-a</option> 805 option, which adds the user to the given group without 806 affecting membership of other groups. In this case, find out 807 the current group memberships with the 808 <command>groups</command> command and add all these groups 809 in a comma-separated list to the command line after the 810 <option>-G</option> option. For example: 819 811 <computeroutput>usermod -G group1,group2,vboxusers 820 812 username</computeroutput>. … … 831 823 If you cannot use the shell script installer described in 832 824 <xref linkend="install-linux-alt-installer"/>, you can perform 833 a manual installation. Invokethe installer as follows:825 a manual installation. Run the installer as follows: 834 826 </para> 835 827 … … 839 831 This will unpack all the files needed for installation in the 840 832 directory <computeroutput>install</computeroutput> under the 841 current directory. The VirtualBoxapplication files are833 current directory. The &product-name; application files are 842 834 contained in 843 835 <computeroutput>VirtualBox.tar.bz2</computeroutput> which you … … 849 841 850 842 <para> 851 or as root: 843 To run the same example as root, use the following commands: 844 </para> 852 845 853 846 <screen>mkdir /opt/VirtualBox 854 847 tar jxf ./install/VirtualBox.tar.bz2 -C /opt/VirtualBox</screen> 855 </para> 856 857 <para> 858 The sources for VirtualBox's kernel module are provided in the 848 849 <para> 850 The sources for &product-name;'s kernel module are provided in the 859 851 <computeroutput>src</computeroutput> directory. To build the 860 module, change to the directory and issue852 module, change to the directory and use the following command: 861 853 </para> 862 854 … … 864 856 865 857 <para> 866 If everything builds correctly, issuethe following command to858 If everything builds correctly, run the following command to 867 859 install the module to the appropriate module directory: 868 860 </para> … … 873 865 In case you do not have sudo, switch the user account to root 874 866 and run the following command: 867 </para> 875 868 876 869 <screen>make install</screen> 877 </para> 878 879 <para> 880 The VirtualBox kernel module needs a device node to operate. 881 The above make command will tell you how to create the device 882 node, depending on your Linux system. The procedure is 883 slightly different for a classical Linux setup with a 884 <computeroutput>/dev</computeroutput> directory, a system with 885 the now deprecated <computeroutput>devfs</computeroutput> and 886 a modern Linux system with 887 <computeroutput>udev</computeroutput>. 870 871 <para> 872 The &product-name; kernel module needs a device node to operate. 873 The above <command>make</command> command will tell you how to 874 create the device node, depending on your Linux system. The 875 procedure is slightly different for a classical Linux setup 876 with a <computeroutput>/dev</computeroutput> directory, a 877 system with the now deprecated <command>devfs</command> and a 878 modern Linux system with <command>udev</command>. 888 879 </para> 889 880 … … 906 897 kernel module and activate the initialization script using the 907 898 right method for your distribution, as follows: 899 </para> 908 900 909 901 <screen>cp /opt/VirtualBox/vboxdrv.sh /sbin/rcvboxdrv</screen> 910 902 911 This example assumes you installed VirtualBox to the 903 <para> 904 This example assumes you installed &product-name; to the 912 905 <computeroutput>/opt/VirtualBox</computeroutput> directory. 913 Create a configuration file for VitrualBox: 906 </para> 907 908 <para> 909 Create a configuration file for &product-name;, as follows: 910 </para> 914 911 915 912 <screen>mkdir /etc/vbox 916 913 echo INSTALL_DIR=/opt/VirtualBox > /etc/vbox/vbox.cfg</screen> 917 914 915 <para> 918 916 Create the following symbolic links: 919 917 </para> … … 921 919 <screen>ln -sf /opt/VirtualBox/VBox.sh /usr/bin/VirtualBox 922 920 ln -sf /opt/VirtualBox/VBox.sh /usr/bin/VBoxManage 923 ln -sf /opt/VirtualBox/VBox.sh /usr/bin/VBoxHeadless 924 ln -sf /opt/VirtualBox/VBox.sh /usr/bin/VBoxSDL</screen> 921 ln -sf /opt/VirtualBox/VBox.sh /usr/bin/VBoxHeadless</screen> 925 922 926 923 </sect3> … … 928 925 <sect3 id="install-linux-update-uninstall"> 929 926 930 <title>Updating and Uninstalling VirtualBox</title>931 932 <para> 933 Before updating or uninstalling VirtualBox, you must terminate927 <title>Updating and Uninstalling &product-name;</title> 928 929 <para> 930 Before updating or uninstalling &product-name;, you must terminate 934 931 any virtual machines which are currently running and exit the 935 VirtualBox or VBoxSVC applications. To update VirtualBox,932 &product-name; or VBoxSVC applications. To update &product-name;, 936 933 simply run the installer of the updated version. To uninstall 937 VirtualBox, invoke the installer like this: 934 &product-name;, run the installer as follows: 935 </para> 938 936 939 937 <screen>sudo ./VirtualBox.run uninstall</screen> 940 938 941 or as root: 939 <para> 940 As root, you can use the following command: 941 </para> 942 942 943 943 <screen>./VirtualBox.run uninstall</screen> 944 944 945 Starting with version 2.2.2, you can uninstall the .run 946 package as follows: 945 <para> 946 You can uninstall the .run package as follows: 947 </para> 947 948 948 949 <screen>/opt/VirtualBox/uninstall.sh</screen> 949 950 950 To manually uninstall VirtualBox, simply perform the manual 951 <para> 952 To manually uninstall &product-name;, perform the manual 951 953 installation steps in reverse order. 952 954 </para> … … 965 967 <computeroutput>vboxconf</computeroutput> can contain the 966 968 following debconf settings: 969 </para> 967 970 968 971 <screen>virtualbox virtualbox/module-compilation-allowed boolean true 969 972 virtualbox virtualbox/delete-old-modules boolean true</screen> 970 973 971 The first line allows compilation of the vboxdrv kernel module 972 if no module was found for the current kernel. The second line 973 allows the package to delete any old vboxdrv kernel modules 974 compiled by previous installations. 974 <para> 975 The first line enables compilation of the vboxdrv kernel 976 module if no module was found for the current kernel. The 977 second line enables the package to delete any old vboxdrv 978 kernel modules compiled by previous installations. 975 979 </para> 976 980 977 981 <para> 978 982 These default settings can be applied prior to the 979 installation of the VirtualBoxDebian package, as follows:983 installation of the &product-name; Debian package, as follows: 980 984 </para> 981 985 … … 1000 1004 <xref 1001 1005 linkend="linux_install_opts" /> for how to set 1002 some common installation options provided by VirtualBox.1006 some common installation options provided by &product-name;. 1003 1007 </para> 1004 1008 … … 1013 1017 packages, you can create a response file named 1014 1018 <computeroutput>/etc/default/virtualbox</computeroutput>. The 1015 automatic generation of the udev rule can be prevented by the 1016 following setting: 1019 automatic generation of the udev rule can be prevented with 1020 the following setting: 1021 </para> 1017 1022 1018 1023 <screen>INSTALL_NO_UDEV=1</screen> 1019 1024 1025 <para> 1020 1026 The creation of the group vboxusers can be prevented as 1021 1027 follows: 1028 </para> 1022 1029 1023 1030 <screen>INSTALL_NO_GROUP=1</screen> 1024 1031 1032 <para> 1025 1033 If the following line is specified, the package installer will 1026 1034 not try to build the <computeroutput>vboxdrv</computeroutput> … … 1042 1050 The Linux installers create the system user group 1043 1051 <computeroutput>vboxusers</computeroutput> during installation. 1044 Any system user who is going to use USB devices from VirtualBox1052 Any system user who is going to use USB devices from &product-name; 1045 1053 guests must be a member of that group. A user can be made a 1046 1054 member of the group <computeroutput>vboxusers</computeroutput> … … 1055 1063 <sect2 id="startingvboxonlinux"> 1056 1064 1057 <title>Starting VirtualBox on Linux</title> 1058 1059 <para> 1060 The easiest way to start a VirtualBox program is by running the 1061 program of your choice 1062 (<computeroutput>VirtualBox</computeroutput>, 1063 <computeroutput>VBoxManage</computeroutput>, 1064 <computeroutput>VBoxSDL</computeroutput>, or 1065 <computeroutput>VBoxHeadless</computeroutput>) from a terminal. 1066 These are symbolic links to 1067 <computeroutput>VBox.sh</computeroutput> that start the required 1068 program for you. 1065 <title>Starting &product-name; on Linux</title> 1066 1067 <para> 1068 The easiest way to start a &product-name; program is by running the 1069 program of your choice (<command>VirtualBox</command>, 1070 <command>VBoxManage</command>, or 1071 <command>VBoxHeadless</command>) from a terminal. These are 1072 symbolic links to <command>VBox.sh</command> that start the 1073 required program for you. 1069 1074 </para> 1070 1075 1071 1076 <para> 1072 1077 The following detailed instructions should only be of interest 1073 if you wish to execute VirtualBoxwithout installing it first.1078 if you wish to execute &product-name; without installing it first. 1074 1079 You should start by compiling the 1075 1080 <computeroutput>vboxdrv</computeroutput> kernel module and 1076 inserting it into the Linux kernel. VirtualBoxconsists of a1081 inserting it into the Linux kernel. &product-name; consists of a 1077 1082 service daemon, <computeroutput>VBoxSVC</computeroutput>, and 1078 1083 several application programs. The daemon is automatically 1079 started if necessary. All VirtualBoxapplications will1080 communicate with the daemon through U nixlocal domain sockets.1084 started if necessary. All &product-name; applications will 1085 communicate with the daemon through UNIX local domain sockets. 1081 1086 There can be multiple daemon instances under different user 1082 1087 accounts and applications can only communicate with the daemon … … 1090 1095 1091 1096 <para> 1092 All VirtualBox applications 1093 (<computeroutput>VirtualBox</computeroutput>, 1094 <computeroutput>VBoxSDL</computeroutput>, 1095 <computeroutput>VBoxManage</computeroutput>, and 1096 <computeroutput>VBoxHeadless</computeroutput>) require the 1097 VirtualBox directory to be in the library path, as follows: 1097 All &product-name; applications (<command>VirtualBox</command>, 1098 <command>VBoxManage</command>, and 1099 <command>VBoxHeadless</command>) require the &product-name; 1100 directory to be in the library path, as follows: 1098 1101 </para> 1099 1102 … … 1106 1109 <sect1 id="install-solaris-host"> 1107 1110 1108 <title>Installing on Solaris Hosts</title>1111 <title>Installing on Oracle Solaris Hosts</title> 1109 1112 1110 1113 <para> 1111 For the specific versions of Solaris that are supported as host1114 For the specific versions of Oracle Solaris that are supported as host 1112 1115 operating systems, see <xref 1113 1116 linkend="hostossupport" />. … … 1115 1118 1116 1119 <para> 1117 If you have a previously installed instance of VirtualBoxon your1118 Solaris host, please uninstall it first before installing a new1120 If you have a previously installed instance of &product-name; on your 1121 Oracle Solaris host, please uninstall it first before installing a new 1119 1122 instance. See <xref linkend="uninstall-solaris-host" /> for 1120 1123 uninstall instructions. … … 1126 1129 1127 1130 <para> 1128 VirtualBox is available as a standardSolaris package. Download1129 the VirtualBoxSunOS package which includes the 64-bit versions1130 of VirtualBox. <emphasis>The installation must be performed as1131 root and from the global zone</emphasis> as the VirtualBox1131 &product-name; is available as a standard Oracle Solaris package. Download 1132 the &product-name; SunOS package which includes the 64-bit versions 1133 of &product-name;. <emphasis>The installation must be performed as 1134 root and from the global zone</emphasis> as the &product-name; 1132 1135 installer loads kernel drivers which cannot be done from 1133 1136 non-global zones. To verify which zone you are currently in, 1134 execute the <com puteroutput>zonename</computeroutput> command.1135 Execute thefollowing commands:1137 execute the <command>zonename</command> command. Execute the 1138 following commands: 1136 1139 </para> 1137 1140 … … 1139 1142 1140 1143 <para> 1141 Starting with VirtualBox 3.1 the VirtualBox kernel package is no1142 longer a separate package and has been integrated into the main1143 package. Install the VirtualBoxpackage as follows:1144 The &product-name; kernel package is no longer a separate package 1145 and has been integrated into the main package. Install the 1146 &product-name; package as follows: 1144 1147 </para> 1145 1148 … … 1153 1156 script to be executed. Choose <emphasis role="bold">y</emphasis> 1154 1157 and proceed, as it is essential to execute this script which 1155 installs the VirtualBoxkernel module. Following this1156 confirmation the installer will install VirtualBoxand execute1158 installs the &product-name; kernel module. Following this 1159 confirmation the installer will install &product-name; and execute 1157 1160 the postinstall setup script. 1158 1161 </para> … … 1162 1165 is now complete. You may now safely delete the uncompressed 1163 1166 package and <computeroutput>autoresponse</computeroutput> files 1164 from your system. VirtualBoxis installed in1167 from your system. &product-name; is installed in 1165 1168 <computeroutput>/opt/VirtualBox</computeroutput>. 1166 1169 </para> … … 1168 1171 <note> 1169 1172 <para> 1170 If you need to use VirtualBoxfrom non-global zones, see1173 If you need to use &product-name; from non-global zones, see 1171 1174 <xref linkend="solaris-zones" />. 1172 1175 </para> … … 1180 1183 1181 1184 <para> 1182 Starting with VirtualBox 4.1, the installer creates the system 1183 user group <computeroutput>vboxuser</computeroutput> during 1184 installation for Solaris hosts that support the USB features 1185 required by VirtualBox. Any system user who is going to use USB 1186 devices from VirtualBox guests must be a member of this group. A 1187 user can be made a member of this group through the GUI 1188 user/group management or at the command line by executing as 1189 root: 1185 The installer creates the system user group 1186 <computeroutput>vboxuser</computeroutput> during installation 1187 for Oracle Solaris hosts that support the USB features required by 1188 &product-name;. Any system user who is going to use USB devices from 1189 &product-name; guests must be a member of this group. A user can be 1190 made a member of this group through the GUI user/group 1191 management or at the command line by executing as root: 1190 1192 </para> 1191 1193 … … 1202 1204 <sect2 id="install-solaris-starting"> 1203 1205 1204 <title>Starting VirtualBox on Solaris</title> 1205 1206 <para> 1207 The easiest way to start a VirtualBox program is by running the 1208 program of your choice 1209 (<computeroutput>VirtualBox</computeroutput>, 1210 <computeroutput>VBoxManage</computeroutput>, 1211 <computeroutput>VBoxSDL</computeroutput>, or 1212 <computeroutput>VBoxHeadless</computeroutput>) from a terminal. 1213 These are symbolic links to 1214 <computeroutput>VBox.sh</computeroutput> that start the required 1215 program for you. 1206 <title>Starting &product-name; on Oracle Solaris</title> 1207 1208 <para> 1209 The easiest way to start a &product-name; program is by running the 1210 program of your choice (<command>VirtualBox</command>, 1211 <command>VBoxManage</command>, or 1212 <command>VBoxHeadless</command>) from a terminal. These are 1213 symbolic links to <command>VBox.sh</command> that start the 1214 required program for you. 1216 1215 </para> 1217 1216 … … 1219 1218 Alternatively, you can directly invoke the required programs 1220 1219 from <computeroutput>/opt/VirtualBox</computeroutput>. Using the 1221 links provided is easier as you do not have to typethe full1220 links provided is easier as you do not have to enter the full 1222 1221 path. 1223 1222 </para> … … 1225 1224 <para> 1226 1225 You can configure some elements of the 1227 <computeroutput>VirtualBox</computeroutput> Qt GUI, such as 1228 fonts and colours, by running 1229 <computeroutput>VBoxQtconfig</computeroutput> from the terminal. 1226 <command>VirtualBox</command> Qt GUI, such as fonts and colours, 1227 by running <command>VBoxQtconfig</command> from the terminal. 1230 1228 </para> 1231 1229 … … 1237 1235 1238 1236 <para> 1239 Uninstallation of VirtualBox onSolaris requires root1237 Uninstallation of &product-name; on Oracle Solaris requires root 1240 1238 permissions. To perform the uninstallation, start a root 1241 1239 terminal session and run the following command: … … 1245 1243 1246 1244 <para> 1247 After confirmation, this will remove VirtualBoxfrom your1245 After confirmation, this will remove &product-name; from your 1248 1246 system. 1249 1247 </para> 1250 1248 1251 1249 <para> 1252 If you are uninstalling VirtualBoxversion 3.0 or lower, you1253 need to remove the VirtualBoxkernel interface package, as1250 If you are uninstalling &product-name; version 3.0 or lower, you 1251 need to remove the &product-name; kernel interface package, as 1254 1252 follows: 1255 1253 </para> 1256 1254 1257 <para>1258 1255 <screen>pkgrm SUNWvboxkern</screen> 1259 </para>1260 1256 1261 1257 </sect2> … … 1266 1262 1267 1263 <para> 1268 To perform a non-interactive installation of VirtualBoxthere is1264 To perform a non-interactive installation of &product-name; there is 1269 1265 a response file named 1270 1266 <computeroutput>autoresponse</computeroutput>, that the … … 1292 1288 <sect2 id="solaris-zones"> 1293 1289 1294 <title>Configuring a Zone for Running VirtualBox</title>1295 1296 <para> 1297 Assuming that VirtualBoxhas already been installed into your1298 zone, you need to give the zone access to VirtualBox's device1290 <title>Configuring a Zone for Running &product-name;</title> 1291 1292 <para> 1293 Assuming that &product-name; has already been installed into your 1294 zone, you need to give the zone access to &product-name;'s device 1299 1295 node. This is done by performing the following steps. Start a 1300 1296 root terminal and run the following command: … … 1305 1301 <para> 1306 1302 Replace "vboxzone" with the name of the zone where you intend to 1307 run VirtualBox.1303 run &product-name;. 1308 1304 </para> 1309 1305 … … 1324 1320 1325 1321 <para> 1326 If you are running VirtualBox 2.2.0 or above onSolaris 11 or1322 If you are running &product-name; 2.2.0 or above on Oracle Solaris 11 or 1327 1323 above, you may also add a device for 1328 1324 <computeroutput>/dev/vboxusbmon</computeroutput>, similar to 1329 that shown above. This does not apply to Solaris 10 hosts, due1325 that shown above. This does not apply to Oracle Solaris 10 hosts, due 1330 1326 to lack of USB support. 1331 1327 </para> … … 1349 1345 <para> 1350 1346 Reboot the zone using <computeroutput>zoneadm</computeroutput> 1351 and you should be able to run VirtualBoxfrom within the1347 and you should be able to run &product-name; from within the 1352 1348 configured zone. 1353 1349 </para> -
trunk/doc/manual/en_US/user_Introduction.xml
r73276 r76078 10 10 11 11 <para> 12 Welcome to Oracle VM VirtualBox.12 Welcome to &product-name;. 13 13 </para> 14 14 15 15 <para> 16 VirtualBox is a cross-platform virtualization application. What does17 that mean? For one thing, it installs on your existing Intel or16 &product-name; is a cross-platform virtualization application. What 17 does that mean? For one thing, it installs on your existing Intel or 18 18 AMD-based computers, whether they are running Windows, Mac, Linux or 19 Solaris operating systems. Secondly, it extends the capabilities of20 your existing computer so that it can run multiple operating21 systems, inside multiple virtual machines, at the same time. So, for22 example, you can run Windows and Linux on your Mac, run Windows23 Server 2008 on your Linux server, run Linux on your Windows PC, and24 so on, all alongside your existing applications. You can install and25 run as many virtual machines as you like. The only practical limits26 are disk space and memory.19 Oracle Solaris operating systems. Secondly, it extends the 20 capabilities of your existing computer so that it can run multiple 21 operating systems, inside multiple virtual machines, at the same 22 time. So, for example, you can run Windows and Linux on your Mac, 23 run Windows Server 2008 on your Linux server, run Linux on your 24 Windows PC, and so on, all alongside your existing applications. You 25 can install and run as many virtual machines as you like. The only 26 practical limits are disk space and memory. 27 27 </para> 28 28 29 29 <para> 30 VirtualBox is deceptively simple yet also very powerful. It can run 31 everywhere from small embedded systems or desktop class machines all 32 the way up to datacenter deployments and even Cloud environments. 30 &product-name; is deceptively simple yet also very powerful. It can 31 run everywhere from small embedded systems or desktop class machines 32 all the way up to datacenter deployments and even Cloud 33 environments. 33 34 </para> 34 35 35 36 <para> 36 The following screenshot shows how VirtualBox, installed on a Mac37 computer, is running Windows 8 in a virtual machine window:37 The following screenshot shows how &product-name;, installed on a 38 Mac computer, is running Windows 8 in a virtual machine window: 38 39 </para> 39 40 40 <mediaobject> 41 <imageobject> 42 <imagedata align="center" fileref="images/vm-vista-running.png" 41 <figure id="fig-win8-intro"> 42 <title>Windows 8 Virtual Machine, Displayed on a Mac OS X Host</title> 43 <mediaobject> 44 <imageobject> 45 <imagedata align="center" fileref="images/vm-vista-running.png" 43 46 width="14cm" /> 44 </imageobject> 45 </mediaobject> 47 </imageobject> 48 </mediaobject> 49 </figure> 46 50 47 51 <para> 48 52 In this User Manual, we will begin simply with a quick introduction 49 53 to virtualization and how to get your first virtual machine running 50 with the easy-to-use VirtualBox graphical user interface. Subsequent51 chapters will go into much more detail covering more powerful tools52 and features, but fortunately, it is not necessary to read the53 entire User Manual before you can use VirtualBox.54 with the easy-to-use &product-name; graphical user interface. 55 Subsequent chapters will go into much more detail covering more 56 powerful tools and features, but fortunately, it is not necessary to 57 read the entire User Manual before you can use &product-name;. 54 58 </para> 55 59 56 60 <para> 57 You can find a summary of VirtualBox's capabilities in 58 <xref 59 linkend="features-overview" />. For existing VirtualBox 60 users who just want to see what is new in this release, there is a 61 detailed list in <xref 62 linkend="ChangeLog" />. 61 You can find a summary of &product-name;'s capabilities in 62 <xref linkend="features-overview" />. For existing &product-name; 63 users who just want to find out what is new in this release, see the 64 <emphasis>&product-name; Release Notes</emphasis>. 63 65 </para> 64 66 … … 68 70 69 71 <para> 70 The techniques and features that VirtualBox provides are useful in71 the following scenarios:72 The techniques and features that &product-name; provides are 73 useful in the following scenarios: 72 74 </para> 73 75 … … 77 79 <para> 78 80 <emphasis role="bold">Running multiple operating systems 79 simultaneously.</emphasis> VirtualBox allows you to run more80 than one operating system at a time. This way, you can run81 software written for one operating system on another, such as82 Windows software on Linux or a Mac, without having to reboot83 to use it. Since you can configure what kinds of "virtual"84 hardware should be presented to each such operating system,85 you can install an old operating system such as DOS or OS/286 even if your real computer's hardware is no longer supported87 by that operating system.81 simultaneously.</emphasis> &product-name; enables you to run 82 more than one operating system at a time. This way, you can 83 run software written for one operating system on another, such 84 as Windows software on Linux or a Mac, without having to 85 reboot to use it. Since you can configure what kinds of 86 <emphasis>virtual</emphasis> hardware should be presented to 87 each such operating system, you can install an old operating 88 system such as DOS or OS/2 even if your real computer's 89 hardware is no longer supported by that operating system. 88 90 </para> 89 91 </listitem> … … 95 97 machines to ship entire software configurations. For example, 96 98 installing a complete mail server solution on a real machine 97 can be a tedious task. With VirtualBox, such a complex setup, 98 often called an "appliance", can be packed into a virtual 99 machine. Installing and running a mail server becomes as easy 100 as importing such an appliance into VirtualBox. 99 can be a tedious task. With &product-name;, such a complex 100 setup, often called an <emphasis>appliance</emphasis>, can be 101 packed into a virtual machine. Installing and running a mail 102 server becomes as easy as importing such an appliance into 103 &product-name;. 101 104 </para> 102 105 </listitem> … … 106 109 <emphasis role="bold">Testing and disaster 107 110 recovery.</emphasis> Once installed, a virtual machine and its 108 virtual hard disks can be considered a "container" that can be109 arbitrarily frozen, woken up, copied, backed up, and110 transported between hosts.111 </para> 112 113 <para> 114 On top of that, with the use of another VirtualBoxfeature115 called "snapshots", one can save a particular state ofa116 virtual machine and revert back to that state, if necessary.117 This way, one can freely experiment with a computing118 environment. If something goes wrong , such as prolems after119 installing software or infecting the guest with a virus, you120 can easily switch back to a previous snapshot and avoid the121 need of frequent backups and restores.111 virtual hard disks can be considered a 112 <emphasis>container</emphasis> that can be arbitrarily frozen, 113 woken up, copied, backed up, and transported between hosts. 114 </para> 115 116 <para> 117 On top of that, with the use of another &product-name; feature 118 called <emphasis>snapshots</emphasis>, one can save a 119 particular state of a virtual machine and revert back to that 120 state, if necessary. This way, one can freely experiment with 121 a computing environment. If something goes wrong, such as 122 prolems after installing software or infecting the guest with 123 a virus, you can easily switch back to a previous snapshot and 124 avoid the need of frequent backups and restores. 122 125 </para> 123 126 … … 164 167 <emphasis role="strong">Host operating system (host 165 168 OS).</emphasis> This is the operating system of the physical 166 computer on which VirtualBox was installed. There are versions167 of VirtualBox for Windows, Mac OS X, Linux and Solaris hosts.168 See <xref linkend="hostossupport" />.169 </para> 170 171 <para> 172 Most of the time, this manual discusses all VirtualBox169 computer on which &product-name; was installed. There are 170 versions of &product-name; for Windows, Mac OS X, Linux, and 171 Oracle Solaris hosts. See <xref linkend="hostossupport" />. 172 </para> 173 174 <para> 175 Most of the time, this manual discusses all &product-name; 173 176 versions together. There may be platform-specific differences 174 177 which we will point out where appropriate. … … 180 183 <emphasis role="strong"> Guest operating system (guest 181 184 OS).</emphasis> This is the operating system that is running 182 inside the virtual machine. Theoretically, VirtualBox can run183 any x86 operating system. such as DOS, Windows, OS/2, FreeBSD,184 and OpenBSD. But to achieve near-native performance of the185 guest code on your machine, we had to go through a lot of186 o ptimizations that are specific to certain operating systems.187 So while your favorite operating system185 inside the virtual machine. Theoretically, &product-name; can 186 run any x86 operating system. such as DOS, Windows, OS/2, 187 FreeBSD, and OpenBSD. But to achieve near-native performance 188 of the guest code on your machine, we had to go through a lot 189 of optimizations that are specific to certain operating 190 systems. So while your favorite operating system 188 191 <emphasis>may</emphasis> run as a guest, we officially support 189 192 and optimize for a select few, which include the most common … … 199 202 <para> 200 203 <emphasis role="strong">Virtual machine (VM).</emphasis> This 201 is the special environment that VirtualBox creates for your202 guest operating system while it is running. In other words,203 you run your guest operating system "in" a VM. Normally, a VM204 will be shown as a window on your computer's desktop, but205 depending on which of the various frontends of VirtualBox you206 use, it can be displayed in full screen mode or remotely on207 another computer.208 </para> 209 210 <para> 211 In a more abstract way, internally, VirtualBox thinks of a VM212 as a set of parameters that determine its behavior. They204 is the special environment that &product-name; creates for 205 your guest operating system while it is running. In other 206 words, you run your guest operating system 207 <emphasis>in</emphasis> a VM. Normally, a VM will be shown as 208 a window on your computer's desktop, but depending on which of 209 the various frontends of &product-name; you use, it can be 210 displayed in full screen mode or remotely on another computer. 211 </para> 212 213 <para> 214 In a more abstract way, internally, &product-name; thinks of a 215 VM as a set of parameters that determine its behavior. They 213 216 include hardware settings, such as: how much memory the VM 214 should have, what hard disks VirtualBoxshould virtualize217 should have, what hard disks &product-name; should virtualize 215 218 through which container files, what CDs are mounted. They also 216 219 include state information, such as: whether the VM is 217 220 currently running, saved, if the VM has snapshots. These 218 settings are mirrored in the VirtualBox Manager window as well 219 as the <computeroutput>VBoxManage</computeroutput> command 220 line program. See <xref linkend="vboxmanage" />. In other 221 words, a VM is also what you can see in its settings dialog. 221 settings are mirrored in the VirtualBox Manager window, as 222 well as the <command>VBoxManage</command> command. See 223 <xref linkend="vboxmanage" />. In other words, a VM is also 224 what you can see in its 225 <emphasis role="bold">Settings</emphasis> dialog. 222 226 </para> 223 227 </listitem> … … 227 231 <emphasis role="strong">Guest Additions.</emphasis> This 228 232 refers to special software packages which are shipped with 229 VirtualBoxbut designed to be installed233 &product-name; but designed to be installed 230 234 <emphasis>inside</emphasis> a VM to improve performance of the 231 235 guest OS and to add extra features. See 232 <xref 233 linkend="guestadditions" />. 236 <xref linkend="guestadditions" />. 234 237 </para> 235 238 </listitem> … … 244 247 245 248 <para> 246 The following is a brief outline of VirtualBox's main features: 249 The following is a brief outline of &product-name;'s main 250 features: 247 251 </para> 248 252 … … 251 255 <listitem> 252 256 <para> 253 <emphasis role="bold">Portability.</emphasis> VirtualBox runs254 on a large number of 32-bit and 64-bit host operating systems255 See <xref linkend="hostossupport" />.256 </para> 257 258 <para> 259 VirtualBoxis a so-called <emphasis>hosted</emphasis>257 <emphasis role="bold">Portability.</emphasis> &product-name; 258 runs on a large number of 32-bit and 64-bit host operating 259 systems See <xref linkend="hostossupport" />. 260 </para> 261 262 <para> 263 &product-name; is a so-called <emphasis>hosted</emphasis> 260 264 hypervisor, sometimes referred to as a <emphasis>type 261 265 2</emphasis> hypervisor. Whereas a 262 266 <emphasis>bare-metal</emphasis> or <emphasis>type 1</emphasis> 263 hypervisor would run directly on the hardware, VirtualBox267 hypervisor would run directly on the hardware, &product-name; 264 268 requires an existing operating system to be installed. It can 265 269 thus run alongside existing applications on that host. … … 267 271 268 272 <para> 269 To a very large degree, VirtualBox is functionally identical270 on all of the host platforms, and the same file and image271 formats are used. This allows you to run virtual machines272 created on one host on another host with a different host273 operating system. For example, you can create a virtual273 To a very large degree, &product-name; is functionally 274 identical on all of the host platforms, and the same file and 275 image formats are used. This enables you to run virtual 276 machines created on one host on another host with a different 277 host operating system. For example, you can create a virtual 274 278 machine on Windows and then run it under Linux. 275 279 </para> … … 280 284 industry standard created for this purpose. You can even 281 285 import OVFs that were created with a different virtualization 282 software. See <xref 283 linkend="ovf" />. 286 software. See <xref linkend="ovf" />. 284 287 </para> 285 288 </listitem> … … 288 291 <para> 289 292 <emphasis role="bold">No hardware virtualization 290 required.</emphasis> For many scenarios, VirtualBox does not291 require the processor features built into newer hardware like292 Intel VT-x or AMD-V. As opposed to many other virtualization293 solutions, you can therefore use VirtualBox even on older294 hardware where these features are not present. See295 <xref293 required.</emphasis> For many scenarios, &product-name; does 294 not require the processor features built into newer hardware 295 like Intel VT-x or AMD-V. As opposed to many other 296 virtualization solutions, you can therefore use &product-name; 297 even on older hardware where these features are not present. 298 See <xref 296 299 linkend="hwvirt" />. 297 300 </para> … … 301 304 <para> 302 305 <emphasis role="bold">Guest Additions: shared folders, 303 seamless windows, 3D virtualization.</emphasis> The VirtualBox304 Guest Additions are software packages which can be installed305 <emphasis>inside</emphasis> of supported guest systems to306 improve their performance and to provide additional306 seamless windows, 3D virtualization.</emphasis> The 307 &product-name; Guest Additions are software packages which can 308 be installed <emphasis>inside</emphasis> of supported guest 309 systems to improve their performance and to provide additional 307 310 integration and communication with the host system. After 308 311 installing the Guest Additions, a virtual machine will support 309 312 automatic adjustment of video resolutions, seamless windows, 310 313 accelerated 3D graphics and more. See 311 <xref 312 linkend="guestadditions" />. 314 <xref linkend="guestadditions" />. 313 315 </para> 314 316 … … 316 318 In particular, Guest Additions provide for "shared folders", 317 319 which let you access files from the host system from within a 318 guest machine. See <xref 319 linkend="sharedfolders" />. 320 guest machine. See <xref linkend="sharedfolders" />. 320 321 </para> 321 322 </listitem> … … 324 325 <para> 325 326 <emphasis role="bold">Great hardware support.</emphasis> Among 326 others, VirtualBoxsupports the following:327 others, &product-name; supports the following: 327 328 </para> 328 329 … … 332 333 <para> 333 334 <emphasis role="bold">Guest multiprocessing 334 (SMP).</emphasis> VirtualBox can present up to 32 virtual335 CPUs to each virtual machine, irrespective of how many CPU336 cores are physically present on your host.335 (SMP).</emphasis> &product-name; can present up to 32 336 virtual CPUs to each virtual machine, irrespective of how 337 many CPU cores are physically present on your host. 337 338 </para> 338 339 </listitem> … … 341 342 <para> 342 343 <emphasis role="bold">USB device support.</emphasis> 343 VirtualBox implements a virtual USB controller and allows344 you to connect arbitrary USB devices to your virtual345 machines without having to install device-specific drivers346 on the host. USB support is not limited to certain device347 categories. See <xref linkend="settings-usb" />.344 &product-name; implements a virtual USB controller and 345 enables you to connect arbitrary USB devices to your 346 virtual machines without having to install device-specific 347 drivers on the host. USB support is not limited to certain 348 device categories. See <xref linkend="settings-usb" />. 348 349 </para> 349 350 </listitem> … … 352 353 <para> 353 354 <emphasis role="bold">Hardware compatibility.</emphasis> 354 VirtualBox virtualizes a vast array of virtual devices,355 among them many devices that are typically provided by356 other virtualization platforms. That includes IDE, SCSI357 and SATA hard disk controllers, several virtual network358 cards and sound cards, virtual serial and parallel ports359 and an Input/Output Advanced Programmable Interrupt355 &product-name; virtualizes a vast array of virtual 356 devices, among them many devices that are typically 357 provided by other virtualization platforms. That includes 358 IDE, SCSI and SATA hard disk controllers, several virtual 359 network cards and sound cards, virtual serial and parallel 360 ports and an Input/Output Advanced Programmable Interrupt 360 361 Controller (I/O APIC), which is found in many modern PC 361 362 systems. This eases cloning of PC images from real 362 363 machines and importing of third-party virtual machines 363 into VirtualBox.364 into &product-name;. 364 365 </para> 365 366 </listitem> … … 369 370 <emphasis role="bold">Full ACPI support.</emphasis> The 370 371 Advanced Configuration and Power Interface (ACPI) is fully 371 supported by VirtualBox. This eases cloning of PC images372 from real machines or third-party virtual machines into373 VirtualBox. With its unique <emphasis>ACPI power status374 s upport</emphasis>, VirtualBox can even report to375 ACPI-aware guest operating systems the power status of the376 host. For mobile systems running on battery, the guest can377 thus enable energy saving and notify the user of the372 supported by &product-name;. This eases cloning of PC 373 images from real machines or third-party virtual machines 374 into &product-name;. With its unique <emphasis>ACPI power 375 status support</emphasis>, &product-name; can even report 376 to ACPI-aware guest operating systems the power status of 377 the host. For mobile systems running on battery, the guest 378 can thus enable energy saving and notify the user of the 378 379 remaining power, for example in full screen modes. 379 380 </para> … … 383 384 <para> 384 385 <emphasis role="bold">Multiscreen resolutions.</emphasis> 385 VirtualBoxvirtual machines support screen resolutions386 &product-name; virtual machines support screen resolutions 386 387 many times that of a physical screen, allowing them to be 387 388 spread over a large number of screens attached to the host … … 393 394 <para> 394 395 <emphasis role="bold">Built-in iSCSI support.</emphasis> 395 This unique feature allows you to connect a virtual396 This unique feature enables you to connect a virtual 396 397 machine directly to an iSCSI storage server without going 397 398 through the host system. The VM accesses the iSCSI target 398 399 directly without the extra overhead that is required for 399 400 virtualizing hard disks in container files. See 400 <xref 401 linkend="storage-iscsi" />. 401 <xref linkend="storage-iscsi" />. 402 402 </para> 403 403 </listitem> … … 406 406 <para> 407 407 <emphasis role="bold">PXE Network boot.</emphasis> The 408 integrated virtual network cards of VirtualBoxfully409 support remote booting viathe Preboot Execution408 integrated virtual network cards of &product-name; fully 409 support remote booting using the Preboot Execution 410 410 Environment (PXE). 411 411 </para> … … 418 418 <para> 419 419 <emphasis role="bold">Multigeneration branched 420 snapshots.</emphasis> VirtualBox can save arbitrary snapshots421 of the state of the virtual machine. You can go back in time422 and revert the virtual machine to any such snapshot and start423 an alternative VM configuration from there, effectively424 creating a whole snapshot tree. See420 snapshots.</emphasis> &product-name; can save arbitrary 421 snapshots of the state of the virtual machine. You can go back 422 in time and revert the virtual machine to any such snapshot 423 and start an alternative VM configuration from there, 424 effectively creating a whole snapshot tree. See 425 425 <xref linkend="snapshots" />. You can create and delete 426 426 snapshots while the virtual machine is running. … … 430 430 <listitem> 431 431 <para> 432 <emphasis role="bold">VM groups.</emphasis> VirtualBox432 <emphasis role="bold">VM groups.</emphasis> &product-name; 433 433 provides a groups feature that enables the user to organize 434 434 and control virtual machines collectively, as well as … … 439 439 groups are the same as those that can be applied to individual 440 440 VMs: Start, Pause, Reset, Close (Save state, Send Shutdown, 441 Poweroff), Discard Saved State, Show in fileSystem, Sort.442 </para> 443 </listitem> 444 445 <listitem> 446 <para> 447 <emphasis role="bold">Clean architecture ;unprecedented448 modularity.</emphasis> VirtualBoxhas an extremely modular441 Poweroff), Discard Saved State, Show in File System, Sort. 442 </para> 443 </listitem> 444 445 <listitem> 446 <para> 447 <emphasis role="bold">Clean architecture and unprecedented 448 modularity.</emphasis> &product-name; has an extremely modular 449 449 design with well-defined internal programming interfaces and a 450 450 clean separation of client and server code. This makes it easy 451 451 to control it from several interfaces at once. For example, 452 452 you can start a VM simply by clicking on a button in the 453 VirtualBoxgraphical user interface and then control that453 &product-name; graphical user interface and then control that 454 454 machine from the command line, or even remotely. See 455 455 <xref linkend="frontends" />. … … 457 457 458 458 <para> 459 Due to its modular architecture, VirtualBox can also expose460 its full functionality and configurability through a459 Due to its modular architecture, &product-name; can also 460 expose its full functionality and configurability through a 461 461 comprehensive <emphasis role="bold">software development kit 462 (SDK),</emphasis> which allows for integrating every aspect of463 VirtualBoxwith other software systems. See462 (SDK),</emphasis> which enables integration of &product-name; 463 with other software systems. See 464 464 <xref linkend="VirtualBoxAPI" />. 465 465 </para> … … 469 469 <para> 470 470 <emphasis role="bold">Remote machine display.</emphasis> The 471 VirtualBox Remote Desktop Extension (VRDE) allows for471 VirtualBox Remote Desktop Extension (VRDE) enables 472 472 high-performance remote access to any running virtual machine. 473 473 This extension supports the Remote Desktop Protocol (RDP) … … 478 478 <para> 479 479 The VRDE does not rely on the RDP server that is built into 480 Microsoft Windows ; instead, it is plugged directly into the481 virtualization layer. As a result, it works with guest480 Microsoft Windows. Instead, the VRDE is plugged directly into 481 the virtualization layer. As a result, it works with guest 482 482 operating systems other than Windows, even in text mode, and 483 483 does not require application support in the virtual machine … … 487 487 488 488 <para> 489 On top of this special capacity, VirtualBox offers you more490 unique features:489 On top of this special capacity, &product-name; offers you 490 more unique features: 491 491 </para> 492 492 … … 496 496 <para> 497 497 <emphasis role="bold">Extensible RDP 498 authentication.</emphasis> VirtualBoxalready supports498 authentication.</emphasis> &product-name; already supports 499 499 Winlogon on Windows and PAM on Linux for RDP 500 500 authentication. In addition, it includes an easy-to-use 501 SDK which allows you to create arbitrary interfaces for501 SDK which enables you to create arbitrary interfaces for 502 502 other methods of authentication. See 503 503 <xref linkend="vbox-auth" />. … … 507 507 <listitem> 508 508 <para> 509 <emphasis role="bold">USB over RDP.</emphasis> Via RDP 510 virtual channel support, VirtualBox also allows you to 511 connect arbitrary USB devices locally to a virtual machine 512 which is running remotely on a VirtualBox RDP server. See 513 <xref 514 linkend="usb-over-rdp" />. 509 <emphasis role="bold">USB over RDP.</emphasis> Using RDP 510 virtual channel support, &product-name; also enables you 511 to connect arbitrary USB devices locally to a virtual 512 machine which is running remotely on a &product-name; RDP 513 server. See <xref linkend="usb-over-rdp" />. 515 514 </para> 516 515 </listitem> … … 528 527 529 528 <para> 530 Currently, VirtualBoxruns on the following host operating529 Currently, &product-name; runs on the following host operating 531 530 systems: 532 531 </para> … … 537 536 <para> 538 537 <emphasis role="bold">Windows hosts:</emphasis> 539 540 <footnote>541 542 <para>543 Support for 64-bit Windows was added with VirtualBox 1.5.544 Support for Windows XP was removed with VirtualBox 5.0.545 Support for Windows Vista was removed with VirtualBox 5.2.546 </para>547 548 </footnote>549 538 </para> 550 539 … … 611 600 <para> 612 601 <emphasis role="bold">Mac OS X hosts (64-bit):</emphasis> 613 614 <footnote>615 616 <para>617 Preliminary Mac OS X support (beta stage) was added with618 VirtualBox 1.4, full support with 1.6. Mac OS X 10.4619 (Tiger) support was removed with VirtualBox 3.1. Support620 for Mac OS X 10.7 (Lion) and earlier was removed with621 VirtualBox 5.0. Support for Mac OS X 10.8 (Mountain Lion)622 was removed with VirtualBox 5.1. Support for Mac OS X 10.9623 (Mavericks) was removed with VirtualBox 5.2.624 </para>625 626 </footnote>627 602 </para> 628 603 … … 664 639 <listitem> 665 640 <para> 666 <emphasis role="bold">Linux hosts (32-bit and 64-bit). 667 Includes the following:</emphasis> 668 669 <footnote> 670 671 <para> 672 Support for 64-bit Linux was added with VirtualBox 1.4. 673 </para> 674 675 </footnote> 641 <emphasis role="bold">Linux hosts (32-bit and 642 64-bit).</emphasis> Includes the following: 676 643 </para> 677 644 … … 693 660 <listitem> 694 661 <para> 695 Oracle Enterprise Linux 5, Oracle Linux 6, and 7 662 Oracle Enterprise Linux 5, Oracle Linux 6, and Oracle 663 Linux 7 696 664 </para> 697 665 </listitem> … … 724 692 725 693 <para> 726 It should be possible to use VirtualBox on most systems based 727 on Linux kernel 2.6 or 3.x using either the VirtualBox 728 installer or by doing a manual installation. See 729 <xref linkend="install-linux-host" />. However, the formally 730 tested and supported Linux distributions are those for which 731 we offer a dedicated package. 732 </para> 733 734 <para> 735 Note that starting with VirtualBox 2.1, Linux 2.4-based host 736 operating systems are no longer supported. 737 </para> 738 </listitem> 739 740 <listitem> 741 <para> 742 <emphasis role="bold">Solaris hosts (64-bit only).</emphasis> 743 The following versions are supported with the restrictions 744 listed in <xref 745 linkend="KnownIssues" />: 694 It should be possible to use &product-name; on most systems 695 based on Linux kernel 2.6 or 3.x using either the 696 &product-name; installer or by doing a manual installation. 697 See <xref linkend="install-linux-host" />. However, the 698 formally tested and supported Linux distributions are those 699 for which we offer a dedicated package. 700 </para> 701 702 <para> 703 Note that Linux 2.4-based host operating systems are no longer 704 supported. 705 </para> 706 </listitem> 707 708 <listitem> 709 <para> 710 <emphasis role="bold">Oracle Solaris hosts (64-bit 711 only).</emphasis> The following versions are supported with 712 the restrictions listed in <xref linkend="KnownIssues" />: 746 713 </para> 747 714 … … 750 717 <listitem> 751 718 <para> 752 Solaris 11753 </para> 754 </listitem> 755 756 <listitem> 757 <para> 758 Solaris 10 (U10 and higher)719 Oracle Solaris 11 720 </para> 721 </listitem> 722 723 <listitem> 724 <para> 725 Oracle Solaris 10 8/11 and later 759 726 </para> 760 727 </listitem> … … 780 747 781 748 <para> 782 SSE2 is required starting with VirtualBoxversion 5.2.10 and749 SSE2 is required, starting with &product-name; version 5.2.10 and 783 750 version 5.1.24. 784 751 </para> … … 788 755 <sect1 id="intro-installing"> 789 756 790 <title>Installing VirtualBoxand Extension Packs</title>791 792 <para> 793 VirtualBoxcomes in many different packages, and installation757 <title>Installing &product-name; and Extension Packs</title> 758 759 <para> 760 &product-name; comes in many different packages, and installation 794 761 depends on your host operating system. If you have installed 795 762 software before, installation should be straightforward. On each 796 host platform, VirtualBoxuses the installation method that is763 host platform, &product-name; uses the installation method that is 797 764 most common and easy to use. If you run into trouble or have 798 765 special requirements, see <xref linkend="installation" /> for … … 801 768 802 769 <para> 803 Starting with version 4.0, VirtualBox is split into several 804 components: 805 </para> 806 807 <orderedlist> 808 809 <listitem> 810 <para> 811 The base package consists of all open source components and is 812 licensed under the GNU General Public License V2. 813 </para> 814 </listitem> 815 816 <listitem> 817 <para> 818 Additional extension packs can be downloaded which extend the 819 functionality of the VirtualBox base package. Currently, 770 &product-name; is split into the following components: 771 </para> 772 773 <itemizedlist> 774 775 <listitem> 776 <para> 777 <emphasis role="bold">Base package.</emphasis> The base 778 package consists of all open source components and is licensed 779 under the GNU General Public License V2. 780 </para> 781 </listitem> 782 783 <listitem> 784 <para> 785 <emphasis role="bold">Extension packs.</emphasis> Additional 786 extension packs can be downloaded which extend the 787 functionality of the &product-name; base package. Currently, 820 788 Oracle provides a single extension pack, available from: 821 789 <ulink … … 829 797 <para> 830 798 The virtual USB 2.0 (EHCI) device. See 831 <xref 832 linkend="settings-usb" />. 799 <xref linkend="settings-usb" />. 833 800 </para> 834 801 </listitem> … … 852 819 <para> 853 820 Host webcam passthrough. See 854 <xref 855 linkend="webcam-passthrough" />. 821 <xref linkend="webcam-passthrough" />. 856 822 </para> 857 823 </listitem> … … 880 846 881 847 <para> 882 VirtualBoxextension packages have a848 &product-name; extension packages have a 883 849 <computeroutput>.vbox-extpack</computeroutput> file name 884 850 extension. To install an extension, simply double-click on the 885 package file and a Network Operations Manager window will 886 appear, guiding you through the required steps. 851 package file and a <emphasis role="bold">Network Operations 852 Manager</emphasis> window is shown to guide you through the 853 required steps. 887 854 </para> 888 855 … … 900 867 901 868 <para> 902 Alternatively, you can use the VBoxManage command line. See903 <xref linkend="vboxmanage-extpack" />.904 </para> 905 </listitem> 906 907 </ orderedlist>869 Alternatively, you can use the <command>VBoxManage</command> 870 command line. See <xref linkend="vboxmanage-extpack" />. 871 </para> 872 </listitem> 873 874 </itemizedlist> 908 875 909 876 </sect1> … … 911 878 <sect1 id="intro-starting"> 912 879 913 <title>Starting VirtualBox</title>914 915 <para> 916 After installation, you can start VirtualBoxas follows:880 <title>Starting &product-name;</title> 881 882 <para> 883 After installation, you can start &product-name; as follows: 917 884 </para> 918 885 … … 921 888 <listitem> 922 889 <para> 923 On a Windows host, in the Programs menu, click on the item in 924 the <emphasis role="bold">VirtualBox</emphasis> group. On 925 Vista or Windows 7, you can also type 890 On a Windows host, in the 891 <emphasis role="bold">Programs</emphasis> menu, click on the 892 item in the <emphasis role="bold">VirtualBox</emphasis> group. 893 On Vista or Windows 7, you can also enter 926 894 <computeroutput>VirtualBox</computeroutput> in the search box 927 of the Startmenu.895 of the <emphasis role="bold">Start</emphasis> menu. 928 896 </para> 929 897 </listitem> … … 933 901 On a Mac OS X host, in the Finder, double-click on the 934 902 <emphasis role="bold">VirtualBox</emphasis> item in the 935 "Applications" folder. You may want to drag this item onto 936 your Dock. 937 </para> 938 </listitem> 939 940 <listitem> 941 <para> 942 On a Linux or Solaris host, depending on your desktop 943 environment, a VirtualBox item may have been placed in either 944 the System or System Tools group of your Applications menu. 945 Alternatively, you can type 946 <computeroutput>VirtualBox</computeroutput> in a terminal. 903 Applications folder. You may want to drag this item onto your 904 Dock. 905 </para> 906 </listitem> 907 908 <listitem> 909 <para> 910 On a Linux or Oracle Solaris host, depending on your desktop 911 environment, an &product-name; item may have been placed in 912 either the System or System Tools group of your 913 <emphasis role="bold">Applications</emphasis> menu. 914 Alternatively, you can enter 915 <computeroutput>VirtualBox</computeroutput> in a terminal 916 window. 947 917 </para> 948 918 </listitem> … … 951 921 952 922 <para> 953 When you start VirtualBox for the first time, a window like the 954 following is displayed: 955 </para> 956 957 <mediaobject> 958 <imageobject> 959 <imagedata align="center" fileref="images/virtualbox-main-empty.png" 923 When you start &product-name; for the first time, a window like 924 the following is displayed: 925 </para> 926 927 <figure id="fig-vbox-manager-initial"> 928 <title>VirtualBox Manager Window, After Initial Startup</title> 929 <mediaobject> 930 <imageobject> 931 <imagedata align="center" fileref="images/virtualbox-main-empty.png" 960 932 width="10cm" /> 961 </imageobject>962 </mediaobject>963 964 <para> 965 This window is called the <emphasis966 role="bold">"VirtualBox967 Manager "</emphasis>. On the left, you can see a pane that will933 </imageobject> 934 </mediaobject> 935 </figure> 936 937 <para> 938 This window is called the <emphasis role="bold">VirtualBox 939 Manager</emphasis>. On the left, you can see a pane that will 968 940 later list all your virtual machines. Since you have not created 969 any, the list is empty. A row of buttons above it allows you to941 any, the list is empty. A row of buttons above it enables you to 970 942 create new VMs and work on existing VMs, once you have some. The 971 943 pane on the right displays the properties of the virtual machine … … 975 947 976 948 <para> 977 To give you an idea what VirtualBox might look like later, after 978 you have created many machines, here is another example: 979 </para> 980 981 <mediaobject> 982 <imageobject> 983 <imagedata align="center" fileref="images/virtualbox-main.png" 949 To give you an idea what &product-name; might look like later, 950 after you have created many machines, here is another example: 951 </para> 952 953 <figure id="fig-vbox-manager-populated"> 954 <title>VirtualBox Manager Window, After Creating Virtual Machines</title> 955 <mediaobject> 956 <imageobject> 957 <imagedata align="center" fileref="images/virtualbox-main.png" 984 958 width="10cm" /> 985 </imageobject> 986 </mediaobject> 959 </imageobject> 960 </mediaobject> 961 </figure> 987 962 988 963 </sect1> … … 993 968 994 969 <para> 995 Click on the <emphasis role="bold">New</emphasis> button at the 996 top of the VirtualBox Manager window. A wizard will pop up to 997 guide you through setting up a new virtual machine (VM): 998 </para> 999 1000 <para> 970 Click the <emphasis role="bold">New</emphasis> button at the top 971 of the VirtualBox Manager window. A wizard is shown, to guide you 972 through setting up a new virtual machine (VM): 973 </para> 974 975 <figure id="fig-new-vm-name"> 976 <title>Creating a New Virtual Machine: Name and Operating System</title> 1001 977 <mediaobject> 1002 978 <imageobject> … … 1005 981 </imageobject> 1006 982 </mediaobject> 1007 983 </figure> 984 985 <para> 1008 986 On the following pages, the wizard will ask you for the bare 1009 987 minimum of information that is needed to create a VM, in … … 1016 994 <para> 1017 995 The <emphasis role="bold">Name</emphasis> of the VM will later 1018 be shown in the VM list of the VirtualBox Manager window, and1019 it will be used for the VM's files on disk. Even though any1020 name can be used, bear in mind that if you create a few VMs,1021 you will appreciate if you have given your VMs rather996 be shown in the machine list of the VirtualBox Manager window, 997 and it will be used for the VM's files on disk. Even though 998 any name can be used, bear in mind that if you create a few 999 VMs, you will appreciate if you have given your VMs rather 1022 1000 informative names."My VM" would thus be less useful than 1023 1001 "Windows XP SP2 with OpenOffice", for example. … … 1032 1010 install something very unusual that is not listed, select 1033 1011 <emphasis role="bold">Other</emphasis>. Depending on your 1034 selection, VirtualBoxwill enable or disable certain VM1012 selection, &product-name; will enable or disable certain VM 1035 1013 settings that your guest operating system may require. This is 1036 1014 particularly important for 64-bit guests. See 1037 <xref 1038 linkend="intro-64bitguests" />. It is 1039 therefore recommended to always set it to the correct value. 1015 <xref linkend="intro-64bitguests" />. It is therefore 1016 recommended to always set it to the correct value. 1040 1017 </para> 1041 1018 </listitem> … … 1044 1021 <para> 1045 1022 On the next page, select the <emphasis role="bold">Memory 1046 (RAM)</emphasis> that VirtualBox should allocate every time1047 t he virtual machine is started. The amount of memory given1048 here will be taken away from your host machine and presented1049 to the guest operating system, which will report this size as1050 th e virtual computer's installed RAM.1023 (RAM)</emphasis> that &product-name; should allocate every 1024 time the virtual machine is started. The amount of memory 1025 given here will be taken away from your host machine and 1026 presented to the guest operating system, which will report 1027 this size as the virtual computer's installed RAM. 1051 1028 </para> 1052 1029 … … 1099 1076 <para> 1100 1077 There are many and potentially complicated ways in which 1101 VirtualBox can provide hard disk space to a VM, see 1102 <xref 1103 linkend="storage" />, but the most common way 1104 is to use a large image file on your "real" hard disk, whose 1105 contents VirtualBox presents to your VM as if it were a 1106 complete hard disk. This file represents an entire hard disk 1107 then, so you can even copy it to another host and use it with 1108 another VirtualBox installation. 1078 &product-name; can provide hard disk space to a VM, see 1079 <xref linkend="storage" />, but the most common way is to use 1080 a large image file on your "real" hard disk, whose contents 1081 &product-name; presents to your VM as if it were a complete 1082 hard disk. This file represents an entire hard disk then, so 1083 you can even copy it to another host and use it with another 1084 &product-name; installation. 1109 1085 </para> 1110 1086 … … 1113 1089 </para> 1114 1090 1115 <para> 1091 <figure id="fig-new-vm-hard-disk"> 1092 <title>Creating a New Virtual Machine: Hard Disk</title> 1116 1093 <mediaobject> 1117 1094 <imageobject> … … 1120 1097 </imageobject> 1121 1098 </mediaobject> 1122 </ para>1099 </figure> 1123 1100 1124 1101 <para> … … 1131 1108 <para> 1132 1109 To create a new, empty virtual hard disk, click the 1133 <emphasis role="bold">New</emphasis> button. 1134 </para> 1135 </listitem> 1136 1137 <listitem> 1138 <para> 1139 You can pick an 1140 <emphasis 1141 >existing</emphasis> disk image 1110 <emphasis role="bold">Create</emphasis> button. 1111 </para> 1112 </listitem> 1113 1114 <listitem> 1115 <para> 1116 You can pick an <emphasis>existing</emphasis> disk image 1142 1117 file. 1143 1118 </para> … … 1145 1120 <para> 1146 1121 The drop-down list presented in the window lists all disk 1147 images which are currently remembered by VirtualBox. These1148 disk images are currently attached to a virtual machine,1149 or have been attached to a virtual machine.1122 images which are currently remembered by &product-name;. 1123 These disk images are currently attached to a virtual 1124 machine, or have been attached to a virtual machine. 1150 1125 </para> 1151 1126 1152 1127 <para> 1153 1128 Alternatively, click on the small 1154 <emphasis 1155 role="bold">folder 1156 icon</emphasis> next to the drop-down list to display a 1157 standard file dialog, where you can select any disk image 1158 file on your host disk. 1129 <emphasis role="bold">folder icon</emphasis> next to the 1130 drop-down list. In the displayed file dialog, you can 1131 click <emphasis role="bold">Add</emphasis> to select any 1132 disk image file on your host disk. 1159 1133 </para> 1160 1134 </listitem> … … 1163 1137 1164 1138 <para> 1165 If you are using VirtualBox for the first time, you will want 1166 to create a new disk image. Click the 1167 <emphasis role="bold">New</emphasis> button. 1168 </para> 1169 1170 <para> 1171 This displays another window, the 1172 <emphasis 1173 role="bold">Create New Virtual Disk 1174 Wizard</emphasis>. This wizard helps you to create a new disk 1175 image file in the new virtual machine's folder. 1176 </para> 1177 1178 <para> 1179 VirtualBox supports the following types of image files: 1139 If you are using &product-name; for the first time, you will 1140 want to create a new disk image. Click the 1141 <emphasis role="bold">Create</emphasis> button. 1142 </para> 1143 1144 <para> 1145 This displays another window, the <emphasis role="bold">Create 1146 Virtual Hard Disk Wizard</emphasis> wizard. This wizard helps 1147 you to create a new disk image file in the new virtual 1148 machine's folder. 1149 </para> 1150 1151 <para> 1152 &product-name; supports the following types of image files: 1180 1153 </para> 1181 1154 … … 1208 1181 <para> 1209 1182 For details about the differences, see 1210 <xref 1211 linkend="vdidetails" />. 1183 <xref linkend="vdidetails" />. 1212 1184 </para> 1213 1185 1214 1186 <para> 1215 1187 To prevent your physical hard disk from running full, 1216 VirtualBox limits the size of the image file. Still, it needs 1217 to be large enough to hold the contents of your operating 1218 system and the applications you want to install. For a modern 1219 Windows or Linux guest, you will probably need several 1220 gigabytes for any serious use. The limit of the image file 1221 size can be changed later, see 1222 <xref 1223 linkend="vboxmanage-modifyvdi"/>. 1224 </para> 1225 1226 <mediaobject> 1227 <imageobject> 1228 <imagedata align="center" fileref="images/create-vdi-1.png" 1188 &product-name; limits the size of the image file. Still, it 1189 needs to be large enough to hold the contents of your 1190 operating system and the applications you want to install. For 1191 a modern Windows or Linux guest, you will probably need 1192 several gigabytes for any serious use. The limit of the image 1193 file size can be changed later, see 1194 <xref linkend="vboxmanage-modifyvdi"/>. 1195 </para> 1196 1197 <figure id="fig-new-vm-vdi"> 1198 <title>Creating a New Virtual Machine: File Location and Size</title> 1199 <mediaobject> 1200 <imageobject> 1201 <imagedata align="center" fileref="images/create-vdi-1.png" 1229 1202 width="10cm" /> 1230 </imageobject> 1231 </mediaobject> 1232 1233 <para> 1234 After having selected or created your image file, again click 1203 </imageobject> 1204 </mediaobject> 1205 </figure> 1206 1207 <para> 1208 After having selected or created your image file, click 1235 1209 <emphasis role="bold">Next</emphasis> to go to the next page. 1236 1210 </para> … … 1239 1213 <listitem> 1240 1214 <para> 1241 After clicking on <emphasis role="bold">Finish</emphasis>1242 button, your new virtual machine is created. The virtual1243 machine is displayed in the list on the left side of the1244 Manager window, withthe name that you entered initially.1215 Click <emphasis role="bold">Create</emphasis>, to create your 1216 new virtual machine. The virtual machine is displayed in the 1217 list on the left side of the VirtualBox Manager window, with 1218 the name that you entered initially. 1245 1219 </para> 1246 1220 </listitem> … … 1271 1245 <listitem> 1272 1246 <para> 1273 Double-click on its entry in the list within the Manager1274 window.1275 </para> 1276 </listitem> 1277 1278 <listitem> 1279 <para> 1280 Select its entry in the list in the Manager window, and click1281 the <emphasis role="bold">Start</emphasis> button at the top.1282 </para>1283 </listitem>1284 1285 <listitem> 1286 <para>1287 For virtual machines created with VirtualBox 4.0 or later,1288 navigate to the <computeroutput>VirtualBox1289 VMs</computeroutput> folder in your system user's home1290 directory. Find the subdirectory of the machine you want to1291 start and double-click on the machine settings file, which has1292 a<computeroutput>.vbox</computeroutput> file extension.1247 Double-click on the VM's entry in the list in the VirtualBox 1248 Manager window. 1249 </para> 1250 </listitem> 1251 1252 <listitem> 1253 <para> 1254 Select the VM's entry in the list in the VirtualBox Manager 1255 window, and click <emphasis role="bold">Start</emphasis> at 1256 the top of the window. 1257 </para> 1258 </listitem> 1259 1260 <listitem> 1261 <para> 1262 Go to the <computeroutput>VirtualBox VMs</computeroutput> 1263 folder in your system user's home directory. Find the 1264 subdirectory of the machine you want to start and double-click 1265 on the machine settings file. This file has a 1266 <computeroutput>.vbox</computeroutput> file extension. 1293 1267 </para> 1294 1268 </listitem> … … 1353 1327 in the form of an ISO image file such as with a Linux 1354 1328 distribution, you would normally burn this file to an empty 1355 CD or DVD and proceed as described above. With VirtualBox1356 however, you can skip this step and mount the ISO file1357 directly. VirtualBox will then present this file as a CD or1358 DVD-ROM drive to the virtual machine, much like it does with1359 virtual hard disk images.1329 CD or DVD and proceed as described above. With 1330 &product-name; however, you can skip this step and mount the 1331 ISO file directly. &product-name; will then present this 1332 file as a CD or DVD-ROM drive to the virtual machine, much 1333 like it does with virtual hard disk images. 1360 1334 </para> 1361 1335 … … 1363 1337 In this case, the wizard's drop-down list contains a list of 1364 1338 installation media that were previously used with 1365 VirtualBox.1339 &product-name;. 1366 1340 </para> 1367 1341 1368 1342 <para> 1369 1343 If your medium is not in the list, especially if you are 1370 using VirtualBox for the first time, click the small folder 1371 icon next to the drop-down list to display a standard file 1372 dialog. Here you can pick an image file on your host disks. 1344 using &product-name; for the first time, click the small 1345 folder icon next to the drop-down list to display a standard 1346 file dialog. Here you can pick an image file on your host 1347 disks. 1373 1348 </para> 1374 1349 </listitem> … … 1388 1363 1389 1364 <para> 1390 As of version 3.2, VirtualBox provides a virtual USB tablet1391 device to new virtual machines through which mouse events are1392 communicated to the guest operating system. If you are running a1393 modern guest operating system that can handle such devices,1394 mouse support maywork out of the box without the mouse being1365 &product-name; provides a virtual USB tablet device to new 1366 virtual machines through which mouse events are communicated to 1367 the guest operating system. If you are running a modern guest 1368 operating system that can handle such devices, mouse support may 1369 work out of the box without the mouse being 1395 1370 <emphasis>captured</emphasis> as described below. See 1396 1371 <xref linkend="settings-motherboard" />. … … 1419 1394 <para> 1420 1395 To return ownership of keyboard and mouse to your host operating 1421 system, VirtualBox reserves a special key on your keyboard: the 1422 <emphasis role="bold">Host key</emphasis>. By default, this is 1423 the <emphasis>right Ctrl key</emphasis> on your keyboard. On a 1424 Mac host, the default Host key is the left Command key. You can 1425 change this default in the VirtualBox Global Settings. See 1426 <xref 1427 linkend="globalsettings" />. The current setting 1428 for the Host key is always displayed at the bottom right of your 1429 VM window. 1430 </para> 1431 1432 <mediaobject> 1433 <imageobject> 1434 <imagedata align="center" fileref="images/vm-hostkey.png" 1396 system, &product-name; reserves a special key on your keyboard: 1397 the <emphasis>Host key</emphasis>. By default, this is the 1398 <emphasis>right Ctrl key</emphasis> on your keyboard. On a Mac 1399 host, the default Host key is the left Command key. You can 1400 change this default in the &product-name; Global Settings. See 1401 <xref linkend="globalsettings" />. The current setting for the 1402 Host key is always displayed at the bottom right of your VM 1403 window. 1404 </para> 1405 1406 <figure id="fig-host-key"> 1407 <title>Host Key Setting on the Virtual Machine Task Bar</title> 1408 <mediaobject> 1409 <imageobject> 1410 <imagedata align="center" fileref="images/vm-hostkey.png" 1435 1411 width="7cm" /> 1436 </imageobject> 1437 </mediaobject> 1412 </imageobject> 1413 </mediaobject> 1414 </figure> 1438 1415 1439 1416 <para> … … 1449 1426 keyboard focus. If you have many windows open in your guest 1450 1427 operating system, the window that has the focus in your VM 1451 is used. This means that if you want to type within your VM,1452 click on the title bar of your VM window first.1428 is used. This means that if you want to enter text within 1429 your VM, click on the title bar of your VM window first. 1453 1430 </para> 1454 1431 … … 1485 1462 Note that mouse ownership is independent of that of the 1486 1463 keyboard. Even after you have clicked on a titlebar to be 1487 able to typeinto the VM window, your mouse is not1464 able to enter text into the VM window, your mouse is not 1488 1465 necessarily owned by the VM yet. 1489 1466 </para> … … 1498 1475 1499 1476 <para> 1500 As this behavior can be inconvenient, VirtualBox provides a set1501 of tools and device drivers for guest systems called the1502 VirtualBoxGuest Additions which make VM keyboard and mouse1477 As this behavior can be inconvenient, &product-name; provides a 1478 set of tools and device drivers for guest systems called the 1479 &product-name; Guest Additions which make VM keyboard and mouse 1503 1480 operation a lot more seamless. Most importantly, the Additions 1504 1481 will get rid of the second "guest" mouse pointer and make your 1505 host mouse pointer work directly in the guest. 1506 </para> 1507 1508 <para> 1509 This is described in <xref 1510 linkend="guestadditions" />. 1482 host mouse pointer work directly in the guest. See 1483 <xref linkend="guestadditions" />. 1511 1484 </para> 1512 1485 … … 1522 1495 difficult to enter into a virtual machine, as there are three 1523 1496 candidates as to who receives keyboard input: the host operating 1524 system, VirtualBox, or the guest operating system. Which of1497 system, &product-name;, or the guest operating system. Which of 1525 1498 these three receives keypresses depends on a number of factors, 1526 1499 including the key itself. … … 1533 1506 Host operating systems reserve certain key combinations for 1534 1507 themselves. For example, it is impossible to enter the 1535 <emphasis 1536 role="bold">Ctrl+Alt+Delete</emphasis> 1537 combination if you want to reboot the guest operating system 1538 in your virtual machine, because this key combination is 1539 usually hard-wired into the host OS, both Windows and Linux 1508 <emphasis role="bold">Ctrl+Alt+Delete</emphasis> combination 1509 if you want to reboot the guest operating system in your 1510 virtual machine, because this key combination is usually 1511 hard-wired into the host OS, both Windows and Linux 1540 1512 intercept this, and pressing this key combination will 1541 1513 therefore reboot your <emphasis>host</emphasis>. … … 1543 1515 1544 1516 <para> 1545 On Linux and Solaris hosts, which use the X Window System, 1546 the key combination 1547 <emphasis 1548 role="bold">Ctrl+Alt+Backspace</emphasis> 1549 normally resets the X server and restarts the entire 1550 graphical user interface. As the X server intercepts this 1551 combination, pressing it will usually restart your 1517 On Linux and Oracle Solaris hosts, which use the X Window 1518 System, the key combination 1519 <emphasis role="bold">Ctrl+Alt+Backspace</emphasis> normally 1520 resets the X server and restarts the entire graphical user 1521 interface. As the X server intercepts this combination, 1522 pressing it will usually restart your 1552 1523 <emphasis>host</emphasis> graphical user interface and kill 1553 all running programs, including VirtualBox, in the process. 1524 all running programs, including &product-name;, in the 1525 process. 1554 1526 </para> 1555 1527 … … 1558 1530 combination <emphasis role="bold">Ctrl+Alt+Fx</emphasis>, 1559 1531 where Fx is one of the function keys from F1 to F12, 1560 normally allows you to switch between virtual terminals. As1532 normally enables you to switch between virtual terminals. As 1561 1533 with Ctrl+Alt+Delete, these combinations are intercepted by 1562 1534 the host operating system and therefore always switch … … 1580 1552 <emphasis role="bold">Insert Ctrl+Alt+Delete</emphasis> 1581 1553 and <emphasis role="bold">Ctrl+Alt+Backspace</emphasis>. 1582 The latter will only have an effect with Linux or 1554 The latter will only have an effect with Linux or Oracle 1583 1555 Solaris guests, however. 1556 </para> 1557 1558 <para> 1559 This menu also includes an option for inserting the Host 1560 key combination. 1584 1561 </para> 1585 1562 </listitem> … … 1588 1565 <para> 1589 1566 Use special key combinations with the Host key, normally 1590 the right Control key. VirtualBox will then translate 1591 these key combinations for the virtual machine: 1567 the right Control key. &product-name; will then 1568 translate these key combinations for the virtual 1569 machine: 1592 1570 </para> 1593 1571 … … 1606 1584 Backspace</emphasis> to send Ctrl+Alt+Backspace to 1607 1585 restart the graphical user interface of a Linux or 1608 Solaris guest.1586 Oracle Solaris guest. 1609 1587 </para> 1610 1588 </listitem> … … 1628 1606 <para> 1629 1607 For some other keyboard combinations such as 1630 <emphasis 1631 role="bold">Alt-Tab</emphasis> to switch 1632 between open windows, VirtualBox allows you to configure 1608 <emphasis role="bold">Alt-Tab</emphasis> to switch between 1609 open windows, &product-name; enables you to configure 1633 1610 whether these combinations will affect the host or the 1634 1611 guest, if a virtual machine currently has the focus. This is 1635 1612 a global setting for all virtual machines and can be found 1636 under "File", "Preferences", "Input". 1613 under <emphasis role="bold">File</emphasis>, 1614 <emphasis role="bold">Preferences</emphasis>, 1615 <emphasis role="bold">Input</emphasis>. 1637 1616 </para> 1638 1617 </listitem> … … 1649 1628 While a virtual machine is running, you can change removable 1650 1629 media in the <emphasis role="bold">Devices</emphasis> menu of 1651 the VM's window. Here you can select in detail what VirtualBox1652 presents to your VM as a CD, DVD, or floppy.1630 the VM's window. Here you can select in detail what 1631 &product-name; presents to your VM as a CD, DVD, or floppy. 1653 1632 </para> 1654 1633 1655 1634 <para> 1656 1635 The settings are the same as would be available for the VM in 1657 the Settings dialog of the VirtualBox main window, but since 1658 that dialog is disabled while the VM is in the "running" or 1659 "saved" state, this extra menu saves you from having to shut 1660 down and restart the VM every time you want to change media. 1661 </para> 1662 1663 <para> 1664 Hence, in the Devices menu, VirtualBox allows you to attach the 1665 host drive to the guest or select a floppy or DVD image using 1666 the Disk Image Manager, as described in 1667 <xref 1668 linkend="configbasics" />. 1636 the <emphasis role="bold">Settings</emphasis> dialog of the 1637 &product-name; main window. But as the 1638 <emphasis role="bold">Settings</emphasis> dialog is disabled 1639 while the VM is in the Running or Saved state, this extra menu 1640 saves you from having to shut down and restart the VM every time 1641 you want to change media. 1642 </para> 1643 1644 <para> 1645 Hence, in the <emphasis role="bold">Devices</emphasis> menu, 1646 &product-name; enables you to attach the host drive to the guest 1647 or select a floppy or DVD image using the Disk Image Manager, as 1648 described in <xref linkend="configbasics" />. 1669 1649 </para> 1670 1650 … … 1677 1657 <para> 1678 1658 You can resize the virtual machine's window when it is running. 1679 In that case, one of th reethings will happen:1659 In that case, one of the following things will happen: 1680 1660 </para> 1681 1661 … … 1704 1684 <para> 1705 1685 The aspect ratio of the guest screen is preserved when 1706 resizing the window. To ignore the aspect ratio, press Shift 1707 during the resize operation. 1686 resizing the window. To ignore the aspect ratio, press 1687 <emphasis role="bold">Shift</emphasis> during the resize 1688 operation. 1708 1689 </para> 1709 1690 … … 1750 1731 button of your virtual machine window, at the top right of the 1751 1732 window, just like you would close any other window on your 1752 system, VirtualBox asks you whether you want to save or power 1753 off the VM. As a shortcut, you can also press Host key + Q. 1754 </para> 1755 1756 <para> 1733 system, &product-name; asks you whether you want to save or 1734 power off the VM. As a shortcut, you can also press 1735 <emphasis role="bold">Host key + Q</emphasis>. 1736 </para> 1737 1738 <figure id="fig-vm-close"> 1739 <title>Closing Down a Virtual Machine</title> 1757 1740 <mediaobject> 1758 1741 <imageobject> … … 1761 1744 </imageobject> 1762 1745 </mediaobject> 1763 1746 </figure> 1747 1748 <para> 1764 1749 The difference between the three options is crucial. They mean 1765 1750 the following: … … 1771 1756 <para> 1772 1757 <emphasis role="bold">Save the machine state:</emphasis> 1773 With this option, VirtualBox <emphasis>freezes</emphasis>1774 the virtual machine by completely saving its state to your1775 local disk.1758 With this option, &product-name; 1759 <emphasis>freezes</emphasis> the virtual machine by 1760 completely saving its state to your local disk. 1776 1761 </para> 1777 1762 … … 1799 1784 <para> 1800 1785 <emphasis role="bold">Power off the machine:</emphasis> With 1801 this option, VirtualBoxalso stops running the virtual1786 this option, &product-name; also stops running the virtual 1802 1787 machine, but <emphasis>without</emphasis> saving its state. 1803 1788 </para> … … 1872 1857 </para> 1873 1858 1874 <para> 1859 <figure id="fig-vm-groups"> 1860 <title>Creating a Group of Virtual Machines</title> 1875 1861 <mediaobject> 1876 1862 <imageobject> … … 1879 1865 </imageobject> 1880 1866 </mediaobject> 1881 </ para>1867 </figure> 1882 1868 </listitem> 1883 1869 … … 1971 1957 state, even though you may have changed the VM considerably since 1972 1958 then. A snapshot of a virtual machine is thus similar to a machine 1973 in "saved" state, as described above, but there can be many of1974 them, and these savedstates are preserved.1959 in Saved state, but there can be many of them, and these saved 1960 states are preserved. 1975 1961 </para> 1976 1962 1977 1963 <para> 1978 1964 You can see the snapshots of a virtual machine by first selecting 1979 a machine in the VirtualBox Manager and then clicking on the1980 <emphasis role="bold">Snapshots</emphasis> button at the top1981 right. Until you take a snapshot of the machine, the list of1982 snapshots will be empty except for the1983 <emphasis role="bold">Current State</emphasis> item, which1984 represents the "now" point in thelifetime of the virtual machine.1965 a machine in the VirtualBox Manager and then clicking 1966 <emphasis role="bold">Snapshots</emphasis> at the top right. Until 1967 you take a snapshot of the machine, the list of snapshots will be 1968 empty except for the <emphasis role="bold">Current 1969 State</emphasis> item, which represents the "now" point in the 1970 lifetime of the virtual machine. 1985 1971 </para> 1986 1972 … … 2017 2003 If your VM is currently in either the Saved or the 2018 2004 Powered Off state, as displayed next to the VM in the 2019 VirtualBoxmain window, click on the2005 &product-name; main window, click on the 2020 2006 <emphasis role="bold">Snapshots </emphasis>tab on the 2021 2007 top right of the main window. Do one of the following: … … 2050 2036 useful name would be "Fresh installation from scratch, no 2051 2037 Guest Additions", or "Service Pack 3 just installed". You 2052 can also add a longer text in the Description field. 2038 can also add a longer text in the 2039 <emphasis role="bold">Description</emphasis> field. 2053 2040 </para> 2054 2041 … … 2063 2050 </para> 2064 2051 2065 <mediaobject> 2066 <imageobject> 2067 <imagedata align="center" fileref="images/snapshots-1.png" 2052 <figure id="fig-snapshots-list"> 2053 <title>Snapshots List for a Virtual Machine</title> 2054 <mediaobject> 2055 <imageobject> 2056 <imagedata align="center" fileref="images/snapshots-1.png" 2068 2057 width="12cm" /> 2069 </imageobject> 2070 </mediaobject> 2071 2072 <para> 2073 VirtualBox imposes no limits on the number of snapshots you 2074 can take. The only practical limitation is disk space on 2058 </imageobject> 2059 </mediaobject> 2060 </figure> 2061 2062 <para> 2063 &product-name; imposes no limits on the number of snapshots 2064 you can take. The only practical limitation is disk space on 2075 2065 your host. Each snapshot stores the state of the virtual 2076 2066 machine and thus occupies some disk space. See … … 2088 2078 and the machine is restored to the exact state it was in 2089 2079 when the snapshot was taken. 2090 2091 <footnote>2092 2093 <para>2094 Both the terminology and the functionality of restoring2095 snapshots has changed with VirtualBox 3.1. Before that2096 version, it was only possible to go back to the very2097 last snapshot taken -- not earlier ones, and the2098 operation was called "Discard current state" instead of2099 "Restore last snapshot". The limitation has been lifted2100 with version 3.1. It is now possible to restore2101 <emphasis>any</emphasis> snapshot, going backward and2102 forward in time.2103 </para>2104 2105 </footnote>2106 2080 </para> 2107 2081 … … 2115 2089 lost. </emphasis>In order to prevent such data loss while 2116 2090 still making use of the snapshot feature, it is possible 2117 to add a second hard drive in "write-through" mode using 2118 the <computeroutput>VBoxManage</computeroutput> interface 2119 and use it to store your data. As write-through hard 2120 drives are <emphasis>not</emphasis> included in snapshots, 2121 they remain unaltered when a machine is reverted. See 2091 to add a second hard drive in 2092 <emphasis>write-through</emphasis> mode using the 2093 <command>VBoxManage</command> interface and use it to 2094 store your data. As write-through hard drives are 2095 <emphasis>not</emphasis> included in snapshots, they 2096 remain unaltered when a machine is reverted. See 2122 2097 <xref 2123 2098 linkend="hdimagewrites" />. … … 2144 2119 <emphasis role="bold">Delete a snapshot</emphasis>. This 2145 2120 does not affect the state of the virtual machine, but only 2146 releases the files on disk that VirtualBox used to store the2147 snapshot data, thus freeing disk space. To delete a2121 releases the files on disk that &product-name; used to store 2122 the snapshot data, thus freeing disk space. To delete a 2148 2123 snapshot, right-click on it in the snapshots tree and select 2149 2124 <emphasis role="bold">Delete</emphasis>. Snapshots can be … … 2217 2192 in "normal" mode. You can configure disks to behave 2218 2193 differently with snapshots, see 2219 <xref 2220 linkend="hdimagewrites" />. Even more 2221 formally and technically correct, it is not the virtual disk 2222 itself that is restored when a snapshot is restored. 2223 Instead, when a snapshot is taken, VirtualBox creates 2224 differencing images which contain only the changes since the 2225 snapshot were taken, and when the snapshot is restored, 2226 VirtualBox throws away that differencing image, thus going 2227 back to the previous state. This is both faster and uses 2228 less disk space. For the details, which can be complex, see 2229 <xref linkend="diffimages" />. 2194 <xref linkend="hdimagewrites" />. Even more formally and 2195 technically correct, it is not the virtual disk itself that 2196 is restored when a snapshot is restored. Instead, when a 2197 snapshot is taken, &product-name; creates differencing 2198 images which contain only the changes since the snapshot 2199 were taken, and when the snapshot is restored, 2200 &product-name; throws away that differencing image, thus 2201 going back to the previous state. This is both faster and 2202 uses less disk space. For the details, which can be complex, 2203 see <xref linkend="diffimages" />. 2230 2204 </para> 2231 2205 … … 2268 2242 2269 2243 <para> 2270 When you select a virtual machine from the list in the Manager2271 window, you will see a summary of that machine's settings on the2272 right.2244 When you select a virtual machine from the list in the VirtualBox 2245 Manager window, you will see a summary of that machine's settings 2246 on the right. 2273 2247 </para> 2274 2248 … … 2285 2259 <note> 2286 2260 <para> 2287 The Settings button is disabled while a VM is either in the 2288 Running or Saved state. This is because the settings dialog 2289 allows you to change fundamental characteristics of the virtual 2261 The <emphasis role="bold">Settings</emphasis> button is disabled 2262 while a VM is either in the Running or Saved state. This is 2263 because the <emphasis role="bold">Settings</emphasis> dialog 2264 enables you to change fundamental characteristics of the virtual 2290 2265 computer that is created for your guest operating system, and 2291 2266 this operating system may perform well when, for example, half 2292 of its memory is taken away. As a result, if the Settings button 2293 is disabled, shut down the current VM first. 2267 of its memory is taken away. As a result, if the 2268 <emphasis role="bold">Settings</emphasis> button is disabled, 2269 shut down the current VM first. 2294 2270 </para> 2295 2271 </note> 2296 2272 2297 2273 <para> 2298 VirtualBox provides a wide range of parameters that can be changed 2299 for a virtual machine. The various settings that can be changed in 2300 the Settings window are described in detail in 2301 <xref 2302 linkend="BasicConcepts" />. Even more parameters are 2303 available with the VirtualBox command line interface. See 2304 <xref 2305 linkend="vboxmanage" />. 2274 &product-name; provides a wide range of parameters that can be 2275 changed for a virtual machine. The various settings that can be 2276 changed in the <emphasis role="bold">Settings</emphasis> window 2277 are described in detail in <xref linkend="BasicConcepts" />. Even 2278 more parameters are available with the &product-name; command line 2279 interface. See <xref linkend="vboxmanage" />. 2306 2280 </para> 2307 2281 … … 2310 2284 <sect1 id="intro-removing"> 2311 2285 2312 <title>Removing Virtual Machines</title> 2313 2314 <para> 2315 To remove a virtual machine which you no longer need, right-click 2316 on it in the Manager's VM list and select 2317 <emphasis role="bold">Remove</emphasis>. 2318 </para> 2319 2320 <para> 2321 A confirmation window is displayed that allows you to select 2322 whether the machine should only be removed from the list of 2323 machines or whether the files associated with it should also be 2324 deleted. 2325 </para> 2326 2327 <para> 2328 The Remove menu item is disabled while a machine is running. 2286 <title>Removing and Moving Virtual Machines</title> 2287 2288 <para> 2289 You can easily remove a virtual machine from &product-name;. 2290 Alternatively, you can move the virtual machine and associated 2291 files, such as a disk image, to another location on the host. 2292 </para> 2293 2294 <itemizedlist> 2295 2296 <listitem> 2297 <para> 2298 <emphasis role="bold">Removing a VM.</emphasis> To remove a 2299 virtual machine which you no longer need, right-click on the 2300 VM in the VirtualBox Manager's machine list and select 2301 <emphasis role="bold">Remove</emphasis>. 2302 </para> 2303 2304 <para> 2305 A confirmation dialog is displayed that enables you to select 2306 whether the virtual machine should only be removed from the 2307 list of machines, or whether the files associated with it 2308 should also be deleted. 2309 </para> 2310 2311 <para> 2312 The <emphasis role="bold">Remove</emphasis> menu item is 2313 disabled while a VM is running. 2314 </para> 2315 </listitem> 2316 2317 <listitem> 2318 <para> 2319 <emphasis role="bold">Moving a VM.</emphasis> To move a 2320 virtual machine to a new location on the host, right-click on 2321 the VM in the VirtualBox Manager's machine list and select 2322 <emphasis role="bold">Move</emphasis>. 2323 </para> 2324 2325 <para> 2326 A file dialog prompts you to select a new location for the 2327 virtual machine. 2328 </para> 2329 2330 <para> 2331 When you move a VM, &product-name; configuration files are 2332 updated automatically to use the new location on the host. 2333 </para> 2334 2335 <para> 2336 The <emphasis role="bold">Move</emphasis> menu item is 2337 disabled while a VM is running. 2338 </para> 2339 2340 <para> 2341 You can also use the <command>VBoxManage</command> command to 2342 move a VM. See <xref linkend="vboxmanage-movevm"/>. 2343 </para> 2344 </listitem> 2345 2346 </itemizedlist> 2347 2348 <para> 2349 For details of removing or moving a disk image file from 2350 &product-name;, see <xref linkend="vdis"/>. 2329 2351 </para> 2330 2352 … … 2337 2359 <para> 2338 2360 To experiment with a VM configuration, test different guest OS 2339 levels or to simply backup a VM, VirtualBox can create a full or a 2340 linked copy of an existing VM. 2341 2342 <footnote> 2343 2344 <para> 2345 Cloning support was introduced with VirtualBox 4.1. 2346 </para> 2347 2348 </footnote> 2349 </para> 2350 2351 <para> 2352 A wizard guides you through the clone process. 2353 </para> 2354 2355 <mediaobject> 2356 <imageobject> 2357 <imagedata align="center" fileref="images/clone-vm.png" 2361 levels or to simply backup a VM, &product-name; can create a full 2362 or a linked copy of an existing VM. This is called 2363 <emphasis>cloning</emphasis> a virtual machine. 2364 </para> 2365 2366 <para> 2367 The <emphasis role="bold">Clone Virtual Machine</emphasis> wizard 2368 guides you through the cloning process. 2369 </para> 2370 2371 <figure id="fig-clone-wizard"> 2372 <title>The Clone Virtual Machine Wizard</title> 2373 <mediaobject> 2374 <imageobject> 2375 <imagedata align="center" fileref="images/clone-vm.png" 2358 2376 width="10cm" /> 2359 </imageobject> 2360 </mediaobject> 2361 2362 <para> 2363 This wizard can be started from the right-click menu of the 2364 Manager's VM list, by clicking 2365 <emphasis role="bold">Clone</emphasis>, or the 2377 </imageobject> 2378 </mediaobject> 2379 </figure> 2380 2381 <para> 2382 Start the wizard by clicking 2383 <emphasis role="bold">Clone</emphasis> in the right-click menu of 2384 the VirtualBox Manager's machine list, or in the 2366 2385 <emphasis role="bold">Snapshots</emphasis> view of the selected 2367 VM. First choose a new name for the clone. When you select 2368 <emphasis 2369 role="bold">Reinitialize the MAC address of all 2370 network cards</emphasis> every network card get a new MAC address 2371 assigned. This is useful when both the source VM and the cloned VM 2372 have to operate on the same network. If you leave this unchanged, 2373 all network cards have the same MAC address like the one in the 2374 source VM. Depending on how you invoke the wizard you have 2375 different choices for the cloning operation. First you need to 2376 decide if the clone should be linked to the source VM or if a 2377 fully independent clone should be created. 2386 VM. 2387 </para> 2388 2389 <para> 2390 Enter a new <emphasis role="bold">Name</emphasis> for the clone. 2391 You can choose a <emphasis role="bold">Path</emphasis> for the 2392 cloned virtual machine, otherwise the default machines folder is 2393 used. 2394 </para> 2395 2396 <para> 2397 The <emphasis role="bold">Clone Type</emphasis> option is used to 2398 specify if the clone should be linked to the source VM, or if a 2399 fully independent clone should be created, as follows: 2378 2400 </para> 2379 2401 … … 2382 2404 <listitem> 2383 2405 <para> 2384 <emphasis role="bold">Full clone:</emphasis> In this mode, all2406 <emphasis role="bold">Full Clone:</emphasis> In this mode, all 2385 2407 dependent disk images are copied to the new VM folder. The 2386 2408 clone can fully operate without the source VM. … … 2390 2412 <listitem> 2391 2413 <para> 2392 <emphasis role="bold">Linked clone:</emphasis> In this mode,2414 <emphasis role="bold">Linked Clone:</emphasis> In this mode, 2393 2415 new differencing disk images are created where the parent disk 2394 2416 images are the source disk images. If you selected the current … … 2401 2423 2402 2424 <para> 2403 After selecting the clone mode, you need to decide what exactly 2404 should be cloned. You can always create a clone of the 2405 <emphasis>current state</emphasis> only or 2406 <emphasis>all</emphasis>. When you select 2407 <emphasis>all</emphasis>, the current state and in addition all 2408 snapshots are cloned. If you started from a snapshot which has 2409 additional children, you can also clone the 2410 <emphasis role="italic">current state and all children</emphasis>. 2411 This creates a clone starting with this snapshot and includes all 2412 child snapshots. 2413 </para> 2425 The <emphasis role="bold">Snapshots</emphasis> option determines 2426 what should be cloned. You can create a clone of the 2427 <emphasis role="bold">Current Machine State</emphasis> only or 2428 <emphasis role="bold">Everything</emphasis>. When you select 2429 <emphasis role="bold">Everything</emphasis>, the current machine 2430 state and additionally all snapshots are cloned. If you started 2431 from a snapshot which has additional children, you can also clone 2432 the <emphasis role="bold">Current Machine State and All 2433 Children</emphasis>. This creates a clone starting with this 2434 snapshot and includes all child snapshots. 2435 </para> 2436 2437 <para> 2438 The following clone options are available: 2439 </para> 2440 2441 <itemizedlist> 2442 2443 <listitem> 2444 <para> 2445 <emphasis role="bold">MAC Address Policy:</emphasis> Select an 2446 option for retaining network card MAC addresses when cloning 2447 the VM. 2448 </para> 2449 2450 <para> 2451 For example, when you select <emphasis role="bold">Generate 2452 New MAC Addresses For All Network Adapters</emphasis> every 2453 network card is assigned a new MAC address during cloning. 2454 This is the default setting, and is useful when both the 2455 source VM and the cloned VM have to operate on the same 2456 network. Other options enable you to retain existing MAC 2457 addresses in the cloned VM. 2458 </para> 2459 </listitem> 2460 2461 <listitem> 2462 <para> 2463 <emphasis role="bold">Keep Disk Names:</emphasis> The names of 2464 disk images are retained when cloning the VM. 2465 </para> 2466 </listitem> 2467 2468 <listitem> 2469 <para> 2470 <emphasis role="bold">Keep Hardware UUIDs:</emphasis> Hardware 2471 UUIDs are retained when cloning the VM. 2472 </para> 2473 </listitem> 2474 2475 </itemizedlist> 2414 2476 2415 2477 <para> … … 2421 2483 2422 2484 <para> 2423 The Clone menu item is disabled while a machine is running. 2485 The <emphasis role="bold">Clone</emphasis> menu item is disabled 2486 while a machine is running. 2424 2487 </para> 2425 2488 2426 2489 <para> 2427 2490 To clone a VM from the command line, see 2428 <xref 2429 linkend="vboxmanage-clonevm" />. 2491 <xref linkend="vboxmanage-clonevm" />. 2430 2492 </para> 2431 2493 … … 2437 2499 2438 2500 <para> 2439 VirtualBox can import and export virtual machines in the 2440 industry-standard Open Virtualization Format (OVF). 2441 2442 <footnote> 2443 2444 <para> 2445 OVF support was originally introduced with VirtualBox 2.2 and 2446 has seen major improvements with every version since. 2447 </para> 2448 2449 </footnote> 2450 </para> 2451 2452 <para> 2453 OVF is a cross-platform standard supported by many virtualization 2454 products which allows for creating ready-made virtual machines 2455 that can then be imported into a virtualizer such as VirtualBox. 2456 VirtualBox makes OVF import and export easy to access and supports 2457 it from the Manager window as well as its command-line interface. 2458 This allows for packaging so-called <emphasis>virtual 2459 appliances</emphasis>. These are disk images, together with 2460 configuration settings that can be distributed easily. This way 2461 one can offer complete ready-to-use software packages, including 2462 operating systems with applications, that need no configuration or 2463 installation except for importing into VirtualBox. 2464 </para> 2465 2466 <note> 2467 <para> 2468 The OVF standard is complex, and support in VirtualBox is an 2469 ongoing process. In particular, no guarantee is made that 2470 VirtualBox supports all appliances created by other 2471 virtualization software. For a list of known limitations, see 2472 <xref 2501 &product-name; can import and export virtual machines in the 2502 following formats: 2503 </para> 2504 2505 <itemizedlist> 2506 2507 <listitem> 2508 <para> 2509 <emphasis role="bold">Open Virtualization Format 2510 (OVF).</emphasis> This is the industry-standard format. See 2511 <xref linkend="ovf-about"/>. 2512 </para> 2513 </listitem> 2514 2515 <listitem> 2516 <para> 2517 <emphasis role="bold">Cloud service formats.</emphasis> Export 2518 to cloud services such as &oci; is supported. Import is not 2519 supported. See <xref linkend="ovf-export-oci"/>. 2520 </para> 2521 </listitem> 2522 2523 </itemizedlist> 2524 2525 <sect2 id="ovf-about"> 2526 2527 <title>About the OVF Format</title> 2528 2529 <para> 2530 OVF is a cross-platform standard supported by many 2531 virtualization products which enables the creation of ready-made 2532 virtual machines that can then be imported into a hypervisor 2533 such as &product-name;. &product-name; makes OVF import and 2534 export easy to do, using the VirtualBox Manager window or the 2535 command-line interface. 2536 </para> 2537 2538 <para> 2539 Using OVF enables packaging of <emphasis>virtual 2540 appliances</emphasis>. These are disk images, together with 2541 configuration settings that can be distributed easily. This way 2542 one can offer complete ready-to-use software packages, including 2543 operating systems with applications, that need no configuration 2544 or installation except for importing into &product-name;. 2545 </para> 2546 2547 <note> 2548 <para> 2549 The OVF standard is complex, and support in &product-name; is 2550 an ongoing process. In particular, no guarantee is made that 2551 &product-name; supports all appliances created by other 2552 virtualization software. For a list of known limitations, see 2553 <xref 2473 2554 linkend="KnownIssues" />. 2474 </para> 2475 </note> 2476 2477 <para> 2478 Appliances in OVF format can appear in the following variants: 2479 </para> 2480 2481 <itemizedlist> 2482 2483 <listitem> 2484 <para> 2485 They can come in several files, as one or several disk images, 2486 typically in the widely-used VMDK format. See 2487 <xref 2488 linkend="vdidetails" />. They also include a 2489 textual description file in an XML dialect with an 2490 <computeroutput>.ovf</computeroutput> extension. These files 2491 must then reside in the same directory for VirtualBox to be 2492 able to import them. 2493 </para> 2494 </listitem> 2495 2496 <listitem> 2497 <para> 2498 Alternatively, the above files can be packed together into a 2499 single archive file, typically with an 2500 <computeroutput>.ova</computeroutput> extension. Such archive 2501 files use a variant of the TAR archive format and can 2502 therefore be unpacked outside of VirtualBox with any utility 2503 that can unpack standard TAR files. 2504 </para> 2505 </listitem> 2506 2507 </itemizedlist> 2508 2509 <para> 2510 To <emphasis role="bold">import an appliance</emphasis> in one of 2511 the above formats, double-click on the OVF/OVA file. 2512 2513 <footnote> 2514 2515 <para> 2516 Starting with version 4.0, VirtualBox creates file type 2517 associations for OVF and OVA files on your host operating 2518 system. 2519 </para> 2520 2521 </footnote> 2522 2523 Alternatively, select <emphasis role="bold">File</emphasis>, 2524 <emphasis role="bold">Import Appliance</emphasis> from the Manager 2525 window. In the displayed file dialog, navigate to the file with 2526 either the <computeroutput>.ovf</computeroutput> or the 2527 <computeroutput>.ova</computeroutput> file extension. 2528 </para> 2529 2530 <para> 2531 If VirtualBox can handle the file, a dialog similar to the 2532 following will appear: 2533 </para> 2534 2535 <mediaobject> 2536 <imageobject> 2537 <imagedata align="center" fileref="images/ovf-import.png" 2555 </para> 2556 </note> 2557 2558 <para> 2559 Appliances in OVF format can appear in the following variants: 2560 </para> 2561 2562 <itemizedlist> 2563 2564 <listitem> 2565 <para> 2566 They can come in several files, as one or several disk 2567 images, typically in the widely-used VMDK format. See 2568 <xref linkend="vdidetails" />. They also include a textual 2569 description file in an XML dialect with an 2570 <computeroutput>.ovf</computeroutput> extension. These files 2571 must then reside in the same directory for &product-name; to 2572 be able to import them. 2573 </para> 2574 </listitem> 2575 2576 <listitem> 2577 <para> 2578 Alternatively, the above files can be packed together into a 2579 single archive file, typically with an 2580 <computeroutput>.ova</computeroutput> extension. Such 2581 archive files use a variant of the TAR archive format and 2582 can therefore be unpacked outside of &product-name; with any 2583 utility that can unpack standard TAR files. 2584 </para> 2585 </listitem> 2586 2587 </itemizedlist> 2588 2589 <note> 2590 <para> 2591 OVF cannot describe snapshots that were taken for a virtual 2592 machine. As a result, when you export a virtual machine that 2593 has snapshots, only the current state of the machine will be 2594 exported. The disk images in the export will have a 2595 <emphasis>flattened</emphasis> state identical to the current 2596 state of the virtual machine. 2597 </para> 2598 </note> 2599 2600 </sect2> 2601 2602 <sect2 id="ovf-import-appliance"> 2603 2604 <title>Importing an Appliance in OVF Format</title> 2605 2606 <para> 2607 To import an appliance in OVF format, use the following steps. 2608 </para> 2609 2610 <orderedlist> 2611 2612 <listitem> 2613 <para> 2614 Double-click on the OVF or OVA file. 2615 </para> 2616 2617 <para> 2618 &product-name; creates file type associations automatically 2619 for any OVF and OVA files on your host operating system. 2620 </para> 2621 </listitem> 2622 2623 <listitem> 2624 <para> 2625 Select <emphasis role="bold">File</emphasis>, 2626 <emphasis role="bold">Import Appliance</emphasis> in the 2627 VirtualBox Manager window. In the displayed file dialog, 2628 navigate to the file with either the 2629 <computeroutput>.ovf</computeroutput> or the 2630 <computeroutput>.ova</computeroutput> file extension. 2631 </para> 2632 2633 <para> 2634 Click <emphasis role="bold">Import</emphasis>. The 2635 <emphasis role="bold">Appliance Settings</emphasis> screen 2636 is shown. 2637 </para> 2638 2639 <figure id="fig-import-appliance"> 2640 <title>Appliance Settings Screen for Import Appliance</title> 2641 <mediaobject> 2642 <imageobject> 2643 <imagedata align="center" fileref="images/ovf-import.png" 2538 2644 width="12cm" /> 2539 </imageobject> 2540 </mediaobject> 2541 2542 <para> 2543 This presents the virtual machines described in the OVF file and 2544 allows you to change the virtual machine settings by 2545 double-clicking on the description items. Once you click on 2546 <emphasis 2547 role="bold">"Import"</emphasis>, VirtualBox will 2548 copy the disk images and create local virtual machines with the 2549 settings described in the dialog. These will then show up in the 2550 Manager's list of virtual machines. 2551 </para> 2552 2553 <para> 2554 Note that since disk images tend to be big, and VMDK images that 2555 come with virtual appliances are typically shipped in a special 2556 compressed format that is unsuitable for being used by virtual 2557 machines directly, the images will need to be unpacked and copied 2558 first, which can take a few minutes. 2559 </para> 2560 2561 <para> 2562 To import an image using the command line, see 2563 <xref 2564 linkend="vboxmanage-import" />. 2565 </para> 2566 2567 <para> 2568 To <emphasis role="bold">export virtual machines</emphasis> that 2569 you already have in VirtualBox, select 2570 <emphasis role="bold">File</emphasis>, <emphasis role="bold"> 2571 Export Appliance</emphasis>. A dialog window is displayed that 2572 enables you to combine several virtual machines into an OVF 2573 appliance. Select the target location where the target files 2574 should be stored, and the conversion process begins. This can take 2575 a while. 2576 </para> 2577 2578 <para> 2579 To export an image using the command line, see 2580 <xref 2581 linkend="vboxmanage-export" />. 2582 </para> 2583 2584 <note> 2585 <para> 2586 OVF cannot describe snapshots that were taken for a virtual 2587 machine. As a result, when you export a virtual machine that has 2588 snapshots, only the current state of the machine will be 2589 exported. The disk images in the export will have a "flattened" 2590 state identical to the current state of the virtual machine. 2591 </para> 2592 </note> 2645 </imageobject> 2646 </mediaobject> 2647 </figure> 2648 2649 <para> 2650 This screen shows the virtual machines described in the OVF 2651 or OVA file and enables you to change the virtual machine 2652 settings. 2653 </para> 2654 2655 <para> 2656 By default, membership of VM groups is preserved on import 2657 for VMs that were initially exported from &product-name;. 2658 This can be changed using the <emphasis role="bold">Primary 2659 Group</emphasis> setting for the VM. 2660 </para> 2661 2662 <para> 2663 The following global settings apply for all of the VMs that 2664 you are importing: 2665 </para> 2666 2667 <itemizedlist> 2668 2669 <listitem> 2670 <para> 2671 <emphasis role="bold">Base Folder:</emphasis> The 2672 directory on the host where the imported VMs are stored. 2673 </para> 2674 2675 <para> 2676 If there are multiple VMs in an appliance, you can 2677 specify a different directory for each VM by editing the 2678 <emphasis role="bold">Base Folder</emphasis> setting for 2679 the VM. 2680 </para> 2681 </listitem> 2682 2683 <listitem> 2684 <para> 2685 <emphasis role="bold">MAC Address Policy</emphasis>: By 2686 default, MAC addresses of network cards on your VMs are 2687 reinitialized before import. You can choose to preserve 2688 MAC addresses on import. 2689 </para> 2690 </listitem> 2691 2692 <listitem> 2693 <para> 2694 <emphasis role="bold">Import Hard Drives as 2695 VDI:</emphasis> By default, hard drives are imported in 2696 VMDK format. This option enables import in VDI format. 2697 </para> 2698 </listitem> 2699 2700 </itemizedlist> 2701 </listitem> 2702 2703 <listitem> 2704 <para> 2705 Click <emphasis role="bold">Import</emphasis> to import the 2706 appliance. 2707 </para> 2708 2709 <para> 2710 &product-name; copies the disk images and creates local 2711 virtual machines with the settings described in the 2712 <emphasis role="bold">Appliance Settings</emphasis> screen. 2713 The imported VMs are shown in the list of virtual machines 2714 in VirtualBox Manager. 2715 </para> 2716 2717 <para> 2718 Note that since disk images tend to be big, and VMDK images 2719 that come with virtual appliances are typically shipped in a 2720 special compressed format that is unsuitable for being used 2721 by virtual machines directly, the images are unpacked and 2722 copied first, which can take a few minutes. 2723 </para> 2724 </listitem> 2725 2726 </orderedlist> 2727 2728 <para> 2729 To import an appliance using the command line, see 2730 <xref linkend="vboxmanage-import" />. 2731 </para> 2732 2733 </sect2> 2734 2735 <sect2 id="ovf-export-appliance"> 2736 2737 <title>Exporting an Appliance in OVF Format</title> 2738 2739 <para> 2740 To export an appliance in OVF format, use the following steps. 2741 </para> 2742 2743 <orderedlist> 2744 2745 <listitem> 2746 <para> 2747 Select <emphasis role="bold">File</emphasis>, 2748 <emphasis role="bold"> Export Appliance</emphasis>. 2749 </para> 2750 2751 <para> 2752 The <emphasis role="bold">Export Virtual 2753 Appliance</emphasis> wizard is shown. The initial window 2754 enables you to combine several virtual machines into an OVF 2755 appliance. 2756 </para> 2757 2758 <para> 2759 Select one or more VMs to export and click 2760 <emphasis role="bold">Next</emphasis>. 2761 </para> 2762 </listitem> 2763 2764 <listitem> 2765 <para> 2766 The <emphasis role="bold">Appliance Settings</emphasis> 2767 screen is shown, where you can choose the following 2768 settings: 2769 </para> 2770 2771 <itemizedlist> 2772 2773 <listitem> 2774 <para> 2775 <emphasis role="bold">Format:</emphasis> Select an 2776 <emphasis role="bold">Open Virtualization 2777 Format</emphasis> option for the output files. 2778 </para> 2779 2780 <para> 2781 The <emphasis role="bold">&oci;</emphasis> option is 2782 used for export to &oci;. See 2783 <xref linkend="ovf-export-oci"/>. 2784 </para> 2785 </listitem> 2786 2787 <listitem> 2788 <para> 2789 <emphasis role="bold">File:</emphasis> Select the 2790 location where the exported files are to be stored. 2791 </para> 2792 </listitem> 2793 2794 <listitem> 2795 <para> 2796 <emphasis role="bold">MAC Address Policy:</emphasis> 2797 Select an option for retaining network card MAC 2798 addresses on export. 2799 </para> 2800 </listitem> 2801 2802 <listitem> 2803 <para> 2804 <emphasis role="bold">Write Manifest File:</emphasis> 2805 Enables you to include a manifest file in the exported 2806 archive file. 2807 </para> 2808 </listitem> 2809 2810 <listitem> 2811 <para> 2812 <emphasis role="bold">Include ISO Image 2813 Files:</emphasis> Enables you to include ISO image files 2814 in the exported archive file. 2815 </para> 2816 </listitem> 2817 2818 </itemizedlist> 2819 </listitem> 2820 2821 <listitem> 2822 <para> 2823 Click <emphasis role="bold">Next</emphasis> to display the 2824 <emphasis role="bold">Virtual System Settings</emphasis> 2825 screen. 2826 </para> 2827 2828 <para> 2829 You can edit settings for the virtual appliance. For 2830 example, you can change the name and add product information 2831 such as vendor details or license text. 2832 </para> 2833 2834 <para> 2835 To change a setting, double-click on the required field. 2836 </para> 2837 </listitem> 2838 2839 <listitem> 2840 <para> 2841 Click <emphasis role="bold">Export</emphasis> and the export 2842 process begins. Note that this can take a while. 2843 </para> 2844 </listitem> 2845 2846 </orderedlist> 2847 2848 <para> 2849 To export an appliance using the command line, see 2850 <xref linkend="vboxmanage-export" />. 2851 </para> 2852 2853 </sect2> 2854 2855 <!-- New content for 6.0 --> 2856 2857 <sect2 id="ovf-export-oci"> 2858 2859 <title>Exporting an Appliance to &oci;</title> 2860 2861 <para> 2862 &product-name; supports the export of VMs to an &oci; service. 2863 </para> 2864 2865 <para> 2866 Before you export a VM to &oci;, you need to do the following: 2867 </para> 2868 2869 <itemizedlist> 2870 2871 <listitem> 2872 <para> 2873 Generate an API signing key pair. This is used for API 2874 requests to &oci;. 2875 </para> 2876 2877 <itemizedlist> 2878 2879 <listitem> 2880 <para> 2881 The key pair is usually installed in the 2882 <computeroutput>.oci</computeroutput> folder in your 2883 home directory. For example, 2884 <computeroutput>~/.oci</computeroutput> on a Linux 2885 system. 2886 </para> 2887 </listitem> 2888 2889 <listitem> 2890 <para> 2891 The public key of the key pair must be uploaded to the 2892 cloud service. 2893 </para> 2894 </listitem> 2895 2896 </itemizedlist> 2897 2898 <para> 2899 Instructions for creating and uploading an API signing key 2900 for &oci; are at: 2901 </para> 2902 2903 <para> 2904 <ulink url="https://docs.cloud.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#How">https://docs.cloud.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#How</ulink> 2905 </para> 2906 </listitem> 2907 2908 <listitem> 2909 <para> 2910 Create a profile for your cloud account. 2911 </para> 2912 2913 <para> 2914 The cloud profile contains resource identifiers for your 2915 cloud account, such as your user OCID, and the fingerprint 2916 for your public key. You can create a cloud profile in the 2917 following ways: 2918 </para> 2919 2920 <itemizedlist> 2921 2922 <listitem> 2923 <para> 2924 Automatically, using the <emphasis role="bold">Cloud 2925 Profile Manager</emphasis>. See 2926 <xref linkend="ovf-cloud-profile-manager"/>. 2927 </para> 2928 </listitem> 2929 2930 <listitem> 2931 <para> 2932 Manually, by creating an 2933 <computeroutput>oci_config</computeroutput> file in your 2934 &product-name; global configuration directory. For 2935 example, this is 2936 <computeroutput>$HOME/.config/VirtualBox/oci_config</computeroutput> 2937 on a Linux host. 2938 </para> 2939 </listitem> 2940 2941 <listitem> 2942 <para> 2943 Manually, by creating a 2944 <computeroutput>config</computeroutput> file in your 2945 &oci; configuration directory. For example, this is 2946 <computeroutput>$HOME/.oci/config</computeroutput> on a 2947 Linux host. 2948 </para> 2949 2950 <para> 2951 This is the same file that is used by the &oci; Command 2952 Line Interface. 2953 </para> 2954 2955 <para> 2956 &product-name; uses this file automatically if a cloud 2957 profile file is not present in your global configuration 2958 directory. Alternatively, you can import this file 2959 manually into the Cloud Profile Manager. 2960 </para> 2961 </listitem> 2962 2963 </itemizedlist> 2964 2965 <para> 2966 For information on cloud profile settings used by &oci; see 2967 the following: 2968 </para> 2969 2970 <para> 2971 <ulink url="https://docs.cloud.oracle.com/iaas/Content/API/Concepts/sdkconfig.htm">https://docs.cloud.oracle.com/iaas/Content/API/Concepts/sdkconfig.htm</ulink> 2972 </para> 2973 </listitem> 2974 2975 <listitem> 2976 <para> 2977 Ensure that the subnet used by source VMs are available in 2978 the target compartment on the cloud service. 2979 </para> 2980 </listitem> 2981 2982 </itemizedlist> 2983 2984 <para> 2985 To export a VM to &oci;, use the following steps. 2986 </para> 2987 2988 <orderedlist> 2989 2990 <listitem> 2991 <para> 2992 Select <emphasis role="bold">File</emphasis>, 2993 <emphasis role="bold"> Export Appliance</emphasis>. 2994 </para> 2995 2996 <para> 2997 The <emphasis role="bold">Export Virtual 2998 Appliance</emphasis> wizard is shown. 2999 </para> 3000 3001 <para> 3002 Select a VM to export and click 3003 <emphasis role="bold">Next</emphasis>. 3004 </para> 3005 </listitem> 3006 3007 <listitem> 3008 <para> 3009 The <emphasis role="bold">Appliance Settings</emphasis> 3010 screen is shown. 3011 </para> 3012 3013 <para> 3014 In the <emphasis role="bold">Format</emphasis> drop-down 3015 list, select <emphasis role="bold">&oci;</emphasis>. 3016 </para> 3017 3018 <para> 3019 In the <emphasis role="bold">Account</emphasis> drop-down 3020 list, select your &oci; account. 3021 </para> 3022 3023 <para> 3024 &oci; accounts can be set up using the Cloud Profile 3025 Manager. 3026 </para> 3027 3028 <para> 3029 The window below the 3030 <emphasis role="bold">Account</emphasis> field displays the 3031 profile settings for your cloud account. 3032 </para> 3033 3034 <figure id="fig-export-appliance-oci"> 3035 <title>Appliance Settings Screen, Showing Cloud Profile Settings</title> 3036 <mediaobject> 3037 <imageobject> 3038 <imagedata align="center" fileref="images/export-appliance-oci.png" 3039 width="12cm" /> 3040 </imageobject> 3041 </mediaobject> 3042 </figure> 3043 3044 <para> 3045 Click <emphasis role="bold">Next</emphasis>. &product-name; 3046 makes an API request to the &oci; service. 3047 </para> 3048 </listitem> 3049 3050 <listitem> 3051 <para> 3052 The <emphasis role="bold">Virtual System Settings</emphasis> 3053 screen is shown. 3054 </para> 3055 3056 <para> 3057 You can edit settings used for the virtual machine on &oci;. 3058 For example, you can edit the Disk Size and Shape used for 3059 the VM instance. 3060 </para> 3061 3062 <para> 3063 Click <emphasis role="bold">Export</emphasis> to export the 3064 virtual machines to the cloud service. 3065 </para> 3066 </listitem> 3067 3068 <listitem> 3069 <para> 3070 The VMs are uploaded to &oci;. 3071 </para> 3072 3073 <para> 3074 Instances are created for the uploaded VMs. 3075 </para> 3076 3077 <para> 3078 If the <emphasis role="bold">Launch Instance</emphasis> 3079 setting was enabled on the <emphasis role="bold">Virtual 3080 System Settings</emphasis> screen, the VM instance is 3081 started. 3082 </para> 3083 3084 <para> 3085 You can monitor the export process using the &oci; Console. 3086 </para> 3087 </listitem> 3088 3089 </orderedlist> 3090 3091 </sect2> 3092 3093 <sect2 id="ovf-cloud-profile-manager"> 3094 3095 <title>The Cloud Profile Manager</title> 3096 3097 <para> 3098 The Cloud Profile Manager is a component of &product-name; that 3099 enables you to create, edit, and manage cloud profiles for your 3100 cloud service accounts. 3101 </para> 3102 3103 <figure id="fig-cloud-profile-manager"> 3104 <title>The Cloud Profile Manager</title> 3105 <mediaobject> 3106 <imageobject> 3107 <imagedata align="center" fileref="images/cloud-profile-manager.png" 3108 width="12cm" /> 3109 </imageobject> 3110 </mediaobject> 3111 </figure> 3112 3113 <para> 3114 To display the Cloud Profile Manager select 3115 <emphasis role="bold">File</emphasis>, 3116 <emphasis role="bold">Cloud Profile Manager</emphasis> in the 3117 VirtualBox Manager window. 3118 </para> 3119 3120 <para> 3121 You can use the Cloud Profile Manager to create a new cloud 3122 profile automatically, or you can create a cloud profile by 3123 importing settings from your &oci; configuration file into the 3124 Cloud Profile Manager. 3125 </para> 3126 3127 <para> 3128 To create a new cloud profile, do the following: 3129 </para> 3130 3131 <orderedlist> 3132 3133 <listitem> 3134 <para> 3135 Click the <emphasis role="bold">Add</emphasis> icon and 3136 specify a <emphasis role="bold">Name</emphasis> for the 3137 profile. 3138 </para> 3139 </listitem> 3140 3141 <listitem> 3142 <para> 3143 Click <emphasis role="bold">Properties</emphasis> and enter 3144 the following settings for the profile: 3145 </para> 3146 3147 <itemizedlist> 3148 3149 <listitem> 3150 <para> 3151 Compartment OCID 3152 </para> 3153 </listitem> 3154 3155 <listitem> 3156 <para> 3157 Fingerprint of the public key 3158 </para> 3159 </listitem> 3160 3161 <listitem> 3162 <para> 3163 Location of the private key on the client device 3164 </para> 3165 </listitem> 3166 3167 <listitem> 3168 <para> 3169 (Optional) Passphrase for the private key, if the key is 3170 encrypted 3171 </para> 3172 </listitem> 3173 3174 <listitem> 3175 <para> 3176 Region OCID 3177 </para> 3178 </listitem> 3179 3180 <listitem> 3181 <para> 3182 Tenancy OCID 3183 </para> 3184 </listitem> 3185 3186 <listitem> 3187 <para> 3188 User OCID 3189 </para> 3190 </listitem> 3191 3192 </itemizedlist> 3193 3194 <para> 3195 Some of these are settings for your &oci; account. They can 3196 be viewed using the &oci; Console. 3197 </para> 3198 </listitem> 3199 3200 <listitem> 3201 <para> 3202 Click <emphasis role="bold">Apply</emphasis> to save your 3203 changes. 3204 </para> 3205 3206 <para> 3207 Settings for your cloud profile are added to the 3208 <computeroutput>oci_config</computeroutput> file in your 3209 &product-name; global settings directory. 3210 </para> 3211 </listitem> 3212 3213 </orderedlist> 3214 3215 <para> 3216 To import an existing &oci; configuration file, do the 3217 following: 3218 </para> 3219 3220 <orderedlist> 3221 3222 <listitem> 3223 <para> 3224 Ensure that a <computeroutput>config</computeroutput> file 3225 is present in your &oci; configuration directory. For 3226 example, this is 3227 <computeroutput>$HOME/.oci/config</computeroutput> on a 3228 Linux host. 3229 </para> 3230 </listitem> 3231 3232 <listitem> 3233 <para> 3234 Click the <emphasis role="bold">Import</emphasis> icon. 3235 </para> 3236 3237 <para> 3238 A dialog prompting you to import cloud profiles from 3239 external files is shown. 3240 </para> 3241 3242 <warning> 3243 <para> 3244 The dialog warns you that any cloud profiles in your 3245 &product-name; global settings directory will be 3246 overwritten. 3247 </para> 3248 </warning> 3249 </listitem> 3250 3251 <listitem> 3252 <para> 3253 Click <emphasis role="bold">Import</emphasis>. 3254 </para> 3255 3256 <para> 3257 Settings for your cloud profile are added to the 3258 <computeroutput>oci_config</computeroutput> file in your 3259 &product-name; global settings directory. 3260 </para> 3261 </listitem> 3262 3263 <listitem> 3264 <para> 3265 Click <emphasis role="bold">Properties</emphasis> to display 3266 settings for the cloud profile. 3267 </para> 3268 3269 <para> 3270 To change a setting, double-click on the required field. 3271 </para> 3272 </listitem> 3273 3274 <listitem> 3275 <para> 3276 Click <emphasis role="bold">Apply</emphasis> to save your 3277 changes. 3278 </para> 3279 </listitem> 3280 3281 </orderedlist> 3282 3283 </sect2> 2593 3284 2594 3285 </sect1> … … 2599 3290 2600 3291 <para> 2601 The Global Settings dialog can be displayed using the2602 <emphasis role="bold">File</emphasis> menu, by clicking the2603 <emphasis role="bold">Preferences</emphasis> item. This dialog2604 offers a selection of settings, most of which apply to all virtual2605 machines of the current user. The3292 The <emphasis role="bold">Global Settings</emphasis> dialog can be 3293 displayed using the <emphasis role="bold">File</emphasis> menu, by 3294 clicking the <emphasis role="bold">Preferences</emphasis> item. 3295 This dialog offers a selection of settings, most of which apply to 3296 all virtual machines of the current user. The 2606 3297 <emphasis role="bold">Extensions</emphasis> option applies to the 2607 3298 entire system. … … 2625 3316 <para> 2626 3317 <emphasis role="bold">Input.</emphasis> Enables the user to 2627 specify the Host yey. It identifies the key that toggles3318 specify the Host key. It identifies the key that toggles 2628 3319 whether the cursor is in the focus of the VM or the Host 2629 3320 operating system windows, see 2630 3321 <xref linkend="keyb_mouse_normal"/>, and which is also used to 2631 3322 trigger certain VM actions, see 2632 <xref 2633 linkend="specialcharacters"/>. 3323 <xref linkend="specialcharacters"/>. 2634 3324 </para> 2635 3325 </listitem> … … 2652 3342 <para> 2653 3343 <emphasis role="bold">Display.</emphasis> Enables the user to 2654 specify the screen resolution, and its width and height. 3344 specify the screen resolution, and its width and height. A 3345 default scale factor can be specified for all guest screens. 2655 3346 </para> 2656 3347 </listitem> … … 2687 3378 <para> 2688 3379 As briefly mentioned in <xref linkend="features-overview" />, 2689 VirtualBox has a very flexible internal design that allows for 2690 using multiple interfaces to control the same virtual machines. 2691 For example, you can start a virtual machine with the VirtualBox 2692 Manager window and then stop it from the command line. With 2693 VirtualBox's support for the Remote Desktop Protocol (RDP), you 2694 can even run virtual machines remotely on a headless server and 2695 have all the graphical output redirected over the network. 2696 </para> 2697 2698 <para> 2699 The following front-ends are shipped in the standard VirtualBox 2700 package: 3380 &product-name; has a very flexible internal design that enables 3381 you to use multiple interfaces to control the same virtual 3382 machines. For example, you can start a virtual machine with the 3383 VirtualBox Manager window and then stop it from the command line. 3384 With &product-name;'s support for the Remote Desktop Protocol 3385 (RDP), you can even run virtual machines remotely on a headless 3386 server and have all the graphical output redirected over the 3387 network. 3388 </para> 3389 3390 <para> 3391 The following front-ends are shipped in the standard 3392 &product-name; package: 2701 3393 </para> 2702 3394 … … 2705 3397 <listitem> 2706 3398 <para> 2707 <computeroutput>VirtualBox</computeroutput> is the VirtualBox 2708 Manager. This graphical user interface uses the Qt toolkit, 2709 and is described throughout this User Manual. While this is 2710 the simplest and easiest front-end to use, some of the more 2711 advanced VirtualBox features are not included. 2712 </para> 2713 </listitem> 2714 2715 <listitem> 2716 <para> 2717 <computeroutput>VBoxManage</computeroutput> is a command-line 3399 <emphasis role="bold">VirtualBox.</emphasis> This is the 3400 VirtualBox Manager, a graphical user interface that uses the 3401 Qt toolkit. This interface is described throughout this 3402 manual. While this is the simplest and easiest front-end to 3403 use, some of the more advanced &product-name; features are not 3404 included. 3405 </para> 3406 </listitem> 3407 3408 <listitem> 3409 <para> 3410 <emphasis role="bold">VBoxManage.</emphasis> A command-line 2718 3411 interface for automated and detailed control of every aspect 2719 of VirtualBox. See <xref 3412 of &product-name;. See 3413 <xref 2720 3414 linkend="vboxmanage" />. 2721 3415 </para> … … 2724 3418 <listitem> 2725 3419 <para> 2726 <computeroutput>VBoxSDL</computeroutput> is an alternative, 2727 simple graphical front-end with an intentionally limited 2728 feature set, designed to only display virtual machines that 2729 are controlled in detail with 2730 <computeroutput>VBoxManage</computeroutput>. This can be used 2731 in environments where displaying all the features of the full 2732 GUI is not feasible. See <xref 2733 linkend="vboxsdl" />. 2734 </para> 2735 </listitem> 2736 2737 <listitem> 2738 <para> 2739 <computeroutput>VBoxHeadless</computeroutput> is a front-end 3420 <emphasis role="bold">VBoxHeadless.</emphasis> A front-end 2740 3421 that produces no visible output on the host at all, but can 2741 3422 act as a RDP server if the VirtualBox Remote Desktop Extension … … 2745 3426 host your virtual machines on a headless Linux server that has 2746 3427 no X Window system installed. See 2747 <xref 2748 linkend="vboxheadless" />. 3428 <xref linkend="vboxheadless" />. 2749 3429 </para> 2750 3430 </listitem> … … 2755 3435 If the above front-ends still do not satisfy your particular 2756 3436 needs, it is possible to create yet another front-end to the 2757 complex virtualization engine that is the core of VirtualBox, as2758 the VirtualBox core neatly exposes all of its features in a clean2759 API. See <xref linkend="VirtualBoxAPI" />.3437 complex virtualization engine that is the core of &product-name;, 3438 as the &product-name; core neatly exposes all of its features in a 3439 clean API. See <xref linkend="VirtualBoxAPI" />. 2760 3440 </para> 2761 3441 -
trunk/doc/manual/en_US/user_KnownIssues.xml
r75474 r76078 14 14 15 15 <para> 16 Some VirtualBoxfeatures are labeled as experimental. Such16 Some &product-name; features are labeled as experimental. Such 17 17 features are provided on an "as-is" basis and are not formally 18 18 supported. However, feedback and suggestions about such features … … 26 26 <para> 27 27 Hardware 3D acceleration support for Windows, Linux, and 28 Solaris guests28 Oracle Solaris guests 29 29 </para> 30 30 </listitem> … … 69 69 <listitem> 70 70 <para> 71 Support of iSCSI via internal networking 71 Support of iSCSI using internal networking 72 </para> 73 </listitem> 74 75 <listitem> 76 <para> 77 Using &product-name; and Hyper-V on the same host 72 78 </para> 73 79 </listitem> … … 83 89 <para> 84 90 The following section describes known problems with this release 85 of VirtualBox. Unless marked otherwise, these issues are planned86 to be fixed in later releases.91 of &product-name;. Unless marked otherwise, these issues are 92 planned to be fixed in later releases. 87 93 </para> 88 94 … … 101 107 <emphasis role="bold">Poor performance</emphasis> with 102 108 32-bit guests on AMD CPUs. This affects mainly Windows and 103 Solaris guests, but possibly also some Linux kernel104 revisions. Partially solved in 3.0.6 for 32 bitsWindows105 NT, 2000, XP and 2003 guests. Requires 3.0.6 or higher106 Guest Additionsto be installed.109 Oracle Solaris guests, but possibly also some Linux kernel 110 revisions. Partially solved in 3.0.6 for 32-bit Windows 111 NT, 2000, XP, and 2003 guests. Requires Guest Additions 112 3.0.6 or later to be installed. 107 113 </para> 108 114 </listitem> … … 113 119 32-bit guests on certain Intel CPU models that do not 114 120 include virtual APIC hardware optimization support. This 115 affects mainly Windows and Solaris guests, but possibly 116 also some Linux kernel revisions. Partially solved in 117 3.0.12 for 32 bits Windows NT, 2000, XP, and 2003 guests. 118 Requires 3.0.12 or higher Guest Additions to be installed. 121 affects mainly Windows and Oracle Solaris guests, but 122 possibly also some Linux kernel revisions. Partially 123 solved in 3.0.12 for 32-bit Windows NT, 2000, XP, and 2003 124 guests. Requires Guest Additions 3.0.12 or later to be 125 installed. 119 126 </para> 120 127 </listitem> … … 136 143 For <emphasis role="bold">basic Direct3D support in Windows 137 144 guests</emphasis> to work, the Guest Additions must be 138 installed in Windows "safe mode". Press F8 when the Windows139 guest is booting and select "Safe mode", then install the140 Guest Additions. Otherwise the Windows file protection141 mechanism will interfere with the replacement DLLs installed142 by VirtualBox and keep restoring the original Windows system143 DLLs.144 145 <note> 146 <para>147 This does <emphasis>not</emphasis> apply to the WDDM148 Direct3D video driver available for Vista and Windows 7149 guests shipped with VirtualBox 4.1.150 </para>151 </ note>152 </ para>145 installed in Windows safe mode. Press F8 when the Windows 146 guest is booting and select <emphasis role="bold">Safe 147 Mode</emphasis>, then install the Guest Additions. Otherwise 148 the Windows file protection mechanism will interfere with the 149 replacement DLLs installed by &product-name; and keep 150 restoring the original Windows system DLLs. 151 </para> 152 153 <note> 154 <para> 155 This does <emphasis>not</emphasis> apply to the WDDM 156 Direct3D video driver available for Vista and Windows 7 157 guests shipped with &product-name; 4.1. 158 </para> 159 </note> 153 160 </listitem> 154 161 … … 156 163 <para> 157 164 <emphasis role="bold">Guest control.</emphasis> On Windows 158 guests, a process lauched viathe guest control execute165 guests, a process started using the guest control execute 159 166 support will not be able to display a graphical user interface 160 167 <emphasis>unless</emphasis> the user account under which it is … … 166 173 guest's group policy must be changed. To do so, open the group 167 174 policy editor on the command line by typing 168 <com puteroutput>gpedit.msc</computeroutput>, open the key169 < emphasis>Computer Configuration\Windows Settings\Security170 Settings\ Local Policies\Security Options</emphasis> and change171 the value of <emphasis>Accounts: Limit local account use of172 blank passwords to console logon only</emphasis> to173 <emphasis>Disabled</emphasis>.175 <command>gpedit.msc</command>, open the key 176 <computeroutput>Computer Configuration\Windows 177 Settings\Security Settings\Local Policies\Security 178 Options</computeroutput> and change the value of 179 <computeroutput>Accounts: Limit local account use of blank 180 passwords to console logon only</computeroutput> to Disabled. 174 181 </para> 175 182 </listitem> … … 178 185 <para> 179 186 <emphasis role="bold">Compacting virtual disk images is 180 limited to VDI files.</emphasis> The <co de>VBoxManage modifyhd181 --compact</code> command is currently only implemented for VDI182 files. At the moment the only way to optimize the size of a183 virtual disk images in other formats (VMDK, VHD) is to clone184 the image and then use the cloned image in the VM185 c onfiguration.187 limited to VDI files.</emphasis> The <command>VBoxManage 188 modifyhd --compact</command> command is currently only 189 implemented for VDI files. At the moment the only way to 190 optimize the size of a virtual disk images in other formats, 191 such as VMDK or VHD, is to clone the image and then use the 192 cloned image in the VM configuration. 186 193 </para> 187 194 </listitem> … … 218 225 <listitem> 219 226 <para> 220 Remote files viaHTTP or other mechanisms are not yet227 Remote files using HTTP or other mechanisms are not yet 221 228 supported. 222 229 </para> … … 238 245 <listitem> 239 246 <para> 240 The RDP server in the VirtualBox extension pack supports only 241 audio streams in format 22.05kHz stereo 16 bit. If the RDP 242 client requests any other audio format there will be no audio. 247 The RDP server in the &product-name; extension pack supports 248 only audio streams in format 22.05kHz stereo 16 bit. If the 249 RDP client requests any other audio format there will be no 250 audio. 243 251 </para> 244 252 </listitem> … … 298 306 <listitem> 299 307 <para> 300 VirtualBox does not provide Guest Additions for Mac OS X301 at this time.308 &product-name; does not provide Guest Additions for Mac OS 309 X at this time. 302 310 </para> 303 311 </listitem> … … 330 338 <listitem> 331 339 <para> 332 By default, the VirtualBox EFI enables debug output of the333 Mac OS X kernel to help you diagnose boot problems. Note334 that there is a lot of output and not all errors are340 By default, the &product-name; EFI enables debug output of 341 the Mac OS X kernel to help you diagnose boot problems. 342 Note that there is a lot of output and not all errors are 335 343 fatal. They would also show when using a physical Apple 336 344 Macintosh computer. You can turn off these messages by 337 issuing this command: 345 using the following command: 346 </para> 338 347 339 348 <screen>VBoxManage setextradata "VM name" "VBoxInternal2/EfiBootArgs" " "</screen> 340 349 341 To revert to the previous behavior, use: 350 <para> 351 To revert to the previous behavior, use the following 352 command: 353 </para> 342 354 343 355 <screen>VBoxManage setextradata "VM name" "VBoxInternal2/EfiBootArgs" ""</screen> 344 </para>345 356 </listitem> 346 357 … … 358 369 <listitem> 359 370 <para> 360 <emphasis role="bold"> Solaris hosts:</emphasis>371 <emphasis role="bold">Oracle Solaris hosts:</emphasis> 361 372 </para> 362 373 … … 365 376 <listitem> 366 377 <para> 367 There is no support for USB devices connected to Solaris368 10 hosts.369 </para> 370 </listitem> 371 372 <listitem> 373 <para> 374 USB support on Solaris hosts requires Solaris 11 version375 snv_124 or higher. Webcams and other isochronous devices376 are known to have poor performance.378 There is no support for USB devices connected to Oracle 379 Solaris 10 hosts. 380 </para> 381 </listitem> 382 383 <listitem> 384 <para> 385 USB support on Oracle Solaris hosts requires Oracle 386 Solaris 11 version snv_124 or later. Webcams and other 387 isochronous devices are known to have poor performance. 377 388 </para> 378 389 </listitem> … … 381 392 <para> 382 393 Host Webcam passthrough is restricted to 640x480 frames at 383 20 frames per second due to limitations in the Solaris384 V4L2 API. This may be addressed in a future Solaris385 release.394 20 frames per second due to limitations in the Oracle 395 Solaris V4L2 API. This may be addressed in a future Oracle 396 Solaris release. 386 397 </para> 387 398 </listitem> … … 403 414 <listitem> 404 415 <para> 405 Crossbow-based bridged networking on Solaris 11 hosts does 406 not work directly with aggregate links. However, you can 407 use <computeroutput>dladm</computeroutput> to manually 408 create a VNIC over the aggregate link and use that with a 409 VM. This limitation does not exist in Solaris 11u1 build 410 17 and newer. 416 Crossbow-based bridged networking on Oracle Solaris 11 417 hosts does not work directly with aggregate links. 418 However, you can use 419 <computeroutput>dladm</computeroutput> to manually create 420 a VNIC over the aggregate link and use that with a VM. 421 This limitation does not exist in Oracle Solaris 11u1 422 build 17 and newer. 411 423 </para> 412 424 </listitem> … … 418 430 <para> 419 431 <emphasis role="bold">Guest Additions of version 4.1, 4.1.2 420 and 4.1.4 for Windows.</emphasis> The VirtualBox WDDM Video421 driver may be installed and remain in the guest system when422 Guest additions uninstallation is performed. This is caused by423 a bug in Guest Additions uninstaller.432 and 4.1.4 for Windows.</emphasis> The &product-name; WDDM 433 Video driver may be installed and remain in the guest system 434 when Guest additions uninstallation is performed. This is 435 caused by a bug in Guest Additions uninstaller. 424 436 </para> 425 437 … … 433 445 434 446 <para> 435 To solve this problem, uninstall the VirtualBoxWDDM Video447 To solve this problem, uninstall the &product-name; WDDM Video 436 448 driver manually. Open Device Manager, and check whether the 437 Display Adapter is named " VirtualBox Graphics Adapter ..". If438 not, there is nothing to be done. If it is, right-click the439 VirtualBoxGraphics Adapter in Device Manager, select449 Display Adapter is named "&product-name; Graphics Adapter ..". 450 If not, there is nothing to be done. If it is, right-click the 451 &product-name; Graphics Adapter in Device Manager, select 440 452 <emphasis role="bold">Uninstall</emphasis>, check 441 453 <emphasis role="bold">Delete the Driver Software for this 442 454 Device</emphasis> and click 443 455 <emphasis role="bold">OK</emphasis>. Once uninstallation is 444 done, start Device Manager, go to the Action menu and select 456 done, start Device Manager, go to the 457 <emphasis role="bold">Action</emphasis> menu and select 445 458 <emphasis role="bold">Scan for Hardware Change</emphasis>s to 446 459 ensure that the correct Windows default driver be picked up -
trunk/doc/manual/en_US/user_Networking.xml
r75206 r76078 10 10 11 11 <para> 12 As mentioned in <xref linkend="settings-network" />, VirtualBox12 As mentioned in <xref linkend="settings-network" />, &product-name; 13 13 provides up to eight virtual PCI Ethernet cards for each virtual 14 14 machine. For each such card, you can individually select the … … 34 34 35 35 <para> 36 Four of the network cards can be configured in the Network section 37 of the settings dialog in the graphical user interface of 38 VirtualBox. You can configure all eight network cards on the command 39 line using VBoxManage modifyvm. See 40 <xref linkend="vboxmanage-modifyvm" />. 36 Four of the network cards can be configured in the 37 <emphasis role="bold">Network</emphasis> section of the 38 <emphasis role="bold">Settings</emphasis> dialog in the graphical 39 user interface of &product-name;. You can configure all eight 40 network cards on the command line using <command>VBoxManage 41 modifyvm</command>. See <xref linkend="vboxmanage-modifyvm" />. 41 42 </para> 42 43 … … 53 54 For each card, you can individually select what kind of 54 55 <emphasis>hardware</emphasis> will be presented to the virtual 55 machine. VirtualBoxcan virtualize the following types of56 machine. &product-name; can virtualize the following types of 56 57 networking hardware: 57 58 </para> … … 115 116 <para> 116 117 The Paravirtualized network adapter (virtio-net) is special. If 117 you select this adapter, then VirtualBoxdoes118 you select this adapter, then &product-name; does 118 119 <emphasis>not</emphasis> virtualize common networking hardware 119 120 that is supported by common guest operating systems. Instead, 120 VirtualBox expects a special software interface for virtualized121 environments to be provided by the guest, thus avoiding the122 complexity of emulating networking hardware and improving network123 performance. Starting with version 3.1, VirtualBox provides124 support for the industry-standard <emphasis>virtio</emphasis>125 networkingdrivers, which are part of the open source KVM project.121 &product-name; expects a special software interface for 122 virtualized environments to be provided by the guest, thus 123 avoiding the complexity of emulating networking hardware and 124 improving network performance. &product-name; provides support for 125 the industry-standard <emphasis>virtio</emphasis> networking 126 drivers, which are part of the open source KVM project. 126 127 </para> 127 128 … … 149 150 <para> 150 151 <ulink 151 url="http://www.linux-kvm.org/page/WindowsGuestDrivers"/>.152 url="http://www.linux-kvm.org/page/WindowsGuestDrivers">http://www.linux-kvm.org/page/WindowsGuestDrivers</ulink>. 152 153 </para> 153 154 </listitem> … … 156 157 157 158 <para> 158 VirtualBoxalso has limited support for <emphasis>jumbo159 &product-name; also has limited support for <emphasis>jumbo 159 160 frames</emphasis>. These are networking packets with more than 160 161 1500 bytes of data, provided that you use the Intel card … … 185 186 <para> 186 187 <emphasis role="bold">Not attached.</emphasis> In this mode, 187 VirtualBoxreports to the guest that a network card is188 &product-name; reports to the guest that a network card is 188 189 present, but that there is no connection. This is as if no 189 190 Ethernet cable was plugged into the card. Using this mode, it … … 209 210 <listitem> 210 211 <para> 211 <emphasis role="bold">NAT Network.</emphasis> The NAT network212 is a new NAT flavour introduced in VirtualBox 4.3. See213 <xref linkend="network_nat_service"/>.212 <emphasis role="bold">NAT Network.</emphasis> A NAT network is 213 a type of internal network that allows outbound connections. 214 See <xref linkend="network_nat_service"/>. 214 215 </para> 215 216 </listitem> … … 220 221 for more advanced networking needs, such as network 221 222 simulations and running servers in a guest. When enabled, 222 VirtualBox connects to one of your installed network cards and223 exchanges network packets directly, circumventing your host224 operating system's network stack.223 &product-name; connects to one of your installed network cards 224 and exchanges network packets directly, circumventing your 225 host operating system's network stack. 225 226 </para> 226 227 </listitem> … … 251 252 used modes which share the same generic network interface, by 252 253 allowing the user to select a driver which can be included 253 with VirtualBoxor be distributed in an extension pack.254 with &product-name; or be distributed in an extension pack. 254 255 </para> 255 256 … … 275 276 Distributed Ethernet switch on a Linux or a FreeBSD host. 276 277 At the moment this option requires compilation of 277 VirtualBoxfrom sources, as the Oracle packages do not278 &product-name; from sources, as the Oracle packages do not 278 279 include it. 279 280 </para> … … 302 303 <row> 303 304 <entry></entry> 304 <entry><emphasis role="bold">VM→Host</emphasis></entry> 305 <entry><emphasis role="bold">VM←Host</emphasis></entry> 306 <entry><emphasis role="bold">VM1↔VM2</emphasis></entry> 307 <entry><emphasis role="bold">VM→Net/LAN</emphasis></entry> 308 <entry><emphasis role="bold">VM←Net/LAN</emphasis></entry> 305 <entry><para> 306 <emphasis role="bold">VM→Host</emphasis> 307 </para></entry> 308 <entry><para> 309 <emphasis role="bold">VM←Host</emphasis> 310 </para></entry> 311 <entry><para> 312 <emphasis role="bold">VM1↔VM2</emphasis> 313 </para></entry> 314 <entry><para> 315 <emphasis role="bold">VM→Net/LAN</emphasis> 316 </para></entry> 317 <entry><para> 318 <emphasis role="bold">VM←Net/LAN</emphasis> 319 </para></entry> 309 320 </row> 310 321 </thead> 311 322 <tbody valign="middle"> 312 323 <row> 313 <entry>Host-only</entry> 314 <entry><emphasis role="bold">+</emphasis></entry> 315 <entry><emphasis role="bold">+</emphasis></entry> 316 <entry align="center"><emphasis role="bold">+</emphasis></entry> 317 <entry>–</entry> 318 <entry>–</entry> 324 <entry><para> 325 Host-only 326 </para></entry> 327 <entry><para> 328 <emphasis role="bold">+</emphasis> 329 </para></entry> 330 <entry><para> 331 <emphasis role="bold">+</emphasis> 332 </para></entry> 333 <entry align="center"><para> 334 <emphasis role="bold">+</emphasis> 335 </para></entry> 336 <entry><para> 337 – 338 </para></entry> 339 <entry><para> 340 – 341 </para></entry> 319 342 </row> 320 343 <row> 321 <entry>Internal</entry> 322 <entry>–</entry> 323 <entry>–</entry> 324 <entry><emphasis role="bold">+</emphasis></entry> 325 <entry>–</entry> 326 <entry>–</entry> 344 <entry><para> 345 Internal 346 </para></entry> 347 <entry><para> 348 – 349 </para></entry> 350 <entry><para> 351 – 352 </para></entry> 353 <entry><para> 354 <emphasis role="bold">+</emphasis> 355 </para></entry> 356 <entry><para> 357 – 358 </para></entry> 359 <entry><para> 360 – 361 </para></entry> 327 362 </row> 328 363 <row> 329 <entry>Bridged</entry> 330 <entry><emphasis role="bold">+</emphasis></entry> 331 <entry><emphasis role="bold">+</emphasis></entry> 332 <entry><emphasis role="bold">+</emphasis></entry> 333 <entry><emphasis role="bold">+</emphasis></entry> 334 <entry><emphasis role="bold">+</emphasis></entry> 364 <entry><para> 365 Bridged 366 </para></entry> 367 <entry><para> 368 <emphasis role="bold">+</emphasis> 369 </para></entry> 370 <entry><para> 371 <emphasis role="bold">+</emphasis> 372 </para></entry> 373 <entry><para> 374 <emphasis role="bold">+</emphasis> 375 </para></entry> 376 <entry><para> 377 <emphasis role="bold">+</emphasis> 378 </para></entry> 379 <entry><para> 380 <emphasis role="bold">+</emphasis> 381 </para></entry> 335 382 </row> 336 383 <row> 337 <entry>NAT</entry> 338 <entry><emphasis role="bold">+</emphasis></entry> 339 <entry><link linkend="natforward">Port forward</link></entry> 340 <entry>–</entry> 341 <entry><emphasis role="bold">+</emphasis></entry> 342 <entry><link linkend="natforward">Port forward</link></entry> 384 <entry><para> 385 NAT 386 </para></entry> 387 <entry><para> 388 <emphasis role="bold">+</emphasis> 389 </para></entry> 390 <entry><para> 391 <link linkend="natforward">Port forward</link> 392 </para></entry> 393 <entry><para> 394 – 395 </para></entry> 396 <entry><para> 397 <emphasis role="bold">+</emphasis> 398 </para></entry> 399 <entry><para> 400 <link linkend="natforward">Port forward</link> 401 </para></entry> 343 402 </row> 344 403 <row> 345 <entry>NATservice</entry> 346 <entry><emphasis role="bold">+</emphasis></entry> 347 <entry><link linkend="network_nat_service">Port forward</link></entry> 348 <entry><emphasis role="bold">+</emphasis></entry> 349 <entry><emphasis role="bold">+</emphasis></entry> 350 <entry><link linkend="network_nat_service">Port forward</link></entry> 404 <entry><para> 405 NATservice 406 </para></entry> 407 <entry><para> 408 <emphasis role="bold">+</emphasis> 409 </para></entry> 410 <entry><para> 411 <link linkend="network_nat_service">Port forward</link> 412 </para></entry> 413 <entry><para> 414 <emphasis role="bold">+</emphasis> 415 </para></entry> 416 <entry><para> 417 <emphasis role="bold">+</emphasis> 418 </para></entry> 419 <entry><para> 420 <link linkend="network_nat_service">Port forward</link> 421 </para></entry> 351 422 </row> 352 423 </tbody> … … 369 440 an external network from a virtual machine. Usually, it does not 370 441 require any configuration on the host network and guest system. 371 For this reason, it is the default networking mode in VirtualBox. 442 For this reason, it is the default networking mode in 443 &product-name;. 372 444 </para> 373 445 … … 375 447 A virtual machine with NAT enabled acts much like a real computer 376 448 that connects to the Internet through a router. The router, in 377 this case, is the VirtualBox networking engine, which maps traffic378 from and to the virtual machine transparently. In VirtualBox this379 router is placed between each virtual machine and the host. This380 separation maximizes security since by default virtual machines381 cannot talk to each other.449 this case, is the &product-name; networking engine, which maps 450 traffic from and to the virtual machine transparently. In 451 &product-name; this router is placed between each virtual machine 452 and the host. This separation maximizes security since by default 453 virtual machines cannot talk to each other. 382 454 </para> 383 455 … … 391 463 <para> 392 464 The network frames sent out by the guest operating system are 393 received by VirtualBox's NAT engine, which extracts the TCP/IP465 received by &product-name;'s NAT engine, which extracts the TCP/IP 394 466 data and resends it using the host operating system. To an 395 467 application on the host, or to another computer on the same 396 468 network as the host, it looks like the data was sent by the 397 VirtualBox application on the host, using an IP address belonging398 to the host. VirtualBox listens for replies to the packages sent,399 and repacks and resends them to the guest machine on its private400 network.469 &product-name; application on the host, using an IP address 470 belonging to the host. &product-name; listens for replies to the 471 packages sent, and repacks and resends them to the guest machine 472 on its private network. 401 473 </para> 402 474 … … 404 476 The virtual machine receives its network address and configuration 405 477 on the private network from a DHCP server integrated into 406 VirtualBox. The IP address thus assigned to the virtual machine is407 usually on a completely different network than the host. As more408 than one card of a virtual machine can be set up to use NAT, the409 first card is connected to the private network 10.0.2.0, the410 second card to the network 10.0.3.0 and so on. If you need to411 change the guest-assigned IP range, see478 &product-name;. The IP address thus assigned to the virtual 479 machine is usually on a completely different network than the 480 host. As more than one card of a virtual machine can be set up to 481 use NAT, the first card is connected to the private network 482 10.0.2.0, the second card to the network 10.0.3.0 and so on. If 483 you need to change the guest-assigned IP range, see 412 484 <xref linkend="changenat" />. 413 485 </para> … … 419 491 <para> 420 492 As the virtual machine is connected to a private network 421 internal to VirtualBoxand invisible to the host, network493 internal to &product-name; and invisible to the host, network 422 494 services on the guest are not accessible to the host machine or 423 495 to other computers on the same network. However, like a physical 424 router, VirtualBox can make selected services available to the425 world outside the guest through <emphasis>port426 forwarding</emphasis>. This means that VirtualBoxlistens to496 router, &product-name; can make selected services available to 497 the world outside the guest through <emphasis>port 498 forwarding</emphasis>. This means that &product-name; listens to 427 499 certain ports on the host and resends all packets which arrive 428 500 there to the guest, on the same or a different port. … … 430 502 431 503 <para> 432 To an application on the host or other physical (or virtual)504 To an application on the host or other physical or virtual 433 505 machines on the network, it looks as though the service being 434 506 proxied is actually running on the host. This also means that … … 442 514 443 515 <para> 444 To configure port forwarding you can use the graphical Port 445 Forwarding editor which can be found in the Network Settings 446 dialog for network adaptors configured to use NAT. Here, you can 447 map host ports to guest ports to allow network traffic to be 448 routed to a specific port in the guest. 516 To configure port forwarding you can use the graphical 517 <emphasis role="bold">Port Forwarding</emphasis> editor which 518 can be found in the <emphasis role="bold">Network 519 Settings</emphasis> dialog for network adaptors configured to 520 use NAT. Here, you can map host ports to guest ports to allow 521 network traffic to be routed to a specific port in the guest. 449 522 </para> 450 523 451 524 <para> 452 525 Alternatively, the command line tool 453 <com puteroutput>VBoxManage</computeroutput> can be used. See526 <command>VBoxManage</command> can be used. See 454 527 <xref linkend="vboxmanage-modifyvm" />. 455 528 </para> … … 463 536 <computeroutput>ssh</computeroutput> server in the guest, use 464 537 the following command: 538 </para> 465 539 466 540 <screen>VBoxManage modifyvm "VM name" --natpf1 "guestssh,tcp,,2222,,22"</screen> 467 541 468 With the above example, all TCP traffic arriving on port 2222 on 542 <para> 543 In the above example, all TCP traffic arriving on port 2222 on 469 544 any host interface will be forwarded to port 22 in the guest. 470 545 The protocol name <computeroutput>tcp</computeroutput> is a … … 473 548 used. The name <computeroutput>guestssh</computeroutput> is 474 549 purely descriptive and will be auto-generated if omitted. The 475 number after < computeroutput>--natpf</computeroutput> denotes476 the network card, as with other VBoxManage command.550 number after <option>--natpf</option> denotes the network card, 551 as with other <command>VBoxManage</command> commands. 477 552 </para> 478 553 479 554 <para> 480 555 To remove this forwarding rule, use the following command: 556 </para> 481 557 482 558 <screen>VBoxManage modifyvm "VM name" --natpf1 delete "guestssh"</screen> 483 </para>484 559 485 560 <para> 486 561 If for some reason the guest uses a static assigned IP address 487 562 not leased from the built-in DHCP server, it is required to 488 specify the guest IP when registering the forwarding rule: 563 specify the guest IP when registering the forwarding rule, as 564 follows: 565 </para> 489 566 490 567 <screen>VBoxManage modifyvm "VM name" --natpf1 "guestssh,tcp,,2222,10.0.2.19,22"</screen> 491 568 569 <para> 492 570 This example is identical to the previous one, except that the 493 571 NAT engine is being told that the guest can be found at the … … 498 576 To forward <emphasis>all</emphasis> incoming traffic from a 499 577 specific host interface to the guest, specify the IP of that 500 host interface like this: 578 host interface as follows: 579 </para> 501 580 502 581 <screen>VBoxManage modifyvm "VM name" --natpf1 "guestssh,tcp,127.0.0.1,2222,,22"</screen> 503 582 504 This forwards all TCP traffic arriving on the localhost 505 interface (127.0.0.1) via port 2222 to port 22 in the guest. 583 <para> 584 This example forwards all TCP traffic arriving on the localhost 585 interface at 127.0.0.1 through port 2222 to port 22 in the 586 guest. 506 587 </para> 507 588 … … 546 627 <computeroutput>ping</computeroutput> or tracerouting, rely 547 628 on the ICMP protocol for sending and receiving messages. 548 While ICMP support has been improved with VirtualBox 2.1,549 meaning <computeroutput>ping</computeroutput> should now550 work, some other tools may not work reliably.629 While ICMP support has been improved with &product-name; 630 2.1, meaning <computeroutput>ping</computeroutput> should 631 now work, some other tools may not work reliably. 551 632 </para> 552 633 </listitem> … … 579 660 <para> 580 661 <emphasis role="bold">Forwarding host ports below 581 1024.</emphasis> On U nix-based hosts, such as Linux,662 1024.</emphasis> On UNIX-based hosts, such as Linux, Oracle 582 663 Solaris, and Mac OS X, it is not possible to bind to ports 583 664 below 1024 from applications that are not run by … … 621 702 network. The name of internal network is chosen when the NAT 622 703 service is created and the internal network will be created if it 623 does not already exist. An example command to create a NAT network 624 is: 625 </para> 626 627 <para> 704 does not already exist. The following is an example command to 705 create a NAT network: 706 </para> 707 628 708 <screen>VBoxManage natnetwork add --netname natnet1 --network "192.168.15.0/24" --enable</screen> 629 </para>630 709 631 710 <para> … … 635 714 will be assigned the address 192.168.15.1, the address following 636 715 the interface address, though this is subject to change. To attach 637 a DHCP server to the internal network, we modify the example as 638 follows: 639 </para> 640 641 <para> 716 a DHCP server to the internal network, modify the example command 717 as follows: 718 </para> 719 642 720 <screen>VBoxManage natnetwork add --netname natnet1 --network "192.168.15.0/24" --enable --dhcp on</screen> 643 </para> 644 645 <para> 646 To add a DHCP server to an existing network: 647 </para> 648 649 <para> 721 722 <para> 723 To add a DHCP server to an existing network, use the following 724 command: 725 </para> 726 650 727 <screen>VBoxManage natnetwork modify --netname natnet1 --dhcp on</screen> 651 </para> 652 653 <para> 654 To disable the DHCP server: 655 </para> 656 657 <para> 728 729 <para> 730 To disable the DHCP server, use the following command: 731 </para> 732 658 733 <screen>VBoxManage natnetwork modify --netname natnet1 --dhcp off</screen> 659 </para>660 734 661 735 <para> … … 668 742 </para> 669 743 670 <para>671 744 <screen>VBoxManage natnetwork start --netname natnet1</screen> 672 </para>673 745 674 746 <para> … … 678 750 679 751 <para> 680 To stops the NAT network service, together with any DHCP server: 681 </para> 682 683 <para> 752 To stop the NAT network service, together with any DHCP server: 753 </para> 754 684 755 <screen>VBoxManage natnetwork stop --netname natnet1</screen> 685 </para>686 756 687 757 <para> … … 689 759 </para> 690 760 691 <para>692 761 <screen>VBoxManage natnetwork remove --netname natnet1</screen> 693 </para>694 762 695 763 <para> … … 705 773 </para> 706 774 707 <para>708 775 <screen>VBoxManage natnetwork modify \ 709 776 --netname natnet1 --port-forward-4 "ssh:tcp:[]:1022:[192.168.15.5]:22"</screen> 710 </para>711 777 712 778 <para> 713 779 This adds a port-forwarding rule from the host's TCP 1022 port to 714 780 the port 22 on the guest with IP address 192.168.15.5. Host port, 715 guest port and guest IP are mandatory. To delete the rule, use :716 </para>717 718 <para> 781 guest port and guest IP are mandatory. To delete the rule, use the 782 following command: 783 </para> 784 719 785 <screen>VBoxManage natnetwork modify --netname natnet1 --port-forward-4 delete ssh</screen> 720 </para>721 786 722 787 <para> … … 728 793 729 794 <para> 730 To see the list of registered NAT networks, use :731 </para>732 733 <para> 795 To see the list of registered NAT networks, use the following 796 command: 797 </para> 798 734 799 <screen>VBoxManage list natnetworks</screen> 735 </para>736 800 737 801 </sect1> … … 742 806 743 807 <para> 744 With bridged networking, VirtualBox uses a device driver on your745 <emphasis>host</emphasis> system that filters data from your808 With bridged networking, &product-name; uses a device driver on 809 your <emphasis>host</emphasis> system that filters data from your 746 810 physical network adapter. This driver is therefore called a 747 <emphasis>net filter</emphasis> driver. This allows VirtualBox to 748 intercept data from the physical network and inject data into it, 749 effectively creating a new network interface in software. When a 750 guest is using such a new software interface, it looks to the host 751 system as though the guest were physically connected to the 752 interface using a network cable. The host can send data to the 753 guest through that interface and receive data from it. This means 754 that you can set up routing or bridging between the guest and the 755 rest of your network. 756 </para> 757 758 <para> 759 For this to work, VirtualBox needs a device driver on your host 760 system. The way bridged networking works has been completely 761 rewritten with VirtualBox 2.0 and 2.1, depending on the host 762 operating system. From the user perspective, the main difference 763 is that complex configuration is no longer necessary on any of the 764 supported host operating systems. 765 766 <footnote> 767 768 <para> 769 For Mac OS X and Solaris hosts, net filter drivers were 770 already added in VirtualBox 2.0, as initial support for Host 771 Interface Networking on these platforms. With VirtualBox 2.1, 772 net filter drivers were also added for the Windows and Linux 773 hosts, replacing the mechanisms previously present in 774 VirtualBox for those platforms; especially on Linux, the 775 earlier method required creating TAP interfaces and bridges, 776 which was complex and varied from one distribution to the 777 next. None of this is necessary anymore. Bridged network was 778 formerly called Host Interface Networking and has been renamed 779 with version 2.2 without any change in functionality. 780 </para> 781 782 </footnote> 811 <emphasis>net filter</emphasis> driver. This enables 812 &product-name; to intercept data from the physical network and 813 inject data into it, effectively creating a new network interface 814 in software. When a guest is using such a new software interface, 815 it looks to the host system as though the guest were physically 816 connected to the interface using a network cable. The host can 817 send data to the guest through that interface and receive data 818 from it. This means that you can set up routing or bridging 819 between the guest and the rest of your network. 783 820 </para> 784 821 785 822 <note> 786 823 <para> 787 Even though TAP i s no longer necessary on Linux with bridged788 networking, you <emphasis>can</emphasis> still use TAP824 Even though TAP interfaces are no longer necessary on Linux for 825 bridged networking, you <emphasis>can</emphasis> still use TAP 789 826 interfaces for certain advanced setups, since you can connect a 790 827 VM to any host interface. … … 793 830 794 831 <para> 795 To enable bridged networking, open the Settings dialog of a 796 virtual machine, go to the Network page and select 797 <emphasis role="bold">Bridged Network</emphasis> in the drop-down 798 list for the Attached To field. Select a host interface from the 799 list at the bottom of the page, which contains the physical 800 network interfaces of your systems. On a typical MacBook, for 801 example, this will allow you to select between en1: AirPort, which 802 is the wireless interface, and en0: Ethernet, which represents the 803 interface with a network cable. 832 To enable bridged networking, open the 833 <emphasis role="bold">Settings</emphasis> dialog of a virtual 834 machine, go to the <emphasis role="bold">Network</emphasis> page 835 and select <emphasis role="bold">Bridged Network</emphasis> in the 836 drop-down list for the <emphasis role="bold">Attached 837 To</emphasis> field. Select a host interface from the list at the 838 bottom of the page, which contains the physical network interfaces 839 of your systems. On a typical MacBook, for example, this will 840 allow you to select between en1: AirPort, which is the wireless 841 interface, and en0: Ethernet, which represents the interface with 842 a network cable. 804 843 </para> 805 844 … … 809 848 bridging to a wired interface, because most wireless adapters do 810 849 not support promiscuous mode. All traffic has to use the MAC 811 address of the host's wireless adapter, and therefore VirtualBox812 needs to replace the source MAC address in the Ethernet header813 of an outgoing packet to make sure the reply will be sent to the814 host interface. When VirtualBox sees an incoming packet with a815 destination IP address that belongs to one of the virtual816 machine adapters it replaces the destination MAC address in the817 Ethernet header with the VM adapter's MAC address and passes it818 on. VirtualBox examines ARP and DHCP packets in order to learn819 the IP addresses of virtual machines.850 address of the host's wireless adapter, and therefore 851 &product-name; needs to replace the source MAC address in the 852 Ethernet header of an outgoing packet to make sure the reply 853 will be sent to the host interface. When &product-name; sees an 854 incoming packet with a destination IP address that belongs to 855 one of the virtual machine adapters it replaces the destination 856 MAC address in the Ethernet header with the VM adapter's MAC 857 address and passes it on. &product-name; examines ARP and DHCP 858 packets in order to learn the IP addresses of virtual machines. 820 859 </para> 821 860 </note> … … 832 871 <emphasis role="bold">Mac OS X hosts.</emphasis> Functionality 833 872 is limited when using AirPort, the Mac's wireless networking 834 system, for bridged networking. Currently, VirtualBox supports835 only IPv4 and IPv6 over AirPort. For other protocols, such as836 IPX, you must choose a wired interface.873 system, for bridged networking. Currently, &product-name; 874 supports only IPv4 and IPv6 over AirPort. For other protocols, 875 such as IPX, you must choose a wired interface. 837 876 </para> 838 877 </listitem> … … 842 881 <emphasis role="bold">Linux hosts.</emphasis> Functionality is 843 882 limited when using wireless interfaces for bridged networking. 844 Currently, VirtualBoxsupports only IPv4 and IPv6 over883 Currently, &product-name; supports only IPv4 and IPv6 over 845 884 wireless. For other protocols, such as IPX, you must choose a 846 885 wired interface. … … 856 895 <para> 857 896 Some adapters strip VLAN tags in hardware. This does not allow 858 to use VLAN trunking between VM and the external network with 859 pre-2.6.27 Linux kernels nor with host operating systems other 860 than Linux. 861 </para> 862 </listitem> 863 864 <listitem> 865 <para> 866 <emphasis role="bold">Solaris hosts.</emphasis> There is no 867 support for using wireless interfaces. Filtering guest traffic 868 using IPFilter is also not completely supported due to 869 technical restrictions of the Solaris networking subsystem. 870 These issues would be addressed in a future release of Solaris 871 11. 872 </para> 873 874 <para> 875 Starting with VirtualBox 4.1, on Solaris 11 hosts build 159 876 and above, it is possible to use Solaris Crossbow Virtual 877 Network Interfaces (VNICs) directly with VirtualBox without 878 any additional configuration other than each VNIC must be 879 exclusive for every guest network interface. 880 </para> 881 882 <para> 883 Starting with VirtualBox 2.0.4 and up to VirtualBox 4.0, VNICs 884 can be used, but with the following caveats: 885 </para> 886 887 <itemizedlist> 888 889 <listitem> 890 <para> 891 A VNIC cannot be shared between multiple guest network 892 interfaces. For example, each guest network interface must 893 have its own, exclusive VNIC. 894 </para> 895 </listitem> 896 897 <listitem> 898 <para> 899 The VNIC and the guest network interface that uses the 900 VNIC must be assigned identical MAC addresses. 901 </para> 902 </listitem> 903 904 </itemizedlist> 905 906 <para> 907 When using VLAN interfaces with VirtualBox, they must be named 908 according to the PPA-hack naming scheme, such as e1000g513001. 909 Otherwise, the guest may receive packets in an unexpected 910 format. 897 you to use VLAN trunking between VM and the external network 898 with pre-2.6.27 Linux kernels, or with host operating systems 899 other than Linux. 900 </para> 901 </listitem> 902 903 <listitem> 904 <para> 905 <emphasis role="bold">Oracle Solaris hosts.</emphasis> There 906 is no support for using wireless interfaces. Filtering guest 907 traffic using IPFilter is also not completely supported due to 908 technical restrictions of the Oracle Solaris networking 909 subsystem. These issues may be addressed in later releases of 910 Oracle Solaris 11. 911 </para> 912 913 <para> 914 On Oracle Solaris 11 hosts build 159 and above, it is possible 915 to use Oracle Solaris Crossbow Virtual Network Interfaces 916 (VNICs) directly with &product-name; without any additional 917 configuration other than each VNIC must be exclusive for every 918 guest network interface. 919 </para> 920 921 <para> 922 When using VLAN interfaces with &product-name;, they must be 923 named according to the PPA-hack naming scheme, such as 924 e1000g513001. Otherwise, the guest may receive packets in an 925 unexpected format. 911 926 </para> 912 927 </listitem> … … 944 959 central configuration. Every internal network is identified simply 945 960 by its name. Once there is more than one active virtual network 946 card with the same internal network ID, the VirtualBoxsupport961 card with the same internal network ID, the &product-name; support 947 962 driver will automatically <emphasis>wire</emphasis> the cards and 948 act as a network switch. The VirtualBox support driver implements949 a complete Ethernet switch and supports both broadcast/multicast950 frames and promiscuous mode.963 act as a network switch. The &product-name; support driver 964 implements a complete Ethernet switch and supports both 965 broadcast/multicast frames and promiscuous mode. 951 966 </para> 952 967 … … 961 976 <listitem> 962 977 <para> 963 Use the VM's Settings dialog in the VirtualBox graphical user 964 interface. In the Networking category of the settings dialog, 965 select <emphasis role="bold">Internal Networking</emphasis> 966 from the drop-down list of networking modes. Select the name 967 of an existing internal network from the drop-down list below, 968 or enter a new name into the entry field. 978 Use the VM's <emphasis role="bold">Settings</emphasis> dialog 979 in the &product-name; graphical user interface. In the 980 <emphasis role="bold">Networking</emphasis> category of the 981 settings dialog, select <emphasis role="bold">Internal 982 Networking</emphasis> from the drop-down list of networking 983 modes. Select the name of an existing internal network from 984 the drop-down list below, or enter a new name into the 985 <emphasis role="bold">Name</emphasis> field. 969 986 </para> 970 987 </listitem> … … 996 1013 operating systems that are participating in the internal network 997 1014 to use static IP addresses, you may want to use the DHCP server 998 that is built into VirtualBoxto manage IP addresses for the1015 that is built into &product-name; to manage IP addresses for the 999 1016 internal network. See <xref linkend="vboxmanage-dhcpserver" />. 1000 1017 </para> … … 1016 1033 <para> 1017 1034 Host-only networking is another networking mode that was added 1018 with version 2.2 of VirtualBox. It can be thought of as a hybrid1019 between the bridged and internal networking modes. As with bridged1020 networking, the virtual machines can talk to each other and the1021 host as if they were connected through a physical Ethernet switch.1022 As with internal networking, a physical networking interface need1023 not be present, and the virtual machines cannot talk to the world1024 outside the host since they are not connected to a physical1025 networking interface.1026 </para> 1027 1028 <para> 1029 When host-only networking is used, VirtualBoxcreates a new1035 with version 2.2 of &product-name;. It can be thought of as a 1036 hybrid between the bridged and internal networking modes. As with 1037 bridged networking, the virtual machines can talk to each other 1038 and the host as if they were connected through a physical Ethernet 1039 switch. As with internal networking, a physical networking 1040 interface need not be present, and the virtual machines cannot 1041 talk to the world outside the host since they are not connected to 1042 a physical networking interface. 1043 </para> 1044 1045 <para> 1046 When host-only networking is used, &product-name; creates a new 1030 1047 software interface on the host which then appears next to your 1031 1048 existing network interfaces. In other words, whereas with bridged … … 1044 1061 machine may contain a web server and a second one a database, and 1045 1062 since they are intended to talk to each other, the appliance can 1046 instruct VirtualBox to set up a host-only network for the two. A1047 second, bridged, network would then connect the web server to the1048 outside world to serve data to, but the outside world cannot1063 instruct &product-name; to set up a host-only network for the two. 1064 A second, bridged, network would then connect the web server to 1065 the outside world to serve data to, but the outside world cannot 1049 1066 connect to the database. 1050 1067 </para> … … 1059 1076 <listitem> 1060 1077 <para> 1061 Go to the Network page in the virtual machine's Settings 1078 Go to the <emphasis role="bold">Network</emphasis> page in the 1079 virtual machine's <emphasis role="bold">Settings</emphasis> 1062 1080 dialog and select <emphasis role="bold">Host-Only 1063 1081 Networking</emphasis>. … … 1067 1085 <listitem> 1068 1086 <para> 1069 On the command line, type<computeroutput>VBoxManage modifyvm1087 On the command line, enter <computeroutput>VBoxManage modifyvm 1070 1088 "VM name" --nic<x> hostonly</computeroutput>. See 1071 1089 <xref … … 1098 1116 <para> 1099 1117 For host-only networking, as with internal networking, you may 1100 find the DHCP server useful that is built into VirtualBox. This1101 can be enabled to then manage the IP addresses in the host-only1102 network since otherwise you would need to configure all IP1103 addresses statically.1118 find the DHCP server useful that is built into &product-name;. 1119 This can be enabled to then manage the IP addresses in the 1120 host-only network since otherwise you would need to configure all 1121 IP addresses statically. 1104 1122 </para> 1105 1123 … … 1108 1126 <listitem> 1109 1127 <para> 1110 In the VirtualBox graphical user interface, you can configure1111 all these items in the global settings by choosing1128 In the &product-name; graphical user interface, you can 1129 configure all these items in the global settings by choosing 1112 1130 <emphasis role="bold">File</emphasis>, 1113 1131 <emphasis role="bold">Preferences</emphasis>, … … 1122 1140 <listitem> 1123 1141 <para> 1124 Alternatively, you can use <com puteroutput>VBoxManage1125 dhcpserver</com puteroutput> on the command line. See1142 Alternatively, you can use <command>VBoxManage 1143 dhcpserver</command> on the command line. See 1126 1144 <xref 1127 1145 linkend="vboxmanage-dhcpserver" />. … … 1134 1152 <para> 1135 1153 On Linux and Mac OS X hosts the number of host-only interfaces 1136 is limited to 128. There is no such limit for Solaris and1154 is limited to 128. There is no such limit for Oracle Solaris and 1137 1155 Windows hosts. 1138 1156 </para> … … 1146 1164 1147 1165 <para> 1148 This networking mode allows you to interconnect virtual machines1166 This networking mode enables you to interconnect virtual machines 1149 1167 running on different hosts. 1150 1168 </para> … … 1221 1239 <note> 1222 1240 <para> 1223 On Unix-based hosts, such as Linux, Solaris, and Mac OS X, it is 1224 not possible to bind to ports below 1024 from applications that 1225 are not run by <computeroutput>root</computeroutput>. As a 1226 result, if you try to configure such a source UDP port, the VM 1227 will refuse to start. 1241 On UNIX-based hosts, such as Linux, Oracle Solaris, and Mac OS 1242 X, it is not possible to bind to ports below 1024 from 1243 applications that are not run by 1244 <computeroutput>root</computeroutput>. As a result, if you try 1245 to configure such a source UDP port, the VM will refuse to 1246 start. 1228 1247 </para> 1229 1248 </note> … … 1236 1255 1237 1256 <para> 1238 Virtual Distributed Ethernet (VDE) 1239 1240 <footnote> 1241 1242 <para> 1243 VDE is a project developed by Renzo Davoli, Associate 1244 Professor at the University of Bologna, Italy. 1245 </para> 1246 1247 </footnote> 1248 1249 is a flexible, virtual network infrastructure system, spanning 1250 across multiple hosts in a secure way. It allows for L2/L3 1251 switching, including spanning-tree protocol, VLANs, and WAN 1252 emulation. It is an optional part of VirtualBox which is only 1253 included in the source code. 1257 Virtual Distributed Ethernet (VDE) is a flexible, virtual network 1258 infrastructure system, spanning across multiple hosts in a secure 1259 way. It enables L2/L3 switching, including spanning-tree protocol, 1260 VLANs, and WAN emulation. It is an optional part of &product-name; 1261 which is only included in the source code. 1262 </para> 1263 1264 <para> 1265 VDE is a project developed by Renzo Davoli, Associate Professor at 1266 the University of Bologna, Italy. 1254 1267 </para> 1255 1268 1256 1269 <para> 1257 1270 The basic building blocks of the infrastructure are VDE switches, 1258 VDE plugs and VDE wires which inter-connect the switches.1259 </para> 1260 1261 <para> 1262 The VirtualBoxVDE driver has a single parameter: VDE network.1271 VDE plugs, and VDE wires which interconnect the switches. 1272 </para> 1273 1274 <para> 1275 The &product-name; VDE driver has a single parameter: VDE network. 1263 1276 This is the name of the VDE network switch socket to which the VM 1264 1277 will be connected. … … 1326 1339 VDE is available on Linux and FreeBSD hosts only. It is only 1327 1340 available if the VDE software and the VDE plugin library from the 1328 VirtualSquare project are installed on the host system 1329 1330 <footnote> 1331 1332 <para> 1333 For Linux hosts, the shared library libvdeplug.so must be 1334 available in the search path for shared libraries 1335 </para> 1336 1337 </footnote> 1338 1339 . For more information on setting up VDE networks, please see the 1340 documentation accompanying the software. 1341 1342 <footnote> 1343 1344 <para> 1345 <ulink 1341 VirtualSquare project are installed on the host system. 1342 </para> 1343 1344 <note> 1345 <para> 1346 For Linux hosts, the shared library libvdeplug.so must be 1347 available in the search path for shared libraries. 1348 </para> 1349 </note> 1350 1351 <para> 1352 For more information on setting up VDE networks, please see the 1353 documentation accompanying the software. See also 1354 <ulink 1346 1355 url="http://wiki.virtualsquare.org/wiki/index.php/VDE_Basic_Networking">http://wiki.virtualsquare.org/wiki/index.php/VDE_Basic_Networking</ulink>. 1347 </para>1348 1349 </footnote>1350 1356 </para> 1351 1357 … … 1354 1360 <sect1 id="network_bandwidth_limit"> 1355 1361 1356 <title>Limiting Bandwidth for Network I /O</title>1357 1358 <para> 1359 Starting with version 4.2, VirtualBox allows for limiting the1360 maximum bandwidth used for network transmission. Several network1361 adapters of one VM may share limits through bandwidth groups. It1362 is possible to have more thanone such limit.1362 <title>Limiting Bandwidth for Network Input/Output</title> 1363 1364 <para> 1365 &product-name; supports limiting of the maximum bandwidth used for 1366 network transmission. Several network adapters of one VM may share 1367 limits through bandwidth groups. It is possible to have more than 1368 one such limit. 1363 1369 </para> 1364 1370 1365 1371 <note> 1366 1372 <para> 1367 VirtualBoxshapes VM traffic only in the transmit direction,1373 &product-name; shapes VM traffic only in the transmit direction, 1368 1374 delaying the packets being sent by virtual machines. It does not 1369 1375 limit the traffic being received by virtual machines. … … 1372 1378 1373 1379 <para> 1374 Limits are configured through 1375 <computeroutput>VBoxManage</computeroutput>. The example below 1376 creates a bandwidth group named Limit, sets the limit to 20 Mbps 1377 and assigns the group to the first and second adapters of the VM: 1380 Limits are configured through <command>VBoxManage</command>. The 1381 following example creates a bandwidth group named Limit, sets the 1382 limit to 20 Mbps and assigns the group to the first and second 1383 adapters of the VM: 1384 </para> 1378 1385 1379 1386 <screen>VBoxManage bandwidthctl "VM name" add Limit --type network --limit 20m 1380 1387 VBoxManage modifyvm "VM name" --nicbandwidthgroup1 Limit 1381 1388 VBoxManage modifyvm "VM name" --nicbandwidthgroup2 Limit</screen> 1382 </para>1383 1389 1384 1390 <para> … … 1391 1397 <para> 1392 1398 The limits for each group can be changed while the VM is running, 1393 with changes being picked up immediately. The example below1394 changes the limit for the group created in the example above to1399 with changes being picked up immediately. The following example 1400 changes the limit for the group created in the previous example to 1395 1401 100 Kbps: 1402 </para> 1396 1403 1397 1404 <screen>VBoxManage bandwidthctl "VM name" set Limit --limit 100k</screen> 1398 </para>1399 1405 1400 1406 <para> 1401 1407 To completely disable shaping for the first adapter of VM use the 1402 1408 following command: 1409 </para> 1403 1410 1404 1411 <screen>VBoxManage modifyvm "VM name" --nicbandwidthgroup1 none</screen> 1405 </para>1406 1412 1407 1413 <para> … … 1409 1415 to a bandwidth group while VM is running, by specifying the zero 1410 1416 limit for the group. For example, for the bandwidth group named 1411 Limit use: 1417 Limit: 1418 </para> 1412 1419 1413 1420 <screen>VBoxManage bandwidthctl "VM name" set Limit --limit 0</screen> 1414 </para>1415 1421 1416 1422 </sect1> … … 1421 1427 1422 1428 <para> 1423 VirtualBox provides a variety of virtual network adapters that can 1424 be attached to the host's network in a number of ways. Depending 1425 on which types of adapters and attachments are used the network 1426 performance will be different. Performance-wise the virtio network 1427 adapter is preferable over Intel PRO/1000 emulated adapters, which 1428 are preferred over the PCNet family of adapters. Both virtio and 1429 Intel PRO/1000 adapters enjoy the benefit of segmentation and 1430 checksum offloading. Segmentation offloading is essential for high 1431 performance as it allows for less context switches, dramatically 1432 increasing the sizes of packets that cross the VM/host boundary. 1429 &product-name; provides a variety of virtual network adapters that 1430 can be attached to the host's network in a number of ways. 1431 Depending on which types of adapters and attachments are used the 1432 network performance will be different. Performance-wise the virtio 1433 network adapter is preferable over Intel PRO/1000 emulated 1434 adapters, which are preferred over the PCNet family of adapters. 1435 Both virtio and Intel PRO/1000 adapters enjoy the benefit of 1436 segmentation and checksum offloading. Segmentation offloading is 1437 essential for high performance as it allows for less context 1438 switches, dramatically increasing the sizes of packets that cross 1439 the VM/host boundary. 1433 1440 </para> 1434 1441 … … 1483 1490 Usually it will be enabled by default. You can check and 1484 1491 modify offloading settings using the 1485 <computeroutput>ethtool</computeroutput> command on Linux 1486 guests. 1492 <command>ethtool</command> command on Linux guests. 1487 1493 </para> 1488 1494 </listitem> … … 1500 1506 <para> 1501 1507 To setup a promiscuous mode policy, either select from the 1502 drop down list located in the Network Settings dialog for the1503 network adaptor or use the command line tool1504 <computeroutput>VBoxManage</computeroutput>. See1508 drop down list located in the <emphasis role="bold">Network 1509 Settings</emphasis> dialog for the network adaptor or use the 1510 command line tool <command>VBoxManage</command>. See 1505 1511 <xref linkend="vboxmanage-modifyvm" />. 1506 1512 </para> -
trunk/doc/manual/en_US/user_PrivacyPolicy.xml
r73276 r76078 5 5 %all.entities; 6 6 ]> 7 <appendix id="privacy"> 7 8 8 <appendix id="privacy"> 9 <title>VirtualBox Privacy Information</title> 9 <title>&product-name; Privacy Information</title> 10 10 11 <para>Version 5, Dec 13, 2012</para> 11 <para> 12 Version 5, Dec 13, 2012 13 </para> 12 14 13 <para>The Oracle Privacy Policies posted on 14 <ulink url="http://www.oracle.com/html/privacy.html">http://www.oracle.com/html/privacy.html</ulink> 15 apply to your personal data collected and used by Oracle. The following 16 privacy information describes in more detail which information is exchanged 17 between the VirtualBox application and Oracle, and which information is 18 collected by the virtualbox.org website.</para> 15 <para> 16 The Oracle Privacy Policies posted on 17 <ulink url="http://www.oracle.com/html/privacy.html">http://www.oracle.com/html/privacy.html</ulink> 18 apply to your personal data collected and used by Oracle. The 19 following privacy information describes in more detail which 20 information is exchanged between the &product-name; application and 21 Oracle, and which information is collected by the virtualbox.org 22 website. 23 </para> 19 24 20 <para><emphasis role="bold">§ 1 virtualbox.org.</emphasis> The 21 "virtualbox.org" website logs anonymous usage information such as your IP 22 address, geographical location, browser type, referral source, length of 23 visit and number of page views while you visit (collectively, "anonymous 24 data"). In addition, but only if you choose to register, the website's bug 25 tracking and forum services store the data you choose to reveal upon 26 registration, such as your user name and contact information.</para> 25 <para> 26 <emphasis role="bold">§ 1 virtualbox.org.</emphasis> The 27 "virtualbox.org" website logs anonymous usage information such as 28 your IP address, geographical location, browser type, referral 29 source, length of visit and number of page views while you visit 30 (collectively, "anonymous data"). In addition, but only if you 31 choose to register, the website's bug tracking and forum services 32 store the data you choose to reveal upon registration, such as your 33 user name and contact information. 34 </para> 27 35 28 <para><emphasis role="bold">§ 2 Cookies.</emphasis> The virtualbox.org 29 website, the bug tracker and the forum services use cookies to identify and 30 track the visiting web browser and, if you have registered, to facilitate 31 login. Most browsers allow you to refuse to accept cookies. While you can 32 still visit the website with cookies disabled, logging into the bug tracker 33 and forum services will most likely not work without them.</para> 36 <para> 37 <emphasis role="bold">§ 2 Cookies.</emphasis> The virtualbox.org 38 website, the bug tracker and the forum services use cookies to 39 identify and track the visiting web browser and, if you have 40 registered, to facilitate login. Most browsers allow you to refuse 41 to accept cookies. While you can still visit the website with 42 cookies disabled, logging into the bug tracker and forum services 43 will most likely not work without them. 44 </para> 34 45 35 <para><emphasis role="bold">§ 3 VirtualBox registration process.</emphasis> 36 The VirtualBox application may ask that the user optionally register with 37 Oracle. If you choose to register, your name, e-mail address, country and 38 company will be submitted to Oracle and stored together with the IP address 39 of the submitter as well as product version and platform being used.</para> 46 <para> 47 <emphasis role="bold">§ 3 &product-name; registration 48 process.</emphasis> The &product-name; application may ask that the 49 user optionally register with Oracle. If you choose to register, 50 your name, e-mail address, country and company will be submitted to 51 Oracle and stored together with the IP address of the submitter as 52 well as product version and platform being used. 53 </para> 40 54 41 <para><emphasis role="bold">§ 4 Update notifications.</emphasis> The 42 VirtualBox application may contact Oracle to find out whether a new version 43 of VirtualBox has been released and notify the user if that is the case. In 44 the process, anonymous data such as your IP address and a non-identifying 45 counter, together with the product version and the platform being used, is 46 sent so that the server can find out whether an update is available. By 47 default, this check is performed once a day. You change this interval or 48 disable these checks altogether in the VirtualBox preferences.</para> 55 <para> 56 <emphasis role="bold">§ 4 Update notifications.</emphasis> The 57 &product-name; application may contact Oracle to find out whether a 58 new version of &product-name; has been released and notify the user 59 if that is the case. In the process, anonymous data such as your IP 60 address and a non-identifying counter, together with the product 61 version and the platform being used, is sent so that the server can 62 find out whether an update is available. By default, this check is 63 performed once a day. You change this interval or disable these 64 checks altogether in the &product-name; preferences. 65 </para> 49 66 50 <para><emphasis role="bold">§ 5 Usage of personal information.</emphasis> 51 Oracle may use anonymous and personal data collected by the means above for 52 statistical purposes as well as to automatically inform you about new 53 notices related to your posts on the bug tracker and forum services, to 54 administer the website and to contact you due to technical issues. Oracle 55 may also inform you about new product releases related to VirtualBox.</para> 67 <para> 68 <emphasis role="bold">§ 5 Usage of personal information.</emphasis> 69 Oracle may use anonymous and personal data collected by the means 70 above for statistical purposes as well as to automatically inform 71 you about new notices related to your posts on the bug tracker and 72 forum services, to administer the website and to contact you due to 73 technical issues. Oracle may also inform you about new product 74 releases related to &product-name;. 75 </para> 56 76 57 <para>In no event will personal data without your express consent be 58 provided to any third parties, unless Oracle may be required to do so by law 59 or in connection with legal proceedings.</para> 77 <para> 78 In no event will personal data without your express consent be 79 provided to any third parties, unless Oracle may be required to do 80 so by law or in connection with legal proceedings. 81 </para> 60 82 61 <para><emphasis role="bold">§ 6 Updates.</emphasis> Oracle may update the 62 privacy policy at any time by posting a new version at 63 <ulink url="http://www.oracle.com/html/privacy.html">http://www.oracle.com/html/privacy.html</ulink> and the privacy information will be kept up to date 64 in the documentation which comes with the VirtualBox application. You 65 should check these places occasionally to ensure you are happy with any 66 changes.</para> 83 <para> 84 <emphasis role="bold">§ 6 Updates.</emphasis> Oracle may update the 85 privacy policy at any time by posting a new version at 86 <ulink url="http://www.oracle.com/html/privacy.html">http://www.oracle.com/html/privacy.html</ulink> 87 and the privacy information will be kept up to date in the 88 documentation which comes with the &product-name; application. You 89 should check these places occasionally to ensure you are happy with 90 any changes. 91 </para> 92 67 93 </appendix> -
trunk/doc/manual/en_US/user_Security.xml
r73276 r76078 25 25 One of the principles of good security practise is to keep all 26 26 software versions and patches up to date. Activate the 27 VirtualBoxupdate notification to get notified when a new28 VirtualBox release is available. When updating VirtualBox, do29 not forget to update the Guest Additions. Keep the host30 operating system as well as the guest operating system up to31 date.27 &product-name; update notification to get notified when a new 28 &product-name; release is available. When updating 29 &product-name;, do not forget to update the Guest Additions. 30 Keep the host operating system as well as the guest operating 31 system up to date. 32 32 </para> 33 33 </listitem> … … 49 49 privilege.</emphasis> The principle of least privilege states 50 50 that users should be given the least amount of privilege 51 necessary to perform their jobs. Always execute VirtualBox as52 a regular user. We strongly discourage anyone from executing53 VirtualBoxwith system privileges.51 necessary to perform their jobs. Always execute &product-name; 52 as a regular user. We strongly discourage anyone from 53 executing &product-name; with system privileges. 54 54 </para> 55 55 … … 95 95 96 96 <para> 97 The VirtualBoxbase package should be downloaded only from a97 The &product-name; base package should be downloaded only from a 98 98 trusted source, for instance the official website 99 99 <ulink url="http://www.virtualbox.org">http://www.virtualbox.org</ulink>. … … 104 104 105 105 <para> 106 General VirtualBox installation instructions for the supported107 hosts can be found in <xref linkend="installation"/>.108 </para> 109 110 <para> 111 On Windows hosts, the installer allows for disablingUSB106 General &product-name; installation instructions for the 107 supported hosts can be found in <xref linkend="installation"/>. 108 </para> 109 110 <para> 111 On Windows hosts, the installer can be used to disable USB 112 112 support, support for bridged networking, support for host-only 113 113 networking and the Python language binding. See … … 116 116 appropriate if the corresponding functionality is not required 117 117 by any virtual machine. The Python language bindings are only 118 required if the VirtualBox API is to be used by external Python119 applications. In particular USB support and support for the two120 networking modes require the installation of Windows kernel121 drivers on the host. Therefore disabling those selected features122 can not only be used to restrict the user to certain118 required if the &product-name; API is to be used by external 119 Python applications. In particular USB support and support for 120 the two networking modes require the installation of Windows 121 kernel drivers on the host. Therefore disabling those selected 122 features can not only be used to restrict the user to certain 123 123 functionality but also to minimize the surface provided to a 124 124 potential attacker. … … 126 126 127 127 <para> 128 The general case is to install the complete VirtualBox package.129 The installation must be done with system privileges. All130 VirtualBox binaries should be executed as a regular user and131 never as a privileged user.132 </para> 133 134 <para> 135 The Oracle VM VirtualBox extension pack provides additional136 featuresand must be downloaded and installed separately, see128 The general case is to install the complete &product-name; 129 package. The installation must be done with system privileges. 130 All &product-name; binaries should be executed as a regular user 131 and never as a privileged user. 132 </para> 133 134 <para> 135 The &product-name; Extension Pack provides additional features 136 and must be downloaded and installed separately, see 137 137 <xref linkend="intro-installing"/>. As for the base package, the 138 138 SHA256 checksum of the extension pack should be verified. As the 139 installation requires system privileges, VirtualBox will ask for140 the system password during the installation of the extension139 installation requires system privileges, &product-name; will ask 140 for the system password during the installation of the extension 141 141 pack. 142 142 </para> … … 150 150 <para> 151 151 Normally there is no post installation configuration of 152 VirtualBox components required. However, on Solaris and Linux153 hosts it is necessary to configure the proper permissions for154 users executing VMs and who should be able to access certain155 host resources. For instance, Linux users must be member of the156 <emphasis>vboxusers</emphasis> group to be able to pass USB157 devices to a guest. If a serial host interface should be158 accessed from a VM, the proper permissions must be granted to152 &product-name; components required. However, on Oracle Solaris 153 and Linux hosts it is necessary to configure the proper 154 permissions for users executing VMs and who should be able to 155 access certain host resources. For instance, Linux users must be 156 member of the <emphasis>vboxusers</emphasis> group to be able to 157 pass USB devices to a guest. If a serial host interface should 158 be accessed from a VM, the proper permissions must be granted to 159 159 the user to be able to access that device. The same applies to 160 160 other resources like raw partitions, DVD/CD drives, and sound … … 172 172 <para> 173 173 This section outlines the specific security mechanisms offered by 174 VirtualBox.174 &product-name;. 175 175 </para> 176 176 … … 180 180 181 181 <para> 182 One property of virtual machine monitors (VMMs) like VirtualBox183 is to encapsulate a guest by executing it in a protected184 environment, a virtual machine, running as a user process on the185 host operating system. The guest cannot communicate directly186 with the hardware or other computers but only through the VMM.187 The VMM provides emulated physical resources and devices to the188 guest which are accessed by the guest operating system to189 perform the required tasks. The VM settings control the190 resources provided to the guest, for example the amount of guest191 memory or the number of guest processors and the enabled192 features for that guest. For example remote control, certain193 screen settings and others. See182 One property of virtual machine monitors (VMMs) like 183 &product-name; is to encapsulate a guest by executing it in a 184 protected environment, a virtual machine, running as a user 185 process on the host operating system. The guest cannot 186 communicate directly with the hardware or other computers but 187 only through the VMM. The VMM provides emulated physical 188 resources and devices to the guest which are accessed by the 189 guest operating system to perform the required tasks. The VM 190 settings control the resources provided to the guest, for 191 example the amount of guest memory or the number of guest 192 processors and the enabled features for that guest. For example 193 remote control, certain screen settings and others. See 194 194 <xref linkend="generalsettings"/>. 195 195 </para> … … 247 247 248 248 <para> 249 When using the VirtualBox extension pack provided by Oracle250 for VRDP remote desktop support, you can optionally use249 When using the &product-name; Extension Pack provided by 250 Oracle for VRDP remote desktop support, you can optionally use 251 251 various methods to configure RDP authentication. The "null" 252 252 method is very insecure and should be avoided in a public … … 261 261 262 262 <para> 263 The shared clipboard allows users to share data between the263 The shared clipboard enables users to share data between the 264 264 host and the guest. Enabling the clipboard in Bidirectional 265 mode allows the guest to read and write the host clipboard.265 mode enables the guest to read and write the host clipboard. 266 266 The Host to Guest mode and the Guest to Host mode limit the 267 267 access to one direction. If the guest is able to access the … … 298 298 299 299 <para> 300 Enabling 3D graphics via the Guest Additions exposes the host301 to additional security risks. See300 Enabling 3D graphics using the Guest Additions exposes the 301 host to additional security risks. See 302 302 <xref 303 303 linkend="guestadd-3d" />. … … 311 311 312 312 <para> 313 Enabling CD/DVD passthrough allows the guest to perform313 Enabling CD/DVD passthrough enables the guest to perform 314 314 advanced operations on the CD/DVD drive, see 315 315 <xref linkend="storage-cds"/>. This could induce a security … … 341 341 342 342 <para> 343 The following components of VirtualBoxcan use passwords for343 The following components of &product-name; can use passwords for 344 344 authentication: 345 345 </para> … … 351 351 When using remote iSCSI storage and the storage server 352 352 requires authentication, an initiator secret can optionally 353 be supplied with the <com puteroutput>VBoxManage354 storageattach</com puteroutput> command. As long as no355 settings password is provided, by using the command line356 option <option>--settingspwfile</option>, then this secret357 isstored <emphasis>unencrypted</emphasis> in the machine353 be supplied with the <command>VBoxManage 354 storageattach</command> command. As long as no settings 355 password is provided, by using the command line option 356 <option>--settingspwfile</option>, then this secret is 357 stored <emphasis>unencrypted</emphasis> in the machine 358 358 configuration and is therefore potentially readable on the 359 host. See <xref 360 linkend="storage-iscsi" /> and 361 <xref 362 linkend="vboxmanage-storageattach" />. 363 </para> 364 </listitem> 365 366 <listitem> 367 <para> 368 When using the VirtualBox web service to control a 369 VirtualBox host remotely, connections to the web service are 370 authenticated in various ways. This is described in detail 371 in the VirtualBox Software Development Kit (SDK) reference. 372 See <xref 373 linkend="VirtualBoxAPI" />. 359 host. See <xref linkend="storage-iscsi" /> and 360 <xref linkend="vboxmanage-storageattach" />. 361 </para> 362 </listitem> 363 364 <listitem> 365 <para> 366 When using the &product-name; web service to control an 367 &product-name; host remotely, connections to the web service 368 are authenticated in various ways. This is described in 369 detail in the &product-name; Software Development Kit (SDK) 370 reference. See <xref linkend="VirtualBoxAPI" />. 374 371 </para> 375 372 </listitem> … … 398 395 399 396 <para> 400 The following features of VirtualBoxcan present security397 The following features of &product-name; can present security 401 398 problems: 402 399 </para> … … 406 403 <listitem> 407 404 <para> 408 Enabling 3D graphics viathe Guest Additions exposes the405 Enabling 3D graphics using the Guest Additions exposes the 409 406 host to additional security risks. See 410 407 <xref … … 431 428 When Page Fusion, see <xref linkend="guestadd-pagefusion"/>, 432 429 is enabled, it is possible that a side-channel opens up that 433 allows a malicious guest to determine the address space of430 enables a malicious guest to determine the address space of 434 431 another VM running on the same host layout. For example, 435 432 where DLLs are typically loaded. This information leak in 436 433 itself is harmless, however the malicious guest may use it 437 to optimize attack against that VM viaunrelated attack434 to optimize attack against that VM through unrelated attack 438 435 vectors. It is recommended to only enable Page Fusion if you 439 436 do not think this is a concern in your setup. … … 443 440 <listitem> 444 441 <para> 445 When using the VirtualBox web service to control a446 VirtualBox host remotely, connections to the web service,447 over which the API calls are transferred using SOAP XML, are448 not encrypted. They use plain HTTP by default. This is a449 potential security risk. For details about the web service,450 se e <xref linkend="VirtualBoxAPI" />.442 When using the &product-name; web service to control an 443 &product-name; host remotely, connections to the web 444 service, over which the API calls are transferred using SOAP 445 XML, are not encrypted. They use plain HTTP by default. This 446 is a potential security risk. For details about the web 447 service, see <xref linkend="VirtualBoxAPI" />. 451 448 </para> 452 449 … … 474 471 <para> 475 472 Because of shortcomings in older Windows versions, using 476 VirtualBox on Windows versions older than Vista with Service477 Pack 1 is not recommended.473 &product-name; on Windows versions older than Vista with 474 Service Pack 1 is not recommended. 478 475 </para> 479 476 </listitem> … … 488 485 489 486 <para> 490 The following components of VirtualBox use encryption to protect491 sensitive data:487 The following components of &product-name; use encryption to 488 protect sensitive data: 492 489 </para> 493 490 … … 496 493 <listitem> 497 494 <para> 498 When using the VirtualBox extension pack provided by Oracle 499 for VRDP remote desktop support, RDP data can optionally be 500 encrypted. See <xref linkend="vrde-crypt" />. Only the 501 Enhanced RDP Security method (RDP5.2) with TLS protocol 502 provides a secure connection. Standard RDP Security (RDP4 503 and RDP5.1) is vulnerable to a man-in-the-middle attack. 495 When using the &product-name; Extension Pack provided by 496 Oracle for VRDP remote desktop support, RDP data can 497 optionally be encrypted. See <xref linkend="vrde-crypt" />. 498 Only the Enhanced RDP Security method (RDP5.2) with TLS 499 protocol provides a secure connection. Standard RDP Security 500 (RDP4 and RDP5.1) is vulnerable to a man-in-the-middle 501 attack. 504 502 </para> 505 503 </listitem> -
trunk/doc/manual/en_US/user_Storage.xml
r73276 r76078 11 11 <para> 12 12 As the virtual machine will most probably expect to see a hard disk 13 built into its virtual computer, VirtualBox must be able to present14 real storage to the guest as a virtual hard disk. There are13 built into its virtual computer, &product-name; must be able to 14 present real storage to the guest as a virtual hard disk. There are 15 15 presently three methods by which to achieve this: 16 16 </para> … … 20 20 <listitem> 21 21 <para> 22 VirtualBoxcan use large image files on a real hard disk and22 &product-name; can use large image files on a real hard disk and 23 23 present them to a guest as a virtual hard disk. This is the most 24 24 common method, described in <xref linkend="vdidetails" />. … … 28 28 <listitem> 29 29 <para> 30 iSCSI storage servers can be attached to VirtualBox. This is 31 described in <xref 32 linkend="storage-iscsi" />. 30 iSCSI storage servers can be attached to &product-name;. This is 31 described in <xref linkend="storage-iscsi" />. 33 32 </para> 34 33 </listitem> … … 47 46 Each such virtual storage device, such as an image file, iSCSI 48 47 target, or physical hard disk, needs to be connected to the virtual 49 hard disk controller that VirtualBox presents to a virtual machine.50 This is explained in the next section.48 hard disk controller that &product-name; presents to a virtual 49 machine. This is explained in the next section. 51 50 </para> 52 51 … … 58 57 In a real PC, hard disks and CD/DVD drives are connected to a 59 58 device called hard disk controller which drives hard disk 60 operation and data transfers. VirtualBox can emulate the five most 61 common types of hard disk controllers typically found in today's 62 PCs: IDE, SATA (AHCI), SCSI, SAS, USB-based, and NVMe mass storage 63 devices. 64 65 <footnote> 66 67 <para> 68 SATA support was added with VirtualBox 1.6; experimental SCSI 69 support was added with 2.1 and fully implemented with 2.2. 70 Generally, storage attachments were made much more flexible 71 with VirtualBox 3.1. Support for the LSI Logic SAS controller 72 was added with VirtualBox 3.2. USB mass storage devices are 73 supported since VirtualBox 5.0. NVMe controller support was 74 added with VirtualBox 5.1. 75 </para> 76 77 </footnote> 59 operation and data transfers. &product-name; can emulate the five 60 most common types of hard disk controllers typically found in 61 today's PCs: IDE, SATA (AHCI), SCSI, SAS, USB-based, and NVMe mass 62 storage devices. 78 63 </para> 79 64 … … 96 81 97 82 <para> 98 In VirtualBox, each virtual machine may have one IDE83 In &product-name;, each virtual machine may have one IDE 99 84 controller enabled, which gives you up to four virtual storage 100 85 devices that you can attach to the machine. By default, one of 101 these four, the secondary master, is preconfigured to be the 102 machine's virtual CD/DVD drive, but this can be changed. 103 104 <footnote> 105 106 <para> 107 The assignment of the machine's CD/DVD drive to the 108 secondary master was fixed before VirtualBox 3.1. It is 109 now changeable, and the drive can be at other slots of the 110 IDE controller, and there can be more than one such drive. 111 </para> 112 113 </footnote> 114 115 ) 86 these virtual storage devices, the secondary master, is 87 preconfigured to be the virtual machine's virtual CD/DVD 88 drive. However, you can change the default setting. 116 89 </para> 117 90 … … 124 97 <para> 125 98 You can also select which exact type of IDE controller 126 hardware VirtualBoxshould present to the virtual machine:99 hardware &product-name; should present to the virtual machine: 127 100 PIIX3, PIIX4, or ICH6. This makes no difference in terms of 128 101 performance, but if you import a virtual machine from another … … 133 106 134 107 <para> 135 After you have created a new virtual machine with the New 136 Virtual Machine wizard of the graphical user interface, you 137 will typically see one IDE controller in the machine's Storage 138 settings. The virtual CD/DVD drive will be attached to one of 139 the four ports of this controller. 108 After you have created a new virtual machine with the 109 <emphasis role="bold">New Virtual Machine</emphasis> wizard of 110 the graphical user interface, you will typically see one IDE 111 controller in the machine's 112 <emphasis role="bold">Storage</emphasis> settings. The virtual 113 CD/DVD drive will be attached to one of the four ports of this 114 controller. 140 115 </para> 141 116 </listitem> … … 152 127 153 128 <para> 154 Like a real SATA controller, VirtualBox's virtual SATA129 Like a real SATA controller, &product-name;'s virtual SATA 155 130 controller operates faster and also consumes fewer CPU 156 resources than the virtual IDE controller. Also, this allows131 resources than the virtual IDE controller. Also, this enables 157 132 you to connect up to 30 virtual hard disks to one machine 158 instead of just three, when compared to the VirtualBoxIDE133 instead of just three, when compared to the &product-name; IDE 159 134 controller with a DVD drive attached. 160 135 </para> 161 136 162 137 <para> 163 For this reason, starting with version 3.2 and depending on164 the selected guest operating system, VirtualBox uses SATA as165 the default for newly created virtual machines. One virtual166 SATA controller is created by default, and the default disk167 that is created witha new VM is attached to this controller.138 For this reason, depending on the selected guest operating 139 system, &product-name; uses SATA as the default for newly 140 created virtual machines. One virtual SATA controller is 141 created by default, and the default disk that is created with 142 a new VM is attached to this controller. 168 143 </para> 169 144 … … 174 149 seen by operating systems that do not have device support 175 150 for AHCI. In particular, <emphasis>there is no support for 176 AHCI in Windows before Windows Vista</emphasis> , so Windows177 XP (even SP3)will not see such disks unless you install151 AHCI in Windows before Windows Vista</emphasis>. So Windows 152 XP, even SP3, will not see such disks unless you install 178 153 additional drivers. It is possible to switch from IDE to 179 154 SATA after installation by installing the SATA drivers and 180 changing the controller type in the VM settings dialog.181 182 <footnote>183 184 185 VirtualBoxrecommends the Intel Matrix Storage drivers,186 187 155 changing the controller type in the VM 156 <emphasis role="bold">Settings</emphasis> dialog. 157 </para> 158 159 <para> 160 &product-name; recommends the Intel Matrix Storage drivers, 161 which can be downloaded from 162 <ulink 188 163 url="http://downloadcenter.intel.com/Product_Filter.aspx?ProductID=2101">http://downloadcenter.intel.com/Product_Filter.aspx?ProductID=2101</ulink>. 189 </para>190 191 </footnote>192 164 </para> 193 165 </warning> … … 196 168 To add a SATA controller to a machine for which it has not 197 169 been enabled by default, either because it was created by an 198 earlier version of VirtualBox, or because SATA is not170 earlier version of &product-name;, or because SATA is not 199 171 supported by default by the selected guest operating system, 200 do the following. Go to the Storage page of the machine's 201 settings dialog, click <emphasis role="bold">Add 202 Controller</emphasis> under the Storage Tree box and then 203 select <emphasis role="bold">Add SATA Controller</emphasis>. 204 The new controller appears as a separate PCI device in the 205 virtual machine, and you can add virtual disks to it. 172 do the following. Go to the 173 <emphasis role="bold">Storage</emphasis> page of the machine's 174 <emphasis role="bold">Settings</emphasis> dialog, click 175 <emphasis role="bold">Add Controller</emphasis> under the 176 Storage Tree box and then select <emphasis role="bold">Add 177 SATA Controller</emphasis>. The new controller appears as a 178 separate PCI device in the virtual machine, and you can add 179 virtual disks to it. 206 180 </para> 207 181 208 182 <para> 209 183 To change the IDE compatibility mode settings for the SATA 210 controller, see 211 <xref 212 linkend="vboxmanage-storagectl" />. 184 controller, see <xref linkend="vboxmanage-storagectl" />. 213 185 </para> 214 186 </listitem> … … 228 200 <para> 229 201 Primarily for compatibility with other virtualization 230 software, VirtualBoxoptionally supports LSI Logic and202 software, &product-name; optionally supports LSI Logic and 231 203 BusLogic SCSI controllers, to each of which up to 15 virtual 232 204 hard disks can be attached. … … 234 206 235 207 <para> 236 To enable a SCSI controller, on the Storage page of a virtual 237 machine's settings dialog, click <emphasis role="bold">Add 238 Controller</emphasis> under the Storage Tree box and then 239 select <emphasis role="bold">Add SCSI Controller</emphasis>. 240 The new controller appears as a separate PCI device in the 241 virtual machine. 208 To enable a SCSI controller, on the 209 <emphasis role="bold">Storage</emphasis> page of a virtual 210 machine's <emphasis role="bold">Settings</emphasis> dialog, 211 click <emphasis role="bold">Add Controller</emphasis> under 212 the Storage Tree box and then select <emphasis role="bold">Add 213 SCSI Controller</emphasis>. The new controller appears as a 214 separate PCI device in the virtual machine. 242 215 </para> 243 216 … … 261 234 are used instead of parallel ones, which simplifies physical 262 235 device connections. In some ways, therefore, SAS is to SCSI 263 what SATA is to IDE: it allows formore reliable and faster236 what SATA is to IDE: it enables more reliable and faster 264 237 connections. 265 238 </para> … … 267 240 <para> 268 241 To support high-end guests which require SAS controllers, 269 VirtualBox emulates a LSI Logic SAS controller, which can be 270 enabled much the same way as a SCSI controller. At this time, 271 up to eight devices can be connected to the SAS controller. 242 &product-name; emulates a LSI Logic SAS controller, which can 243 be enabled much the same way as a SCSI controller. At this 244 time, up to eight devices can be connected to the SAS 245 controller. 272 246 </para> 273 247 … … 277 251 operating systems with device support for it. In particular, 278 252 <emphasis>there is no support for SAS in Windows before 279 Windows Vista</emphasis> , so Windows XP (even SP3)will not253 Windows Vista</emphasis>. So Windows XP, even SP3, will not 280 254 see such disks unless you install additional drivers. 281 255 </para> … … 296 270 297 271 <para> 298 The virtual USB storage controller offered by VirtualBox works299 differently to the other storage controller types. While most300 storage controllers appear as a single PCI device to the guest301 with multiple disks attached to it, the USB-based storage302 controller does not appear as virtual storage controller. Each303 disk attached to the controller appears as a dedicated USB304 de vice to the guest.272 The virtual USB storage controller offered by &product-name; 273 works differently to the other storage controller types. While 274 most storage controllers appear as a single PCI device to the 275 guest with multiple disks attached to it, the USB-based 276 storage controller does not appear as virtual storage 277 controller. Each disk attached to the controller appears as a 278 dedicated USB device to the guest. 305 279 </para> 306 280 307 281 <warning> 308 282 <para> 309 Booting from drives attached via USB is when EFI is used as310 the BIOS lacks USB support.283 Booting from drives attached using USB is only supported 284 when EFI is used as the BIOS lacks USB support. 311 285 </para> 312 286 </warning> … … 325 299 8.1 added native NVMe support. For Windows 7, native support 326 300 was added with an update. 327 328 <footnote> 329 330 <para> 331 The NVMe controller is part of the extension pack. 332 </para> 333 334 </footnote> 301 </para> 302 303 <para> 304 The NVMe controller is part of the extension pack. 335 305 </para> 336 306 337 307 <warning> 338 308 <para> 339 Booting from drives attached via NVMe is only supported when340 EFI is used as the BIOS lacks the appropriate driver.309 Booting from drives attached using NVMe is only supported 310 when EFI is used as the BIOS lacks the appropriate driver. 341 311 </para> 342 312 </warning> … … 346 316 347 317 <para> 348 In summary, VirtualBoxgives you the following categories of318 In summary, &product-name; gives you the following categories of 349 319 virtual storage slots: 350 320 </para> … … 402 372 the only controller supported by your guest. Whether you use SATA, 403 373 SCSI, or SAS does not make any real difference. The variety of 404 controllers is only supplied by VirtualBox for compatibility with405 existing hardware and other hypervisors.374 controllers is only supplied by &product-name; for compatibility 375 with existing hardware and other hypervisors. 406 376 </para> 407 377 … … 415 385 Disk image files reside on the host system and are seen by the 416 386 guest systems as hard disks of a certain geometry. When a guest 417 operating system reads from or writes to a hard disk, VirtualBox 418 redirects the request to the image file. 419 </para> 420 421 <para> 422 Like a physical disk, a virtual disk has a size (capacity), which 423 must be specified when the image file is created. As opposed to a 424 physical disk however, VirtualBox allows you to expand an image 425 file after creation, even if it has data already. See 426 <xref 427 linkend="vboxmanage-modifyvdi" />. 428 429 <footnote> 430 431 <para> 432 Image resizing was added with VirtualBox 4.0. 433 </para> 434 435 </footnote> 436 </para> 437 438 <para> 439 VirtualBox supports the following types of disk image files: 387 operating system reads from or writes to a hard disk, 388 &product-name; redirects the request to the image file. 389 </para> 390 391 <para> 392 Like a physical disk, a virtual disk has a size, or capacity, 393 which must be specified when the image file is created. As opposed 394 to a physical disk however, &product-name; enables you to expand 395 an image file after creation, even if it has data already. See 396 <xref linkend="vboxmanage-modifyvdi" />. 397 </para> 398 399 <para> 400 &product-name; supports the following types of disk image files: 440 401 </para> 441 402 … … 444 405 <listitem> 445 406 <para> 446 <emphasis role="bold">VDI.</emphasis> Normally, VirtualBox407 <emphasis role="bold">VDI.</emphasis> Normally, &product-name; 447 408 uses its own container format for guest hard disks. This is 448 409 called a Virtual Disk Image (VDI) file. This format is used … … 453 414 <listitem> 454 415 <para> 455 <emphasis role="bold">VMDK.</emphasis> VirtualBox also fully 456 supports the popular and open VMDK container format that is 457 used by many other virtualization products, in particular, by 458 VMware. 459 460 <footnote> 461 462 <para> 463 Initial support for VMDK was added with VirtualBox 1.4. 464 Since version 2.1, VirtualBox supports VMDK fully, meaning 465 that you can create snapshots and use all the other 466 advanced features described above for VDI images with VMDK 467 also. 468 </para> 469 470 </footnote> 471 </para> 472 </listitem> 473 474 <listitem> 475 <para> 476 <emphasis role="bold">VHD.</emphasis> VirtualBox also fully 477 supports the VHD format used by Microsoft. 416 <emphasis role="bold">VMDK.</emphasis> &product-name; also 417 fully supports the popular and open VMDK container format that 418 is used by many other virtualization products, such as VMware. 419 </para> 420 </listitem> 421 422 <listitem> 423 <para> 424 <emphasis role="bold">VHD.</emphasis> &product-name; also 425 fully supports the VHD format used by Microsoft. 478 426 </para> 479 427 </listitem> … … 483 431 <emphasis role="bold">HDD.</emphasis> Image files of Parallels 484 432 version 2 (HDD format) are also supported. 485 486 <footnote> 487 488 <para> 489 Support was added with VirtualBox 3.1. 490 </para> 491 492 </footnote> 493 433 </para> 434 435 <para> 494 436 Due to lack of documentation of the format, newer versions 495 437 such as 3 and 4 are not supported. You can however convert … … 530 472 drive reaches the maximum capacity chosen when the drive was 531 473 created. While this format takes less space initially, the 532 fact that VirtualBox needs to expand the image file consumes533 additional computing resources, so until the disk file size534 has stabilized, write operations may be slower than with fixed535 size disks. However, after a time the rate of growth will slow536 and the average penalty for write operations will be537 negligible.474 fact that &product-name; needs to expand the image file 475 consumes additional computing resources, so until the disk 476 file size has stabilized, write operations may be slower than 477 with fixed size disks. However, after a time the rate of 478 growth will slow and the average penalty for write operations 479 will be negligible. 538 480 </para> 539 481 </listitem> … … 548 490 549 491 <para> 550 VirtualBoxkeeps track of all the hard disk, CD/DVD-ROM, and492 &product-name; keeps track of all the hard disk, CD/DVD-ROM, and 551 493 floppy disk images which are in use by virtual machines. These are 552 494 often referred to as <emphasis>known media</emphasis> and come … … 564 506 <listitem> 565 507 <para> 566 Registered media, for compatibility with VirtualBox versions567 older than version 4.0. For details about how media508 Registered media, for compatibility with &product-name; 509 versions older than version 4.0. For details about how media 568 510 registration has changed with version 4.0, see 569 <xref 570 linkend="vboxconfigdata" />. 511 <xref linkend="vboxconfigdata" />. 571 512 </para> 572 513 </listitem> … … 575 516 576 517 <para> 577 The known media can be viewed and changed in the 578 <emphasis 579 role="bold">Virtual Media Manager</emphasis>, which 580 you can access from the File menu in the VirtualBox main window. 581 </para> 582 583 <mediaobject> 584 <imageobject> 585 <imagedata align="center" fileref="images/virtual-disk-manager.png" 518 The known media can be viewed and changed using the 519 <emphasis role="bold">Virtual Media Manager</emphasis>, which you 520 can access from the <emphasis role="bold">File</emphasis> menu in 521 the VirtualBox Manager window. 522 </para> 523 524 <figure id="fig-virtual-media-manager"> 525 <title>The Virtual Media Manager</title> 526 <mediaobject> 527 <imageobject> 528 <imagedata align="center" fileref="images/virtual-disk-manager.png" 586 529 width="12cm" /> 587 </imageobject> 588 </mediaobject> 530 </imageobject> 531 </mediaobject> 532 </figure> 589 533 590 534 <para> 591 535 The known media are conveniently grouped in separate tabs for the 592 three possibleformats. These formats are:536 supported formats. These formats are: 593 537 </para> 594 538 … … 597 541 <listitem> 598 542 <para> 599 Hard disk images, either in VirtualBox's own Virtual Disk543 Hard disk images, either in &product-name;'s own Virtual Disk 600 544 Image (VDI) format, or in the third-party formats listed in 601 545 <xref linkend="vdidetails"/>. … … 620 564 For each image, the Virtual Media Manager shows you the full path 621 565 of the image file and other information, such as the virtual 622 machine the image is currently attached to , if any.566 machine the image is currently attached to. 623 567 </para> 624 568 … … 628 572 629 573 <itemizedlist> 574 575 <listitem> 576 <para> 577 <emphasis role="bold">Add</emphasis> an image to the registry. 578 </para> 579 </listitem> 580 581 <listitem> 582 <para> 583 <emphasis role="bold">Copy</emphasis> a virtual hard disk, to 584 create another one. The target type can be different. 585 Available options are: VDI, VHD, or VMDK. 586 </para> 587 </listitem> 588 589 <listitem> 590 <para> 591 <emphasis role="bold">Move</emphasis> an image that is 592 currently in the registry. A file dialog prompts you for the 593 new image file location. 594 </para> 595 596 <para> 597 When you move a disk image using the Virtual Media Manager, 598 any related &product-name; configuration files are updated 599 automatically. 600 </para> 601 602 <note> 603 <para> 604 If possible, always use the Virtual Media Manager or the 605 <command>VBoxManage modifymedium</command> command to move a 606 disk image. 607 </para> 608 609 <para> 610 If you move a disk image to a new location by using a file 611 management feature of the host operating system, use the 612 <computeroutput>--setlocation</computeroutput> option of the 613 <command>VBoxManage modifymedium</command> command to 614 configure the new path of the disk image on the host file 615 system. This updates the &product-name; configuration 616 automatically. 617 </para> 618 </note> 619 </listitem> 630 620 631 621 <listitem> … … 647 637 <listitem> 648 638 <para> 649 <emphasis role="bold">Copy</emphasis> a virtual hard disk, to 650 create another one. The target type can be different. 651 Available options are: VDI, VHD, or VMDK. 652 </para> 653 </listitem> 654 655 <listitem> 656 <para> 657 <emphasis role="bold">Modify</emphasis> the attributes of the 658 disk image file. Available options are: Normal, Immutable, 659 Writethrough, Shareable, Multi-attach. 660 </para> 639 Display and edit the 640 <emphasis role="bold">Properties</emphasis> of a disk image. 641 </para> 642 643 <para> 644 Available properties include the following: 645 </para> 646 647 <itemizedlist> 648 649 <listitem> 650 <para> 651 <emphasis role="bold">Type:</emphasis> Defines the 652 snapshot behavior of the disk. See 653 <xref linkend="hdimagewrites"/>. 654 </para> 655 </listitem> 656 657 <listitem> 658 <para> 659 <emphasis role="bold">Location:</emphasis> The location of 660 the disk image file on the host system. A file dialog 661 selector is available. 662 </para> 663 </listitem> 664 665 <listitem> 666 <para> 667 <emphasis role="bold">Description:</emphasis> A short 668 description of the disk image. 669 </para> 670 </listitem> 671 672 <listitem> 673 <para> 674 <emphasis role="bold">Size:</emphasis> The size of the 675 disk image. Use the slider to increase or decrease the 676 disk image size. 677 </para> 678 </listitem> 679 680 <listitem> 681 <para> 682 <emphasis role="bold">Information:</emphasis> Further 683 details about the disk image can be added on the 684 <emphasis role="bold">Information</emphasis> tab. 685 </para> 686 </listitem> 687 688 </itemizedlist> 661 689 </listitem> 662 690 … … 671 699 672 700 <para> 673 These commands are accessible once a medium has been selected 674 either by selecting from the options shown at the top of the 675 window, or by right-clicking the medium and selecting from the 676 options shown on the drop-down menu. 677 </para> 678 679 <para> 680 Starting with version 4.0, to create a new disk image, you use the 681 Storage page in a virtual machine's settings dialog. This is 682 because disk images are now by default stored in each machine's 683 own folder. 701 To perform these actions, highlight the medium in the Virtual 702 Media Manager. Then do either of the following: 703 </para> 704 705 <itemizedlist> 706 707 <listitem> 708 <para> 709 Click an icon in the Virtual Media Manager task bar. 710 </para> 711 </listitem> 712 713 <listitem> 714 <para> 715 Right-click the medium and select an option. 716 </para> 717 </listitem> 718 719 </itemizedlist> 720 721 <para> 722 To create a new disk image, you use the 723 <emphasis role="bold">Storage</emphasis> page in a virtual 724 machine's <emphasis role="bold">Settings</emphasis> dialog. This 725 is because disk images are by default stored in each machine's own 726 folder. 684 727 </para> 685 728 686 729 <para> 687 730 Hard disk image files can be copied to other host systems and 688 imported into virtual machines there, although certain guest 689 systems, notably Windows 2000 and XP, will require that the new 690 virtual machine be set up in a similar way to the old one. 731 imported into virtual machines there. However, certain guest 732 operating systems, such as Windows 2000 and Windows XP, require 733 that the new virtual machine be set up in a similar way to the old 734 one. 691 735 </para> 692 736 … … 694 738 <para> 695 739 Do not simply make copies of virtual disk images. If you import 696 such a second copy into a virtual machine, VirtualBoxwill697 complain with an error, since VirtualBoxassigns a unique740 such a second copy into a virtual machine, &product-name; will 741 complain with an error, since &product-name; assigns a unique 698 742 identifier (UUID) to each disk image to make sure it is only 699 used once. See <xref 700 linkend="cloningvdis" />. Also, if 701 you want to copy a virtual machine to another system, VirtualBox 702 has an import/export facility that might be better suited for 703 your needs. See <xref linkend="ovf" />. 743 used once. See <xref linkend="cloningvdis" />. Also, if you want 744 to copy a virtual machine to another system, &product-name; has 745 import and export features that might be better suited for your 746 needs. See <xref linkend="ovf" />. 704 747 </para> 705 748 </note> … … 712 755 713 756 <para> 714 For each virtual disk image supported by VirtualBox, you can757 For each virtual disk image supported by &product-name;, you can 715 758 determine separately how it should be affected by write operations 716 759 from a virtual machine and snapshot operations. This applies to … … 723 766 By default, images are in <emphasis>normal</emphasis> mode. To 724 767 mark an existing image with one of the non-standard modes listed 725 below, use <computeroutput>VBoxManage modifyhd</computeroutput>. 726 See <xref 727 linkend="vboxmanage-modifyvdi" />. Alternatively, 728 use VBoxManage to attach the image to a VM and use the 729 <computeroutput>--mtype</computeroutput> argument. See 768 below, use <command>VBoxManage modifyhd</command>. See 769 <xref linkend="vboxmanage-modifyvdi" />. Alternatively, use 770 <command>VBoxManage</command> to attach the image to a VM and use 771 the <option>--mtype</option> argument. See 730 772 <xref linkend="vboxmanage-storageattach" />. 731 773 </para> … … 753 795 <para> 754 796 The image file itself is not reset. Instead, when a snapshot 755 is taken, VirtualBox "freezes" the image file and no longer756 writes to it. For the write operations from the VM, a second,757 <emphasis>differencing</emphasis> image file is created which758 receives only the changes to the original image. See759 <xref linkend="diffimages"/>.797 is taken, &product-name; "freezes" the image file and no 798 longer writes to it. For the write operations from the VM, a 799 second, <emphasis>differencing</emphasis> image file is 800 created which receives only the changes to the original image. 801 See <xref linkend="diffimages"/>. 760 802 </para> 761 803 … … 766 808 otherwise there would be conflicts if several machines write 767 809 to the same image file. 768 769 <footnote>770 771 <para>772 This restriction is more lenient now than it was before773 VirtualBox 2.2. Previously, each normal disk image could774 only be <emphasis>attached</emphasis> to one single775 machine. Now it can be attached to more than one machine776 so long as only one of these machines is running.777 </para>778 779 </footnote>780 810 </para> 781 811 </listitem> … … 803 833 disk concurrently. Only fixed size images can be used in this 804 834 way, and dynamically allocated images are rejected. 805 806 <warning> 807 <para>808 This is an expert feature, and misuse can lead to data809 loss, as regular filesystems are not prepared to handle810 simultaneous changes by several parties.811 </para>812 </ warning>813 </ para>835 </para> 836 837 <warning> 838 <para> 839 This is an expert feature, and misuse can lead to data loss, 840 as regular filesystems are not prepared to handle 841 simultaneous changes by several parties. 842 </para> 843 </warning> 814 844 </listitem> 815 845 … … 855 885 856 886 <para> 857 VirtualBox never writes to an immutable image directly at all.858 All write operations from the machine are directed to a887 &product-name; never writes to an immutable image directly at 888 all. All write operations from the machine are directed to a 859 889 differencing image. The next time the VM is powered on, the 860 890 differencing image is reset so that every time the VM starts, 861 891 its immutable images have exactly the same content. 862 863 <footnote> 864 865 <para> 866 This behavior also changed with VirtualBox 2.2. 867 Previously, the differencing images were discarded when 868 the machine session <emphasis>ended</emphasis>; now they 869 are discarded every time the machine is powered on. 870 </para> 871 872 </footnote> 873 892 </para> 893 894 <para> 874 895 The differencing image is only reset when the machine is 875 powered on from within VirtualBox, not when you reboot by896 powered on from within &product-name;, not when you reboot by 876 897 requesting a reboot from within the machine. This is also why 877 898 immutable images behave as described above when snapshots are … … 882 903 If the automatic discarding of the differencing image on VM 883 904 startup does not fit your needs, you can turn it off using the 884 <computeroutput>autoreset</computeroutput> parameter of 885 <computeroutput>VBoxManage modifyhd</computeroutput>. See 886 <xref 887 linkend="vboxmanage-modifyvdi"/>. 905 <option>autoreset</option> parameter of <command>VBoxManage 906 modifyhd</command>. See 907 <xref linkend="vboxmanage-modifyvdi"/>. 888 908 </para> 889 909 </listitem> … … 984 1004 When the machine reads a sector from such a virtual hard disk, it 985 1005 looks into the differencing image first. If the sector is present, 986 it is returned from there. If not, VirtualBoxlooks into the1006 it is returned from there. If not, &product-name; looks into the 987 1007 parent. In other words, the parent becomes 988 1008 <emphasis>read-only</emphasis>. It is never written to again, but … … 997 1017 read-only as well, and write operations only go to the 998 1018 second-level differencing image. When reading from the virtual 999 disk, VirtualBox needs to look into the second differencing image1000 first, then into the first if the sector was not found, and then1001 into the original image.1019 disk, &product-name; needs to look into the second differencing 1020 image first, then into the first if the sector was not found, and 1021 then into the original image. 1002 1022 </para> 1003 1023 … … 1009 1029 Write operations always go to the one <emphasis>active</emphasis> 1010 1030 differencing image that is attached to the machine, and for read 1011 operations, VirtualBox may need to look up all the parents in the 1012 chain until the sector in question is found. You can view such a 1013 tree in the Virtual Media Manager: 1014 </para> 1015 1016 <mediaobject> 1017 <imageobject> 1018 <imagedata align="center" fileref="images/virtual-disk-manager2.png" 1031 operations, &product-name; may need to look up all the parents in 1032 the chain until the sector in question is found. You can view such 1033 a tree in the Virtual Media Manager. 1034 </para> 1035 1036 <figure id="fig-diff-images"> 1037 <title>Differencing Images, Shown in Virtual Media Manager</title> 1038 <mediaobject> 1039 <imageobject> 1040 <imagedata align="center" fileref="images/virtual-disk-manager2.png" 1019 1041 width="12cm" /> 1020 </imageobject> 1021 </mediaobject> 1042 </imageobject> 1043 </mediaobject> 1044 </figure> 1022 1045 1023 1046 <para> … … 1025 1048 machine, the virtual hard disk behaves like any other disk. While 1026 1049 the virtual machine is running, there is a slight run-time I/O 1027 overhead because VirtualBox might need to look up sectors several1028 times. This is not noticeable however since the tables with sector1029 information are always kept in memory and can be looked up1030 quickly.1050 overhead because &product-name; might need to look up sectors 1051 several times. This is not noticeable however since the tables 1052 with sector information are always kept in memory and can be 1053 looked up quickly. 1031 1054 </para> 1032 1055 … … 1040 1063 <para> 1041 1064 <emphasis role="bold">Snapshots.</emphasis> When you create a 1042 snapshot, as explained in the previous section, VirtualBox1065 snapshot, as explained in the previous section, &product-name; 1043 1066 "freezes" the images attached to the virtual machine and 1044 1067 creates differencing images for each image that is not in … … 1067 1090 <listitem> 1068 1091 <para> 1069 VirtualBox copies the virtual machine settings that were1070 copied into the snapshot back to the virtual machine. As a1071 result, if you have made changes to the machine1092 &product-name; copies the virtual machine settings that 1093 were copied into the snapshot back to the virtual machine. 1094 As a result, if you have made changes to the machine 1072 1095 configuration since taking the snapshot, they are undone. 1073 1096 </para> … … 1105 1128 differencing images becomes obsolete. In this case, the 1106 1129 differencing image of the disk attachment cannot simply be 1107 deleted. Instead, VirtualBox needs to look at each sector of1108 the differencing image and needs to copy it back into its1130 deleted. Instead, &product-name; needs to look at each sector 1131 of the differencing image and needs to copy it back into its 1109 1132 parent. This is called "merging" images and can be a 1110 1133 potentially lengthy process, depending on how large the … … 1143 1166 system setup. However, you should <emphasis>only</emphasis> make 1144 1167 copies of virtual disk images using the utility supplied with 1145 VirtualBox. See <xref 1146 linkend="vboxmanage-clonevdi" />. This 1147 is because VirtualBox assigns a unique identity number (UUID) to 1148 each disk image, which is also stored inside the image, and 1149 VirtualBox will refuse to work with two images that use the same 1150 number. If you do accidentally try to reimport a disk image which 1151 you copied normally, you can make a second copy using VirtualBox's 1152 utility and import that instead. 1168 &product-name;. See <xref linkend="vboxmanage-clonevdi" />. This 1169 is because &product-name; assigns a unique identity number (UUID) 1170 to each disk image, which is also stored inside the image, and 1171 &product-name; will refuse to work with two images that use the 1172 same number. If you do accidentally try to reimport a disk image 1173 which you copied normally, you can make a second copy using 1174 &product-name;'s utility and import that instead. 1153 1175 </para> 1154 1176 1155 1177 <para> 1156 1178 Note that newer Linux distributions identify the boot hard disk 1157 from the ID of the drive. The ID VirtualBox reports for a drive is1158 d etermined from the UUID of the virtual disk image. So if you1159 clone a disk image and try to boot the copied image the guest1179 from the ID of the drive. The ID &product-name; reports for a 1180 drive is determined from the UUID of the virtual disk image. So if 1181 you clone a disk image and try to boot the copied image the guest 1160 1182 might not be able to determine its own boot disk as the UUID 1161 1183 changed. In this case you have to adapt the disk ID in your boot … … 1177 1199 <sect1 id="iocaching"> 1178 1200 1179 <title>Host I/O Caching</title> 1180 1181 <para> 1182 Starting with version 3.2, VirtualBox can optionally disable the 1183 I/O caching that the host operating system would otherwise perform 1184 on disk image files. 1185 </para> 1186 1187 <para> 1188 Traditionally, VirtualBox has opened disk image files as normal 1189 files, which results in them being cached by the host operating 1190 system like any other file. The main advantage of this is speed: 1191 when the guest OS writes to disk and the host OS cache uses 1192 delayed writing, the write operation can be reported as completed 1193 to the guest OS quickly while the host OS can perform the 1194 operation asynchronously. Also, when you start a VM a second time 1195 and have enough memory available for the OS to use for caching, 1196 large parts of the virtual disk may be in system memory, and the 1197 VM can access the data much faster. 1201 <title>Host Input/Output Caching</title> 1202 1203 <para> 1204 &product-name; can optionally disable the I/O caching that the 1205 host operating system would otherwise perform on disk image files. 1206 </para> 1207 1208 <para> 1209 Traditionally, &product-name; has opened disk image files as 1210 normal files, which results in them being cached by the host 1211 operating system like any other file. The main advantage of this 1212 is speed: when the guest OS writes to disk and the host OS cache 1213 uses delayed writing, the write operation can be reported as 1214 completed to the guest OS quickly while the host OS can perform 1215 the operation asynchronously. Also, when you start a VM a second 1216 time and have enough memory available for the OS to use for 1217 caching, large parts of the virtual disk may be in system memory, 1218 and the VM can access the data much faster. 1198 1219 </para> 1199 1220 … … 1202 1223 occur for virtual disks residing on remote iSCSI storage, which is 1203 1224 the more common scenario in enterprise-class setups. See 1204 <xref 1205 linkend="storage-iscsi" />. 1225 <xref linkend="storage-iscsi" />. 1206 1226 </para> 1207 1227 … … 1251 1271 <para> 1252 1272 If you decide to disable host I/O caching for the above reasons, 1253 VirtualBox uses its own small cache to buffer writes, but no read1254 caching since this is typically already performed by the guest OS.1255 In addition, VirtualBox fully supports asynchronous I/O for its1256 virtual SATA, SCSI and SAS controllers through multiple I/O1257 threads.1273 &product-name; uses its own small cache to buffer writes, but no 1274 read caching since this is typically already performed by the 1275 guest OS. In addition, &product-name; fully supports asynchronous 1276 I/O for its virtual SATA, SCSI and SAS controllers through 1277 multiple I/O threads. 1258 1278 </para> 1259 1279 … … 1265 1285 1266 1286 <para> 1267 For this reason, VirtualBox allows you to configure whether the 1268 host I/O cache is used for each I/O controller separately. Either 1269 select the <emphasis role="bold">Use Host I/O Cache</emphasis> 1270 check box in the Storage settings for a given virtual storage 1271 controller, or use the following VBoxManage command to disable the 1272 host I/O cache for a virtual storage controller: 1287 For this reason, &product-name; enables you to configure whether 1288 the host I/O cache is used for each I/O controller separately. 1289 Either select the <emphasis role="bold">Use Host I/O 1290 Cache</emphasis> check box in the 1291 <emphasis role="bold">Storage</emphasis> settings for a given 1292 virtual storage controller, or use the following 1293 <command>VBoxManage</command> command to disable the host I/O 1294 cache for a virtual storage controller: 1273 1295 </para> 1274 1296 … … 1280 1302 1281 1303 <para> 1282 For the above reasons, VirtualBoxnow uses SATA controllers by1304 For the above reasons, &product-name; now uses SATA controllers by 1283 1305 default for new virtual machines. 1284 1306 </para> … … 1291 1313 1292 1314 <para> 1293 Starting with version 4.0, VirtualBox allows for limiting the1294 maximum bandwidth used for asynchronous I/O. Additionally it1295 supports sharing limits through bandwidth groups for several1296 images. It is possible to have morethan one such limit.1297 </para> 1298 1299 <para> 1300 Limits are configured using 1301 <computeroutput>VBoxManage</computeroutput>. The example below1302 creates a bandwidth group named Limit, sets the limit to 20 MB per1303 second, and assigns the group to the attacheddisks of the VM:1315 &product-name; supports limiting of the maximum bandwidth used for 1316 asynchronous I/O. Additionally it supports sharing limits through 1317 bandwidth groups for several images. It is possible to have more 1318 than one such limit. 1319 </para> 1320 1321 <para> 1322 Limits are configured using <command>VBoxManage</command>. The 1323 example below creates a bandwidth group named Limit, sets the 1324 limit to 20 MB per second, and assigns the group to the attached 1325 disks of the VM: 1304 1326 </para> 1305 1327 … … 1373 1395 1374 1396 <para> 1375 Medium changes can be prevented by the guest, and VirtualBox1397 Medium changes can be prevented by the guest, and &product-name; 1376 1398 reflects that by locking the host drive if appropriate. You can 1377 force a medium removal in such situations via the VirtualBox GUI 1378 or the VBoxManage command line tool. Effectively this is the 1379 equivalent of the emergency eject which many CD/DVD drives 1380 provide, with all associated side effects. The guest OS can issue 1381 error messages, just like on real hardware, and guest applications 1382 may misbehave. Use this with caution. 1399 force a medium removal in such situations by using the 1400 &product-name; GUI or the <command>VBoxManage</command> command 1401 line tool. Effectively this is the equivalent of the emergency 1402 eject which many CD/DVD drives provide, with all associated side 1403 effects. The guest OS can issue error messages, just like on real 1404 hardware, and guest applications may misbehave. Use this with 1405 caution. 1383 1406 </para> 1384 1407 … … 1395 1418 1396 1419 <para> 1397 The standard CD/DVD emulation allows for readingstandard data CD1420 The standard CD/DVD emulation enables reading of standard data CD 1398 1421 and DVD formats only. As an experimental feature, for additional 1399 1422 capabilities, it is possible to give the guest direct access to … … 1427 1450 1428 1451 <para> 1429 There is a Passthrough check box in the GUI dialog for configuring 1430 the media attached to a storage controller, or you can use the 1431 <computeroutput>--passthrough</computeroutput> option with 1432 <computeroutput>VBoxManage storageattach</computeroutput>. See 1433 <xref 1434 linkend="vboxmanage-storageattach" />. 1452 There is a <emphasis role="bold">Passthrough</emphasis> check box 1453 in the GUI dialog for configuring the media attached to a storage 1454 controller, or you can use the <option>--passthrough</option> 1455 option with <command>VBoxManage storageattach</command>. See 1456 <xref linkend="vboxmanage-storageattach" />. 1435 1457 </para> 1436 1458 … … 1443 1465 1444 1466 <para> 1445 On Solaris hosts, passthrough requires running VirtualBox with1446 real root permissions due to security measures enforced by the1447 host.1467 On Oracle Solaris hosts, passthrough requires running 1468 &product-name; with real root permissions due to security measures 1469 enforced by the host. 1448 1470 </para> 1449 1471 … … 1455 1477 1456 1478 <para> 1457 iSCSI stands for "Internet SCSI" and is a standard that allows for1458 us ingthe SCSI protocol over Internet (TCP/IP) connections.1479 iSCSI stands for "Internet SCSI" and is a standard that supports 1480 use of the SCSI protocol over Internet (TCP/IP) connections. 1459 1481 Especially with the advent of Gigabit Ethernet, it has become 1460 1482 affordable to attach iSCSI storage servers simply as remote hard … … 1467 1489 1468 1490 <para> 1469 VirtualBoxcan transparently present iSCSI remote storage to a1491 &product-name; can transparently present iSCSI remote storage to a 1470 1492 virtual machine as a virtual hard disk. The guest operating system 1471 1493 will not see any difference between a virtual disk image (VDI 1472 file) and an iSCSI target. To achieve this, VirtualBoxhas an1494 file) and an iSCSI target. To achieve this, &product-name; has an 1473 1495 integrated iSCSI initiator. 1474 1496 </para> 1475 1497 1476 1498 <para> 1477 VirtualBox's iSCSI support has been developed according to the1499 &product-name;'s iSCSI support has been developed according to the 1478 1500 iSCSI standard and should work with all standard-conforming iSCSI 1479 targets. To use an iSCSI target with VirtualBox, you must use the1480 command line. See <xref linkend="vboxmanage-storageattach" />.1501 targets. To use an iSCSI target with &product-name;, you must use 1502 the command line. See <xref linkend="vboxmanage-storageattach" />. 1481 1503 </para> 1482 1504 -
trunk/doc/manual/en_US/user_Technical.xml
r73276 r76078 10 10 11 11 <para> 12 Th e contents of this chapter are not required to use VirtualBox13 successfully. The following is provided as additional information14 for readers who are more familiar with computer architecture and15 technology and wish to find out more about how VirtualBox works16 "under the hood".12 This chapter provides additional information for readers who are 13 familiar with computer architecture and technology and wish to find 14 out more about how &product-name; works <emphasis>under the 15 hood</emphasis>. The contents of this chapter are not required 16 reading in order to use &product-name; successfully. 17 17 </para> 18 18 19 19 <sect1 id="vboxconfigdata"> 20 20 21 <title>Where VirtualBox Stores its Files</title> 22 23 <para> 24 In VirtualBox, a virtual machine and its settings are described in 25 a virtual machine settings file in XML format. In addition, most 26 virtual machine have one or more virtual hard disks, which are 27 typically represented by disk images, such as those in VDI format. 28 Where all these files are stored depends on which version of 29 VirtualBox created the machine. 30 </para> 31 32 <sect2 id="vboxconfigdata-pre-version-four"> 33 34 <title>Machines Created by VirtualBox Version 4.0 or Later</title> 35 36 <para> 37 Starting with version 4.0, by default, each virtual machine has 38 one directory on your host computer where all the files of that 39 machine are stored: the XML settings file, with a 40 <computeroutput>.vbox</computeroutput> file extension, and its 41 disk images. 42 </para> 43 44 <para> 45 By default, this <replaceable>machine folder</replaceable> is 46 placed in a common folder called <computeroutput>VirtualBox 47 VMs</computeroutput>, which VirtualBox creates in the current 48 system user's home directory. The location of this home 21 <title>Where &product-name; Stores its Files</title> 22 23 <para> 24 In &product-name;, a virtual machine and its settings are 25 described in a virtual machine settings file in XML format. In 26 addition, most virtual machine have one or more virtual hard 27 disks, which are typically represented by disk images, such as 28 those in VDI format. Where all these files are stored depends on 29 which version of &product-name; created the machine. 30 </para> 31 32 <sect2 id="vboxconfigdata-post-version-four"> 33 34 <title>Machines Created by &product-name; Version 4.0 or Later</title> 35 36 <para> 37 By default, each virtual machine has one directory on your host 38 computer where all the files of that machine are stored: the XML 39 settings file, with a <computeroutput>.vbox</computeroutput> 40 file extension, and its disk images. 41 </para> 42 43 <para> 44 By default, this <emphasis>machine folder</emphasis> is placed 45 in a common folder called <computeroutput>VirtualBox 46 VMs</computeroutput>, which &product-name; creates in the 47 current system user's home directory. The location of this home 49 48 directory depends on the conventions of the host operating 50 system :49 system, as follows: 51 50 </para> 52 51 … … 71 70 <listitem> 72 71 <para> 73 On Linux, Mac OS X and Solaris, this is generally taken from74 t he environment variable72 On Linux, Mac OS X, and Oracle Solaris, this is generally 73 taken from the environment variable 75 74 <computeroutput>$HOME</computeroutput>, except for the user 76 75 <computeroutput>root</computeroutput> where it is taken from 77 76 the account database. This is a workaround for the frequent 78 trouble caused by users using VirtualBox in combination with79 the tool <computeroutput>sudo</computeroutput> which by77 trouble caused by users using &product-name; in combination 78 with the tool <computeroutput>sudo</computeroutput> which by 80 79 default does not reset the environment variable 81 80 <computeroutput>$HOME</computeroutput>. A typical location 82 on Linux and Solaris is81 on Linux and Oracle Solaris is 83 82 <computeroutput>/home/username</computeroutput> and on Mac 84 83 OS X <computeroutput>/Users/username</computeroutput>. … … 97 96 <para> 98 97 As an example, when you create a virtual machine called "Example 99 VM", you will find that VirtualBoxcreates the following:98 VM", &product-name; creates the following: 100 99 </para> 101 100 … … 126 125 127 126 <para> 128 This is the default layout if you use the Create New Virtual129 Machine wizard described in <xref linkend="gui-createvm" />.130 Once you start working with the VM, additional files are added.131 Log files are in a subfolder called132 <computeroutput>Logs</computeroutput>, and if you have taken133 snapshots, they are in a127 This is the default layout if you use the 128 <emphasis role="bold">Create New Virtual Machine</emphasis> 129 wizard described in <xref linkend="gui-createvm" />. Once you 130 start working with the VM, additional files are added. Log files 131 are in a subfolder called <computeroutput>Logs</computeroutput>, 132 and if you have taken snapshots, they are in a 134 133 <computeroutput>Snapshots</computeroutput> subfolder. For each 135 134 VM, you can change the location of its snapshots folder in the … … 139 138 <para> 140 139 You can change the default machine folder by selecting 141 <emphasis role="bold">Preferences</emphasis> from the File menu 142 in the VirtualBox main window. Then, in the displayed window, 143 click on the <emphasis role="bold">General</emphasis> tab. 144 Alternatively, use <computeroutput>VBoxManage setproperty 145 machinefolder</computeroutput>. See 146 <xref 147 linkend="vboxmanage-setproperty" />. 140 <emphasis role="bold">Preferences</emphasis> from the 141 <emphasis role="bold">File</emphasis> menu in the &product-name; 142 main window. Then, in the displayed window, click on the 143 <emphasis role="bold">General</emphasis> tab. Alternatively, use 144 <command>VBoxManage setproperty machinefolder</command>. See 145 <xref linkend="vboxmanage-setproperty" />. 148 146 </para> 149 147 150 148 </sect2> 151 149 152 <sect2 id="vboxconfigdata-post-version-four"> 153 154 <title>Machines Created by VirtualBox Versions Before 4.0</title> 155 156 <para> 157 If you have upgraded to VirtualBox 4.0 from an earlier version 158 of VirtualBox, you probably have settings files and disks in the 159 earlier file system layout. 160 </para> 161 162 <para> 163 Before version 4.0, VirtualBox separated the machine settings 164 files from virtual disk images. The machine settings files had 165 an <computeroutput>.xml</computeroutput> file extension and 166 resided in a folder called "Machines" under the global 167 VirtualBox configuration directory. See 150 <sect2 id="vboxconfigdata-pre-version-four"> 151 152 <title>Machines Created by &product-name; Versions Before 4.0</title> 153 154 <para> 155 If you have upgraded to &product-name; 4.0 from an earlier 156 version of &product-name;, you probably have settings files and 157 disks in the earlier file system layout. 158 </para> 159 160 <para> 161 Before version 4.0, &product-name; separated the machine 162 settings files from virtual disk images. The machine settings 163 files had an <computeroutput>.xml</computeroutput> file 164 extension and resided in a folder called 165 <computeroutput>Machines</computeroutput> under the global 166 &product-name; configuration directory. See 168 167 <xref linkend="vboxconfigdata-global"/>. On Linux, for example, 169 this was the hidden 170 <computeroutput>$HOME/.VirtualBox/Machines</computeroutput> 171 directory. The default hard disks folder was called "HardDisks" 172 and resided in the <computeroutput>.VirtualBox</computeroutput> 173 folder as well. Both locations could be changed by the user in 174 the global preferences. The concept of a default hard disk 175 folder has been abandoned with VirtualBox 4.0, since disk images 176 now reside in each machine's folder by default. 168 this was the hidden directory 169 <computeroutput>$HOME/.VirtualBox/Machines</computeroutput>. The 170 default hard disks folder was called 171 <computeroutput>HardDisks</computeroutput> and was also located 172 in the <computeroutput>.VirtualBox</computeroutput> folder. Both 173 locations could be changed by the user in the global 174 preferences. The concept of a default hard disk folder was 175 abandoned with &product-name; 4.0, since disk images now reside 176 in each machine's folder by default. 177 177 </para> 178 178 … … 189 189 the same folder. In addition, the virtual media of all 190 190 machines were registered with a global registry in the 191 central VirtualBoxsettings file,191 central &product-name; settings file, 192 192 <computeroutput>$HOME/.VirtualBox/VirtualBox.xml</computeroutput>. 193 193 </para> … … 208 208 under the hidden 209 209 <computeroutput>.VirtualBox</computeroutput> directory, at 210 least on Linux and Solaris hosts, made many users wonder211 w here their disk space had gone.210 least on Linux and Oracle Solaris hosts, made many users 211 wonder where their disk space had gone. 212 212 </para> 213 213 </listitem> … … 216 216 217 217 <para> 218 Whereas new VMs created with VirtualBox4.0 or later will218 Whereas new VMs created with &product-name; 4.0 or later will 219 219 conform to the new layout, for maximum compatibility, old VMs 220 220 are <emphasis>not</emphasis> converted to the new layout. 221 221 Otherwise machine settings would be irrevocably broken if a user 222 downgraded from 4.0 back to an older version of VirtualBox.222 downgraded from 4.0 back to an older version of &product-name;. 223 223 </para> 224 224 … … 230 230 231 231 <para> 232 In addition to the files of the virtual machines, VirtualBox 233 maintains global configuration data. On Linux and Solaris as of 234 VirtualBox 4.3, this is in the hidden directory 235 <computeroutput>$HOME/.config/VirtualBox</computeroutput>, 236 although <computeroutput>$HOME/.VirtualBox</computeroutput> will 237 be used if it exists for compatibility with earlier versions. On 238 Windows, and on Linux and Solaris with VirtualBox 4.2 and 239 earlier, this is in 240 <computeroutput>$HOME/.VirtualBox</computeroutput>. On Mac OS X, 241 it resides in 242 <computeroutput>$HOME/Library/VirtualBox</computeroutput>. 243 </para> 244 245 <para> 246 VirtualBox creates this configuration directory automatically if 247 necessary. Optionally, you can supply an alternate configuration 248 directory by setting the 249 <computeroutput><literal>VBOX_USER_HOME</literal></computeroutput> 250 environment variable, or additionally on Linux or Solaris by 251 using the standard 252 <computeroutput><literal>XDG_CONFIG_HOME</literal></computeroutput> 232 In addition to the files of the virtual machines, &product-name; 233 maintains global configuration data in the following directory: 234 </para> 235 236 <itemizedlist> 237 238 <listitem> 239 <para> 240 <emphasis role="bold">Linux and Oracle Solaris:</emphasis> 241 <computeroutput>$HOME/.config/VirtualBox</computeroutput>. 242 </para> 243 244 <para> 245 <computeroutput>$HOME/.VirtualBox</computeroutput> is used 246 if it exists, for compatibility with legacy versions before 247 &product-name; 4.3. 248 </para> 249 </listitem> 250 251 <listitem> 252 <para> 253 <emphasis role="bold">Windows:</emphasis> 254 <computeroutput>$HOME/.VirtualBox</computeroutput>. 255 </para> 256 </listitem> 257 258 <listitem> 259 <para> 260 <emphasis role="bold">Mac OS X:</emphasis> 261 <computeroutput>$HOME/Library/VirtualBox</computeroutput>. 262 </para> 263 </listitem> 264 265 </itemizedlist> 266 267 <para> 268 &product-name; creates this configuration directory 269 automatically, if necessary. Optionally, you can specify an 270 alternate configuration directory by setting the 271 <computeroutput>VBOX_USER_HOME</computeroutput> environment 272 variable, or additionally on Linux or Oracle Solaris by using 273 the standard <computeroutput>XDG_CONFIG_HOME</computeroutput> 253 274 variable. Since the global 254 275 <computeroutput>VirtualBox.xml</computeroutput> settings file 255 points to all other configuration files, this allows for256 switching between several VirtualBox configurations entirely.257 </para> 258 259 <para> 260 Most importantly, in this directory, VirtualBoxstores its276 points to all other configuration files, this enables switching 277 between several &product-name; configurations. 278 </para> 279 280 <para> 281 Most importantly, in this directory, &product-name; stores its 261 282 global settings file, another XML file called 262 283 <computeroutput>VirtualBox.xml</computeroutput>. This includes … … 264 285 machines with pointers to their XML settings files. Neither the 265 286 location of this file nor its directory has changed with 266 VirtualBox 4.0. 267 </para> 268 269 <para> 270 Before VirtualBox 4.0, all virtual media (disk image files) were 271 also contained in a global registry in this settings file. For 272 compatibility, this media registry still exists if you upgrade 273 VirtualBox and there are media from machines which were created 274 with a version before 4.0. If you have no such machines, then 275 there will be no global media registry. With VirtualBox 4.0, 276 each machine XML file has its own media registry. 277 </para> 278 279 <para> 280 Also before VirtualBox 4.0, the default "Machines" folder and 281 the default "HardDisks" folder resided under the VirtualBox 282 configuration directory, such as 287 &product-name; 4.0. 288 </para> 289 290 <para> 291 Before &product-name; 4.0, all virtual media, such as disk image 292 files, were also contained in a global registry in this settings 293 file. For compatibility, this media registry still exists if you 294 upgrade &product-name; and there are media from machines which 295 were created with a version before 4.0. If you have no such 296 machines, then there will be no global media registry. With 297 &product-name; 4.0, each machine XML file has its own media 298 registry. 299 </para> 300 301 <para> 302 Also before &product-name; 4.0, the default 303 <computeroutput>Machines</computeroutput> folder and the default 304 <computeroutput>HardDisks</computeroutput> folder resided under 305 the &product-name; configuration directory, such as 283 306 <computeroutput>$HOME/.VirtualBox/Machines</computeroutput> on 284 Linux. If you are upgrading from a VirtualBox version before285 4.0, files in these directories are not automatically moved in286 order not to break backwards compatibility.307 Linux. If you are upgrading from an &product-name; version 308 before 4.0, files in these directories are not automatically 309 moved in order not to break backwards compatibility. 287 310 </para> 288 311 … … 304 327 <thead> 305 328 <row> 306 <entry><emphasis role="bold">Setting</emphasis></entry> 307 <entry><emphasis role="bold">Before 4.0</emphasis></entry> 308 <entry><emphasis role="bold">4.0 or above</emphasis></entry> 329 <entry><para> 330 <emphasis role="bold">Setting</emphasis> 331 </para></entry> 332 <entry><para> 333 <emphasis role="bold">Before 4.0</emphasis> 334 </para></entry> 335 <entry><para> 336 <emphasis role="bold">4.0 or above</emphasis> 337 </para></entry> 309 338 </row> 310 339 </thead> 311 340 <tbody> 312 341 <row> 313 <entry>Default machines folder</entry> 314 <entry><computeroutput>$HOME/.VirtualBox/Machines</computeroutput></entry> 315 <entry><computeroutput>$HOME/VirtualBox VMs</computeroutput></entry> 342 <entry><para> 343 Default machines folder 344 </para></entry> 345 <entry><para> 346 <computeroutput>$HOME/.VirtualBox/Machines</computeroutput> 347 </para></entry> 348 <entry><para> 349 <computeroutput>$HOME/VirtualBox VMs</computeroutput> 350 </para></entry> 316 351 </row> 317 352 <row> 318 <entry>Default disk image location</entry> 319 <entry><computeroutput>$HOME/.VirtualBox/HardDisks</computeroutput></entry> 320 <entry>In each machine's folder</entry> 353 <entry><para> 354 Default disk image location 355 </para></entry> 356 <entry><para> 357 <computeroutput>$HOME/.VirtualBox/HardDisks</computeroutput> 358 </para></entry> 359 <entry><para> 360 In each machine's folder 361 </para></entry> 321 362 </row> 322 363 <row> 323 <entry>Machine settings file extension</entry> 324 <entry><computeroutput>.xml</computeroutput></entry> 325 <entry><computeroutput>.vbox</computeroutput></entry> 364 <entry><para> 365 Machine settings file extension 366 </para></entry> 367 <entry><para> 368 <computeroutput>.xml</computeroutput> 369 </para></entry> 370 <entry><para> 371 <computeroutput>.vbox</computeroutput> 372 </para></entry> 326 373 </row> 327 374 <row> 328 <entry>Media registry</entry> 329 <entry>Global <computeroutput>VirtualBox.xml</computeroutput> file</entry> 330 <entry>Each machine settings file</entry> 375 <entry><para> 376 Media registry 377 </para></entry> 378 <entry><para> 379 Global <computeroutput>VirtualBox.xml</computeroutput> 380 file 381 </para></entry> 382 <entry><para> 383 Each machine settings file 384 </para></entry> 331 385 </row> 332 386 <row> 333 <entry>Media registration</entry> 334 <entry>Explicit open/close required</entry> 335 <entry>Automatic on attach</entry> 387 <entry><para> 388 Media registration 389 </para></entry> 390 <entry><para> 391 Explicit open/close required 392 </para></entry> 393 <entry><para> 394 Automatic on attach 395 </para></entry> 336 396 </row> 337 397 </tbody> … … 343 403 <sect2 id="vboxconfigdata-XML-files"> 344 404 345 <title> VirtualBoxXML Files</title>346 347 <para> 348 VirtualBox uses XML for both the machine settings files and the349 global configuration file,405 <title>&product-name; XML Files</title> 406 407 <para> 408 &product-name; uses XML for both the machine settings files and 409 the global configuration file, 350 410 <computeroutput>VirtualBox.xml</computeroutput>. 351 411 </para> 352 412 353 413 <para> 354 All VirtualBox XML files are versioned. When a new settings file 355 is created, for example because a new virtual machine is 356 created, VirtualBox automatically uses the settings format of 357 the current VirtualBox version. These files may not be readable 358 if you downgrade to an earlier version of VirtualBox. However, 359 when VirtualBox encounters a settings file from an earlier 360 version, such as after upgrading VirtualBox, it attempts to 361 preserve the settings format as much as possible. It will only 362 silently upgrade the settings format if the current settings 363 cannot be expressed in the old format, for example because you 364 enabled a feature that was not present in an earlier version of 365 VirtualBox. 366 367 <footnote> 368 369 <para> 370 As an example, before VirtualBox 3.1, it was only possible 371 to enable or disable a single DVD drive in a virtual 372 machine. If it was enabled, then it would always be visible 373 as the secondary master of the IDE controller. With 374 VirtualBox 3.1, DVD drives can be attached to arbitrary 375 slots of arbitrary controllers, so they could be the 376 secondary slave of an IDE controller or in a SATA slot. If 377 you have a machine settings file from an earlier version and 378 upgrade VirtualBox to 3.1 and then move the DVD drive from 379 its default position, this cannot be expressed in the old 380 settings format; the XML machine file would get written in 381 the new format, and a backup file of the old format would be 382 kept. 383 </para> 384 385 </footnote> 386 387 In such cases, VirtualBox backs up the old settings file in the 388 virtual machine's configuration directory. If you need to go 389 back to the earlier version of VirtualBox, then you will need to 390 manually copy these backup files back. 414 All &product-name; XML files are versioned. When a new settings 415 file is created, for example because a new virtual machine is 416 created, &product-name; automatically uses the settings format 417 of the current &product-name; version. These files may not be 418 readable if you downgrade to an earlier version of 419 &product-name;. However, when &product-name; encounters a 420 settings file from an earlier version, such as after upgrading 421 &product-name;, it attempts to preserve the settings format as 422 much as possible. It will only silently upgrade the settings 423 format if the current settings cannot be expressed in the old 424 format, for example because you enabled a feature that was not 425 present in an earlier version of &product-name;. 426 </para> 427 428 <para> 429 As an example, before &product-name; 3.1, it was only possible 430 to enable or disable a single DVD drive in a virtual machine. If 431 it was enabled, then it would always be visible as the secondary 432 master of the IDE controller. With &product-name; 3.1, DVD 433 drives can be attached to arbitrary slots of arbitrary 434 controllers, so they could be the secondary slave of an IDE 435 controller or in a SATA slot. If you have a machine settings 436 file from an earlier version and upgrade &product-name; to 3.1 437 and then move the DVD drive from its default position, this 438 cannot be expressed in the old settings format; the XML machine 439 file would get written in the new format, and a backup file of 440 the old format would be kept. 441 </para> 442 443 <para> 444 In such cases, &product-name; backs up the old settings file in 445 the virtual machine's configuration directory. If you need to go 446 back to the earlier version of &product-name;, then you will 447 need to manually copy these backup files back. 391 448 </para> 392 449 393 450 <para> 394 451 We intentionally do not document the specifications of the 395 VirtualBoxXML files, as we must reserve the right to modify452 &product-name; XML files, as we must reserve the right to modify 396 453 them in the future. We therefore strongly suggest that you do 397 not edit these files manually. VirtualBoxprovides complete454 not edit these files manually. &product-name; provides complete 398 455 access to its configuration data through its the 399 <computeroutput>VBoxManage</computeroutput> command line tool, 400 see <xref linkend="vboxmanage" /> and its API, see 401 <xref 402 linkend="VirtualBoxAPI" />. 456 <command>VBoxManage</command> command line tool, see 457 <xref linkend="vboxmanage" /> and its API, see 458 <xref linkend="VirtualBoxAPI" />. 403 459 </para> 404 460 … … 409 465 <sect1 id="technical-components"> 410 466 411 <title> VirtualBoxExecutables and Components</title>412 413 <para> 414 VirtualBoxwas designed to be modular and flexible. When the415 VirtualBox graphical user interface (GUI) is opened and a VM is416 started, at least the following three processes are running:467 <title>&product-name; Executables and Components</title> 468 469 <para> 470 &product-name; was designed to be modular and flexible. When the 471 &product-name; graphical user interface (GUI) is opened and a VM 472 is started, at least the following three processes are running: 417 473 </para> 418 474 … … 421 477 <listitem> 422 478 <para> 423 <computeroutput>VBoxSVC</computeroutput>, the VirtualBox479 <computeroutput>VBoxSVC</computeroutput>, the &product-name; 424 480 service process which always runs in the background. This 425 process is started automatically by the first VirtualBox481 process is started automatically by the first &product-name; 426 482 client process and exits a short time after the last client 427 exits. The first VirtualBoxservice can be the GUI,483 exits. The first &product-name; service can be the GUI, 428 484 <computeroutput>VBoxManage</computeroutput>, 429 485 <computeroutput>VBoxHeadless</computeroutput>, the web service 430 486 amongst others. The service is responsible for bookkeeping, 431 487 maintaining the state of all VMs, and for providing 432 communication between VirtualBoxcomponents. This433 communication is implemented viaCOM/XPCOM.488 communication between &product-name; components. This 489 communication is implemented using COM/XPCOM. 434 490 </para> 435 491 436 492 <note> 437 493 <para> 438 When we refer to "clients" here, we mean the local clients 439 of a particular <computeroutput>VBoxSVC</computeroutput> 440 server process, not clients in a network. VirtualBox employs 441 its own client/server design to allow its processes to 442 cooperate, but all these processes run under the same user 443 account on the host operating system, and this is totally 444 transparent to the user. 494 When we refer to <emphasis>clients</emphasis> here, we mean 495 the local clients of a particular 496 <computeroutput>VBoxSVC</computeroutput> server process, not 497 clients in a network. &product-name; employs its own 498 client/server design to allow its processes to cooperate, 499 but all these processes run under the same user account on 500 the host operating system, and this is totally transparent 501 to the user. 445 502 </para> 446 503 </note> … … 449 506 <listitem> 450 507 <para> 451 The GUI process, <computeroutput>VirtualBox</computeroutput>, 452 a client application based on the cross-platform Qt library. 453 When started without the 454 <computeroutput>--startvm</computeroutput> option, this 455 application acts as the VirtualBox manager, displaying the VMs 456 and their settings. It then communicates settings and state 457 changes to <computeroutput>VBoxSVC</computeroutput> and also 458 reflects changes effected through other means, such as 459 <computeroutput>VBoxManage</computeroutput>. 460 </para> 461 </listitem> 462 463 <listitem> 464 <para> 465 If the <computeroutput>VirtualBox</computeroutput> client 508 The GUI process, 509 <computeroutput>VirtualBoxVM</computeroutput>, a client 510 application based on the cross-platform Qt library. When 511 started without the <computeroutput>--startvm</computeroutput> 512 option, this application acts as the &product-name; manager, 513 displaying the VMs and their settings. It then communicates 514 settings and state changes to 515 <computeroutput>VBoxSVC</computeroutput> and also reflects 516 changes effected through other means, such as the 517 <command>VBoxManage</command> command. 518 </para> 519 </listitem> 520 521 <listitem> 522 <para> 523 If the <computeroutput>VirtualBoxVM</computeroutput> client 466 524 application is started with the 467 525 <computeroutput>--startvm</computeroutput> argument, it loads … … 475 533 476 534 <para> 477 Any VirtualBoxfront-end, or client, will communicate with the535 Any &product-name; front-end, or client, will communicate with the 478 536 service process and can both control and reflect the current 479 537 state. For example, either the VM selector or the VM window or … … 483 541 484 542 <para> 485 The VirtualBox GUI application is only one of several available486 front ends, or clients. The complete list shipped with VirtualBox487 is as follows:543 The &product-name; GUI application is only one of several 544 available front ends, or clients. The complete list shipped with 545 &product-name; is as follows: 488 546 </para> 489 547 … … 492 550 <listitem> 493 551 <para> 494 <computeroutput>VirtualBox </computeroutput>: The Qt front end495 implementing the manager and running VMs.552 <computeroutput>VirtualBoxVM</computeroutput>: The Qt front 553 end implementing the manager and running VMs. 496 554 </para> 497 555 </listitem> … … 501 559 <computeroutput>VBoxManage</computeroutput>: A less 502 560 user-friendly but more powerful alternative. See 503 <xref 504 linkend="vboxmanage" />. 505 </para> 506 </listitem> 507 508 <listitem> 509 <para> 510 <computeroutput>VBoxSDL</computeroutput>: A simple graphical 511 front end based on the SDL library. See 512 <xref 513 linkend="vboxsdl" />. 561 <xref linkend="vboxmanage" />. 514 562 </para> 515 563 </listitem> … … 518 566 <para> 519 567 <computeroutput>VBoxHeadless</computeroutput>: A VM front end 520 which does not directly provide any video output and 521 keyboard/mouse input, but allows redirection viaVirtualBox568 which does not directly provide any video output and keyboard 569 or mouse input, but enables redirection through the VirtualBox 522 570 Remote Desktop Extension. See <xref linkend="vboxheadless" />. 523 571 </para> … … 526 574 <listitem> 527 575 <para> 528 <computeroutput>vboxwebsrv</computeroutput>: The VirtualBox529 web service process which allows for controlling a VirtualBox530 host remotely. This is described in detail in the VirtualBox531 Software Development Kit (SDK) reference. See532 <xref533 linkend="VirtualBoxAPI" />.534 </para>535 </listitem> 536 537 <listitem>538 <para>539 The VirtualBox Python shell: A Python alternative to540 VBoxManage. This is alsodescribed in the SDK reference.576 <computeroutput>vboxwebsrv</computeroutput>: The 577 &product-name; web service process which enables control of an 578 &product-name; host remotely. This is described in detail in 579 the &product-name; Software Development Kit (SDK) reference. 580 See <xref linkend="VirtualBoxAPI" />. 581 </para> 582 </listitem> 583 584 <listitem> 585 <para> 586 The &product-name; Python shell: A Python alternative to 587 <computeroutput>VBoxManage</computeroutput>. This is also 588 described in the SDK reference. 541 589 </para> 542 590 </listitem> … … 545 593 546 594 <para> 547 Internally, VirtualBoxconsists of many more or less separate548 components. You may encounter these when analyzing VirtualBox595 Internally, &product-name; consists of many more or less separate 596 components. You may encounter these when analyzing &product-name; 549 597 internal error messages or log files. These include the following: 550 598 </para> … … 555 603 <para> 556 604 IPRT: A portable runtime library which abstracts file access, 557 threading, and string manipulation. Whenever VirtualBox605 threading, and string manipulation. Whenever &product-name; 558 606 accesses host operating features, it does so through this 559 607 library for cross-platform portability. … … 607 655 implementations from VMM internals and makes it easy to add 608 656 new emulated devices. Through PDM, third-party developers can 609 add new virtual devices to VirtualBox without having to change610 VirtualBoxitself.657 add new virtual devices to &product-name; without having to 658 change &product-name; itself. 611 659 </para> 612 660 </listitem> … … 662 710 <listitem> 663 711 <para> 664 VirtualBoxemulates a number of devices to provide the712 &product-name; emulates a number of devices to provide the 665 713 hardware environment that various guests need. Most of these 666 714 are standard devices found in many PC compatible machines and … … 676 724 Guest Additions for various guest operating systems. This is 677 725 code that is installed from within a virtual machine. See 678 <xref 679 linkend="guestadditions" />. 726 <xref linkend="guestadditions" />. 680 727 </para> 681 728 </listitem> … … 684 731 <para> 685 732 The "Main" component is special. It ties all the above bits 686 together and is the only public API that VirtualBox provides.687 All the client processes listed above use only this API and688 never access the hypervisor components directly. As a result,689 third-party applications that use the VirtualBox Main API can690 rely on the fact that it is always well-tested and that all691 capabilities of VirtualBox are fully exposed. It is this API692 that is described in the VirtualBox SDK. See693 <xref linkend="VirtualBoxAPI" />.733 together and is the only public API that &product-name; 734 provides. All the client processes listed above use only this 735 API and never access the hypervisor components directly. As a 736 result, third-party applications that use the &product-name; 737 Main API can rely on the fact that it is always well-tested 738 and that all capabilities of &product-name; are fully exposed. 739 It is this API that is described in the &product-name; SDK. 740 See <xref linkend="VirtualBoxAPI" />. 694 741 </para> 695 742 </listitem> … … 704 751 705 752 <para> 706 VirtualBox allows software in the virtual machine to run directly 707 on the processor of the host, but an array of complex techniques 708 is employed to intercept operations that would interfere with your 709 host. Whenever the guest attempts to do something that could be 710 harmful to your computer and its data, VirtualBox steps in and 711 takes action. In particular, for lots of hardware that the guest 712 believes to be accessing, VirtualBox simulates a certain "virtual" 713 environment according to how you have configured a virtual 714 machine. For example, when the guest attempts to access a hard 715 disk, VirtualBox redirects these requests to whatever you have 716 configured to be the virtual machine's virtual hard disk. This is 717 normally an image file on your host. 753 &product-name; enables software in the virtual machine to run 754 directly on the processor of the host, but an array of complex 755 techniques is employed to intercept operations that would 756 interfere with your host. Whenever the guest attempts to do 757 something that could be harmful to your computer and its data, 758 &product-name; steps in and takes action. In particular, for lots 759 of hardware that the guest believes to be accessing, 760 &product-name; simulates a certain "virtual" environment according 761 to how you have configured a virtual machine. For example, when 762 the guest attempts to access a hard disk, &product-name; redirects 763 these requests to whatever you have configured to be the virtual 764 machine's virtual hard disk. This is normally an image file on 765 your host. 718 766 </para> 719 767 720 768 <para> 721 769 Unfortunately, the x86 platform was never designed to be 722 virtualized. Detecting situations in which VirtualBoxneeds to770 virtualized. Detecting situations in which &product-name; needs to 723 771 take control over the guest code that is executing, as described 724 772 above, is difficult. There are two ways in which to achieve this: … … 731 779 Since 2006, Intel and AMD processors have had support for 732 780 so-called <emphasis>hardware virtualization</emphasis>. This 733 means that these processors can help VirtualBox to intercept734 potentially dangerous operations that a guest operating system735 may be attempting and also makes it easier to present virtual736 hardware to a virtual machine.781 means that these processors can help &product-name; to 782 intercept potentially dangerous operations that a guest 783 operating system may be attempting and also makes it easier to 784 present virtual hardware to a virtual machine. 737 785 </para> 738 786 … … 747 795 <para> 748 796 On many systems, the hardware virtualization features first 749 need to be enabled in the BIOS before VirtualBoxcan use797 need to be enabled in the BIOS before &product-name; can use 750 798 them. 751 799 </para> … … 756 804 <para> 757 805 As opposed to other virtualization software, for many usage 758 scenarios, VirtualBox does not <emphasis>require</emphasis> 759 hardware virtualization features to be present. Through 760 sophisticated techniques, VirtualBox virtualizes many guest 761 operating systems entirely in <emphasis>software</emphasis>. 762 This means that you can run virtual machines even on older 763 processors which do not support hardware virtualization. 806 scenarios, &product-name; does not 807 <emphasis>require</emphasis> hardware virtualization features 808 to be present. Through sophisticated techniques, 809 &product-name; virtualizes many guest operating systems 810 entirely in <emphasis>software</emphasis>. This means that you 811 can run virtual machines even on older processors which do not 812 support hardware virtualization. 764 813 </para> 765 814 </listitem> … … 768 817 769 818 <para> 770 Even though VirtualBoxdoes not always require hardware819 Even though &product-name; does not always require hardware 771 820 virtualization, enabling it is <emphasis>required</emphasis> in 772 821 the following scenarios: … … 787 836 <listitem> 788 837 <para> 789 VirtualBox's 64-bit guest support (added with version 2.0) and790 multiprocessing (SMP, added with version 3.0) both require791 hardware virtualization to be enabled. This is not much of a792 limitation since the vast majority of today's 64-bit and793 multicore CPUs ship with hardware virtualization anyway. The794 exceptions to this rule are older Intel Celeron and AMD838 &product-name;'s 64-bit guest support, added with version 2.0, 839 and multiprocessing (SMP), added with version 3.0, both 840 require hardware virtualization to be enabled. This is not 841 much of a limitation since the vast majority of today's 64-bit 842 and multicore CPUs ship with hardware virtualization anyway. 843 The exceptions to this rule are older Intel Celeron and AMD 795 844 Opteron CPUs, for example. 796 845 </para> … … 802 851 <para> 803 852 Do not run other hypervisors, either open source or commercial 804 virtualization products, together with VirtualBox. While several 805 hypervisors can normally be <emphasis>installed</emphasis> in 806 parallel, do not attempt to <emphasis>run</emphasis> several 807 virtual machines from competing hypervisors at the same time. 808 VirtualBox cannot track what another hypervisor is currently 809 attempting to do on the same host, and especially if several 810 products attempt to use hardware virtualization features such as 811 VT-x, this can crash the entire host. Also, within VirtualBox, 812 you can mix software and hardware virtualization when running 813 multiple VMs. In certain cases a small performance penalty will 814 be unavoidable when mixing VT-x and software virtualization VMs. 815 We recommend not mixing virtualization modes if maximum 816 performance and low overhead are essential. This does 817 <emphasis>not</emphasis> apply to AMD-V. 853 virtualization products, together with &product-name;. While 854 several hypervisors can normally be 855 <emphasis>installed</emphasis> in parallel, do not attempt to 856 <emphasis>run</emphasis> several virtual machines from competing 857 hypervisors at the same time. &product-name; cannot track what 858 another hypervisor is currently attempting to do on the same 859 host, and especially if several products attempt to use hardware 860 virtualization features such as VT-x, this can crash the entire 861 host. Also, within &product-name;, you can mix software and 862 hardware virtualization when running multiple VMs. In certain 863 cases a small performance penalty will be unavoidable when 864 mixing VT-x and software virtualization VMs. We recommend not 865 mixing virtualization modes if maximum performance and low 866 overhead are essential. This does <emphasis>not</emphasis> apply 867 to AMD-V. 818 868 </para> 819 869 </warning> … … 826 876 827 877 <para> 828 VirtualBox allows exposing a paravirtualization interface to829 facilitate accurate and efficient execution of software within a830 virtual machine. These interfaces require the guest operating831 system to recognize their presence and make use of them in order832 t o leverage the benefits of communicating with the VirtualBox833 hypervisor.878 &product-name; enables the exposure of a paravirtualization 879 interface, to facilitate accurate and efficient execution of 880 software within a virtual machine. These interfaces require the 881 guest operating system to recognize their presence and make use of 882 them in order to leverage the benefits of communicating with the 883 &product-name; hypervisor. 834 884 </para> 835 885 … … 847 897 the <emphasis>Hyper-V</emphasis> paravirtualization provider can 848 898 be used for VMs to run on any host platform supported by 849 VirtualBoxand not just Windows.850 </para> 851 852 <para> 853 VirtualBoxprovides the following interfaces:899 &product-name; and not just Windows. 900 </para> 901 902 <para> 903 &product-name; provides the following interfaces: 854 904 </para> 855 905 … … 869 919 <emphasis role="bold">KVM</emphasis>: Presents a Linux KVM 870 920 hypervisor interface which is recognized by Linux kernels 871 starting with version 2.6.25. VirtualBox's implementation921 version 2.6.25 or later. &product-name;'s implementation 872 922 currently supports paravirtualized clocks and SMP spinlocks. 873 923 This provider is recommended for Linux guests. … … 879 929 <emphasis role="bold">Hyper-V</emphasis>: Presents a Microsoft 880 930 Hyper-V hypervisor interface which is recognized by Windows 7 881 and newer operating systems. VirtualBox's implementation931 and newer operating systems. &product-name;'s implementation 882 932 currently supports paravirtualized clocks, APIC frequency 883 933 reporting, guest debugging, guest crash reporting and relaxed … … 908 958 in the 1980s with the 286 CPU architecture and then again with the 909 959 Intel 386 and its 32-bit architecture. Whereas the 386 did have 910 limited virtualization support for real mode operation (V86 mode,911 as used by the "DOS Box" of Windows 3.x and OS/2 2.x), no support912 was provided for virtualizing the entire architecture.960 limited virtualization support for real mode operation with V86 961 mode, as used by the "DOS Box" of Windows 3.x and OS/2 2.x, no 962 support was provided for virtualizing the entire architecture. 913 963 </para> 914 964 … … 944 994 to either modify or see the true state of the CPU, and only then 945 995 executed. This process is obviously highly complex and costly in 946 terms of performance. VirtualBox contains a recompiler based on947 QEMU which can be used for pure software emulation, but the996 terms of performance. &product-name; contains a recompiler based 997 on QEMU which can be used for pure software emulation, but the 948 998 recompiler is only activated in special situations, described 949 999 below. … … 962 1012 963 1013 <para> 964 VirtualBox chooses a different approach. When starting a virtual 965 machine, through its ring-0 support kernel driver, VirtualBox has 966 set up the host system so that it can run most of the guest code 967 natively, but it has inserted itself at the "bottom" of the 968 picture. It can then assume control when needed. If a privileged 969 instruction is executed, the guest traps, in particular because an 970 I/O register was accessed and a device needs to be virtualized, or 971 external interrupts occur. VirtualBox may then handle this and 972 either route a request to a virtual device or possibly delegate 973 handling such things to the guest or host OS. In guest context, 974 VirtualBox can therefore be in one of three states: 1014 &product-name; chooses a different approach. When starting a 1015 virtual machine, through its ring-0 support kernel driver, 1016 &product-name; has set up the host system so that it can run most 1017 of the guest code natively, but it has inserted itself at the 1018 "bottom" of the picture. It can then assume control when needed. 1019 If a privileged instruction is executed, the guest traps, in 1020 particular because an I/O register was accessed and a device needs 1021 to be virtualized, or external interrupts occur. &product-name; 1022 may then handle this and either route a request to a virtual 1023 device or possibly delegate handling such things to the guest or 1024 host OS. In guest context, &product-name; can therefore be in one 1025 of three states: 975 1026 </para> 976 1027 … … 990 1041 <listitem> 991 1042 <para> 992 For guest code in ring 0, VirtualBox employs a clever trick.993 It actually reconfigures the guest so that its ring-0 code is994 run in ring 1 instead, which is normally not used in x86995 operating systems). As a result, when guest ring-0 code,1043 For guest code in ring 0, &product-name; employs a clever 1044 trick. It actually reconfigures the guest so that its ring-0 1045 code is run in ring 1 instead, which is normally not used in 1046 x86 operating systems). As a result, when guest ring-0 code, 996 1047 actually running n ring 1, such as a guest device driver 997 1048 attempts to write to an I/O register or execute a privileged 998 instruction, the VirtualBox hypervisor in the "real" ring 0999 can take over.1049 instruction, the &product-name; hypervisor in the "real" ring 1050 0 can take over. 1000 1051 </para> 1001 1052 </listitem> … … 1004 1055 <para> 1005 1056 The hypervisor (VMM) can be active. Every time a fault occurs, 1006 VirtualBox looks at the offending instruction and can relegate1007 it to a virtual device or the host OS or the guest OS or run1008 it in the recompiler.1057 &product-name; looks at the offending instruction and can 1058 relegate it to a virtual device or the host OS or the guest OS 1059 or run it in the recompiler. 1009 1060 </para> 1010 1061 1011 1062 <para> 1012 1063 In particular, the recompiler is used when guest code disables 1013 interrupts and VirtualBox cannot figure out when they will be1014 switched back on. In these situations, VirtualBox actually1015 a nalyzes the guest code using its own disassembler. Also,1016 certain privileged instructions such as LIDT need to be1064 interrupts and &product-name; cannot figure out when they will 1065 be switched back on. In these situations, &product-name; 1066 actually analyzes the guest code using its own disassembler. 1067 Also, certain privileged instructions such as LIDT need to be 1017 1068 handled specially. Finally, any real-mode or protected-mode 1018 1069 code, such as BIOS code, a DOS guest, or any operating system … … 1090 1141 register in 32-bit mode. Accesses to this register must be 1091 1142 trapped by the hypervisor. But certain guest operating 1092 systems, notably Windows and Solaris, write this register very 1093 often, which adversely affects virtualization performance. 1143 systems, notably Windows and Oracle Solaris, write this 1144 register very often, which adversely affects virtualization 1145 performance. 1094 1146 </para> 1095 1147 </listitem> … … 1098 1150 1099 1151 <para> 1100 To fix these performance and security issues, VirtualBox contains1101 a Code Scanning and Analysis Manager (CSAM), which disassembles1102 guest code, and the Patch Manager (PATM), which can replace it at1103 r untime.1152 To fix these performance and security issues, &product-name; 1153 contains a Code Scanning and Analysis Manager (CSAM), which 1154 disassembles guest code, and the Patch Manager (PATM), which can 1155 replace it at runtime. 1104 1156 </para> 1105 1157 … … 1117 1169 1118 1170 <para> 1119 In addition, every time a fault occurs, VirtualBox analyzes the1120 offending code to determine if it is possible to patch it in order1121 to prevent it from causing more faults in the future. This1171 In addition, every time a fault occurs, &product-name; analyzes 1172 the offending code to determine if it is possible to patch it in 1173 order to prevent it from causing more faults in the future. This 1122 1174 approach works well in practice and dramatically improves software 1123 1175 virtualization performance. … … 1233 1285 In addition to normal hardware virtualization, your processor may 1234 1286 also support the following additional sophisticated techniques: 1235 1236 <footnote>1237 1238 <para>1239 VirtualBox 2.0 added support for AMD's nested paging; support1240 for Intel's EPT and VPIDs was added with version 2.1.1241 </para>1242 1243 </footnote>1244 1287 </para> 1245 1288 … … 1248 1291 <listitem> 1249 1292 <para> 1250 A newer feature called <emphasis>nested paging</emphasis>1251 implements some memory management in hardware, which can1252 greatly accelerate hardware virtualization since these tasks1253 no longer need to be performed by thevirtualization software.1293 Nested paging implements some memory management in hardware, 1294 which can greatly accelerate hardware virtualization since 1295 these tasks no longer need to be performed by the 1296 virtualization software. 1254 1297 </para> 1255 1298 … … 1275 1318 <para> 1276 1319 On AMD processors, nested paging has been available starting 1277 with the Barcelona (K10) architecture. They now call it "rapid1278 virtualization indexing "(RVI). Intel added support for nested1320 with the Barcelona (K10) architecture. They now call it rapid 1321 virtualization indexing (RVI). Intel added support for nested 1279 1322 paging, which they call extended page tables (EPT), with their 1280 1323 Core i7 (Nehalem) processors. … … 1282 1325 1283 1326 <para> 1284 If nested paging is enabled, the VirtualBoxhypervisor can1285 also use <emphasis role="bold">large pages</emphasis> to1286 reduce TLB usage and overhead. This can yield a performance1287 improvement of up to 5%. To enable this feature for a VM, you1288 need to use the<computeroutput>VBoxManage modifyvm1327 If nested paging is enabled, the &product-name; hypervisor can 1328 also use <emphasis>large pages</emphasis> to reduce TLB usage 1329 and overhead. This can yield a performance improvement of up 1330 to 5%. To enable this feature for a VM, you need to use the 1331 <computeroutput>VBoxManage modifyvm 1289 1332 </computeroutput><computeroutput>--largepages</computeroutput> 1290 1333 command. See <xref linkend="vboxmanage-modifyvm" />. … … 1294 1337 <listitem> 1295 1338 <para> 1296 On Intel CPUs, a nother hardware feature called Virtual1297 Processor Identifiers" (VPIDs) can greatly accelerate context1298 switching by reducing the need for expensive flushing of the1299 processor'sTranslation Lookaside Buffers (TLBs).1339 On Intel CPUs, a hardware feature called Virtual Processor 1340 Identifiers (VPIDs) can greatly accelerate context switching 1341 by reducing the need for expensive flushing of the processor's 1342 Translation Lookaside Buffers (TLBs). 1300 1343 </para> 1301 1344 … … 1304 1347 <computeroutput>VBoxManage modifyvm --vtxvpid</computeroutput> 1305 1348 and <computeroutput>--largepages</computeroutput> commands. 1306 See <xref 1307 linkend="vboxmanage-modifyvm" />. 1349 See <xref linkend="vboxmanage-modifyvm" />. 1308 1350 </para> 1309 1351 </listitem> -
trunk/doc/manual/en_US/user_ThirdParty.xml
r73278 r76078 5 5 %all.entities; 6 6 ]> 7 8 7 <appendix id="ThirdParty"> 8 9 9 <title>Third-Party Materials and Licenses</title> 10 10 11 <para>VirtualBox incorporates materials from several Open Source software 12 projects. Therefore the use of these materials by VirtualBox is governed by 13 different Open Source licenses. This document reproduces these licenses and 14 provides a list of the materials used and their respective licensing 15 conditions. Section 1 contains a list of the materials used. Section 2 16 reproduces the applicable Open Source licenses. For each material, a 17 reference to its license is provided.</para> 18 19 <para>The source code for the materials listed below as well as the rest of 20 the VirtualBox code which is released as open source are available at <ulink 21 url="http://www.virtualbox.org">http://www.virtualbox.org</ulink>, both as 22 tarballs for particular releases and as a live SVN repository.</para> 11 <para> 12 &product-name; incorporates materials from several Open Source 13 software projects. Therefore the use of these materials by 14 &product-name; is governed by different Open Source licenses. This 15 document reproduces these licenses and provides a list of the 16 materials used and their respective licensing conditions. Section 1 17 contains a list of the materials used. Section 2 reproduces the 18 applicable Open Source licenses. For each material, a reference to 19 its license is provided. 20 </para> 21 22 <para> 23 The source code for the materials listed below as well as the rest 24 of the &product-name; code which is released as open source are 25 available at 26 <ulink 27 url="http://www.virtualbox.org">http://www.virtualbox.org</ulink>, 28 both as tarballs for particular releases and as a live SVN 29 repository. 30 </para> 23 31 24 32 <sect1 id="third-party-materials"> 33 25 34 <title>Third-Party Materials</title> 26 35 27 36 <itemizedlist> 37 28 38 <listitem> 29 <para>VirtualBox contains portions of QEMU which is governed by the 30 licenses in <xref linkend="licX11" xrefstyle="template: %n" /> and 31 <xref linkend="licLGPL" xrefstyle="template: %n" /> and</para> 32 33 <para>(C) 2003-2005 Fabrice Bellard; Copyright (C) 2004-2005 Vassili 34 Karpov (malc); Copyright (c) 2004 Antony T Curtis; Copyright (C) 2003 35 Jocelyn Mayer</para> 39 <para> 40 &product-name; contains portions of QEMU which is governed by 41 the licenses in 42 <xref linkend="licX11" xrefstyle="template: %n" /> and 43 <xref linkend="licLGPL" xrefstyle="template: %n" /> and 44 </para> 45 46 <para> 47 (C) 2003-2005 Fabrice Bellard; Copyright (C) 2004-2005 Vassili 48 Karpov (malc); Copyright (c) 2004 Antony T Curtis; Copyright 49 (C) 2003 Jocelyn Mayer 50 </para> 36 51 </listitem> 37 52 38 53 <listitem> 39 <para>VirtualBox contains code which is governed by the license in 40 <xref linkend="licX11" xrefstyle="template: %n" /> and</para> 41 42 <para>Copyright 2004 by the Massachusetts Institute of 43 Technology.</para> 54 <para> 55 &product-name; contains code which is governed by the license 56 in <xref linkend="licX11" xrefstyle="template: %n" /> and 57 </para> 58 59 <para> 60 Copyright 2004 by the Massachusetts Institute of Technology. 61 </para> 44 62 </listitem> 45 63 46 64 <listitem> 47 <para>VirtualBox contains code of the BOCHS VGA BIOS which is governed 48 by the license in <xref linkend="licLGPL" xrefstyle="template: %n" /> 49 and</para> 50 51 <para>Copyright (C) 2001, 2002 the LGPL VGABios developers 52 Team.</para> 65 <para> 66 &product-name; contains code of the BOCHS VGA BIOS which is 67 governed by the license in 68 <xref linkend="licLGPL" xrefstyle="template: %n" /> and 69 </para> 70 71 <para> 72 Copyright (C) 2001, 2002 the LGPL VGABios developers Team. 73 </para> 53 74 </listitem> 54 75 55 76 <listitem> 56 <para>VirtualBox contains code of the BOCHS ROM BIOS which is governed 57 by the license in <xref linkend="licLGPL" xrefstyle="template: %n" /> 58 and</para> 59 60 <para>Copyright (C) 2002 MandrakeSoft S.A.; Copyright (C) 2004 Fabrice 61 Bellard; Copyright (C) 2005 Struan Bartlett.</para> 77 <para> 78 &product-name; contains code of the BOCHS ROM BIOS which is 79 governed by the license in 80 <xref linkend="licLGPL" xrefstyle="template: %n" /> and 81 </para> 82 83 <para> 84 Copyright (C) 2002 MandrakeSoft S.A.; Copyright (C) 2004 85 Fabrice Bellard; Copyright (C) 2005 Struan Bartlett. 86 </para> 62 87 </listitem> 63 88 64 89 <listitem> 65 <para>VirtualBox contains the zlib library which is governed by the 66 license in <xref linkend="licZLIB" xrefstyle="template: %n" /> 67 and</para> 68 69 <para>Copyright (C) 1995-2003 Jean-loup Gailly and Mark Adler.</para> 90 <para> 91 &product-name; contains the zlib library which is governed by 92 the license in 93 <xref linkend="licZLIB" xrefstyle="template: %n" /> and 94 </para> 95 96 <para> 97 Copyright (C) 1995-2003 Jean-loup Gailly and Mark Adler. 98 </para> 70 99 </listitem> 71 100 72 101 <listitem> 73 <para>VirtualBox may contain OpenSSL which is governed by the license 74 in <xref linkend="licSSL" xrefstyle="template: %n" /> and</para> 75 76 <para>Copyright (C) 1995-1998 Eric Young ([email protected]). This 77 product includes software written by Tim Hudson 78 ([email protected]).</para> 102 <para> 103 &product-name; may contain OpenSSL which is governed by the 104 license in <xref linkend="licSSL" xrefstyle="template: %n" /> 105 and 106 </para> 107 108 <para> 109 Copyright (C) 1995-1998 Eric Young ([email protected]). This 110 product includes software written by Tim Hudson 111 ([email protected]). 112 </para> 79 113 </listitem> 80 114 81 115 <listitem> 82 <para>VirtualBox may contain NSPR and XPCOM which is governed by the 83 license in <xref linkend="licMPL" xrefstyle="template: %n" /> 84 and</para> 85 86 <para>Copyright (C) The Authors.</para> 116 <para> 117 &product-name; may contain NSPR and XPCOM which is governed by 118 the license in 119 <xref linkend="licMPL" xrefstyle="template: %n" /> and 120 </para> 121 122 <para> 123 Copyright (C) The Authors. 124 </para> 87 125 </listitem> 88 126 89 127 <listitem> 90 <para>VirtualBox contains Slirp which is governed by the license in 91 <xref linkend="licSlirp" xrefstyle="template: %n" /> and was written 92 by Danny Gasparovski.</para> 93 94 <para>Copyright (C) 1995, 1996 All Rights Reserved.</para> 128 <para> 129 &product-name; contains Slirp which is governed by the license 130 in <xref linkend="licSlirp" xrefstyle="template: %n" /> and 131 was written by Danny Gasparovski. 132 </para> 133 134 <para> 135 Copyright (C) 1995, 1996 All Rights Reserved. 136 </para> 95 137 </listitem> 96 138 97 139 <listitem> 98 <para>VirtualBox contains liblzf which is governed by the license in 99 <xref linkend="licLZF" xrefstyle="template: %n" /> and</para> 100 101 <para>Copyright (C) 2000-2005 Marc Alexander Lehmann 102 <[email protected]></para> 140 <para> 141 &product-name; contains liblzf which is governed by the 142 license in <xref linkend="licLZF" xrefstyle="template: %n" /> 143 and 144 </para> 145 146 <para> 147 Copyright (C) 2000-2005 Marc Alexander Lehmann 148 <[email protected]> 149 </para> 103 150 </listitem> 104 151 105 152 <listitem> 106 <para>VirtualBox may ship with a modified copy of rdesktop which is 107 governed by the license in <xref linkend="licGPL" 108 xrefstyle="template: %n" /> and</para> 109 110 <para>Copyright (C) Matthew Chapman and others.</para> 153 <para> 154 &product-name; may ship with a modified copy of rdesktop which 155 is governed by the license in 156 <xref linkend="licGPL" 157 xrefstyle="template: %n" /> and 158 </para> 159 160 <para> 161 Copyright (C) Matthew Chapman and others. 162 </para> 111 163 </listitem> 112 164 113 165 <listitem> 114 <para>VirtualBox may ship with a copy of kchmviewer which is governed 115 by the license in <xref linkend="licGPL" xrefstyle="template: %n" /> 116 and</para> 117 118 <para>Copyright (C) George Yunaev and others.</para> 166 <para> 167 &product-name; may ship with a copy of kchmviewer which is 168 governed by the license in 169 <xref linkend="licGPL" xrefstyle="template: %n" /> and 170 </para> 171 172 <para> 173 Copyright (C) George Yunaev and others. 174 </para> 119 175 </listitem> 120 176 121 177 <listitem> 122 <para>VirtualBox may contain Etherboot which is governed by the 123 license in <xref linkend="licGPL" xrefstyle="template: %n" /> with the 124 exception that aggregating Etherboot with another work does not 125 require the other work to be released under the same license (see 126 <literal><ulink 127 url="http://etherboot.sourceforge.net/clinks.html">http://etherboot.sourceforge.net/clinks.html</ulink></literal>). 128 Etherboot is</para> 129 130 <para>Copyright (C) Etherboot team.</para> 178 <para> 179 &product-name; may contain Etherboot which is governed by the 180 license in <xref linkend="licGPL" xrefstyle="template: %n" /> 181 with the exception that aggregating Etherboot with another 182 work does not require the other work to be released under the 183 same license (see 184 <ulink 185 url="http://etherboot.sourceforge.net/clinks.html">http://etherboot.sourceforge.net/clinks.html</ulink>). 186 Etherboot is 187 </para> 188 189 <para> 190 Copyright (C) Etherboot team. 191 </para> 131 192 </listitem> 132 193 133 194 <listitem> 134 <para>VirtualBox may contain iPXE which is governed by the license 135 in <xref linkend="licGPL" xrefstyle="template: %n" /> and</para> 136 <para>Copyright (C) Michael Brown <[email protected]> 137 and others.</para> 195 <para> 196 &product-name; may contain iPXE which is governed by the 197 license in <xref linkend="licGPL" xrefstyle="template: %n" /> 198 and 199 </para> 200 201 <para> 202 Copyright (C) Michael Brown <[email protected]> 203 and others. 204 </para> 138 205 </listitem> 139 206 140 207 <listitem> 141 <para>VirtualBox contains code from Wine which is governed by the 142 license in <xref linkend="licLGPL" xrefstyle="template: %n" /> 143 and</para> 144 145 <para>Copyright 1993 Bob Amstadt, Copyright 1996 Albrecht Kleine, 146 Copyright 1997 David Faure, Copyright 1998 Morten Welinder, Copyright 147 1998 Ulrich Weigand, Copyright 1999 Ove Koven</para> 208 <para> 209 &product-name; contains code from Wine which is governed by 210 the license in 211 <xref linkend="licLGPL" xrefstyle="template: %n" /> and 212 </para> 213 214 <para> 215 Copyright 1993 Bob Amstadt, Copyright 1996 Albrecht Kleine, 216 Copyright 1997 David Faure, Copyright 1998 Morten Welinder, 217 Copyright 1998 Ulrich Weigand, Copyright 1999 Ove Koven 218 </para> 148 219 </listitem> 149 220 150 221 <listitem> 151 <para>VirtualBox contains code from lwIP which is governed by the 152 license in <xref linkend="licLWIP" xrefstyle="template: %n" /> 153 and</para> 154 155 <para>Copyright (C) 2001, 2002 Swedish Institute of Computer 156 Science.</para> 222 <para> 223 &product-name; contains code from lwIP which is governed by 224 the license in 225 <xref linkend="licLWIP" xrefstyle="template: %n" /> and 226 </para> 227 228 <para> 229 Copyright (C) 2001, 2002 Swedish Institute of Computer 230 Science. 231 </para> 157 232 </listitem> 158 233 159 234 <listitem> 160 <para>VirtualBox contains libxml which is governed by the license in 161 <xref linkend="licLibXML" xrefstyle="template: %n" /> and</para> 162 163 <para>Copyright (C) 1998-2003 Daniel Veillard.</para> 235 <para> 236 &product-name; contains libxml which is governed by the 237 license in 238 <xref linkend="licLibXML" xrefstyle="template: %n" /> and 239 </para> 240 241 <para> 242 Copyright (C) 1998-2003 Daniel Veillard. 243 </para> 164 244 </listitem> 165 245 166 246 <listitem> 167 <para>VirtualBox contains libxslt which is governed by the license in 168 <xref linkend="licLibXSLT" xrefstyle="template: %n" /> and</para> 169 170 <para>Copyright (C) 2001-2002 Daniel Veillard and Copyright (C) 171 2001-2002 Thomas Broyer, Charlie Bozeman and Daniel Veillard.</para> 247 <para> 248 &product-name; contains libxslt which is governed by the 249 license in 250 <xref linkend="licLibXSLT" xrefstyle="template: %n" /> and 251 </para> 252 253 <para> 254 Copyright (C) 2001-2002 Daniel Veillard and Copyright (C) 255 2001-2002 Thomas Broyer, Charlie Bozeman and Daniel Veillard. 256 </para> 172 257 </listitem> 173 258 174 259 <listitem> 175 <para>VirtualBox contains code from the gSOAP XML web services 176 tools, which are licensed under the license in <xref 177 linkend="licgSOAP" xrefstyle="template: %n" /> and</para> 178 179 <para>Copyright (C) 2000-2007, Robert van Engelen, Genivia Inc., and 180 others.</para> 260 <para> 261 &product-name; contains code from the gSOAP XML web services 262 tools, which are licensed under the license in 263 <xref 264 linkend="licgSOAP" xrefstyle="template: %n" /> 265 and 266 </para> 267 268 <para> 269 Copyright (C) 2000-2007, Robert van Engelen, Genivia Inc., and 270 others. 271 </para> 181 272 </listitem> 182 273 183 274 <listitem> 184 <para>VirtualBox ships with the application tunctl (shipped as 185 VBoxTunctl) from the User-mode Linux suite which is governed by the 186 license in <xref linkend="licGPL" xrefstyle="template: %n" /> 187 and</para> 188 189 <para>Copyright (C) 2002 Jeff Dike.</para> 275 <para> 276 &product-name; ships with the application tunctl (shipped as 277 VBoxTunctl) from the User-mode Linux suite which is governed 278 by the license in 279 <xref linkend="licGPL" xrefstyle="template: %n" /> and 280 </para> 281 282 <para> 283 Copyright (C) 2002 Jeff Dike. 284 </para> 190 285 </listitem> 191 286 192 287 <listitem> 193 <para>VirtualBox contains code from Chromium, an OpenGL 194 implementation, which is goverened by the licenses in <xref 195 linkend="licChromium" xrefstyle="template: %n" /> and</para> 196 197 <para>Copyright (C) Stanford University, The Regents of the University 198 of California, Red Hat, and others.</para> 288 <para> 289 &product-name; contains code from Chromium, an OpenGL 290 implementation, which is goverened by the licenses in 291 <xref 292 linkend="licChromium" xrefstyle="template: %n" /> 293 and 294 </para> 295 296 <para> 297 Copyright (C) Stanford University, The Regents of the 298 University of California, Red Hat, and others. 299 </para> 199 300 </listitem> 200 301 201 302 <listitem> 202 <para>VirtualBox contains libcurl which is governed by the license in 203 <xref linkend="licLibCurl" xrefstyle="template: %n" /> and</para> 204 205 <para>Copyright (C) 1996-2009, Daniel Stenberg.</para> 303 <para> 304 &product-name; contains libcurl which is governed by the 305 license in 306 <xref linkend="licLibCurl" xrefstyle="template: %n" /> and 307 </para> 308 309 <para> 310 Copyright (C) 1996-2009, Daniel Stenberg. 311 </para> 206 312 </listitem> 207 313 208 314 <listitem> 209 <para>VirtualBox contains dnsproxy which is governed by the license in 210 <xref linkend="licMIT" xrefstyle="template: %n" /> and</para> 211 212 <para>Copyright (c) 2003, 2004, 2005 Armin Wolfermann.</para> 315 <para> 316 &product-name; contains dnsproxy which is governed by the 317 license in <xref linkend="licMIT" xrefstyle="template: %n" /> 318 and 319 </para> 320 321 <para> 322 Copyright (c) 2003, 2004, 2005 Armin Wolfermann. 323 </para> 213 324 </listitem> 214 325 215 326 <listitem> 216 <para>VirtualBox may contain iniparser which is governed by the 217 license in <xref linkend="licMIT" xrefstyle="template: %n" /> and</para> 218 219 <para>Copyright (c) 2000-2008 by Nicolas Devillard.</para> 327 <para> 328 &product-name; may contain iniparser which is governed by the 329 license in <xref linkend="licMIT" xrefstyle="template: %n" /> 330 and 331 </para> 332 333 <para> 334 Copyright (c) 2000-2008 by Nicolas Devillard. 335 </para> 220 336 </listitem> 221 337 222 338 <listitem> 223 <para>VirtualBox contains some code from libgd which is governed by 224 the license in <xref linkend="licLibgd" xrefstyle="template: %n"/> and</para> 225 226 <para>Copyright 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 227 Pierre-Alain Joye ([email protected]).</para> 339 <para> 340 &product-name; contains some code from libgd which is governed 341 by the license in 342 <xref linkend="licLibgd" xrefstyle="template: %n"/> and 343 </para> 344 345 <para> 346 Copyright 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 347 Pierre-Alain Joye ([email protected]). 348 </para> 228 349 </listitem> 229 350 230 351 <listitem> 231 <para>VirtualBox contains code from the EFI Development Kit II 352 <para> 353 &product-name; contains code from the EFI Development Kit II 232 354 which is governed by the license in 233 <xref linkend="licBsdIntel" xrefstyle="template: %n" /> and</para> 234 235 <para>Copyright (c) 2004-2008, Intel Corporation.</para> 355 <xref linkend="licBsdIntel" xrefstyle="template: %n" /> and 356 </para> 357 358 <para> 359 Copyright (c) 2004-2008, Intel Corporation. 360 </para> 236 361 </listitem> 237 362 238 363 <listitem> 239 <para>VirtualBox contains libjpeg which is governed by the 240 license in <xref linkend="licJPEG" xrefstyle="template: %n" /> and</para> 241 242 <para>Copyright (C) 1991-2010, Thomas G. Lane, Guido Vollbeding.</para> 364 <para> 365 &product-name; contains libjpeg which is governed by the 366 license in <xref linkend="licJPEG" xrefstyle="template: %n" /> 367 and 368 </para> 369 370 <para> 371 Copyright (C) 1991-2010, Thomas G. Lane, Guido Vollbeding. 372 </para> 243 373 </listitem> 244 374 245 375 <listitem> 246 <para>VirtualBox may contain x86 SIMD extension for IJG JPEG library 247 which is governed by the license in <xref linkend="licJPEGSIMD" 248 xrefstyle="template: %n" /> and</para> 249 250 <para>Copyright 2009 Pierre Ossman <[email protected]> for Cendio AB; 251 Copyright 2010 D. R. Commander; Copyright (C) 1999-2006, MIYASAKA Masaru. 376 <para> 377 &product-name; may contain x86 SIMD extension for IJG JPEG 378 library which is governed by the license in 379 <xref linkend="licJPEGSIMD" 380 xrefstyle="template: %n" /> 381 and 382 </para> 383 384 <para> 385 Copyright 2009 Pierre Ossman <[email protected]> for 386 Cendio AB; Copyright 2010 D. R. Commander; Copyright (C) 387 1999-2006, MIYASAKA Masaru. 252 388 </para> 253 389 </listitem> 254 390 255 391 <listitem> 256 <para>VirtualBox may ship a copy of Qt which is governed by the license in 257 <xref linkend="licLGPL" xrefstyle="template: %n" /> 258 and</para> 259 260 <para>Copyright (C) 2010, 2011 Nokia Corporation and/or its subsidiary(-ies).</para> 392 <para> 393 &product-name; may ship a copy of Qt which is governed by the 394 license in <xref linkend="licLGPL" xrefstyle="template: %n" /> 395 and 396 </para> 397 398 <para> 399 Copyright (C) 2010, 2011 Nokia Corporation and/or its 400 subsidiary(-ies). 401 </para> 261 402 </listitem> 262 403 263 404 <listitem> 264 <para>VirtualBox contains parts of the FreeBSD kernel which is governed by 265 the license in <xref linkend="licFreeBsd" xrefstyle="template: %n" />. 405 <para> 406 &product-name; contains parts of the FreeBSD kernel which is 407 governed by the license in 408 <xref linkend="licFreeBsd" xrefstyle="template: %n" />. 266 409 </para> 267 410 </listitem> 268 411 269 412 <listitem> 270 <para>VirtualBox contains parts of the NetBSD kernel which is governed by 271 the license in <xref linkend="licNetBsd" xrefstyle="template: %n" />. 413 <para> 414 &product-name; contains parts of the NetBSD kernel which is 415 governed by the license in 416 <xref linkend="licNetBsd" xrefstyle="template: %n" />. 272 417 </para> 273 418 </listitem> 274 419 275 420 <listitem> 276 <para>VirtualBox contains portions of liblightdm-gobject which is governed by the 277 license in <xref linkend="licLGPL" xrefstyle="template: %n" /> and</para> 278 279 <para>Copyright (C) 2010-2013 Canonical Ltd.; Copyright (C) 2010-2011 Robert Ancell.</para> 421 <para> 422 &product-name; contains portions of liblightdm-gobject which 423 is governed by the license in 424 <xref linkend="licLGPL" xrefstyle="template: %n" /> and 425 </para> 426 427 <para> 428 Copyright (C) 2010-2013 Canonical Ltd.; Copyright (C) 429 2010-2011 Robert Ancell. 430 </para> 280 431 </listitem> 281 432 282 433 <listitem> 283 <para>VirtualBox contains portions of glib which is governed by the 284 license in <xref linkend="licLGPL" xrefstyle="template: %n" /> and</para> 285 286 <para>Copyright (C) 1995-2011 The Glib team</para> 434 <para> 435 &product-name; contains portions of glib which is governed by 436 the license in 437 <xref linkend="licLGPL" xrefstyle="template: %n" /> and 438 </para> 439 440 <para> 441 Copyright (C) 1995-2011 The Glib team 442 </para> 287 443 </listitem> 288 444 289 445 <listitem> 290 <para>VirtualBox contains portions of PCRE which is governed by the 291 license in <xref linkend="licPcre" xrefstyle="template: %n" /> and</para> 292 <para>Copyright (c) 1997-2012 University of Cambridge; 293 Copyright(c) 2009-2012 Zoltan Herczeg; 294 Copyright (c) 2007-2012, Google Inc. 446 <para> 447 &product-name; contains portions of PCRE which is governed by 448 the license in 449 <xref linkend="licPcre" xrefstyle="template: %n" /> and 450 </para> 451 452 <para> 453 Copyright (c) 1997-2012 University of Cambridge; Copyright(c) 454 2009-2012 Zoltan Herczeg; Copyright (c) 2007-2012, Google Inc. 295 455 </para> 296 456 </listitem> 297 457 298 458 <listitem> 299 <para>VirtualBox contains portions of libffi which is governed by the 300 license in <xref linkend="licLibffi" xrefstyle="template: %n" /> and</para> 301 <para> 302 Copyright (c) 1996-2012 Anthony Green, Red Hat, Inc and others. 303 See source files for details. 459 <para> 460 &product-name; contains portions of libffi which is governed 461 by the license in 462 <xref linkend="licLibffi" xrefstyle="template: %n" /> and 463 </para> 464 465 <para> 466 Copyright (c) 1996-2012 Anthony Green, Red Hat, Inc and 467 others. See source files for details. 304 468 </para> 305 469 </listitem> 306 470 307 471 <listitem> 308 <para>VirtualBox contains portions of FLTK which is governed by the 309 licenses in <xref linkend="licFltk" xrefstyle="template: %n" /> and 310 <xref linkend="licLGPL" xrefstyle="template: %n"/> and </para> 311 <para> 312 Copyright (C) 1991-2012 The FLTK team 472 <para> 473 &product-name; contains portions of FLTK which is governed by 474 the licenses in 475 <xref linkend="licFltk" xrefstyle="template: %n" /> and 476 <xref linkend="licLGPL" xrefstyle="template: %n"/> and 477 </para> 478 479 <para> 480 Copyright (C) 1991-2012 The FLTK team 313 481 </para> 314 482 </listitem> 315 483 316 484 <listitem> 317 <para>VirtualBox contains portions of Expat which is governed by the 318 license in <xref linkend="licExpat" xrefstyle="template: %n" /> and</para> 319 <para> 320 Copyright (c) 1998, 1999, 2000 Thai Open Source Software Center Ltd 321 and Clark Cooper; Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006 Expat 322 maintainers. 485 <para> 486 &product-name; contains portions of Expat which is governed by 487 the license in 488 <xref linkend="licExpat" xrefstyle="template: %n" /> and 489 </para> 490 491 <para> 492 Copyright (c) 1998, 1999, 2000 Thai Open Source Software 493 Center Ltd and Clark Cooper; Copyright (c) 2001, 2002, 2003, 494 2004, 2005, 2006 Expat maintainers. 323 495 </para> 324 496 </listitem> 325 497 326 498 <listitem> 327 <para>VirtualBox contains portions of Fontconfig which is governed by the 328 license in <xref linkend="licFontconfig" xrefstyle="template: %n" /> 329 and</para> 499 <para> 500 &product-name; contains portions of Fontconfig which is 501 governed by the license in 502 <xref linkend="licFontconfig" xrefstyle="template: %n" /> and 503 </para> 504 330 505 <para> 331 506 Copyright (C) 2001, 2003 Keith Packard … … 334 509 335 510 <listitem> 336 <para>VirtualBox contains portions of Freetype which is governed by the 337 license in <xref linkend="licFreetype" xrefstyle="template: %n" /> 338 and</para> 339 <para> 340 Copyright 2012 The FreeType Project (www.freetype.org). All rights reserved. 511 <para> 512 &product-name; contains portions of Freetype which is governed 513 by the license in 514 <xref linkend="licFreetype" xrefstyle="template: %n" /> and 515 </para> 516 517 <para> 518 Copyright 2012 The FreeType Project (www.freetype.org). All 519 rights reserved. 341 520 </para> 342 521 </listitem> 343 522 344 523 <listitem> 345 <para>VirtualBox may contain code from the WebM VP8 Codec SDK which 346 is governed by the license in <xref linkend="licVPX" xrefstyle="template: %n" /> 347 and </para> 348 <para> 349 Copyright (c) 2010, The WebM Project authors. All rights reserved. 524 <para> 525 &product-name; may contain code from the WebM VP8 Codec SDK 526 which is governed by the license in 527 <xref linkend="licVPX" xrefstyle="template: %n" /> and 528 </para> 529 530 <para> 531 Copyright (c) 2010, The WebM Project authors. All rights 532 reserved. 350 533 </para> 351 534 </listitem> 352 535 353 536 <listitem> 354 <para>VirtualBox may contain code from libopus ("Opus") which 355 is governed by the license in <xref linkend="licOpus" xrefstyle="template: %n" /> 356 and </para> 537 <para> 538 &product-name; may contain code from libopus ("Opus") which is 539 governed by the license in 540 <xref linkend="licOpus" xrefstyle="template: %n" /> and 541 </para> 542 357 543 <para> 358 544 Copyright 2001-2011 Xiph.Org, Skype Limited, Octasic, 359 Jean-Marc Valin, Timothy B. Terriberry, 360 CSIRO, Gregory Maxwell, Mark Borgerding, 361 Erik de Castro Lopo 545 Jean-Marc Valin, Timothy B. Terriberry, CSIRO, Gregory 546 Maxwell, Mark Borgerding, Erik de Castro Lopo 362 547 </para> 363 548 </listitem> 364 549 365 550 </itemizedlist> 551 366 552 </sect1> 367 553 368 554 <sect1 id="third-party-licenses"> 555 369 556 <title>Third-Party Licenses</title> 370 557 371 558 <sect2 id="licGPL"> 559 372 560 <title>GNU General Public License (GPL)</title> 373 561 374 <para>GNU GENERAL PUBLIC LICENSE Version 2, June 1991</para> 375 376 <para>Copyright (C) 1989, 1991 Free Software Foundation, Inc.</para> 377 378 <para>51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA</para> 379 380 <para>Everyone is permitted to copy and distribute verbatim copies of 381 this license document, but changing it is not allowed.</para> 382 383 <para>Preamble</para> 384 385 <para>The licenses for most software are designed to take away your 386 freedom to share and change it. By contrast, the GNU General Public 387 License is intended to guarantee your freedom to share and change free 388 software--to make sure the software is free for all its users. This 389 General Public License applies to most of the Free Software Foundation's 390 software and to any other program whose authors commit to using it. 391 (Some other Free Software Foundation software is covered by the GNU 392 Library General Public License instead.) You can apply it to your 393 programs, too.</para> 394 395 <para>When we speak of free software, we are referring to freedom, not 396 price. Our General Public Licenses are designed to make sure that you 397 have the freedom to distribute copies of free software (and charge for 398 this service if you wish), that you receive source code or can get it if 399 you want it, that you can change the software or use pieces of it in new 400 free programs; and that you know you can do these things.</para> 401 402 <para>To protect your rights, we need to make restrictions that forbid 403 anyone to deny you these rights or to ask you to surrender the rights. 404 These restrictions translate to certain responsibilities for you if you 405 distribute copies of the software, or if you modify it.</para> 406 407 <para>For example, if you distribute copies of such a program, whether 408 gratis or for a fee, you must give the recipients all the rights that 409 you have. You must make sure that they, too, receive or can get the 410 source code. And you must show them these terms so they know their 411 rights.</para> 412 413 <para>We protect your rights with two steps: (1) copyright the software, 414 and (2) offer you this license which gives you legal permission to copy, 415 distribute and/or modify the software.</para> 416 417 <para>Also, for each author's protection and ours, we want to make 418 certain that everyone understands that there is no warranty for this 419 free software. If the software is modified by someone else and passed 420 on, we want its recipients to know that what they have is not the 421 original, so that any problems introduced by others will not reflect on 422 the original authors' reputations.</para> 423 424 <para>Finally, any free program is threatened constantly by software 425 patents. We wish to avoid the danger that redistributors of a free 426 program will individually obtain patent licenses, in effect making the 427 program proprietary. To prevent this, we have made it clear that any 428 patent must be licensed for everyone's free use or not licensed at 429 all.</para> 430 431 <para>The precise terms and conditions for copying, distribution and 432 modification follow.</para> 433 434 <para>GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, 435 DISTRIBUTION AND MODIFICATION</para> 436 437 <para>0. This License applies to any program or other work which 438 contains a notice placed by the copyright holder saying it may be 439 distributed under the terms of this General Public License. The 440 "Program", below, refers to any such program or work, and a "work based 441 on the Program" means either the Program or any derivative work under 442 copyright law: that is to say, a work containing the Program or a 443 portion of it, either verbatim or with modifications and/or translated 444 into another language. (Hereinafter, translation is included without 445 limitation in the term "modification".) Each licensee is addressed as 446 "you".</para> 447 448 <para>Activities other than copying, distribution and modification are 449 not covered by this License; they are outside its scope. The act of 450 running the Program is not restricted, and the output from the Program 451 is covered only if its contents constitute a work based on the Program 452 (independent of having been made by running the Program). Whether that 453 is true depends on what the Program does.</para> 454 455 <para>1. You may copy and distribute verbatim copies of the Program's 456 source code as you receive it, in any medium, provided that you 457 conspicuously and appropriately publish on each copy an appropriate 458 copyright notice and disclaimer of warranty; keep intact all the notices 459 that refer to this License and to the absence of any warranty; and give 460 any other recipients of the Program a copy of this License along with 461 the Program.</para> 462 463 <para>You may charge a fee for the physical act of transferring a copy, 464 and you may at your option offer warranty protection in exchange for a 465 fee.</para> 466 467 <para>2. You may modify your copy or copies of the Program or any 468 portion of it, thus forming a work based on the Program, and copy and 469 distribute such modifications or work under the terms of Section 1 470 above, provided that you also meet all of these conditions:</para> 471 472 <para>a) You must cause the modified files to carry prominent notices 473 stating that you changed the files and the date of any change.</para> 474 475 <para>b) You must cause any work that you distribute or publish, that in 476 whole or in part contains or is derived from the Program or any part 477 thereof, to be licensed as a whole at no charge to all third parties 478 under the terms of this License.</para> 479 480 <para>c) If the modified program normally reads commands interactively 481 when run, you must cause it, when started running for such interactive 482 use in the most ordinary way, to print or display an announcement 483 including an appropriate copyright notice and a notice that there is no 484 warranty (or else, saying that you provide a warranty) and that users 485 may redistribute the program under these conditions, and telling the 486 user how to view a copy of this License. (Exception: if the Program 487 itself is interactive but does not normally print such an announcement, 488 your work based on the Program is not required to print an 489 announcement.)</para> 490 491 <para>These requirements apply to the modified work as a whole. If 492 identifiable sections of that work are not derived from the Program, and 493 can be reasonably considered independent and separate works in 494 themselves, then this License, and its terms, do not apply to those 495 sections when you distribute them as separate works. But when you 496 distribute the same sections as part of a whole which is a work based on 497 the Program, the distribution of the whole must be on the terms of this 498 License, whose permissions for other licensees extend to the entire 499 whole, and thus to each and every part regardless of who wrote 500 it.</para> 501 502 <para>Thus, it is not the intent of this section to claim rights or 503 contest your rights to work written entirely by you; rather, the intent 504 is to exercise the right to control the distribution of derivative or 505 collective works based on the Program.</para> 506 507 <para>In addition, mere aggregation of another work not based on the 508 Program with the Program (or with a work based on the Program) on a 509 volume of a storage or distribution medium does not bring the other work 510 under the scope of this License.</para> 511 512 <para>3. You may copy and distribute the Program (or a work based on it, 513 under Section 2) in object code or executable form under the terms of 514 Sections 1 and 2 above provided that you also do one of the 515 following:</para> 516 517 <para>a) Accompany it with the complete corresponding machine-readable 518 source code, which must be distributed under the terms of Sections 1 and 519 2 above on a medium customarily used for software interchange; 520 or,</para> 521 522 <para>b) Accompany it with a written offer, valid for at least three 523 years, to give any third party, for a charge no more than your cost of 524 physically performing source distribution, a complete machine-readable 525 copy of the corresponding source code, to be distributed under the terms 526 of Sections 1 and 2 above on a medium customarily used for software 527 interchange; or,</para> 528 529 <para>c) Accompany it with the information you received as to the offer 530 to distribute corresponding source code. (This alternative is allowed 531 only for noncommercial distribution and only if you received the program 532 in object code or executable form with such an offer, in accord with 533 Subsection b above.)</para> 534 535 <para>The source code for a work means the preferred form of the work 536 for making modifications to it. For an executable work, complete source 537 code means all the source code for all modules it contains, plus any 538 associated interface definition files, plus the scripts used to control 539 compilation and installation of the executable. However, as a special 540 exception, the source code distributed need not include anything that is 541 normally distributed (in either source or binary form) with the major 542 components (compiler, kernel, and so on) of the operating system on 543 which the executable runs, unless that component itself accompanies the 544 executable.</para> 545 546 <para>If distribution of executable or object code is made by offering 547 access to copy from a designated place, then offering equivalent access 548 to copy the source code from the same place counts as distribution of 549 the source code, even though third parties are not compelled to copy the 550 source along with the object code.</para> 551 552 <para>4. You may not copy, modify, sublicense, or distribute the Program 553 except as expressly provided under this License. Any attempt otherwise 554 to copy, modify, sublicense or distribute the Program is void, and will 555 automatically terminate your rights under this License. However, parties 556 who have received copies, or rights, from you under this License will 557 not have their licenses terminated so long as such parties remain in 558 full compliance.</para> 559 560 <para>5. You are not required to accept this License, since you have not 561 signed it. However, nothing else grants you permission to modify or 562 distribute the Program or its derivative works. These actions are 563 prohibited by law if you do not accept this License. Therefore, by 564 modifying or distributing the Program (or any work based on the 565 Program), you indicate your acceptance of this License to do so, and all 566 its terms and conditions for copying, distributing or modifying the 567 Program or works based on it.</para> 568 569 <para>6. Each time you redistribute the Program (or any work based on 570 the Program), the recipient automatically receives a license from the 571 original licensor to copy, distribute or modify the Program subject to 572 these terms and conditions. You may not impose any further restrictions 573 on the recipients' exercise of the rights granted herein. You are not 574 responsible for enforcing compliance by third parties to this 575 License.</para> 576 577 <para>7. If, as a consequence of a court judgment or allegation of 578 patent infringement or for any other reason (not limited to patent 579 issues), conditions are imposed on you (whether by court order, 580 agreement or otherwise) that contradict the conditions of this License, 581 they do not excuse you from the conditions of this License. If you 582 cannot distribute so as to satisfy simultaneously your obligations under 583 this License and any other pertinent obligations, then as a consequence 584 you may not distribute the Program at all. For example, if a patent 585 license would not permit royalty-free redistribution of the Program by 586 all those who receive copies directly or indirectly through you, then 587 the only way you could satisfy both it and this License would be to 588 refrain entirely from distribution of the Program.</para> 589 590 <para>If any portion of this section is held invalid or unenforceable 591 under any particular circumstance, the balance of the section is 592 intended to apply and the section as a whole is intended to apply in 593 other circumstances.</para> 594 595 <para>It is not the purpose of this section to induce you to infringe 596 any patents or other property right claims or to contest validity of any 597 such claims; this section has the sole purpose of protecting the 598 integrity of the free software distribution system, which is implemented 599 by public license practices. Many people have made generous 600 contributions to the wide range of software distributed through that 601 system in reliance on consistent application of that system; it is up to 602 the author/donor to decide if he or she is willing to distribute 603 software through any other system and a licensee cannot impose that 604 choice.</para> 605 606 <para>This section is intended to make thoroughly clear what is believed 607 to be a consequence of the rest of this License.</para> 608 609 <para>8. If the distribution and/or use of the Program is restricted in 610 certain countries either by patents or by copyrighted interfaces, the 611 original copyright holder who places the Program under this License may 612 add an explicit geographical distribution limitation excluding those 613 countries, so that distribution is permitted only in or among countries 614 not thus excluded. In such case, this License incorporates the 615 limitation as if written in the body of this License.</para> 616 617 <para>9. The Free Software Foundation may publish revised and/or new 618 versions of the General Public License from time to time. Such new 619 versions will be similar in spirit to the present version, but may 620 differ in detail to address new problems or concerns.</para> 621 622 <para>Each version is given a distinguishing version number. If the 623 Program specifies a version number of this License which applies to it 624 and "any later version", you have the option of following the terms and 625 conditions either of that version or of any later version published by 626 the Free Software Foundation. If the Program does not specify a version 627 number of this License, you may choose any version ever published by the 628 Free Software Foundation.</para> 629 630 <para>10. If you wish to incorporate parts of the Program into other 631 free programs whose distribution conditions are different, write to the 632 author to ask for permission. For software which is copyrighted by the 633 Free Software Foundation, write to the Free Software Foundation; we 634 sometimes make exceptions for this. Our decision will be guided by the 635 two goals of preserving the free status of all derivatives of our free 636 software and of promoting the sharing and reuse of software 637 generally.</para> 638 639 <para>NO WARRANTY</para> 640 641 <para>11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO 642 WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 643 EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR 644 OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, 645 EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 646 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE 647 ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH 648 YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL 649 NECESSARY SERVICING, REPAIR OR CORRECTION.</para> 650 651 <para>12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN 652 WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY 653 AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR 654 DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL 655 DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM 656 (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED 657 INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF 658 THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR 659 OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.</para> 660 661 <para>END OF TERMS AND CONDITIONS</para> 562 <para> 563 GNU GENERAL PUBLIC LICENSE Version 2, June 1991 564 </para> 565 566 <para> 567 Copyright (C) 1989, 1991 Free Software Foundation, Inc. 568 </para> 569 570 <para> 571 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 572 </para> 573 574 <para> 575 Everyone is permitted to copy and distribute verbatim copies of 576 this license document, but changing it is not allowed. 577 </para> 578 579 <para> 580 Preamble 581 </para> 582 583 <para> 584 The licenses for most software are designed to take away your 585 freedom to share and change it. By contrast, the GNU General 586 Public License is intended to guarantee your freedom to share 587 and change free software--to make sure the software is free for 588 all its users. This General Public License applies to most of 589 the Free Software Foundation's software and to any other program 590 whose authors commit to using it. (Some other Free Software 591 Foundation software is covered by the GNU Library General Public 592 License instead.) You can apply it to your programs, too. 593 </para> 594 595 <para> 596 When we speak of free software, we are referring to freedom, not 597 price. Our General Public Licenses are designed to make sure 598 that you have the freedom to distribute copies of free software 599 (and charge for this service if you wish), that you receive 600 source code or can get it if you want it, that you can change 601 the software or use pieces of it in new free programs; and that 602 you know you can do these things. 603 </para> 604 605 <para> 606 To protect your rights, we need to make restrictions that forbid 607 anyone to deny you these rights or to ask you to surrender the 608 rights. These restrictions translate to certain responsibilities 609 for you if you distribute copies of the software, or if you 610 modify it. 611 </para> 612 613 <para> 614 For example, if you distribute copies of such a program, whether 615 gratis or for a fee, you must give the recipients all the rights 616 that you have. You must make sure that they, too, receive or can 617 get the source code. And you must show them these terms so they 618 know their rights. 619 </para> 620 621 <para> 622 We protect your rights with two steps: (1) copyright the 623 software, and (2) offer you this license which gives you legal 624 permission to copy, distribute and/or modify the software. 625 </para> 626 627 <para> 628 Also, for each author's protection and ours, we want to make 629 certain that everyone understands that there is no warranty for 630 this free software. If the software is modified by someone else 631 and passed on, we want its recipients to know that what they 632 have is not the original, so that any problems introduced by 633 others will not reflect on the original authors' reputations. 634 </para> 635 636 <para> 637 Finally, any free program is threatened constantly by software 638 patents. We wish to avoid the danger that redistributors of a 639 free program will individually obtain patent licenses, in effect 640 making the program proprietary. To prevent this, we have made it 641 clear that any patent must be licensed for everyone's free use 642 or not licensed at all. 643 </para> 644 645 <para> 646 The precise terms and conditions for copying, distribution and 647 modification follow. 648 </para> 649 650 <para> 651 GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, 652 DISTRIBUTION AND MODIFICATION 653 </para> 654 655 <para> 656 0. This License applies to any program or other work which 657 contains a notice placed by the copyright holder saying it may 658 be distributed under the terms of this General Public License. 659 The "Program", below, refers to any such program or work, and a 660 "work based on the Program" means either the Program or any 661 derivative work under copyright law: that is to say, a work 662 containing the Program or a portion of it, either verbatim or 663 with modifications and/or translated into another language. 664 (Hereinafter, translation is included without limitation in the 665 term "modification".) Each licensee is addressed as "you". 666 </para> 667 668 <para> 669 Activities other than copying, distribution and modification are 670 not covered by this License; they are outside its scope. The act 671 of running the Program is not restricted, and the output from 672 the Program is covered only if its contents constitute a work 673 based on the Program (independent of having been made by running 674 the Program). Whether that is true depends on what the Program 675 does. 676 </para> 677 678 <para> 679 1. You may copy and distribute verbatim copies of the Program's 680 source code as you receive it, in any medium, provided that you 681 conspicuously and appropriately publish on each copy an 682 appropriate copyright notice and disclaimer of warranty; keep 683 intact all the notices that refer to this License and to the 684 absence of any warranty; and give any other recipients of the 685 Program a copy of this License along with the Program. 686 </para> 687 688 <para> 689 You may charge a fee for the physical act of transferring a 690 copy, and you may at your option offer warranty protection in 691 exchange for a fee. 692 </para> 693 694 <para> 695 2. You may modify your copy or copies of the Program or any 696 portion of it, thus forming a work based on the Program, and 697 copy and distribute such modifications or work under the terms 698 of Section 1 above, provided that you also meet all of these 699 conditions: 700 </para> 701 702 <para> 703 a) You must cause the modified files to carry prominent notices 704 stating that you changed the files and the date of any change. 705 </para> 706 707 <para> 708 b) You must cause any work that you distribute or publish, that 709 in whole or in part contains or is derived from the Program or 710 any part thereof, to be licensed as a whole at no charge to all 711 third parties under the terms of this License. 712 </para> 713 714 <para> 715 c) If the modified program normally reads commands interactively 716 when run, you must cause it, when started running for such 717 interactive use in the most ordinary way, to print or display an 718 announcement including an appropriate copyright notice and a 719 notice that there is no warranty (or else, saying that you 720 provide a warranty) and that users may redistribute the program 721 under these conditions, and telling the user how to view a copy 722 of this License. (Exception: if the Program itself is 723 interactive but does not normally print such an announcement, 724 your work based on the Program is not required to print an 725 announcement.) 726 </para> 727 728 <para> 729 These requirements apply to the modified work as a whole. If 730 identifiable sections of that work are not derived from the 731 Program, and can be reasonably considered independent and 732 separate works in themselves, then this License, and its terms, 733 do not apply to those sections when you distribute them as 734 separate works. But when you distribute the same sections as 735 part of a whole which is a work based on the Program, the 736 distribution of the whole must be on the terms of this License, 737 whose permissions for other licensees extend to the entire 738 whole, and thus to each and every part regardless of who wrote 739 it. 740 </para> 741 742 <para> 743 Thus, it is not the intent of this section to claim rights or 744 contest your rights to work written entirely by you; rather, the 745 intent is to exercise the right to control the distribution of 746 derivative or collective works based on the Program. 747 </para> 748 749 <para> 750 In addition, mere aggregation of another work not based on the 751 Program with the Program (or with a work based on the Program) 752 on a volume of a storage or distribution medium does not bring 753 the other work under the scope of this License. 754 </para> 755 756 <para> 757 3. You may copy and distribute the Program (or a work based on 758 it, under Section 2) in object code or executable form under the 759 terms of Sections 1 and 2 above provided that you also do one of 760 the following: 761 </para> 762 763 <para> 764 a) Accompany it with the complete corresponding machine-readable 765 source code, which must be distributed under the terms of 766 Sections 1 and 2 above on a medium customarily used for software 767 interchange; or, 768 </para> 769 770 <para> 771 b) Accompany it with a written offer, valid for at least three 772 years, to give any third party, for a charge no more than your 773 cost of physically performing source distribution, a complete 774 machine-readable copy of the corresponding source code, to be 775 distributed under the terms of Sections 1 and 2 above on a 776 medium customarily used for software interchange; or, 777 </para> 778 779 <para> 780 c) Accompany it with the information you received as to the 781 offer to distribute corresponding source code. (This alternative 782 is allowed only for noncommercial distribution and only if you 783 received the program in object code or executable form with such 784 an offer, in accord with Subsection b above.) 785 </para> 786 787 <para> 788 The source code for a work means the preferred form of the work 789 for making modifications to it. For an executable work, complete 790 source code means all the source code for all modules it 791 contains, plus any associated interface definition files, plus 792 the scripts used to control compilation and installation of the 793 executable. However, as a special exception, the source code 794 distributed need not include anything that is normally 795 distributed (in either source or binary form) with the major 796 components (compiler, kernel, and so on) of the operating system 797 on which the executable runs, unless that component itself 798 accompanies the executable. 799 </para> 800 801 <para> 802 If distribution of executable or object code is made by offering 803 access to copy from a designated place, then offering equivalent 804 access to copy the source code from the same place counts as 805 distribution of the source code, even though third parties are 806 not compelled to copy the source along with the object code. 807 </para> 808 809 <para> 810 4. You may not copy, modify, sublicense, or distribute the 811 Program except as expressly provided under this License. Any 812 attempt otherwise to copy, modify, sublicense or distribute the 813 Program is void, and will automatically terminate your rights 814 under this License. However, parties who have received copies, 815 or rights, from you under this License will not have their 816 licenses terminated so long as such parties remain in full 817 compliance. 818 </para> 819 820 <para> 821 5. You are not required to accept this License, since you have 822 not signed it. However, nothing else grants you permission to 823 modify or distribute the Program or its derivative works. These 824 actions are prohibited by law if you do not accept this License. 825 Therefore, by modifying or distributing the Program (or any work 826 based on the Program), you indicate your acceptance of this 827 License to do so, and all its terms and conditions for copying, 828 distributing or modifying the Program or works based on it. 829 </para> 830 831 <para> 832 6. Each time you redistribute the Program (or any work based on 833 the Program), the recipient automatically receives a license 834 from the original licensor to copy, distribute or modify the 835 Program subject to these terms and conditions. You may not 836 impose any further restrictions on the recipients' exercise of 837 the rights granted herein. You are not responsible for enforcing 838 compliance by third parties to this License. 839 </para> 840 841 <para> 842 7. If, as a consequence of a court judgment or allegation of 843 patent infringement or for any other reason (not limited to 844 patent issues), conditions are imposed on you (whether by court 845 order, agreement or otherwise) that contradict the conditions of 846 this License, they do not excuse you from the conditions of this 847 License. If you cannot distribute so as to satisfy 848 simultaneously your obligations under this License and any other 849 pertinent obligations, then as a consequence you may not 850 distribute the Program at all. For example, if a patent license 851 would not permit royalty-free redistribution of the Program by 852 all those who receive copies directly or indirectly through you, 853 then the only way you could satisfy both it and this License 854 would be to refrain entirely from distribution of the Program. 855 </para> 856 857 <para> 858 If any portion of this section is held invalid or unenforceable 859 under any particular circumstance, the balance of the section is 860 intended to apply and the section as a whole is intended to 861 apply in other circumstances. 862 </para> 863 864 <para> 865 It is not the purpose of this section to induce you to infringe 866 any patents or other property right claims or to contest 867 validity of any such claims; this section has the sole purpose 868 of protecting the integrity of the free software distribution 869 system, which is implemented by public license practices. Many 870 people have made generous contributions to the wide range of 871 software distributed through that system in reliance on 872 consistent application of that system; it is up to the 873 author/donor to decide if he or she is willing to distribute 874 software through any other system and a licensee cannot impose 875 that choice. 876 </para> 877 878 <para> 879 This section is intended to make thoroughly clear what is 880 believed to be a consequence of the rest of this License. 881 </para> 882 883 <para> 884 8. If the distribution and/or use of the Program is restricted 885 in certain countries either by patents or by copyrighted 886 interfaces, the original copyright holder who places the Program 887 under this License may add an explicit geographical distribution 888 limitation excluding those countries, so that distribution is 889 permitted only in or among countries not thus excluded. In such 890 case, this License incorporates the limitation as if written in 891 the body of this License. 892 </para> 893 894 <para> 895 9. The Free Software Foundation may publish revised and/or new 896 versions of the General Public License from time to time. Such 897 new versions will be similar in spirit to the present version, 898 but may differ in detail to address new problems or concerns. 899 </para> 900 901 <para> 902 Each version is given a distinguishing version number. If the 903 Program specifies a version number of this License which applies 904 to it and "any later version", you have the option of following 905 the terms and conditions either of that version or of any later 906 version published by the Free Software Foundation. If the 907 Program does not specify a version number of this License, you 908 may choose any version ever published by the Free Software 909 Foundation. 910 </para> 911 912 <para> 913 10. If you wish to incorporate parts of the Program into other 914 free programs whose distribution conditions are different, write 915 to the author to ask for permission. For software which is 916 copyrighted by the Free Software Foundation, write to the Free 917 Software Foundation; we sometimes make exceptions for this. Our 918 decision will be guided by the two goals of preserving the free 919 status of all derivatives of our free software and of promoting 920 the sharing and reuse of software generally. 921 </para> 922 923 <para> 924 NO WARRANTY 925 </para> 926 927 <para> 928 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO 929 WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE 930 LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 931 HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT 932 WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, 933 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY 934 AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE 935 QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 936 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY 937 SERVICING, REPAIR OR CORRECTION. 938 </para> 939 940 <para> 941 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO 942 IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY 943 MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE 944 LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, 945 INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR 946 INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS 947 OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 948 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH 949 ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN 950 ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 951 </para> 952 953 <para> 954 END OF TERMS AND CONDITIONS 955 </para> 956 662 957 </sect2> 663 958 664 959 <sect2 id="licLGPL"> 960 665 961 <title>GNU Lesser General Public License (LGPL)</title> 666 962 667 <para>GNU LESSER GENERAL PUBLIC LICENSE Version 2.1, February 668 1999</para> 669 670 <para>Copyright (C) 1991, 1999 Free Software Foundation, Inc. 59 Temple 671 Place, Suite 330, Boston, MA 02111-1307 USA Everyone is permitted to 672 copy and distribute verbatim copies of this license document, but 673 changing it is not allowed.</para> 674 675 <para>[This is the first released version of the Lesser GPL. It also 676 counts as the successor of the GNU Library Public License, version 2, 677 hence the version number 2.1.]</para> 678 679 <para>Preamble</para> 680 681 <para>The licenses for most software are designed to take away your 682 freedom to share and change it. By contrast, the GNU General Public 683 Licenses are intended to guarantee your freedom to share and change free 684 software--to make sure the software is free for all its users.</para> 685 686 <para>This license, the Lesser General Public License, applies to some 687 specially designated software packages--typically libraries--of the Free 688 Software Foundation and other authors who decide to use it. You can use 689 it too, but we suggest you first think carefully about whether this 690 license or the ordinary General Public License is the better strategy to 691 use in any particular case, based on the explanations below.</para> 692 693 <para>When we speak of free software, we are referring to freedom of 694 use, not price. Our General Public Licenses are designed to make sure 695 that you have the freedom to distribute copies of free software (and 696 charge for this service if you wish); that you receive source code or 697 can get it if you want it; that you can change the software and use 698 pieces of it in new free programs; and that you are informed that you 699 can do these things.</para> 700 701 <para>To protect your rights, we need to make restrictions that forbid 702 distributors to deny you these rights or to ask you to surrender these 703 rights. These restrictions translate to certain responsibilities for you 704 if you distribute copies of the library or if you modify it.</para> 705 706 <para>For example, if you distribute copies of the library, whether 707 gratis or for a fee, you must give the recipients all the rights that we 708 gave you. You must make sure that they, too, receive or can get the 709 source code. If you link other code with the library, you must provide 710 complete object files to the recipients, so that they can relink them 711 with the library after making changes to the library and recompiling it. 712 And you must show them these terms so they know their rights.</para> 713 714 <para>We protect your rights with a two-step method: (1) we copyright 715 the library, and (2) we offer you this license, which gives you legal 716 permission to copy, distribute and/or modify the library.</para> 717 718 <para>To protect each distributor, we want to make it very clear that 719 there is no warranty for the free library. Also, if the library is 720 modified by someone else and passed on, the recipients should know that 721 what they have is not the original version, so that the original 722 author's reputation will not be affected by problems that might be 723 introduced by others.</para> 724 725 <para>Finally, software patents pose a constant threat to the existence 726 of any free program. We wish to make sure that a company cannot 727 effectively restrict the users of a free program by obtaining a 728 restrictive license from a patent holder. Therefore, we insist that any 729 patent license obtained for a version of the library must be consistent 730 with the full freedom of use specified in this license.</para> 731 732 <para>Most GNU software, including some libraries, is covered by the 733 ordinary GNU General Public License. This license, the GNU Lesser 734 General Public License, applies to certain designated libraries, and is 735 quite different from the ordinary General Public License. We use this 736 license for certain libraries in order to permit linking those libraries 737 into non-free programs.</para> 738 739 <para>When a program is linked with a library, whether statically or 740 using a shared library, the combination of the two is legally speaking a 741 combined work, a derivative of the original library. The ordinary 742 General Public License therefore permits such linking only if the entire 743 combination fits its criteria of freedom. The Lesser General Public 744 License permits more lax criteria for linking other code with the 745 library.</para> 746 747 <para>We call this license the "Lesser" General Public License because 748 it does Less to protect the user's freedom than the ordinary General 749 Public License. It also provides other free software developers Less of 750 an advantage over competing non-free programs. These disadvantages are 751 the reason we use the ordinary General Public License for many 752 libraries. However, the Lesser license provides advantages in certain 753 special circumstances.</para> 754 755 <para>For example, on rare occasions, there may be a special need to 756 encourage the widest possible use of a certain library, so that it 757 becomes a de-facto standard. To achieve this, non-free programs must be 758 allowed to use the library. A more frequent case is that a free library 759 does the same job as widely used non-free libraries. In this case, there 760 is little to gain by limiting the free library to free software only, so 761 we use the Lesser General Public License.</para> 762 763 <para>In other cases, permission to use a particular library in non-free 764 programs enables a greater number of people to use a large body of free 765 software. For example, permission to use the GNU C Library in non-free 766 programs enables many more people to use the whole GNU operating system, 767 as well as its variant, the GNU/Linux operating system.</para> 768 769 <para>Although the Lesser General Public License is Less protective of 770 the users' freedom, it does ensure that the user of a program that is 771 linked with the Library has the freedom and the wherewithal to run that 772 program using a modified version of the Library.</para> 773 774 <para>The precise terms and conditions for copying, distribution and 775 modification follow. Pay close attention to the difference between a 776 "work based on the library" and a "work that uses the library". The 777 former contains code derived from the library, whereas the latter must 778 be combined with the library in order to run.</para> 779 780 <para>GNU LESSER GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR 781 COPYING, DISTRIBUTION AND MODIFICATION</para> 782 783 <para>0. This License Agreement applies to any software library or other 784 program which contains a notice placed by the copyright holder or other 785 authorized party saying it may be distributed under the terms of this 786 Lesser General Public License (also called "this License"). Each 787 licensee is addressed as "you".</para> 788 789 <para>A "library" means a collection of software functions and/or data 790 prepared so as to be conveniently linked with application programs 791 (which use some of those functions and data) to form executables.</para> 792 793 <para>The "Library", below, refers to any such software library or work 794 which has been distributed under these terms. A "work based on the 795 Library" means either the Library or any derivative work under copyright 796 law: that is to say, a work containing the Library or a portion of it, 797 either verbatim or with modifications and/or translated 798 straightforwardly into another language. (Hereinafter, translation is 799 included without limitation in the term "modification".)</para> 800 801 <para>"Source code" for a work means the preferred form of the work for 802 making modifications to it. For a library, complete source code means 803 all the source code for all modules it contains, plus any associated 804 interface definition files, plus the scripts used to control compilation 805 and installation of the library.</para> 806 807 <para>Activities other than copying, distribution and modification are 808 not covered by this License; they are outside its scope. The act of 809 running a program using the Library is not restricted, and output from 810 such a program is covered only if its contents constitute a work based 811 on the Library (independent of the use of the Library in a tool for 812 writing it). Whether that is true depends on what the Library does and 813 what the program that uses the Library does.</para> 814 815 <para>1. You may copy and distribute verbatim copies of the Library's 816 complete source code as you receive it, in any medium, provided that you 817 conspicuously and appropriately publish on each copy an appropriate 818 copyright notice and disclaimer of warranty; keep intact all the notices 819 that refer to this License and to the absence of any warranty; and 820 distribute a copy of this License along with the Library.</para> 821 822 <para>You may charge a fee for the physical act of transferring a copy, 823 and you may at your option offer warranty protection in exchange for a 824 fee.</para> 825 826 <para>2. You may modify your copy or copies of the Library or any 827 portion of it, thus forming a work based on the Library, and copy and 828 distribute such modifications or work under the terms of Section 1 829 above, provided that you also meet all of these conditions:</para> 830 831 <para>a) The modified work must itself be a software library.</para> 832 833 <para>b) You must cause the files modified to carry prominent notices 834 stating that you changed the files and the date of any change.</para> 835 836 <para>c) You must cause the whole of the work to be licensed at no 837 charge to all third parties under the terms of this License.</para> 838 839 <para>d) If a facility in the modified Library refers to a function or a 840 table of data to be supplied by an application program that uses the 841 facility, other than as an argument passed when the facility is invoked, 842 then you must make a good faith effort to ensure that, in the event an 843 application does not supply such function or table, the facility still 844 operates, and performs whatever part of its purpose remains 845 meaningful.</para> 846 847 <para>(For example, a function in a library to compute square roots has 848 a purpose that is entirely well-defined independent of the application. 849 Therefore, Subsection 2d requires that any application-supplied function 850 or table used by this function must be optional: if the application does 851 not supply it, the square root function must still compute square 852 roots.)</para> 853 854 <para>These requirements apply to the modified work as a whole. If 855 identifiable sections of that work are not derived from the Library, and 856 can be reasonably considered independent and separate works in 857 themselves, then this License, and its terms, do not apply to those 858 sections when you distribute them as separate works. But when you 859 distribute the same sections as part of a whole which is a work based on 860 the Library, the distribution of the whole must be on the terms of this 861 License, whose permissions for other licensees extend to the entire 862 whole, and thus to each and every part regardless of who wrote 863 it.</para> 864 865 <para>Thus, it is not the intent of this section to claim rights or 866 contest your rights to work written entirely by you; rather, the intent 867 is to exercise the right to control the distribution of derivative or 868 collective works based on the Library.</para> 869 870 <para>In addition, mere aggregation of another work not based on the 871 Library with the Library (or with a work based on the Library) on a 872 volume of a storage or distribution medium does not bring the other work 873 under the scope of this License.</para> 874 875 <para>3. You may opt to apply the terms of the ordinary GNU General 876 Public License instead of this License to a given copy of the Library. 877 To do this, you must alter all the notices that refer to this License, 878 so that they refer to the ordinary GNU General Public License, version 879 2, instead of to this License. (If a newer version than version 2 of the 880 ordinary GNU General Public License has appeared, then you can specify 881 that version instead if you wish.) Do not make any other change in these 882 notices.</para> 883 884 <para>Once this change is made in a given copy, it is irreversible for 885 that copy, so the ordinary GNU General Public License applies to all 886 subsequent copies and derivative works made from that copy.</para> 887 888 <para>This option is useful when you wish to copy part of the code of 889 the Library into a program that is not a library.</para> 890 891 <para>4. You may copy and distribute the Library (or a portion or 892 derivative of it, under Section 2) in object code or executable form 893 under the terms of Sections 1 and 2 above provided that you accompany it 894 with the complete corresponding machine-readable source code, which must 895 be distributed under the terms of Sections 1 and 2 above on a medium 896 customarily used for software interchange.</para> 897 898 <para>If distribution of object code is made by offering access to copy 899 from a designated place, then offering equivalent access to copy the 900 source code from the same place satisfies the requirement to distribute 901 the source code, even though third parties are not compelled to copy the 902 source along with the object code.</para> 903 904 <para>5. A program that contains no derivative of any portion of the 905 Library, but is designed to work with the Library by being compiled or 906 linked with it, is called a "work that uses the Library". Such a work, 907 in isolation, is not a derivative work of the Library, and therefore 908 falls outside the scope of this License.</para> 909 910 <para>However, linking a "work that uses the Library" with the Library 911 creates an executable that is a derivative of the Library (because it 912 contains portions of the Library), rather than a "work that uses the 913 library". The executable is therefore covered by this License. Section 6 914 states terms for distribution of such executables.</para> 915 916 <para>When a "work that uses the Library" uses material from a header 917 file that is part of the Library, the object code for the work may be a 918 derivative work of the Library even though the source code is not. 919 Whether this is true is especially significant if the work can be linked 920 without the Library, or if the work is itself a library. The threshold 921 for this to be true is not precisely defined by law.</para> 922 923 <para>If such an object file uses only numerical parameters, data 924 structure layouts and accessors, and small macros and small inline 925 functions (ten lines or less in length), then the use of the object file 926 is unrestricted, regardless of whether it is legally a derivative work. 927 (Executables containing this object code plus portions of the Library 928 will still fall under Section 6.) Otherwise, if the work is a derivative 929 of the Library, you may distribute the object code for the work under 930 the terms of Section 6. Any executables containing that work also fall 931 under Section 6, whether or not they are linked directly with the 932 Library itself.</para> 933 934 <para>6. As an exception to the Sections above, you may also combine or 935 link a "work that uses the Library" with the Library to produce a work 936 containing portions of the Library, and distribute that work under terms 937 of your choice, provided that the terms permit modification of the work 938 for the customer's own use and reverse engineering for debugging such 939 modifications.</para> 940 941 <para>You must give prominent notice with each copy of the work that the 942 Library is used in it and that the Library and its use are covered by 943 this License. You must supply a copy of this License. If the work during 944 execution displays copyright notices, you must include the copyright 945 notice for the Library among them, as well as a reference directing the 946 user to the copy of this License. Also, you must do one of these 947 things:</para> 948 949 <para>a) Accompany the work with the complete corresponding 950 machine-readable source code for the Library including whatever changes 951 were used in the work (which must be distributed under Sections 1 and 2 952 above); and, if the work is an executable linked with the Library, with 953 the complete machine-readable "work that uses the Library", as object 954 code and/or source code, so that the user can modify the Library and 955 then relink to produce a modified executable containing the modified 956 Library. (It is understood that the user who changes the contents of 957 definitions files in the Library will not necessarily be able to 958 recompile the application to use the modified definitions.)</para> 959 960 <para>b) Use a suitable shared library mechanism for linking with the 961 Library. A suitable mechanism is one that (1) uses at run time a copy of 962 the library already present on the user's computer system, rather than 963 copying library functions into the executable, and (2) will operate 964 properly with a modified version of the library, if the user installs 965 one, as long as the modified version is interface-compatible with the 966 version that the work was made with.</para> 967 968 <para>c) Accompany the work with a written offer, valid for at least 969 three years, to give the same user the materials specified in Subsection 970 6a, above, for a charge no more than the cost of performing this 971 distribution.</para> 972 973 <para>d) If distribution of the work is made by offering access to copy 974 from a designated place, offer equivalent access to copy the above 975 specified materials from the same place.</para> 976 977 <para>e) Verify that the user has already received a copy of these 978 materials or that you have already sent this user a copy.</para> 979 980 <para>For an executable, the required form of the "work that uses the 981 Library" must include any data and utility programs needed for 982 reproducing the executable from it. However, as a special exception, the 983 materials to be distributed need not include anything that is normally 984 distributed (in either source or binary form) with the major components 985 (compiler, kernel, and so on) of the operating system on which the 986 executable runs, unless that component itself accompanies the 987 executable.</para> 988 989 <para>It may happen that this requirement contradicts the license 990 restrictions of other proprietary libraries that do not normally 991 accompany the operating system. Such a contradiction means you cannot 992 use both them and the Library together in an executable that you 993 distribute.</para> 994 995 <para>7. You may place library facilities that are a work based on the 996 Library side-by-side in a single library together with other library 997 facilities not covered by this License, and distribute such a combined 998 library, provided that the separate distribution of the work based on 999 the Library and of the other library facilities is otherwise permitted, 1000 and provided that you do these two things:</para> 1001 1002 <para>a) Accompany the combined library with a copy of the same work 1003 based on the Library, uncombined with any other library facilities. This 1004 must be distributed under the terms of the Sections above.</para> 1005 1006 <para>b) Give prominent notice with the combined library of the fact 1007 that part of it is a work based on the Library, and explaining where to 1008 find the accompanying uncombined form of the same work.</para> 1009 1010 <para>8. You may not copy, modify, sublicense, link with, or distribute 1011 the Library except as expressly provided under this License. Any attempt 1012 otherwise to copy, modify, sublicense, link with, or distribute the 1013 Library is void, and will automatically terminate your rights under this 1014 License. However, parties who have received copies, or rights, from you 1015 under this License will not have their licenses terminated so long as 1016 such parties remain in full compliance.</para> 1017 1018 <para>9. You are not required to accept this License, since you have not 1019 signed it. However, nothing else grants you permission to modify or 1020 distribute the Library or its derivative works. These actions are 1021 prohibited by law if you do not accept this License. Therefore, by 1022 modifying or distributing the Library (or any work based on the 1023 Library), you indicate your acceptance of this License to do so, and all 1024 its terms and conditions for copying, distributing or modifying the 1025 Library or works based on it.</para> 1026 1027 <para>10. Each time you redistribute the Library (or any work based on 1028 the Library), the recipient automatically receives a license from the 1029 original licensor to copy, distribute, link with or modify the Library 1030 subject to these terms and conditions. You may not impose any further 1031 restrictions on the recipients' exercise of the rights granted herein. 1032 You are not responsible for enforcing compliance by third parties with 1033 this License.</para> 1034 1035 <para>11. If, as a consequence of a court judgment or allegation of 1036 patent infringement or for any other reason (not limited to patent 1037 issues), conditions are imposed on you (whether by court order, 1038 agreement or otherwise) that contradict the conditions of this License, 1039 they do not excuse you from the conditions of this License. If you 1040 cannot distribute so as to satisfy simultaneously your obligations under 1041 this License and any other pertinent obligations, then as a consequence 1042 you may not distribute the Library at all. For example, if a patent 1043 license would not permit royalty-free redistribution of the Library by 1044 all those who receive copies directly or indirectly through you, then 1045 the only way you could satisfy both it and this License would be to 1046 refrain entirely from distribution of the Library.</para> 1047 1048 <para>If any portion of this section is held invalid or unenforceable 1049 under any particular circumstance, the balance of the section is 1050 intended to apply, and the section as a whole is intended to apply in 1051 other circumstances.</para> 1052 1053 <para>It is not the purpose of this section to induce you to infringe 1054 any patents or other property right claims or to contest validity of any 1055 such claims; this section has the sole purpose of protecting the 1056 integrity of the free software distribution system which is implemented 1057 by public license practices. Many people have made generous 1058 contributions to the wide range of software distributed through that 1059 system in reliance on consistent application of that system; it is up to 1060 the author/donor to decide if he or she is willing to distribute 1061 software through any other system and a licensee cannot impose that 1062 choice.</para> 1063 1064 <para>This section is intended to make thoroughly clear what is believed 1065 to be a consequence of the rest of this License.</para> 1066 1067 <para>12. If the distribution and/or use of the Library is restricted in 1068 certain countries either by patents or by copyrighted interfaces, the 1069 original copyright holder who places the Library under this License may 1070 add an explicit geographical distribution limitation excluding those 1071 countries, so that distribution is permitted only in or among countries 1072 not thus excluded. In such case, this License incorporates the 1073 limitation as if written in the body of this License.</para> 1074 1075 <para>13. The Free Software Foundation may publish revised and/or new 1076 versions of the Lesser General Public License from time to time. Such 1077 new versions will be similar in spirit to the present version, but may 1078 differ in detail to address new problems or concerns.</para> 1079 1080 <para>Each version is given a distinguishing version number. If the 1081 Library specifies a version number of this License which applies to it 1082 and "any later version", you have the option of following the terms and 1083 conditions either of that version or of any later version published by 1084 the Free Software Foundation. If the Library does not specify a license 1085 version number, you may choose any version ever published by the Free 1086 Software Foundation.</para> 1087 1088 <para>14. If you wish to incorporate parts of the Library into other 1089 free programs whose distribution conditions are incompatible with these, 1090 write to the author to ask for permission. For software which is 1091 copyrighted by the Free Software Foundation, write to the Free Software 1092 Foundation; we sometimes make exceptions for this. Our decision will be 1093 guided by the two goals of preserving the free status of all derivatives 1094 of our free software and of promoting the sharing and reuse of software 1095 generally.</para> 1096 1097 <para>NO WARRANTY</para> 1098 1099 <para>15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO 1100 WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 1101 EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR 1102 OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY KIND, 1103 EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 1104 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE 1105 ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH 1106 YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL 1107 NECESSARY SERVICING, REPAIR OR CORRECTION.</para> 1108 1109 <para>16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN 1110 WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY 1111 AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR 1112 DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL 1113 DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE LIBRARY 1114 (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED 1115 INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF 1116 THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR 1117 OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.</para> 1118 1119 <para>END OF TERMS AND CONDITIONS</para> 963 <para> 964 GNU LESSER GENERAL PUBLIC LICENSE Version 2.1, February 1999 965 </para> 966 967 <para> 968 Copyright (C) 1991, 1999 Free Software Foundation, Inc. 59 969 Temple Place, Suite 330, Boston, MA 02111-1307 USA Everyone is 970 permitted to copy and distribute verbatim copies of this license 971 document, but changing it is not allowed. 972 </para> 973 974 <para> 975 [This is the first released version of the Lesser GPL. It also 976 counts as the successor of the GNU Library Public License, 977 version 2, hence the version number 2.1.] 978 </para> 979 980 <para> 981 Preamble 982 </para> 983 984 <para> 985 The licenses for most software are designed to take away your 986 freedom to share and change it. By contrast, the GNU General 987 Public Licenses are intended to guarantee your freedom to share 988 and change free software--to make sure the software is free for 989 all its users. 990 </para> 991 992 <para> 993 This license, the Lesser General Public License, applies to some 994 specially designated software packages--typically libraries--of 995 the Free Software Foundation and other authors who decide to use 996 it. You can use it too, but we suggest you first think carefully 997 about whether this license or the ordinary General Public 998 License is the better strategy to use in any particular case, 999 based on the explanations below. 1000 </para> 1001 1002 <para> 1003 When we speak of free software, we are referring to freedom of 1004 use, not price. Our General Public Licenses are designed to make 1005 sure that you have the freedom to distribute copies of free 1006 software (and charge for this service if you wish); that you 1007 receive source code or can get it if you want it; that you can 1008 change the software and use pieces of it in new free programs; 1009 and that you are informed that you can do these things. 1010 </para> 1011 1012 <para> 1013 To protect your rights, we need to make restrictions that forbid 1014 distributors to deny you these rights or to ask you to surrender 1015 these rights. These restrictions translate to certain 1016 responsibilities for you if you distribute copies of the library 1017 or if you modify it. 1018 </para> 1019 1020 <para> 1021 For example, if you distribute copies of the library, whether 1022 gratis or for a fee, you must give the recipients all the rights 1023 that we gave you. You must make sure that they, too, receive or 1024 can get the source code. If you link other code with the 1025 library, you must provide complete object files to the 1026 recipients, so that they can relink them with the library after 1027 making changes to the library and recompiling it. And you must 1028 show them these terms so they know their rights. 1029 </para> 1030 1031 <para> 1032 We protect your rights with a two-step method: (1) we copyright 1033 the library, and (2) we offer you this license, which gives you 1034 legal permission to copy, distribute and/or modify the library. 1035 </para> 1036 1037 <para> 1038 To protect each distributor, we want to make it very clear that 1039 there is no warranty for the free library. Also, if the library 1040 is modified by someone else and passed on, the recipients should 1041 know that what they have is not the original version, so that 1042 the original author's reputation will not be affected by 1043 problems that might be introduced by others. 1044 </para> 1045 1046 <para> 1047 Finally, software patents pose a constant threat to the 1048 existence of any free program. We wish to make sure that a 1049 company cannot effectively restrict the users of a free program 1050 by obtaining a restrictive license from a patent holder. 1051 Therefore, we insist that any patent license obtained for a 1052 version of the library must be consistent with the full freedom 1053 of use specified in this license. 1054 </para> 1055 1056 <para> 1057 Most GNU software, including some libraries, is covered by the 1058 ordinary GNU General Public License. This license, the GNU 1059 Lesser General Public License, applies to certain designated 1060 libraries, and is quite different from the ordinary General 1061 Public License. We use this license for certain libraries in 1062 order to permit linking those libraries into non-free programs. 1063 </para> 1064 1065 <para> 1066 When a program is linked with a library, whether statically or 1067 using a shared library, the combination of the two is legally 1068 speaking a combined work, a derivative of the original library. 1069 The ordinary General Public License therefore permits such 1070 linking only if the entire combination fits its criteria of 1071 freedom. The Lesser General Public License permits more lax 1072 criteria for linking other code with the library. 1073 </para> 1074 1075 <para> 1076 We call this license the "Lesser" General Public License because 1077 it does Less to protect the user's freedom than the ordinary 1078 General Public License. It also provides other free software 1079 developers Less of an advantage over competing non-free 1080 programs. These disadvantages are the reason we use the ordinary 1081 General Public License for many libraries. However, the Lesser 1082 license provides advantages in certain special circumstances. 1083 </para> 1084 1085 <para> 1086 For example, on rare occasions, there may be a special need to 1087 encourage the widest possible use of a certain library, so that 1088 it becomes a de-facto standard. To achieve this, non-free 1089 programs must be allowed to use the library. A more frequent 1090 case is that a free library does the same job as widely used 1091 non-free libraries. In this case, there is little to gain by 1092 limiting the free library to free software only, so we use the 1093 Lesser General Public License. 1094 </para> 1095 1096 <para> 1097 In other cases, permission to use a particular library in 1098 non-free programs enables a greater number of people to use a 1099 large body of free software. For example, permission to use the 1100 GNU C Library in non-free programs enables many more people to 1101 use the whole GNU operating system, as well as its variant, the 1102 GNU/Linux operating system. 1103 </para> 1104 1105 <para> 1106 Although the Lesser General Public License is Less protective of 1107 the users' freedom, it does ensure that the user of a program 1108 that is linked with the Library has the freedom and the 1109 wherewithal to run that program using a modified version of the 1110 Library. 1111 </para> 1112 1113 <para> 1114 The precise terms and conditions for copying, distribution and 1115 modification follow. Pay close attention to the difference 1116 between a "work based on the library" and a "work that uses the 1117 library". The former contains code derived from the library, 1118 whereas the latter must be combined with the library in order to 1119 run. 1120 </para> 1121 1122 <para> 1123 GNU LESSER GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR 1124 COPYING, DISTRIBUTION AND MODIFICATION 1125 </para> 1126 1127 <para> 1128 0. This License Agreement applies to any software library or 1129 other program which contains a notice placed by the copyright 1130 holder or other authorized party saying it may be distributed 1131 under the terms of this Lesser General Public License (also 1132 called "this License"). Each licensee is addressed as "you". 1133 </para> 1134 1135 <para> 1136 A "library" means a collection of software functions and/or data 1137 prepared so as to be conveniently linked with application 1138 programs (which use some of those functions and data) to form 1139 executables. 1140 </para> 1141 1142 <para> 1143 The "Library", below, refers to any such software library or 1144 work which has been distributed under these terms. A "work based 1145 on the Library" means either the Library or any derivative work 1146 under copyright law: that is to say, a work containing the 1147 Library or a portion of it, either verbatim or with 1148 modifications and/or translated straightforwardly into another 1149 language. (Hereinafter, translation is included without 1150 limitation in the term "modification".) 1151 </para> 1152 1153 <para> 1154 "Source code" for a work means the preferred form of the work 1155 for making modifications to it. For a library, complete source 1156 code means all the source code for all modules it contains, plus 1157 any associated interface definition files, plus the scripts used 1158 to control compilation and installation of the library. 1159 </para> 1160 1161 <para> 1162 Activities other than copying, distribution and modification are 1163 not covered by this License; they are outside its scope. The act 1164 of running a program using the Library is not restricted, and 1165 output from such a program is covered only if its contents 1166 constitute a work based on the Library (independent of the use 1167 of the Library in a tool for writing it). Whether that is true 1168 depends on what the Library does and what the program that uses 1169 the Library does. 1170 </para> 1171 1172 <para> 1173 1. You may copy and distribute verbatim copies of the Library's 1174 complete source code as you receive it, in any medium, provided 1175 that you conspicuously and appropriately publish on each copy an 1176 appropriate copyright notice and disclaimer of warranty; keep 1177 intact all the notices that refer to this License and to the 1178 absence of any warranty; and distribute a copy of this License 1179 along with the Library. 1180 </para> 1181 1182 <para> 1183 You may charge a fee for the physical act of transferring a 1184 copy, and you may at your option offer warranty protection in 1185 exchange for a fee. 1186 </para> 1187 1188 <para> 1189 2. You may modify your copy or copies of the Library or any 1190 portion of it, thus forming a work based on the Library, and 1191 copy and distribute such modifications or work under the terms 1192 of Section 1 above, provided that you also meet all of these 1193 conditions: 1194 </para> 1195 1196 <para> 1197 a) The modified work must itself be a software library. 1198 </para> 1199 1200 <para> 1201 b) You must cause the files modified to carry prominent notices 1202 stating that you changed the files and the date of any change. 1203 </para> 1204 1205 <para> 1206 c) You must cause the whole of the work to be licensed at no 1207 charge to all third parties under the terms of this License. 1208 </para> 1209 1210 <para> 1211 d) If a facility in the modified Library refers to a function or 1212 a table of data to be supplied by an application program that 1213 uses the facility, other than as an argument passed when the 1214 facility is invoked, then you must make a good faith effort to 1215 ensure that, in the event an application does not supply such 1216 function or table, the facility still operates, and performs 1217 whatever part of its purpose remains meaningful. 1218 </para> 1219 1220 <para> 1221 (For example, a function in a library to compute square roots 1222 has a purpose that is entirely well-defined independent of the 1223 application. Therefore, Subsection 2d requires that any 1224 application-supplied function or table used by this function 1225 must be optional: if the application does not supply it, the 1226 square root function must still compute square roots.) 1227 </para> 1228 1229 <para> 1230 These requirements apply to the modified work as a whole. If 1231 identifiable sections of that work are not derived from the 1232 Library, and can be reasonably considered independent and 1233 separate works in themselves, then this License, and its terms, 1234 do not apply to those sections when you distribute them as 1235 separate works. But when you distribute the same sections as 1236 part of a whole which is a work based on the Library, the 1237 distribution of the whole must be on the terms of this License, 1238 whose permissions for other licensees extend to the entire 1239 whole, and thus to each and every part regardless of who wrote 1240 it. 1241 </para> 1242 1243 <para> 1244 Thus, it is not the intent of this section to claim rights or 1245 contest your rights to work written entirely by you; rather, the 1246 intent is to exercise the right to control the distribution of 1247 derivative or collective works based on the Library. 1248 </para> 1249 1250 <para> 1251 In addition, mere aggregation of another work not based on the 1252 Library with the Library (or with a work based on the Library) 1253 on a volume of a storage or distribution medium does not bring 1254 the other work under the scope of this License. 1255 </para> 1256 1257 <para> 1258 3. You may opt to apply the terms of the ordinary GNU General 1259 Public License instead of this License to a given copy of the 1260 Library. To do this, you must alter all the notices that refer 1261 to this License, so that they refer to the ordinary GNU General 1262 Public License, version 2, instead of to this License. (If a 1263 newer version than version 2 of the ordinary GNU General Public 1264 License has appeared, then you can specify that version instead 1265 if you wish.) Do not make any other change in these notices. 1266 </para> 1267 1268 <para> 1269 Once this change is made in a given copy, it is irreversible for 1270 that copy, so the ordinary GNU General Public License applies to 1271 all subsequent copies and derivative works made from that copy. 1272 </para> 1273 1274 <para> 1275 This option is useful when you wish to copy part of the code of 1276 the Library into a program that is not a library. 1277 </para> 1278 1279 <para> 1280 4. You may copy and distribute the Library (or a portion or 1281 derivative of it, under Section 2) in object code or executable 1282 form under the terms of Sections 1 and 2 above provided that you 1283 accompany it with the complete corresponding machine-readable 1284 source code, which must be distributed under the terms of 1285 Sections 1 and 2 above on a medium customarily used for software 1286 interchange. 1287 </para> 1288 1289 <para> 1290 If distribution of object code is made by offering access to 1291 copy from a designated place, then offering equivalent access to 1292 copy the source code from the same place satisfies the 1293 requirement to distribute the source code, even though third 1294 parties are not compelled to copy the source along with the 1295 object code. 1296 </para> 1297 1298 <para> 1299 5. A program that contains no derivative of any portion of the 1300 Library, but is designed to work with the Library by being 1301 compiled or linked with it, is called a "work that uses the 1302 Library". Such a work, in isolation, is not a derivative work of 1303 the Library, and therefore falls outside the scope of this 1304 License. 1305 </para> 1306 1307 <para> 1308 However, linking a "work that uses the Library" with the Library 1309 creates an executable that is a derivative of the Library 1310 (because it contains portions of the Library), rather than a 1311 "work that uses the library". The executable is therefore 1312 covered by this License. Section 6 states terms for distribution 1313 of such executables. 1314 </para> 1315 1316 <para> 1317 When a "work that uses the Library" uses material from a header 1318 file that is part of the Library, the object code for the work 1319 may be a derivative work of the Library even though the source 1320 code is not. Whether this is true is especially significant if 1321 the work can be linked without the Library, or if the work is 1322 itself a library. The threshold for this to be true is not 1323 precisely defined by law. 1324 </para> 1325 1326 <para> 1327 If such an object file uses only numerical parameters, data 1328 structure layouts and accessors, and small macros and small 1329 inline functions (ten lines or less in length), then the use of 1330 the object file is unrestricted, regardless of whether it is 1331 legally a derivative work. (Executables containing this object 1332 code plus portions of the Library will still fall under Section 1333 6.) Otherwise, if the work is a derivative of the Library, you 1334 may distribute the object code for the work under the terms of 1335 Section 6. Any executables containing that work also fall under 1336 Section 6, whether or not they are linked directly with the 1337 Library itself. 1338 </para> 1339 1340 <para> 1341 6. As an exception to the Sections above, you may also combine 1342 or link a "work that uses the Library" with the Library to 1343 produce a work containing portions of the Library, and 1344 distribute that work under terms of your choice, provided that 1345 the terms permit modification of the work for the customer's own 1346 use and reverse engineering for debugging such modifications. 1347 </para> 1348 1349 <para> 1350 You must give prominent notice with each copy of the work that 1351 the Library is used in it and that the Library and its use are 1352 covered by this License. You must supply a copy of this License. 1353 If the work during execution displays copyright notices, you 1354 must include the copyright notice for the Library among them, as 1355 well as a reference directing the user to the copy of this 1356 License. Also, you must do one of these things: 1357 </para> 1358 1359 <para> 1360 a) Accompany the work with the complete corresponding 1361 machine-readable source code for the Library including whatever 1362 changes were used in the work (which must be distributed under 1363 Sections 1 and 2 above); and, if the work is an executable 1364 linked with the Library, with the complete machine-readable 1365 "work that uses the Library", as object code and/or source code, 1366 so that the user can modify the Library and then relink to 1367 produce a modified executable containing the modified Library. 1368 (It is understood that the user who changes the contents of 1369 definitions files in the Library will not necessarily be able to 1370 recompile the application to use the modified definitions.) 1371 </para> 1372 1373 <para> 1374 b) Use a suitable shared library mechanism for linking with the 1375 Library. A suitable mechanism is one that (1) uses at run time a 1376 copy of the library already present on the user's computer 1377 system, rather than copying library functions into the 1378 executable, and (2) will operate properly with a modified 1379 version of the library, if the user installs one, as long as the 1380 modified version is interface-compatible with the version that 1381 the work was made with. 1382 </para> 1383 1384 <para> 1385 c) Accompany the work with a written offer, valid for at least 1386 three years, to give the same user the materials specified in 1387 Subsection 6a, above, for a charge no more than the cost of 1388 performing this distribution. 1389 </para> 1390 1391 <para> 1392 d) If distribution of the work is made by offering access to 1393 copy from a designated place, offer equivalent access to copy 1394 the above specified materials from the same place. 1395 </para> 1396 1397 <para> 1398 e) Verify that the user has already received a copy of these 1399 materials or that you have already sent this user a copy. 1400 </para> 1401 1402 <para> 1403 For an executable, the required form of the "work that uses the 1404 Library" must include any data and utility programs needed for 1405 reproducing the executable from it. However, as a special 1406 exception, the materials to be distributed need not include 1407 anything that is normally distributed (in either source or 1408 binary form) with the major components (compiler, kernel, and so 1409 on) of the operating system on which the executable runs, unless 1410 that component itself accompanies the executable. 1411 </para> 1412 1413 <para> 1414 It may happen that this requirement contradicts the license 1415 restrictions of other proprietary libraries that do not normally 1416 accompany the operating system. Such a contradiction means you 1417 cannot use both them and the Library together in an executable 1418 that you distribute. 1419 </para> 1420 1421 <para> 1422 7. You may place library facilities that are a work based on the 1423 Library side-by-side in a single library together with other 1424 library facilities not covered by this License, and distribute 1425 such a combined library, provided that the separate distribution 1426 of the work based on the Library and of the other library 1427 facilities is otherwise permitted, and provided that you do 1428 these two things: 1429 </para> 1430 1431 <para> 1432 a) Accompany the combined library with a copy of the same work 1433 based on the Library, uncombined with any other library 1434 facilities. This must be distributed under the terms of the 1435 Sections above. 1436 </para> 1437 1438 <para> 1439 b) Give prominent notice with the combined library of the fact 1440 that part of it is a work based on the Library, and explaining 1441 where to find the accompanying uncombined form of the same work. 1442 </para> 1443 1444 <para> 1445 8. You may not copy, modify, sublicense, link with, or 1446 distribute the Library except as expressly provided under this 1447 License. Any attempt otherwise to copy, modify, sublicense, link 1448 with, or distribute the Library is void, and will automatically 1449 terminate your rights under this License. However, parties who 1450 have received copies, or rights, from you under this License 1451 will not have their licenses terminated so long as such parties 1452 remain in full compliance. 1453 </para> 1454 1455 <para> 1456 9. You are not required to accept this License, since you have 1457 not signed it. However, nothing else grants you permission to 1458 modify or distribute the Library or its derivative works. These 1459 actions are prohibited by law if you do not accept this License. 1460 Therefore, by modifying or distributing the Library (or any work 1461 based on the Library), you indicate your acceptance of this 1462 License to do so, and all its terms and conditions for copying, 1463 distributing or modifying the Library or works based on it. 1464 </para> 1465 1466 <para> 1467 10. Each time you redistribute the Library (or any work based on 1468 the Library), the recipient automatically receives a license 1469 from the original licensor to copy, distribute, link with or 1470 modify the Library subject to these terms and conditions. You 1471 may not impose any further restrictions on the recipients' 1472 exercise of the rights granted herein. You are not responsible 1473 for enforcing compliance by third parties with this License. 1474 </para> 1475 1476 <para> 1477 11. If, as a consequence of a court judgment or allegation of 1478 patent infringement or for any other reason (not limited to 1479 patent issues), conditions are imposed on you (whether by court 1480 order, agreement or otherwise) that contradict the conditions of 1481 this License, they do not excuse you from the conditions of this 1482 License. If you cannot distribute so as to satisfy 1483 simultaneously your obligations under this License and any other 1484 pertinent obligations, then as a consequence you may not 1485 distribute the Library at all. For example, if a patent license 1486 would not permit royalty-free redistribution of the Library by 1487 all those who receive copies directly or indirectly through you, 1488 then the only way you could satisfy both it and this License 1489 would be to refrain entirely from distribution of the Library. 1490 </para> 1491 1492 <para> 1493 If any portion of this section is held invalid or unenforceable 1494 under any particular circumstance, the balance of the section is 1495 intended to apply, and the section as a whole is intended to 1496 apply in other circumstances. 1497 </para> 1498 1499 <para> 1500 It is not the purpose of this section to induce you to infringe 1501 any patents or other property right claims or to contest 1502 validity of any such claims; this section has the sole purpose 1503 of protecting the integrity of the free software distribution 1504 system which is implemented by public license practices. Many 1505 people have made generous contributions to the wide range of 1506 software distributed through that system in reliance on 1507 consistent application of that system; it is up to the 1508 author/donor to decide if he or she is willing to distribute 1509 software through any other system and a licensee cannot impose 1510 that choice. 1511 </para> 1512 1513 <para> 1514 This section is intended to make thoroughly clear what is 1515 believed to be a consequence of the rest of this License. 1516 </para> 1517 1518 <para> 1519 12. If the distribution and/or use of the Library is restricted 1520 in certain countries either by patents or by copyrighted 1521 interfaces, the original copyright holder who places the Library 1522 under this License may add an explicit geographical distribution 1523 limitation excluding those countries, so that distribution is 1524 permitted only in or among countries not thus excluded. In such 1525 case, this License incorporates the limitation as if written in 1526 the body of this License. 1527 </para> 1528 1529 <para> 1530 13. The Free Software Foundation may publish revised and/or new 1531 versions of the Lesser General Public License from time to time. 1532 Such new versions will be similar in spirit to the present 1533 version, but may differ in detail to address new problems or 1534 concerns. 1535 </para> 1536 1537 <para> 1538 Each version is given a distinguishing version number. If the 1539 Library specifies a version number of this License which applies 1540 to it and "any later version", you have the option of following 1541 the terms and conditions either of that version or of any later 1542 version published by the Free Software Foundation. If the 1543 Library does not specify a license version number, you may 1544 choose any version ever published by the Free Software 1545 Foundation. 1546 </para> 1547 1548 <para> 1549 14. If you wish to incorporate parts of the Library into other 1550 free programs whose distribution conditions are incompatible 1551 with these, write to the author to ask for permission. For 1552 software which is copyrighted by the Free Software Foundation, 1553 write to the Free Software Foundation; we sometimes make 1554 exceptions for this. Our decision will be guided by the two 1555 goals of preserving the free status of all derivatives of our 1556 free software and of promoting the sharing and reuse of software 1557 generally. 1558 </para> 1559 1560 <para> 1561 NO WARRANTY 1562 </para> 1563 1564 <para> 1565 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO 1566 WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE 1567 LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 1568 HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT 1569 WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, 1570 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY 1571 AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE 1572 QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE 1573 LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY 1574 SERVICING, REPAIR OR CORRECTION. 1575 </para> 1576 1577 <para> 1578 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO 1579 IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY 1580 MODIFY AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE 1581 LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, 1582 INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR 1583 INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS 1584 OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 1585 YOU OR THIRD PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH 1586 ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN 1587 ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 1588 </para> 1589 1590 <para> 1591 END OF TERMS AND CONDITIONS 1592 </para> 1593 1120 1594 </sect2> 1121 1595 1122 1596 <sect2 id="licMPL"> 1597 1123 1598 <title>Mozilla Public License (MPL)</title> 1124 1599 1125 <para>MOZILLA PUBLIC LICENSE Version 1.1</para> 1126 1127 <para>1. Definitions.</para> 1128 1129 <para>1.0.1. "Commercial Use" means distribution or otherwise making the 1130 Covered Code available to a third party.</para> 1131 1132 <para>1.1. "Contributor" means each entity that creates or contributes 1133 to the creation of Modifications.</para> 1134 1135 <para>1.2. "Contributor Version" means the combination of the Original 1136 Code, prior Modifications used by a Contributor, and the Modifications 1137 made by that particular Contributor.</para> 1138 1139 <para>1.3. "Covered Code" means the Original Code or Modifications or 1140 the combination of the Original Code and Modifications, in each case 1141 including portions thereof.</para> 1142 1143 <para>1.4. "Electronic Distribution Mechanism" means a mechanism 1144 generally accepted in the software development community for the 1145 electronic transfer of data.</para> 1146 1147 <para>1.5. "Executable" means Covered Code in any form other than Source 1148 Code.</para> 1149 1150 <para>1.6. "Initial Developer" means the individual or entity identified 1151 as the Initial Developer in the Source Code notice required by Exhibit 1152 A.</para> 1153 1154 <para>1.7. "Larger Work" means a work which combines Covered Code or 1155 portions thereof with code not governed by the terms of this 1156 License.</para> 1157 1158 <para>1.8. "License" means this document.</para> 1159 1160 <para>1.8.1. "Licensable" means having the right to grant, to the 1161 maximum extent possible, whether at the time of the initial grant or 1162 subsequently acquired, any and all of the rights conveyed herein.</para> 1163 1164 <para>1.9. "Modifications" means any addition to or deletion from the 1165 substance or structure of either the Original Code or any previous 1166 Modifications. When Covered Code is released as a series of files, a 1167 Modification is:</para> 1168 1169 <para>A. Any addition to or deletion from the contents of a file 1170 containing Original Code or previous Modifications.</para> 1171 1172 <para>B. Any new file that contains any part of the Original Code or 1173 previous Modifications.</para> 1174 1175 <para>1.10. "Original Code" means Source Code of computer software code 1176 which is described in the Source Code notice required by Exhibit A as 1177 Original Code, and which, at the time of its release under this License 1178 is not already Covered Code governed by this License.</para> 1179 1180 <para>1.10.1. "Patent Claims" means any patent claim(s), now owned or 1181 hereafter acquired, including without limitation, method, process, and 1182 apparatus claims, in any patent Licensable by grantor.</para> 1183 1184 <para>1.11. "Source Code" means the preferred form of the Covered Code 1185 for making modifications to it, including all modules it contains, plus 1186 any associated interface definition files, scripts used to control 1187 compilation and installation of an Executable, or source code 1188 differential comparisons against either the Original Code or another 1189 well known, available Covered Code of the Contributor's choice. The 1190 Source Code can be in a compressed or archival form, provided the 1191 appropriate decompression or de-archiving software is widely available 1192 for no charge.</para> 1193 1194 <para>1.12. "You" (or "Your") means an individual or a legal entity 1195 exercising rights under, and complying with all of the terms of, this 1196 License or a future version of this License issued under Section 6.1. 1197 For legal entities, "You" includes any entity which controls, is 1198 controlled by, or is under common control with You. For purposes of this 1199 definition, "control" means (a) the power, direct or indirect, to cause 1200 the direction or management of such entity, whether by contract or 1201 otherwise, or (b) ownership of more than fifty percent (50%) of the 1202 outstanding shares or beneficial ownership of such entity.</para> 1203 1204 <para>2. Source Code License.</para> 1205 1206 <para>2.1. The Initial Developer Grant. The Initial Developer hereby 1207 grants You a world-wide, royalty-free, non-exclusive license, subject to 1208 third party intellectual property claims:</para> 1209 1210 <para>(a) under intellectual property rights (other than patent or 1211 trademark) Licensable by Initial Developer to use, reproduce, modify, 1212 display, perform, sublicense and distribute the Original Code (or 1213 portions thereof) with or without Modifications, and/or as part of a 1214 Larger Work; and</para> 1215 1216 <para>(b) under Patents Claims infringed by the making, using or selling 1217 of Original Code, to make, have made, use, practice, sell, and offer for 1218 sale, and/or otherwise dispose of the Original Code (or portions 1219 thereof).</para> 1220 1221 <para>(c) the licenses granted in this Section 2.1(a) and (b) are 1222 effective on the date Initial Developer first distributes Original Code 1223 under the terms of this License.</para> 1224 1225 <para>(d) Notwithstanding Section 2.1(b) above, no patent license is 1226 granted: 1) for code that You delete from the Original Code; 2) separate 1227 from the Original Code; or 3) for infringements caused by: i) the 1228 modification of the Original Code or ii) the combination of the Original 1229 Code with other software or devices.</para> 1230 1231 <para>2.2. Contributor Grant. Subject to third party intellectual 1232 property claims, each Contributor hereby grants You a world-wide, 1233 royalty-free, non-exclusive license</para> 1234 1235 <para>(a) under intellectual property rights (other than patent or 1236 trademark) Licensable by Contributor, to use, reproduce, modify, 1237 display, perform, sublicense and distribute the Modifications created by 1238 such Contributor (or portions thereof) either on an unmodified basis, 1239 with other Modifications, as Covered Code and/or as part of a Larger 1240 Work; and</para> 1241 1242 <para>(b) under Patent Claims infringed by the making, using, or selling 1243 of Modifications made by that Contributor either alone and/or in 1244 combination with its Contributor Version (or portions of such 1245 combination), to make, use, sell, offer for sale, have made, and/or 1246 otherwise dispose of: 1) Modifications made by that Contributor (or 1247 portions thereof); and 2) the combination of Modifications made by that 1248 Contributor with its Contributor Version (or portions of such 1249 combination).</para> 1250 1251 <para>(c) the licenses granted in Sections 2.2(a) and 2.2(b) are 1252 effective on the date Contributor first makes Commercial Use of the 1253 Covered Code.</para> 1254 1255 <para>(d) Notwithstanding Section 2.2(b) above, no patent license is 1256 granted: 1) for any code that Contributor has deleted from the 1257 Contributor Version; 2) separate from the Contributor Version; 3) for 1258 infringements caused by: i) third party modifications of Contributor 1259 Version or ii) the combination of Modifications made by that Contributor 1260 with other software (except as part of the Contributor Version) or other 1261 devices; or 4) under Patent Claims infringed by Covered Code in the 1262 absence of Modifications made by that Contributor.</para> 1263 1264 <para>3. Distribution Obligations.</para> 1265 1266 <para>3.1. Application of License. The Modifications which You create or 1267 to which You contribute are governed by the terms of this License, 1268 including without limitation Section 2.2. The Source Code version of 1269 Covered Code may be distributed only under the terms of this License or 1270 a future version of this License released under Section 6.1, and You 1271 must include a copy of this License with every copy of the Source Code 1272 You distribute. You may not offer or impose any terms on any Source Code 1273 version that alters or restricts the applicable version of this License 1274 or the recipients' rights hereunder. However, You may include an 1275 additional document offering the additional rights described in Section 1276 3.5.</para> 1277 1278 <para>3.2. Availability of Source Code. Any Modification which You 1279 create or to which You contribute must be made available in Source Code 1280 form under the terms of this License either on the same media as an 1281 Executable version or via an accepted Electronic Distribution Mechanism 1282 to anyone to whom you made an Executable version available; and if made 1283 available via Electronic Distribution Mechanism, must remain available 1284 for at least twelve (12) months after the date it initially became 1285 available, or at least six (6) months after a subsequent version of that 1286 particular Modification has been made available to such recipients. You 1287 are responsible for ensuring that the Source Code version remains 1288 available even if the Electronic Distribution Mechanism is maintained by 1289 a third party.</para> 1290 1291 <para>3.3. Description of Modifications. You must cause all Covered Code 1292 to which You contribute to contain a file documenting the changes You 1293 made to create that Covered Code and the date of any change. You must 1294 include a prominent statement that the Modification is derived, directly 1295 or indirectly, from Original Code provided by the Initial Developer and 1296 including the name of the Initial Developer in (a) the Source Code, and 1297 (b) in any notice in an Executable version or related documentation in 1298 which You describe the origin or ownership of the Covered Code.</para> 1299 1300 <para>3.4. Intellectual Property Matters</para> 1301 1302 <para>(a) Third Party Claims. If Contributor has knowledge that a 1303 license under a third party's intellectual property rights is required 1304 to exercise the rights granted by such Contributor under Sections 2.1 or 1305 2.2, Contributor must include a text file with the Source Code 1306 distribution titled "LEGAL" which describes the claim and the party 1307 making the claim in sufficient detail that a recipient will know whom to 1308 contact. If Contributor obtains such knowledge after the Modification is 1309 made available as described in Section 3.2, Contributor shall promptly 1310 modify the LEGAL file in all copies Contributor makes available 1311 thereafter and shall take other steps (such as notifying appropriate 1312 mailing lists or newsgroups) reasonably calculated to inform those who 1313 received the Covered Code that new knowledge has been obtained.</para> 1314 1315 <para>(b) Contributor APIs. If Contributor's Modifications include an 1316 application programming interface and Contributor has knowledge of 1317 patent licenses which are reasonably necessary to implement that API, 1318 Contributor must also include this information in the LEGAL file.</para> 1319 1320 <para>3.5. Required Notices. You must duplicate the notice in Exhibit A 1321 in each file of the Source Code. If it is not possible to put such 1322 notice in a particular Source Code file due to its structure, then You 1323 must include such notice in a location (such as a relevant directory) 1324 where a user would be likely to look for such a notice. If You created 1325 one or more Modification(s) You may add your name as a Contributor to 1326 the notice described in Exhibit A. You must also duplicate this License 1327 in any documentation for the Source Code where You describe recipients' 1328 rights or ownership rights relating to Covered Code. You may choose to 1329 offer, and to charge a fee for, warranty, support, indemnity or 1330 liability obligations to one or more recipients of Covered Code. 1331 However, You may do so only on Your own behalf, and not on behalf of the 1332 Initial Developer or any Contributor. You must make it absolutely clear 1333 than any such warranty, support, indemnity or liability obligation is 1334 offered by You alone, and You hereby agree to indemnify the Initial 1335 Developer and every Contributor for any liability incurred by the 1336 Initial Developer or such Contributor as a result of warranty, support, 1337 indemnity or liability terms You offer.</para> 1338 1339 <para>3.6. Distribution of Executable Versions. You may distribute 1340 Covered Code in Executable form only if the requirements of Section 1341 3.1-3.5 have been met for that Covered Code, and if You include a notice 1342 stating that the Source Code version of the Covered Code is available 1343 under the terms of this License, including a description of how and 1344 where You have fulfilled the obligations of Section 3.2. The notice must 1345 be conspicuously included in any notice in an Executable version, 1346 related documentation or collateral in which You describe recipients' 1347 rights relating to the Covered Code. You may distribute the Executable 1348 version of Covered Code or ownership rights under a license of Your 1349 choice, which may contain terms different from this License, provided 1350 that You are in compliance with the terms of this License and that the 1351 license for the Executable version does not attempt to limit or alter 1352 the recipient's rights in the Source Code version from the rights set 1353 forth in this License. If You distribute the Executable version under a 1354 different license You must make it absolutely clear that any terms which 1355 differ from this License are offered by You alone, not by the Initial 1356 Developer or any Contributor. You hereby agree to indemnify the Initial 1357 Developer and every Contributor for any liability incurred by the 1358 Initial Developer or such Contributor as a result of any such terms You 1359 offer.</para> 1360 1361 <para>3.7. Larger Works. You may create a Larger Work by combining 1362 Covered Code with other code not governed by the terms of this License 1363 and distribute the Larger Work as a single product. In such a case, You 1364 must make sure the requirements of this License are fulfilled for the 1365 Covered Code.</para> 1366 1367 <para>4. Inability to Comply Due to Statute or Regulation.If it is 1368 impossible for You to comply with any of the terms of this License with 1369 respect to some or all of the Covered Code due to statute, judicial 1370 order, or regulation then You must: (a) comply with the terms of this 1371 License to the maximum extent possible; and (b) describe the limitations 1372 and the code they affect. Such description must be included in the LEGAL 1373 file described in Section 3.4 and must be included with all 1374 distributions of the Source Code. Except to the extent prohibited by 1375 statute or regulation, such description must be sufficiently detailed 1376 for a recipient of ordinary skill to be able to understand it.</para> 1377 1378 <para>5. Application of this License. This License applies to code to 1379 which the Initial Developer has attached the notice in Exhibit A and to 1380 related Covered Code.</para> 1381 1382 <para>6. Versions of the License.</para> 1383 1384 <para>6.1. New Versions. Netscape Communications Corporation 1385 ("Netscape") may publish revised and/or new versions of the License from 1386 time to time. Each version will be given a distinguishing version 1387 number.</para> 1388 1389 <para>6.2. Effect of New Versions. Once Covered Code has been published 1390 under a particular version of the License, You may always continue to 1391 use it under the terms of that version. You may also choose to use such 1392 Covered Code under the terms of any subsequent version of the License 1393 published by Netscape. No one other than Netscape has the right to 1394 modify the terms applicable to Covered Code created under this 1395 License.</para> 1396 1397 <para>6.3. Derivative Works. If You create or use a modified version of 1398 this License (which you may only do in order to apply it to code which 1399 is not already Covered Code governed by this License), You must (a) 1400 rename Your license so that the phrases "Mozilla", "MOZILLAPL", "MOZPL", 1401 "Netscape", "MPL", "NPL" or any confusingly similar phrase do not appear 1402 in your license (except to note that your license differs from this 1403 License) and (b) otherwise make it clear that Your version of the 1404 license contains terms which differ from the Mozilla Public License and 1405 Netscape Public License. (Filling in the name of the Initial Developer, 1406 Original Code or Contributor in the notice described in Exhibit A shall 1407 not of themselves be deemed to be modifications of this License.)</para> 1408 1409 <para>7. DISCLAIMER OF WARRANTY.</para> 1410 1411 <para>COVERED CODE IS PROVIDED UNDER THIS LICENSE ON AN "AS IS" BASIS, 1412 WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, 1413 WITHOUT LIMITATION, WARRANTIES THAT THE COVERED CODE IS FREE OF DEFECTS, 1414 MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE 1415 RISK AS TO THE QUALITY AND PERFORMANCE OF THE COVERED CODE IS WITH YOU. 1416 SHOULD ANY COVERED CODE PROVE DEFECTIVE IN ANY RESPECT, YOU (NOT THE 1417 INITIAL DEVELOPER OR ANY OTHER CONTRIBUTOR) ASSUME THE COST OF ANY 1418 NECESSARY SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER OF WARRANTY 1419 CONSTITUTES AN ESSENTIAL PART OF THIS LICENSE. NO USE OF ANY COVERED 1420 CODE IS AUTHORIZED HEREUNDER EXCEPT UNDER THIS DISCLAIMER.</para> 1421 1422 <para>8. TERMINATION.</para> 1423 1424 <para>8.1. This License and the rights granted hereunder will terminate 1425 automatically if You fail to comply with terms herein and fail to cure 1426 such breach within 30 days of becoming aware of the breach. All 1427 sublicenses to the Covered Code which are properly granted shall survive 1428 any termination of this License. Provisions which, by their nature, must 1429 remain in effect beyond the termination of this License shall 1430 survive.</para> 1431 1432 <para>8.2. If You initiate litigation by asserting a patent infringement 1433 claim (excluding declaratory judgment actions) against Initial Developer 1434 or a Contributor (the Initial Developer or Contributor against whom You 1435 file such action is referred to as "Participant") alleging that:</para> 1436 1437 <para>(a) such Participant's Contributor Version directly or indirectly 1438 infringes any patent, then any and all rights granted by such 1439 Participant to You under Sections 2.1 and/or 2.2 of this License shall, 1440 upon 60 days notice from Participant terminate prospectively, unless if 1441 within 60 days after receipt of notice You either: (i) agree in writing 1442 to pay Participant a mutually agreeable reasonable royalty for Your past 1443 and future use of Modifications made by such Participant, or (ii) 1444 withdraw Your litigation claim with respect to the Contributor Version 1445 against such Participant. If within 60 days of notice, a reasonable 1446 royalty and payment arrangement are not mutually agreed upon in writing 1447 by the parties or the litigation claim is not withdrawn, the rights 1448 granted by Participant to You under Sections 2.1 and/or 2.2 1449 automatically terminate at the expiration of the 60 day notice period 1450 specified above.</para> 1451 1452 <para>(b) any software, hardware, or device, other than such 1453 Participant's Contributor Version, directly or indirectly infringes any 1454 patent, then any rights granted to You by such Participant under 1455 Sections 2.1(b) and 2.2(b) are revoked effective as of the date You 1456 first made, used, sold, distributed, or had made, Modifications made by 1457 that Participant.</para> 1458 1459 <para>8.3. If You assert a patent infringement claim against Participant 1460 alleging that such Participant's Contributor Version directly or 1461 indirectly infringes any patent where such claim is resolved (such as by 1462 license or settlement) prior to the initiation of patent infringement 1463 litigation, then the reasonable value of the licenses granted by such 1464 Participant under Sections 2.1 or 2.2 shall be taken into account in 1465 determining the amount or value of any payment or license.</para> 1466 1467 <para>8.4. In the event of termination under Sections 8.1 or 8.2 above, 1468 all end user license agreements (excluding distributors and resellers) 1469 which have been validly granted by You or any distributor hereunder 1470 prior to termination shall survive termination.</para> 1471 1472 <para>9. LIMITATION OF LIABILITY. UNDER NO CIRCUMSTANCES AND UNDER NO 1473 LEGAL THEORY, WHETHER TORT (INCLUDING NEGLIGENCE), CONTRACT, OR 1474 OTHERWISE, SHALL YOU, THE INITIAL DEVELOPER, ANY OTHER CONTRIBUTOR, OR 1475 ANY DISTRIBUTOR OF COVERED CODE, OR ANY SUPPLIER OF ANY OF SUCH PARTIES, 1476 BE LIABLE TO ANY PERSON FOR ANY INDIRECT, SPECIAL, INCIDENTAL, OR 1477 CONSEQUENTIAL DAMAGES OF ANY CHARACTER INCLUDING, WITHOUT LIMITATION, 1478 DAMAGES FOR LOSS OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR 1479 MALFUNCTION, OR ANY AND ALL OTHER COMMERCIAL DAMAGES OR LOSSES, EVEN IF 1480 SUCH PARTY SHALL HAVE BEEN INFORMED OF THE POSSIBILITY OF SUCH DAMAGES. 1481 THIS LIMITATION OF LIABILITY SHALL NOT APPLY TO LIABILITY FOR DEATH OR 1482 PERSONAL INJURY RESULTING FROM SUCH PARTY'S NEGLIGENCE TO THE EXTENT 1483 APPLICABLE LAW PROHIBITS SUCH LIMITATION. SOME JURISDICTIONS DO NOT 1484 ALLOW THE EXCLUSION OR LIMITATION OF INCIDENTAL OR CONSEQUENTIAL 1485 DAMAGES, SO THIS EXCLUSION AND LIMITATION MAY NOT APPLY TO YOU.</para> 1486 1487 <para>10. U.S. GOVERNMENT END USERS. The Covered Code is a "commercial 1488 item," as that term is defined in 48 C.F.R. 2.101 (Oct. 1995), 1489 consisting of "commercial computer software" and "commercial computer 1490 software documentation," as such terms are used in 48 C.F.R. 12.212 1491 (Sept. 1995). Consistent with 48 C.F.R. 12.212 and 48 C.F.R. 227.7202-1 1492 through 227.7202-4 (June 1995), all U.S. Government End Users acquire 1493 Covered Code with only those rights set forth herein.</para> 1494 1495 <para>11. MISCELLANEOUS. This License represents the complete agreement 1496 concerning subject matter hereof. If any provision of this License is 1497 held to be unenforceable, such provision shall be reformed only to the 1498 extent necessary to make it enforceable. This License shall be governed 1499 by California law provisions (except to the extent applicable law, if 1500 any, provides otherwise), excluding its conflict-of-law provisions. With 1501 respect to disputes in which at least one party is a citizen of, or an 1502 entity chartered or registered to do business in the United States of 1503 America, any litigation relating to this License shall be subject to the 1504 jurisdiction of the Federal Courts of the Northern District of 1505 California, with venue lying in Santa Clara County, California, with the 1506 losing party responsible for costs, including without limitation, court 1507 costs and reasonable attorneys' fees and expenses. The application of 1508 the United Nations Convention on Contracts for the International Sale of 1509 Goods is expressly excluded. Any law or regulation which provides that 1510 the language of a contract shall be construed against the drafter shall 1511 not apply to this License.</para> 1512 1513 <para>12. RESPONSIBILITY FOR CLAIMS. As between Initial Developer and 1514 the Contributors, each party is responsible for claims and damages 1515 arising, directly or indirectly, out of its utilization of rights under 1516 this License and You agree to work with Initial Developer and 1517 Contributors to distribute such responsibility on an equitable basis. 1518 Nothing herein is intended or shall be deemed to constitute any 1519 admission of liability.</para> 1520 1521 <para>13. MULTIPLE-LICENSED CODE. Initial Developer may designate 1522 portions of the Covered Code as "Multiple-Licensed". "Multiple-Licensed" 1523 means that the Initial Developer permits you to utilize portions of the 1524 Covered Code under Your choice of the NPL or the alternative licenses, 1525 if any, specified by the Initial Developer in the file described in 1526 Exhibit A.</para> 1527 1528 <para>EXHIBIT A -Mozilla Public License.</para> 1529 1530 <para>``The contents of this file are subject to the Mozilla Public 1531 License Version 1.1 (the "License"); you may not use this file except in 1532 compliance with the License. You may obtain a copy of the License at 1533 http://www.mozilla.org/MPL/</para> 1534 1535 <para>Software distributed under the License is distributed on an "AS 1536 IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See 1537 the License for the specific language governing rights and limitations 1538 under the License.</para> 1539 1540 <para>The Original Code is 1541 ______________________________________.</para> 1542 1543 <para>The Initial Developer of the Original Code is 1544 ________________________. Portions created by ______________________ are 1545 Copyright (C) ______ _______________________. All Rights 1546 Reserved.</para> 1547 1548 <para>Contributor(s): ______________________________________.</para> 1549 1550 <para>Alternatively, the contents of this file may be used under the 1551 terms of the _____ license (the "[___] License"), in which case the 1552 provisions of [______] License are applicable instead of those above. If 1553 you wish to allow use of your version of this file only under the terms 1554 of the [____] License and not to allow others to use your version of 1555 this file under the MPL, indicate your decision by deleting the 1556 provisions above and replace them with the notice and other provisions 1557 required by the [___] License. If you do not delete the provisions 1558 above, a recipient may use your version of this file under either the 1559 MPL or the [___] License."</para> 1560 1561 <para>[NOTE: The text of this Exhibit A may differ slightly from the 1562 text of the notices in the Source Code files of the Original Code. You 1563 should use the text of this Exhibit A rather than the text found in the 1564 Original Code Source Code for Your Modifications.]</para> 1600 <para> 1601 MOZILLA PUBLIC LICENSE Version 1.1 1602 </para> 1603 1604 <para> 1605 1. Definitions. 1606 </para> 1607 1608 <para> 1609 1.0.1. "Commercial Use" means distribution or otherwise making 1610 the Covered Code available to a third party. 1611 </para> 1612 1613 <para> 1614 1.1. "Contributor" means each entity that creates or contributes 1615 to the creation of Modifications. 1616 </para> 1617 1618 <para> 1619 1.2. "Contributor Version" means the combination of the Original 1620 Code, prior Modifications used by a Contributor, and the 1621 Modifications made by that particular Contributor. 1622 </para> 1623 1624 <para> 1625 1.3. "Covered Code" means the Original Code or Modifications or 1626 the combination of the Original Code and Modifications, in each 1627 case including portions thereof. 1628 </para> 1629 1630 <para> 1631 1.4. "Electronic Distribution Mechanism" means a mechanism 1632 generally accepted in the software development community for the 1633 electronic transfer of data. 1634 </para> 1635 1636 <para> 1637 1.5. "Executable" means Covered Code in any form other than 1638 Source Code. 1639 </para> 1640 1641 <para> 1642 1.6. "Initial Developer" means the individual or entity 1643 identified as the Initial Developer in the Source Code notice 1644 required by Exhibit A. 1645 </para> 1646 1647 <para> 1648 1.7. "Larger Work" means a work which combines Covered Code or 1649 portions thereof with code not governed by the terms of this 1650 License. 1651 </para> 1652 1653 <para> 1654 1.8. "License" means this document. 1655 </para> 1656 1657 <para> 1658 1.8.1. "Licensable" means having the right to grant, to the 1659 maximum extent possible, whether at the time of the initial 1660 grant or subsequently acquired, any and all of the rights 1661 conveyed herein. 1662 </para> 1663 1664 <para> 1665 1.9. "Modifications" means any addition to or deletion from the 1666 substance or structure of either the Original Code or any 1667 previous Modifications. When Covered Code is released as a 1668 series of files, a Modification is: 1669 </para> 1670 1671 <para> 1672 A. Any addition to or deletion from the contents of a file 1673 containing Original Code or previous Modifications. 1674 </para> 1675 1676 <para> 1677 B. Any new file that contains any part of the Original Code or 1678 previous Modifications. 1679 </para> 1680 1681 <para> 1682 1.10. "Original Code" means Source Code of computer software 1683 code which is described in the Source Code notice required by 1684 Exhibit A as Original Code, and which, at the time of its 1685 release under this License is not already Covered Code governed 1686 by this License. 1687 </para> 1688 1689 <para> 1690 1.10.1. "Patent Claims" means any patent claim(s), now owned or 1691 hereafter acquired, including without limitation, method, 1692 process, and apparatus claims, in any patent Licensable by 1693 grantor. 1694 </para> 1695 1696 <para> 1697 1.11. "Source Code" means the preferred form of the Covered Code 1698 for making modifications to it, including all modules it 1699 contains, plus any associated interface definition files, 1700 scripts used to control compilation and installation of an 1701 Executable, or source code differential comparisons against 1702 either the Original Code or another well known, available 1703 Covered Code of the Contributor's choice. The Source Code can be 1704 in a compressed or archival form, provided the appropriate 1705 decompression or de-archiving software is widely available for 1706 no charge. 1707 </para> 1708 1709 <para> 1710 1.12. "You" (or "Your") means an individual or a legal entity 1711 exercising rights under, and complying with all of the terms of, 1712 this License or a future version of this License issued under 1713 Section 6.1. For legal entities, "You" includes any entity which 1714 controls, is controlled by, or is under common control with You. 1715 For purposes of this definition, "control" means (a) the power, 1716 direct or indirect, to cause the direction or management of such 1717 entity, whether by contract or otherwise, or (b) ownership of 1718 more than fifty percent (50%) of the outstanding shares or 1719 beneficial ownership of such entity. 1720 </para> 1721 1722 <para> 1723 2. Source Code License. 1724 </para> 1725 1726 <para> 1727 2.1. The Initial Developer Grant. The Initial Developer hereby 1728 grants You a world-wide, royalty-free, non-exclusive license, 1729 subject to third party intellectual property claims: 1730 </para> 1731 1732 <para> 1733 (a) under intellectual property rights (other than patent or 1734 trademark) Licensable by Initial Developer to use, reproduce, 1735 modify, display, perform, sublicense and distribute the Original 1736 Code (or portions thereof) with or without Modifications, and/or 1737 as part of a Larger Work; and 1738 </para> 1739 1740 <para> 1741 (b) under Patents Claims infringed by the making, using or 1742 selling of Original Code, to make, have made, use, practice, 1743 sell, and offer for sale, and/or otherwise dispose of the 1744 Original Code (or portions thereof). 1745 </para> 1746 1747 <para> 1748 (c) the licenses granted in this Section 2.1(a) and (b) are 1749 effective on the date Initial Developer first distributes 1750 Original Code under the terms of this License. 1751 </para> 1752 1753 <para> 1754 (d) Notwithstanding Section 2.1(b) above, no patent license is 1755 granted: 1) for code that You delete from the Original Code; 2) 1756 separate from the Original Code; or 3) for infringements caused 1757 by: i) the modification of the Original Code or ii) the 1758 combination of the Original Code with other software or devices. 1759 </para> 1760 1761 <para> 1762 2.2. Contributor Grant. Subject to third party intellectual 1763 property claims, each Contributor hereby grants You a 1764 world-wide, royalty-free, non-exclusive license 1765 </para> 1766 1767 <para> 1768 (a) under intellectual property rights (other than patent or 1769 trademark) Licensable by Contributor, to use, reproduce, modify, 1770 display, perform, sublicense and distribute the Modifications 1771 created by such Contributor (or portions thereof) either on an 1772 unmodified basis, with other Modifications, as Covered Code 1773 and/or as part of a Larger Work; and 1774 </para> 1775 1776 <para> 1777 (b) under Patent Claims infringed by the making, using, or 1778 selling of Modifications made by that Contributor either alone 1779 and/or in combination with its Contributor Version (or portions 1780 of such combination), to make, use, sell, offer for sale, have 1781 made, and/or otherwise dispose of: 1) Modifications made by that 1782 Contributor (or portions thereof); and 2) the combination of 1783 Modifications made by that Contributor with its Contributor 1784 Version (or portions of such combination). 1785 </para> 1786 1787 <para> 1788 (c) the licenses granted in Sections 2.2(a) and 2.2(b) are 1789 effective on the date Contributor first makes Commercial Use of 1790 the Covered Code. 1791 </para> 1792 1793 <para> 1794 (d) Notwithstanding Section 2.2(b) above, no patent license is 1795 granted: 1) for any code that Contributor has deleted from the 1796 Contributor Version; 2) separate from the Contributor Version; 1797 3) for infringements caused by: i) third party modifications of 1798 Contributor Version or ii) the combination of Modifications made 1799 by that Contributor with other software (except as part of the 1800 Contributor Version) or other devices; or 4) under Patent Claims 1801 infringed by Covered Code in the absence of Modifications made 1802 by that Contributor. 1803 </para> 1804 1805 <para> 1806 3. Distribution Obligations. 1807 </para> 1808 1809 <para> 1810 3.1. Application of License. The Modifications which You create 1811 or to which You contribute are governed by the terms of this 1812 License, including without limitation Section 2.2. The Source 1813 Code version of Covered Code may be distributed only under the 1814 terms of this License or a future version of this License 1815 released under Section 6.1, and You must include a copy of this 1816 License with every copy of the Source Code You distribute. You 1817 may not offer or impose any terms on any Source Code version 1818 that alters or restricts the applicable version of this License 1819 or the recipients' rights hereunder. However, You may include an 1820 additional document offering the additional rights described in 1821 Section 3.5. 1822 </para> 1823 1824 <para> 1825 3.2. Availability of Source Code. Any Modification which You 1826 create or to which You contribute must be made available in 1827 Source Code form under the terms of this License either on the 1828 same media as an Executable version or via an accepted 1829 Electronic Distribution Mechanism to anyone to whom you made an 1830 Executable version available; and if made available via 1831 Electronic Distribution Mechanism, must remain available for at 1832 least twelve (12) months after the date it initially became 1833 available, or at least six (6) months after a subsequent version 1834 of that particular Modification has been made available to such 1835 recipients. You are responsible for ensuring that the Source 1836 Code version remains available even if the Electronic 1837 Distribution Mechanism is maintained by a third party. 1838 </para> 1839 1840 <para> 1841 3.3. Description of Modifications. You must cause all Covered 1842 Code to which You contribute to contain a file documenting the 1843 changes You made to create that Covered Code and the date of any 1844 change. You must include a prominent statement that the 1845 Modification is derived, directly or indirectly, from Original 1846 Code provided by the Initial Developer and including the name of 1847 the Initial Developer in (a) the Source Code, and (b) in any 1848 notice in an Executable version or related documentation in 1849 which You describe the origin or ownership of the Covered Code. 1850 </para> 1851 1852 <para> 1853 3.4. Intellectual Property Matters 1854 </para> 1855 1856 <para> 1857 (a) Third Party Claims. If Contributor has knowledge that a 1858 license under a third party's intellectual property rights is 1859 required to exercise the rights granted by such Contributor 1860 under Sections 2.1 or 2.2, Contributor must include a text file 1861 with the Source Code distribution titled "LEGAL" which describes 1862 the claim and the party making the claim in sufficient detail 1863 that a recipient will know whom to contact. If Contributor 1864 obtains such knowledge after the Modification is made available 1865 as described in Section 3.2, Contributor shall promptly modify 1866 the LEGAL file in all copies Contributor makes available 1867 thereafter and shall take other steps (such as notifying 1868 appropriate mailing lists or newsgroups) reasonably calculated 1869 to inform those who received the Covered Code that new knowledge 1870 has been obtained. 1871 </para> 1872 1873 <para> 1874 (b) Contributor APIs. If Contributor's Modifications include an 1875 application programming interface and Contributor has knowledge 1876 of patent licenses which are reasonably necessary to implement 1877 that API, Contributor must also include this information in the 1878 LEGAL file. 1879 </para> 1880 1881 <para> 1882 3.5. Required Notices. You must duplicate the notice in Exhibit 1883 A in each file of the Source Code. If it is not possible to put 1884 such notice in a particular Source Code file due to its 1885 structure, then You must include such notice in a location (such 1886 as a relevant directory) where a user would be likely to look 1887 for such a notice. If You created one or more Modification(s) 1888 You may add your name as a Contributor to the notice described 1889 in Exhibit A. You must also duplicate this License in any 1890 documentation for the Source Code where You describe recipients' 1891 rights or ownership rights relating to Covered Code. You may 1892 choose to offer, and to charge a fee for, warranty, support, 1893 indemnity or liability obligations to one or more recipients of 1894 Covered Code. However, You may do so only on Your own behalf, 1895 and not on behalf of the Initial Developer or any Contributor. 1896 You must make it absolutely clear than any such warranty, 1897 support, indemnity or liability obligation is offered by You 1898 alone, and You hereby agree to indemnify the Initial Developer 1899 and every Contributor for any liability incurred by the Initial 1900 Developer or such Contributor as a result of warranty, support, 1901 indemnity or liability terms You offer. 1902 </para> 1903 1904 <para> 1905 3.6. Distribution of Executable Versions. You may distribute 1906 Covered Code in Executable form only if the requirements of 1907 Section 3.1-3.5 have been met for that Covered Code, and if You 1908 include a notice stating that the Source Code version of the 1909 Covered Code is available under the terms of this License, 1910 including a description of how and where You have fulfilled the 1911 obligations of Section 3.2. The notice must be conspicuously 1912 included in any notice in an Executable version, related 1913 documentation or collateral in which You describe recipients' 1914 rights relating to the Covered Code. You may distribute the 1915 Executable version of Covered Code or ownership rights under a 1916 license of Your choice, which may contain terms different from 1917 this License, provided that You are in compliance with the terms 1918 of this License and that the license for the Executable version 1919 does not attempt to limit or alter the recipient's rights in the 1920 Source Code version from the rights set forth in this License. 1921 If You distribute the Executable version under a different 1922 license You must make it absolutely clear that any terms which 1923 differ from this License are offered by You alone, not by the 1924 Initial Developer or any Contributor. You hereby agree to 1925 indemnify the Initial Developer and every Contributor for any 1926 liability incurred by the Initial Developer or such Contributor 1927 as a result of any such terms You offer. 1928 </para> 1929 1930 <para> 1931 3.7. Larger Works. You may create a Larger Work by combining 1932 Covered Code with other code not governed by the terms of this 1933 License and distribute the Larger Work as a single product. In 1934 such a case, You must make sure the requirements of this License 1935 are fulfilled for the Covered Code. 1936 </para> 1937 1938 <para> 1939 4. Inability to Comply Due to Statute or Regulation.If it is 1940 impossible for You to comply with any of the terms of this 1941 License with respect to some or all of the Covered Code due to 1942 statute, judicial order, or regulation then You must: (a) comply 1943 with the terms of this License to the maximum extent possible; 1944 and (b) describe the limitations and the code they affect. Such 1945 description must be included in the LEGAL file described in 1946 Section 3.4 and must be included with all distributions of the 1947 Source Code. Except to the extent prohibited by statute or 1948 regulation, such description must be sufficiently detailed for a 1949 recipient of ordinary skill to be able to understand it. 1950 </para> 1951 1952 <para> 1953 5. Application of this License. This License applies to code to 1954 which the Initial Developer has attached the notice in Exhibit A 1955 and to related Covered Code. 1956 </para> 1957 1958 <para> 1959 6. Versions of the License. 1960 </para> 1961 1962 <para> 1963 6.1. New Versions. Netscape Communications Corporation 1964 ("Netscape") may publish revised and/or new versions of the 1965 License from time to time. Each version will be given a 1966 distinguishing version number. 1967 </para> 1968 1969 <para> 1970 6.2. Effect of New Versions. Once Covered Code has been 1971 published under a particular version of the License, You may 1972 always continue to use it under the terms of that version. You 1973 may also choose to use such Covered Code under the terms of any 1974 subsequent version of the License published by Netscape. No one 1975 other than Netscape has the right to modify the terms applicable 1976 to Covered Code created under this License. 1977 </para> 1978 1979 <para> 1980 6.3. Derivative Works. If You create or use a modified version 1981 of this License (which you may only do in order to apply it to 1982 code which is not already Covered Code governed by this 1983 License), You must (a) rename Your license so that the phrases 1984 "Mozilla", "MOZILLAPL", "MOZPL", "Netscape", "MPL", "NPL" or any 1985 confusingly similar phrase do not appear in your license (except 1986 to note that your license differs from this License) and (b) 1987 otherwise make it clear that Your version of the license 1988 contains terms which differ from the Mozilla Public License and 1989 Netscape Public License. (Filling in the name of the Initial 1990 Developer, Original Code or Contributor in the notice described 1991 in Exhibit A shall not of themselves be deemed to be 1992 modifications of this License.) 1993 </para> 1994 1995 <para> 1996 7. DISCLAIMER OF WARRANTY. 1997 </para> 1998 1999 <para> 2000 COVERED CODE IS PROVIDED UNDER THIS LICENSE ON AN "AS IS" BASIS, 2001 WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, 2002 INCLUDING, WITHOUT LIMITATION, WARRANTIES THAT THE COVERED CODE 2003 IS FREE OF DEFECTS, MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE 2004 OR NON-INFRINGING. THE ENTIRE RISK AS TO THE QUALITY AND 2005 PERFORMANCE OF THE COVERED CODE IS WITH YOU. SHOULD ANY COVERED 2006 CODE PROVE DEFECTIVE IN ANY RESPECT, YOU (NOT THE INITIAL 2007 DEVELOPER OR ANY OTHER CONTRIBUTOR) ASSUME THE COST OF ANY 2008 NECESSARY SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER OF 2009 WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS LICENSE. NO USE 2010 OF ANY COVERED CODE IS AUTHORIZED HEREUNDER EXCEPT UNDER THIS 2011 DISCLAIMER. 2012 </para> 2013 2014 <para> 2015 8. TERMINATION. 2016 </para> 2017 2018 <para> 2019 8.1. This License and the rights granted hereunder will 2020 terminate automatically if You fail to comply with terms herein 2021 and fail to cure such breach within 30 days of becoming aware of 2022 the breach. All sublicenses to the Covered Code which are 2023 properly granted shall survive any termination of this License. 2024 Provisions which, by their nature, must remain in effect beyond 2025 the termination of this License shall survive. 2026 </para> 2027 2028 <para> 2029 8.2. If You initiate litigation by asserting a patent 2030 infringement claim (excluding declaratory judgment actions) 2031 against Initial Developer or a Contributor (the Initial 2032 Developer or Contributor against whom You file such action is 2033 referred to as "Participant") alleging that: 2034 </para> 2035 2036 <para> 2037 (a) such Participant's Contributor Version directly or 2038 indirectly infringes any patent, then any and all rights granted 2039 by such Participant to You under Sections 2.1 and/or 2.2 of this 2040 License shall, upon 60 days notice from Participant terminate 2041 prospectively, unless if within 60 days after receipt of notice 2042 You either: (i) agree in writing to pay Participant a mutually 2043 agreeable reasonable royalty for Your past and future use of 2044 Modifications made by such Participant, or (ii) withdraw Your 2045 litigation claim with respect to the Contributor Version against 2046 such Participant. If within 60 days of notice, a reasonable 2047 royalty and payment arrangement are not mutually agreed upon in 2048 writing by the parties or the litigation claim is not withdrawn, 2049 the rights granted by Participant to You under Sections 2.1 2050 and/or 2.2 automatically terminate at the expiration of the 60 2051 day notice period specified above. 2052 </para> 2053 2054 <para> 2055 (b) any software, hardware, or device, other than such 2056 Participant's Contributor Version, directly or indirectly 2057 infringes any patent, then any rights granted to You by such 2058 Participant under Sections 2.1(b) and 2.2(b) are revoked 2059 effective as of the date You first made, used, sold, 2060 distributed, or had made, Modifications made by that 2061 Participant. 2062 </para> 2063 2064 <para> 2065 8.3. If You assert a patent infringement claim against 2066 Participant alleging that such Participant's Contributor Version 2067 directly or indirectly infringes any patent where such claim is 2068 resolved (such as by license or settlement) prior to the 2069 initiation of patent infringement litigation, then the 2070 reasonable value of the licenses granted by such Participant 2071 under Sections 2.1 or 2.2 shall be taken into account in 2072 determining the amount or value of any payment or license. 2073 </para> 2074 2075 <para> 2076 8.4. In the event of termination under Sections 8.1 or 8.2 2077 above, all end user license agreements (excluding distributors 2078 and resellers) which have been validly granted by You or any 2079 distributor hereunder prior to termination shall survive 2080 termination. 2081 </para> 2082 2083 <para> 2084 9. LIMITATION OF LIABILITY. UNDER NO CIRCUMSTANCES AND UNDER NO 2085 LEGAL THEORY, WHETHER TORT (INCLUDING NEGLIGENCE), CONTRACT, OR 2086 OTHERWISE, SHALL YOU, THE INITIAL DEVELOPER, ANY OTHER 2087 CONTRIBUTOR, OR ANY DISTRIBUTOR OF COVERED CODE, OR ANY SUPPLIER 2088 OF ANY OF SUCH PARTIES, BE LIABLE TO ANY PERSON FOR ANY 2089 INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY 2090 CHARACTER INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF 2091 GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR MALFUNCTION, OR ANY 2092 AND ALL OTHER COMMERCIAL DAMAGES OR LOSSES, EVEN IF SUCH PARTY 2093 SHALL HAVE BEEN INFORMED OF THE POSSIBILITY OF SUCH DAMAGES. 2094 THIS LIMITATION OF LIABILITY SHALL NOT APPLY TO LIABILITY FOR 2095 DEATH OR PERSONAL INJURY RESULTING FROM SUCH PARTY'S NEGLIGENCE 2096 TO THE EXTENT APPLICABLE LAW PROHIBITS SUCH LIMITATION. SOME 2097 JURISDICTIONS DO NOT ALLOW THE EXCLUSION OR LIMITATION OF 2098 INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO THIS EXCLUSION AND 2099 LIMITATION MAY NOT APPLY TO YOU. 2100 </para> 2101 2102 <para> 2103 10. U.S. GOVERNMENT END USERS. The Covered Code is a "commercial 2104 item," as that term is defined in 48 C.F.R. 2.101 (Oct. 1995), 2105 consisting of "commercial computer software" and "commercial 2106 computer software documentation," as such terms are used in 48 2107 C.F.R. 12.212 (Sept. 1995). Consistent with 48 C.F.R. 12.212 and 2108 48 C.F.R. 227.7202-1 through 227.7202-4 (June 1995), all U.S. 2109 Government End Users acquire Covered Code with only those rights 2110 set forth herein. 2111 </para> 2112 2113 <para> 2114 11. MISCELLANEOUS. This License represents the complete 2115 agreement concerning subject matter hereof. If any provision of 2116 this License is held to be unenforceable, such provision shall 2117 be reformed only to the extent necessary to make it enforceable. 2118 This License shall be governed by California law provisions 2119 (except to the extent applicable law, if any, provides 2120 otherwise), excluding its conflict-of-law provisions. With 2121 respect to disputes in which at least one party is a citizen of, 2122 or an entity chartered or registered to do business in the 2123 United States of America, any litigation relating to this 2124 License shall be subject to the jurisdiction of the Federal 2125 Courts of the Northern District of California, with venue lying 2126 in Santa Clara County, California, with the losing party 2127 responsible for costs, including without limitation, court costs 2128 and reasonable attorneys' fees and expenses. The application of 2129 the United Nations Convention on Contracts for the International 2130 Sale of Goods is expressly excluded. Any law or regulation which 2131 provides that the language of a contract shall be construed 2132 against the drafter shall not apply to this License. 2133 </para> 2134 2135 <para> 2136 12. RESPONSIBILITY FOR CLAIMS. As between Initial Developer and 2137 the Contributors, each party is responsible for claims and 2138 damages arising, directly or indirectly, out of its utilization 2139 of rights under this License and You agree to work with Initial 2140 Developer and Contributors to distribute such responsibility on 2141 an equitable basis. Nothing herein is intended or shall be 2142 deemed to constitute any admission of liability. 2143 </para> 2144 2145 <para> 2146 13. MULTIPLE-LICENSED CODE. Initial Developer may designate 2147 portions of the Covered Code as "Multiple-Licensed". 2148 "Multiple-Licensed" means that the Initial Developer permits you 2149 to utilize portions of the Covered Code under Your choice of the 2150 NPL or the alternative licenses, if any, specified by the 2151 Initial Developer in the file described in Exhibit A. 2152 </para> 2153 2154 <para> 2155 EXHIBIT A -Mozilla Public License. 2156 </para> 2157 2158 <para> 2159 ``The contents of this file are subject to the Mozilla Public 2160 License Version 1.1 (the "License"); you may not use this file 2161 except in compliance with the License. You may obtain a copy of 2162 the License at http://www.mozilla.org/MPL/ 2163 </para> 2164 2165 <para> 2166 Software distributed under the License is distributed on an "AS 2167 IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or 2168 implied. See the License for the specific language governing 2169 rights and limitations under the License. 2170 </para> 2171 2172 <para> 2173 The Original Code is ______________________________________. 2174 </para> 2175 2176 <para> 2177 The Initial Developer of the Original Code is 2178 ________________________. Portions created by 2179 ______________________ are Copyright (C) ______ 2180 _______________________. All Rights Reserved. 2181 </para> 2182 2183 <para> 2184 Contributor(s): ______________________________________. 2185 </para> 2186 2187 <para> 2188 Alternatively, the contents of this file may be used under the 2189 terms of the _____ license (the "[___] License"), in which case 2190 the provisions of [______] License are applicable instead of 2191 those above. If you wish to allow use of your version of this 2192 file only under the terms of the [____] License and not to allow 2193 others to use your version of this file under the MPL, indicate 2194 your decision by deleting the provisions above and replace them 2195 with the notice and other provisions required by the [___] 2196 License. If you do not delete the provisions above, a recipient 2197 may use your version of this file under either the MPL or the 2198 [___] License." 2199 </para> 2200 2201 <para> 2202 [NOTE: The text of this Exhibit A may differ slightly from the 2203 text of the notices in the Source Code files of the Original 2204 Code. You should use the text of this Exhibit A rather than the 2205 text found in the Original Code Source Code for Your 2206 Modifications.] 2207 </para> 2208 1565 2209 </sect2> 1566 2210 1567 2211 <sect2 id="licMIT"> 2212 1568 2213 <title>MIT License</title> 1569 2214 1570 <para>Permission is hereby granted, free of charge, to any person 1571 obtaining a copy of this software and associated documentation files 1572 (the "Software"), to deal in the Software without restriction, including 1573 without limitation the rights to use, copy, modify, merge, publish, 1574 distribute, sublicense, and/or sell copies of the Software, and to 1575 permit persons to whom the Software is furnished to do so, subject to 1576 the following conditions:</para> 1577 1578 <para>The above copyright notice and this permission notice shall be 1579 included in all copies or substantial portions of the Software.</para> 1580 1581 <para>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 1582 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 1583 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 1584 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 1585 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 1586 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 1587 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</para> 2215 <para> 2216 Permission is hereby granted, free of charge, to any person 2217 obtaining a copy of this software and associated documentation 2218 files (the "Software"), to deal in the Software without 2219 restriction, including without limitation the rights to use, 2220 copy, modify, merge, publish, distribute, sublicense, and/or 2221 sell copies of the Software, and to permit persons to whom the 2222 Software is furnished to do so, subject to the following 2223 conditions: 2224 </para> 2225 2226 <para> 2227 The above copyright notice and this permission notice shall be 2228 included in all copies or substantial portions of the Software. 2229 </para> 2230 2231 <para> 2232 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 2233 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES 2234 OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 2235 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 2236 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 2237 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 2238 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 2239 OTHER DEALINGS IN THE SOFTWARE. 2240 </para> 2241 1588 2242 </sect2> 1589 2243 1590 2244 <sect2 id="licX11"> 2245 1591 2246 <title>X Consortium License (X11)</title> 1592 2247 1593 <para>Permission is hereby granted, free of charge, to any person 1594 obtaining a copy of this software and associated documentation files 1595 (the "Software"), to deal in the Software without restriction, including 1596 without limitation the rights to use, copy, modify, merge, publish, 1597 distribute, sublicense, and/or sell copies of the Software, and to 1598 permit persons to whom the Software is furnished to do so, subject to 1599 the following conditions:</para> 1600 1601 <para>The above copyright notice and this permission notice shall be 1602 included in all copies or substantial portions of the Software.</para> 1603 1604 <para>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 1605 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 1606 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 1607 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 1608 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 1609 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 1610 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</para> 2248 <para> 2249 Permission is hereby granted, free of charge, to any person 2250 obtaining a copy of this software and associated documentation 2251 files (the "Software"), to deal in the Software without 2252 restriction, including without limitation the rights to use, 2253 copy, modify, merge, publish, distribute, sublicense, and/or 2254 sell copies of the Software, and to permit persons to whom the 2255 Software is furnished to do so, subject to the following 2256 conditions: 2257 </para> 2258 2259 <para> 2260 The above copyright notice and this permission notice shall be 2261 included in all copies or substantial portions of the Software. 2262 </para> 2263 2264 <para> 2265 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 2266 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES 2267 OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 2268 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 2269 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 2270 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 2271 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 2272 OTHER DEALINGS IN THE SOFTWARE. 2273 </para> 2274 1611 2275 </sect2> 1612 2276 1613 2277 <sect2 id="licZLIB"> 2278 1614 2279 <title>zlib License</title> 1615 2280 1616 <para>This software is provided 'as-is', without any express or implied 1617 warranty. In no event will the authors be held liable for any damages 1618 arising from the use of this software.</para> 1619 1620 <para>Permission is granted to anyone to use this software for any 1621 purpose, including commercial applications, and to alter it and 1622 redistribute it freely, subject to the following restrictions:</para> 1623 1624 <para>1. The origin of this software must not be misrepresented; you 1625 must not claim that you wrote the original software. If you use this 1626 software in a product, an acknowledgment in the product documentation 1627 would be appreciated but is not required.</para> 1628 1629 <para>2. Altered source versions must be plainly marked as such, and 1630 must not be misrepresented as being the original software.</para> 1631 1632 <para>3. This notice may not be removed or altered from any source 1633 distribution.</para> 1634 1635 <screen>Jean-loup Gailly Mark Adler 2281 <para> 2282 This software is provided 'as-is', without any express or 2283 implied warranty. In no event will the authors be held liable 2284 for any damages arising from the use of this software. 2285 </para> 2286 2287 <para> 2288 Permission is granted to anyone to use this software for any 2289 purpose, including commercial applications, and to alter it and 2290 redistribute it freely, subject to the following restrictions: 2291 </para> 2292 2293 <para> 2294 1. The origin of this software must not be misrepresented; you 2295 must not claim that you wrote the original software. If you use 2296 this software in a product, an acknowledgment in the product 2297 documentation would be appreciated but is not required. 2298 </para> 2299 2300 <para> 2301 2. Altered source versions must be plainly marked as such, and 2302 must not be misrepresented as being the original software. 2303 </para> 2304 2305 <para> 2306 3. This notice may not be removed or altered from any source 2307 distribution. 2308 </para> 2309 2310 <screen>Jean-loup Gailly Mark Adler 1636 2311 [email protected] [email protected]</screen> 2312 1637 2313 </sect2> 1638 2314 1639 2315 <sect2 id="licSSL"> 2316 1640 2317 <title>OpenSSL License</title> 1641 2318 1642 <para>This package is an SSL implementation written by Eric Young 1643 ([email protected]). The implementation was written so as to conform 1644 with Netscape's SSL.</para> 1645 1646 <para>This library is free for commercial and non-commercial use as long 1647 as the following conditions are adhered to. The following conditions 1648 apply to all code found in this distribution, be it the RC4, RSA, lhash, 1649 DES, etc., code; not just the SSL code. The SSL documentation included 1650 with this distribution is covered by the same copyright terms except 1651 that the holder is Tim Hudson ([email protected]).</para> 1652 1653 <para>Copyright remains Eric Young's, and as such any Copyright notices 1654 in the code are not to be removed. If this package is used in a product, 1655 Eric Young should be given attribution as the author of the parts of the 1656 library used. This can be in the form of a textual message at program 1657 startup or in documentation (online or textual) provided with the 1658 package.</para> 1659 1660 <para>Redistribution and use in source and binary forms, with or without 1661 modification, are permitted provided that the following conditions are 1662 met:</para> 1663 1664 <para>1. Redistributions of source code must retain the copyright 1665 notice, this list of conditions and the following disclaimer.</para> 1666 1667 <para>2. Redistributions in binary form must reproduce the above 1668 copyright notice, this list of conditions and the following disclaimer 1669 in the documentation and/or other materials provided with the 1670 distribution.</para> 1671 1672 <para>3. All advertising materials mentioning features or use of this 1673 software must display the following acknowledgement: "This product 1674 includes cryptographic software written by Eric Young 1675 ([email protected])" The word 'cryptographic' can be left out if the 1676 routines from the library being used are not cryptographic related 1677 :-).</para> 1678 1679 <para>4. If you include any Windows specific code (or a derivative 1680 thereof) from the apps directory (application code) you must include an 1681 acknowledgement: "This product includes software written by Tim Hudson 1682 ([email protected])"</para> 1683 1684 <para>THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND ANY EXPRESS 1685 OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 1686 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 1687 DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR 1688 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 1689 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 1690 OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 1691 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 1692 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 1693 ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 1694 POSSIBILITY OF SUCH DAMAGE.</para> 1695 1696 <para>The licence and distribution terms for any publicly available 1697 version or derivative of this code cannot be changed. i.e. this code 1698 cannot simply be copied and put under another distribution licence 1699 [including the GNU Public Licence.]</para> 1700 </sect2> 1701 1702 <sect2 id="licSlirp"> 1703 <title>Slirp License</title> 1704 1705 <para>Copyright (c) 1995,1996 Danny Gasparovski. All rights reserved.</para> 1706 1707 <para>Redistribution and use in source and binary forms, with or without 1708 modification, are permitted provided that the following conditions are 1709 met:</para> 1710 1711 <para>1. Redistributions of source code must retain the above copyright 1712 notice, this list of conditions and the following disclaimer.</para> 1713 1714 <para>2. Redistributions in binary form must reproduce the above 1715 copyright notice, this list of conditions and the following disclaimer 1716 in the documentation and/or other materials provided with the 1717 distribution.</para> 1718 1719 <para>3. All advertising materials mentioning features or use of this 1720 software must display the following acknowledgment: This product 1721 includes software developed by Danny Gasparovski.</para> 1722 1723 <para>THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED 1724 WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 1725 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN 1726 NO EVENT SHALL DANNY GASPAROVSKI OR CONTRIBUTORS BE LIABLE FOR ANY 1727 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 1728 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 1729 OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 1730 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 1731 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 1732 ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 1733 POSSIBILITY OF SUCH DAMAGE.</para> 1734 </sect2> 1735 1736 <sect2 id="licLZF"> 1737 <title>liblzf License</title> 1738 1739 <para>Redistribution and use in source and binary forms, with or without 1740 modification, are permitted provided that the following conditions are 1741 met:</para> 1742 1743 <para>1. Redistributions of source code must retain the above copyright 1744 notice, this list of conditions and the following disclaimer.</para> 1745 1746 <para>2. Redistributions in binary form must reproduce the above 1747 copyright notice, this list of conditions and the following disclaimer 1748 in the documentation and/or other materials provided with the 1749 distribution.</para> 1750 1751 <para>3. The name of the author may not be used to endorse or promote 1752 products derived from this software without specific prior written 1753 permission.</para> 1754 1755 <para>THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS 1756 OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 1757 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 1758 DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, 1759 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 1760 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 1761 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 1762 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 1763 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 1764 ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 1765 POSSIBILITY OF SUCH DAMAGE.</para> 1766 </sect2> 1767 1768 <sect2 id="liclibping"> 1769 <title>libpng License</title> 1770 1771 <para>The PNG Reference Library is supplied "AS IS". The Contributing 1772 Authors and Group 42, Inc. disclaim all warranties, expressed or 1773 implied, including, without limitation, the warranties of 1774 merchantability and of fitness for any purpose. The Contributing Authors 1775 and Group 42, Inc. assume no liability for direct, indirect, incidental, 1776 special, exemplary, or consequential damages, which may result from the 1777 use of the PNG Reference Library, even if advised of the possibility of 1778 such damage.</para> 1779 1780 <para>Permission is hereby granted to use, copy, modify, and distribute 1781 this source code, or portions hereof, for any purpose, without fee, 1782 subject to the following restrictions:</para> 1783 1784 <para>1. The origin of this source code must not be 1785 misrepresented.</para> 1786 1787 <para>2. Altered versions must be plainly marked as such and must not be 1788 misrepresented as being the original source.</para> 1789 1790 <para>3. This Copyright notice may not be removed or altered from any 1791 source or altered source distribution.</para> 1792 1793 <para>The Contributing Authors and Group 42, Inc. specifically permit, 1794 without fee, and encourage the use of this source code as a component to 1795 supporting the PNG file format in commercial products. If you use this 1796 source code in a product, acknowledgment is not required but would be 1797 appreciated.</para> 1798 </sect2> 1799 1800 <sect2 id="licLWIP"> 1801 <title>lwIP License</title> 1802 1803 <para>Redistribution and use in source and binary forms, with or without 1804 modification, are permitted provided that the following conditions are 1805 met:</para> 1806 1807 <para>1. Redistributions of source code must retain the above copyright 1808 notice, this list of conditions and the following disclaimer.</para> 1809 1810 <para>2. Redistributions in binary form must reproduce the above 1811 copyright notice, this list of conditions and the following disclaimer 1812 in the documentation and/or other materials provided with the 1813 distribution.</para> 1814 1815 <para>3. The name of the author may not be used to endorse or promote 1816 products derived from this software without specific prior written 1817 permission.</para> 1818 1819 <para>THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS 1820 OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 1821 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 1822 DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, 1823 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 1824 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 1825 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 1826 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 1827 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 1828 ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 1829 POSSIBILITY OF SUCH DAMAGE.</para> 1830 </sect2> 1831 1832 <sect2 id="licLibXML"> 1833 <title>libxml License</title> 1834 1835 <para>Except where otherwise noted in the source code (e.g. the files 1836 hash.c, list.c and the trio files, which are covered by a similar 1837 licence but with different Copyright notices) all the files are:</para> 1838 1839 <para>Copyright (C) 1998-2003 Daniel Veillard. All Rights 1840 Reserved.</para> 1841 1842 <para>Permission is hereby granted, free of charge, to any person 1843 obtaining a copy of this software and associated documentation files 1844 (the "Software"), to deal in the Software without restriction, including 1845 without limitation the rights to use, copy, modify, merge, publish, 1846 distribute, sublicense, and/or sell copies of the Software, and to 1847 permit persons to whom the Software is furnished to do so, subject to 1848 the following conditions:</para> 1849 1850 <para>The above copyright notice and this permission notice shall be 1851 included in all copies or substantial portions of the Software.</para> 1852 1853 <para>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 1854 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 1855 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 1856 IN NO EVENT SHALL THE DANIEL VEILLARD BE LIABLE FOR ANY CLAIM, DAMAGES 1857 OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 1858 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 1859 OTHER DEALINGS IN THE SOFTWARE.</para> 1860 1861 <para>Except as contained in this notice, the name of Daniel Veillard 1862 shall not be used in advertising or otherwise to promote the sale, use 1863 or other dealings in this Software without prior written authorization 1864 from him.</para> 1865 </sect2> 1866 1867 <sect2 id="licLibXSLT"> 1868 <title>libxslt Licenses</title> 1869 1870 <para>Licence for libxslt except libexslt:</para> 1871 1872 <para>Copyright (C) 2001-2002 Daniel Veillard. All Rights 1873 Reserved.</para> 1874 1875 <para>Permission is hereby granted, free of charge, to any person 1876 obtaining a copy of this software and associated documentation files 1877 (the "Software"), to deal in the Software without restriction, including 1878 without limitation the rights to use, copy, modify, merge, publish, 1879 distribute, sublicense, and/or sell copies of the Software, and to 1880 permit persons to whom the Software is furnished to do so, subject to 1881 the following conditions:</para> 1882 1883 <para>The above copyright notice and this permission notice shall be 1884 included in all copies or substantial portions of the Software.</para> 1885 1886 <para>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 1887 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 1888 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 1889 IN NO EVENT SHALL THE DANIEL VEILLARD BE LIABLE FOR ANY CLAIM, DAMAGES 1890 OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 1891 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 1892 OTHER DEALINGS IN THE SOFTWARE.</para> 1893 1894 <para>Except as contained in this notice, the name of Daniel Veillard 1895 shall not be used in advertising or otherwise to promote the sale, use 1896 or other dealings in this Software without prior written authorization 1897 from him.</para> 1898 1899 <para>Licence for libexslt:</para> 1900 1901 <para>Copyright (C) 2001-2002 Thomas Broyer, Charlie Bozeman and Daniel 1902 Veillard. All Rights Reserved.</para> 1903 1904 <para>Permission is hereby granted, free of charge, to any person 1905 obtaining a copy of this software and associated documentation files 1906 (the "Software"), to deal in the Software without restriction, including 1907 without limitation the rights to use, copy, modify, merge, publish, 1908 distribute, sublicense, and/or sell copies of the Software, and to 1909 permit persons to whom the Software is furnished to do so, subject to 1910 the following conditions:</para> 1911 1912 <para>The above copyright notice and this permission notice shall be 1913 included in all copies or substantial portions of the Software.</para> 1914 1915 <para>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 1916 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 1917 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 1918 IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 1919 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 1920 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 1921 DEALINGS IN THE SOFTWARE.</para> 1922 1923 <para>Except as contained in this notice, the name of the authors shall 1924 not be used in advertising or otherwise to promote the sale, use or 1925 other dealings in this Software without prior written authorization from 1926 him.</para> 1927 </sect2> 1928 1929 <sect2 id="licgSOAP"> 1930 <title>gSOAP Public License Version 1.3a</title> 1931 1932 <para>The gSOAP public license is derived from the Mozilla Public 1933 License (MPL1.1). The sections that were deleted from the original 1934 MPL1.1 text are 1.0.1, 2.1.(c),(d), 2.2.(c),(d), 8.2.(b), 10, and 11. 1935 Section 3.8 was added. The modified sections are 2.1.(b), 2.2.(b), 3.2 1936 (simplified), 3.5 (deleted the last sentence), and 3.6 1937 (simplified).</para> 1938 1939 <para>1 DEFINITIONS</para> 1940 1941 <para>1.1. "Contributor" means each entity that creates or contributes 1942 to the creation of Modifications.</para> 1943 1944 <para>1.2. "Contributor Version" means the combination of the Original 1945 Code, prior Modifications used by a Contributor, and the Modifications 1946 made by that particular Contributor.</para> 1947 1948 <para>1.3. "Covered Code" means the Original Code, or Modifications or 1949 the combination of the Original Code, and Modifications, in each case 1950 including portions thereof.</para> 1951 1952 <para>1.4. "Electronic Distribution Mechanism" means a mechanism 1953 generally accepted in the software development community for the 1954 electronic transfer of data.</para> 1955 1956 <para>1.5. "Executable" means Covered Code in any form other than Source 1957 Code.</para> 1958 1959 <para>1.6. "Initial Developer" means the individual or entity identified 1960 as the Initial Developer in the Source Code notice required by Exhibit 1961 A.</para> 1962 1963 <para>1.7. "Larger Work" means a work which combines Covered Code or 1964 portions thereof with code not governed by the terms of this 1965 License.</para> 1966 1967 <para>1.8. "License" means this document.</para> 1968 1969 <para>1.8.1. "Licensable" means having the right to grant, to the 1970 maximum extent possible, whether at the time of the initial grant or 1971 subsequently acquired, any and all of the rights conveyed herein.</para> 1972 1973 <para>1.9. "Modifications" means any addition to or deletion from the 1974 substance or structure of either the Original Code or any previous 1975 Modifications. When Covered Code is released as a series of files, a 1976 Modification is:</para> 1977 1978 <para>A. Any addition to or deletion from the contents of a file 1979 containing Original Code or previous Modifications.</para> 1980 1981 <para>B. Any new file that contains any part of the Original Code, or 1982 previous Modifications.</para> 1983 1984 <para>1.10. "Original Code" means Source Code of computer software code 1985 which is described in the Source Code notice required by Exhibit A as 1986 Original Code, and which, at the time of its release under this License 1987 is not already Covered Code governed by this License.</para> 1988 1989 <para>1.10.1. "Patent Claims" means any patent claim(s), now owned or 1990 hereafter acquired, including without limitation, method, process, and 1991 apparatus claims, in any patent Licensable by grantor.</para> 1992 1993 <para>1.11. "Source Code" means the preferred form of the Covered Code 1994 for making modifications to it, including all modules it contains, plus 1995 any associated interface definition files, scripts used to control 1996 compilation and installation of an Executable, or source code 1997 differential comparisons against either the Original Code or another 1998 well known, available Covered Code of the Contributor's choice. The 1999 Source Code can be in a compressed or archival form, provided the 2000 appropriate decompression or de-archiving software is widely available 2001 for no charge.</para> 2002 2003 <para>1.12. "You" (or "Your") means an individual or a legal entity 2004 exercising rights under, and complying with all of the terms of, this 2005 License or a future version of this License issued under Section 6.1. 2006 For legal entities, "You" includes any entity which controls, is 2007 controlled by, or is under common control with You. For purposes of this 2008 definition, "control" means (a) the power, direct or indirect, to cause 2009 the direction or management of such entity, whether by contract or 2010 otherwise, or (b) ownership of more than fifty percent (50%) of the 2011 outstanding shares or beneficial ownership of such entity.</para> 2012 2013 <para>2 SOURCE CODE LICENSE.</para> 2014 2015 <para>2.1. The Initial Developer Grant.</para> 2016 2017 <para>The Initial Developer hereby grants You a world-wide, 2018 royalty-free, non-exclusive license, subject to third party intellectual 2019 property claims:</para> 2020 2021 <para>(a) under intellectual property rights (other than patent or 2022 trademark) Licensable by Initial Developer to use, reproduce, modify, 2023 display, perform, sublicense and distribute the Original Code (or 2024 portions thereof) with or without Modifications, and/or as part of a 2025 Larger Work; and</para> 2026 2027 <para>(b) under patents now or hereafter owned or controlled by Initial 2028 Developer, to make, have made, use and sell ("offer to sell and import") 2029 the Original Code, Modifications, or portions thereof, but solely to the 2030 extent that any such patent is reasonably necessary to enable You to 2031 utilize, alone or in combination with other software, the Original Code, 2032 Modifications, or any combination or portions thereof.</para> 2033 2034 <para>(c)</para> 2035 2036 <para>(d)</para> 2037 2038 <para>2.2. Contributor Grant.</para> 2039 2040 <para>Subject to third party intellectual property claims, each 2041 Contributor hereby grants You a world-wide, royalty-free, non-exclusive 2042 license</para> 2043 2044 <para>(a) under intellectual property rights (other than patent or 2045 trademark) Licensable by Contributor, to use, reproduce, modify, 2046 display, perform, sublicense and distribute the Modifications created by 2047 such Contributor (or portions thereof) either on an unmodified basis, 2048 with other Modifications, as Covered Code and/or as part of a Larger 2049 Work; and</para> 2050 2051 <para>(b) under patents now or hereafter owned or controlled by 2052 Contributor, to make, have made, use and sell ("offer to sell and 2053 import") the Contributor Version (or portions thereof), but solely to 2054 the extent that any such patent is reasonably necessary to enable You to 2055 utilize, alone or in combination with other software, the Contributor 2056 Version (or portions thereof).</para> 2057 2058 <para>(c)</para> 2059 2060 <para>(d)</para> 2061 2062 <para>3 DISTRIBUTION OBLIGATIONS.</para> 2063 2064 <para>3.1. Application of License.</para> 2065 2066 <para>The Modifications which You create or to which You contribute are 2067 governed by the terms of this License, including without limitation 2068 Section 2.2. The Source Code version of Covered Code may be distributed 2069 only under the terms of this License or a future version of this License 2070 released under Section 6.1, and You must include a copy of this License 2071 with every copy of the Source Code You distribute. You may not offer or 2072 impose any terms on any Source Code version that alters or restricts the 2073 applicable version of this License or the recipients' rights hereunder. 2074 However, You may include an additional document offering the additional 2075 rights described in Section 3.5.</para> 2076 2077 <para>3.2. Availability of Source Code.</para> 2078 2079 <para>Any Modification created by You will be provided to the Initial 2080 Developer in Source Code form and are subject to the terms of the 2081 License. 3.3. Description of Modifications.</para> 2082 2083 <para>You must cause all Covered Code to which You contribute to contain 2084 a file documenting the changes You made to create that Covered Code and 2085 the date of any change. You must include a prominent statement that the 2086 Modification is derived, directly or indirectly, from Original Code 2087 provided by the Initial Developer and including the name of the Initial 2088 Developer in (a) the Source Code, and (b) in any notice in an Executable 2089 version or related documentation in which You describe the origin or 2090 ownership of the Covered Code.</para> 2091 2092 <para>3.4. Intellectual Property Matters.</para> 2093 2094 <para>(a) Third Party Claims. If Contributor has knowledge that a 2095 license under a third party's intellectual property rights is required 2096 to exercise the rights granted by such Contributor under Sections 2.1 or 2097 2.2, Contributor must include a text file with the Source Code 2098 distribution titled "LEGAL" which describes the claim and the party 2099 making the claim in sufficient detail that a recipient will know whom to 2100 contact. If Contributor obtains such knowledge after the Modification is 2101 made available as described in Section 3.2, Contributor shall promptly 2102 modify the LEGAL file in all copies Contributor makes available 2103 thereafter and shall take other steps (such as notifying appropriate 2104 mailing lists or newsgroups) reasonably calculated to inform those who 2105 received the Covered Code that new knowledge has been obtained.</para> 2106 2107 <para>(b) Contributor APIs. If Contributor's Modifications include an 2108 application programming interface and Contributor has knowledge of 2109 patent licenses which are reasonably necessary to implement that API, 2110 Contributor must also include this information in the LEGAL file.</para> 2111 2112 <para>(c) Representations. Contributor represents that, except as 2113 disclosed pursuant to Section 3.4(a) above, Contributor believes that 2114 Contributor's Modifications are Contributor's original creation(s) 2115 and/or Contributor has sufficient rights to grant the rights conveyed by 2116 this License.</para> 2117 2118 <para>3.5. Required Notices. You must duplicate the notice in Exhibit A 2119 in each file of the Source Code. If it is not possible to put such 2120 notice in a particular Source Code file due to its structure, then You 2121 must include such notice in a location (such as a relevant directory) 2122 where a user would be likely to look for such a notice. If You created 2123 one or more Modification(s) You may add your name as a Contributor to 2124 the notice described in Exhibit A. You must also duplicate this License 2125 in any documentation for the Source Code where You describe recipients' 2126 rights or ownership rights relating to Covered Code. You may choose to 2127 offer, and to charge a fee for, warranty, support, indemnity or 2128 liability obligations to one or more recipients of Covered Code. 2129 However, You may do so only on Your own behalf, and not on behalf of the 2130 Initial Developer or any Contributor.</para> 2131 2132 <para>3.6. Distribution of Executable Versions. You may distribute 2133 Covered Code in Executable form only if the requirements of Section 2134 3.1-3.5 have been met for that Covered Code. You may distribute the 2135 Executable version of Covered Code or ownership rights under a license 2136 of Your choice, which may contain terms different from this License, 2137 provided that You are in compliance with the terms of this License and 2138 that the license for the Executable version does not attempt to limit or 2139 alter the recipient's rights in the Source Code version from the rights 2140 set forth in this License. If You distribute the Executable version 2141 under a different license You must make it absolutely clear that any 2142 terms which differ from this License are offered by You alone, not by 2143 the Initial Developer or any Contributor. If you distribute executable 2144 versions containing Covered Code as part of a product, you must 2145 reproduce the notice in Exhibit B in the documentation and/or other 2146 materials provided with the product.</para> 2147 2148 <para>3.7. Larger Works. You may create a Larger Work by combining 2149 Covered Code with other code not governed by the terms of this License 2150 and distribute the Larger Work as a single product. In such a case, You 2151 must make sure the requirements of this License are fulfilled for the 2152 Covered Code.</para> 2153 2154 <para>3.8. Restrictions. You may not remove any product identification, 2155 copyright, proprietary notices or labels from gSOAP.</para> 2156 2157 <para>4 INABILITY TO COMPLY DUE TO STATUTE OR REGULATION.</para> 2158 2159 <para>If it is impossible for You to comply with any of the terms of 2160 this License with respect to some or all of the Covered Code due to 2161 statute, judicial order, or regulation then You must: (a) comply with 2162 the terms of this License to the maximum extent possible; and (b) 2163 describe the limitations and the code they affect. Such description must 2164 be included in the LEGAL file described in Section 3.4 and must be 2165 included with all distributions of the Source Code. Except to the extent 2166 prohibited by statute or regulation, such description must be 2167 sufficiently detailed for a recipient of ordinary skill to be able to 2168 understand it.</para> 2169 2170 <para>5 APPLICATION OF THIS LICENSE.</para> 2171 2172 <para>This License applies to code to which the Initial Developer has 2173 attached the notice in Exhibit A and to related Covered Code.</para> 2174 2175 <para>6 VERSIONS OF THE LICENSE.</para> 2176 2177 <para>6.1. New Versions.</para> 2178 2179 <para>Grantor may publish revised and/or new versions of the License 2180 from time to time. Each version will be given a distinguishing version 2181 number.</para> 2182 2183 <para>6.2. Effect of New Versions.</para> 2184 2185 <para>Once Covered Code has been published under a particular version of 2186 the License, You may always continue to use it under the terms of that 2187 version. You may also choose to use such Covered Code under the terms of 2188 any subsequent version of the License.</para> 2189 2190 <para>6.3. Derivative Works.</para> 2191 2192 <para>If You create or use a modified version of this License (which you 2193 may only do in order to apply it to code which is not already Covered 2194 Code governed by this License), You must (a) rename Your license so that 2195 the phrase "gSOAP" or any confusingly similar phrase do not appear in 2196 your license (except to note that your license differs from this 2197 License) and (b) otherwise make it clear that Your version of the 2198 license contains terms which differ from the gSOAP Public License. 2199 (Filling in the name of the Initial Developer, Original Code or 2200 Contributor in the notice described in Exhibit A shall not of themselves 2201 be deemed to be modifications of this License.)</para> 2202 2203 <para>7 DISCLAIMER OF WARRANTY.</para> 2204 2205 <para>COVERED CODE IS PROVIDED UNDER THIS LICENSE ON AN "AS IS" BASIS, 2206 WITHOUT WARRANTY OF ANY KIND, WHETHER EXPRESS, IMPLIED OR STATUTORY, 2207 INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF 2208 MERCHANTABILITY, OF FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT OF 2209 THIRD PARTY INTELLECTUAL PROPERTY RIGHTS, AND ANY WARRANTY THAT MAY 2210 ARISE BY REASON OF TRADE USAGE, CUSTOM, OR COURSE OF DEALING. WITHOUT 2211 LIMITING THE FOREGOING, YOU ACKNOWLEDGE THAT THE SOFTWARE IS PROVIDED 2212 "AS IS" AND THAT THE AUTHORS DO NOT WARRANT THE SOFTWARE WILL RUN 2213 UNINTERRUPTED OR ERROR FREE. LIMITED LIABILITY THE ENTIRE RISK AS TO 2214 RESULTS AND PERFORMANCE OF THE SOFTWARE IS ASSUMED BY YOU. UNDER NO 2215 CIRCUMSTANCES WILL THE AUTHORS BE LIABLE FOR ANY SPECIAL, INDIRECT, 2216 INCIDENTAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES OF ANY KIND OR NATURE 2217 WHATSOEVER, WHETHER BASED ON CONTRACT, WARRANTY, TORT (INCLUDING 2218 NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, ARISING OUT OF OR IN ANY WAY 2219 RELATED TO THE SOFTWARE, EVEN IF THE AUTHORS HAVE BEEN ADVISED ON THE 2220 POSSIBILITY OF SUCH DAMAGE OR IF SUCH DAMAGE COULD HAVE BEEN REASONABLY 2221 FORESEEN, AND NOTWITHSTANDING ANY FAILURE OF ESSENTIAL PURPOSE OF ANY 2222 EXCLUSIVE REMEDY PROVIDED. SUCH LIMITATION ON DAMAGES INCLUDES, BUT IS 2223 NOT LIMITED TO, DAMAGES FOR LOSS OF GOODWILL, LOST PROFITS, LOSS OF DATA 2224 OR SOFTWARE, WORK STOPPAGE, COMPUTER FAILURE OR MALFUNCTION OR 2225 IMPAIRMENT OF OTHER GOODS. IN NO EVENT WILL THE AUTHORS BE LIABLE FOR 2226 THE COSTS OF PROCUREMENT OF SUBSTITUTE SOFTWARE OR SERVICES. YOU 2227 ACKNOWLEDGE THAT THIS SOFTWARE IS NOT DESIGNED FOR USE IN ON-LINE 2228 EQUIPMENT IN HAZARDOUS ENVIRONMENTS SUCH AS OPERATION OF NUCLEAR 2229 FACILITIES, AIRCRAFT NAVIGATION OR CONTROL, OR LIFE-CRITICAL 2230 APPLICATIONS. THE AUTHORS EXPRESSLY DISCLAIM ANY LIABILITY RESULTING 2231 FROM USE OF THE SOFTWARE IN ANY SUCH ON-LINE EQUIPMENT IN HAZARDOUS 2232 ENVIRONMENTS AND ACCEPTS NO LIABILITY IN RESPECT OF ANY ACTIONS OR 2233 CLAIMS BASED ON THE USE OF THE SOFTWARE IN ANY SUCH ON-LINE EQUIPMENT IN 2234 HAZARDOUS ENVIRONMENTS BY YOU. FOR PURPOSES OF THIS PARAGRAPH, THE TERM 2235 "LIFE-CRITICAL APPLICATION" MEANS AN APPLICATION IN WHICH THE 2236 FUNCTIONING OR MALFUNCTIONING OF THE SOFTWARE MAY RESULT DIRECTLY OR 2237 INDIRECTLY IN PHYSICAL INJURY OR LOSS OF HUMAN LIFE. THIS DISCLAIMER OF 2238 WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS LICENSE. NO USE OF ANY 2239 COVERED CODE IS AUTHORIZED HEREUNDER EXCEPT UNDER THIS 2240 DISCLAIMER.</para> 2241 2242 <para>8 TERMINATION.</para> 2243 2244 <para>8.1.</para> 2245 2246 <para>This License and the rights granted hereunder will terminate 2247 automatically if You fail to comply with terms herein and fail to cure 2248 such breach within 30 days of becoming aware of the breach. All 2249 sublicenses to the Covered Code which are properly granted shall survive 2250 any termination of this License. Provisions which, by their nature, must 2251 remain in effect beyond the termination of this License shall 2252 survive.</para> 2253 2254 <para>8.2.</para> 2255 2256 <para>8.3.</para> 2257 2258 <para>If You assert a patent infringement claim against Participant 2259 alleging that such Participant's Contributor Version directly or 2260 indirectly infringes any patent where such claim is resolved (such as by 2261 license or settlement) prior to the initiation of patent infringement 2262 litigation, then the reasonable value of the licenses granted by such 2263 Participant under Sections 2.1 or 2.2 shall be taken into account in 2264 determining the amount or value of any payment or license.</para> 2265 2266 <para>8.4. In the event of termination under Sections 8.1 or 8.2 above, 2267 all end user license agreements (excluding distributors and resellers) 2268 which have been validly granted by You or any distributor hereunder 2269 prior to termination shall survive termination.</para> 2270 2271 <para>9 LIMITATION OF LIABILITY.</para> 2272 2273 <para>UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY, WHETHER TORT 2274 (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE, SHALL YOU, THE INITIAL 2275 DEVELOPER, ANY OTHER CONTRIBUTOR, OR ANY DISTRIBUTOR OF COVERED CODE, OR 2276 ANY SUPPLIER OF ANY OF SUCH PARTIES, BE LIABLE TO ANY PERSON FOR ANY 2277 INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY CHARACTER 2278 INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF GOODWILL, WORK 2279 STOPPAGE, COMPUTER FAILURE OR MALFUNCTION, OR ANY AND ALL OTHER 2280 COMMERCIAL DAMAGES OR LOSSES, EVEN IF SUCH PARTY SHALL HAVE BEEN 2281 INFORMED OF THE POSSIBILITY OF SUCH DAMAGES. THIS LIMITATION OF 2282 LIABILITY SHALL NOT APPLY TO LIABILITY FOR DEATH OR PERSONAL INJURY 2283 RESULTING FROM SUCH PARTY'S NEGLIGENCE TO THE EXTENT APPLICABLE LAW 2284 PROHIBITS SUCH LIMITATION. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION 2285 OR LIMITATION OF INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO THIS EXCLUSION 2286 AND LIMITATION MAY NOT APPLY TO YOU.</para> 2287 2288 <para>10 U.S. GOVERNMENT END USERS.</para> 2289 2290 <para>11 MISCELLANEOUS.</para> 2291 2292 <para>12 RESPONSIBILITY FOR CLAIMS.</para> 2293 2294 <para>As between Initial Developer and the Contributors, each party is 2295 responsible for claims and damages arising, directly or indirectly, out 2296 of its utilization of rights under this License and You agree to work 2297 with Initial Developer and Contributors to distribute such 2298 responsibility on an equitable basis. Nothing herein is intended or 2299 shall be deemed to constitute any admission of liability.</para> 2300 2301 <para>EXHIBIT A.</para> 2302 2303 <para>"The contents of this file are subject to the gSOAP Public License 2304 Version 1.3 (the "License"); you may not use this file except in 2305 compliance with the License. You may obtain a copy of the License at 2306 <ulink 2307 url="http://www.cs.fsu.edu/~engelen/soaplicense.html">http://www.cs.fsu.edu/~engelen/soaplicense.html</ulink>. 2308 Software distributed under the License is distributed on an "AS IS" 2309 basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the 2310 License for the specific language governing rights and limitations under 2311 the License.</para> 2312 2313 <para>The Original Code of the gSOAP Software is: stdsoap.h, stdsoap2.h, 2314 stdsoap.c, stdsoap2.c, stdsoap.cpp, stdsoap2.cpp, soapcpp2.h, 2315 soapcpp2.c, soapcpp2_lex.l, soapcpp2_yacc.y, error2.h, error2.c, 2316 symbol2.c, init2.c, soapdoc2.html, and soapdoc2.pdf, httpget.h, 2317 httpget.c, stl.h, stldeque.h, stllist.h, stlvector.h, stlset.h.</para> 2318 2319 <para>The Initial Developer of the Original Code is Robert A. van 2320 Engelen. Portions created by Robert A. van Engelen are Copyright (C) 2321 2001-2004 Robert A. van Engelen, Genivia inc. All Rights 2322 Reserved.</para> 2323 2324 <para>Contributor(s): "________________________." [Note: The text of 2325 this Exhibit A may differ slightly form the text of the notices in the 2326 Source Code files of the Original code. You should use the text of this 2327 Exhibit A rather than the text found in the Original Code Source Code 2328 for Your Modifications.]</para> 2329 2330 <para>EXHIBIT B.</para> 2331 2332 <para>"Part of the software embedded in this product is gSOAP software. 2333 Portions created by gSOAP are Copyright (C) 2001-2004 Robert A. van 2334 Engelen, Genivia inc. All Rights Reserved. THE SOFTWARE IN THIS PRODUCT 2335 WAS IN PART PROVIDED BY GENIVIA INC AND ANY EXPRESS OR IMPLIED 2336 WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 2337 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN 2338 NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 2339 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 2340 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 2341 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON 2342 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2343 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 2344 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 2345 DAMAGE."</para> 2346 </sect2> 2347 2348 <sect2 id="licChromium"> 2349 <title>Chromium Licenses</title> 2350 2351 <sect3> 2352 <title>Main License</title> 2353 2354 <para>Copyright (c) 2002, Stanford University All rights 2355 reserved.</para> 2356 2357 <para>Some portions of Chromium are copyrighted by individiual 2358 organizations. Please see the files COPYRIGHT.LLNL and 2359 COPYRIGHT.REDHAT for more information.</para> 2360 2361 <para>Redistribution and use in source and binary forms, with or 2319 <para> 2320 This package is an SSL implementation written by Eric Young 2321 ([email protected]). The implementation was written so as to 2322 conform with Netscape's SSL. 2323 </para> 2324 2325 <para> 2326 This library is free for commercial and non-commercial use as 2327 long as the following conditions are adhered to. The following 2328 conditions apply to all code found in this distribution, be it 2329 the RC4, RSA, lhash, DES, etc., code; not just the SSL code. The 2330 SSL documentation included with this distribution is covered by 2331 the same copyright terms except that the holder is Tim Hudson 2332 ([email protected]). 2333 </para> 2334 2335 <para> 2336 Copyright remains Eric Young's, and as such any Copyright 2337 notices in the code are not to be removed. If this package is 2338 used in a product, Eric Young should be given attribution as the 2339 author of the parts of the library used. This can be in the form 2340 of a textual message at program startup or in documentation 2341 (online or textual) provided with the package. 2342 </para> 2343 2344 <para> 2345 Redistribution and use in source and binary forms, with or 2362 2346 without modification, are permitted provided that the following 2363 conditions are met:</para> 2364 <itemizedlist> 2365 <listitem> 2366 <para>Redistributions of source code must retain the above 2367 copyright notice, this list of conditions and the following 2368 disclaimer.</para> 2369 </listitem> 2370 2371 <listitem> 2372 <para>Redistributions in binary form must reproduce the above 2373 copyright notice, this list of conditions and the following 2374 disclaimer in the documentation and/or other materials provided 2375 with the distribution.</para> 2376 </listitem> 2377 2378 <listitem> 2379 <para>Neither the name of Stanford University nor the names of 2380 its contributors may be used to endorse or promote products 2381 derived from this software without specific prior written 2382 permission.</para> 2383 </listitem> 2384 </itemizedlist> 2385 2386 <para>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 2387 CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, 2388 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 2389 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 2390 COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 2391 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 2392 BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 2393 OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 2394 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR 2395 TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE 2396 USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 2397 DAMAGE.</para> 2398 </sect3> 2399 2400 <sect3> 2401 <title>COPYRIGHT.LLNL File</title> 2402 2403 <para>This Chromium distribution contains information and code which 2404 is covered under the following notice:</para> 2405 2406 <para>Copyright (c) 2002, The Regents of the University of California. 2407 Produced at the Lawrence Livermore National Laboratory For details, 2408 contact: Randall Frank ([email protected]). UCRL-CODE-2002-058 All 2409 rights reserved.</para> 2410 2411 <para>This file is part of Chromium. For details, see accompanying 2412 documentation.</para> 2413 2414 <para>Redistribution and use in source and binary forms, with or 2415 without modification, are permitted provided that the following 2416 conditions are met:</para> 2417 2418 <para>Redistributions of source code must retain the above copyright 2419 notice, this list of conditions and the disclaimer below.</para> 2420 2421 <para>Redistributions in binary form must reproduce the above 2422 copyright notice, this list of conditions and the disclaimer (as noted 2423 below) in the documentation and/or other materials provided with the 2424 distribution.</para> 2425 2426 <para>Neither the name of the UC/LLNL nor the names of its 2427 contributors may be used to endorse or promote products derived from 2428 this software without specific prior written permission.</para> 2429 2430 <para>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 2431 CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, 2432 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 2433 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 2434 REGENTS OF THE UNIVERSITY OF CALIFORNIA, THE U.S. DEPARTMENT OF ENERGY 2347 conditions are met: 2348 </para> 2349 2350 <para> 2351 1. Redistributions of source code must retain the copyright 2352 notice, this list of conditions and the following disclaimer. 2353 </para> 2354 2355 <para> 2356 2. Redistributions in binary form must reproduce the above 2357 copyright notice, this list of conditions and the following 2358 disclaimer in the documentation and/or other materials provided 2359 with the distribution. 2360 </para> 2361 2362 <para> 2363 3. All advertising materials mentioning features or use of this 2364 software must display the following acknowledgement: "This 2365 product includes cryptographic software written by Eric Young 2366 ([email protected])" The word 'cryptographic' can be left out if 2367 the routines from the library being used are not cryptographic 2368 related :-). 2369 </para> 2370 2371 <para> 2372 4. If you include any Windows specific code (or a derivative 2373 thereof) from the apps directory (application code) you must 2374 include an acknowledgement: "This product includes software 2375 written by Tim Hudson ([email protected])" 2376 </para> 2377 2378 <para> 2379 THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND ANY 2380 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 2381 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A 2382 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR 2435 2383 OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2436 2384 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2437 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2438 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2439 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2440 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2441 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 2442 DAMAGE.</para> 2443 2444 <para>Additional BSD Notice</para> 2445 2446 <para>1. This notice is required to be provided under our contract 2447 with the U.S. Department of Energy (DOE). This work was produced at 2448 the University of California, Lawrence Livermore National Laboratory 2449 under Contract No. W-7405-ENG-48 with the DOE.</para> 2450 2451 <para>2. Neither the United States Government nor the University of 2452 California nor any of their employees, makes any warranty, express or 2453 implied, or assumes any liability or responsibility for the accuracy, 2454 completeness, or usefulness of any information, apparatus, product, or 2455 process disclosed, or represents that its use would not infringe 2456 privately-owned rights.</para> 2457 2458 <para>3. Also, reference herein to any specific commercial products, 2459 process, or services by trade name, trademark, manufacturer or 2460 otherwise does not necessarily constitute or imply its endorsement, 2461 recommendation, or favoring by the United States Government or the 2462 University of California. The views and opinions of authors expressed 2463 herein do not necessarily state or reflect those of the United States 2464 Government or the University of California, and shall not be used for 2465 advertising or product endorsement purposes.</para> 2385 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 2386 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 2387 AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2388 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 2389 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 2390 THE POSSIBILITY OF SUCH DAMAGE. 2391 </para> 2392 2393 <para> 2394 The licence and distribution terms for any publicly available 2395 version or derivative of this code cannot be changed. i.e. this 2396 code cannot simply be copied and put under another distribution 2397 licence [including the GNU Public Licence.] 2398 </para> 2399 2400 </sect2> 2401 2402 <sect2 id="licSlirp"> 2403 2404 <title>Slirp License</title> 2405 2406 <para> 2407 Copyright (c) 1995,1996 Danny Gasparovski. All rights reserved. 2408 </para> 2409 2410 <para> 2411 Redistribution and use in source and binary forms, with or 2412 without modification, are permitted provided that the following 2413 conditions are met: 2414 </para> 2415 2416 <para> 2417 1. Redistributions of source code must retain the above 2418 copyright notice, this list of conditions and the following 2419 disclaimer. 2420 </para> 2421 2422 <para> 2423 2. Redistributions in binary form must reproduce the above 2424 copyright notice, this list of conditions and the following 2425 disclaimer in the documentation and/or other materials provided 2426 with the distribution. 2427 </para> 2428 2429 <para> 2430 3. All advertising materials mentioning features or use of this 2431 software must display the following acknowledgment: This product 2432 includes software developed by Danny Gasparovski. 2433 </para> 2434 2435 <para> 2436 THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED 2437 WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 2438 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 2439 PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DANNY GASPAROVSKI OR 2440 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2441 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2442 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 2443 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 2444 AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2445 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 2446 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 2447 THE POSSIBILITY OF SUCH DAMAGE. 2448 </para> 2449 2450 </sect2> 2451 2452 <sect2 id="licLZF"> 2453 2454 <title>liblzf License</title> 2455 2456 <para> 2457 Redistribution and use in source and binary forms, with or 2458 without modification, are permitted provided that the following 2459 conditions are met: 2460 </para> 2461 2462 <para> 2463 1. Redistributions of source code must retain the above 2464 copyright notice, this list of conditions and the following 2465 disclaimer. 2466 </para> 2467 2468 <para> 2469 2. Redistributions in binary form must reproduce the above 2470 copyright notice, this list of conditions and the following 2471 disclaimer in the documentation and/or other materials provided 2472 with the distribution. 2473 </para> 2474 2475 <para> 2476 3. The name of the author may not be used to endorse or promote 2477 products derived from this software without specific prior 2478 written permission. 2479 </para> 2480 2481 <para> 2482 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY 2483 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 2484 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A 2485 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR 2486 BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 2487 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 2488 TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2489 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 2490 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2491 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 2492 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 2493 THE POSSIBILITY OF SUCH DAMAGE. 2494 </para> 2495 2496 </sect2> 2497 2498 <sect2 id="liclibping"> 2499 2500 <title>libpng License</title> 2501 2502 <para> 2503 The PNG Reference Library is supplied "AS IS". The Contributing 2504 Authors and Group 42, Inc. disclaim all warranties, expressed or 2505 implied, including, without limitation, the warranties of 2506 merchantability and of fitness for any purpose. The Contributing 2507 Authors and Group 42, Inc. assume no liability for direct, 2508 indirect, incidental, special, exemplary, or consequential 2509 damages, which may result from the use of the PNG Reference 2510 Library, even if advised of the possibility of such damage. 2511 </para> 2512 2513 <para> 2514 Permission is hereby granted to use, copy, modify, and 2515 distribute this source code, or portions hereof, for any 2516 purpose, without fee, subject to the following restrictions: 2517 </para> 2518 2519 <para> 2520 1. The origin of this source code must not be misrepresented. 2521 </para> 2522 2523 <para> 2524 2. Altered versions must be plainly marked as such and must not 2525 be misrepresented as being the original source. 2526 </para> 2527 2528 <para> 2529 3. This Copyright notice may not be removed or altered from any 2530 source or altered source distribution. 2531 </para> 2532 2533 <para> 2534 The Contributing Authors and Group 42, Inc. specifically permit, 2535 without fee, and encourage the use of this source code as a 2536 component to supporting the PNG file format in commercial 2537 products. If you use this source code in a product, 2538 acknowledgment is not required but would be appreciated. 2539 </para> 2540 2541 </sect2> 2542 2543 <sect2 id="licLWIP"> 2544 2545 <title>lwIP License</title> 2546 2547 <para> 2548 Redistribution and use in source and binary forms, with or 2549 without modification, are permitted provided that the following 2550 conditions are met: 2551 </para> 2552 2553 <para> 2554 1. Redistributions of source code must retain the above 2555 copyright notice, this list of conditions and the following 2556 disclaimer. 2557 </para> 2558 2559 <para> 2560 2. Redistributions in binary form must reproduce the above 2561 copyright notice, this list of conditions and the following 2562 disclaimer in the documentation and/or other materials provided 2563 with the distribution. 2564 </para> 2565 2566 <para> 2567 3. The name of the author may not be used to endorse or promote 2568 products derived from this software without specific prior 2569 written permission. 2570 </para> 2571 2572 <para> 2573 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY 2574 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 2575 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A 2576 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR 2577 BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 2578 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 2579 TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2580 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 2581 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2582 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 2583 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 2584 THE POSSIBILITY OF SUCH DAMAGE. 2585 </para> 2586 2587 </sect2> 2588 2589 <sect2 id="licLibXML"> 2590 2591 <title>libxml License</title> 2592 2593 <para> 2594 Except where otherwise noted in the source code (e.g. the files 2595 hash.c, list.c and the trio files, which are covered by a 2596 similar licence but with different Copyright notices) all the 2597 files are: 2598 </para> 2599 2600 <para> 2601 Copyright (C) 1998-2003 Daniel Veillard. All Rights Reserved. 2602 </para> 2603 2604 <para> 2605 Permission is hereby granted, free of charge, to any person 2606 obtaining a copy of this software and associated documentation 2607 files (the "Software"), to deal in the Software without 2608 restriction, including without limitation the rights to use, 2609 copy, modify, merge, publish, distribute, sublicense, and/or 2610 sell copies of the Software, and to permit persons to whom the 2611 Software is furnished to do so, subject to the following 2612 conditions: 2613 </para> 2614 2615 <para> 2616 The above copyright notice and this permission notice shall be 2617 included in all copies or substantial portions of the Software. 2618 </para> 2619 2620 <para> 2621 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 2622 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES 2623 OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 2624 NONINFRINGEMENT. IN NO EVENT SHALL THE DANIEL VEILLARD BE LIABLE 2625 FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 2626 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 2627 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 2628 SOFTWARE. 2629 </para> 2630 2631 <para> 2632 Except as contained in this notice, the name of Daniel Veillard 2633 shall not be used in advertising or otherwise to promote the 2634 sale, use or other dealings in this Software without prior 2635 written authorization from him. 2636 </para> 2637 2638 </sect2> 2639 2640 <sect2 id="licLibXSLT"> 2641 2642 <title>libxslt Licenses</title> 2643 2644 <para> 2645 Licence for libxslt except libexslt: 2646 </para> 2647 2648 <para> 2649 Copyright (C) 2001-2002 Daniel Veillard. All Rights Reserved. 2650 </para> 2651 2652 <para> 2653 Permission is hereby granted, free of charge, to any person 2654 obtaining a copy of this software and associated documentation 2655 files (the "Software"), to deal in the Software without 2656 restriction, including without limitation the rights to use, 2657 copy, modify, merge, publish, distribute, sublicense, and/or 2658 sell copies of the Software, and to permit persons to whom the 2659 Software is furnished to do so, subject to the following 2660 conditions: 2661 </para> 2662 2663 <para> 2664 The above copyright notice and this permission notice shall be 2665 included in all copies or substantial portions of the Software. 2666 </para> 2667 2668 <para> 2669 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 2670 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES 2671 OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 2672 NONINFRINGEMENT. IN NO EVENT SHALL THE DANIEL VEILLARD BE LIABLE 2673 FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 2674 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 2675 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 2676 SOFTWARE. 2677 </para> 2678 2679 <para> 2680 Except as contained in this notice, the name of Daniel Veillard 2681 shall not be used in advertising or otherwise to promote the 2682 sale, use or other dealings in this Software without prior 2683 written authorization from him. 2684 </para> 2685 2686 <para> 2687 Licence for libexslt: 2688 </para> 2689 2690 <para> 2691 Copyright (C) 2001-2002 Thomas Broyer, Charlie Bozeman and 2692 Daniel Veillard. All Rights Reserved. 2693 </para> 2694 2695 <para> 2696 Permission is hereby granted, free of charge, to any person 2697 obtaining a copy of this software and associated documentation 2698 files (the "Software"), to deal in the Software without 2699 restriction, including without limitation the rights to use, 2700 copy, modify, merge, publish, distribute, sublicense, and/or 2701 sell copies of the Software, and to permit persons to whom the 2702 Software is furnished to do so, subject to the following 2703 conditions: 2704 </para> 2705 2706 <para> 2707 The above copyright notice and this permission notice shall be 2708 included in all copies or substantial portions of the Software. 2709 </para> 2710 2711 <para> 2712 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 2713 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES 2714 OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 2715 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY 2716 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF 2717 CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 2718 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 2719 SOFTWARE. 2720 </para> 2721 2722 <para> 2723 Except as contained in this notice, the name of the authors 2724 shall not be used in advertising or otherwise to promote the 2725 sale, use or other dealings in this Software without prior 2726 written authorization from him. 2727 </para> 2728 2729 </sect2> 2730 2731 <sect2 id="licgSOAP"> 2732 2733 <title>gSOAP Public License Version 1.3a</title> 2734 2735 <para> 2736 The gSOAP public license is derived from the Mozilla Public 2737 License (MPL1.1). The sections that were deleted from the 2738 original MPL1.1 text are 1.0.1, 2.1.(c),(d), 2.2.(c),(d), 2739 8.2.(b), 10, and 11. Section 3.8 was added. The modified 2740 sections are 2.1.(b), 2.2.(b), 3.2 (simplified), 3.5 (deleted 2741 the last sentence), and 3.6 (simplified). 2742 </para> 2743 2744 <para> 2745 1 DEFINITIONS 2746 </para> 2747 2748 <para> 2749 1.1. "Contributor" means each entity that creates or contributes 2750 to the creation of Modifications. 2751 </para> 2752 2753 <para> 2754 1.2. "Contributor Version" means the combination of the Original 2755 Code, prior Modifications used by a Contributor, and the 2756 Modifications made by that particular Contributor. 2757 </para> 2758 2759 <para> 2760 1.3. "Covered Code" means the Original Code, or Modifications or 2761 the combination of the Original Code, and Modifications, in each 2762 case including portions thereof. 2763 </para> 2764 2765 <para> 2766 1.4. "Electronic Distribution Mechanism" means a mechanism 2767 generally accepted in the software development community for the 2768 electronic transfer of data. 2769 </para> 2770 2771 <para> 2772 1.5. "Executable" means Covered Code in any form other than 2773 Source Code. 2774 </para> 2775 2776 <para> 2777 1.6. "Initial Developer" means the individual or entity 2778 identified as the Initial Developer in the Source Code notice 2779 required by Exhibit A. 2780 </para> 2781 2782 <para> 2783 1.7. "Larger Work" means a work which combines Covered Code or 2784 portions thereof with code not governed by the terms of this 2785 License. 2786 </para> 2787 2788 <para> 2789 1.8. "License" means this document. 2790 </para> 2791 2792 <para> 2793 1.8.1. "Licensable" means having the right to grant, to the 2794 maximum extent possible, whether at the time of the initial 2795 grant or subsequently acquired, any and all of the rights 2796 conveyed herein. 2797 </para> 2798 2799 <para> 2800 1.9. "Modifications" means any addition to or deletion from the 2801 substance or structure of either the Original Code or any 2802 previous Modifications. When Covered Code is released as a 2803 series of files, a Modification is: 2804 </para> 2805 2806 <para> 2807 A. Any addition to or deletion from the contents of a file 2808 containing Original Code or previous Modifications. 2809 </para> 2810 2811 <para> 2812 B. Any new file that contains any part of the Original Code, or 2813 previous Modifications. 2814 </para> 2815 2816 <para> 2817 1.10. "Original Code" means Source Code of computer software 2818 code which is described in the Source Code notice required by 2819 Exhibit A as Original Code, and which, at the time of its 2820 release under this License is not already Covered Code governed 2821 by this License. 2822 </para> 2823 2824 <para> 2825 1.10.1. "Patent Claims" means any patent claim(s), now owned or 2826 hereafter acquired, including without limitation, method, 2827 process, and apparatus claims, in any patent Licensable by 2828 grantor. 2829 </para> 2830 2831 <para> 2832 1.11. "Source Code" means the preferred form of the Covered Code 2833 for making modifications to it, including all modules it 2834 contains, plus any associated interface definition files, 2835 scripts used to control compilation and installation of an 2836 Executable, or source code differential comparisons against 2837 either the Original Code or another well known, available 2838 Covered Code of the Contributor's choice. The Source Code can be 2839 in a compressed or archival form, provided the appropriate 2840 decompression or de-archiving software is widely available for 2841 no charge. 2842 </para> 2843 2844 <para> 2845 1.12. "You" (or "Your") means an individual or a legal entity 2846 exercising rights under, and complying with all of the terms of, 2847 this License or a future version of this License issued under 2848 Section 6.1. For legal entities, "You" includes any entity which 2849 controls, is controlled by, or is under common control with You. 2850 For purposes of this definition, "control" means (a) the power, 2851 direct or indirect, to cause the direction or management of such 2852 entity, whether by contract or otherwise, or (b) ownership of 2853 more than fifty percent (50%) of the outstanding shares or 2854 beneficial ownership of such entity. 2855 </para> 2856 2857 <para> 2858 2 SOURCE CODE LICENSE. 2859 </para> 2860 2861 <para> 2862 2.1. The Initial Developer Grant. 2863 </para> 2864 2865 <para> 2866 The Initial Developer hereby grants You a world-wide, 2867 royalty-free, non-exclusive license, subject to third party 2868 intellectual property claims: 2869 </para> 2870 2871 <para> 2872 (a) under intellectual property rights (other than patent or 2873 trademark) Licensable by Initial Developer to use, reproduce, 2874 modify, display, perform, sublicense and distribute the Original 2875 Code (or portions thereof) with or without Modifications, and/or 2876 as part of a Larger Work; and 2877 </para> 2878 2879 <para> 2880 (b) under patents now or hereafter owned or controlled by 2881 Initial Developer, to make, have made, use and sell ("offer to 2882 sell and import") the Original Code, Modifications, or portions 2883 thereof, but solely to the extent that any such patent is 2884 reasonably necessary to enable You to utilize, alone or in 2885 combination with other software, the Original Code, 2886 Modifications, or any combination or portions thereof. 2887 </para> 2888 2889 <para> 2890 (c) 2891 </para> 2892 2893 <para> 2894 (d) 2895 </para> 2896 2897 <para> 2898 2.2. Contributor Grant. 2899 </para> 2900 2901 <para> 2902 Subject to third party intellectual property claims, each 2903 Contributor hereby grants You a world-wide, royalty-free, 2904 non-exclusive license 2905 </para> 2906 2907 <para> 2908 (a) under intellectual property rights (other than patent or 2909 trademark) Licensable by Contributor, to use, reproduce, modify, 2910 display, perform, sublicense and distribute the Modifications 2911 created by such Contributor (or portions thereof) either on an 2912 unmodified basis, with other Modifications, as Covered Code 2913 and/or as part of a Larger Work; and 2914 </para> 2915 2916 <para> 2917 (b) under patents now or hereafter owned or controlled by 2918 Contributor, to make, have made, use and sell ("offer to sell 2919 and import") the Contributor Version (or portions thereof), but 2920 solely to the extent that any such patent is reasonably 2921 necessary to enable You to utilize, alone or in combination with 2922 other software, the Contributor Version (or portions thereof). 2923 </para> 2924 2925 <para> 2926 (c) 2927 </para> 2928 2929 <para> 2930 (d) 2931 </para> 2932 2933 <para> 2934 3 DISTRIBUTION OBLIGATIONS. 2935 </para> 2936 2937 <para> 2938 3.1. Application of License. 2939 </para> 2940 2941 <para> 2942 The Modifications which You create or to which You contribute 2943 are governed by the terms of this License, including without 2944 limitation Section 2.2. The Source Code version of Covered Code 2945 may be distributed only under the terms of this License or a 2946 future version of this License released under Section 6.1, and 2947 You must include a copy of this License with every copy of the 2948 Source Code You distribute. You may not offer or impose any 2949 terms on any Source Code version that alters or restricts the 2950 applicable version of this License or the recipients' rights 2951 hereunder. However, You may include an additional document 2952 offering the additional rights described in Section 3.5. 2953 </para> 2954 2955 <para> 2956 3.2. Availability of Source Code. 2957 </para> 2958 2959 <para> 2960 Any Modification created by You will be provided to the Initial 2961 Developer in Source Code form and are subject to the terms of 2962 the License. 3.3. Description of Modifications. 2963 </para> 2964 2965 <para> 2966 You must cause all Covered Code to which You contribute to 2967 contain a file documenting the changes You made to create that 2968 Covered Code and the date of any change. You must include a 2969 prominent statement that the Modification is derived, directly 2970 or indirectly, from Original Code provided by the Initial 2971 Developer and including the name of the Initial Developer in (a) 2972 the Source Code, and (b) in any notice in an Executable version 2973 or related documentation in which You describe the origin or 2974 ownership of the Covered Code. 2975 </para> 2976 2977 <para> 2978 3.4. Intellectual Property Matters. 2979 </para> 2980 2981 <para> 2982 (a) Third Party Claims. If Contributor has knowledge that a 2983 license under a third party's intellectual property rights is 2984 required to exercise the rights granted by such Contributor 2985 under Sections 2.1 or 2.2, Contributor must include a text file 2986 with the Source Code distribution titled "LEGAL" which describes 2987 the claim and the party making the claim in sufficient detail 2988 that a recipient will know whom to contact. If Contributor 2989 obtains such knowledge after the Modification is made available 2990 as described in Section 3.2, Contributor shall promptly modify 2991 the LEGAL file in all copies Contributor makes available 2992 thereafter and shall take other steps (such as notifying 2993 appropriate mailing lists or newsgroups) reasonably calculated 2994 to inform those who received the Covered Code that new knowledge 2995 has been obtained. 2996 </para> 2997 2998 <para> 2999 (b) Contributor APIs. If Contributor's Modifications include an 3000 application programming interface and Contributor has knowledge 3001 of patent licenses which are reasonably necessary to implement 3002 that API, Contributor must also include this information in the 3003 LEGAL file. 3004 </para> 3005 3006 <para> 3007 (c) Representations. Contributor represents that, except as 3008 disclosed pursuant to Section 3.4(a) above, Contributor believes 3009 that Contributor's Modifications are Contributor's original 3010 creation(s) and/or Contributor has sufficient rights to grant 3011 the rights conveyed by this License. 3012 </para> 3013 3014 <para> 3015 3.5. Required Notices. You must duplicate the notice in Exhibit 3016 A in each file of the Source Code. If it is not possible to put 3017 such notice in a particular Source Code file due to its 3018 structure, then You must include such notice in a location (such 3019 as a relevant directory) where a user would be likely to look 3020 for such a notice. If You created one or more Modification(s) 3021 You may add your name as a Contributor to the notice described 3022 in Exhibit A. You must also duplicate this License in any 3023 documentation for the Source Code where You describe recipients' 3024 rights or ownership rights relating to Covered Code. You may 3025 choose to offer, and to charge a fee for, warranty, support, 3026 indemnity or liability obligations to one or more recipients of 3027 Covered Code. However, You may do so only on Your own behalf, 3028 and not on behalf of the Initial Developer or any Contributor. 3029 </para> 3030 3031 <para> 3032 3.6. Distribution of Executable Versions. You may distribute 3033 Covered Code in Executable form only if the requirements of 3034 Section 3.1-3.5 have been met for that Covered Code. You may 3035 distribute the Executable version of Covered Code or ownership 3036 rights under a license of Your choice, which may contain terms 3037 different from this License, provided that You are in compliance 3038 with the terms of this License and that the license for the 3039 Executable version does not attempt to limit or alter the 3040 recipient's rights in the Source Code version from the rights 3041 set forth in this License. If You distribute the Executable 3042 version under a different license You must make it absolutely 3043 clear that any terms which differ from this License are offered 3044 by You alone, not by the Initial Developer or any Contributor. 3045 If you distribute executable versions containing Covered Code as 3046 part of a product, you must reproduce the notice in Exhibit B in 3047 the documentation and/or other materials provided with the 3048 product. 3049 </para> 3050 3051 <para> 3052 3.7. Larger Works. You may create a Larger Work by combining 3053 Covered Code with other code not governed by the terms of this 3054 License and distribute the Larger Work as a single product. In 3055 such a case, You must make sure the requirements of this License 3056 are fulfilled for the Covered Code. 3057 </para> 3058 3059 <para> 3060 3.8. Restrictions. You may not remove any product 3061 identification, copyright, proprietary notices or labels from 3062 gSOAP. 3063 </para> 3064 3065 <para> 3066 4 INABILITY TO COMPLY DUE TO STATUTE OR REGULATION. 3067 </para> 3068 3069 <para> 3070 If it is impossible for You to comply with any of the terms of 3071 this License with respect to some or all of the Covered Code due 3072 to statute, judicial order, or regulation then You must: (a) 3073 comply with the terms of this License to the maximum extent 3074 possible; and (b) describe the limitations and the code they 3075 affect. Such description must be included in the LEGAL file 3076 described in Section 3.4 and must be included with all 3077 distributions of the Source Code. Except to the extent 3078 prohibited by statute or regulation, such description must be 3079 sufficiently detailed for a recipient of ordinary skill to be 3080 able to understand it. 3081 </para> 3082 3083 <para> 3084 5 APPLICATION OF THIS LICENSE. 3085 </para> 3086 3087 <para> 3088 This License applies to code to which the Initial Developer has 3089 attached the notice in Exhibit A and to related Covered Code. 3090 </para> 3091 3092 <para> 3093 6 VERSIONS OF THE LICENSE. 3094 </para> 3095 3096 <para> 3097 6.1. New Versions. 3098 </para> 3099 3100 <para> 3101 Grantor may publish revised and/or new versions of the License 3102 from time to time. Each version will be given a distinguishing 3103 version number. 3104 </para> 3105 3106 <para> 3107 6.2. Effect of New Versions. 3108 </para> 3109 3110 <para> 3111 Once Covered Code has been published under a particular version 3112 of the License, You may always continue to use it under the 3113 terms of that version. You may also choose to use such Covered 3114 Code under the terms of any subsequent version of the License. 3115 </para> 3116 3117 <para> 3118 6.3. Derivative Works. 3119 </para> 3120 3121 <para> 3122 If You create or use a modified version of this License (which 3123 you may only do in order to apply it to code which is not 3124 already Covered Code governed by this License), You must (a) 3125 rename Your license so that the phrase "gSOAP" or any 3126 confusingly similar phrase do not appear in your license (except 3127 to note that your license differs from this License) and (b) 3128 otherwise make it clear that Your version of the license 3129 contains terms which differ from the gSOAP Public License. 3130 (Filling in the name of the Initial Developer, Original Code or 3131 Contributor in the notice described in Exhibit A shall not of 3132 themselves be deemed to be modifications of this License.) 3133 </para> 3134 3135 <para> 3136 7 DISCLAIMER OF WARRANTY. 3137 </para> 3138 3139 <para> 3140 COVERED CODE IS PROVIDED UNDER THIS LICENSE ON AN "AS IS" BASIS, 3141 WITHOUT WARRANTY OF ANY KIND, WHETHER EXPRESS, IMPLIED OR 3142 STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES 3143 OF MERCHANTABILITY, OF FITNESS FOR A PARTICULAR PURPOSE, 3144 NONINFRINGEMENT OF THIRD PARTY INTELLECTUAL PROPERTY RIGHTS, AND 3145 ANY WARRANTY THAT MAY ARISE BY REASON OF TRADE USAGE, CUSTOM, OR 3146 COURSE OF DEALING. WITHOUT LIMITING THE FOREGOING, YOU 3147 ACKNOWLEDGE THAT THE SOFTWARE IS PROVIDED "AS IS" AND THAT THE 3148 AUTHORS DO NOT WARRANT THE SOFTWARE WILL RUN UNINTERRUPTED OR 3149 ERROR FREE. LIMITED LIABILITY THE ENTIRE RISK AS TO RESULTS AND 3150 PERFORMANCE OF THE SOFTWARE IS ASSUMED BY YOU. UNDER NO 3151 CIRCUMSTANCES WILL THE AUTHORS BE LIABLE FOR ANY SPECIAL, 3152 INDIRECT, INCIDENTAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES OF ANY 3153 KIND OR NATURE WHATSOEVER, WHETHER BASED ON CONTRACT, WARRANTY, 3154 TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, 3155 ARISING OUT OF OR IN ANY WAY RELATED TO THE SOFTWARE, EVEN IF 3156 THE AUTHORS HAVE BEEN ADVISED ON THE POSSIBILITY OF SUCH DAMAGE 3157 OR IF SUCH DAMAGE COULD HAVE BEEN REASONABLY FORESEEN, AND 3158 NOTWITHSTANDING ANY FAILURE OF ESSENTIAL PURPOSE OF ANY 3159 EXCLUSIVE REMEDY PROVIDED. SUCH LIMITATION ON DAMAGES INCLUDES, 3160 BUT IS NOT LIMITED TO, DAMAGES FOR LOSS OF GOODWILL, LOST 3161 PROFITS, LOSS OF DATA OR SOFTWARE, WORK STOPPAGE, COMPUTER 3162 FAILURE OR MALFUNCTION OR IMPAIRMENT OF OTHER GOODS. IN NO EVENT 3163 WILL THE AUTHORS BE LIABLE FOR THE COSTS OF PROCUREMENT OF 3164 SUBSTITUTE SOFTWARE OR SERVICES. YOU ACKNOWLEDGE THAT THIS 3165 SOFTWARE IS NOT DESIGNED FOR USE IN ON-LINE EQUIPMENT IN 3166 HAZARDOUS ENVIRONMENTS SUCH AS OPERATION OF NUCLEAR FACILITIES, 3167 AIRCRAFT NAVIGATION OR CONTROL, OR LIFE-CRITICAL APPLICATIONS. 3168 THE AUTHORS EXPRESSLY DISCLAIM ANY LIABILITY RESULTING FROM USE 3169 OF THE SOFTWARE IN ANY SUCH ON-LINE EQUIPMENT IN HAZARDOUS 3170 ENVIRONMENTS AND ACCEPTS NO LIABILITY IN RESPECT OF ANY ACTIONS 3171 OR CLAIMS BASED ON THE USE OF THE SOFTWARE IN ANY SUCH ON-LINE 3172 EQUIPMENT IN HAZARDOUS ENVIRONMENTS BY YOU. FOR PURPOSES OF THIS 3173 PARAGRAPH, THE TERM "LIFE-CRITICAL APPLICATION" MEANS AN 3174 APPLICATION IN WHICH THE FUNCTIONING OR MALFUNCTIONING OF THE 3175 SOFTWARE MAY RESULT DIRECTLY OR INDIRECTLY IN PHYSICAL INJURY OR 3176 LOSS OF HUMAN LIFE. THIS DISCLAIMER OF WARRANTY CONSTITUTES AN 3177 ESSENTIAL PART OF THIS LICENSE. NO USE OF ANY COVERED CODE IS 3178 AUTHORIZED HEREUNDER EXCEPT UNDER THIS DISCLAIMER. 3179 </para> 3180 3181 <para> 3182 8 TERMINATION. 3183 </para> 3184 3185 <para> 3186 8.1. 3187 </para> 3188 3189 <para> 3190 This License and the rights granted hereunder will terminate 3191 automatically if You fail to comply with terms herein and fail 3192 to cure such breach within 30 days of becoming aware of the 3193 breach. All sublicenses to the Covered Code which are properly 3194 granted shall survive any termination of this License. 3195 Provisions which, by their nature, must remain in effect beyond 3196 the termination of this License shall survive. 3197 </para> 3198 3199 <para> 3200 8.2. 3201 </para> 3202 3203 <para> 3204 8.3. 3205 </para> 3206 3207 <para> 3208 If You assert a patent infringement claim against Participant 3209 alleging that such Participant's Contributor Version directly or 3210 indirectly infringes any patent where such claim is resolved 3211 (such as by license or settlement) prior to the initiation of 3212 patent infringement litigation, then the reasonable value of the 3213 licenses granted by such Participant under Sections 2.1 or 2.2 3214 shall be taken into account in determining the amount or value 3215 of any payment or license. 3216 </para> 3217 3218 <para> 3219 8.4. In the event of termination under Sections 8.1 or 8.2 3220 above, all end user license agreements (excluding distributors 3221 and resellers) which have been validly granted by You or any 3222 distributor hereunder prior to termination shall survive 3223 termination. 3224 </para> 3225 3226 <para> 3227 9 LIMITATION OF LIABILITY. 3228 </para> 3229 3230 <para> 3231 UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY, WHETHER TORT 3232 (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE, SHALL YOU, THE 3233 INITIAL DEVELOPER, ANY OTHER CONTRIBUTOR, OR ANY DISTRIBUTOR OF 3234 COVERED CODE, OR ANY SUPPLIER OF ANY OF SUCH PARTIES, BE LIABLE 3235 TO ANY PERSON FOR ANY INDIRECT, SPECIAL, INCIDENTAL, OR 3236 CONSEQUENTIAL DAMAGES OF ANY CHARACTER INCLUDING, WITHOUT 3237 LIMITATION, DAMAGES FOR LOSS OF GOODWILL, WORK STOPPAGE, 3238 COMPUTER FAILURE OR MALFUNCTION, OR ANY AND ALL OTHER COMMERCIAL 3239 DAMAGES OR LOSSES, EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED 3240 OF THE POSSIBILITY OF SUCH DAMAGES. THIS LIMITATION OF LIABILITY 3241 SHALL NOT APPLY TO LIABILITY FOR DEATH OR PERSONAL INJURY 3242 RESULTING FROM SUCH PARTY'S NEGLIGENCE TO THE EXTENT APPLICABLE 3243 LAW PROHIBITS SUCH LIMITATION. SOME JURISDICTIONS DO NOT ALLOW 3244 THE EXCLUSION OR LIMITATION OF INCIDENTAL OR CONSEQUENTIAL 3245 DAMAGES, SO THIS EXCLUSION AND LIMITATION MAY NOT APPLY TO YOU. 3246 </para> 3247 3248 <para> 3249 10 U.S. GOVERNMENT END USERS. 3250 </para> 3251 3252 <para> 3253 11 MISCELLANEOUS. 3254 </para> 3255 3256 <para> 3257 12 RESPONSIBILITY FOR CLAIMS. 3258 </para> 3259 3260 <para> 3261 As between Initial Developer and the Contributors, each party is 3262 responsible for claims and damages arising, directly or 3263 indirectly, out of its utilization of rights under this License 3264 and You agree to work with Initial Developer and Contributors to 3265 distribute such responsibility on an equitable basis. Nothing 3266 herein is intended or shall be deemed to constitute any 3267 admission of liability. 3268 </para> 3269 3270 <para> 3271 EXHIBIT A. 3272 </para> 3273 3274 <para> 3275 "The contents of this file are subject to the gSOAP Public 3276 License Version 1.3 (the "License"); you may not use this file 3277 except in compliance with the License. You may obtain a copy of 3278 the License at 3279 <ulink 3280 url="http://www.cs.fsu.edu/~engelen/soaplicense.html">http://www.cs.fsu.edu/~engelen/soaplicense.html</ulink>. 3281 Software distributed under the License is distributed on an "AS 3282 IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or 3283 implied. See the License for the specific language governing 3284 rights and limitations under the License. 3285 </para> 3286 3287 <para> 3288 The Original Code of the gSOAP Software is: stdsoap.h, 3289 stdsoap2.h, stdsoap.c, stdsoap2.c, stdsoap.cpp, stdsoap2.cpp, 3290 soapcpp2.h, soapcpp2.c, soapcpp2_lex.l, soapcpp2_yacc.y, 3291 error2.h, error2.c, symbol2.c, init2.c, soapdoc2.html, and 3292 soapdoc2.pdf, httpget.h, httpget.c, stl.h, stldeque.h, 3293 stllist.h, stlvector.h, stlset.h. 3294 </para> 3295 3296 <para> 3297 The Initial Developer of the Original Code is Robert A. van 3298 Engelen. Portions created by Robert A. van Engelen are Copyright 3299 (C) 2001-2004 Robert A. van Engelen, Genivia inc. All Rights 3300 Reserved. 3301 </para> 3302 3303 <para> 3304 Contributor(s): "________________________." [Note: The text of 3305 this Exhibit A may differ slightly form the text of the notices 3306 in the Source Code files of the Original code. You should use 3307 the text of this Exhibit A rather than the text found in the 3308 Original Code Source Code for Your Modifications.] 3309 </para> 3310 3311 <para> 3312 EXHIBIT B. 3313 </para> 3314 3315 <para> 3316 "Part of the software embedded in this product is gSOAP 3317 software. Portions created by gSOAP are Copyright (C) 2001-2004 3318 Robert A. van Engelen, Genivia inc. All Rights Reserved. THE 3319 SOFTWARE IN THIS PRODUCT WAS IN PART PROVIDED BY GENIVIA INC AND 3320 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 3321 TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A 3322 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR 3323 BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 3324 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 3325 TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 3326 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 3327 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 3328 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 3329 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 3330 THE POSSIBILITY OF SUCH DAMAGE." 3331 </para> 3332 3333 </sect2> 3334 3335 <sect2 id="licChromium"> 3336 3337 <title>Chromium Licenses</title> 3338 3339 <sect3> 3340 3341 <title>Main License</title> 3342 3343 <para> 3344 Copyright (c) 2002, Stanford University All rights reserved. 3345 </para> 3346 3347 <para> 3348 Some portions of Chromium are copyrighted by individiual 3349 organizations. Please see the files COPYRIGHT.LLNL and 3350 COPYRIGHT.REDHAT for more information. 3351 </para> 3352 3353 <para> 3354 Redistribution and use in source and binary forms, with or 3355 without modification, are permitted provided that the 3356 following conditions are met: 3357 </para> 3358 3359 <itemizedlist> 3360 3361 <listitem> 3362 <para> 3363 Redistributions of source code must retain the above 3364 copyright notice, this list of conditions and the 3365 following disclaimer. 3366 </para> 3367 </listitem> 3368 3369 <listitem> 3370 <para> 3371 Redistributions in binary form must reproduce the above 3372 copyright notice, this list of conditions and the 3373 following disclaimer in the documentation and/or other 3374 materials provided with the distribution. 3375 </para> 3376 </listitem> 3377 3378 <listitem> 3379 <para> 3380 Neither the name of Stanford University nor the names of 3381 its contributors may be used to endorse or promote 3382 products derived from this software without specific prior 3383 written permission. 3384 </para> 3385 </listitem> 3386 3387 </itemizedlist> 3388 3389 <para> 3390 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 3391 CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 3392 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 3393 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 3394 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 3395 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 3396 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 3397 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 3398 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 3399 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 3400 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 3401 OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 3402 EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3403 </para> 3404 2466 3405 </sect3> 2467 3406 2468 3407 <sect3> 3408 3409 <title>COPYRIGHT.LLNL File</title> 3410 3411 <para> 3412 This Chromium distribution contains information and code which 3413 is covered under the following notice: 3414 </para> 3415 3416 <para> 3417 Copyright (c) 2002, The Regents of the University of 3418 California. Produced at the Lawrence Livermore National 3419 Laboratory For details, contact: Randall Frank 3420 ([email protected]). UCRL-CODE-2002-058 All rights reserved. 3421 </para> 3422 3423 <para> 3424 This file is part of Chromium. For details, see accompanying 3425 documentation. 3426 </para> 3427 3428 <para> 3429 Redistribution and use in source and binary forms, with or 3430 without modification, are permitted provided that the 3431 following conditions are met: 3432 </para> 3433 3434 <para> 3435 Redistributions of source code must retain the above copyright 3436 notice, this list of conditions and the disclaimer below. 3437 </para> 3438 3439 <para> 3440 Redistributions in binary form must reproduce the above 3441 copyright notice, this list of conditions and the disclaimer 3442 (as noted below) in the documentation and/or other materials 3443 provided with the distribution. 3444 </para> 3445 3446 <para> 3447 Neither the name of the UC/LLNL nor the names of its 3448 contributors may be used to endorse or promote products 3449 derived from this software without specific prior written 3450 permission. 3451 </para> 3452 3453 <para> 3454 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 3455 CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 3456 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 3457 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 3458 DISCLAIMED. IN NO EVENT SHALL THE REGENTS OF THE UNIVERSITY OF 3459 CALIFORNIA, THE U.S. DEPARTMENT OF ENERGY OR CONTRIBUTORS BE 3460 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 3461 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 3462 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 3463 OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 3464 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 3465 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 3466 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 3467 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3468 </para> 3469 3470 <para> 3471 Additional BSD Notice 3472 </para> 3473 3474 <para> 3475 1. This notice is required to be provided under our contract 3476 with the U.S. Department of Energy (DOE). This work was 3477 produced at the University of California, Lawrence Livermore 3478 National Laboratory under Contract No. W-7405-ENG-48 with the 3479 DOE. 3480 </para> 3481 3482 <para> 3483 2. Neither the United States Government nor the University of 3484 California nor any of their employees, makes any warranty, 3485 express or implied, or assumes any liability or responsibility 3486 for the accuracy, completeness, or usefulness of any 3487 information, apparatus, product, or process disclosed, or 3488 represents that its use would not infringe privately-owned 3489 rights. 3490 </para> 3491 3492 <para> 3493 3. Also, reference herein to any specific commercial products, 3494 process, or services by trade name, trademark, manufacturer or 3495 otherwise does not necessarily constitute or imply its 3496 endorsement, recommendation, or favoring by the United States 3497 Government or the University of California. The views and 3498 opinions of authors expressed herein do not necessarily state 3499 or reflect those of the United States Government or the 3500 University of California, and shall not be used for 3501 advertising or product endorsement purposes. 3502 </para> 3503 3504 </sect3> 3505 3506 <sect3> 3507 2469 3508 <title>COPYRIGHT.REDHAT File</title> 2470 3509 2471 <para>This Chromium distribution contains information and code which 2472 is covered under the following notice:</para> 2473 2474 <para>Copyright 2001,2002 Red Hat Inc., Durham, North Carolina.</para> 2475 2476 <para>All Rights Reserved.</para> 2477 2478 <para>Permission is hereby granted, free of charge, to any person 2479 obtaining a copy of this software and associated documentation files 2480 (the "Software"), to deal in the Software without restriction, 2481 including without limitation on the rights to use, copy, modify, 2482 merge, publish, distribute, sublicense, and/or sell copies of the 2483 Software, and to permit persons to whom the Software is furnished to 2484 do so, subject to the following conditions:</para> 2485 2486 <para>The above copyright notice and this permission notice (including 2487 the next paragraph) shall be included in all copies or substantial 2488 portions of the Software.</para> 2489 2490 <para>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 2491 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 2492 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 2493 NON-INFRINGEMENT. IN NO EVENT SHALL RED HAT AND/OR THEIR SUPPLIERS BE 2494 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 2495 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 2496 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</para> 3510 <para> 3511 This Chromium distribution contains information and code which 3512 is covered under the following notice: 3513 </para> 3514 3515 <para> 3516 Copyright 2001,2002 Red Hat Inc., Durham, North Carolina. 3517 </para> 3518 3519 <para> 3520 All Rights Reserved. 3521 </para> 3522 3523 <para> 3524 Permission is hereby granted, free of charge, to any person 3525 obtaining a copy of this software and associated documentation 3526 files (the "Software"), to deal in the Software without 3527 restriction, including without limitation on the rights to 3528 use, copy, modify, merge, publish, distribute, sublicense, 3529 and/or sell copies of the Software, and to permit persons to 3530 whom the Software is furnished to do so, subject to the 3531 following conditions: 3532 </para> 3533 3534 <para> 3535 The above copyright notice and this permission notice 3536 (including the next paragraph) shall be included in all copies 3537 or substantial portions of the Software. 3538 </para> 3539 3540 <para> 3541 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY 3542 KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE 3543 WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR 3544 PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL RED HAT AND/OR 3545 THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 3546 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR 3547 OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 3548 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 3549 </para> 3550 2497 3551 </sect3> 3552 2498 3553 </sect2> 2499 3554 2500 3555 <sect2 id="licLibCurl"> 3556 2501 3557 <title>curl License</title> 2502 3558 2503 <para>COPYRIGHT AND PERMISSION NOTICE</para> 2504 2505 <para>Copyright (c) 1996 - 2009, Daniel Stenberg, [email protected].</para> 2506 2507 <para>All rights reserved.</para> 2508 2509 <para>Permission to use, copy, modify, and distribute this software for 2510 any purpose with or without fee is hereby granted, provided that the 2511 above copyright notice and this permission notice appear in all 2512 copies.</para> 2513 2514 <para>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 2515 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 2516 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF 2517 THIRD PARTY RIGHTS. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 2518 BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 2519 ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 2520 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 2521 SOFTWARE.</para> 2522 2523 <para>Except as contained in this notice, the name of a copyright holder 2524 shall not be used in advertising or otherwise to promote the sale, use 2525 or other dealings in this Software without prior written authorization 2526 of the copyright holder.</para> 3559 <para> 3560 COPYRIGHT AND PERMISSION NOTICE 3561 </para> 3562 3563 <para> 3564 Copyright (c) 1996 - 2009, Daniel Stenberg, [email protected]. 3565 </para> 3566 3567 <para> 3568 All rights reserved. 3569 </para> 3570 3571 <para> 3572 Permission to use, copy, modify, and distribute this software 3573 for any purpose with or without fee is hereby granted, provided 3574 that the above copyright notice and this permission notice 3575 appear in all copies. 3576 </para> 3577 3578 <para> 3579 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 3580 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES 3581 OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 3582 NONINFRINGEMENT OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE 3583 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR 3584 OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR 3585 OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 3586 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 3587 </para> 3588 3589 <para> 3590 Except as contained in this notice, the name of a copyright 3591 holder shall not be used in advertising or otherwise to promote 3592 the sale, use or other dealings in this Software without prior 3593 written authorization of the copyright holder. 3594 </para> 3595 2527 3596 </sect2> 2528 3597 2529 3598 <sect2 id="licLibgd"> 3599 2530 3600 <title>libgd License</title> 2531 3601 2532 <para>Portions copyright 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2533 2002 by Cold Spring Harbor Laboratory. Funded under Grant P41-RR02188 by 2534 the National Institutes of Health.</para> 2535 2536 <para>Portions copyright 1996, 1997, 1998, 1999, 2000, 2001, 2002 by 2537 Boutell.Com, Inc.</para> 2538 2539 <para>Portions relating to GD2 format copyright 1999, 2000, 2001, 2002 2540 Philip Warner.</para> 2541 2542 <para>Portions relating to PNG copyright 1999, 2000, 2001, 2002 Greg 2543 Roelofs.</para> 2544 2545 <para>Portions relating to gdttf.c copyright 1999, 2000, 2001, 2002 John 2546 Ellson ([email protected]).</para> 2547 2548 <para>Portions relating to gdft.c copyright 2001, 2002 John Ellson 2549 ([email protected]).</para> 2550 2551 <para>Portions copyright 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 2552 Pierre-Alain Joye ([email protected]).</para> 2553 2554 <para>Portions relating to JPEG and to color quantization copyright 2555 2000, 2001, 2002, Doug Becker and copyright (C) 1994, 1995, 1996, 1997, 2556 1998, 1999, 2000, 2001, 2002, Thomas G. Lane. This software is based in 2557 part on the work of the Independent JPEG Group. See the file 2558 README-JPEG.TXT for more information.</para> 2559 2560 <para>Portions relating to WBMP copyright 2000, 2001, 2002 Maurice 2561 Szmurlo and Johan Van den Brande.</para> 2562 2563 <para>Permission has been granted to copy, distribute and modify gd in 2564 any context without fee, including a commercial application, provided 2565 that this notice is present in user-accessible supporting 2566 documentation.</para> 2567 2568 <para>This does not affect your ownership of the derived work itself, 2569 and the intent is to assure proper credit for the authors of gd, not to 2570 interfere with your productive use of gd. If you have questions, ask. 2571 "Derived works" includes all programs that utilize the library. Credit 2572 must be given in user-accessible documentation.</para> 2573 2574 <para>This software is provided "AS IS." The copyright holders disclaim 2575 all warranties, either express or implied, including but not limited to 2576 implied warranties of merchantability and fitness for a particular 2577 purpose, with respect to this code and accompanying 2578 documentation.</para> 2579 2580 <para>Although their code does not appear in gd, the authors wish to 2581 thank David Koblas, David Rowley, and Hutchison Avenue Software 2582 Corporation for their prior contributions.</para> 3602 <para> 3603 Portions copyright 1994, 1995, 1996, 1997, 1998, 1999, 2000, 3604 2001, 2002 by Cold Spring Harbor Laboratory. Funded under Grant 3605 P41-RR02188 by the National Institutes of Health. 3606 </para> 3607 3608 <para> 3609 Portions copyright 1996, 1997, 1998, 1999, 2000, 2001, 2002 by 3610 Boutell.Com, Inc. 3611 </para> 3612 3613 <para> 3614 Portions relating to GD2 format copyright 1999, 2000, 2001, 2002 3615 Philip Warner. 3616 </para> 3617 3618 <para> 3619 Portions relating to PNG copyright 1999, 2000, 2001, 2002 Greg 3620 Roelofs. 3621 </para> 3622 3623 <para> 3624 Portions relating to gdttf.c copyright 1999, 2000, 2001, 2002 3625 John Ellson ([email protected]). 3626 </para> 3627 3628 <para> 3629 Portions relating to gdft.c copyright 2001, 2002 John Ellson 3630 ([email protected]). 3631 </para> 3632 3633 <para> 3634 Portions copyright 2000, 2001, 2002, 2003, 2004, 2005, 2006, 3635 2007 Pierre-Alain Joye ([email protected]). 3636 </para> 3637 3638 <para> 3639 Portions relating to JPEG and to color quantization copyright 3640 2000, 2001, 2002, Doug Becker and copyright (C) 1994, 1995, 3641 1996, 1997, 1998, 1999, 2000, 2001, 2002, Thomas G. Lane. This 3642 software is based in part on the work of the Independent JPEG 3643 Group. See the file README-JPEG.TXT for more information. 3644 </para> 3645 3646 <para> 3647 Portions relating to WBMP copyright 2000, 2001, 2002 Maurice 3648 Szmurlo and Johan Van den Brande. 3649 </para> 3650 3651 <para> 3652 Permission has been granted to copy, distribute and modify gd in 3653 any context without fee, including a commercial application, 3654 provided that this notice is present in user-accessible 3655 supporting documentation. 3656 </para> 3657 3658 <para> 3659 This does not affect your ownership of the derived work itself, 3660 and the intent is to assure proper credit for the authors of gd, 3661 not to interfere with your productive use of gd. If you have 3662 questions, ask. "Derived works" includes all programs that 3663 utilize the library. Credit must be given in user-accessible 3664 documentation. 3665 </para> 3666 3667 <para> 3668 This software is provided "AS IS." The copyright holders 3669 disclaim all warranties, either express or implied, including 3670 but not limited to implied warranties of merchantability and 3671 fitness for a particular purpose, with respect to this code and 3672 accompanying documentation. 3673 </para> 3674 3675 <para> 3676 Although their code does not appear in gd, the authors wish to 3677 thank David Koblas, David Rowley, and Hutchison Avenue Software 3678 Corporation for their prior contributions. 3679 </para> 3680 2583 3681 </sect2> 2584 3682 2585 3683 <sect2 id="licBsdIntel"> 3684 2586 3685 <title>BSD License from Intel</title> 2587 3686 2588 <para>All rights reserved.</para> 2589 2590 <para>Redistribution and use in source and binary forms, with or without 2591 modification, are permitted provided that the following conditions are met:</para> 3687 <para> 3688 All rights reserved. 3689 </para> 3690 3691 <para> 3692 Redistribution and use in source and binary forms, with or 3693 without modification, are permitted provided that the following 3694 conditions are met: 3695 </para> 3696 2592 3697 <itemizedlist> 3698 2593 3699 <listitem> 2594 <para>Redistributions of source code must retain the above copyright 2595 notice, this list of conditions and the following disclaimer.</para> 2596 </listitem> 2597 <listitem> 2598 <para>Redistributions in binary form must reproduce the above copyright 2599 notice, this list of conditions and the following disclaimer in the 2600 documentation and/or other materials provided with the distribution.</para> 2601 </listitem> 2602 <listitem> 2603 <para>Neither the name of the Intel Corporation nor the names of its 2604 contributors may be used to endorse or promote products derived from 2605 this software without specific prior written permission.</para> 2606 </listitem> 2607 </itemizedlist> 2608 <para>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2609 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 2610 TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 2611 PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS 2612 BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 2613 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 2614 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2615 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2616 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2617 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 2618 DAMAGE.</para> 2619 </sect2> 2620 2621 <sect2 id="licJPEG"> 2622 <title>libjpeg License</title> 2623 2624 <para>The authors make NO WARRANTY or representation, either express or implied, 2625 with respect to this software, its quality, accuracy, merchantability, or 2626 fitness for a particular purpose. This software is provided "AS IS", and you, 2627 its user, assume the entire risk as to its quality and accuracy.</para> 2628 2629 <para>This software is copyright (C) 1991-2010, Thomas G. Lane, Guido Vollbeding. 2630 All Rights Reserved except as specified below.</para> 2631 2632 <para>Permission is hereby granted to use, copy, modify, and distribute this 2633 software (or portions thereof) for any purpose, without fee, subject to these 2634 conditions:</para> 2635 <para>(1) If any part of the source code for this software is distributed, then this 2636 README file must be included, with this copyright and no-warranty notice 2637 unaltered; and any additions, deletions, or changes to the original files 2638 must be clearly indicated in accompanying documentation.</para> 2639 <para>(2) If only executable code is distributed, then the accompanying 2640 documentation must state that "this software is based in part on the work of 2641 the Independent JPEG Group".</para> 2642 <para>(3) Permission for use of this software is granted only if the user accepts 2643 full responsibility for any undesirable consequences; the authors accept 2644 NO LIABILITY for damages of any kind.</para> 2645 2646 <para>These conditions apply to any software derived from or based on the IJG code, 2647 not just to the unmodified library. If you use our work, you ought to 2648 acknowledge us.</para> 2649 2650 <para>Permission is NOT granted for the use of any IJG author's name or company name 2651 in advertising or publicity relating to this software or products derived from 2652 it. This software may be referred to only as "the Independent JPEG Group's 2653 software".</para> 2654 2655 <para>We specifically permit and encourage the use of this software as the basis of 2656 commercial products, provided that all warranty or liability claims are 2657 assumed by the product vendor.</para> 2658 2659 <para>ansi2knr.c is included in this distribution by permission of L. Peter Deutsch, 2660 sole proprietor of its copyright holder, Aladdin Enterprises of Menlo Park, CA. 2661 ansi2knr.c is NOT covered by the above copyright and conditions, but instead 2662 by the usual distribution terms of the Free Software Foundation; principally, 2663 that you must include source code if you redistribute it. (See the file 2664 ansi2knr.c for full details.) However, since ansi2knr.c is not needed as part 2665 of any program generated from the IJG code, this does not limit you more than 2666 the foregoing paragraphs do.</para> 2667 2668 <para>The Unix configuration script "configure" was produced with GNU Autoconf. 2669 It is copyright by the Free Software Foundation but is freely distributable. 2670 The same holds for its supporting scripts (config.guess, config.sub, 2671 ltmain.sh). Another support script, install-sh, is copyright by X Consortium 2672 but is also freely distributable.</para> 2673 2674 <para>The IJG distribution formerly included code to read and write GIF files. 2675 To avoid entanglement with the Unisys LZW patent, GIF reading support has 2676 been removed altogether, and the GIF writer has been simplified to produce 2677 "uncompressed GIFs". This technique does not use the LZW algorithm; the 2678 resulting GIF files are larger than usual, but are readable by all standard 2679 GIF decoders.</para> 2680 2681 <para>We are required to state that</para> 2682 <para>"The Graphics Interchange Format(c) is the Copyright property of 2683 CompuServe Incorporated. GIF(sm) is a Service Mark property of 2684 CompuServe Incorporated."</para> 2685 </sect2> 2686 2687 <sect2 id="licJPEGSIMD"> 2688 <title>x86 SIMD Extension for IJG JPEG Library License</title> 2689 2690 <para>Copyright 2009 Pierre Ossman <[email protected]> for Cendio AB</para> 2691 <para>Copyright 2010 D. R. Commander</para> 2692 2693 <para>Based on</para> 2694 <para>x86 SIMD extension for IJG JPEG library - version 1.02</para> 2695 2696 <para>Copyright (C) 1999-2006, MIYASAKA Masaru.</para> 2697 2698 <para>This software is provided 'as-is', without any express or implied 2699 warranty. In no event will the authors be held liable for any damages 2700 arising from the use of this software.</para> 2701 2702 <para>Permission is granted to anyone to use this software for any purpose, 2703 including commercial applications, and to alter it and redistribute it 2704 freely, subject to the following restrictions:</para> 2705 2706 <para>1. The origin of this software must not be misrepresented; you must not 2707 claim that you wrote the original software. If you use this software 2708 in a product, an acknowledgment in the product documentation would be 2709 appreciated but is not required.</para> 2710 <para>2. Altered source versions must be plainly marked as such, and must not be 2711 misrepresented as being the original software.</para> 2712 <para>3. This notice may not be removed or altered from any source distribution.</para> 2713 </sect2> 2714 2715 <sect2 id="licFreeBsd"> 2716 <title>FreeBSD License</title> 2717 2718 <para>The compilation of software known as FreeBSD is distributed under the 2719 following terms:</para> 2720 2721 <para>Copyright (c) 1992-2009 The FreeBSD Project. All rights reserved.</para> 2722 2723 <para>Redistribution and use in source and binary forms, with or without 2724 modification, are permitted provided that the following conditions 2725 are met:</para> 2726 2727 <orderedlist> 2728 <listitem> 2729 <para>Redistributions of source code must retain the above copyright 2730 notice, this list of conditions and the following disclaimer. 3700 <para> 3701 Redistributions of source code must retain the above 3702 copyright notice, this list of conditions and the following 3703 disclaimer. 2731 3704 </para> 2732 3705 </listitem> 3706 2733 3707 <listitem> 2734 3708 <para> 2735 Redistributions in binary form must reproduce the above copyright 2736 notice, this list of conditions and the following disclaimer in the 2737 documentation and/or other materials provided with the distribution. 3709 Redistributions in binary form must reproduce the above 3710 copyright notice, this list of conditions and the following 3711 disclaimer in the documentation and/or other materials 3712 provided with the distribution. 2738 3713 </para> 2739 3714 </listitem> 2740 </orderedlist> 2741 2742 <para>THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 2743 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 2744 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 2745 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 2746 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2747 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2748 OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2749 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2750 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2751 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2752 SUCH DAMAGE.</para> 2753 </sect2> 2754 2755 <sect2 id="licNetBsd"> 2756 <title>NetBSD License</title> 2757 2758 <para>Copyright (c) 1992, 1993 The Regents of the University of California. 2759 All rights reserved.</para> 2760 2761 <para> 2762 This software was developed by the Computer Systems Engineering group 2763 at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and 2764 contributed to Berkeley. 2765 </para> 2766 2767 <para> 2768 Redistribution and use in source and binary forms, with or without 2769 modification, are permitted provided that the following conditions 2770 are met: 2771 </para> 2772 2773 <orderedlist> 3715 2774 3716 <listitem> 2775 3717 <para> 2776 Redistributions of source code must retain the above copyright 2777 notice, this list of conditions and the following disclaimer. 3718 Neither the name of the Intel Corporation nor the names of 3719 its contributors may be used to endorse or promote products 3720 derived from this software without specific prior written 3721 permission. 2778 3722 </para> 2779 3723 </listitem> 3724 3725 </itemizedlist> 3726 3727 <para> 3728 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 3729 CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 3730 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 3731 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 3732 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 3733 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 3734 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 3735 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 3736 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 3737 AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 3738 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 3739 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 3740 THE POSSIBILITY OF SUCH DAMAGE. 3741 </para> 3742 3743 </sect2> 3744 3745 <sect2 id="licJPEG"> 3746 3747 <title>libjpeg License</title> 3748 3749 <para> 3750 The authors make NO WARRANTY or representation, either express 3751 or implied, with respect to this software, its quality, 3752 accuracy, merchantability, or fitness for a particular purpose. 3753 This software is provided "AS IS", and you, its user, assume the 3754 entire risk as to its quality and accuracy. 3755 </para> 3756 3757 <para> 3758 This software is copyright (C) 1991-2010, Thomas G. Lane, Guido 3759 Vollbeding. All Rights Reserved except as specified below. 3760 </para> 3761 3762 <para> 3763 Permission is hereby granted to use, copy, modify, and 3764 distribute this software (or portions thereof) for any purpose, 3765 without fee, subject to these conditions: 3766 </para> 3767 3768 <para> 3769 (1) If any part of the source code for this software is 3770 distributed, then this README file must be included, with this 3771 copyright and no-warranty notice unaltered; and any additions, 3772 deletions, or changes to the original files must be clearly 3773 indicated in accompanying documentation. 3774 </para> 3775 3776 <para> 3777 (2) If only executable code is distributed, then the 3778 accompanying documentation must state that "this software is 3779 based in part on the work of the Independent JPEG Group". 3780 </para> 3781 3782 <para> 3783 (3) Permission for use of this software is granted only if the 3784 user accepts full responsibility for any undesirable 3785 consequences; the authors accept NO LIABILITY for damages of any 3786 kind. 3787 </para> 3788 3789 <para> 3790 These conditions apply to any software derived from or based on 3791 the IJG code, not just to the unmodified library. If you use our 3792 work, you ought to acknowledge us. 3793 </para> 3794 3795 <para> 3796 Permission is NOT granted for the use of any IJG author's name 3797 or company name in advertising or publicity relating to this 3798 software or products derived from it. This software may be 3799 referred to only as "the Independent JPEG Group's software". 3800 </para> 3801 3802 <para> 3803 We specifically permit and encourage the use of this software as 3804 the basis of commercial products, provided that all warranty or 3805 liability claims are assumed by the product vendor. 3806 </para> 3807 3808 <para> 3809 ansi2knr.c is included in this distribution by permission of L. 3810 Peter Deutsch, sole proprietor of its copyright holder, Aladdin 3811 Enterprises of Menlo Park, CA. ansi2knr.c is NOT covered by the 3812 above copyright and conditions, but instead by the usual 3813 distribution terms of the Free Software Foundation; principally, 3814 that you must include source code if you redistribute it. (See 3815 the file ansi2knr.c for full details.) However, since ansi2knr.c 3816 is not needed as part of any program generated from the IJG 3817 code, this does not limit you more than the foregoing paragraphs 3818 do. 3819 </para> 3820 3821 <para> 3822 The Unix configuration script "configure" was produced with GNU 3823 Autoconf. It is copyright by the Free Software Foundation but is 3824 freely distributable. The same holds for its supporting scripts 3825 (config.guess, config.sub, ltmain.sh). Another support script, 3826 install-sh, is copyright by X Consortium but is also freely 3827 distributable. 3828 </para> 3829 3830 <para> 3831 The IJG distribution formerly included code to read and write 3832 GIF files. To avoid entanglement with the Unisys LZW patent, GIF 3833 reading support has been removed altogether, and the GIF writer 3834 has been simplified to produce "uncompressed GIFs". This 3835 technique does not use the LZW algorithm; the resulting GIF 3836 files are larger than usual, but are readable by all standard 3837 GIF decoders. 3838 </para> 3839 3840 <para> 3841 We are required to state that 3842 </para> 3843 3844 <para> 3845 "The Graphics Interchange Format(c) is the Copyright property of 3846 CompuServe Incorporated. GIF(sm) is a Service Mark property of 3847 CompuServe Incorporated." 3848 </para> 3849 3850 </sect2> 3851 3852 <sect2 id="licJPEGSIMD"> 3853 3854 <title>x86 SIMD Extension for IJG JPEG Library License</title> 3855 3856 <para> 3857 Copyright 2009 Pierre Ossman <[email protected]> for Cendio 3858 AB 3859 </para> 3860 3861 <para> 3862 Copyright 2010 D. R. Commander 3863 </para> 3864 3865 <para> 3866 Based on 3867 </para> 3868 3869 <para> 3870 x86 SIMD extension for IJG JPEG library - version 1.02 3871 </para> 3872 3873 <para> 3874 Copyright (C) 1999-2006, MIYASAKA Masaru. 3875 </para> 3876 3877 <para> 3878 This software is provided 'as-is', without any express or 3879 implied warranty. In no event will the authors be held liable 3880 for any damages arising from the use of this software. 3881 </para> 3882 3883 <para> 3884 Permission is granted to anyone to use this software for any 3885 purpose, including commercial applications, and to alter it and 3886 redistribute it freely, subject to the following restrictions: 3887 </para> 3888 3889 <para> 3890 1. The origin of this software must not be misrepresented; you 3891 must not claim that you wrote the original software. If you use 3892 this software in a product, an acknowledgment in the product 3893 documentation would be appreciated but is not required. 3894 </para> 3895 3896 <para> 3897 2. Altered source versions must be plainly marked as such, and 3898 must not be misrepresented as being the original software. 3899 </para> 3900 3901 <para> 3902 3. This notice may not be removed or altered from any source 3903 distribution. 3904 </para> 3905 3906 </sect2> 3907 3908 <sect2 id="licFreeBsd"> 3909 3910 <title>FreeBSD License</title> 3911 3912 <para> 3913 The compilation of software known as FreeBSD is distributed 3914 under the following terms: 3915 </para> 3916 3917 <para> 3918 Copyright (c) 1992-2009 The FreeBSD Project. All rights 3919 reserved. 3920 </para> 3921 3922 <para> 3923 Redistribution and use in source and binary forms, with or 3924 without modification, are permitted provided that the following 3925 conditions are met: 3926 </para> 3927 3928 <orderedlist> 3929 2780 3930 <listitem> 2781 3931 <para> 2782 Redistributions in binary form must reproduce the above copyright2783 notice, this list of conditions and the following disclaimer in the2784 d ocumentation and/or other materials provided with the distribution.3932 Redistributions of source code must retain the above 3933 copyright notice, this list of conditions and the following 3934 disclaimer. 2785 3935 </para> 2786 3936 </listitem> 3937 2787 3938 <listitem> 2788 3939 <para> 2789 Neither the name of the University nor the names of its contributors 2790 may be used to endorse or promote products derived from this software 2791 without specific prior written permission. 3940 Redistributions in binary form must reproduce the above 3941 copyright notice, this list of conditions and the following 3942 disclaimer in the documentation and/or other materials 3943 provided with the distribution. 2792 3944 </para> 2793 3945 </listitem> 3946 2794 3947 </orderedlist> 2795 3948 2796 3949 <para> 2797 THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 2798 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 2799 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 2800 ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 2801 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2802 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2803 OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2804 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2805 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2806 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 3950 THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS 3951 IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 3952 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 3953 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 3954 SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 3955 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 3956 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 3957 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 3958 BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 3959 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 3960 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 3961 THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2807 3962 SUCH DAMAGE. 2808 3963 </para> 3964 2809 3965 </sect2> 2810 3966 2811 <sect2 id="licPcre"> 2812 <title>PCRE License</title> 2813 2814 <para> 2815 PCRE is a library of functions to support regular expressions whose syntax 2816 and semantics are as close as possible to those of the Perl 5 language. 2817 </para><para> 2818 Release 8 of PCRE is distributed under the terms of the "BSD" licence, as 2819 specified below. The documentation for PCRE, supplied in the "doc" 2820 directory, is distributed under the same terms as the software itself. 2821 </para><para> 2822 The basic library functions are written in C and are freestanding. Also 2823 included in the distribution is a set of C++ wrapper functions, and a 2824 just-in-time compiler that can be used to optimize pattern matching. These 2825 are both optional features that can be omitted when the library is built. 2826 </para><para> 2827 THE BASIC LIBRARY FUNCTIONS. 2828 Written by: Philip Hazel; Email local part: ph10; Email domain: cam.ac.uk 2829 University of Cambridge Computing Service, Cambridge, England. 2830 Copyright (c) 1997-2012 University of Cambridge 2831 All rights reserved. 2832 </para><para> 2833 PCRE JUST-IN-TIME COMPILATION SUPPORT. 2834 Written by: Zoltan Herczeg; Email local part: hzmester; Emain domain: freemail.hu 2835 Copyright(c) 2010-2012 Zoltan Herczeg 2836 All rights reserved. 2837 </para><para> 2838 STACK-LESS JUST-IN-TIME COMPILER. 2839 Written by: Zoltan Herczeg; Email local part: hzmester; Emain domain: freemail.hu 2840 Copyright(c) 2009-2012 Zoltan Herczeg 2841 All rights reserved. 2842 </para><para> 2843 THE C++ WRAPPER FUNCTIONS. 2844 Contributed by: Google Inc. 2845 Copyright (c) 2007-2012, Google Inc. 2846 All rights reserved. 2847 </para><para> 2848 THE "BSD" LICENCE. 2849 Redistribution and use in source and binary forms, with or without 2850 modification, are permitted provided that the following conditions are met: 2851 </para> 2852 <itemizedlist> 3967 <sect2 id="licNetBsd"> 3968 3969 <title>NetBSD License</title> 3970 3971 <para> 3972 Copyright (c) 1992, 1993 The Regents of the University of 3973 California. All rights reserved. 3974 </para> 3975 3976 <para> 3977 This software was developed by the Computer Systems Engineering 3978 group at Lawrence Berkeley Laboratory under DARPA contract BG 3979 91-66 and contributed to Berkeley. 3980 </para> 3981 3982 <para> 3983 Redistribution and use in source and binary forms, with or 3984 without modification, are permitted provided that the following 3985 conditions are met: 3986 </para> 3987 3988 <orderedlist> 3989 2853 3990 <listitem> 2854 3991 <para> 2855 Redistributions of source code must retain the above copyright notice, 2856 this list of conditions and the following disclaimer. 3992 Redistributions of source code must retain the above 3993 copyright notice, this list of conditions and the following 3994 disclaimer. 2857 3995 </para> 2858 3996 </listitem> 3997 2859 3998 <listitem> 2860 3999 <para> 2861 Redistributions in binary form must reproduce the above copyright 2862 notice, this list of conditions and the following disclaimer in the 2863 documentation and/or other materials provided with the distribution. 4000 Redistributions in binary form must reproduce the above 4001 copyright notice, this list of conditions and the following 4002 disclaimer in the documentation and/or other materials 4003 provided with the distribution. 2864 4004 </para> 2865 4005 </listitem> 4006 2866 4007 <listitem> 2867 4008 <para> 2868 Neither the name of the University of Cambridge nor the name of Google2869 Inc. nor the names of their contributors may be used to endorse or2870 promote products derived from this software without specific prior2871 writtenpermission.4009 Neither the name of the University nor the names of its 4010 contributors may be used to endorse or promote products 4011 derived from this software without specific prior written 4012 permission. 2872 4013 </para> 2873 4014 </listitem> 4015 4016 </orderedlist> 4017 4018 <para> 4019 THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS 4020 IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 4021 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 4022 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 4023 SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 4024 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 4025 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 4026 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 4027 BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 4028 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 4029 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 4030 THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 4031 SUCH DAMAGE. 4032 </para> 4033 4034 </sect2> 4035 4036 <sect2 id="licPcre"> 4037 4038 <title>PCRE License</title> 4039 4040 <para> 4041 PCRE is a library of functions to support regular expressions 4042 whose syntax and semantics are as close as possible to those of 4043 the Perl 5 language. 4044 </para> 4045 4046 <para> 4047 Release 8 of PCRE is distributed under the terms of the "BSD" 4048 licence, as specified below. The documentation for PCRE, 4049 supplied in the "doc" directory, is distributed under the same 4050 terms as the software itself. 4051 </para> 4052 4053 <para> 4054 The basic library functions are written in C and are 4055 freestanding. Also included in the distribution is a set of C++ 4056 wrapper functions, and a just-in-time compiler that can be used 4057 to optimize pattern matching. These are both optional features 4058 that can be omitted when the library is built. 4059 </para> 4060 4061 <para> 4062 THE BASIC LIBRARY FUNCTIONS. Written by: Philip Hazel; Email 4063 local part: ph10; Email domain: cam.ac.uk University of 4064 Cambridge Computing Service, Cambridge, England. Copyright (c) 4065 1997-2012 University of Cambridge All rights reserved. 4066 </para> 4067 4068 <para> 4069 PCRE JUST-IN-TIME COMPILATION SUPPORT. Written by: Zoltan 4070 Herczeg; Email local part: hzmester; Emain domain: freemail.hu 4071 Copyright(c) 2010-2012 Zoltan Herczeg All rights reserved. 4072 </para> 4073 4074 <para> 4075 STACK-LESS JUST-IN-TIME COMPILER. Written by: Zoltan Herczeg; 4076 Email local part: hzmester; Emain domain: freemail.hu 4077 Copyright(c) 2009-2012 Zoltan Herczeg All rights reserved. 4078 </para> 4079 4080 <para> 4081 THE C++ WRAPPER FUNCTIONS. Contributed by: Google Inc. Copyright 4082 (c) 2007-2012, Google Inc. All rights reserved. 4083 </para> 4084 4085 <para> 4086 THE "BSD" LICENCE. Redistribution and use in source and binary 4087 forms, with or without modification, are permitted provided that 4088 the following conditions are met: 4089 </para> 4090 4091 <itemizedlist> 4092 4093 <listitem> 4094 <para> 4095 Redistributions of source code must retain the above 4096 copyright notice, this list of conditions and the following 4097 disclaimer. 4098 </para> 4099 </listitem> 4100 4101 <listitem> 4102 <para> 4103 Redistributions in binary form must reproduce the above 4104 copyright notice, this list of conditions and the following 4105 disclaimer in the documentation and/or other materials 4106 provided with the distribution. 4107 </para> 4108 </listitem> 4109 4110 <listitem> 4111 <para> 4112 Neither the name of the University of Cambridge nor the name 4113 of Google Inc. nor the names of their contributors may be 4114 used to endorse or promote products derived from this 4115 software without specific prior written permission. 4116 </para> 4117 </listitem> 4118 2874 4119 </itemizedlist> 2875 <para> 2876 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 2877 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 2878 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 2879 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 2880 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 2881 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 2882 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 2883 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 2884 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 2885 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 2886 POSSIBILITY OF SUCH DAMAGE. 2887 </para> 4120 4121 <para> 4122 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 4123 CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 4124 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 4125 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 4126 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 4127 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 4128 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 4129 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 4130 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 4131 AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 4132 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 4133 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 4134 THE POSSIBILITY OF SUCH DAMAGE. 4135 </para> 4136 2888 4137 </sect2> 2889 4138 2890 4139 <sect2 id="licLibffi"> 4140 2891 4141 <title>libffi License</title> 2892 4142 2893 4143 <para> 2894 Copyright (c) 1996-2012 4144 Copyright (c) 1996-2012 Anthony Green, Red Hat, Inc and others. 2895 4145 See source files for details. 2896 </para><para> 2897 Permission is hereby granted, free of charge, to any person obtaining 2898 a copy of this software and associated documentation files (the 2899 ``Software''), to deal in the Software without restriction, including 2900 without limitation the rights to use, copy, modify, merge, publish, 2901 distribute, sublicense, and/or sell copies of the Software, and to 2902 permit persons to whom the Software is furnished to do so, subject to 2903 the following conditions: 2904 </para><para> 4146 </para> 4147 4148 <para> 4149 Permission is hereby granted, free of charge, to any person 4150 obtaining a copy of this software and associated documentation 4151 files (the ``Software''), to deal in the Software without 4152 restriction, including without limitation the rights to use, 4153 copy, modify, merge, publish, distribute, sublicense, and/or 4154 sell copies of the Software, and to permit persons to whom the 4155 Software is furnished to do so, subject to the following 4156 conditions: 4157 </para> 4158 4159 <para> 2905 4160 The above copyright notice and this permission notice shall be 2906 4161 included in all copies or substantial portions of the Software. 2907 </para><para> 2908 THE SOFTWARE IS PROVIDED ``AS IS'', WITHOUT WARRANTY OF ANY KIND, 2909 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 2910 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 2911 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 2912 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 2913 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 2914 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 2915 </para> 4162 </para> 4163 4164 <para> 4165 THE SOFTWARE IS PROVIDED ``AS IS'', WITHOUT WARRANTY OF ANY 4166 KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE 4167 WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE 4168 AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 4169 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 4170 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 4171 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 4172 OTHER DEALINGS IN THE SOFTWARE. 4173 </para> 4174 2916 4175 </sect2> 2917 4176 2918 4177 <sect2 id="licFltk"> 4178 2919 4179 <title>FLTK License</title> 2920 4180 2921 4181 <para> 2922 4182 December 11, 2001 2923 </para><para> 2924 The FLTK library and included programs are provided under the terms 2925 of the GNU Library General Public License (LGPL) with the following 2926 exceptions: 2927 </para> 4183 </para> 4184 4185 <para> 4186 The FLTK library and included programs are provided under the 4187 terms of the GNU Library General Public License (LGPL) with the 4188 following exceptions: 4189 </para> 4190 2928 4191 <orderedlist> 4192 2929 4193 <listitem> 2930 4194 <para> 2931 Modifications to the FLTK configure script, config 2932 header file, and makefiles by themselves to support 2933 a specific platform do not constitute a modified or 2934 derivative work. 4195 Modifications to the FLTK configure script, config header 4196 file, and makefiles by themselves to support a specific 4197 platform do not constitute a modified or derivative work. 2935 4198 </para> 4199 2936 4200 <para> 2937 4201 The authors do request that such modifications be 2938 4202 contributed to the FLTK project - send all contributions 2939 4203 through the "Software Trouble Report" on the following page: 2940 </para><para> 4204 </para> 4205 4206 <para> 2941 4207 http://www.fltk.org/str.php 2942 4208 </para> 2943 4209 </listitem> 4210 2944 4211 <listitem> 2945 4212 <para> … … 2948 4215 </para> 2949 4216 </listitem> 4217 2950 4218 <listitem> 2951 4219 <para> 2952 Static linking of applications and widgets to the 2953 FLTK library does not constitute a derivative work2954 and does not require the author to provide source2955 code for the application or widget, use the shared2956 FLTK libraries, or link their applications or2957 widgets against a user-suppliedversion of FLTK.4220 Static linking of applications and widgets to the FLTK 4221 library does not constitute a derivative work and does not 4222 require the author to provide source code for the 4223 application or widget, use the shared FLTK libraries, or 4224 link their applications or widgets against a user-supplied 4225 version of FLTK. 2958 4226 </para> 4227 2959 4228 <para> 2960 If you link the application or widget to a modified 2961 version of FLTK, then the changes to FLTK must be 2962 provided under the terms of the LGPL in sections 2963 1, 2, and 4. 4229 If you link the application or widget to a modified version 4230 of FLTK, then the changes to FLTK must be provided under the 4231 terms of the LGPL in sections 1, 2, and 4. 2964 4232 </para> 2965 4233 </listitem> 4234 2966 4235 <listitem> 2967 4236 <para> 2968 You do not have to provide a copy of the FLTK license 2969 with programs that are linked to the FLTK library, nor 2970 do you have to identify the FLTK license in your 2971 program or documentation as required by section 6 2972 of the LGPL. 4237 You do not have to provide a copy of the FLTK license with 4238 programs that are linked to the FLTK library, nor do you 4239 have to identify the FLTK license in your program or 4240 documentation as required by section 6 of the LGPL. 2973 4241 </para> 4242 2974 4243 <para> 2975 However, programs must still identify their use of FLTK. 2976 Thefollowing example statement can be included in user4244 However, programs must still identify their use of FLTK. The 4245 following example statement can be included in user 2977 4246 documentation to satisfy this requirement: 2978 4247 </para> 4248 2979 4249 <para> 2980 [program/widget] is based in part on the work of 2981 the FLTKproject (http://www.fltk.org).4250 [program/widget] is based in part on the work of the FLTK 4251 project (http://www.fltk.org). 2982 4252 </para> 2983 4253 </listitem> 4254 2984 4255 </orderedlist> 4256 2985 4257 </sect2> 2986 4258 2987 4259 <sect2 id="licExpat"> 4260 2988 4261 <title>Expat License</title> 2989 <para> 2990 Copyright (c) 1998, 1999, 2000 Thai Open Source Software Center Ltd 2991 and Clark Cooper 2992 </para> 2993 <para> 2994 Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006 Expat maintainers. 2995 </para> 2996 <para> 2997 Permission is hereby granted, free of charge, to any person obtaining 2998 a copy of this software and associated documentation files (the 2999 "Software"), to deal in the Software without restriction, including 3000 without limitation the rights to use, copy, modify, merge, publish, 3001 distribute, sublicense, and/or sell copies of the Software, and to 3002 permit persons to whom the Software is furnished to do so, subject to 3003 the following conditions: 3004 </para> 3005 <para> 3006 The above copyright notice and this permission notice shall be included 3007 in all copies or substantial portions of the Software. 3008 </para> 4262 4263 <para> 4264 Copyright (c) 1998, 1999, 2000 Thai Open Source Software Center 4265 Ltd and Clark Cooper 4266 </para> 4267 4268 <para> 4269 Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006 Expat 4270 maintainers. 4271 </para> 4272 4273 <para> 4274 Permission is hereby granted, free of charge, to any person 4275 obtaining a copy of this software and associated documentation 4276 files (the "Software"), to deal in the Software without 4277 restriction, including without limitation the rights to use, 4278 copy, modify, merge, publish, distribute, sublicense, and/or 4279 sell copies of the Software, and to permit persons to whom the 4280 Software is furnished to do so, subject to the following 4281 conditions: 4282 </para> 4283 4284 <para> 4285 The above copyright notice and this permission notice shall be 4286 included in all copies or substantial portions of the Software. 4287 </para> 4288 3009 4289 <para> 3010 4290 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 3011 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 3012 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 3013 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 3014 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 3015 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 3016 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 3017 </para> 4291 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES 4292 OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 4293 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 4294 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 4295 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 4296 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 4297 OTHER DEALINGS IN THE SOFTWARE. 4298 </para> 4299 3018 4300 </sect2> 3019 4301 3020 4302 <sect2 id="licFontconfig"> 4303 3021 4304 <title>Fontconfig License</title> 4305 3022 4306 <para> 3023 4307 Copyright (C) 2001, 2003 Keith Packard 3024 4308 </para> 3025 <para> 3026 Permission to use, copy, modify, distribute, and sell this software and its 3027 documentation for any purpose is hereby granted without fee, provided that 3028 the above copyright notice appear in all copies and that both that 3029 copyright notice and this permission notice appear in supporting 3030 documentation, and that the name of the author(s) not be used in 3031 advertising or publicity pertaining to distribution of the software without 3032 specific, written prior permission. The authors make no 3033 representations about the suitability of this software for any purpose. It 3034 is provided "as is" without express or implied warranty. 3035 </para> 3036 <para> 3037 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, 3038 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO 3039 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR 3040 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, 3041 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER 3042 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 3043 PERFORMANCE OF THIS SOFTWARE. 3044 </para> 4309 4310 <para> 4311 Permission to use, copy, modify, distribute, and sell this 4312 software and its documentation for any purpose is hereby granted 4313 without fee, provided that the above copyright notice appear in 4314 all copies and that both that copyright notice and this 4315 permission notice appear in supporting documentation, and that 4316 the name of the author(s) not be used in advertising or 4317 publicity pertaining to distribution of the software without 4318 specific, written prior permission. The authors make no 4319 representations about the suitability of this software for any 4320 purpose. It is provided "as is" without express or implied 4321 warranty. 4322 </para> 4323 4324 <para> 4325 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS 4326 SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY 4327 AND FITNESS, IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY 4328 SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 4329 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER 4330 IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, 4331 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF 4332 THIS SOFTWARE. 4333 </para> 4334 3045 4335 </sect2> 3046 4336 3047 4337 <sect2 id="licFreetype"> 4338 3048 4339 <title>Freetype License</title> 4340 3049 4341 <para> 3050 4342 2006-Jan-27 3051 4343 </para> 3052 <para> 3053 Copyright 1996-2002, 2006 by David Turner, Robert Wilhelm, and Werner Lemberg 3054 </para> 4344 4345 <para> 4346 Copyright 1996-2002, 2006 by David Turner, Robert Wilhelm, and 4347 Werner Lemberg 4348 </para> 4349 3055 4350 <sect3> 4351 3056 4352 <title>Introduction</title> 3057 <para> 3058 The FreeType Project is distributed in several archive packages; 3059 some of them may contain, in addition to the FreeType font engine, 3060 various tools and contributions which rely on, or relate to, the 3061 FreeType Project. 3062 </para> 3063 <para> 3064 This license applies to all files found in such packages, and 3065 which do not fall under their own explicit license. The license 3066 affects thus the FreeType font engine, the test programs, 3067 documentation and makefiles, at the very least. 3068 </para> 3069 <para> 3070 This license was inspired by the BSD, Artistic, and IJG 3071 (Independent JPEG Group) licenses, which all encourage inclusion 3072 and use of free software in commercial and freeware products 3073 alike. As a consequence, its main points are that: 3074 </para> 4353 4354 <para> 4355 The FreeType Project is distributed in several archive 4356 packages; some of them may contain, in addition to the 4357 FreeType font engine, various tools and contributions which 4358 rely on, or relate to, the FreeType Project. 4359 </para> 4360 4361 <para> 4362 This license applies to all files found in such packages, and 4363 which do not fall under their own explicit license. The 4364 license affects thus the FreeType font engine, the test 4365 programs, documentation and makefiles, at the very least. 4366 </para> 4367 4368 <para> 4369 This license was inspired by the BSD, Artistic, and IJG 4370 (Independent JPEG Group) licenses, which all encourage 4371 inclusion and use of free software in commercial and freeware 4372 products alike. As a consequence, its main points are that: 4373 </para> 4374 3075 4375 <itemizedlist> 4376 3076 4377 <listitem> 3077 4378 <para> 3078 We don't promise that this software works. However, we will be 3079 interested in any kind of bug reports. (`as is' distribution) 4379 We don't promise that this software works. However, we 4380 will be interested in any kind of bug reports. (`as is' 4381 distribution) 3080 4382 </para> 3081 4383 </listitem> 4384 3082 4385 <listitem> 3083 4386 <para> 3084 You can use this software for whatever you want, in parts or 3085 full form, without having to pay us. (`royalty-free' usage) 4387 You can use this software for whatever you want, in parts 4388 or full form, without having to pay us. (`royalty-free' 4389 usage) 3086 4390 </para> 3087 4391 </listitem> 4392 3088 4393 <listitem> 3089 4394 <para> 3090 You may not pretend that you wrote this software. If you use3091 it, or only parts of it, in a program, you must acknowledge3092 somewhere in your documentation that you have used the3093 FreeType code. (`credits')4395 You may not pretend that you wrote this software. If you 4396 use it, or only parts of it, in a program, you must 4397 acknowledge somewhere in your documentation that you have 4398 used the FreeType code. (`credits') 3094 4399 </para> 3095 4400 </listitem> 4401 3096 4402 </itemizedlist> 3097 <para> 3098 We specifically permit and encourage the inclusion of this 3099 software, with or without modifications, in commercial products. 3100 We disclaim all warranties covering The FreeType Project and 3101 assume no liability related to The FreeType Project. 3102 </para> 3103 <para> 3104 Finally, many people asked us for a preferred form for a 3105 credit/disclaimer to use in compliance with this license. We thus 3106 encourage you to use the following text: 3107 </para> 3108 <para> 3109 Portions of this software are copyright (C) <year> The FreeType 3110 Project (www.freetype.org). All rights reserved. 3111 </para> 3112 <para> 3113 Please replace <year> with the value from the FreeType version you 3114 actually use. 3115 </para> 4403 4404 <para> 4405 We specifically permit and encourage the inclusion of this 4406 software, with or without modifications, in commercial 4407 products. We disclaim all warranties covering The FreeType 4408 Project and assume no liability related to The FreeType 4409 Project. 4410 </para> 4411 4412 <para> 4413 Finally, many people asked us for a preferred form for a 4414 credit/disclaimer to use in compliance with this license. We 4415 thus encourage you to use the following text: 4416 </para> 4417 4418 <para> 4419 Portions of this software are copyright (C) <year> The 4420 FreeType Project (www.freetype.org). All rights reserved. 4421 </para> 4422 4423 <para> 4424 Please replace <year> with the value from the FreeType 4425 version you actually use. 4426 </para> 4427 3116 4428 </sect3> 4429 3117 4430 <sect3> 4431 3118 4432 <title>Legal Terms</title> 3119 4433 3120 <para>0. Definitions</para> 3121 <para> 3122 Throughout this license, the terms `package', `FreeType Project', 3123 and `FreeType archive' refer to the set of files originally 3124 distributed by the authors (David Turner, Robert Wilhelm, and 3125 Werner Lemberg) as the `FreeType Project', be they named as alpha, 3126 beta or final release. 3127 </para> 3128 <para> 3129 `You' refers to the licensee, or person using the project, where 3130 `using' is a generic term including compiling the project's source 3131 code as well as linking it to form a `program' or `executable'. 3132 This program is referred to as `a program using the FreeType 3133 engine'. 3134 </para> 3135 <para> 3136 This license applies to all files distributed in the original 3137 FreeType Project, including all source code, binaries and 3138 documentation, unless otherwise stated in the file in its 3139 original, unmodified form as distributed in the original archive. 3140 If you are unsure whether or not a particular file is covered by 3141 this license, you must contact us to verify this. 3142 </para> 3143 <para> 3144 The FreeType Project is copyright (C) 1996-2000 by David Turner, 3145 Robert Wilhelm, and Werner Lemberg. All rights reserved except as 3146 specified below. 3147 </para> 3148 3149 3150 <para>1. No Warranty</para> 3151 <para> 3152 THE FREETYPE PROJECT IS PROVIDED `AS IS' WITHOUT WARRANTY OF ANY 3153 KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 3154 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 3155 PURPOSE. IN NO EVENT WILL ANY OF THE AUTHORS OR COPYRIGHT HOLDERS 3156 BE LIABLE FOR ANY DAMAGES CAUSED BY THE USE OR THE INABILITY TO 3157 USE, OF THE FREETYPE PROJECT. 3158 </para> 3159 3160 3161 <para>2. Redistribution</para> 3162 <para> 3163 This license grants a worldwide, royalty-free, perpetual and 3164 irrevocable right and license to use, execute, perform, compile, 3165 display, copy, create derivative works of, distribute and 3166 sublicense the FreeType Project (in both source and object code 3167 forms) and derivative works thereof for any purpose; and to 3168 authorize others to exercise some or all of the rights granted 3169 herein, subject to the following conditions: 3170 </para> 3171 <itemizedlist> 3172 <listitem> 3173 <para> 3174 Redistribution of source code must retain this license file 3175 (`FTL.TXT') unaltered; any additions, deletions or changes to 3176 the original files must be clearly indicated in accompanying 3177 documentation. The copyright notices of the unaltered, 3178 original files must be preserved in all copies of source 3179 files. 3180 </para> 3181 </listitem> 3182 <listitem> 3183 <para> 3184 Redistribution in binary form must provide a disclaimer that 3185 states that the software is based in part of the work of the 3186 FreeType Team, in the distribution documentation. We also 3187 encourage you to put an URL to the FreeType web page in your 3188 documentation, though this isn't mandatory. 3189 </para> 3190 </listitem> 3191 </itemizedlist> 3192 <para> 3193 These conditions apply to any software derived from or based on 3194 the FreeType Project, not just the unmodified files. If you use 3195 our work, you must acknowledge us. However, no fee need be paid 3196 to us. 3197 </para> 3198 3199 3200 <para>3. Advertising</para> 3201 <para> 3202 Neither the FreeType authors and contributors nor you shall use 3203 the name of the other for commercial, advertising, or promotional 3204 purposes without specific prior written permission. 4434 <para> 4435 0. Definitions 4436 </para> 4437 4438 <para> 4439 Throughout this license, the terms `package', `FreeType 4440 Project', and `FreeType archive' refer to the set of files 4441 originally distributed by the authors (David Turner, Robert 4442 Wilhelm, and Werner Lemberg) as the `FreeType Project', be 4443 they named as alpha, beta or final release. 4444 </para> 4445 4446 <para> 4447 `You' refers to the licensee, or person using the project, 4448 where `using' is a generic term including compiling the 4449 project's source code as well as linking it to form a 4450 `program' or `executable'. This program is referred to as `a 4451 program using the FreeType engine'. 4452 </para> 4453 4454 <para> 4455 This license applies to all files distributed in the original 4456 FreeType Project, including all source code, binaries and 4457 documentation, unless otherwise stated in the file in its 4458 original, unmodified form as distributed in the original 4459 archive. If you are unsure whether or not a particular file is 4460 covered by this license, you must contact us to verify this. 4461 </para> 4462 4463 <para> 4464 The FreeType Project is copyright (C) 1996-2000 by David 4465 Turner, Robert Wilhelm, and Werner Lemberg. All rights 4466 reserved except as specified below. 4467 </para> 4468 4469 <para> 4470 1. No Warranty 4471 </para> 4472 4473 <para> 4474 THE FREETYPE PROJECT IS PROVIDED `AS IS' WITHOUT WARRANTY OF 4475 ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT 4476 LIMITED TO, WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A 4477 PARTICULAR PURPOSE. IN NO EVENT WILL ANY OF THE AUTHORS OR 4478 COPYRIGHT HOLDERS BE LIABLE FOR ANY DAMAGES CAUSED BY THE USE 4479 OR THE INABILITY TO USE, OF THE FREETYPE PROJECT. 4480 </para> 4481 4482 <para> 4483 2. Redistribution 4484 </para> 4485 4486 <para> 4487 This license grants a worldwide, royalty-free, perpetual and 4488 irrevocable right and license to use, execute, perform, 4489 compile, display, copy, create derivative works of, distribute 4490 and sublicense the FreeType Project (in both source and object 4491 code forms) and derivative works thereof for any purpose; and 4492 to authorize others to exercise some or all of the rights 4493 granted herein, subject to the following conditions: 4494 </para> 4495 4496 <itemizedlist> 4497 4498 <listitem> 4499 <para> 4500 Redistribution of source code must retain this license 4501 file (`FTL.TXT') unaltered; any additions, deletions or 4502 changes to the original files must be clearly indicated in 4503 accompanying documentation. The copyright notices of the 4504 unaltered, original files must be preserved in all copies 4505 of source files. 3205 4506 </para> 3206 <para> 3207 We suggest, but do not require, that you use one or more of the 3208 following phrases to refer to this software in your documentation 3209 or advertising materials: `FreeType Project', `FreeType Engine', 3210 `FreeType library', or `FreeType Distribution'. 3211 </para> 3212 <para> 3213 As you have not signed this license, you are not required to 3214 accept it. However, as the FreeType Project is copyrighted 3215 material, only this license, or another one contracted with the 3216 authors, grants you the right to use, distribute, and modify it. 3217 Therefore, by using, distributing, or modifying the FreeType 3218 Project, you indicate that you understand and accept all the terms 3219 of this license. 3220 </para> 3221 3222 3223 <para>4. Contacts</para> 3224 <para> 3225 There are two mailing lists related to FreeType: 3226 </para> 3227 <itemizedlist> 3228 <listitem> 3229 <para> 3230 [email protected] 3231 </para> 3232 <para> 3233 Discusses general use and applications of FreeType, as well as 3234 future and wanted additions to the library and distribution. 3235 If you are looking for support, start in this list if you 3236 haven't found anything to help you in the documentation. 3237 </para> 3238 </listitem> 3239 <listitem> 3240 <para> 3241 [email protected] 3242 </para> 3243 <para> 3244 Discusses bugs, as well as engine internals, design issues, 3245 specific licenses, porting, etc. 3246 </para> 3247 </listitem> 3248 </itemizedlist> 3249 <para> 3250 Our home page can be found at 3251 </para> 3252 <para> 3253 http://www.freetype.org 3254 </para> 4507 </listitem> 4508 4509 <listitem> 4510 <para> 4511 Redistribution in binary form must provide a disclaimer 4512 that states that the software is based in part of the work 4513 of the FreeType Team, in the distribution documentation. 4514 We also encourage you to put an URL to the FreeType web 4515 page in your documentation, though this isn't mandatory. 4516 </para> 4517 </listitem> 4518 4519 </itemizedlist> 4520 4521 <para> 4522 These conditions apply to any software derived from or based 4523 on the FreeType Project, not just the unmodified files. If you 4524 use our work, you must acknowledge us. However, no fee need be 4525 paid to us. 4526 </para> 4527 4528 <para> 4529 3. Advertising 4530 </para> 4531 4532 <para> 4533 Neither the FreeType authors and contributors nor you shall 4534 use the name of the other for commercial, advertising, or 4535 promotional purposes without specific prior written 4536 permission. 4537 </para> 4538 4539 <para> 4540 We suggest, but do not require, that you use one or more of 4541 the following phrases to refer to this software in your 4542 documentation or advertising materials: `FreeType Project', 4543 `FreeType Engine', `FreeType library', or `FreeType 4544 Distribution'. 4545 </para> 4546 4547 <para> 4548 As you have not signed this license, you are not required to 4549 accept it. However, as the FreeType Project is copyrighted 4550 material, only this license, or another one contracted with 4551 the authors, grants you the right to use, distribute, and 4552 modify it. Therefore, by using, distributing, or modifying the 4553 FreeType Project, you indicate that you understand and accept 4554 all the terms of this license. 4555 </para> 4556 4557 <para> 4558 4. Contacts 4559 </para> 4560 4561 <para> 4562 There are two mailing lists related to FreeType: 4563 </para> 4564 4565 <itemizedlist> 4566 4567 <listitem> 4568 <para> 4569 [email protected] 4570 </para> 4571 4572 <para> 4573 Discusses general use and applications of FreeType, as 4574 well as future and wanted additions to the library and 4575 distribution. If you are looking for support, start in 4576 this list if you haven't found anything to help you in the 4577 documentation. 4578 </para> 4579 </listitem> 4580 4581 <listitem> 4582 <para> 4583 [email protected] 4584 </para> 4585 4586 <para> 4587 Discusses bugs, as well as engine internals, design 4588 issues, specific licenses, porting, etc. 4589 </para> 4590 </listitem> 4591 4592 </itemizedlist> 4593 4594 <para> 4595 Our home page can be found at 4596 </para> 4597 4598 <para> 4599 http://www.freetype.org 4600 </para> 3255 4601 3256 4602 </sect3> 4603 3257 4604 </sect2> 4605 3258 4606 <sect2 id="licVPX"> 4607 3259 4608 <title>VPX License</title> 3260 <para> 3261 Copyright (c) 2010, The WebM Project authors. All rights reserved. 3262 </para> 3263 <para> 3264 Redistribution and use in source and binary forms, with or without 3265 modification, are permitted provided that the following conditions are 3266 met: 3267 </para> 4609 4610 <para> 4611 Copyright (c) 2010, The WebM Project authors. All rights 4612 reserved. 4613 </para> 4614 4615 <para> 4616 Redistribution and use in source and binary forms, with or 4617 without modification, are permitted provided that the following 4618 conditions are met: 4619 </para> 4620 3268 4621 <itemizedlist> 4622 3269 4623 <listitem> 3270 4624 <para> 3271 Redistributions of source code must retain the above copyright 3272 notice, this list of conditions and the following disclaimer. 4625 Redistributions of source code must retain the above 4626 copyright notice, this list of conditions and the following 4627 disclaimer. 3273 4628 </para> 3274 4629 </listitem> 4630 3275 4631 <listitem> 3276 4632 <para> 3277 Redistributions in binary form must reproduce the above copyright3278 notice, this list of conditions and the following disclaimer in3279 the documentation and/or other materials provided with the3280 distribution.4633 Redistributions in binary form must reproduce the above 4634 copyright notice, this list of conditions and the following 4635 disclaimer in the documentation and/or other materials 4636 provided with the distribution. 3281 4637 </para> 3282 4638 </listitem> 4639 3283 4640 <listitem> 3284 4641 <para> 3285 Neither the name of Google, nor the WebM Project, nor the names3286 of its contributors may be used to endorse or promote products3287 derived from this software without specific prior written3288 permission.4642 Neither the name of Google, nor the WebM Project, nor the 4643 names of its contributors may be used to endorse or promote 4644 products derived from this software without specific prior 4645 written permission. 3289 4646 </para> 3290 4647 </listitem> 4648 3291 4649 </itemizedlist> 3292 <para> 3293 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 3294 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 3295 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 3296 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 3297 HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 4650 4651 <para> 4652 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 4653 CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 4654 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 4655 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 4656 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR 4657 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 3298 4658 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 3299 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 3300 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 3301 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 3302 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 3303 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3304 </para> 4659 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 4660 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 4661 AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 4662 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 4663 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 4664 THE POSSIBILITY OF SUCH DAMAGE. 4665 </para> 4666 3305 4667 </sect2> 4668 3306 4669 <sect2 id="licOpus"> 4670 3307 4671 <title>Opus License</title> 3308 <para> 3309 Copyright 2001-2011 Xiph.Org, Skype Limited, Octasic, 3310 Jean-Marc Valin, Timothy B. Terriberry, 3311 CSIRO, Gregory Maxwell, Mark Borgerding, 3312 Erik de Castro Lopo 3313 </para> 3314 <para> 3315 Redistribution and use in source and binary forms, with or without 3316 modification, are permitted provided that the following conditions are 3317 met: 3318 </para> 4672 4673 <para> 4674 Copyright 2001-2011 Xiph.Org, Skype Limited, Octasic, Jean-Marc 4675 Valin, Timothy B. Terriberry, CSIRO, Gregory Maxwell, Mark 4676 Borgerding, Erik de Castro Lopo 4677 </para> 4678 4679 <para> 4680 Redistribution and use in source and binary forms, with or 4681 without modification, are permitted provided that the following 4682 conditions are met: 4683 </para> 4684 3319 4685 <itemizedlist> 4686 3320 4687 <listitem> 3321 4688 <para> 3322 Redistributions of source code must retain the above copyright 3323 notice, this list of conditions and the following disclaimer. 4689 Redistributions of source code must retain the above 4690 copyright notice, this list of conditions and the following 4691 disclaimer. 3324 4692 </para> 3325 4693 </listitem> 4694 3326 4695 <listitem> 3327 4696 <para> 3328 Redistributions in binary form must reproduce the above copyright 3329 notice, this list of conditions and the following disclaimer in the 3330 documentation and/or other materials provided with the distribution. 4697 Redistributions in binary form must reproduce the above 4698 copyright notice, this list of conditions and the following 4699 disclaimer in the documentation and/or other materials 4700 provided with the distribution. 3331 4701 </para> 3332 4702 </listitem> 4703 3333 4704 <listitem> 3334 4705 <para> 3335 Neither the name of Internet Society, IETF or IETF Trust, nor the3336 n ames of specific contributors, may be used to endorse or promote3337 products derived from this software without specific prior written3338 permission.4706 Neither the name of Internet Society, IETF or IETF Trust, 4707 nor the names of specific contributors, may be used to 4708 endorse or promote products derived from this software 4709 without specific prior written permission. 3339 4710 </para> 3340 4711 </listitem> 4712 3341 4713 </itemizedlist> 3342 <para> 3343 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 3344 ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 3345 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 3346 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER 3347 OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 3348 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 3349 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 3350 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 3351 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 3352 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 3353 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3354 3355 Opus is subject to the royalty-free patent licenses which are 3356 specified at: 3357 3358 Xiph.Org Foundation: 3359 https://datatracker.ietf.org/ipr/1524/ 3360 3361 Microsoft Corporation: 3362 https://datatracker.ietf.org/ipr/1914/ 3363 3364 Broadcom Corporation: 3365 https://datatracker.ietf.org/ipr/1526/ 3366 </para> 4714 4715 <para> 4716 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 4717 CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, 4718 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 4719 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 4720 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 4721 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 4722 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 4723 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 4724 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 4725 AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 4726 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 4727 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 4728 THE POSSIBILITY OF SUCH DAMAGE. Opus is subject to the 4729 royalty-free patent licenses which are specified at: Xiph.Org 4730 Foundation: https://datatracker.ietf.org/ipr/1524/ Microsoft 4731 Corporation: https://datatracker.ietf.org/ipr/1914/ Broadcom 4732 Corporation: https://datatracker.ietf.org/ipr/1526/ 4733 </para> 4734 3367 4735 </sect2> 4736 3368 4737 </sect1> 4738 3369 4739 </appendix> -
trunk/doc/manual/en_US/user_Troubleshooting.xml
r73276 r76078 11 11 <para> 12 12 This chapter provides answers to commonly asked questions. In order 13 to improve your user experience with VirtualBox, it is recommended14 to read this section to learn more about common pitfalls and get15 recommendations on how to use the product.13 to improve your user experience with &product-name;, it is 14 recommended to read this section to learn more about common pitfalls 15 and get recommendations on how to use the product. 16 16 </para> 17 17 … … 33 33 34 34 <para> 35 If a true VirtualBoxproblem is encountered, it helps to35 If a true &product-name; problem is encountered, it helps to 36 36 categorize and isolate the problem first. Here are some of the 37 37 questions that should be answered before reporting a problem: … … 52 52 <para> 53 53 Is the problem specific to a certain host OS? Problems are 54 usually not host OS specific, because most of the VirtualBox55 code base is shared across all supported platforms, but56 especially in the areas of networking and USB support, there57 are significant differences between host platforms. Some GUI58 related issues are also host specific.54 usually not host OS specific, because most of the 55 &product-name; code base is shared across all supported 56 platforms, but especially in the areas of networking and USB 57 support, there are significant differences between host 58 platforms. Some GUI related issues are also host specific. 59 59 </para> 60 60 </listitem> … … 104 104 Is the problem specific to a certain environment? Some 105 105 problems are related to a particular environment external to 106 the VM ; this usually involves network setup. Certain106 the VM. This usually involves network setup. Certain 107 107 configurations of external servers such as DHCP or PXE may 108 108 expose problems which do not occur with other, similar … … 130 130 <para> 131 131 For problem determination, it is often important to collect 132 debugging information which can be analyzed by VirtualBox132 debugging information which can be analyzed by &product-name; 133 133 support. This section contains information about what kind of 134 134 information can be obtained. … … 136 136 137 137 <para> 138 Every time VirtualBoxstarts up a VM, a so-called138 Every time &product-name; starts up a VM, a so-called 139 139 <emphasis>release log file</emphasis> is created, containing 140 140 lots of information about the VM configuration and runtime 141 141 events. The log file is called 142 <computeroutput> <literal>VBox.log</literal></computeroutput> and143 resides in the VM log file folder. Typically this will be a144 directory as follows:142 <computeroutput>VBox.log</computeroutput> and resides in the VM 143 log file folder. Typically this will be a directory as follows: 144 </para> 145 145 146 146 <screen>$HOME/VirtualBox VMs/{machinename}/Logs</screen> 147 </para>148 147 149 148 <para> … … 152 151 <computeroutput>.3</computeroutput>. Sometimes when there is a 153 152 problem, it is useful to have a look at the logs. Also when 154 requesting support for VirtualBox, supplying the corresponding155 log file is mandatory.156 </para> 157 158 <para> 159 For convenience, for each virtual machine, the VirtualBox main160 window can show these logs in a window. To access it, select a161 virtual machine from the list on the left and select162 <emphasis role="bold">Show logs...</emphasis> from the Machine163 menu.164 </para> 165 166 <para> 167 The release log file (VBox.log)contains a wealth of diagnostic168 information, such as Host OS type and version, VirtualBox169 version and build (32-bit or 64-bit) , a complete dump of the170 guest's configuration (CFGM), detailed information about the171 host CPU type and supported features, whether hardware172 virtualization is enabled, information about VT-x/AMD-V setup,173 state transitions (such as creating, running, paused, stopping),174 guest BIOS messages, Guest Additions messages, device-specific175 log entries and, at the end of execution, final guest state and176 condensed statistics.153 requesting support for &product-name;, supplying the 154 corresponding log file is mandatory. 155 </para> 156 157 <para> 158 For convenience, for each virtual machine, the VirtualBox 159 Manager window can show these logs in a window. To access it, 160 select a virtual machine from the list on the left and select 161 <emphasis role="bold">Show logs...</emphasis> from the 162 <emphasis role="bold">Machine</emphasis> menu. 163 </para> 164 165 <para> 166 The release log file, VBox.log, contains a wealth of diagnostic 167 information, such as Host OS type and version, &product-name; 168 version and build (32-bit or 64-bit). It also includes a 169 complete dump of the guest's configuration (CFGM), detailed 170 information about the host CPU type and supported features, 171 whether hardware virtualization is enabled, information about 172 VT-x/AMD-V setup, state transitions (such as creating, running, 173 paused, stopping), guest BIOS messages, Guest Additions 174 messages, device-specific log entries and, at the end of 175 execution, final guest state and condensed statistics. 177 176 </para> 178 177 … … 181 180 <emphasis>crash dumps</emphasis>. This is true for both host and 182 181 guest crashes. For information about enabling core dumps on 183 Linux, Solaris, and OS X systems, refer to the following core184 dump article on the VirtualBoxwebsite:182 Linux, Oracle Solaris, and OS X systems, refer to the following 183 core dump article on the &product-name; website: 185 184 </para> 186 185 … … 191 190 192 191 <para> 193 You can also use <com puteroutput>VBoxManage194 debugvm</computeroutput> to create a dump of a complete virtual195 machine. See<xref linkend="vboxmanage-debugvm" />.192 You can also use <command>VBoxManage debugvm</command> to create 193 a dump of a complete virtual machine. See 194 <xref linkend="vboxmanage-debugvm" />. 196 195 </para> 197 196 … … 205 204 206 205 <para> 207 VirtualBox provides an ability to capture network traffic only208 on a specific VM's network adapter. Refer to the following209 network tracing article on the VirtualBoxwebsite for206 &product-name; provides an ability to capture network traffic 207 only on a specific VM's network adapter. Refer to the following 208 network tracing article on the &product-name; website for 210 209 information on enabling this capture: 211 210 </para> … … 217 216 218 217 <para> 219 The trace files created by VirtualBoxare in218 The trace files created by &product-name; are in 220 219 <computeroutput>.pcap</computeroutput> format and can be easily 221 220 analyzed with Wireshark. … … 229 228 230 229 <para> 231 VirtualBox includes a built-in VM debugger, which advanced users232 may find useful. This debugger allows for examining and, to some233 extent, controllingthe VM state.230 &product-name; includes a built-in VM debugger, which advanced 231 users may find useful. This debugger enables you to examine and, 232 to some extent, control the VM state. 234 233 </para> 235 234 … … 248 247 <para> 249 248 The VM debugger is available in all regular production versions 250 of VirtualBox, but it is disabled by default because the average251 user will have little use for it. There are two ways to access252 the debugger:249 of &product-name;, but it is disabled by default because the 250 average user will have little use for it. There are two ways to 251 access the debugger: 253 252 </para> 254 253 … … 278 277 <listitem> 279 278 <para> 280 Start the VM directly using <com puteroutput>VirtualBox281 --startvm</com puteroutput>, with an additional279 Start the VM directly using <command>VirtualBox 280 --startvm</command>, with an additional 282 281 <computeroutput>--dbg</computeroutput>, 283 282 <computeroutput>--debug</computeroutput>, or 284 283 <computeroutput>--debug-command-line</computeroutput> 285 argument. See the VirtualBox usage help for details. 284 argument. See the <command>VirtualBox</command> command 285 usage help for details. 286 286 </para> 287 287 </listitem> … … 294 294 environment variable to 295 295 <computeroutput>true</computeroutput> before launching the 296 VirtualBoxprocess. Setting these variables, only their296 &product-name; process. Setting these variables, only their 297 297 presence is checked, is effective even when the first 298 VirtualBoxprocess is the VM selector window. VMs298 &product-name; process is the VM selector window. VMs 299 299 subsequently launched from the selector will have the 300 300 debugger enabled. … … 314 314 315 315 <para> 316 A new Debug menu entry is added to the VirtualBox application. 317 This menu allows the user to open the debugger console. 316 A new <emphasis role="bold">Debug</emphasis> menu entry is added 317 to the &product-name; application. This menu enables the user to 318 open the debugger console. 318 319 </para> 319 320 … … 322 323 and IBM debuggers used on DOS, OS/2, and Windows. Users familiar 323 324 with symdeb, CodeView, or the OS/2 kernel debugger will find the 324 VirtualBox VM debugger familiar. 325 </para> 326 327 <para> 328 The most important command is 329 <computeroutput>help</computeroutput>. This will print brief 330 usage help for all debugger commands. The set of commands 331 supported by the VM debugger changes frequently and the 332 <computeroutput>help</computeroutput> command is always 333 up-to-date. 325 &product-name; VM debugger familiar. 326 </para> 327 328 <para> 329 The most important command is <command>help</command>. This will 330 print brief usage help for all debugger commands. The set of 331 commands supported by the VM debugger changes frequently and the 332 <command>help</command> command is always up-to-date. 334 333 </para> 335 334 … … 453 452 <para> 454 453 The VM debugger supports symbolic debugging, although symbols 455 for guest code are often not available. For Solaris guests, the456 <computeroutput>detect</computeroutput> command automatically454 for guest code are often not available. For Oracle Solaris 455 guests, the <command>detect</command> command automatically 457 456 determines the guest OS version and locates kernel symbols in 458 457 guest's memory. Symbolic debugging is then available. For Linux 459 guests, the <com puteroutput>detect</computeroutput> commands460 also determines the guest OS version, but there are no symbols461 in the guest'smemory. Kernel symbols are available in the file458 guests, the <command>detect</command> commands also determines 459 the guest OS version, but there are no symbols in the guest's 460 memory. Kernel symbols are available in the file 462 461 <computeroutput>/proc/kallsyms</computeroutput> on Linux guests. 463 462 This file must be copied to the host, for example using 464 <computeroutput>scp</computeroutput>. The 465 <computeroutput>loadmap</computeroutput> debugger command can be 466 used to make the symbol information available to the VM 467 debugger. Note that the 463 <command>scp</command>. The <command>loadmap</command> debugger 464 command can be used to make the symbol information available to 465 the VM debugger. Note that the 468 466 <computeroutput>kallsyms</computeroutput> file contains the 469 467 symbols for the currently loaded modules. If the guest's … … 474 472 <para> 475 473 For all guests, a simple way to verify that the correct symbols 476 are loaded is the <com puteroutput>k</computeroutput> command.477 The guest is normally idling and it should be clear from the478 symbolic information that the guest operating system's idle loop479 is beingexecuted.474 are loaded is the <command>k</command> command. The guest is 475 normally idling and it should be clear from the symbolic 476 information that the guest operating system's idle loop is being 477 executed. 480 478 </para> 481 479 482 480 <para> 483 481 Another group of debugger commands is the set of 484 <computeroutput>info</computeroutput> commands. Running 485 <computeroutput>info help</computeroutput> provides complete 486 usage information. The information commands provide ad-hoc data 487 pertinent to various emulated devices and aspects of the VMM. 488 There is no general guideline for using the 489 <computeroutput>info</computeroutput> commands, the right 490 command to use depends entirely on the problem being 491 investigated. Some of the <computeroutput>info</computeroutput> 492 commands are as follows: 482 <command>info</command> commands. Running <command>info 483 help</command> provides complete usage information. The 484 information commands provide ad-hoc data pertinent to various 485 emulated devices and aspects of the VMM. There is no general 486 guideline for using the <command>info</command> commands, the 487 right command to use depends entirely on the problem being 488 investigated. Some of the <command>info</command> commands are 489 as follows: 493 490 </para> 494 491 … … 574 571 575 572 <para> 576 The output of the <com puteroutput>info</computeroutput> commands577 generally requires in-depth knowledge of the emulated device578 and/or VirtualBox VMM internals. However, when used properly,579 theinformation provided can be invaluable.573 The output of the <command>info</command> commands generally 574 requires in-depth knowledge of the emulated device or 575 &product-name; VMM internals. However, when used properly, the 576 information provided can be invaluable. 580 577 </para> 581 578 … … 587 584 588 585 <para> 589 VirtualBoxuses the 64-bit ELF format for its VM core files590 created by <com puteroutput>VBoxManage debugvm</computeroutput>,591 see <xref linkend="vboxmanage-debugvm" />. The VM core file592 containthe memory and CPU dumps of the VM and can be useful for586 &product-name; uses the 64-bit ELF format for its VM core files 587 created by <command>VBoxManage debugvm</command>, see 588 <xref linkend="vboxmanage-debugvm" />. The VM core file contain 589 the memory and CPU dumps of the VM and can be useful for 593 590 debugging your guest OS. The 64-bit ELF object format 594 591 specification can be obtained at: … … 604 601 </para> 605 602 606 <para>607 603 <screen>[ ELF 64 Header] 608 604 [ Program Header, type PT_NOTE ] … … 622 618 [ Additional Notes + Data ] - currently unused 623 619 [ Memory dump ]</screen> 624 </para>625 620 626 621 <para> … … 632 627 <para> 633 628 The relevant data structures and definitions can be found in the 634 VirtualBoxsources under the following header files:629 &product-name; sources under the following header files: 635 630 <computeroutput>include/VBox/dbgfcorefmt.h</computeroutput>, 636 631 <computeroutput>include/iprt/x86.h</computeroutput> and … … 828 823 <para> 829 824 Depending on the specific hardware and host OS, this effect can 830 very significantly skew the CPU usage reported by the OS ; the825 very significantly skew the CPU usage reported by the OS. The 831 826 reported CPU usage can be several times higher than what it 832 827 would have been had the CPU been running at full speed. The … … 891 886 892 887 <para> 893 To use 2D Video Acceleration within VirtualBox, your host's888 To use 2D Video Acceleration within &product-name;, your host's 894 889 video card should support certain OpenGL extensions. On startup, 895 VirtualBox checks for those extensions, and, if the test fails,896 this option is silently grayed out.890 &product-name; checks for those extensions, and, if the test 891 fails, this option is silently grayed out. 897 892 </para> 898 893 … … 929 924 support at all. This happens because Windows 7 predates USB 3.0 930 925 and therefore does not ship with any xHCI drivers. Microsoft 931 also does not offer any vendor-provided xHCI drivers via Windows932 Update.926 also does not offer any vendor-provided xHCI drivers through 927 Windows Update. 933 928 </para> 934 929 … … 984 979 Changing the storage controller hardware will cause bootup 985 980 failures as well. This might also apply to you if you copy a 986 disk image from an older version of VirtualBox to a virtual987 machine created with a newer VirtualBox version; the default988 subtype of IDE controller hardware was changed from PIIX3 to989 PIIX4 with VirtualBox 2.2. Make sure these settings are990 identical.981 disk image from an older version of &product-name; to a 982 virtual machine created with a newer &product-name; version. 983 The default subtype of IDE controller hardware was changed 984 from PIIX3 to PIIX4 with &product-name; 2.2. Make sure these 985 settings are identical. 991 986 </para> 992 987 </listitem> … … 1004 999 (symmetrical multiprocessing, SMP), some configurations of 1005 1000 Windows guests crash with an 0x101 error message, indicating a 1006 timeout for inter -processor interrupts (IPIs). These interrupts1001 timeout for interprocessor interrupts (IPIs). These interrupts 1007 1002 synchronize memory management between processors. 1008 1003 </para> … … 1048 1043 <para> 1049 1044 Installation complains about a failure installing 1050 < literal>msgina.dll</literal>.1045 <computeroutput>msgina.dll</computeroutput>. 1051 1046 </para> 1052 1047 </listitem> … … 1098 1093 1099 1094 <para> 1100 VirtualBox provides a method of halting a guest when it wants to 1101 perform a reset. In order to enable this feature, issue the 1102 following command: 1103 </para> 1104 1105 <para> 1095 &product-name; provides a method of halting a guest when it 1096 wants to perform a reset. In order to enable this feature, use 1097 the following command: 1098 </para> 1099 1106 1100 <screen>VBoxManage setextradata "VM name" "VBoxInternal/PDM/HaltOnReset" 1</screen> 1107 </para>1108 1101 1109 1102 </sect2> … … 1138 1131 <para> 1139 1132 With Windows Vista, Microsoft dropped support for the AMD PCNet 1140 card that VirtualBoxused to provide as the default virtual1133 card that &product-name; used to provide as the default virtual 1141 1134 network card before version 1.6.0. For Windows Vista guests, 1142 VirtualBoxnow uses an Intel E1000 card by default.1135 &product-name; now uses an Intel E1000 card by default. 1143 1136 </para> 1144 1137 … … 1173 1166 The performance for accesses to shared folders from a Windows 1174 1167 guest might be decreased due to delays during the resolution of 1175 the VirtualBox shared folders name service. To fix these delays,1176 add the following entries to the file1168 the &product-name; shared folders name service. To fix these 1169 delays, add the following entries to the file 1177 1170 <computeroutput>\windows\system32\drivers\etc\lmhosts</computeroutput> 1178 1171 of the Windows guest: … … 1201 1194 <para> 1202 1195 The USB HID (Human Interface Device) drivers in Windows 98 are 1203 very old and do not handle tablets the same way all more recent 1204 operating systems do (Windows 2000 and later, Mac OS X, 1205 Solaris). To work around the problem, issue the following 1206 command: 1207 </para> 1208 1209 <para> 1196 very old and do not handle tablets the same way as more recent 1197 operating systems do. For example, Windows 2000 and later, Mac 1198 OS X, and Oracle Solaris. To work around the problem, use the 1199 following command: 1200 </para> 1201 1210 1202 <screen>VBoxManage setextradata "VM name" "VBoxInternal/USB/HidMouse/0/Config/CoordShift" 0</screen> 1211 </para>1212 1203 1213 1204 <para> … … 1225 1216 <para> 1226 1217 If a Windows guest is a member of an Active Directory domain and 1227 the snapshot feature of VirtualBox is used, it could happen it1228 loses this status after you restore an older snapshot.1218 the snapshot feature of &product-name; is used, it could happen 1219 it loses this status after you restore an older snapshot. 1229 1220 </para> 1230 1221 … … 1245 1236 1246 1237 <para> 1247 VirtualBox Guest Additions for Windows prior to 4.1.8 did not1248 properly back up the original d3d8.dll and d3d9.dll system files1249 when selecting and installing the experimental Direct3D support.1250 This process replaces both system files with files from the1251 VirtualBoxGuest Additions so that Direct3D calls can be handled1252 correctly. Although this issue was fixed with VirtualBox 4.1.8,1253 there is no way the Windows Guest Additions installer can repair1254 these files.1255 </para> 1256 1257 <para> 1258 Corruption of these files has no implications i n case 3D1259 acceleration is enabled and basic Direct3D support is installed,1260 that is, without WDDM (on Windows Vista or higher) or on older1261 Windows systems like Windows XP. With the basic Direct3D support1262 allDirect3D 8.0 and Direct3D 9.0 applications will utilize1263 VirtualBoxDirect3D files directly and thus will run as1238 &product-name; Guest Additions for Windows prior to 4.1.8 did 1239 not properly back up the original d3d8.dll and d3d9.dll system 1240 files when selecting and installing the experimental Direct3D 1241 support. This process replaces both system files with files from 1242 the Guest Additions so that Direct3D calls can be handled 1243 correctly. Although this issue was fixed with &product-name; 1244 4.1.8, there is no way the Windows Guest Additions installer can 1245 repair these files. 1246 </para> 1247 1248 <para> 1249 Corruption of these files has no implications if 3D acceleration 1250 is enabled and basic Direct3D support is installed. That is, 1251 without WDDM on Windows Vista or later, or on older Windows 1252 systems like Windows XP. With the basic Direct3D support all 1253 Direct3D 8.0 and Direct3D 9.0 applications will utilize 1254 &product-name; Direct3D files directly and thus will run as 1264 1255 expected. 1265 1256 </para> … … 1272 1263 not work anymore. See below for a step-by-step guide for 1273 1264 restoring the original d3d8.dll and d3d9.dll system files in 1274 case the VirtualBox Guest Additions installer warned about those1275 incorrect files or when having trouble running Direct3D1265 case the &product-name; Guest Additions installer warned about 1266 those incorrect files or when having trouble running Direct3D 1276 1267 applications. 1277 1268 </para> … … 1534 1525 <para> 1535 1526 The following bugs in Linux kernels prevent them from executing 1536 correctly in VirtualBox, causing VM boot crashes:1527 correctly in &product-name;, causing VM boot crashes: 1537 1528 </para> 1538 1529 … … 1543 1534 The Linux kernel version 2.6.18, and some 2.6.17 versions, 1544 1535 introduced a race condition that can cause boot crashes in 1545 VirtualBox. Please use a kernel version 2.6.19 or later.1536 &product-name;. Please use a kernel version 2.6.19 or later. 1546 1537 </para> 1547 1538 </listitem> … … 1563 1554 linkend="settings-system" />, or upgrade 1564 1555 the guest to a newer kernel. 1565 1566 <footnote> 1567 1568 <para> 1569 See 1570 <ulink 1556 </para> 1557 1558 <para> 1559 See 1560 <ulink 1571 1561 url="http://www.mail-archive.com/[email protected]/msg30813.html">http://www.mail-archive.com/[email protected]/msg30813.html</ulink> 1572 for details about the kernel fix. 1573 </para> 1574 1575 </footnote> 1562 for details about the kernel fix. 1576 1563 </para> 1577 1564 </listitem> … … 1587 1574 <para> 1588 1575 Guest desktop services in guests running the X11 window system 1589 such as Solaris and Linux, are provided by a guest service1590 called <computeroutput>VBoxClient</computeroutput>, which runs1591 under the ID of the user who started the desktop session and is1592 automatically started using the following command lines when1593 your X11 user session is started if you are using a common1594 desktop environment (Gnome, KDE and others).1576 such as Oracle Solaris and Linux, are provided by a guest 1577 service called <computeroutput>VBoxClient</computeroutput>, 1578 which runs under the ID of the user who started the desktop 1579 session and is automatically started using the following command 1580 lines when your X11 user session is started if you are using a 1581 common desktop environment such as Gnome or KDE. 1595 1582 </para> 1596 1583 … … 1623 1610 <sect1 id="ts_sol-guests"> 1624 1611 1625 <title> Solaris Guests</title>1612 <title>Oracle Solaris Guests</title> 1626 1613 1627 1614 <sect2 id="ts_solaris-10-guest-crash"> 1628 1615 1629 <title>Older Solaris 10 Releases Crash in 64-bit Mode</title>1630 1631 <para> 1632 Solaris 10 releases up to and including Solaris 10 8/071633 ("S10U4") incorrectly detect newer Intel processors produced1634 since 2007. This problem leads to the 64-bitSolaris kernel1616 <title>Older Oracle Solaris 10 Releases Crash in 64-bit Mode</title> 1617 1618 <para> 1619 Oracle Solaris 10 releases up to and including Oracle Solaris 10 1620 8/07 incorrectly detect newer Intel processors produced since 1621 2007. This problem leads to the 64-bit Oracle Solaris kernel 1635 1622 crashing, and usually causing a triple fault, almost immediately 1636 1623 during startup, in both virtualized and physical environments. … … 1638 1625 1639 1626 <para> 1640 The recommended solution is upgrading to at least Solaris 101641 5/08 ("S10U5"). Alternative solutions include forcingSolaris to1627 The recommended solution is upgrading to at least Oracle Solaris 1628 10 5/08. Alternative solutions include forcing Oracle Solaris to 1642 1629 always boot the 32-bit kernel or applying a patch for bug 1643 6574102 while Solaris is using the 32-bit kernel.1630 6574102 while Oracle Solaris is using the 32-bit kernel. 1644 1631 </para> 1645 1632 … … 1648 1635 <sect2 id="ts_solaris-10-guest-slow-boot-smp"> 1649 1636 1650 <title>Certain Solaris 10 Releases May Take a Long Time to Boot with SMP</title>1651 1652 <para> 1653 When using more than one CPU, Solaris 10 releases 5/081654 ("S10U5"), 10/08 ("S10U6"), and 5/09 ("S10U7")may take a long1637 <title>Certain Oracle Solaris 10 Releases May Take a Long Time to Boot with SMP</title> 1638 1639 <para> 1640 When using more than one CPU, Oracle Solaris 10 5/08, Oracle 1641 Solaris 10 10/08, and Oracle Solaris 10 5/09 may take a long 1655 1642 time to boot and may print warnings on the system console 1656 regarding failures to read from disk. This is a bug in Solaris 1657 10 which affects specific physical and virtual configurations. 1658 It is caused by trying to read microcode updates from the boot 1659 disk when the disk interrupt is reassigned to a not yet fully 1660 initialized secondary CPU. Disk reads will time out and fail, 1661 triggering delays of about 45 seconds and warnings. 1662 </para> 1663 1664 <para> 1665 The recommended solution is upgrading to at least Solaris 10 1666 10/09 ("S10U8") which includes a fix for this problem. 1667 Alternative solutions include restricting the number of virtual 1668 CPUs to one or possibly using a different storage controller. 1643 regarding failures to read from disk. This is a bug in Oracle 1644 Solaris 10 which affects specific physical and virtual 1645 configurations. It is caused by trying to read microcode updates 1646 from the boot disk when the disk interrupt is reassigned to a 1647 not yet fully initialized secondary CPU. Disk reads will time 1648 out and fail, triggering delays of about 45 seconds and 1649 warnings. 1650 </para> 1651 1652 <para> 1653 The recommended solution is upgrading to at least Oracle Solaris 1654 10 10/09 which includes a fix for this problem. Alternative 1655 solutions include restricting the number of virtual CPUs to one 1656 or possibly using a different storage controller. 1669 1657 </para> 1670 1658 … … 1729 1717 1730 1718 <para> 1731 VirtualBoxmakes use of the Microsoft Component Object Model1732 (COM) for inter -process and intra-process communication. This1733 allows VirtualBoxto share a common configuration among1719 &product-name; makes use of the Microsoft Component Object Model 1720 (COM) for interprocess and intraprocess communication. This 1721 enables &product-name; to share a common configuration among 1734 1722 different virtual machine processes and provide several user 1735 1723 interface options based on a common architecture. All global 1736 1724 status information and configuration is maintained by the 1737 1725 process <computeroutput>VBoxSVC.exe</computeroutput>, which is 1738 an out-of-process COM server. Whenever a VirtualBox process is1739 started, it requests access to the COM server and Windows1726 an out-of-process COM server. Whenever an &product-name; process 1727 is started, it requests access to the COM server and Windows 1740 1728 automatically starts the process. Note that it should never be 1741 1729 started by the end user. … … 1744 1732 <para> 1745 1733 When the last process disconnects from the COM server, it will 1746 terminate itself after some seconds. The VirtualBox1734 terminate itself after some seconds. The &product-name; 1747 1735 configuration (XML files) is maintained and owned by the COM 1748 1736 server and the files are locked whenever the server runs. … … 1772 1760 turned off. This is represented by the following key in the 1773 1761 Windows registry: 1774 1775 <screen><literal>HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\Cdrom\Autorun</literal></screen> 1776 1762 </para> 1763 1764 <screen>HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\Cdrom\Autorun</screen> 1765 1766 <para> 1777 1767 Certain applications may disable this key against Microsoft's 1778 1768 advice. If it is set to 0, change it to 1 and reboot your 1779 system. VirtualBoxrelies on Windows notifying it of media1769 system. &product-name; relies on Windows notifying it of media 1780 1770 changes. 1781 1771 </para> … … 1788 1778 1789 1779 <para> 1790 If connecting to a Virtual Machine via the Microsoft RDP client,1791 c alled a Remote Desktop Connection, there can be large delays1792 between input such as moving the mouse over a menu and output.1793 This is because this RDP client collects input for a certain1794 time before sending it to the RDP server.1780 If connecting to a Virtual Machine using the Microsoft RDP 1781 client, called a Remote Desktop Connection, there can be large 1782 delays between input such as moving the mouse over a menu and 1783 output. This is because this RDP client collects input for a 1784 certain time before sending it to the RDP server. 1795 1785 </para> 1796 1786 … … 1839 1829 1 will enable a workaround for this problem until Microsoft 1840 1830 addresses the issue. For example, open a command prompt window 1841 and start VirtualBoxlike this:1831 and start &product-name; like this: 1842 1832 </para> 1843 1833 … … 1858 1848 1859 1849 <para> 1860 If no bridged adapters show up in the Networking section of the 1861 VM settings, this typically means that the bridged networking 1850 If no bridged adapters show up in the 1851 <emphasis role="bold">Networking</emphasis> section of the VM 1852 settings, this typically means that the bridged networking 1862 1853 driver was not installed properly on your host. This could be 1863 1854 due to the following reasons: … … 1871 1862 this case, the MSI log would mention the 1872 1863 <computeroutput>0x8004a029</computeroutput> error code 1873 returned on NetFlt network component install: 1864 returned on NetFlt network component install, as follows: 1865 </para> 1874 1866 1875 1867 <screen>VBoxNetCfgWinInstallComponent: Install failed, hr (0x8004a029)</screen> 1876 </para>1877 1868 1878 1869 <para> 1879 1870 You can try to increase the maximum filter count in the 1880 Windows registry at the following key: 1871 Windows registry using the following key: 1872 </para> 1881 1873 1882 1874 <screen>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Network\MaxNumFilters</screen> 1883 1875 1876 <para> 1884 1877 The maximum number allowed is 14. After a reboot, try to 1885 reinstall VirtualBox.1878 reinstall &product-name;. 1886 1879 </para> 1887 1880 </listitem> … … 1897 1890 <computeroutput>sun_VBoxNetFlt</computeroutput> or 1898 1891 <computeroutput>sun_VBoxNetFltmp</computeroutput> 1899 components. The solution then is to uninstall VirtualBox,1900 remove the INF cache1892 components. The solution then is to uninstall 1893 &product-name;, remove the INF cache 1901 1894 (<computeroutput>%windir%\inf\INFCACHE.1</computeroutput>), 1902 reboot and try to reinstall VirtualBox1895 reboot and try to reinstall &product-name;. 1903 1896 </para> 1904 1897 </listitem> … … 1910 1903 <sect2 id="ts_win-host-host-only-network-adapters"> 1911 1904 1912 <title>Host-only Networking Adapters Cannot be Created</title> 1913 1914 <para> 1915 If host-only adapter cannot be created, either via the Manager 1916 or VBoxManage, then the INF cache is probably corrupt. In this 1917 case, the install log 1905 <title>Host-Only Networking Adapters Cannot be Created</title> 1906 1907 <para> 1908 If a host-only adapter cannot be created, either with the 1909 VirtualBox Manager or the <command>VBoxManage</command> 1910 command, then the INF cache is probably corrupt. In this case, 1911 the install log 1918 1912 (<computeroutput>%windir%\inf\setupapi.log</computeroutput> on 1919 XP or1913 Windows XP or 1920 1914 <computeroutput>%windir%\inf\setupapi.dev.log</computeroutput> 1921 on Vista or later) would typically mention the failure to find a1922 suitable driver package for the1915 on Windows Vista or later) would typically mention the failure 1916 to find a suitable driver package for the 1923 1917 <computeroutput>sun_VBoxNetAdp</computeroutput> component. 1924 1918 Again, as with the bridged networking problem described above, 1925 the solution is to uninstall VirtualBox, remove the INF cache 1919 the solution is to uninstall &product-name;, remove the INF 1920 cache 1926 1921 (<computeroutput>%windir%\inf\INFCACHE.1</computeroutput>), 1927 reboot and try to reinstall VirtualBox.1922 reboot and try to reinstall &product-name;. 1928 1923 </para> 1929 1924 … … 1941 1936 1942 1937 <para> 1943 If the VirtualBoxkernel module,1938 If the &product-name; kernel module, 1944 1939 <computeroutput>vboxdrv</computeroutput>, refuses to load you 1945 1940 may see an "Error inserting vboxdrv: Invalid argument" message. 1946 As root, check the output of the 1947 <computeroutput>dmesg</computeroutput> command to find out why 1948 the load failed. Most probably the kernel disagrees with the 1949 version of <computeroutput>gcc</computeroutput> used to compile 1950 the module. Make sure that you use the same compiler as used to 1951 build the kernel. 1941 As root, check the output of the <command>dmesg</command> 1942 command to find out why the load failed. Most probably the 1943 kernel disagrees with the version of <command>gcc</command> used 1944 to compile the module. Make sure that you use the same compiler 1945 as used to build the kernel. 1952 1946 </para> 1953 1947 … … 1979 1973 <para> 1980 1974 On older Linux distributions, if your CD/DVD device has a 1981 different name, VirtualBox may be unable to find it. On older1982 Linux hosts, VirtualBox performs the following steps to locate1983 your CD/DVD drives:1975 different name, &product-name; may be unable to find it. On 1976 older Linux hosts, &product-name; performs the following steps 1977 to locate your CD/DVD drives: 1984 1978 </para> 1985 1979 … … 1988 1982 <listitem> 1989 1983 <para> 1990 VirtualBoxchecks if the environment variable1984 &product-name; checks if the environment variable 1991 1985 <computeroutput>VBOX_CDROM</computeroutput> is defined. If 1992 so, VirtualBoxomits all the following checks.1993 </para> 1994 </listitem> 1995 1996 <listitem> 1997 <para> 1998 VirtualBoxtests if1986 so, &product-name; omits all the following checks. 1987 </para> 1988 </listitem> 1989 1990 <listitem> 1991 <para> 1992 &product-name; tests if 1999 1993 <computeroutput>/dev/cdrom</computeroutput> works. 2000 1994 </para> … … 2003 1997 <listitem> 2004 1998 <para> 2005 VirtualBox checks if any CD/DVD drives are currently mounted 2006 by checking <computeroutput>/etc/mtab</computeroutput>. 2007 </para> 2008 </listitem> 2009 2010 <listitem> 2011 <para> 2012 VirtualBox checks if any of the entries in 1999 &product-name; checks if any CD/DVD drives are currently 2000 mounted by checking 2001 <computeroutput>/etc/mtab</computeroutput>. 2002 </para> 2003 </listitem> 2004 2005 <listitem> 2006 <para> 2007 &product-name; checks if any of the entries in 2013 2008 <computeroutput>/etc/fstab</computeroutput> point to CD/DVD 2014 2009 devices. … … 2026 2021 2027 2022 <para> 2028 On modern Linux distributions, VirtualBoxuses the hardware2023 On modern Linux distributions, &product-name; uses the hardware 2029 2024 abstraction layer (HAL) to locate CD and DVD hardware. 2030 2025 </para> … … 2039 2034 <xref linkend="ts_linux-host-cd-dvd-not-found-legacy"/> appplies 2040 2035 also to floppy disks, except that on older distributions 2041 VirtualBox tests for <computeroutput>/dev/fd*</computeroutput> 2042 devices by default. This can be overridden with the 2036 &product-name; tests for 2037 <computeroutput>/dev/fd*</computeroutput> devices by default. 2038 This can be overridden with the 2043 2039 <computeroutput>VBOX_FLOPPY</computeroutput> environment 2044 2040 variable. … … 2053 2049 <para> 2054 2050 If the experimental CD/DVD writer support is enabled with an 2055 incorrect VirtualBox, host or guest configuration, it is2051 incorrect &product-name;, host or guest configuration, it is 2056 2052 possible that any attempt to access the CD/DVD writer fails and 2057 2053 simply results in guest kernel error messages for Linux guests 2058 or application error messages for Windows guests. VirtualBox2054 or application error messages for Windows guests. &product-name; 2059 2055 performs the usual consistency checks when a VM is powered up. 2060 2056 In particular, it aborts with an error message if the device for 2061 2057 the CD/DVD writer is not writable by the user starting the VM. 2062 But VirtualBoxcannot detect all misconfigurations. The2058 But &product-name; cannot detect all misconfigurations. The 2063 2059 necessary host and guest OS configuration is not specific for 2064 VirtualBox, but a few frequent problems are listed here which2065 occurred in connection with VirtualBox.2060 &product-name;, but a few frequent problems are listed here 2061 which occurred in connection with &product-name;. 2066 2062 </para> 2067 2063 … … 2069 2065 Special care must be taken to use the correct device. The 2070 2066 configured host CD/DVD device file name, in most cases 2071 <literal>/dev/cdrom</literal>, must point to the device that 2072 allows writing to the CD/DVD unit. For CD/DVD writer units 2073 connected to a SCSI controller or to a IDE controller that 2074 interfaces to the Linux SCSI subsystem (common for some SATA 2075 controllers), this must refer to the SCSI device node, such as 2076 <literal>/dev/scd0</literal>. Even for IDE CD/DVD writer units 2077 this must refer to the appropriate SCSI CD-ROM device node, such 2078 as <literal>/dev/scd0</literal>, if the 2079 <literal>ide-scsi</literal> kernel module is loaded. This module 2080 is required for CD/DVD writer support with all Linux 2.4 kernels 2081 and some early 2.6 kernels. Many Linux distributions load this 2082 module whenever a CD/DVD writer is detected in the system, even 2083 if the kernel would support CD/DVD writers without the module. 2084 VirtualBox supports the use of IDE device files, such as 2085 <literal>/dev/hdc</literal>, provided the kernel supports this 2086 and the <literal>ide-scsi</literal> module is not loaded. 2067 <computeroutput>/dev/cdrom</computeroutput>, must point to the 2068 device that allows writing to the CD/DVD unit. For CD/DVD writer 2069 units connected to a SCSI controller or to a IDE controller that 2070 interfaces to the Linux SCSI subsystem, common for some SATA 2071 controllers, this must refer to the SCSI device node, such as 2072 <computeroutput>/dev/scd0</computeroutput>. Even for IDE CD/DVD 2073 writer units this must refer to the appropriate SCSI CD-ROM 2074 device node, such as <computeroutput>/dev/scd0</computeroutput>, 2075 if the <computeroutput>ide-scsi</computeroutput> kernel module 2076 is loaded. This module is required for CD/DVD writer support 2077 with all Linux 2.4 kernels and some early 2.6 kernels. Many 2078 Linux distributions load this module whenever a CD/DVD writer is 2079 detected in the system, even if the kernel would support CD/DVD 2080 writers without the module. &product-name; supports the use of 2081 IDE device files, such as 2082 <computeroutput>/dev/hdc</computeroutput>, provided the kernel 2083 supports this and the <computeroutput>ide-scsi</computeroutput> 2084 module is not loaded. 2087 2085 </para> 2088 2086 … … 2101 2099 2102 2100 <para> 2103 On Linux, VirtualBox makes use of a custom version of Mozilla2104 XPCOM (cross platform component object model) for inter-process2105 and intra-process communication (IPC). The process2101 On Linux, &product-name; makes use of a custom version of 2102 Mozilla XPCOM (cross platform component object model) for 2103 interprocess and intraprocess communication (IPC). The process 2106 2104 <computeroutput>VBoxSVC</computeroutput> serves as a 2107 communication hub between different VirtualBoxprocesses and2105 communication hub between different &product-name; processes and 2108 2106 maintains the global configuration, such as the XML database. 2109 When starting a VirtualBoxcomponent, the processes2107 When starting an &product-name; component, the processes 2110 2108 <computeroutput>VBoxSVC</computeroutput> and 2111 2109 <computeroutput>VBoxXPCOMIPCD</computeroutput> are started 2112 2110 automatically. They are only accessible from the user account 2113 2111 they are running under. <computeroutput>VBoxSVC</computeroutput> 2114 owns the VirtualBoxconfiguration database which normally2112 owns the &product-name; configuration database which normally 2115 2113 resides in 2116 2114 <computeroutput>~/.config/VirtualBox</computeroutput>, or the 2117 2115 appropriate configuration directory for your operating system. 2118 2116 While it is running, the configuration files are locked. 2119 Communication between the various VirtualBoxcomponents and2117 Communication between the various &product-name; components and 2120 2118 <computeroutput>VBoxSVC</computeroutput> is performed through a 2121 2119 local domain socket residing in 2122 2120 <computeroutput>/tmp/.vbox-<username>-ipc</computeroutput>. 2123 In case there are communication problems, such as a VirtualBox2124 application cannot communicate with2121 In case there are communication problems, such as an 2122 &product-name; application cannot communicate with 2125 2123 <computeroutput>VBoxSVC</computeroutput>, terminate the daemons 2126 2124 and remove the local domain socket directory. … … 2139 2137 mind that group membership does not take effect immediately but 2140 2138 rather at the next login. If available, the 2141 <com puteroutput>newgrp</computeroutput> command may avoid the2142 need for logout/login.2139 <command>newgrp</command> command may avoid the need for a 2140 logout and login. 2143 2141 </para> 2144 2142 … … 2187 2185 <sect1 id="ts_sol-hosts"> 2188 2186 2189 <title> Solaris Hosts</title>2187 <title>Oracle Solaris Hosts</title> 2190 2188 2191 2189 <sect2 id="ts_sol-host-zfs"> … … 2197 2195 cache if the default system settings are not changed. This may 2198 2196 lead to a heavy fragmentation of the host memory preventing 2199 VirtualBox VMs from being started. We recommend to limit the ZFS2200 cache by adding the following line to /etc/system, where2197 &product-name; VMs from being started. We recommend to limit the 2198 ZFS cache by adding the following line to /etc/system, where 2201 2199 <computeroutput>xxxx</computeroutput> bytes is the amount of 2202 2200 memory usable for the ZFS cache. … … 2209 2207 <sect2 id="ts_sol-host-swap-space"> 2210 2208 2211 <title>VM Aborts With Out of Memory Errors on Solaris 10 Hosts</title>2212 2213 <para> 2214 32-bit Solaris 10 hosts (bug 1225025) require swap space equal2215 to, or greater than the host's physical memory size. For2209 <title>VM Aborts With Out of Memory Errors on Oracle Solaris 10 Hosts</title> 2210 2211 <para> 2212 32-bit Oracle Solaris 10 hosts (bug 1225025) require swap space 2213 equal to, or greater than the host's physical memory size. For 2216 2214 example, 8 GB physical memory would require at least 8 GB swap. 2217 This can be configured during a Solaris 10 install by choosing a2218 Custom Install and changing the default partitions.2215 This can be configured during an Oracle Solaris 10 install by 2216 choosing a Custom Install and changing the default partitions. 2219 2217 </para> 2220 2218 2221 2219 <note> 2222 2220 <para> 2223 This restriction applies only to 32-bit Solaris hosts, 64-bit2224 hosts are not affected.2221 This restriction applies only to 32-bit Oracle Solaris hosts, 2222 64-bit hosts are not affected. 2225 2223 </para> 2226 2224 </note> 2227 2225 2228 2226 <para> 2229 For existing Solaris 10 installs, an additional swap image needs2230 to be mounted and used as swap. Hence if you have 1 GB swap and2231 8 GB of physical memory, you require to add 7 GB more swap. This2232 can be done as follows:2227 For existing Oracle Solaris 10 installs, an additional swap 2228 image needs to be mounted and used as swap. Hence if you have 1 2229 GB swap and 8 GB of physical memory, you require to add 7 GB 2230 more swap. This can be done as follows: 2233 2231 </para> 2234 2232 -
trunk/doc/manual/en_US/user_VBoxManage.xml
r75365 r76078 31 31 32 32 <para> 33 As briefly mentioned in <xref linkend="frontends" />, VBoxManage 34 is the command-line interface to VirtualBox. With it, you can 35 completely control VirtualBox from the command line of your host 36 operating system. VBoxManage supports all the features that the 33 As briefly mentioned in <xref linkend="frontends" />, 34 <command>VBoxManage</command> is the command-line interface to 35 &product-name;. With it, you can completely control &product-name; 36 from the command line of your host operating system. 37 <command>VBoxManage</command> supports all the features that the 37 38 graphical user interface gives you access to, but it supports a 38 lot more than that. It exposes reallyall the features of the39 virtualization engine, even those that cannot (yet) be accessed40 from theGUI.39 lot more than that. It exposes all the features of the 40 virtualization engine, even those that cannot be accessed from the 41 GUI. 41 42 </para> 42 43 … … 50 51 <listitem> 51 52 <para> 52 Use a different user interface than the main GUI . For example,53 VBox SDL or the VBoxHeadless server.53 Use a different user interface than the main GUI such as the 54 VBoxHeadless server. 54 55 </para> 55 56 </listitem> … … 66 67 <para> 67 68 There are two main things to keep in mind when using 68 <com puteroutput>VBoxManage</computeroutput>:First,69 <com puteroutput>VBoxManage</computeroutput> must always be used70 with a specific "subcommand", such as "list" or "createvm"or71 "startvm". All the subcommands that72 <computeroutput>VBoxManage</computeroutput> supports are described73 in detail in <xref linkend="vboxmanage" />.69 <command>VBoxManage</command>. First, 70 <command>VBoxManage</command> must always be used with a specific 71 subcommand, such as <command>list</command> or 72 <command>createvm</command> or <command>startvm</command>. All the 73 subcommands that <command>VBoxManage</command> supports are 74 described in detail in <xref linkend="vboxmanage" />. 74 75 </para> 75 76 … … 84 85 <listitem> 85 86 <para> 86 You can specify the VM name, as it is shown in the VirtualBox 87 GUI. Note that if that name contains spaces, then you must 88 enclose the entire name in double quotes (as it is always 89 required with command line arguments that contain spaces). 90 </para> 91 92 <para> 93 For example: 87 You can specify the VM name, as it is shown in the 88 &product-name; GUI. Note that if that name contains spaces, 89 then you must enclose the entire name in double quotes. This 90 is always required with command line arguments that contain 91 spaces. For example: 92 </para> 94 93 95 94 <screen>VBoxManage startvm "Windows XP"</screen> 96 </para>97 95 </listitem> 98 96 … … 100 98 <para> 101 99 You can specify the UUID, which is the internal unique 102 identifier that VirtualBox uses to refer to the virtual 103 machine. Assuming that the aforementioned VM called "Windows 104 XP" has the UUID shown below, the following command has the 105 same effect as the previous: 100 identifier that &product-name; uses to refer to the virtual 101 machine. Assuming that the VM called "Windows XP" has the UUID 102 shown below, the following command has the same effect as the 103 previous example: 104 </para> 106 105 107 106 <screen>VBoxManage startvm 670e746d-abea-4ba6-ad02-2a3b043810a5</screen> 108 </para>109 107 </listitem> 110 108 … … 112 110 113 111 <para> 114 You can type <computeroutput>VBoxManage list vms</computeroutput>115 to have all currently registered VMs listed with all their116 settings, includingtheir respective names and UUIDs.117 </para> 118 119 <para> 120 Some typical examples of how to control VirtualBoxfrom the112 You can enter <command>VBoxManage list vms</command> to have all 113 currently registered VMs listed with all their settings, including 114 their respective names and UUIDs. 115 </para> 116 117 <para> 118 Some typical examples of how to control &product-name; from the 121 119 command line are listed below: 122 120 </para> … … 127 125 <para> 128 126 To create a new virtual machine from the command line and 129 immediately register it with VirtualBox, use 130 <computeroutput>VBoxManage createvm</computeroutput> with the 131 <computeroutput>--register</computeroutput> option, 132 133 <footnote> 134 135 <para> 136 For details, see 137 <xref 138 linkend="vboxmanage-createvm" />. 139 </para> 140 141 </footnote> 142 143 like this: 127 immediately register it with &product-name;, use 128 <command>VBoxManage createvm</command> with the 129 <option>--register</option> option, as follows: 144 130 </para> 145 131 … … 157 143 has been created with a new UUID and a new XML settings file. 158 144 </para> 145 146 <para> 147 For more details, see 148 <xref 149 linkend="vboxmanage-createvm" />. 150 </para> 159 151 </listitem> 160 152 … … 162 154 <para> 163 155 To show the configuration of a particular VM, use 164 <com puteroutput>VBoxManage showvminfo</computeroutput>. See156 <command>VBoxManage showvminfo</command>. See 165 157 <xref 166 158 linkend="vboxmanage-showvminfo" /> for details … … 172 164 <para> 173 165 To change settings while a VM is powered off, use 174 <com puteroutput>VBoxManage modifyvm</computeroutput>. For175 example:166 <command>VBoxManage modifyvm</command>. For example: 167 </para> 176 168 177 169 <screen>VBoxManage modifyvm "Windows XP" --memory 512</screen> 178 </para> 179 180 <para> 181 For details, see <xref linkend="vboxmanage-modifyvm" />. 182 </para> 183 </listitem> 184 185 <listitem> 186 <para> 187 To change the storage configuration (e.g. to add a storage 188 controller and then a virtual disk), use 189 <computeroutput>VBoxManage storagectl</computeroutput> and 190 <computeroutput>VBoxManage storageattach</computeroutput>. See 170 171 <para> 172 See also <xref linkend="vboxmanage-modifyvm" />. 173 </para> 174 </listitem> 175 176 <listitem> 177 <para> 178 To change the storage configuration, such as to add a storage 179 controller and then a virtual disk, use <command>VBoxManage 180 storagectl</command> and <command>VBoxManage 181 storageattach</command>. See 191 182 <xref 192 183 linkend="vboxmanage-storagectl" /> and … … 206 197 <para> 207 198 To start a VM that is currently powered off, use 208 <com puteroutput>VBoxManage startvm</computeroutput>. See199 <command>VBoxManage startvm</command>. See 209 200 <xref 210 201 linkend="vboxmanage-startvm" />. … … 215 206 <para> 216 207 To pause or save a VM that is currently running or change 217 some of its settings, use <com puteroutput>VBoxManage218 controlvm</com puteroutput>. See208 some of its settings, use <command>VBoxManage 209 controlvm</command>. See 219 210 <xref 220 211 linkend="vboxmanage-controlvm" />. … … 234 225 235 226 <para> 236 When running VBoxManage without parameters or when supplying an237 invalid command line, the below syntax diagram will be shown. Note238 that the output will be slightly different depending on the host239 platform; when in doubt, check the output of240 <computeroutput>VBoxManage</computeroutput> for the commands241 availableon your particular host.227 When running <command>VBoxManage</command> without parameters or 228 when supplying an invalid command line, the following command 229 syntax list is shown. Note that the output will be slightly 230 different depending on the host platform. If in doubt, check the 231 output of <command>VBoxManage</command> for the commands available 232 on your particular host. 242 233 </para> 243 234 … … 246 237 247 238 <para> 248 Each time VBoxManage is invoked, only one command can be executed. 249 However, a command might support several subcommands which then 250 can be invoked in one single call. The following sections provide 251 detailed reference information on the different commands. 239 Each time <command>VBoxManage</command> is invoked, only one 240 command can be executed. However, a command might support several 241 subcommands which then can be invoked in one single call. The 242 following sections provide detailed reference information on the 243 different commands. 252 244 </para> 253 245 … … 262 254 <listitem> 263 255 <para> 264 <computeroutput>-v|--version</computeroutput>: show the256 <computeroutput>-v|--version</computeroutput>: Show the 265 257 version of this tool and exit. 266 258 </para> … … 269 261 <listitem> 270 262 <para> 271 <computeroutput>--nologo</computeroutput>: suppress the output272 of the logo information (useful for scripts)273 </para> 274 </listitem> 275 276 <listitem> 277 <para> 278 <computeroutput>--settingspw</computeroutput>: specifiy a279 settings password 280 </para> 281 </listitem> 282 283 <listitem> 284 <para> 285 <computeroutput>--settingspwfile</computeroutput>: specify a263 <computeroutput>--nologo</computeroutput>: Suppress the output 264 of the logo information. This option is useful for scripts. 265 </para> 266 </listitem> 267 268 <listitem> 269 <para> 270 <computeroutput>--settingspw</computeroutput>: Specifiy a 271 settings password. 272 </para> 273 </listitem> 274 275 <listitem> 276 <para> 277 <computeroutput>--settingspwfile</computeroutput>: Specify a 286 278 file containing the settings password. 287 279 </para> … … 292 284 <para> 293 285 The settings password is used for certain settings which need to 294 be stored encrypted for security reasons. At the moment, the only295 encrypted setting is the iSCSI initiator secret (see296 <xref linkend="vboxmanage-storageattach" /> for details). As long297 as no settings password is specified, this information is stored298 in <emphasis role="bold">plain text</emphasis>. After using the286 be stored in encrypted form for security reasons. At the moment, 287 the only encrypted setting is the iSCSI initiator secret, see 288 <xref linkend="vboxmanage-storageattach" />. As long as no 289 settings password is specified, this information is stored in 290 <emphasis>plain text</emphasis>. After using the 299 291 <computeroutput>--settingspw|--settingspwfile</computeroutput> 300 option once, it must be always used , otherwisethe encrypted292 option once, it must be always used. Otherwise, the encrypted 301 293 setting cannot be unencrypted. 302 294 </para> … … 309 301 310 302 <para> 311 The <com puteroutput>list</computeroutput> command gives relevant312 information about your system and information about VirtualBox's313 currentsettings.314 </para> 315 316 <para> 317 The following subcommands are available with 318 <computeroutput>VBoxManage list</computeroutput>:303 The <command>list</command> command gives relevant information 304 about your system and information about &product-name;'s current 305 settings. 306 </para> 307 308 <para> 309 The following subcommands are available with <command>VBoxManage 310 list</command>: 319 311 </para> 320 312 … … 323 315 <listitem> 324 316 <para> 325 <com puteroutput>vms</computeroutput> lists all virtual326 machines currently registered with VirtualBox. By default this327 displays a compact list with each VM's name and UUID; if you328 also specify<computeroutput>--long</computeroutput> or317 <command>vms</command>: Lists all virtual machines currently 318 registered with &product-name;. By default this displays a 319 compact list with each VM's name and UUID. If you also specify 320 <computeroutput>--long</computeroutput> or 329 321 <computeroutput>-l</computeroutput>, this will be a detailed 330 list as with the <computeroutput>showvminfo</computeroutput> 331 command (see below). 332 </para> 333 </listitem> 334 335 <listitem> 336 <para> 337 <computeroutput>runningvms</computeroutput> lists all 338 currently running virtual machines by their unique identifiers 339 (UUIDs) in the same format as with 340 <computeroutput>vms</computeroutput>. 341 </para> 342 </listitem> 343 344 <listitem> 345 <para> 346 <computeroutput>ostypes</computeroutput> lists all guest 347 operating systems presently known to VirtualBox, along with 348 the identifiers used to refer to them with the 349 <computeroutput>modifyvm</computeroutput> command. 350 </para> 351 </listitem> 352 353 <listitem> 354 <para> 355 <computeroutput>hostdvds</computeroutput>, 356 <computeroutput>hostfloppies</computeroutput>, respectively, 357 list DVD, floppy, bridged networking and host-only networking 358 interfaces on the host, along with the name used to access 359 them from within VirtualBox. 360 </para> 361 </listitem> 362 363 <listitem> 364 <para> 365 <computeroutput>intnets</computeroutput> displays information 366 about the internal networks. 367 </para> 368 </listitem> 369 370 <listitem> 371 <para> 372 <computeroutput>bridgedifs</computeroutput>, 373 <computeroutput>hostonlyifs</computeroutput>, 374 <computeroutput>natnets</computeroutput> and 375 <computeroutput>dhcpservers</computeroutput>, respectively, 376 list bridged network interfaces, host-only network interfaces, 377 NAT network interfaces and DHCP servers currently available on 378 the host. Please see 379 <xref 380 linkend="networkingdetails" /> for details on 381 these. 382 </para> 383 </listitem> 384 385 <listitem> 386 <para> 387 <computeroutput>hostinfo</computeroutput> displays information 388 about the host system, such as CPUs, memory size and operating 389 system version. 390 </para> 391 </listitem> 392 393 <listitem> 394 <para> 395 <computeroutput>hostcpuids</computeroutput> dumps the CPUID 396 parameters for the host CPUs. This can be used for a more fine 397 grained analyis of the host's virtualization capabilities. 398 </para> 399 </listitem> 400 401 <listitem> 402 <para> 403 <computeroutput>hddbackends</computeroutput> lists all known 404 virtual disk back-ends of VirtualBox. For each such format 405 (such as VDI, VMDK or RAW), this lists the back-end's 322 list as with the <command>showvminfo</command> command, see 323 <xref linkend="vboxmanage-showvminfo"/>. 324 </para> 325 </listitem> 326 327 <listitem> 328 <para> 329 <command>runningvms</command>: Lists all currently running 330 virtual machines by their unique identifiers (UUIDs) in the 331 same format as with <command>vms</command>. 332 </para> 333 </listitem> 334 335 <listitem> 336 <para> 337 <command>ostypes</command>: Lists all guest operating systems 338 presently known to &product-name;, along with the identifiers 339 used to refer to them with the <command>modifyvm</command> 340 command. 341 </para> 342 </listitem> 343 344 <listitem> 345 <para> 346 <command>hostdvds</command>, <command>hostfloppies</command>: 347 Lists the DVD, floppy, bridged networking, and host-only 348 networking interfaces on the host, along with the name used to 349 access them from within &product-name;. 350 </para> 351 </listitem> 352 353 <listitem> 354 <para> 355 <command>intnets</command>: Displays information about the 356 internal networks. 357 </para> 358 </listitem> 359 360 <listitem> 361 <para> 362 <command>bridgedifs</command>, <command>hostonlyifs</command>, 363 <command>natnets</command>, <command>dhcpservers</command>: 364 Lists the bridged network interfaces, host-only network 365 interfaces, NAT network interfaces, and DHCP servers currently 366 available on the host. See 367 <xref linkend="networkingdetails" />. 368 </para> 369 </listitem> 370 371 <listitem> 372 <para> 373 <command>hostinfo</command>: Displays information about the 374 host system, such as CPUs, memory size, and operating system 375 version. 376 </para> 377 </listitem> 378 379 <listitem> 380 <para> 381 <command>hostcpuids</command>: Lists the CPUID parameters for 382 the host CPUs. This can be used for a more fine grained 383 analyis of the host's virtualization capabilities. 384 </para> 385 </listitem> 386 387 <listitem> 388 <para> 389 <command>hddbackends</command>: Lists all known virtual disk 390 back-ends of &product-name;. For each such format, such as 391 VDI, VMDK, or RAW, this subcommand lists the back-end's 406 392 capabilities and configuration. 407 393 </para> … … 410 396 <listitem> 411 397 <para> 412 <computeroutput>hdds</computeroutput>, 413 <computeroutput>dvds</computeroutput> and 414 <computeroutput>floppies</computeroutput> all give you 415 information about virtual disk images currently in use by 416 VirtualBox, including all their settings, the unique 417 identifiers (UUIDs) associated with them by VirtualBox and all 418 files associated with them. This is the command-line 419 equivalent of the Virtual Media Manager. See 420 <xref 421 linkend="vdis" />. 422 </para> 423 </listitem> 424 425 <listitem> 426 <para> 427 <computeroutput>usbhost</computeroutput> supplies information 428 about USB devices attached to the host, notably information 429 useful for constructing USB filters and whether they are 430 currently in use by the host. 431 </para> 432 </listitem> 433 434 <listitem> 435 <para> 436 <computeroutput>usbfilters</computeroutput> lists all global 437 USB filters registered with VirtualBox -- that is, filters for 438 devices which are accessible to all virtual machines -- and 439 displays the filter parameters. 440 </para> 441 </listitem> 442 443 <listitem> 444 <para> 445 <computeroutput>systemproperties</computeroutput> displays 446 some global VirtualBox settings, such as minimum and maximum 447 guest RAM and virtual hard disk size, folder settings and the 448 current authentication library in use. 449 </para> 450 </listitem> 451 452 <listitem> 453 <para> 454 <computeroutput>extpacks</computeroutput> displays all 455 VirtualBox extension packs currently installed. See 456 <xref 457 linkend="intro-installing" /> and 458 <xref 459 linkend="vboxmanage-extpack" />. 460 </para> 461 </listitem> 462 463 <listitem> 464 <para> 465 <computeroutput>groups</computeroutput> displays details of 466 the VM Groups. See <xref linkend="gui-vmgroups" />. 467 </para> 468 </listitem> 469 470 <listitem> 471 <para> 472 <computeroutput>webcams</computeroutput> displays a list of 473 webcams attached to the running VM. The output format is a 474 list of absolute paths or aliases that were used for attaching 475 the webcams to the VM using the webcam attach command. 476 </para> 477 </listitem> 478 479 <listitem> 480 <para> 481 <computeroutput>screenshotformats</computeroutput> displays a 482 list of available screenshot formats. 398 <command>hdds</command>, <command>dvds</command>, 399 <command>floppies</command>: Shows information about virtual 400 disk images currently in use by &product-name;, including all 401 their settings, the unique identifiers (UUIDs) associated with 402 them by &product-name; and all files associated with them. 403 This is the command-line equivalent of the Virtual Media 404 Manager. See <xref linkend="vdis" />. 405 </para> 406 </listitem> 407 408 <listitem> 409 <para> 410 <command>usbhost</command>: Shows information about USB 411 devices attached to the host, including information useful for 412 constructing USB filters and whether they are currently in use 413 by the host. 414 </para> 415 </listitem> 416 417 <listitem> 418 <para> 419 <command>usbfilters</command>: Lists all global USB filters 420 registered with &product-name; and displays the filter 421 parameters. Global USB filters are for devices which are 422 accessible to all virtual machines. 423 </para> 424 </listitem> 425 426 <listitem> 427 <para> 428 <command>systemproperties</command>: Displays some global 429 &product-name; settings, such as minimum and maximum guest RAM 430 and virtual hard disk size, folder settings and the current 431 authentication library in use. 432 </para> 433 </listitem> 434 435 <listitem> 436 <para> 437 <command>extpacks</command>: Displays all &product-name; 438 extension packs that are currently installed. See 439 <xref linkend="intro-installing" /> and 440 <xref linkend="vboxmanage-extpack" />. 441 </para> 442 </listitem> 443 444 <listitem> 445 <para> 446 <command>groups</command>: Displays details of the VM Groups. 447 See <xref linkend="gui-vmgroups" />. 448 </para> 449 </listitem> 450 451 <listitem> 452 <para> 453 <command>webcams</command>: Displays a list of webcams 454 attached to the running VM. The output format is a list of 455 absolute paths or aliases that were used for attaching the 456 webcams to the VM using the webcam attach command. 457 </para> 458 </listitem> 459 460 <listitem> 461 <para> 462 <command>screenshotformats</command>: Displays a list of 463 available screenshot formats. 464 </para> 465 </listitem> 466 467 <listitem> 468 <para> 469 <command>cloudproviders</command>: Displays a list of cloud 470 providers that are supported by &product-name;. &oci; is an 471 example of a cloud provider. 472 </para> 473 </listitem> 474 475 <listitem> 476 <para> 477 <command>cloudprofiles</command>: Displays a list of cloud 478 profiles that have been configured. 479 </para> 480 481 <para> 482 Cloud profiles are used when exporting VMs to a cloud service. 483 See <xref linkend="ovf-export-oci"/>. 483 484 </para> 484 485 </listitem> … … 493 494 494 495 <para> 495 The <computeroutput>showvminfo</computeroutput> command shows 496 information about a particular virtual machine. This is the same 497 information as <computeroutput>VBoxManage list vms 498 --long</computeroutput> would show for all virtual machines. 499 </para> 500 501 <para> 502 You will get information that resembles the following example. 503 </para> 504 505 <para> 496 The <command>showvminfo</command> command shows information about 497 a particular virtual machine. This is the same information as 498 <command>VBoxManage list vms --long</command> would show for all 499 virtual machines. 500 </para> 501 502 <para> 503 You will see information as shown in the following example. 504 </para> 505 506 506 <screen>$ VBoxManage showvminfo "Windows XP" 507 507 VirtualBox Command Line Management Interface Version <replaceable>version-number</replaceable> … … 525 525 ... 526 526 </screen> 527 </para>528 527 529 528 <para> 530 529 Use the <computeroutput>--machinereadable</computeroutput> option 531 to produce the same output, but in machine readable format: 532 property="value" on a line by line basis, e.g.: 533 </para> 534 535 <para> 530 to produce the same output, but in machine readable format with a 531 property=value string on each line. For example: 532 </para> 533 536 534 <screen> 537 name="VBoxSDL --startvm OL7.2" 535 ... 538 536 groups="/" 539 537 ostype="Oracle (64-bit)" 540 538 UUID="457af700-bc0a-4258-aa3c-13b03da171f2" 541 539 ... 542 </screen> 543 </para> 540 </screen> 544 541 545 542 </sect1> … … 550 547 551 548 <para> 552 The <computeroutput>registervm</computeroutput> command allows you 553 to import a virtual machine definition in an XML file into 554 VirtualBox. The machine must not conflict with one already 555 registered in VirtualBox and it may not have any hard or removable 556 disks attached. It is advisable to place the definition file in 557 the machines folder before registering it. 558 559 <note> 560 <para> 561 When creating a new virtual machine with 562 <computeroutput>VBoxManage createvm</computeroutput> (see 563 below), you can directly specify the 564 <computeroutput>--register</computeroutput> option to avoid 565 having to register it separately. 566 </para> 567 </note> 568 </para> 569 570 <para> 571 The <computeroutput>unregistervm</computeroutput> command 572 unregisters a virtual machine. If 573 <computeroutput>--delete</computeroutput> is also specified, the 574 following files will automatically be deleted as well: 575 </para> 576 577 <orderedlist> 549 The <computeroutput>registervm</computeroutput> command enables 550 you to import a virtual machine definition in an XML file into 551 &product-name;. The machine must not conflict with one already 552 registered in &product-name; and it may not have any hard or 553 removable disks attached. It is advisable to place the definition 554 file in the machines folder before registering it. 555 </para> 556 557 <note> 558 <para> 559 When creating a new virtual machine with <command>VBoxManage 560 createvm</command>, as shown in 561 <xref linkend="vboxmanage-createvm"/>, you can directly specify 562 the <option>--register</option> option to avoid having to 563 register it separately. 564 </para> 565 </note> 566 567 <para> 568 The <command>unregistervm</command> command unregisters a virtual 569 machine. If <option>--delete</option> is also specified, the 570 following files will also be deleted automatically: 571 </para> 572 573 <itemizedlist> 578 574 579 575 <listitem> … … 587 583 <para> 588 584 Saved state files that the machine created. One if the machine 589 was in "saved"state and one for each online snapshot.590 </para> 591 </listitem> 592 593 <listitem> 594 <para> 595 The machine XML file and its backups ,585 was in Saved state and one for each online snapshot. 586 </para> 587 </listitem> 588 589 <listitem> 590 <para> 591 The machine XML file and its backups. 596 592 </para> 597 593 </listitem> … … 610 606 </listitem> 611 607 612 </ orderedlist>608 </itemizedlist> 613 609 614 610 </sect1> … … 619 615 620 616 <para> 621 This command creates a new XML virtual machine definition file. 622 </para> 623 624 <para> 625 The <computeroutput>--name <name></computeroutput> parameter 626 is required and must specify the name of the machine. Since this 627 name is used by default as the file name of the settings file 628 (with the extension <computeroutput>.xml</computeroutput>) and the 629 machine folder (a subfolder of the 617 The <command>VBoxManage createvm</command> command creates a new 618 XML virtual machine definition file. 619 </para> 620 621 <para> 622 You must specify the name of the VM by using <option>--name 623 <replaceable>name</replaceable></option>. This name is used by 624 default as the file name of the settings file that has the 625 <computeroutput>.xml</computeroutput> extension and the machine 626 folder, which is a subfolder of the 630 627 <computeroutput>.config/VirtualBox/Machines</computeroutput> 631 folder - this folder name may vary depending on the operating632 system and the version of VirtualBox which you are using), it must633 conform to your host operating system's requirements for file name634 specifications. If the VM is later renamed, the file and folder 635 names will change automatically.636 </para>637 638 <para>639 However, if the <computeroutput>--basefolder640 <path></computeroutput> option is used, the machine folder 641 will be named <computeroutput><path></computeroutput>. In642 this case, the names of the file and the folder will not change if643 the virtual machine is renamed.644 </para>645 646 <para> 647 If the <computeroutput>--group <group>, ...</computeroutput>648 option is used, the machine will be assigned membership of the649 specified VM groups in the list. Note that group ids always start650 with a <computeroutput>/</computeroutput> and can be nested. By651 default, VMs are always assigned membership of the group652 <computeroutput>/</computeroutput>.653 </para>654 655 <para> 656 If the <computeroutput>--ostype <ostype></computeroutput>:657 option is used, <ostype> specifies the guest operating658 system to run in the VM. To learn about the available OS options,659 run <computeroutput>VBoxManage list ostypes</computeroutput> .660 </para>661 662 <para> 663 If the <computeroutput>--uuid <uuid></computeroutput>:664 option is used, <uuid> specifies the VM uuid. This must be665 unique within the namespace of the host, or that of the VM Group666 if it is assigned to a VM group membership. By default, a unique667 uuid within the appropriate namespace is automatically generated.668 </para>669 670 <para> 671 If the <computeroutput>--default</computeroutput> option is used,672 default hardware configuration for specified guest operation673 system will be applied. By default, VM is created with minimal674 hardware.675 </para> 676 677 <para> 678 By default, this command only creates the XML file without679 automatically registering the VM with your VirtualBox680 installation. To register the VM instantly, use the optional681 <computeroutput>--register</computeroutput> option, or run682 <computeroutput>VBoxManage registervm</computeroutput> separately683 afterwards.628 folder. Note that the machine folder path name varies based on the 629 OS type and the &product-name; version. 630 </para> 631 632 <para> 633 Ensure that the VM name conforms to the host OS's file name 634 requirements. If you later rename the VM, the file and folder 635 names will be updated to match the new name automatically. 636 </para> 637 638 <para> 639 The <option>--basefolder <replaceable>path</replaceable></option> 640 option specifies the machine folder path name. Note that the names 641 of the file and the folder do not change if you rename the VM. 642 </para> 643 644 <para> 645 The <option>--group <replaceable>group-ID</replaceable>, 646 ...</option> option assigns the VM to the specified groups. Note 647 that group IDs always start with 648 <computeroutput>/</computeroutput> so that they can be nested. By 649 default, each VM is assigned membership to the 650 <computeroutput>/</computeroutput> group. 651 </para> 652 653 <para> 654 The <option>--ostype <replaceable>ostype</replaceable></option> 655 option specifies the guest OS to run in the VM. Run the 656 <command>VBoxManage list ostypes</command> command to see the 657 available OS types. 658 </para> 659 660 <para> 661 The <option>--uuid <replaceable>uuid</replaceable></option> option 662 specifies the universal unique identifier (UUID) of the VM. The 663 UUID must be unique within the namespace of the host or of its VM 664 group memberships. By default, the <command>VBoxManage</command> 665 command automatically generates the UUID. 666 </para> 667 668 <para> 669 The <computeroutput>--default</computeroutput> option applies a 670 default hardware configuration for the specified guest OS. By 671 default, the VM is created with minimal hardware. 672 </para> 673 674 <para> 675 The <option>--register</option> option registers the VM with your 676 &product-name; installation. By default, the <command>VBoxManage 677 createvm</command> command creates only the XML configuration for 678 the VM but does not registered the VM. If you do not register the 679 VM at creation, you can run the <command>VBoxManage 680 registervm</command> command after you create the VM. 684 681 </para> 685 682 … … 694 691 machine which is not running. Most of the properties that this 695 692 command makes available correspond to the VM settings that 696 VirtualBoxgraphical user interface displays in each VM's697 "Settings" dialog. These were described in698 <xref linkend="BasicConcepts" />. Some of the more advanced699 settings, however,are only available through the700 <com puteroutput>VBoxManage</computeroutput> interface.701 </para> 702 703 <para> 704 These commands require that the machine is powered off (neither705 running nor in "saved" state). Some machine settings can also be706 changed while a machine is running ; those settings will then have707 a corresponding subcommand with the <com puteroutput>VBoxManage708 controlvm</com puteroutput> subcommand. See693 &product-name; graphical user interface displays in each VM's 694 <emphasis role="bold">Settings</emphasis> dialog. These are 695 described in <xref linkend="BasicConcepts" />. However, some of 696 the more advanced settings are only available through the 697 <command>VBoxManage</command> interface. 698 </para> 699 700 <para> 701 These commands require that the machine is powered off, neither 702 running nor in a Saved state. Some machine settings can also be 703 changed while a machine is running. Those settings will then have 704 a corresponding subcommand with the <command>VBoxManage 705 controlvm</command> subcommand. See 709 706 <xref linkend="vboxmanage-controlvm" />. 710 707 </para> … … 716 713 <para> 717 714 The following general settings are available through 718 <com puteroutput>VBoxManage modifyvm</computeroutput>:715 <command>VBoxManage modifyvm</command>: 719 716 </para> 720 717 … … 723 720 <listitem> 724 721 <para> 725 <computeroutput>--name <name></computeroutput>: This726 changes the VM's name and can be used to rename the internal722 <computeroutput>--name <name></computeroutput>: 723 Changes the VM's name and can be used to rename the internal 727 724 virtual machine files, as described in 728 725 <xref linkend="vboxmanage-createvm"/>. … … 733 730 <para> 734 731 <computeroutput>--groups <group>, 735 ...</computeroutput>: This changes the group membership of a736 VM.Groups always start with a732 ...</computeroutput>: Changes the group membership of a VM. 733 Groups always start with a 737 734 <computeroutput>/</computeroutput> and can be nested. By 738 735 default VMs are in group <computeroutput>/</computeroutput>. … … 743 740 <para> 744 741 <computeroutput>--description <desc></computeroutput>: 745 This changes the VM's description, which is a way to record742 Changes the VM's description, which is a way to record 746 743 details about the VM in a way which is meaningful for the 747 744 user. The GUI interprets HTML formatting, the command line … … 754 751 <para> 755 752 <computeroutput>--ostype <ostype></computeroutput>: 756 This specifies what guest operating system is supposed to 757 run in the VM. To learn about the various identifiers that 758 can be used here, use <computeroutput>VBoxManage list 759 ostypes</computeroutput>. 753 Specifies what guest operating system is supposed to run in 754 the VM. To learn about the various identifiers that can be 755 used here, use <command>VBoxManage list ostypes</command>. 760 756 </para> 761 757 </listitem> … … 764 760 <para> 765 761 <computeroutput>--iconfile 766 <filename></computeroutput>: This specifies the767 absolute path on the host file system for the VirtualBox768 icon tobe displayed in the VM.762 <filename></computeroutput>: Specifies the absolute 763 path on the host file system for the &product-name; icon to 764 be displayed in the VM. 769 765 </para> 770 766 </listitem> … … 773 769 <para> 774 770 <computeroutput>--memory 775 <memorysize></computeroutput>: This sets the amount of776 RAM, in MB, that the virtual machine should allocate for777 itselffrom the host. See <xref linkend="gui-createvm" />.771 <memorysize></computeroutput>: Sets the amount of RAM, 772 in MB, that the virtual machine should allocate for itself 773 from the host. See <xref linkend="gui-createvm" />. 778 774 </para> 779 775 </listitem> … … 782 778 <para> 783 779 <computeroutput>--pagefusion on|off</computeroutput>: 784 Enables/disables (default) the Page Fusion feature. The Page 785 Fusion feature minimises memory duplication between VMs with 786 similar configurations running on the same host. See 780 Enables and disables the Page Fusion feature. Page Fusion is 781 disabled by default. The Page Fusion feature minimises 782 memory duplication between VMs with similar configurations 783 running on the same host. See 787 784 <xref linkend="guestadd-pagefusion" />. 788 785 </para> … … 792 789 <para> 793 790 <computeroutput>--vram <vramsize></computeroutput>: 794 This sets the amount of RAM that the virtual graphics card795 shouldhave. See <xref linkend="settings-display" />.791 Sets the amount of RAM that the virtual graphics card should 792 have. See <xref linkend="settings-display" />. 796 793 </para> 797 794 </listitem> … … 800 797 <para> 801 798 <computeroutput>--acpi on|off</computeroutput> and 802 <computeroutput>--ioapic on|off</computeroutput>: These 803 settings determine whether the VM should have ACPI and I/O 804 APIC support, respectively. See 799 <computeroutput>--ioapic on|off</computeroutput>: Determines 800 whether the VM has ACPI and I/O APIC support. See 805 801 <xref linkend="settings-motherboard" />. 806 802 </para> … … 829 825 <computeroutput>--hardwareuuid 830 826 <uuid></computeroutput>: The UUID presented to the 831 guest via memory tables (DMI/SMBIOS), hardware and guest832 properties. By default this is the same as the VM uuid.833 U seful when cloning a VM. Teleporting takes care of this834 automatically.827 guest through memory tables (DMI/SMBIOS), hardware, and 828 guest properties. By default this is the same as the VM 829 UUID. This setting is useful when cloning a VM. Teleporting 830 takes care of this automatically. 835 831 </para> 836 832 </listitem> … … 839 835 <para> 840 836 <computeroutput>--cpus <cpucount></computeroutput>: 841 This sets the number of virtual CPUs for the virtual842 machine, see <xref linkend="settings-processor" />. If CPU843 hot-plugging is enabled, this then sets the844 <emphasis>maximum</emphasis> number of virtual CPUs that can845 be plugged into the virtualmachines.846 </para> 847 </listitem> 848 849 <listitem> 850 <para> 851 <computeroutput>--cpuhotplug on|off</computeroutput>: This852 enables CPU hot-plugging. When enabled, virtual CPUs can be837 Sets the number of virtual CPUs for the virtual machine, see 838 <xref linkend="settings-processor" />. If CPU hot-plugging 839 is enabled, this then sets the <emphasis>maximum</emphasis> 840 number of virtual CPUs that can be plugged into the virtual 841 machines. 842 </para> 843 </listitem> 844 845 <listitem> 846 <para> 847 <computeroutput>--cpuhotplug on|off</computeroutput>: 848 Enables CPU hot-plugging. When enabled, virtual CPUs can be 853 849 added to and removed from a virtual machine while it is 854 850 running. See <xref linkend="cpuhotplug" />. … … 860 856 <computeroutput>--plugcpu|unplugcpu 861 857 <id></computeroutput>: If CPU hot-plugging is enabled, 862 this adds or removes a virtual CPU on the virtual machine. 863 <computeroutput><id></computeroutput> specifies the 864 index of the virtual CPU to be added or removed and must be 865 a number from 0 to the maximum no. of CPUs configured with 866 the <computeroutput>--cpus</computeroutput> option. CPU 0 867 can never be removed. 858 this setting adds or removes a virtual CPU on the virtual 859 machine. <computeroutput><id></computeroutput> 860 specifies the index of the virtual CPU to be added or 861 removed and must be a number from 0 to the maximum number of 862 CPUs configured with the 863 <computeroutput>--cpus</computeroutput> option. CPU 0 can 864 never be removed. 868 865 </para> 869 866 </listitem> … … 872 869 <para> 873 870 <computeroutput>--cpuexecutioncap 874 <1-100></computeroutput>: This setting controls how 875 much CPUtime a virtual CPU can use. A value of 50 implies a 876 single virtual CPU can use up to 50% of a single host CPU. 877 </para> 878 </listitem> 879 880 <listitem> 881 <para> 882 <computeroutput>--pae on|off</computeroutput>: This 883 enables/disables PAE. See 871 <1-100></computeroutput>: Controls how much CPU time a 872 virtual CPU can use. A value of 50 implies a single virtual 873 CPU can use up to 50% of a single host CPU. 874 </para> 875 </listitem> 876 877 <listitem> 878 <para> 879 <computeroutput>--pae on|off</computeroutput>: Enables and 880 disables PAE. See <xref linkend="settings-processor" />. 881 </para> 882 </listitem> 883 884 <listitem> 885 <para> 886 <computeroutput>--longmode on|off</computeroutput>: Enables 887 and disables long mode. See 884 888 <xref linkend="settings-processor" />. 885 889 </para> … … 888 892 <listitem> 889 893 <para> 890 <computeroutput>--longmode on|off</computeroutput>: This 891 enables/disables long mode. See 892 <xref linkend="settings-processor" />. 893 </para> 894 </listitem> 895 896 <listitem> 897 <para> 898 <computeroutput>--spec-ctrl on|off</computeroutput>: This 899 setting enables/disables exposing speculation control 900 interfaces to the guest, provided they are available on the 901 host. Depending on the host CPU and workload, enabling 902 speculation control may significantly reduce performance. 894 <computeroutput>--spec-ctrl on|off</computeroutput>: Enables 895 and disables the exposure of speculation control interfaces 896 to the guest, provided they are available on the host. 897 Depending on the host CPU and workload, enabling speculation 898 control may significantly reduce performance. 903 899 </para> 904 900 </listitem> … … 907 903 <para> 908 904 <computeroutput>--cpu-profile <host|intel 909 80[86|286|386]></computeroutput>: This enables 910 specification of a profile for guest CPU emulation. Specify 911 either one based on the host system CPU (host), or one from 912 a number of older Intel Micro-architectures - 8086, 80286, 913 80386. 914 </para> 915 </listitem> 916 917 <listitem> 918 <para> 919 <computeroutput>--hpet on|off</computeroutput>: This 920 enables/disables a High Precision Event Timer (HPET) which 921 can replace the legacy system timers. This is turned off by 905 80[86|286|386]></computeroutput>: Enables specification 906 of a profile for guest CPU emulation. Specify either one 907 based on the host system CPU (host), or one from a number of 908 older Intel Micro-architectures: 8086, 80286, 80386. 909 </para> 910 </listitem> 911 912 <listitem> 913 <para> 914 <computeroutput>--hpet on|off</computeroutput>: Enables and 915 disables a High Precision Event Timer (HPET) which can 916 replace the legacy system timers. This is turned off by 922 917 default. Note that Windows supports a HPET only from Vista 923 918 onwards. … … 927 922 <listitem> 928 923 <para> 929 <computeroutput>--hwvirtex on|off</computeroutput>: This930 enables or disables the use of hardware virtualization931 extensions (Intel VT-x or AMD-V) in the processor of your932 hostsystem. See <xref linkend="hwvirt" />.924 <computeroutput>--hwvirtex on|off</computeroutput>: Enables 925 and disables the use of hardware virtualization extensions, 926 such as Intel VT-x or AMD-V, in the processor of your host 927 system. See <xref linkend="hwvirt" />. 933 928 </para> 934 929 </listitem> … … 937 932 <para> 938 933 <computeroutput>--triplefaultreset on|off</computeroutput>: 939 This setting enables resetting of the guest instead of940 triggering a Guru Meditation. Some guests raise a triple941 fault to reset the CPU so sometimes this is desired942 behavior. Works only fornon-SMP guests.943 </para> 944 </listitem> 945 946 <listitem> 947 <para> 948 <computeroutput>--apic on|off</computeroutput>: This setting949 enables(default)/disables IO APIC. With I/O APIC, operating950 systems can use more than 16 interrupt requests (IRQs) thus951 avoiding IRQ sharing for improved reliability. See952 <xref linkend="settings-motherboard" />.953 </para> 954 </listitem> 955 956 <listitem> 957 <para> 958 <computeroutput>--x2apic on|off</computeroutput>: This959 setting enables(default)/disables CPU x2APIC support. CPU960 x2APIC support helps operating systems run more efficiently961 on high core count configurations, and optimizes interrupt962 distribution in virtualized environments. Disable when using963 host/guest operating systems incompatible with x2APIC964 support.934 Enables resetting of the guest instead of triggering a Guru 935 Meditation. Some guests raise a triple fault to reset the 936 CPU so sometimes this is desired behavior. Works only for 937 non-SMP guests. 938 </para> 939 </listitem> 940 941 <listitem> 942 <para> 943 <computeroutput>--apic on|off</computeroutput>: Enables and 944 disables I/O APIC. With I/O APIC, operating systems can use 945 more than 16 interrupt requests (IRQs) thus avoiding IRQ 946 sharing for improved reliability. This setting is enabled by 947 default. See <xref linkend="settings-motherboard" />. 948 </para> 949 </listitem> 950 951 <listitem> 952 <para> 953 <computeroutput>--x2apic on|off</computeroutput>: Enables 954 and disables CPU x2APIC support. CPU x2APIC support helps 955 operating systems run more efficiently on high core count 956 configurations, and optimizes interrupt distribution in 957 virtualized environments. This setting is enabled by 958 default. Disable this setting when using host or guest 959 operating systems that are incompatible with x2APIC support. 965 960 </para> 966 961 </listitem> … … 970 965 <computeroutput>--paravirtprovider 971 966 none|default|legacy|minimal|hyperv|kvm</computeroutput>: 972 This setting specifies which paravirtualization interface to973 provide tothe guest operating system. Specifying967 Specifies which paravirtualization interface to provide to 968 the guest operating system. Specifying 974 969 <computeroutput>none</computeroutput> explicitly turns off 975 970 exposing any paravirtualization interface. The option 976 <computeroutput>default</computeroutput> , will pickan977 appropriate interface depending on the guest OS type while978 starting the VM. This is the default option chosen while971 <computeroutput>default</computeroutput> selects an 972 appropriate interface when starting the VM, depending on the 973 guest OS type. This is the default option chosen when 979 974 creating new VMs. The 980 <computeroutput>legacy</computeroutput> option is chosenfor981 VMs which were created with older VirtualBox versions and982 will pick a paravirtualization interface while starting the983 VM with VirtualBox5.0 and newer. The975 <computeroutput>legacy</computeroutput> option is used for 976 VMs which were created with older &product-name; versions 977 and will pick a paravirtualization interface when starting 978 the VM with &product-name; 5.0 and newer. The 984 979 <computeroutput>minimal</computeroutput> provider is 985 mandatory for Mac OS X guests , while980 mandatory for Mac OS X guests. 986 981 <computeroutput>kvm</computeroutput> and 987 982 <computeroutput>hyperv</computeroutput> are recommended for … … 993 988 <listitem> 994 989 <para> 995 <computeroutput>--paravirtdebug <key =value>996 [,<key =value> ...]</computeroutput>: This setting997 specifies debugging options specific to the998 p aravirtualization provider configured for this VM. See the999 provider specific options in <xref linkend="gimdebug" /> for1000 a list of supported key-value pairs for each provider.990 <computeroutput>--paravirtdebug <keyword=value> 991 [,<keyword=value> ...]</computeroutput>: Specifies 992 debugging options specific to the paravirtualization 993 provider configured for this VM. See the provider specific 994 options in <xref linkend="gimdebug" /> for a list of 995 supported keyword-value pairs for each provider. 1001 996 </para> 1002 997 </listitem> … … 1030 1025 this additional setting enables or disables the use of the 1031 1026 tagged TLB (VPID) feature in the processor of your host 1032 system. See <xref 1033 linkend="hwvirt" />. 1027 system. See <xref linkend="hwvirt" />. 1034 1028 </para> 1035 1029 </listitem> … … 1049 1043 the Guest Additions are installed, this setting enables or 1050 1044 disables hardware 3D acceleration. See 1051 <xref 1052 linkend="guestadd-3d" />. 1045 <xref linkend="guestadd-3d" />. 1053 1046 </para> 1054 1047 </listitem> … … 1059 1052 If the Guest Additions are installed, this setting enables 1060 1053 or disables 2D video acceleration. See 1061 <xref 1062 linkend="guestadd-2d" />. 1054 <xref linkend="guestadd-2d" />. 1063 1055 </para> 1064 1056 </listitem> … … 1067 1059 <para> 1068 1060 <computeroutput>--chipset piix3|ich9</computeroutput>: By 1069 default VirtualBox emulates an Intel PIIX3 chipset. Usually 1070 there is no reason to change the default setting unless this 1071 is required to relax some of its constraints. See 1072 <xref 1073 linkend="settings-motherboard" />. 1061 default, &product-name; emulates an Intel PIIX3 chipset. 1062 Usually there is no reason to change the default setting 1063 unless this is required to relax some of its constraints. 1064 See <xref linkend="settings-motherboard" />. 1074 1065 </para> 1075 1066 </listitem> … … 1079 1070 You can influence the BIOS logo that is displayed when a 1080 1071 virtual machine starts up with a number of settings. By 1081 default, a VirtualBoxlogo is displayed.1072 default, an &product-name; logo is displayed. 1082 1073 </para> 1083 1074 … … 1098 1089 <para> 1099 1090 With <computeroutput>--bioslogoimagepath 1100 <imagepath></computeroutput> you can , if you are so1101 inclined, replace the image that is shown, with your own1102 logo. The image must be an uncompressed 256 color BMP file1103 without color space information (Windows 3.0 format). The1104 image must not bebigger than 640 x 480.1091 <imagepath></computeroutput> you can replace the image 1092 that is shown with your own logo. The image must be an 1093 uncompressed 256 color BMP file without color space 1094 information (Windows 3.0 format). The image must not be 1095 bigger than 640 x 480. 1105 1096 </para> 1106 1097 </listitem> … … 1109 1100 <para> 1110 1101 <computeroutput>--biosbootmenu 1111 disabled|menuonly|messageandmenu</computeroutput>: This 1112 specifies whether the BIOS allows the user to select a 1113 temporary boot device. 1114 <computeroutput>menuonly</computeroutput> suppresses the 1115 message, but the user can still press F12 to select a 1116 temporary boot device. 1102 disabled|menuonly|messageandmenu</computeroutput>: Specifies 1103 whether the BIOS enables the user to select a temporary boot 1104 device. The <computeroutput>menuonly</computeroutput> option 1105 suppresses the message, but the user can still press F12 to 1106 select a temporary boot device. 1117 1107 </para> 1118 1108 </listitem> … … 1121 1111 <para> 1122 1112 <computeroutput>--biosapic 1123 x2apic|apic|disabled</computeroutput>: This specifies the1113 x2apic|apic|disabled</computeroutput>: Specifies the 1124 1114 firmware APIC level to be used. Options are: x2apic, apic or 1125 1115 disabled (no apic or x2apic) respectively. … … 1127 1117 1128 1118 <para> 1129 Note that if x2apic is specified and x2 apicis unsupported1130 by the VCPU, biosapic downgrades to apic, if supported -1131 otherwise down to 'disabled'. Similarly, if apic is1132 specified, and apic is unsupported a downgrade to 'disabled'1133 results.1119 Note that if x2apic is specified and x2APIC is unsupported 1120 by the VCPU, biosapic downgrades to apic, if supported. 1121 Otherwise biosapic downgrades to disabled. Similarly, if 1122 apic is specified, and APIC is unsupported, a downgrade to 1123 disabled results. 1134 1124 </para> 1135 1125 </listitem> … … 1138 1128 <para> 1139 1129 <computeroutput>--biossystemtimeoffset 1140 <ms></computeroutput>: This specifies a fixed time1141 offset (milliseconds) of the guest relative to the host1142 t ime. If the offset is positive, the guest time runs ahead1143 of thehost time.1144 </para> 1145 </listitem> 1146 1147 <listitem> 1148 <para> 1149 <computeroutput>--biospxedebug on|off</computeroutput>: This1150 option enables additional debugging output when using the1151 Intel PXE boot ROM. The output will be written to the1152 release log file (<xref linkend="collect-debug-info" />.1130 <ms></computeroutput>: Specifies a fixed time offset, 1131 in milliseconds, of the guest relative to the host time. If 1132 the offset is positive, the guest time runs ahead of the 1133 host time. 1134 </para> 1135 </listitem> 1136 1137 <listitem> 1138 <para> 1139 <computeroutput>--biospxedebug on|off</computeroutput>: 1140 Enables additional debugging output when using the Intel PXE 1141 boot ROM. The output is written to the release log file. See 1142 <xref linkend="collect-debug-info" />. 1153 1143 </para> 1154 1144 </listitem> … … 1157 1147 <para> 1158 1148 <computeroutput>--boot<1-4> 1159 none|floppy|dvd|disk|net</computeroutput>: This specifies1160 theboot order for the virtual machine. There are four1161 "slots", which the VM will try to access from 1 to 4, and1162 f or each of which you can set a device that the VM should1163 attempt to boot from.1164 </para> 1165 </listitem> 1166 1167 <listitem> 1168 <para> 1169 <computeroutput>--rtcuseutc on|off</computeroutput>: This1170 option lets the real-time clock (RTC) operate in UTC time.1171 See<xref linkend="settings-motherboard" />.1149 none|floppy|dvd|disk|net</computeroutput>: Specifies the 1150 boot order for the virtual machine. There are four 1151 <emphasis>slots</emphasis>, which the VM will try to access 1152 from 1 to 4, and for each of which you can set a device that 1153 the VM should attempt to boot from. 1154 </para> 1155 </listitem> 1156 1157 <listitem> 1158 <para> 1159 <computeroutput>--rtcuseutc on|off</computeroutput>: Sets 1160 the real-time clock (RTC) to operate in UTC time. See 1161 <xref linkend="settings-motherboard" />. 1172 1162 </para> 1173 1163 </listitem> … … 1176 1166 <para> 1177 1167 <computeroutput>--graphicscontroller 1178 none|vboxvga|vmsvga </computeroutput>: This option specifies1179 use of a graphics controller, and type chosen from vboxvga1180 or vmsvga. <xref linkend="settings-motherboard" />).1168 none|vboxvga|vmsvga|vboxsvga</computeroutput>: Specifies the 1169 use of a graphics controller, with an option to choose a 1170 specific type. See <xref linkend="settings-screen" />. 1181 1171 </para> 1182 1172 </listitem> … … 1185 1175 <para> 1186 1176 <computeroutput>--snapshotfolder 1187 default|<path></computeroutput>: This option specifies 1188 the folder in which snapshots will be kept for a virtual 1189 machine. 1177 default|<path></computeroutput>: Specifies the folder 1178 where snapshots are kept for a virtual machine. 1190 1179 </para> 1191 1180 </listitem> … … 1194 1183 <para> 1195 1184 <computeroutput>--firmware 1196 bios|efi|efi32|efi64</computeroutput>: This option specifies1197 which firmware to be used to boot the VM: Available options1198 are: BIOS, or one of the EFI options: efi, efi32 or efi64.1199 UseEFI options with care.1185 bios|efi|efi32|efi64</computeroutput>: Specifies the 1186 firmware to be used to boot the VM: Available options are: 1187 BIOS, or one of the EFI options: efi, efi32, or efi64. Use 1188 EFI options with care. 1200 1189 </para> 1201 1190 </listitem> … … 1204 1193 <para> 1205 1194 <computeroutput>--guestmemoryballoon 1206 <size></computeroutput> This option sets the default1207 size of the guest memory balloon, that is, memory allocated1208 by the VirtualBoxGuest Additions from the guest operating1209 system and returned to the hypervisor for re -use by other1195 <size></computeroutput> Sets the default size of the 1196 guest memory balloon. This is the memory allocated by the 1197 &product-name; Guest Additions from the guest operating 1198 system and returned to the hypervisor for reuse by other 1210 1199 virtual machines. 1211 1200 <computeroutput><size></computeroutput> must be … … 1218 1207 <para> 1219 1208 <computeroutput>--defaultfrontend 1220 default|<name></computeroutput>: This option specifies1221 the defaultfrontend to be used when starting this VM. See1209 default|<name></computeroutput>: Specifies the default 1210 frontend to be used when starting this VM. See 1222 1211 <xref linkend="vboxmanage-startvm" />. 1223 1212 </para> … … 1234 1223 <para> 1235 1224 The following networking settings are available through 1236 <com puteroutput>VBoxManage modifyvm</computeroutput>. With all1237 the se settings, the decimal number directly following the option1238 name ("1-N" in the list below) specifies the virtual network1239 adapter whosesettings should be changed.1225 <command>VBoxManage modifyvm</command>. With all these settings, 1226 the decimal number directly following the option name, 1-N in 1227 the list below, specifies the virtual network adapter whose 1228 settings should be changed. 1240 1229 </para> 1241 1230 … … 1246 1235 <computeroutput>--nic<1-N> 1247 1236 none|null|nat|natnetwork|bridged|intnet|hostonly|generic</computeroutput>: 1248 You can configure for each of the VM's virtual network1249 cards, what type of networking should be available. Options1250 are: not present (<computeroutput>none</computeroutput>),1251 not connected to the host1252 (<computeroutput>null</computeroutput>), use network address1253 translation (<computeroutput>nat</computeroutput>), use the1254 new networkaddress translation engine1237 Configures the type of networking for each of the VM's 1238 virtual network cards. Options are: not present 1239 (<computeroutput>none</computeroutput>), not connected to 1240 the host (<computeroutput>null</computeroutput>), use 1241 network address translation 1242 (<computeroutput>nat</computeroutput>), use the new network 1243 address translation engine 1255 1244 (<computeroutput>natnetwork</computeroutput>), bridged 1256 1245 networking (<computeroutput>bridged</computeroutput>), or … … 1270 1259 <computeroutput>--nictype<1-N> 1271 1260 Am79C970A|Am79C973|82540EM|82543GC|82545EM|virtio</computeroutput>: 1272 This enables you to specify which networking hardware1273 VirtualBox presents to the guest for a specified VM virtual1274 network card. See <xref linkend="nichardware" />.1261 Enables you to specify the networking hardware that 1262 &product-name; presents to the guest for a specified VM 1263 virtual network card. See <xref linkend="nichardware" />. 1275 1264 </para> 1276 1265 </listitem> … … 1279 1268 <para> 1280 1269 <computeroutput>--cableconnected<1-N> 1281 on|off</computeroutput>: This enables you to temporarily1270 on|off</computeroutput>: Enables you to temporarily 1282 1271 disconnect a virtual network interface, as if a network 1283 1272 cable had been pulled from a real network card. This might 1284 be useful e.g. for resetting certain software components in1285 the VM.1286 </para> 1287 </listitem> 1288 1289 <listitem> 1290 <para> 1291 With the "nictrace" options, you can optionally trace1292 network traffic by dumping it to a file, for debugging1293 purposes.1273 be useful, for example for resetting certain software 1274 components in the VM. 1275 </para> 1276 </listitem> 1277 1278 <listitem> 1279 <para> 1280 With the <computeroutput>nictrace</computeroutput> options, 1281 you can optionally trace network traffic by dumping it to a 1282 file, for debugging purposes. 1294 1283 </para> 1295 1284 … … 1312 1301 <computeroutput>--nicproperty<1-N> 1313 1302 <paramname>="paramvalue"</computeroutput>: This 1314 option, in combination with "nicgenericdrv" allows you to 1315 pass parameters to rarely-used network backends. 1303 option, in combination with 1304 <computeroutput>nicgenericdrv</computeroutput> enables you 1305 to pass parameters to rarely-used network backends. 1316 1306 </para> 1317 1307 … … 1319 1309 These parameters are backend engine-specific, and are 1320 1310 different between UDP Tunnel and the VDE backend drivers. 1321 For examples, please see 1322 <xref linkend="network_udp_tunnel" />. 1311 For examples, see <xref linkend="network_udp_tunnel" />. 1323 1312 </para> 1324 1313 </listitem> … … 1327 1316 <para> 1328 1317 <computeroutput>--nicspeed<1-N> 1329 <kbps></computeroutput>: If generic networking has 1330 been enabled for a particular virtual network card (see the 1331 <computeroutput>--nic</computeroutput> option above - 1332 otherwise this setting has no effect), this mode enables 1333 access to rarely used networking sub-modes, such as VDE 1334 network or UDP Tunnel. This option specifies the throughput 1335 rate in KBytes/sec. 1318 <kbps></computeroutput>: Only has an effect if generic 1319 networking has been enabled for a particular virtual network 1320 card. See the <computeroutput>--nic</computeroutput> option. 1321 This mode enables access to rarely used networking 1322 sub-modes, such as VDE network or UDP Tunnel. This option 1323 specifies the throughput rate in KBps. 1336 1324 </para> 1337 1325 </listitem> … … 1340 1328 <para> 1341 1329 <computeroutput>--nicbootprio<1-N> 1342 <priority></computeroutput>: This specifies the order1343 in which NICs are tried for booting over the network (using1344 PXE ). The priority is an integer in the 0 to 4 range.1330 <priority></computeroutput>: Specifies the order in 1331 which NICs are tried for booting over the network, using 1332 PXE. The priority is an integer in the 0 to 4 range. 1345 1333 Priority 1 is the highest, priority 4 is low. Priority 0, 1346 1334 which is the default unless otherwise specified, is the … … 1349 1337 1350 1338 <para> 1351 Note that this option only has effect when the Intel PXE1339 Note that this option only has an effect when the Intel PXE 1352 1340 boot ROM is used. 1353 1341 </para> … … 1357 1345 <para> 1358 1346 <computeroutput>--nicpromisc<1-N> 1359 deny|allow-vms|allow-all</computeroutput>: This ernables you 1360 to specify how the promiscuous mode is handled for the 1361 specified VM virtual network card. This setting is only 1362 relevant for bridged networking. 1363 <computeroutput>deny</computeroutput> (default setting) 1364 hides any traffic not intended for this VM. 1365 <computeroutput>allow-vms</computeroutput> hides all host 1366 traffic from this VM but allows the VM to see traffic 1367 from/to other VMs. 1347 deny|allow-vms|allow-all</computeroutput>: Enables you to 1348 specify how promiscuous mode is handled for the specified VM 1349 virtual network card. This setting is only relevant for 1350 bridged networking. <computeroutput>deny</computeroutput>, 1351 the default setting, hides any traffic not intended for the 1352 VM. <computeroutput>allow-vms</computeroutput> hides all 1353 host traffic from the VM, but allows the VM to see traffic 1354 to and from other VMs. 1368 1355 <computeroutput>allow-all</computeroutput> removes this 1369 1356 restriction completely. … … 1374 1361 <para> 1375 1362 <computeroutput>--nicbandwidthgroup<1-N> 1376 none|<name></computeroutput>: This removes/adds an1377 assignment of a bandwidth group f rom/to the specified1378 virtualnetwork interface. Specifying1363 none|<name></computeroutput>: Adds and removes an 1364 assignment of a bandwidth group for the specified virtual 1365 network interface. Specifying 1379 1366 <computeroutput>none</computeroutput> removes any current 1380 1367 bandwidth group assignment from the specified virtual … … 1386 1373 1387 1374 <para> 1388 For details, please see 1389 <xref linkend="network_bandwidth_limit" />. 1375 See <xref linkend="network_bandwidth_limit" />. 1390 1376 </para> 1391 1377 </listitem> … … 1394 1380 <para> 1395 1381 <computeroutput>--bridgeadapter<1-N> 1396 none|<devicename></computeroutput>: If bridged 1397 networking has been enabled for a virtual network card (see 1398 the <computeroutput>--nic</computeroutput> option above), 1399 otherwise this setting has no effect. Use this option to 1400 specify which host interface the given virtual network 1401 interface will use. For details, please see 1382 none|<devicename></computeroutput>: Only has an effect 1383 if bridged networking has been enabled for a virtual network 1384 card. See the <computeroutput>--nic</computeroutput> option. 1385 Use this option to specify which host interface the given 1386 virtual network interface will use. See 1402 1387 <xref linkend="network_bridged" />. 1403 1388 </para> … … 1407 1392 <para> 1408 1393 <computeroutput>--hostonlyadapter<1-N> 1409 none|<devicename></computeroutput>: If host-only1410 networking has been enabled for a virtual network card (see1411 the <computeroutput>--nic</computeroutput> option above),1412 o therwise this setting has no effect. Use this option to1413 specify which host-only networking interface the given1414 virtual network interface will use. For details, please see1394 none|<devicename></computeroutput>: Only has an effect 1395 if host-only networking has been enabled for a virtual 1396 network card. See the <computeroutput>--nic</computeroutput> 1397 option. Use this option to specify which host-only 1398 networking interface the given virtual network interface 1399 will use. See 1415 1400 <xref 1416 1401 linkend="network_hostonly" />. … … 1421 1406 <para> 1422 1407 <computeroutput>--intnet<1-N> 1423 network</computeroutput>: If internal networking has been 1424 enabled for a virtual network card (see the 1425 <computeroutput>--nic</computeroutput> option above), 1426 otherwise this setting has no effect. Ue this option to 1427 specify the name of the internal network (see 1408 network</computeroutput>: Only has an effect if internal 1409 networking has been enabled for a virtual network card. See 1410 the <computeroutput>--nic</computeroutput> option. Use this 1411 option to specify the name of the internal network. See 1428 1412 <xref 1429 linkend="network_internal" /> ).1413 linkend="network_internal" />. 1430 1414 </para> 1431 1415 </listitem> … … 1435 1419 <computeroutput>--nat-network<1-N> <network 1436 1420 name></computeroutput>: If the networking type is set to 1437 <computeroutput>natnetwork</computeroutput> (not1438 <computeroutput>nat</computeroutput> )then this setting1421 <computeroutput>natnetwork</computeroutput>, not 1422 <computeroutput>nat</computeroutput>, then this setting 1439 1423 specifies the name of the NAT network this adapter is 1440 1424 connected to. Optional. … … 1445 1429 <para> 1446 1430 <computeroutput>--nicgenericdrv<1-N> <backend 1447 driver></computeroutput>: If generic networking has been 1448 enabled for a virtual network card (see the 1449 <computeroutput>--nic</computeroutput> option above), 1450 otherwise this setting has no effect. This mode allows you 1451 to access rarely used networking sub-modes, such as VDE 1452 network or UDP Tunnel. 1431 driver></computeroutput>: Only has an effect if generic 1432 networking has been enabled for a virtual network card. See 1433 the <computeroutput>--nic</computeroutput> option. This mode 1434 enables you to access rarely used networking sub-modes, such 1435 as VDE network or UDP Tunnel. 1453 1436 </para> 1454 1437 </listitem> … … 1460 1443 set the MAC address of a particular network adapter on the 1461 1444 VM. Normally, each network adapter is assigned a random 1462 address by VirtualBoxat VM creation.1445 address by &product-name; at VM creation. 1463 1446 </para> 1464 1447 </listitem> … … 1472 1455 <para> 1473 1456 The following NAT networking settings are available through 1474 <com puteroutput>VBoxManage modifyvm</computeroutput>. With all1475 these settings, the decimal number directly following the1476 option name ("1-N" in the list below) specifies the virtual1477 networkadapter whose settings should be changed.1457 <command>VBoxManage modifyvm</command>. With all these 1458 settings, the decimal number directly following the option 1459 name, 1-N in the list below, specifies the virtual network 1460 adapter whose settings should be changed. 1478 1461 </para> 1479 1462 … … 1485 1468 <network>|default</computeroutput>: If the 1486 1469 networking type is set to 1487 <computeroutput>nat</computeroutput> (not1488 <computeroutput>natnetwork</computeroutput> )then this1470 <computeroutput>nat</computeroutput>, not 1471 <computeroutput>natnetwork</computeroutput>, then this 1489 1472 setting specifies the IP address range to be used for this 1490 network. See <xref linkend="changenat" /> for an example.1473 network. See <xref linkend="changenat" />. 1491 1474 </para> 1492 1475 </listitem> … … 1496 1479 <computeroutput>--natpf<1-N> 1497 1480 [<name>],tcp|udp,[<hostip>],<hostport>,[<guestip>], 1498 <guestport></computeroutput>: This setting defines a 1499 NAT port-forwarding rule. See 1500 <xref linkend="natforward" />. 1481 <guestport></computeroutput>: Defines a NAT 1482 port-forwarding rule. See <xref linkend="natforward" />. 1501 1483 </para> 1502 1484 </listitem> … … 1505 1487 <para> 1506 1488 <computeroutput>--natpf<1-N> delete 1507 <name></computeroutput>: This setting deletes a NAT1489 <name></computeroutput>: Deletes a NAT 1508 1490 port-forwarding rule. See <xref linkend="natforward" />. 1509 1491 </para> … … 1513 1495 <para> 1514 1496 <computeroutput>--nattftpprefix<1-N> 1515 <prefix></computeroutput>: This setting defines a 1516 prefix for the built-in TFTP server, i.e. where the boot 1517 file is located. See <xref linkend="nat-tftp" /> and 1518 <xref 1519 linkend="nat-adv-tftp" />. 1497 <prefix></computeroutput>: Defines a prefix for the 1498 built-in TFTP server. For example, where the boot file is 1499 located. See <xref linkend="nat-tftp" /> and 1500 <xref linkend="nat-adv-tftp" />. 1520 1501 </para> 1521 1502 </listitem> … … 1524 1505 <para> 1525 1506 <computeroutput>--nattftpfile<1-N> 1526 <bootfile></computeroutput>: This setting defines1527 the TFT bootfile. See <xref linkend="nat-adv-tftp" />.1507 <bootfile></computeroutput>: Defines the TFT boot 1508 file. See <xref linkend="nat-adv-tftp" />. 1528 1509 </para> 1529 1510 </listitem> … … 1532 1513 <para> 1533 1514 <computeroutput>--nattftpserver<1-N> 1534 <tftpserver></computeroutput>: This setting defines 1535 the TFTP server address to boot from. See 1536 <xref 1537 linkend="nat-adv-tftp" />. 1515 <tftpserver></computeroutput>: Defines the TFTP 1516 server address to boot from. See 1517 <xref linkend="nat-adv-tftp" />. 1538 1518 </para> 1539 1519 </listitem> … … 1542 1522 <para> 1543 1523 <computeroutput>--nattbindip<1-N> 1544 <ip;></computeroutput>: VirtualBox's NAT engine1524 <ip;></computeroutput>: &product-name;'s NAT engine 1545 1525 normally routes TCP/IP packets through the default 1546 1526 interface assigned by the host's TCP/IP stack. Use this 1547 1527 setting to instruct the NAT engine to bind to a specified 1548 1528 IP address instead. See 1549 <xref 1550 linkend="nat-adv-settings" />. 1529 <xref linkend="nat-adv-settings" />. 1551 1530 </para> 1552 1531 </listitem> … … 1555 1534 <para> 1556 1535 <computeroutput>--natdnspassdomain<1-N> 1557 on|off</computeroutput>: This setting specifies whether1558 the built-in DHCP server passes the domain name for1559 network nameresolution.1536 on|off</computeroutput>: Specifies whether the built-in 1537 DHCP server passes the domain name for network name 1538 resolution. 1560 1539 </para> 1561 1540 </listitem> … … 1564 1543 <para> 1565 1544 <computeroutput>--natdnsproxy<1-N> 1566 on|off</computeroutput>: This setting makes the NAT engine1567 proxy all guest DNS requests to the host's DNS servers.1568 See<xref linkend="nat-adv-dns" />.1545 on|off</computeroutput>: Makes the NAT engine proxy all 1546 guest DNS requests to the host's DNS servers. See 1547 <xref linkend="nat-adv-dns" />. 1569 1548 </para> 1570 1549 </listitem> … … 1573 1552 <para> 1574 1553 <computeroutput>--natdnshostresolver<1-N> 1575 on|off</computeroutput>: This setting makes the NAT engine1576 use the host's resolver mechanisms to handle DNS requests.1577 See<xref linkend="nat-adv-dns" />.1554 on|off</computeroutput>: Makes the NAT engine use the 1555 host's resolver mechanisms to handle DNS requests. See 1556 <xref linkend="nat-adv-dns" />. 1578 1557 </para> 1579 1558 </listitem> … … 1583 1562 <computeroutput>--natsettings<1-N> 1584 1563 [<mtu>],[<socksnd>],[<sockrcv>],[<tcpsnd>], 1585 [<tcprcv>]</computeroutput>: This setting controls 1586 several NAT settings. See 1587 <xref linkend="nat-adv-settings" />. 1564 [<tcprcv>]</computeroutput>: Controls several NAT 1565 settings. See <xref linkend="nat-adv-settings" />. 1588 1566 </para> 1589 1567 </listitem> … … 1593 1571 <computeroutput>--nataliasmode<1-N> 1594 1572 default|[log],[proxyonly],[sameports]</computeroutput>: 1595 This setting defines behaviour of NAT engine core: log - 1596 enables logging, proxyonly - switches of aliasing mode 1597 makes NAT transparent, sameports enforces NAT engine to 1598 send packets via the same port as they originated on, 1599 default - disable all mentioned modes above. See 1600 <xref 1601 linkend="nat-adv-alias" />. 1573 Defines behaviour of the NAT engine core: log - enables 1574 logging, proxyonly - switches off aliasing mode and makes 1575 NAT transparent, sameports - enforces the NAT engine to 1576 send packets through the same port as they originated on, 1577 default - disable all aliasing modes. See 1578 <xref linkend="nat-adv-alias" />. 1602 1579 </para> 1603 1580 </listitem> … … 1615 1592 <para> 1616 1593 The following hardware settings, such as serial port, audio, 1617 clipboard, drag and drop, monitor and USB settings are available1618 through <computeroutput>VBoxManage modifyvm</computeroutput>:1594 clipboard, drag and drop, monitor, and USB settings are 1595 available through <command>VBoxManage modifyvm</command>: 1619 1596 </para> 1620 1597 … … 1641 1618 <para> 1642 1619 <computeroutput>--uart<1-N> off|<I/O base> 1643 <IRQ></computeroutput>: With this setting you can 1644 configure virtual serial ports for the VM. See 1645 <xref 1646 linkend="serialports" />. 1620 <IRQ></computeroutput>: Configures virtual serial 1621 ports for the VM. See <xref linkend="serialports" />. 1647 1622 </para> 1648 1623 </listitem> … … 1651 1626 <para> 1652 1627 <computeroutput>--uartmode<1-N> 1653 <arg></computeroutput>: This setting controls how 1654 VirtualBox connects a given virtual serial port (previously 1655 configured with the <computeroutput>--uartX</computeroutput> 1656 setting, see above) to the host on which the virtual machine 1657 is running. As described in <xref linkend="serialports" />, 1658 for each such port, you can specify 1659 <computeroutput><arg></computeroutput> as one of the 1660 following options: 1628 <arg></computeroutput>: Controls how &product-name; 1629 connects a given virtual serial port, configured with the 1630 <computeroutput>--uartX</computeroutput> setting, to the 1631 host on which the virtual machine is running. As described 1632 in <xref linkend="serialports" />, for each such port, you 1633 can specify <computeroutput><arg></computeroutput> as 1634 one of the following options: 1661 1635 </para> 1662 1636 … … 1676 1650 <computeroutput>server 1677 1651 <pipename></computeroutput>: On a Windows host, 1678 this tells VirtualBox to create a named pipe on the host 1679 named <computeroutput><pipename></computeroutput> 1680 and connect the virtual serial device to it. Note that 1681 Windows requires that the name of a named pipe begin 1652 this tells &product-name; to create a named pipe on the 1653 host named 1654 <computeroutput><pipename></computeroutput> and 1655 connect the virtual serial device to it. Note that 1656 Windows requires that the name of a named pipe begins 1682 1657 with <computeroutput>\\.\pipe\</computeroutput>. 1683 1658 </para> … … 1692 1667 <para> 1693 1668 <computeroutput>client 1694 <pipename></computeroutput>: This operates just1695 like <computeroutput>server ...</computeroutput>, except1696 that thepipe, or local domain socket, is not created by1697 VirtualBox, butassumed to exist already.1669 <pipename></computeroutput>: Operates as for 1670 <computeroutput>server</computeroutput>, except that the 1671 pipe, or local domain socket, is not created by 1672 &product-name; but is assumed to exist already. 1698 1673 </para> 1699 1674 </listitem> … … 1702 1677 <para> 1703 1678 <computeroutput>tcpserver <port></computeroutput>: 1704 This tells VirtualBox to create a TCP socket on the host 1705 with TCP <computeroutput><port></computeroutput> 1706 and connect the virtual serial device to it. Note that 1679 Configures &product-name; to create a TCP socket on the 1680 host with TCP 1681 <computeroutput><port></computeroutput> and 1682 connect the virtual serial device to it. Note that 1707 1683 UNIX-like systems require ports over 1024 for normal 1708 1684 users. … … 1713 1689 <para> 1714 1690 <computeroutput>tcpclient 1715 <hostname:port></computeroutput>: This operates 1716 just like <computeroutput>tcpserver 1717 ...</computeroutput>, except that the TCP socket is not 1718 created by VirtualBox, but assumed to exist already. 1719 </para> 1720 </listitem> 1721 1722 <listitem> 1723 <para> 1724 <computeroutput>file <file></computeroutput>: This 1725 redirects the serial port output to a raw file 1691 <hostname:port></computeroutput>: Operates as for 1692 <computeroutput>tcpserver</computeroutput>, except that 1693 the TCP socket is not created by &product-name;, but is 1694 assumed to exist already. 1695 </para> 1696 </listitem> 1697 1698 <listitem> 1699 <para> 1700 <computeroutput>uarttype <1-N> 1701 16450|16550A|16750</computeroutput>: Confgures the UART 1702 type for a virtual serial port. The default UART type is 1703 16550A. 1704 </para> 1705 </listitem> 1706 1707 <listitem> 1708 <para> 1709 <computeroutput>file <file></computeroutput>: 1710 Redirects the serial port output to a raw file 1726 1711 <file> specified by its absolute path on the host 1727 1712 file system. … … 1732 1717 <para> 1733 1718 <computeroutput><devicename></computeroutput>: If, 1734 instead of the above, the device name of a physical 1735 hardware serial port of the host is specified, the 1736 virtual serial port is connected to that hardware port. 1737 On a Windows host, the device name will be a COM port 1738 such as <computeroutput>COM1</computeroutput>; on a 1739 Linux host, the device name will look like 1740 <computeroutput>/dev/ttyS0</computeroutput>. This allows 1741 you to "wire" a real serial port to a virtual machine. 1719 instead of the above options, the device name of a 1720 physical hardware serial port of the host is specified, 1721 the virtual serial port is connected to that hardware 1722 port. On a Windows host, the device name will be a COM 1723 port such as <computeroutput>COM1</computeroutput>. On a 1724 Linux host, the device name will be 1725 <computeroutput>/dev/ttyS0</computeroutput> or similar. 1726 This enables you to wire up a real serial port to a 1727 virtual machine. 1742 1728 </para> 1743 1729 </listitem> … … 1752 1738 of the parallel port that the Parallel Port feature will be 1753 1739 using. Use this <emphasis>before</emphasis> 1754 <computeroutput>--lpt</computeroutput>. This feature is host1755 o perating system specific. For Windows hosts, use a device1756 name like <emphasis>lpt1</emphasis> while on Linux hosts you1757 have to use a device name like <emphasis>/dev/lp0</emphasis>1740 <computeroutput>--lpt</computeroutput>. This feature depends 1741 on the host operating system. For Windows hosts, use a 1742 device name such as lpt1. On Linux hosts, use a device name 1743 such as /dev/lp0. 1758 1744 </para> 1759 1745 </listitem> … … 1776 1762 <computeroutput>--audio 1777 1763 none|null|dsound|oss|alsa|pulse|coreaudio</computeroutput>: 1778 With this setting, you can specify whether the VM should 1779 have audio support, and – if so – which type. 1780 The list of supported audio types depends on the host and 1781 can be determined with <computeroutput>VBoxManage 1782 modifyvm</computeroutput>. 1764 Specifies whether the VM should have audio support, and if 1765 so, which type. The list of supported audio types depends on 1766 the host and can be determined with <command>VBoxManage 1767 modifyvm</command>. 1783 1768 </para> 1784 1769 </listitem> … … 1787 1772 <para> 1788 1773 <computeroutput>--audiocontroller 1789 ac97|hda|sb16</computeroutput>: With this setting, you can1790 specify the audio controller to be used with thisVM.1774 ac97|hda|sb16</computeroutput>: Specifies the audio 1775 controller to be used with the VM. 1791 1776 </para> 1792 1777 </listitem> … … 1795 1780 <para> 1796 1781 <computeroutput>--audiocodec 1797 stac9700|ad1980|stac9221|sb16</computeroutput>: With this 1798 setting, you can specify the audio codec to be used with 1799 this VM. 1800 </para> 1801 </listitem> 1802 1803 <listitem> 1804 <para> 1805 <computeroutput>--audioin on</computeroutput>: With this 1806 setting, you can specify whether capturing audio from the 1807 host is enabled or disabled. 1808 </para> 1809 </listitem> 1810 1811 <listitem> 1812 <para> 1813 <computeroutput>--audioout on</computeroutput>: With this 1814 setting, you can specify whether audio playback from the 1815 guest is enabled or disabled. 1782 stac9700|ad1980|stac9221|sb16</computeroutput>: Specifies 1783 the audio codec to be used with the VM. 1784 </para> 1785 </listitem> 1786 1787 <listitem> 1788 <para> 1789 <computeroutput>--audioin on</computeroutput>: Specifies 1790 whether capturing audio from the host is enabled or 1791 disabled. 1792 </para> 1793 </listitem> 1794 1795 <listitem> 1796 <para> 1797 <computeroutput>--audioout on</computeroutput>: Specifies 1798 whether audio playback from the guest is enabled or 1799 disabled. 1816 1800 </para> 1817 1801 </listitem> … … 1821 1805 <computeroutput>--clipboard 1822 1806 disabled|hosttoguest|guesttohost|bidirectional</computeroutput>: 1823 With this setting, you can select if and how the guest or1824 host operating system's clipboard should be shared with the1825 host or guest. See <xref linkend="generalsettings" />. This1826 requires that the Guest Additions be installed in the1827 virtualmachine.1807 Configues how the guest or host operating system's clipboard 1808 should be shared with the host or guest. See 1809 <xref linkend="generalsettings" />. This setting requires 1810 that the Guest Additions be installed in the virtual 1811 machine. 1828 1812 </para> 1829 1813 </listitem> … … 1833 1817 <computeroutput>--draganddrop 1834 1818 disabled|hosttoguest|guesttohost|bidirectional</computeroutput>: 1835 With this setting, you can specify the current drag and drop1836 mode being used between the host and the virtual machine.1837 See <xref linkend="guestadd-dnd" />. This requires thatthe1838 Guest Additions be installed in thevirtual machine.1819 Specifies the drag and drop mode to use between the host and 1820 the virtual machine. See <xref linkend="guestadd-dnd" />. 1821 This requires that the Guest Additions be installed in the 1822 virtual machine. 1839 1823 </para> 1840 1824 </listitem> … … 1843 1827 <para> 1844 1828 <computeroutput>--monitorcount 1845 <count></computeroutput>: This enables multi-monitor1829 <count></computeroutput>: Enables multi-monitor 1846 1830 support. See <xref linkend="settings-display" />. 1847 1831 </para> … … 1850 1834 <listitem> 1851 1835 <para> 1852 <computeroutput>--usb on|off</computeroutput>: This setting1853 enables ordisables the VM's virtual USB controller. See1836 <computeroutput>--usb on|off</computeroutput>: Enables and 1837 disables the VM's virtual USB controller. See 1854 1838 <xref 1855 1839 linkend="settings-usb" />. … … 1859 1843 <listitem> 1860 1844 <para> 1861 <computeroutput>--usbehci on|off</computeroutput>: This1862 setting enables or disables the VM's virtual USB 2.01863 controller. See<xref linkend="settings-usb" />.1864 </para> 1865 </listitem> 1866 1867 <listitem> 1868 <para> 1869 <computeroutput>--usbxhci on|off</computeroutput>: This1870 setting enables or disables the VM's virtual USB 3.01871 controller. See<xref linkend="settings-usb" />.1845 <computeroutput>--usbehci on|off</computeroutput>: Enables 1846 and disables the VM's virtual USB 2.0 controller. See 1847 <xref linkend="settings-usb" />. 1848 </para> 1849 </listitem> 1850 1851 <listitem> 1852 <para> 1853 <computeroutput>--usbxhci on|off</computeroutput>: Enables 1854 and disables the VM's virtual USB 3.0 controller. See 1855 <xref linkend="settings-usb" />. 1872 1856 </para> 1873 1857 </listitem> … … 1876 1860 <para> 1877 1861 <computeroutput>--usbrename <oldname> 1878 <newname></computeroutput>: This setting enables1879 renaming of the VM's virtual USB controller from1880 < oldname> to <newname>.1862 <newname></computeroutput>: Enables renaming of the 1863 VM's virtual USB controller from <oldname> to 1864 <newname>. 1881 1865 </para> 1882 1866 </listitem> … … 1891 1875 1892 1876 <para> 1893 The following settings for changing video and/or audio recording1894 parameters are available through <computeroutput>VBoxManage1895 modifyvm</computeroutput>.1877 The <command>VBoxManage modifyvm</command> command enables you 1878 to modify recording settings for video recording, audio 1879 recording, or both. 1896 1880 </para> 1897 1881 1882 <para> 1883 Use the following options to update the recording settings: 1884 </para> 1885 1898 1886 <itemizedlist> 1899 1887 1900 1888 <listitem> 1901 1889 <para> 1902 <computeroutput>--recording on|off</computeroutput>: This 1903 option enables or disables recording a VM session into a 1904 file. If this option is enabled, recording will start when the 1905 VM session is started. 1906 </para> 1907 </listitem> 1908 1909 <listitem> 1910 <para> 1911 <computeroutput>--recordingscreens all|<screen ID> 1912 [<screen ID> ...]</computeroutput>: This option allows 1913 to specify which screens of the VM are being recorded. Each 1914 screen is recorded into a separate file. 1915 </para> 1916 </listitem> 1917 1918 <listitem> 1919 <para> 1920 <computeroutput>--recordingfile 1921 <filename></computeroutput>: This option sets the 1922 filename VirtualBox uses to save the recorded content. 1923 </para> 1924 </listitem> 1925 1926 <listitem> 1927 <para> 1928 <computeroutput>--recordingmaxtime 1929 <ms></computeroutput>: This option sets the maximum 1930 time in milliseconds the recording will be enabled 1931 since activation. The recording stops when the defined time 1932 interval has elapsed. If this value is zero the recording is 1933 not limited by time. 1934 </para> 1935 </listitem> 1936 1937 <listitem> 1938 <para> 1939 <computeroutput>--recordingmaxsize 1940 <MB></computeroutput>: This option limits the maximum 1941 size of the recorded file (in MB). The recording stops 1942 when the file size has reached the specified size. If this 1943 value is zero the recording will not be limited by file size. 1944 </para> 1945 </listitem> 1946 1947 <listitem> 1948 <para> 1949 <computeroutput>--recordingopts <key=value> 1950 [,<key=value> ...]</computeroutput>: This format can 1951 be used to specify additional recording options. These 1952 options only are for advanced users and must be specified in 1953 a comma-separated key=value format. For example: 1890 <option>--recording on|off</option> enables or disables the 1891 recording of a VM session into a WebM/VP8 file. When this 1892 option value is <computeroutput>on</computeroutput>, 1893 recording begins when the VM session starts. 1894 </para> 1895 </listitem> 1896 1897 <listitem> 1898 <para> 1899 <option>--recordingscreens 1900 all|<replaceable>screen-ID</replaceable> 1901 [<replaceable>screen-ID</replaceable> ...]</option> enables 1902 you to specify which VM screens to record. The recording for 1903 each screen that you specify is saved to its own file. 1904 </para> 1905 </listitem> 1906 1907 <listitem> 1908 <para> 1909 <option>--recordingfile 1910 <replaceable>filename</replaceable></option> specifies the 1911 file in which to save the recording. 1912 </para> 1913 </listitem> 1914 1915 <listitem> 1916 <para> 1917 <option>--recordingmaxsize 1918 <replaceable>MB</replaceable></option> specifies the maximum 1919 size of the recorded video file in megabytes. The recording 1920 stops when the file reaches the specified size. If this 1921 value is zero, the recording continues until you stop the 1922 recording. 1923 </para> 1924 </listitem> 1925 1926 <listitem> 1927 <para> 1928 <option>--recordingmaxtime 1929 <replaceable>seconds</replaceable></option> specifies the 1930 maximum amount time to record in seconds. The recording 1931 stops after the specified number of seconds elapses. If this 1932 value is zero, the recording continues until you stop the 1933 recording. 1934 </para> 1935 </listitem> 1936 1937 <listitem> 1938 <para> 1939 <option>--recordingopts 1940 <replaceable>keyword</replaceable>=<replaceable>value</replaceable>[,<replaceable>keyword</replaceable>=<replaceable>value</replaceable> 1941 ...]</option> specifies additional video-recording options 1942 in a comma-separated keyword-value format. For example, 1954 1943 <computeroutput>foo=bar,a=b</computeroutput>. 1955 1944 </para> 1956 </listitem> 1957 1958 <listitem> 1959 <para> 1960 <computeroutput>--recordingvideores 1961 <width>x<height></computeroutput>: This option 1962 sets the video resolution (in pixels) of the recorded file. 1963 </para> 1964 </listitem> 1965 1966 <listitem> 1967 <para> 1968 <computeroutput>--recordingvideorate 1969 <rate></computeroutput>: This option sets the video bitrate 1970 in kilobits (kb) per second. Increasing this value makes the 1971 video look better for the cost of an increased file size. 1972 </para> 1973 </listitem> 1974 1975 <listitem> 1976 <para> 1977 <computeroutput>--recordingvideofps <fps></computeroutput>: 1978 This option sets the maximum number of video frames per second 1979 (FPS) to be recorded. Frames with a higher frequency will be 1980 skipped. Reducing this value increases the number of skipped 1981 frames and reduces the file size. 1982 </para> 1983 1984 <para> 1985 The following keys and their corresponding values are 1986 available: 1987 </para> 1988 1989 <itemizedlist> 1990 1991 <listitem> 1992 <para> 1993 <computeroutput>ac_enabled</computeroutput>: Enables 1994 audio recording when set to 1995 <computeroutput>true</computeroutput>, otherwise set to 1996 <computeroutput>false</computeroutput> to disable. This 1997 feature is considered being experimental. 1998 </para> 1999 </listitem> 2000 2001 </itemizedlist> 1945 1946 <para> 1947 Only use this option only if you are an advanced user. For 1948 information about keywords, see <emphasis>Oracle VM 1949 VirtualBox Programming Guide and Reference</emphasis>. 1950 </para> 1951 </listitem> 1952 1953 <listitem> 1954 <para> 1955 <option>--recordingvideofps 1956 <replaceable>fps</replaceable></option> specifies the 1957 maximum number of video frames per second (FPS) to record. 1958 Frames that have a higher frequency are skipped. Increasing 1959 this value reduces the number of skipped frames and 1960 increases the file size. 1961 </para> 1962 </listitem> 1963 1964 <listitem> 1965 <para> 1966 <option>--recordingvideorate 1967 <replaceable>bit-rate</replaceable></option> specifies the 1968 bit rate of the video in kilobits per second. Increasing 1969 this value improves the appearance of the video at the cost 1970 of an increased file size. 1971 </para> 1972 </listitem> 1973 1974 <listitem> 1975 <para> 1976 <option>--recordingvideores 1977 <replaceable>width</replaceable>x<replaceable>height</replaceable></option> 1978 specifies the video resolution of the recorded video in 1979 pixels. 1980 </para> 2002 1981 </listitem> 2003 1982 … … 2012 1991 <para> 2013 1992 The following settings that affect remote machine behavior are 2014 available through <computeroutput>VBoxManage 2015 modifyvm</computeroutput>: 1993 available through <command>VBoxManage modifyvm</command>: 2016 1994 </para> 2017 1995 … … 2020 1998 <listitem> 2021 1999 <para> 2022 <computeroutput>--vrde on|off</computeroutput>: This enables2023 or disables the VirtualBox remote desktop extension (VRDE)2000 <computeroutput>--vrde on|off</computeroutput>: Enables and 2001 disables the VirtualBox Remote Desktop Extension (VRDE) 2024 2002 server. 2025 2003 </para> … … 2029 2007 <para> 2030 2008 <computeroutput>--vrdeproperty 2031 "TCP/Ports|Address=<value>"</computeroutput> sets the2032 port number (s)and IP address on the VM that the VRDE server2009 "TCP/Ports|Address=<value>"</computeroutput>: Sets the 2010 port numbers and IP address on the VM that the VRDE server 2033 2011 can bind to. 2034 2012 </para> … … 2039 2017 <para> 2040 2018 For TCP/Ports, <value> should be a port or a range 2041 of ports that the VRDE server can bind to; "default" or 2042 "0" means port 3389, the standard port for RDP. See the 2043 description for the 2019 of ports that the VRDE server can bind to. 2020 <computeroutput>default</computeroutput> or 2021 <computeroutput>0</computeroutput> means port 3389, the 2022 standard port for RDP. See the description for the 2044 2023 <computeroutput>--vrdeport</computeroutput> option in 2045 2024 <xref … … 2067 2046 <para> 2068 2047 <computeroutput>--vrdeproperty 2069 "VideoChannel/Enabled|Quality|DownscaleProtection=<value>"</computeroutput> 2070 sets the VRDP video redirection properties.2048 "VideoChannel/Enabled|Quality|DownscaleProtection=<value>"</computeroutput>: 2049 Sets the VRDP video redirection properties. 2071 2050 </para> 2072 2051 … … 2076 2055 <para> 2077 2056 For VideoChannel/Enabled, <value> can be set to 2078 "1" switching the VRDP video channel on. For details,2079 see<xref linkend="vrde-videochannel" />.2057 "1", switching the VRDP video channel on. See 2058 <xref linkend="vrde-videochannel" />. 2080 2059 </para> 2081 2060 </listitem> … … 2112 2091 <para> 2113 2092 <computeroutput>--vrdeproperty 2114 "Client/DisableDisplay|DisableInput|DisableAudio|DisableUSB=1"</computeroutput> 2115 </para> 2116 2117 <para> 2093 "Client/DisableDisplay|DisableInput|DisableAudio|DisableUSB=1"</computeroutput>: 2118 2094 Disables one of the VRDE server features: Display, Input, 2119 2095 Audio or USB respectively. To reenable a feature, use … … 2126 2102 <para> 2127 2103 <computeroutput>--vrdeproperty 2128 "Client/DisableClipboard|DisableUpstreamAudio=1"</computeroutput> 2129 </para> 2130 2131 <para> 2104 "Client/DisableClipboard|DisableUpstreamAudio=1"</computeroutput>: 2132 2105 Disables one of the VRDE server features: Clipboard or 2133 2106 UpstreamAudio respectively. To reenable a feature, use … … 2140 2113 <para> 2141 2114 <computeroutput>--vrdeproperty 2142 "Client/DisableRDPDR=1"</computeroutput> 2143 </para> 2144 2145 <para> 2146 Disables the VRDE server feature: RDP device redirection for 2147 smart cards. To reenable this feature, use 2148 "Client/DisableRDPR=". 2115 "Client/DisableRDPDR=1"</computeroutput>: Disables the VRDE 2116 server feature: RDP device redirection for smart cards. To 2117 reenable this feature, use "Client/DisableRDPR=". 2149 2118 </para> 2150 2119 </listitem> … … 2153 2122 <para> 2154 2123 <computeroutput>--vrdeproperty 2155 "H3DRedirect/Enabled=1"</computeroutput> 2156 </para> 2157 2158 <para> 2159 Enables the VRDE server feature: 3D redirection. To disable 2160 this feature, use "H3DRedirect/Enabled=". 2124 "H3DRedirect/Enabled=1"</computeroutput>: Enables the VRDE 2125 server feature: 3D redirection. To disable this feature, use 2126 "H3DRedirect/Enabled=". 2161 2127 </para> 2162 2128 </listitem> … … 2165 2131 <para> 2166 2132 <computeroutput>--vrdeproperty 2167 "Security/Method|ServerCertificate|ServerPrivateKey|CACertificate=<value>"</computeroutput> 2168 sets the desired security method/Path of server certificate,2169 path of server private key, path of CA certificate, used for2170 a connection.2133 "Security/Method|ServerCertificate|ServerPrivateKey|CACertificate=<value>"</computeroutput>: 2134 Sets the desired security method and path of server 2135 certificate, path of server private key, path of CA 2136 certificate, that are used for a connection. 2171 2137 </para> 2172 2138 … … 2185 2151 <listitem> 2186 2152 <para> 2187 <computeroutput>Negotiate</computeroutput> - both2153 <computeroutput>Negotiate</computeroutput>: Both 2188 2154 Enhanced (TLS) and Standard RDP Security connections 2189 2155 are allowed. The security method is negotiated with … … 2194 2160 <listitem> 2195 2161 <para> 2196 <computeroutput>RDP</computeroutput> - only Standard2162 <computeroutput>RDP</computeroutput>: Only Standard 2197 2163 RDP Security is accepted. 2198 2164 </para> … … 2201 2167 <listitem> 2202 2168 <para> 2203 <computeroutput>TLS</computeroutput> - only Enhanced2169 <computeroutput>TLS</computeroutput>: Only Enhanced 2204 2170 RDP Security is accepted. The client must support 2205 2171 TLS. … … 2219 2185 "Security/ServerCertificate=<value>"</computeroutput> 2220 2186 where <value> is the absolute path of the server 2221 certificate. S see <xref linkend="vrde-crypt" />.2187 certificate. See <xref linkend="vrde-crypt" />. 2222 2188 </para> 2223 2189 </listitem> … … 2248 2214 <computeroutput>--vrdeproperty 2249 2215 "Audio/RateCorrectionMode|LogPath=<value>"</computeroutput> 2250 sets the Audio connection mode, or Path of the audio2216 sets the audio connection mode, or path of the audio 2251 2217 logfile. 2252 2218 </para> … … 2258 2224 <computeroutput>--vrdeproperty 2259 2225 "Audio/RateCorrectionMode=<value>"</computeroutput> 2260 where <value> is the desired rate correction mode ,2261 allowed values are:2226 where <value> is the desired rate correction mode. 2227 Allowed values are: 2262 2228 </para> 2263 2229 … … 2266 2232 <listitem> 2267 2233 <para> 2268 <computeroutput>VRDP_AUDIO_MODE_VOID</computeroutput> 2269 - no mode specified, use to unset any Audio mode2234 <computeroutput>VRDP_AUDIO_MODE_VOID</computeroutput>: 2235 No mode specified, use to unset any Audio mode 2270 2236 already set. 2271 2237 </para> … … 2274 2240 <listitem> 2275 2241 <para> 2276 <computeroutput>VRDP_AUDIO_MODE_RC</computeroutput> 2277 - rate correction mode.2242 <computeroutput>VRDP_AUDIO_MODE_RC</computeroutput>: 2243 Rate correction mode. 2278 2244 </para> 2279 2245 </listitem> … … 2281 2247 <listitem> 2282 2248 <para> 2283 <computeroutput>VRDP_AUDIO_MODE_LPF</computeroutput> 2284 - low pass filter mode.2249 <computeroutput>VRDP_AUDIO_MODE_LPF</computeroutput>: 2250 Low pass filter mode. 2285 2251 </para> 2286 2252 </listitem> … … 2288 2254 <listitem> 2289 2255 <para> 2290 <computeroutput>VRDP_AUDIO_MODE_CS</computeroutput> 2291 - client sync mode to prevent under/overflow of the2292 client queue.2256 <computeroutput>VRDP_AUDIO_MODE_CS</computeroutput>: 2257 Client sync mode to prevent underflow or overflow of 2258 the client queue. 2293 2259 </para> 2294 2260 </listitem> … … 2312 2278 <para> 2313 2279 <computeroutput>--vrdeextpack 2314 default|<name></computeroutput>: Enables specification2315 of the library for accessing the VM remotely. The default is2316 t o use the RDP code which is part of the Oracle VM2317 VirtualBox ExtensionPack.2280 default|<name></computeroutput>: Specifies the library 2281 to use for accessing the VM remotely. The default is to use 2282 the RDP code which is part of the &product-name; Extension 2283 Pack. 2318 2284 </para> 2319 2285 </listitem> … … 2323 2289 <computeroutput>--vrdeport 2324 2290 default|<ports></computeroutput>: A port or a range of 2325 ports the VRDE server can bind to; "default" or "0" means 2326 port 3389, the standard port for RDP. You can specify a 2327 comma-separated list of ports or ranges of ports. Use a dash 2328 between two port numbers to specify a range. The VRDE server 2329 will bind to 2330 <emphasis 2331 role="bold">one</emphasis> of the 2332 available ports from the specified list. Only one machine 2333 can use a given port at a time. For example, the option 2334 <computeroutput> --vrdeport 5000,5010-5012</computeroutput> 2335 will tell the server to bind to one of following ports: 2336 5000, 5010, 5011 or 5012. 2291 ports the VRDE server can bind to. 2292 <computeroutput>default</computeroutput> or 2293 <computeroutput>0</computeroutput> means port 3389, the 2294 standard port for RDP. You can specify a comma-separated 2295 list of ports or ranges of ports. Use a dash between two 2296 port numbers to specify a range. The VRDE server will bind 2297 to <emphasis>one</emphasis> of the available ports from the 2298 specified list. Only one machine can use a given port at a 2299 time. For example, the option <computeroutput> --vrdeport 2300 5000,5010-5012</computeroutput> will tell the server to bind 2301 to one of following ports: 5000, 5010, 5011, or 5012. 2337 2302 </para> 2338 2303 </listitem> … … 2349 2314 <para> 2350 2315 The setting can be used to specify whether the VRDP server 2351 should accept either IPv4, IPv6 or both connections:2316 should accept either IPv4, IPv6, or both connections: 2352 2317 </para> 2353 2318 … … 2370 2335 <listitem> 2371 2336 <para> 2372 Both IPv6 and IPv4 (default): 2373 <computeroutput>--vrdeaddress "" </computeroutput> 2337 Both IPv6 and IPv4: <computeroutput>--vrdeaddress "" 2338 </computeroutput> 2339 </para> 2340 2341 <para> 2342 This is the default setting. 2374 2343 </para> 2375 2344 </listitem> … … 2381 2350 <para> 2382 2351 <computeroutput>--vrdeauthtype 2383 null|external|guest</computeroutput>: This enables you to2352 null|external|guest</computeroutput>: Enables you to 2384 2353 indicate use of authorization, and specify how authorization 2385 2354 will be performed. See <xref linkend="vbox-auth" />. … … 2390 2359 <para> 2391 2360 <computeroutput>--vrdeauthlibrary 2392 default|<name></computeroutput>: This specifies the2393 libraryused for RDP authentication. See2394 <xref 2361 default|<name></computeroutput>: Specifies the library 2362 used for RDP authentication. See 2363 <xref 2395 2364 linkend="vbox-auth" />. 2396 2365 </para> … … 2399 2368 <listitem> 2400 2369 <para> 2401 <computeroutput>--vrdemulticon on|off</computeroutput>: This2402 enables multiple connections to be made to the same VRDE2370 <computeroutput>--vrdemulticon on|off</computeroutput>: 2371 Enables multiple connections to be made to the same VRDE 2403 2372 server, if the server supports this feature. See 2404 <xref 2373 <xref 2405 2374 linkend="vrde-multiconnection" />. 2406 2375 </para> … … 2422 2391 <para> 2423 2392 <computeroutput>--vrdevideochannel on|off</computeroutput>: 2424 This enables video redirection, if it is supported by the2425 VRDEserver. See <xref linkend="vrde-videochannel" />.2393 Enables video redirection, if it is supported by the VRDE 2394 server. See <xref linkend="vrde-videochannel" />. 2426 2395 </para> 2427 2396 </listitem> … … 2432 2401 <percent></computeroutput>: Specifies the image 2433 2402 quality for video redirection. See 2434 <xref 2403 <xref 2435 2404 linkend="vrde-videochannel" />. 2436 2405 </para> … … 2446 2415 2447 2416 <para> 2448 With the following commands for <com puteroutput>VBoxManage2449 modifyvm</com puteroutput> you can configure a machine to be a2450 targetfor teleporting. See <xref linkend="teleporting" />.2417 With the following commands for <command>VBoxManage 2418 modifyvm</command> you can configure a machine to be a target 2419 for teleporting. See <xref linkend="teleporting" />. 2451 2420 </para> 2452 2421 … … 2455 2424 <listitem> 2456 2425 <para> 2457 <computeroutput>--teleporter on|off</computeroutput>: This2458 setting enables/disables the teleporter feature whereby when2459 the machine is started, it waits to receieve a teleporting2426 <computeroutput>--teleporter on|off</computeroutput>: 2427 Enables and disables the teleporter feature whereby when the 2428 machine is started, it waits to receive a teleporting 2460 2429 request from the network instead of booting normally. 2461 2430 Teleporting requests are received on the port and address … … 2470 2439 <computeroutput>--teleporteraddress 2471 2440 <address></computeroutput>: These settings must be 2472 used with --teleporter and they specify the port and address 2473 the virtual machine should listen to to receive a 2474 teleporting request sent from another virtual machine. 2441 used with <computeroutput>--teleporter</computeroutput>. 2442 They specify the port and address the virtual machine should 2443 listen to in order to receive a teleporting request sent 2444 from another virtual machine. 2475 2445 <computeroutput><port></computeroutput> can be any 2476 2446 free TCP/IP port number, such as 6000. 2477 2447 <computeroutput><address></computeroutput> can be any 2478 2448 IP address or hostname and specifies the TCP/IP socket to 2479 bind to. The default is "0.0.0.0", which means any address.2449 bind to. The default is 0.0.0.0, which means any address. 2480 2450 </para> 2481 2451 </listitem> … … 2485 2455 <computeroutput>--teleporterpassword 2486 2456 <password></computeroutput>: If this optional setting 2487 is given, then the teleporting request will only succeed if2457 is used, then the teleporting request will only succeed if 2488 2458 the source machine specifies the same password as the one 2489 2459 given with this command. … … 2495 2465 <computeroutput>--teleporterpasswordfile 2496 2466 <password></computeroutput>: If this optional setting 2497 is given, then the teleporting request will only succeed if2467 is used, then the teleporting request will only succeed if 2498 2468 the source machine specifies the same password as the one 2499 2469 specified in the file give with this command. Use … … 2507 2477 <computeroutput>--cpuid <leaf> <eax> <ebx> 2508 2478 <ecx> <edx></computeroutput>: Advanced users can 2509 use this setting before a teleporting operation to restrict 2510 the virtual CPU capabilities that VirtualBox presents to the 2511 guest operating system. This must be run on both the source 2512 and the target machines involved in the teleporting and will 2513 then modify what the guest sees when it executes the 2514 <computeroutput>CPUID</computeroutput> machine instruction. 2515 This might help with misbehaving applications that wrongly 2516 assume that certain CPU capabilities are present. The 2517 meaning of the parameters is hardware dependent, refer to 2518 the AMD or Intel processor documentation. 2479 use this setting before a teleporting operation, to restrict 2480 the virtual CPU capabilities that &product-name; presents to 2481 the guest operating system. This must be run on both the 2482 source and the target machines involved in the teleporting 2483 and will then modify what the guest sees when it executes 2484 the <computeroutput>CPUID</computeroutput> machine 2485 instruction. This might help with misbehaving applications 2486 that wrongly assume that certain CPU capabilities are 2487 present. The meaning of the parameters is hardware 2488 dependent, refer to the AMD or Intel processor 2489 documentation. 2519 2490 </para> 2520 2491 </listitem> … … 2538 2509 <para> 2539 2510 <computeroutput>--tracing-enabled on|off</computeroutput>: 2540 Enable the tracebuffer. This consumes some memory for the2511 Enables the tracebuffer. This consumes some memory for the 2541 2512 tracebuffer and adds extra overhead. 2542 2513 </para> … … 2555 2526 <para> 2556 2527 <computeroutput>--tracing-allow-vm-access 2557 on|off</computeroutput>: Enables /disables (default) VM2558 access to the tracebuffer.2528 on|off</computeroutput>: Enables and disables VM access to 2529 the tracebuffer. By default, this setting is disabled. 2559 2530 </para> 2560 2531 </listitem> … … 2580 2551 <para> 2581 2552 <computeroutput>--usbcardreader on|off</computeroutput>: 2582 Enables /disables the USB card reader interface.2553 Enables and disables the USB card reader interface. 2583 2554 </para> 2584 2555 </listitem> … … 2603 2574 <listitem> 2604 2575 <para> 2605 <computeroutput>--autostart on|off</computeroutput>:2606 Enables /disables VM autostart at host system boot-up, using2607 specified user name.2576 <computeroutput>--autostart-enabled on|off</computeroutput>: 2577 Enables and disables VM autostart at host system boot-up, 2578 using the specified user name. 2608 2579 </para> 2609 2580 </listitem> … … 2612 2583 <para> 2613 2584 <computeroutput>--autostart-delay 2614 <seconds></computeroutput>: Specifies a delay 2615 (seconds) following host system boot-up, before VM2585 <seconds></computeroutput>: Specifies a delay, in 2586 seconds, following host system boot-up, before the VM 2616 2587 autostarts. 2617 2588 </para> … … 2629 2600 2630 2601 <para> 2631 This command creates a full or linked copy of an existing virtual 2632 machine. 2633 </para> 2634 2635 <para> 2636 The <computeroutput>clonevm</computeroutput> subcommand takes at 2637 least the name of the virtual machine which should be cloned. The 2638 following additional settings can be used to further configure the 2639 clone VM operation: 2602 The <command>VBoxManage clonevm</command> command creates a clone 2603 of an existing virtual machine (VM). The clone can be a full copy 2604 of the VM or a linked copy of a VM. 2605 </para> 2606 2607 <screen> 2608 VBoxManage clonevm <replaceable>vm</replaceable> [ --basefolder <replaceable>basefolder</replaceable> ] 2609 [ --group <replaceable>group</replaceable>, ... ] [ --mode machine | machinechildren | all ] 2610 [ --name <replaceable>name</replaceable> ] [ --options link | keepallmacs | keepnatmacs | keepdisknames | keephwuuids ] 2611 [ --register ] [ --snapshot <replaceable>vm</replaceable> ] [ --uuid <replaceable>uuid</replaceable> ] 2612 </screen> 2613 2614 <para> 2615 In addition to specifying the name of the VM to clone, which is 2616 required, you can specify any of the following options: 2640 2617 </para> 2641 2618 … … 2644 2621 <listitem> 2645 2622 <para> 2646 <computeroutput>--snapshot 2647 <uuid>|<name></computeroutput>: Select a specific 2648 snapshot where the clone operation should refer to. Default is 2649 referring to the current state. 2650 </para> 2651 </listitem> 2652 2653 <listitem> 2654 <para> 2655 <computeroutput>--mode 2656 machine|machineandchildren|all</computeroutput>: Selects the 2657 cloning mode of the operation. If 2658 <computeroutput>machine</computeroutput> is selected (the 2659 default), the current state of the VM without any snapshots is 2660 cloned. In the 2661 <computeroutput>machineandchildren</computeroutput> mode the 2662 snapshot provided by 2663 <computeroutput>--snapshot</computeroutput> and all child 2664 snapshots are cloned. If <computeroutput>all</computeroutput> 2665 is the selected mode all snapshots and the current state are 2666 cloned. 2667 </para> 2668 </listitem> 2669 2670 <listitem> 2671 <para> 2672 <computeroutput>--options 2673 link|keepallmacs|keepnatmacs|keepdisknames|keephwuuids</computeroutput>: 2674 Allows additional fine tuning of the clone operation. The 2675 first option defines that a linked clone should be created, 2676 which is only possible for a machine cloned from a snapshot. 2677 The next two options enable specification of the handling of 2678 MAC addresses of every virtual network card. They can either 2679 be reinitialized (the default), left unchanged 2680 (<computeroutput>keepallmacs</computeroutput>) or left 2681 unchanged when the network type is NAT 2682 (<computeroutput>keepnatmacs</computeroutput>). If you add 2683 <computeroutput>keepdisknames</computeroutput> all new disk 2684 images are called like the original ones, otherwise they are 2685 renamed. If you add <computeroutput>keephwuuids</computeroutput> 2686 source hardware IDs will be preserved. 2687 </para> 2688 </listitem> 2689 2690 <listitem> 2691 <para> 2692 <computeroutput>--name <name></computeroutput>: Select a 2693 new name for the new virtual machine. Default is "Original 2694 Name Clone". 2695 </para> 2696 </listitem> 2697 2698 <listitem> 2699 <para> 2700 <computeroutput>--groups <group>, ...</computeroutput> 2701 Enables the clone to be assigned membership of the specified 2702 VM groups in the list. Note that group ids always start with a 2703 <computeroutput>/</computeroutput> and can be nested. By 2704 default, clones are always assigned membership of the group 2705 <computeroutput>/</computeroutput>. 2706 </para> 2707 </listitem> 2708 2709 <listitem> 2710 <para> 2711 <computeroutput>--basefolder 2712 <basefolder></computeroutput>: Select the folder where 2713 the new virtual machine configuration should be saved in. 2714 </para> 2715 </listitem> 2716 2717 <listitem> 2718 <para> 2719 <computeroutput>--uuid <uuid></computeroutput>: Select 2720 the UUID the new VM should have. This ID has to be unique in 2721 the VirtualBox instance this clone should be registered. 2722 Default is creating a new UUID. 2723 </para> 2724 </listitem> 2725 2726 <listitem> 2727 <para> 2728 <computeroutput>--register</computeroutput>: Automatically 2729 register the new clone in this VirtualBox installation. If you 2730 manually want to register the new VM later, see 2731 <xref linkend="vboxmanage-registervm" />. 2623 <option>--basefolder</option> 2624 <replaceable>basefolder</replaceable> specifies the name of 2625 the folder in which to save the configuration for the new VM. 2626 </para> 2627 </listitem> 2628 2629 <listitem> 2630 <para> 2631 <option>--groups <replaceable>group</replaceable>, 2632 ...</option> assigns the clone to the specified group or 2633 groups. If you specify more than one group, separate each 2634 group name with a comma. 2635 </para> 2636 2637 <para> 2638 Note that each group is identified by a group ID that starts 2639 with a slash character (<computeroutput>/</computeroutput>) so 2640 that groups can be nested. By default, a clone is always 2641 assigned membership to the <computeroutput>/</computeroutput> 2642 group. 2643 </para> 2644 </listitem> 2645 2646 <listitem> 2647 <para> 2648 <option>--mode machine|machineandchildren|all</option> 2649 specifies which of the following cloning modes to use: 2650 </para> 2651 2652 <itemizedlist> 2653 2654 <listitem> 2655 <para> 2656 <computeroutput>machine</computeroutput> mode clones the 2657 current state of the existing VM without any snapshots. 2658 This is the default mode. 2659 </para> 2660 </listitem> 2661 2662 <listitem> 2663 <para> 2664 <computeroutput>machineandchildren</computeroutput> mode 2665 clones the snapshot specified by by the 2666 <option>--snapshot</option> option and all child 2667 snapshots. 2668 </para> 2669 </listitem> 2670 2671 <listitem> 2672 <para> 2673 <computeroutput>all</computeroutput> mode clones all 2674 snapshots and the current state of the existing VM. 2675 </para> 2676 </listitem> 2677 2678 </itemizedlist> 2679 </listitem> 2680 2681 <listitem> 2682 <para> 2683 <option>--name <replaceable>name</replaceable></option> 2684 specifies a new name for the new VM. The default value is 2685 "<replaceable>name</replaceable> Clone", where 2686 <replaceable>name</replaceable> is the original name of the 2687 VM. 2688 </para> 2689 </listitem> 2690 2691 <listitem> 2692 <para> 2693 <option>--options</option> specifies how to create a new 2694 clone. 2695 </para> 2696 2697 <itemizedlist> 2698 2699 <listitem> 2700 <para> 2701 <option>--options link</option> creates a linked clone, 2702 which can be cloned only from a snapshot. 2703 </para> 2704 </listitem> 2705 2706 <listitem> 2707 <para> 2708 <option>--options keepallmacs</option> specifies that the 2709 new clone reuses the MAC addresses of each virtual network 2710 card from the existing VM. 2711 </para> 2712 2713 <para> 2714 If you do not specify this option or the <option>--options 2715 keepnatmacs</option> option, the default behavior is to 2716 reinitialize the MAC addresses of each virtual network 2717 card. 2718 </para> 2719 </listitem> 2720 2721 <listitem> 2722 <para> 2723 <option>--options keepnatmacs</option> specifies that the 2724 new clone reuses the MAC addresses of each virtual network 2725 card from the existing VM when the network type is NAT. 2726 </para> 2727 2728 <para> 2729 If you do not specify this option or the <option>--options 2730 keepallmacs</option> option, the default behavior is to 2731 reinitialize the MAC addresses of each virtual network 2732 card. 2733 </para> 2734 </listitem> 2735 2736 <listitem> 2737 <para> 2738 <option>--option keepdisknames</option> specifies that the 2739 new clone reuses the disk image names from the existing 2740 VM. By default, disk images are renamed. You can preserve 2741 source hardware IDs by adding 2742 <computeroutput>keephwuuids</computeroutput>. 2743 </para> 2744 </listitem> 2745 2746 <listitem> 2747 <para> 2748 <option>--option keephwuuids</option> specifies that the 2749 new clone reuses the hardware IDs from the existing VM. By 2750 default, new UUIDs are used. 2751 </para> 2752 </listitem> 2753 2754 </itemizedlist> 2755 </listitem> 2756 2757 <listitem> 2758 <para> 2759 <option>--register</option> automatically registers the new 2760 clone in this &product-name; installation. You can manually 2761 register the new VM later by using the <command>VMBoxManage 2762 registervm</command> command. See the 2763 <xref linkend="vboxmanage-registervm" /> man page. 2764 </para> 2765 </listitem> 2766 2767 <listitem> 2768 <para> 2769 <option>--snapshot <replaceable>vm</replaceable></option> 2770 specifies the snapshot on which to base the new VM. By 2771 default, the clone is created from the current state of the 2772 specified VM. 2773 </para> 2774 </listitem> 2775 2776 <listitem> 2777 <para> 2778 <option>--uuid <replaceable>uuid</replaceable></option> 2779 specifies the UUID for the new VM. Ensure that this ID is 2780 unique for the &product-name; instance if you decide to 2781 register this new VM. By default, &product-name; provides a 2782 new UUID. 2732 2783 </para> 2733 2784 </listitem> 2734 2785 2735 2786 </itemizedlist> 2787 2788 </sect1> 2789 2790 <sect1 id="vboxmanage-movevm"> 2791 2792 <title>VBoxManage movevm</title> 2793 2794 <para> 2795 This command moves a virtual machine to a new location on the 2796 host. 2797 </para> 2798 2799 <para> 2800 Associated files of the virtual machine, such as settings files 2801 and disk image files, are moved to the new location. The 2802 &product-name; configuration is updated automatically. 2803 </para> 2804 2805 <para> 2806 The <command>movevm</command> subcommand requires the name of the 2807 virtual machine which should be moved. 2808 </para> 2809 2810 <remark> 2811 What does the --type basic setting do? 2812 </remark> 2813 2814 <para> 2815 Also required is the type of move operation, specified by 2816 <computeroutput>--type basic</computeroutput>. Other types of move 2817 operation may be supported in future releases. 2818 </para> 2819 2820 <para> 2821 The <computeroutput>--folder</computeroutput> setting configures 2822 the new location on the host file system. Enter a relative 2823 pathname or a full pathname. 2824 </para> 2736 2825 2737 2826 </sect1> … … 2744 2833 This command imports a virtual appliance in OVF format by copying 2745 2834 the virtual disk images and creating virtual machines in 2746 VirtualBox. See <xref linkend="ovf" /> for an introduction to2835 &product-name;. See <xref linkend="ovf" /> for an introduction to 2747 2836 appliances. 2748 2837 </para> 2749 2838 2750 2839 <para> 2751 The <computeroutput>import</computeroutput> subcommand takes at 2752 least the path name of an OVF file as input and expects the disk 2753 images, if needed, in the same directory as the OVF file. A lot of 2754 additional command-line options are supported to control in detail 2755 what is being imported and modify the import parameters, but the 2756 details depend on the content of the OVF file. 2757 </para> 2758 2759 <para> 2760 It is therefore recommended to first run the import subcommand 2761 with the <computeroutput>--dry-run</computeroutput> or 2840 The <command>import</command> subcommand takes at least the path 2841 name of an OVF file as input and expects the disk images, if 2842 needed, in the same directory as the OVF file. A lot of additional 2843 command-line options are supported to control in detail what is 2844 being imported and modify the import parameters, but the details 2845 depend on the content of the OVF file. 2846 </para> 2847 2848 <para> 2849 It is therefore recommended to first run the 2850 <command>import</command> subcommand with the 2851 <computeroutput>--dry-run</computeroutput> or 2762 2852 <computeroutput>-n</computeroutput> option. This will then print a 2763 2853 description of the appliance's contents to the screen how it would 2764 be imported into VirtualBox, together with the optional2854 be imported into &product-name;, together with the optional 2765 2855 command-line options to influence the import behavior. 2766 2856 </para> … … 2768 2858 <para> 2769 2859 Use of the <computeroutput>--options 2770 keepallmacs|keepnatmacs|keepdisknames</computeroutput> :2771 option enables additional fine tuning of the clone operation. The2772 first two options enable specification of how the MAC addresses of2773 everyvirtual network card should be handled. They can either be2774 reinitialized (the default), left unchanged2860 keepallmacs|keepnatmacs|keepdisknames</computeroutput> option 2861 enables additional fine tuning of the clone operation. The first 2862 two options enable specification of how the MAC addresses of every 2863 virtual network card should be handled. They can either be 2864 reinitialized, which is the default setting, left unchanged 2775 2865 (<computeroutput>keepallmacs</computeroutput>) or left unchanged 2776 2866 when the network type is NAT … … 2782 2872 2783 2873 <para> 2784 As an example, here is the screen output with a sample appliance2785 containing a Windows XP guest:2874 As an example, the following is a screen output for a sample 2875 appliance containing a Windows XP guest: 2786 2876 </para> 2787 2877 … … 2828 2918 subcommand can be directed to ignore many such items with a 2829 2919 <computeroutput>--vsys X --unit Y --ignore</computeroutput> 2830 option, where X is the number of the virtual system (zero unless2831 there are several virtual system descriptions in the appliance)2832 and Y the item number, as printed on the screen.2920 option, where X is the number of the virtual system and Y the item 2921 number, as printed on the screen. X is zero, unless there are 2922 several virtual system descriptions in the appliance. 2833 2923 </para> 2834 2924 2835 2925 <para> 2836 2926 In the above example, Item #1 specifies the name of the target 2837 machine in VirtualBox. Items #9 and #10 specify hard disk2838 controllers, respectively. Item #11 describes a hard disk image ;2839 in this case, the additional2927 machine in &product-name;. Items #9 and #10 specify hard disk 2928 controllers, respectively. Item #11 describes a hard disk image. 2929 In this case, the additional 2840 2930 <computeroutput>--controller</computeroutput> option indicates 2841 2931 which item the disk image should be connected to, with the default … … 2849 2939 the sound card and without the USB controller, and with the disk 2850 2940 image connected to the IDE controller instead of the SCSI 2851 controller, use th iscommand:2941 controller, use the following command: 2852 2942 </para> 2853 2943 … … 2862 2952 2863 2953 <para> 2864 This command exports one or more virtual machines from VirtualBox 2865 into a virtual appliance in OVF format, including copying their 2866 virtual disk images to compressed VMDK. See <xref linkend="ovf" /> 2867 for an introduction to appliances. 2868 </para> 2869 2870 <para> 2871 The <computeroutput>export</computeroutput> command is simple to 2872 use: list the machine (or the machines) that you would like to 2873 export to the same OVF file and specify the target OVF file after 2874 an additional <computeroutput>--output</computeroutput> or 2875 <computeroutput>-o</computeroutput> option. Note that the 2876 directory of the target OVF file will also receive the exported 2877 disk images in the compressed VMDK format (regardless of the 2878 original format) and should have enough disk space left for them. 2879 </para> 2880 2881 <para> 2882 Beside a simple export of a given virtual machine, you can append 2883 several product information to the appliance file. Use 2884 <computeroutput>--product</computeroutput>, 2885 <computeroutput>--producturl</computeroutput>, 2886 <computeroutput>--vendor</computeroutput>, 2887 <computeroutput>--vendorurl</computeroutput>, 2888 <computeroutput>--version</computeroutput> and 2889 <computeroutput>--description</computeroutput> to specify this 2890 additional information. For legal reasons you may add a license 2891 text or the content of a license file by using the 2892 <computeroutput>--eula</computeroutput> and 2893 <computeroutput>--eulafile</computeroutput> option respectively. 2894 As with OVF import, you must use the <computeroutput>--vsys 2895 X</computeroutput> option to direct the previously mentioned 2896 options to the correct virtual machine. 2897 </para> 2898 2899 <para> 2900 For virtualization products which are not fully compatible with 2901 the OVF standard 1.0 you can enable an OVF 0.9 legacy mode with 2902 the <computeroutput>--legacy09</computeroutput> option. Other 2903 options are <computeroutput>--ovf09</computeroutput>, 2904 <computeroutput>--ovf10</computeroutput>, 2905 <computeroutput>--ovf20</computeroutput>. 2906 </para> 2907 2908 <para> 2909 To specify options controlling the exact content of the appliance 2910 file, you can use <computeroutput>--options</computeroutput> to 2911 request the creation of a manifest file, which allows detection of 2912 corrupted appliances on import, the additional export of DVD 2913 images, and the exclusion of MAC addresses. You can specify a list 2914 of options, such as <computeroutput>--options 2915 manifest,nomacs</computeroutput>. For details, check the help 2916 output of <computeroutput>VBoxManage export</computeroutput>. 2917 </para> 2954 This command exports one or more virtual machines from 2955 &product-name;. You can export to either of the following: 2956 </para> 2957 2958 <itemizedlist> 2959 2960 <listitem> 2961 <para> 2962 A virtual appliance in OVF format, including copying their 2963 virtual disk images to compressed VMDK 2964 </para> 2965 </listitem> 2966 2967 <listitem> 2968 <para> 2969 A cloud service, such as &oci;. 2970 </para> 2971 </listitem> 2972 2973 </itemizedlist> 2974 2975 <para> 2976 See <xref linkend="ovf" /> for more details on exporting VMs from 2977 &product-name;. 2978 </para> 2979 2980 <sect2 id="vboxmanage-export-ovf"> 2981 2982 <title>Export to OVF</title> 2983 2984 <para> 2985 List the machine, or the machines, that you would like to export 2986 to the same OVF file and specify the target OVF file after an 2987 additional <computeroutput>--output</computeroutput> or 2988 <computeroutput>-o</computeroutput> option. Note that the 2989 directory of the target OVF file will also receive the exported 2990 disk images in the compressed VMDK format, regardless of the 2991 original format, and should have enough disk space left for 2992 them. 2993 </para> 2994 2995 <para> 2996 Beside a simple export of a given virtual machine, you can 2997 append several product information to the appliance file. Use 2998 <computeroutput>--product</computeroutput>, 2999 <computeroutput>--producturl</computeroutput>, 3000 <computeroutput>--vendor</computeroutput>, 3001 <computeroutput>--vendorurl</computeroutput>, 3002 <computeroutput>--version</computeroutput> and 3003 <computeroutput>--description</computeroutput> to specify this 3004 additional information. For legal reasons you may add a license 3005 text or the content of a license file by using the 3006 <computeroutput>--eula</computeroutput> and 3007 <computeroutput>--eulafile</computeroutput> option respectively. 3008 </para> 3009 3010 <para> 3011 As with OVF import, you use the <computeroutput>--vsys 3012 X</computeroutput> option to apply these options to the correct 3013 virtual machine. 3014 </para> 3015 3016 <para> 3017 For virtualization products which are not fully compatible with 3018 the OVF standard 1.0 you can enable an OVF 0.9 legacy mode with 3019 the <computeroutput>--legacy09</computeroutput> option. Other 3020 options are <computeroutput>--ovf09</computeroutput>, 3021 <computeroutput>--ovf10</computeroutput>, 3022 <computeroutput>--ovf20</computeroutput>. 3023 </para> 3024 3025 <para> 3026 To specify options controlling the exact content of the 3027 appliance file, you can use <option>--options</option> to 3028 request the creation of a manifest file, which enables detection 3029 of corrupted appliances on import, the additional export of DVD 3030 images, and the exclusion of MAC addresses. You can specify a 3031 list of options, such as <option>--options 3032 manifest,nomacs</option>. For details, check the help output of 3033 <command>VBoxManage export</command>. 3034 </para> 3035 3036 </sect2> 3037 3038 <sect2 id="vboxmanage-export-cloud"> 3039 3040 <title>Export to &oci;</title> 3041 3042 <para> 3043 List the machine that you want to export to &oci; and specify 3044 output to &oci; by using the 3045 <computeroutput>--output</computeroutput> or 3046 <computeroutput>-o</computeroutput> option. 3047 </para> 3048 3049 <para> 3050 To export a VM to a cloud service such as &oci;, you must use 3051 the <option>--cloud</option> option to identify the virtual 3052 machine that you want to export. This option works in the same 3053 way as the <option>--vsys</option> option for OVF export. 3054 </para> 3055 3056 <para> 3057 Specify the following options. Some of these are settings for 3058 the VM instance and require you to enter an Oracle Cloud 3059 Identifier (OCID) for a resource. OCIDs can be viewed using the 3060 &oci; Console. 3061 </para> 3062 3063 <itemizedlist> 3064 3065 <listitem> 3066 <para> 3067 <computeroutput>--output</computeroutput>: The short name 3068 for the cloud service you are exporting to. For &oci;, enter 3069 <computeroutput>OCI//</computeroutput>. 3070 </para> 3071 </listitem> 3072 3073 <listitem> 3074 <para> 3075 <computeroutput>--cloud <number of virtual 3076 system></computeroutput>: A number identifying the VM 3077 that you are exporting. Numbering starts at 3078 <computeroutput>0</computeroutput> for the first VM. 3079 </para> 3080 </listitem> 3081 3082 <listitem> 3083 <para> 3084 <computeroutput>--vmname <vnamem></computeroutput>: 3085 The name of the VM to export. This is the name used in the 3086 VirtualBox Manager. 3087 </para> 3088 </listitem> 3089 3090 <listitem> 3091 <para> 3092 <computeroutput>--cloudprofile <cloud profile 3093 name></computeroutput>: The cloud profile used for the 3094 export. The cloud profile contains details for your &oci; 3095 account, such as your user OCID, and the fingerprint for 3096 your public key. See <xref linkend="ovf-export-oci"/>. 3097 </para> 3098 </listitem> 3099 3100 <listitem> 3101 <para> 3102 <computeroutput>--cloudshape <shape></computeroutput>: 3103 The shape used for the VM instance. This determines the 3104 number of CPUs and the amount of memory allocated to a the 3105 VM instance. 3106 </para> 3107 </listitem> 3108 3109 <listitem> 3110 <para> 3111 <computeroutput>--clouddomain 3112 <domain></computeroutput>: The availability domain 3113 used for the VM instance. Enter the OCID for the 3114 availability domain. 3115 </para> 3116 </listitem> 3117 3118 <listitem> 3119 <para> 3120 <computeroutput>--clouddisksize <disk 3121 size></computeroutput>: The disk size used for the VM 3122 instance, in gigabytes. 3123 </para> 3124 </listitem> 3125 3126 <listitem> 3127 <para> 3128 <computeroutput>--cloudbucket <bucket 3129 name></computeroutput>: The bucket used to store the VM 3130 instance. In &oci;, a bucket is a logical container for 3131 storing objects. 3132 </para> 3133 </listitem> 3134 3135 <listitem> 3136 <para> 3137 <computeroutput>--cloudocivcn <OCI vcn 3138 id></computeroutput>: The virtual cloud network (VCN) 3139 used for the VM instance. Enter the OCID for the VCN. 3140 </para> 3141 </listitem> 3142 3143 <listitem> 3144 <para> 3145 <computeroutput>--cloudocisubnet <OCI subnet 3146 ID></computeroutput>: The subnet of the VCN used for the 3147 VM instance. Enter the OCID for the subnet. 3148 </para> 3149 </listitem> 3150 3151 <listitem> 3152 <para> 3153 <computeroutput>--cloudkeepobject 3154 <true/false></computeroutput>: Whether to store the 3155 exported disk image in Oracle Object Storage. 3156 </para> 3157 </listitem> 3158 3159 <listitem> 3160 <para> 3161 <computeroutput>--cloudlaunchinstance 3162 <true/false></computeroutput>: Whether to start the VM 3163 instance after export to &oci; has completed. 3164 </para> 3165 </listitem> 3166 3167 <listitem> 3168 <para> 3169 <computeroutput>--cloudpublicip 3170 <true/false></computeroutput>: Whether to enable a 3171 public IP address for the VM instance. 3172 </para> 3173 </listitem> 3174 3175 </itemizedlist> 3176 3177 <para> 3178 The following example shows a typical command line for exporting 3179 a VM to &oci;. 3180 </para> 3181 3182 <screen>VBoxManage export "OCI_Export" --output OCI:// --cloud 0 --vmname OCI_export \ 3183 --cloudshape VM.Standard2.1 --clouddomain abcd:US-ASHBURN-AD-1 --clouddisksize 50 \ 3184 --cloudbucket test_bucket --cloudocivcn ocid1.vcn.oc1.iad.aaaa... \ 3185 --cloudpublicip true --cloudprofile "standard user" --cloudocisubnet ocid1.subnet.oc1.iad.aaaa... \ 3186 --cloudkeepobject true --cloudlaunchinstance true</screen> 3187 3188 </sect2> 2918 3189 2919 3190 </sect1> … … 2925 3196 <para> 2926 3197 This command starts a virtual machine that is currently in the 2927 "Powered off" or "Saved"states.3198 Powered Off or Saved states. 2928 3199 </para> 2929 3200 … … 2932 3203 determines whether the machine will be started in a window or 2933 3204 whether the output should go through 2934 <com puteroutput>VBoxHeadless</computeroutput>, with VRDE enabled2935 or not. See <xref linkend="vboxheadless" />. The list of types is2936 subject to change, and it is not guaranteed that all types are2937 a ccepted by any product variant.3205 <command>VBoxHeadless</command>, with VRDE enabled or not. See 3206 <xref linkend="vboxheadless" />. The list of types is subject to 3207 change, and it is not guaranteed that all types are accepted by 3208 any product variant. 2938 3209 </para> 2939 3210 … … 2976 3247 <varlistentry> 2977 3248 <term> 2978 <computeroutput>sdl</computeroutput>2979 </term>2980 2981 <listitem>2982 <para>2983 Starts a VM with a minimal GUI and limited features.2984 </para>2985 </listitem>2986 </varlistentry>2987 2988 <varlistentry>2989 <term>2990 3249 <computeroutput>separate</computeroutput> 2991 3250 </term> … … 2993 3252 <listitem> 2994 3253 <para> 2995 Starts a VM with detachable UI. Technically, it is a3254 Starts a VM with a detachable UI. Technically, it is a 2996 3255 headless VM with user interface in a separate process. This 2997 3256 is an experimental feature as it lacks certain 2998 functionality, such as 3D acceleration , at the moment.3257 functionality, such as 3D acceleration. 2999 3258 </para> 3000 3259 </listitem> … … 3020 3279 3021 3280 <para> 3022 The <com puteroutput>controlvm</computeroutput> subcommand allows3023 you to change the state of a virtual machine that is currently3024 running. Thefollowing can be specified:3281 The <command>controlvm</command> subcommand enables you to change 3282 the state of a virtual machine that is currently running. The 3283 following can be specified: 3025 3284 </para> 3026 3285 … … 3029 3288 <listitem> 3030 3289 <para> 3031 <computeroutput>VBoxManage controlvm <vm> 3032 pause</computeroutput> temporarily puts a virtual machine on 3033 hold, without changing its state for good. The VM window will 3034 be painted in gray to indicate that the VM is currently 3035 paused. This is equivalent to selecting the "Pause" item in 3036 the "Machine" menu of the GUI. 3037 </para> 3038 </listitem> 3039 3040 <listitem> 3041 <para> 3042 Use <computeroutput>VBoxManage controlvm <vm> 3043 resume</computeroutput> to undo a previous 3044 <computeroutput>pause</computeroutput> command. This is 3045 equivalent to selecting the "Resume" item in the "Machine" 3046 menu of the GUI. 3047 </para> 3048 </listitem> 3049 3050 <listitem> 3051 <para> 3052 <computeroutput>VBoxManage controlvm <vm> 3053 reset</computeroutput> has the same effect on a virtual 3054 machine as pressing the "Reset" button on a real computer: a 3055 cold reboot of the virtual machine, which will restart and 3056 boot the guest operating system again immediately. The state 3057 of the VM is not saved beforehand, and data may be lost. This 3058 is equivalent to selecting the "Reset" item in the "Machine" 3059 menu of the GUI. 3060 </para> 3061 </listitem> 3062 3063 <listitem> 3064 <para> 3065 <computeroutput>VBoxManage controlvm <vm> 3066 poweroff</computeroutput> has the same effect on a virtual 3067 machine as pulling the power cable on a real computer. Again, 3068 the state of the VM is not saved beforehand, and data may be 3069 lost. This is equivalent to selecting the "Close" item in the 3070 "Machine" menu of the GUI or pressing the window's close 3071 button, and then selecting "Power off the machine" in the 3072 dialog. 3073 </para> 3074 3075 <para> 3076 After this, the VM's state will be "Powered off". From there, 3077 it can be started again. See 3290 <command>VBoxManage controlvm <vm> pause</command>: 3291 Temporarily puts a virtual machine on hold, without 3292 permanently changing its state. The VM window is gray, to 3293 indicate that the VM is currently paused. This is equivalent 3294 to selecting the <emphasis role="bold">Pause</emphasis> item 3295 in the <emphasis role="bold">Machine</emphasis> menu of the 3296 GUI. 3297 </para> 3298 </listitem> 3299 3300 <listitem> 3301 <para> 3302 Use <command>VBoxManage controlvm <vm> resume</command>: 3303 Undoes a previous <command>pause</command> command. This is 3304 equivalent to selecting the 3305 <emphasis role="bold">Resume</emphasis> item in the 3306 <emphasis role="bold">Machine</emphasis> menu of the GUI. 3307 </para> 3308 </listitem> 3309 3310 <listitem> 3311 <para> 3312 <command>VBoxManage controlvm <vm> reset</command>: Has 3313 the same effect on a virtual machine as pressing the Reset 3314 button on a real computer. A cold reboot of the virtual 3315 machine is done, which immediately restarts and reboots the 3316 guest operating system. The state of the VM is not saved 3317 beforehand, and data may be lost. This is equivalent to 3318 selecting the <emphasis role="bold">Reset</emphasis> item in 3319 the <emphasis role="bold">Machine</emphasis> menu of the GUI. 3320 </para> 3321 </listitem> 3322 3323 <listitem> 3324 <para> 3325 <command>VBoxManage controlvm <vm> poweroff</command>: 3326 Has the same effect on a virtual machine as pulling the power 3327 cable on a real computer. The state of the VM is not saved 3328 beforehand, and data may be lost. This is equivalent to 3329 selecting the <emphasis role="bold">Close</emphasis> item in 3330 the <emphasis role="bold">Machine</emphasis> menu of the GUI, 3331 or clicking the VM window's close button, and then selecting 3332 <emphasis role="bold">Power Off the Machine</emphasis> in the 3333 displayed dialog. 3334 </para> 3335 3336 <para> 3337 After this, the VM's state will be Powered Off. From that 3338 state, it can be started again. See 3078 3339 <xref 3079 3340 linkend="vboxmanage-startvm" />. … … 3083 3344 <listitem> 3084 3345 <para> 3085 <computeroutput>VBoxManage controlvm <vm> 3086 savestate</computeroutput> will save the current state of the 3087 VM to disk and then stop the VM. This is equivalent to 3088 selecting the "Close" item in the "Machine" menu of the GUI or 3089 pressing the window's close button, and then selecting "Save 3090 the machine state" in the dialog. 3091 </para> 3092 3093 <para> 3094 After this, the VM's state will be "Saved". From there, it can 3095 be started again. See <xref linkend="vboxmanage-startvm" />. 3096 </para> 3097 </listitem> 3098 3099 <listitem> 3100 <para> 3101 <computeroutput>VBoxManage controlvm <vm> 3102 acpipowerbutton</computeroutput> will send an ACPI shutdown 3103 signal to the VM, as if the power button on a real computer 3104 had been pressed. So long as the VM is running a fairly modern 3105 guest operating system providing ACPI support, this should 3106 trigger a proper shutdown mechanism from within the VM. 3107 </para> 3108 </listitem> 3109 3110 <listitem> 3111 <para> 3112 <computeroutput>VBoxManage controlvm <vm> 3113 keyboardputscancode <hex> 3114 [<hex>...]</computeroutput> Sends commands using 3346 <command>VBoxManage controlvm <vm> savestate</command>: 3347 Saves the current state of the VM to disk and then stops the 3348 VM. This is equivalent to selecting the 3349 <emphasis role="bold">Close</emphasis> item in the 3350 <emphasis role="bold">Machine</emphasis> menu of the GUI or 3351 clicking the VM window's close button, and then selecting 3352 <emphasis role="bold">Save the Machine State</emphasis> in the 3353 displayed dialog. 3354 </para> 3355 3356 <para> 3357 After this, the VM's state will be Saved. From this state, it 3358 can be started again. See 3359 <xref linkend="vboxmanage-startvm" />. 3360 </para> 3361 </listitem> 3362 3363 <listitem> 3364 <para> 3365 <command>VBoxManage controlvm <vm> 3366 acpipowerbutton</command>: Sends an ACPI shutdown signal to 3367 the VM, as if the power button on a real computer had been 3368 pressed. So long as the VM is running a fairly modern guest 3369 operating system providing ACPI support, this should trigger a 3370 proper shutdown mechanism from within the VM. 3371 </para> 3372 </listitem> 3373 3374 <listitem> 3375 <para> 3376 <command>VBoxManage controlvm <vm> keyboardputscancode 3377 <hex> [<hex>...]</command>: Sends commands using 3115 3378 keycodes to the VM. Keycodes are documented in the public 3116 domain , e.g.3379 domain. For example: 3117 3380 http://www.win.tue.nl/~aeb/linux/kbd/scancodes-1.html. 3118 3381 </para> … … 3121 3384 <listitem> 3122 3385 <para> 3123 <computeroutput>VBoxManage controlvm "VM name" teleport 3124 --hostname <name> --port <port> [--passwordfile 3125 <file> | --password <password>]</computeroutput> 3126 makes the machine the source of a teleporting operation and 3127 initiates a teleport to the given target. See 3128 <xref linkend="teleporting" /> for an introduction. If the 3129 optional password is specified, it must match the password 3130 that was given to the 3131 <computeroutput>modifyvm</computeroutput> command for the 3132 target machine. See 3386 <command>VBoxManage controlvm "VM name" teleport --hostname 3387 <name> --port <port> [--passwordfile <file> 3388 | --password <password>]</command>: Makes the machine 3389 the source of a teleporting operation and initiates a teleport 3390 to the given target. See <xref linkend="teleporting" />. If 3391 the optional password is specified, it must match the password 3392 that was given to the <command>modifyvm</command> command for 3393 the target machine. See 3133 3394 <xref linkend="vboxmanage-modifyvm-teleport" />. 3134 3395 </para> … … 3138 3399 3139 3400 <para> 3140 A fewextra options are available with3141 <com puteroutput>controlvm</computeroutput> that do not directly3142 affect the VM'srunning state:3401 The following extra options are available with 3402 <command>controlvm</command> that do not directly affect the VM's 3403 running state: 3143 3404 </para> 3144 3405 … … 3147 3408 <listitem> 3148 3409 <para> 3149 The <computeroutput>setlinkstate<1-N></computeroutput>3150 operation connects or disconnects virtual network cables from3151 theirnetwork interfaces.3410 <computeroutput>setlinkstate<1-N></computeroutput>: 3411 Connects or disconnects virtual network cables from their 3412 network interfaces. 3152 3413 </para> 3153 3414 </listitem> … … 3157 3418 <computeroutput>nic<1-N> 3158 3419 null|nat|bridged|intnet|hostonly|generic|natnetwork[<devicename>]</computeroutput>: 3159 specifies the type of networking that should be made available3160 on the specified VM virtual network card. They can be: not3161 connected to the host (<computeroutput>null</computeroutput>),3162 use network address translation3163 (<computeroutput>nat</computeroutput>), bridged networking3164 (<computeroutput>bridged</computeroutput>) or communicate with3165 other virtual machines using internal networking3166 (<computeroutput>intnet</computeroutput>) or host-only3167 networking (<computeroutput>hostonly</computeroutput>) or3168 natnetwork networking3169 (<computeroutput>natnetwork</computeroutput>) or access to3170 rarely used sub-modes3420 Specifies the type of networking that should be made available 3421 on the specified VM virtual network card. They available types 3422 are: not connected to the host 3423 (<computeroutput>null</computeroutput>), use network address 3424 translation (<computeroutput>nat</computeroutput>), bridged 3425 networking (<computeroutput>bridged</computeroutput>), 3426 communicate with other virtual machines using internal 3427 networking (<computeroutput>intnet</computeroutput>), 3428 host-only networking 3429 (<computeroutput>hostonly</computeroutput>), natnetwork 3430 networking (<computeroutput>natnetwork</computeroutput>), or 3431 access to rarely used submodes 3171 3432 (<computeroutput>generic</computeroutput>). These options 3172 3433 correspond to the modes which are described in detail in … … 3178 3439 <listitem> 3179 3440 <para> 3180 With the "nictrace" options, you can optionally trace network3181 traffic by dumping it to a file, for debugging purposes.3182 </para>3183 3184 <para> 3185 With <computeroutput>nictrace<1-N>3186 on|off</computeroutput>, you can enable network tracing for a3187 particular virtual network card.3441 With the <computeroutput>nictrace</computeroutput> options, 3442 you can optionally trace network traffic by dumping it to a 3443 file, for debugging purposes. 3444 </para> 3445 3446 <para> 3447 <computeroutput>nictrace<1-N> on|off</computeroutput>: 3448 Enables network tracing for a particular virtual network card. 3188 3449 </para> 3189 3450 … … 3199 3460 <para> 3200 3461 <computeroutput>nicpromisc<1-N> 3201 deny|allow-vms|allow-all</computeroutput>: This specifies how3202 thepromiscious mode is handled for the specified VM virtual3462 deny|allow-vms|allow-all</computeroutput>: Specifies how the 3463 promiscious mode is handled for the specified VM virtual 3203 3464 network card. This setting is only relevant for bridged 3204 networking. <computeroutput>deny</computeroutput> (default 3205 setting) hides any traffic not intended for this VM. 3465 networking. The default setting of 3466 <computeroutput>deny</computeroutput> hides any traffic not 3467 intended for this VM. 3206 3468 <computeroutput>allow-vms</computeroutput> hides all host 3207 traffic from this VM but allows the VM to see traffic from/to3208 other VMs. <computeroutput>allow-all</computeroutput> removes3209 this restriction completely.3469 traffic from this VM but enables the VM to see traffic to and 3470 from other VMs. <computeroutput>allow-all</computeroutput> 3471 removes this restriction completely. 3210 3472 </para> 3211 3473 </listitem> … … 3215 3477 <computeroutput>nicproperty<1-N> 3216 3478 <paramname>="paramvalue"</computeroutput>: This option, 3217 in combination with "nicgenericdrv" enables you to pass 3218 parameters to rarely-used network backends. 3479 in combination with <computeroutput>nicgenericdrv 3480 </computeroutput>enables you to pass parameters to rarely-used 3481 network backends. 3219 3482 </para> 3220 3483 3221 3484 <para> 3222 3485 Those parameters are backend engine-specific, and are 3223 different between UDP Tunnel and the VDE backend drivers. For3224 example, please see<xref linkend="network_udp_tunnel" />.3486 different between UDP Tunnel and the VDE backend drivers. See 3487 <xref linkend="network_udp_tunnel" />. 3225 3488 </para> 3226 3489 </listitem> … … 3230 3493 <computeroutput>natpf<1-N> 3231 3494 [<name>],tcp|udp,[<hostip>],<hostport>,[<guestip>], 3232 <guestport></computeroutput>: This option specifies a3233 NATport-forwarding rule. See <xref linkend="natforward"/>.3495 <guestport></computeroutput>: Specifies a NAT 3496 port-forwarding rule. See <xref linkend="natforward"/>. 3234 3497 </para> 3235 3498 </listitem> … … 3238 3501 <para> 3239 3502 <computeroutput>natpf<1-N> delete 3240 <name></computeroutput>: This option deletes a NAT3241 port-forwardingrule. See <xref linkend="natforward"/>.3503 <name></computeroutput>: Deletes a NAT port-forwarding 3504 rule. See <xref linkend="natforward"/>. 3242 3505 </para> 3243 3506 </listitem> … … 3246 3509 <para> 3247 3510 The <computeroutput>guestmemoryballoon<balloon size in 3248 MB></computeroutput> operation changes the size of the3249 guest memory balloon, that is, memory allocated by the3250 VirtualBox Guest Additions from the guest operating system and3251 returned to the hypervisor for re-use by other virtual3252 m achines. This must be specified in megabytes. See3511 MB></computeroutput>: Changes the size of the guest memory 3512 balloon. This is the memory allocated by the &product-name; 3513 Guest Additions from the guest operating system and returned 3514 to the hypervisor for reuse by other virtual machines. This 3515 must be specified in megabytes. See 3253 3516 <xref linkend="guestadd-balloon" />. 3254 3517 </para> … … 3263 3526 <para> 3264 3527 and <computeroutput>usbdetach <uuid|address> 3265 [--capturefile <filename>]</computeroutput> makehost3266 USB devices visible /invisible to the virtual machine on the3528 [--capturefile <filename>]</computeroutput>: Makes host 3529 USB devices visible or invisible to the virtual machine on the 3267 3530 fly, without the need for creating filters first. The USB 3268 3531 devices can be specified by UUID (unique identifier) or by 3269 address on the host system. Use the --capturefile option to 3532 address on the host system. Use the 3533 <computeroutput>--capturefile</computeroutput> option to 3270 3534 specify the absolute path of a file for writing activity 3271 3535 logging data. … … 3273 3537 3274 3538 <para> 3275 You can use <computeroutput>VBoxManage list 3276 usbhost</computeroutput> to locate this information. 3277 </para> 3278 </listitem> 3279 3280 <listitem> 3281 <para> 3282 <computeroutput>audioin on</computeroutput>: With this 3283 setting, you can select whether capturing audio from the host 3284 is enabled or disabled. 3285 </para> 3286 </listitem> 3287 3288 <listitem> 3289 <para> 3290 <computeroutput>audioout on</computeroutput>: With this 3291 setting, you can select whether audio playback from the guest 3292 is enabled or disabled. 3539 You can use <command>VBoxManage list usbhost</command> to 3540 locate this information. 3541 </para> 3542 </listitem> 3543 3544 <listitem> 3545 <para> 3546 <computeroutput>audioin on</computeroutput>: Selects whether 3547 capturing audio from the host is enabled or disabled. 3548 </para> 3549 </listitem> 3550 3551 <listitem> 3552 <para> 3553 <computeroutput>audioout on</computeroutput>: Selects whether 3554 audio playback from the guest is enabled or disabled. 3293 3555 </para> 3294 3556 </listitem> … … 3298 3560 <computeroutput>clipboard 3299 3561 disabled|hosttoguest|guesttohost|bidirectional</computeroutput>: 3300 With this setting, you can select if and how the guest or host3301 operating system's clipboard should be shared with the host or3302 guest. See <xref linkend="generalsettings" />. This requires3303 that theGuest Additions be installed in the virtual machine.3562 Selects how the guest or host operating system's clipboard 3563 should be shared with the host or guest. See 3564 <xref linkend="generalsettings" />. This requires that the 3565 Guest Additions be installed in the virtual machine. 3304 3566 </para> 3305 3567 </listitem> … … 3309 3571 <computeroutput>draganddrop 3310 3572 disabled|hosttoguest|guesttohost|bidirectional</computeroutput>: 3311 With this setting, you can select the current drag and drop3312 mode being used between thehost and the virtual machine. See3573 Selects the current drag and drop mode being used between the 3574 host and the virtual machine. See 3313 3575 <xref linkend="guestadd-dnd" />. This requires that the Guest 3314 3576 Additions be installed in the virtual machine. … … 3318 3580 <listitem> 3319 3581 <para> 3320 <computeroutput>vrde on|off</computeroutput> lets you enable3321 or disablethe VRDE server, if it is installed.3582 <computeroutput>vrde on|off</computeroutput>: Enables and 3583 disables the VRDE server, if it is installed. 3322 3584 </para> 3323 3585 </listitem> … … 3326 3588 <para> 3327 3589 <computeroutput>vrdeport 3328 default|<ports></computeroutput> changes the port or a 3329 range of ports that the VRDE server can bind to; "default" or 3330 "0" means port 3389, the standard port for RDP. See the 3331 description for the 3590 default|<ports></computeroutput>: Changes the port or a 3591 range of ports that the VRDE server can bind to. 3592 <computeroutput>default</computeroutput> or 3593 <computeroutput>0</computeroutput> means port 3389, the 3594 standard port for RDP. See the description for the 3332 3595 <computeroutput>--vrdeport</computeroutput> option in 3333 3596 <xref … … 3339 3602 <para> 3340 3603 <computeroutput>vrdeproperty 3341 "TCP/Ports|Address=<value>"</computeroutput> sets the3342 port number (s) and IP address on the VM to which the VRDE3343 servercan bind.3604 "TCP/Ports|Address=<value>"</computeroutput>: Sets the 3605 port numbers and IP address on the VM to which the VRDE server 3606 can bind. 3344 3607 </para> 3345 3608 … … 3349 3612 <para> 3350 3613 For TCP/Ports, <value> should be a port or a range 3351 of ports to which the VRDE server can bind; "default" or 3352 "0" means port 3389, the standard port for RDP. See the 3353 description for the 3614 of ports to which the VRDE server can bind. 3615 <computeroutput>default</computeroutput> or 3616 <computeroutput>0</computeroutput> means port 3389, the 3617 standard port for RDP. See the description for the 3354 3618 <computeroutput>--vrdeport</computeroutput> option in 3355 3619 <xref … … 3360 3624 <listitem> 3361 3625 <para> 3362 For TCP/Address, <value> should be the IP address of3363 the host network interface that the VRDE server will bind3364 to. If specified, the server will accept connections only3365 on the specified host network interface. See the3366 description for the3367 <computeroutput>--vrdeaddress</computeroutput> optionin3626 For TCP/Address, <value>: The IP address of the host 3627 network interface that the VRDE server will bind to. If 3628 specified, the server will accept connections only on the 3629 specified host network interface. See the description for 3630 the <computeroutput>--vrdeaddress</computeroutput> option 3631 in 3368 3632 <xref 3369 3633 linkend="vboxmanage-modifyvm-vrde" />. … … 3377 3641 <para> 3378 3642 <computeroutput>vrdeproperty 3379 "VideoChannel/Enabled|Quality|DownscaleProtection=<value>"</computeroutput> 3380 sets the VRDP video redirection properties.3643 "VideoChannel/Enabled|Quality|DownscaleProtection=<value>"</computeroutput>: 3644 Sets the VRDP video redirection properties. 3381 3645 </para> 3382 3646 … … 3396 3660 between 10 and 100% inclusive, representing a JPEG 3397 3661 compression level on the VRDE server video channel. Lower 3398 values mean lower quality but higher compression. For3399 details, see<xref linkend="vrde-videochannel" />.3662 values mean lower quality but higher compression. See 3663 <xref linkend="vrde-videochannel" />. 3400 3664 </para> 3401 3665 </listitem> … … 3407 3671 feature. When enabled, if a video's size equals the shadow 3408 3672 buffer size, then it is regarded as a full screen video, 3409 and is displayed ; but if its size is between fullscreen3410 and the downscale threshold - it is NOT displayed, as it3411 could be an application window, which would be unreadable3412 whendownscaled. When the downscale protection feature is3673 and is displayed. If its size is between fullscreen and 3674 the downscale threshold it is not displayed, as it could 3675 be an application window, which would be unreadable when 3676 downscaled. When the downscale protection feature is 3413 3677 disabled, an attempt is always made to display videos. 3414 3678 </para> … … 3421 3685 <para> 3422 3686 <computeroutput>vrdeproperty 3423 "Client/DisableDisplay|DisableInput|DisableAudio|DisableUSB=1"</computeroutput> 3424 </para> 3425 3426 <para> 3427 disables one of the VRDE server features: Display, Input, 3428 Audio or USB respectively. To reenable a feature, use 3687 "Client/DisableDisplay|DisableInput|DisableAudio|DisableUSB=1"</computeroutput>: 3688 Disables one of the VRDE server features: Display, Input, 3689 Audio, or USB. To reenable a feature, use 3429 3690 "Client/DisableDisplay=" for example. See 3430 3691 <xref linkend="vrde-customization" />. … … 3435 3696 <para> 3436 3697 <computeroutput>vrdeproperty 3437 "Client/DisableClipboard|DisableUpstreamAudio=1"</computeroutput> 3438 </para> 3439 3440 <para> 3441 disables one of the VRDE server features: Clipboard or 3442 UpstreamAudio respectively. To reenable a feature, use 3698 "Client/DisableClipboard|DisableUpstreamAudio=1"</computeroutput>. 3699 Disables one of the VRDE server features: Clipboard or 3700 UpstreamAudio. To reenable a feature, use 3443 3701 "Client/DisableClipboard=" for example. See 3444 3702 <xref linkend="vrde-customization" />. … … 3449 3707 <para> 3450 3708 <computeroutput>vrdeproperty 3451 "Client/DisableRDPDR=1"</computeroutput> 3452 </para> 3453 3454 <para> 3455 disables the VRDE server feature: RDP device redirection for 3456 smart cards. To reenable this feature, use 3457 "Client/DisableRDPR=". 3709 "Client/DisableRDPDR=1"</computeroutput>: Disables the VRDE 3710 server feature: RDP device redirection for smart cards. To 3711 reenable this feature, use "Client/DisableRDPR=". 3458 3712 </para> 3459 3713 </listitem> … … 3462 3716 <para> 3463 3717 <computeroutput>vrdeproperty 3464 "H3DRedirect/Enabled=1"</computeroutput> 3465 </para> 3466 3467 <para> 3468 enables the VRDE server feature: 3D redirection. To disable 3469 this feature, use "H3DRedirect/Enabled=". 3718 "H3DRedirect/Enabled=1"</computeroutput>: Enables the VRDE 3719 server feature: 3D redirection. To disable this feature, use 3720 "H3DRedirect/Enabled=". 3470 3721 </para> 3471 3722 </listitem> … … 3474 3725 <para> 3475 3726 <computeroutput>vrdeproperty 3476 "Security/Method|ServerCertificate|ServerPrivateKey|CACertificate=<value>"</computeroutput> 3477 sets the desired security method/Path of server certificate,3478 path of server private key, path of CA certificate, used for a3479 c onnection.3727 "Security/Method|ServerCertificate|ServerPrivateKey|CACertificate=<value>"</computeroutput>: 3728 Sets the desired security method, path of the server 3729 certificate, path of the server private key, and path of CA 3730 certificate, used for a connection. 3480 3731 </para> 3481 3732 … … 3485 3736 <para> 3486 3737 <computeroutput>vrdeproperty 3487 "Security/Method=<value>"</computeroutput> sets the3738 "Security/Method=<value>"</computeroutput>: Sets the 3488 3739 desired security method, which is used for a connection. 3489 Valid values are :3740 Valid values are as follows: 3490 3741 </para> 3491 3742 … … 3494 3745 <listitem> 3495 3746 <para> 3496 <computeroutput>Negotiate</computeroutput> - both3747 <computeroutput>Negotiate</computeroutput>: Both 3497 3748 Enhanced (TLS) and Standard RDP Security connections 3498 3749 are allowed. The security method is negotiated with … … 3503 3754 <listitem> 3504 3755 <para> 3505 <computeroutput>RDP</computeroutput> - only Standard3756 <computeroutput>RDP</computeroutput>: Only Standard 3506 3757 RDP Security is accepted. 3507 3758 </para> … … 3510 3761 <listitem> 3511 3762 <para> 3512 <computeroutput>TLS</computeroutput> - only Enhanced3763 <computeroutput>TLS</computeroutput>: Only Enhanced 3513 3764 RDP Security is accepted. The client must support TLS. 3514 3765 </para> … … 3555 3806 <para> 3556 3807 <computeroutput>vrdeproperty 3557 "Audio/RateCorrectionMode|LogPath=<value>"</computeroutput> 3558 sets the Audio connection mode, or Path of the audio logfile.3808 "Audio/RateCorrectionMode|LogPath=<value>"</computeroutput>: 3809 Sets the audio connection mode, or path of the audio logfile. 3559 3810 </para> 3560 3811 … … 3573 3824 <listitem> 3574 3825 <para> 3575 <computeroutput>VRDP_AUDIO_MODE_VOID</computeroutput> 3576 - no mode specified, use to unset any Audio mode3577 alreadyset.3826 <computeroutput>VRDP_AUDIO_MODE_VOID</computeroutput>: 3827 No mode specified, use to unset any Audio mode already 3828 set. 3578 3829 </para> 3579 3830 </listitem> … … 3581 3832 <listitem> 3582 3833 <para> 3583 <computeroutput>VRDP_AUDIO_MODE_RC</computeroutput> -3584 rate correction mode.3834 <computeroutput>VRDP_AUDIO_MODE_RC</computeroutput>: 3835 Rate correction mode. 3585 3836 </para> 3586 3837 </listitem> … … 3588 3839 <listitem> 3589 3840 <para> 3590 <computeroutput>VRDP_AUDIO_MODE_LPF</computeroutput> -3591 low pass filter mode.3841 <computeroutput>VRDP_AUDIO_MODE_LPF</computeroutput>: 3842 Low pass filter mode. 3592 3843 </para> 3593 3844 </listitem> … … 3595 3846 <listitem> 3596 3847 <para> 3597 <computeroutput>VRDP_AUDIO_MODE_CS</computeroutput> -3598 client sync mode to prevent under/overflow of the3599 client queue.3848 <computeroutput>VRDP_AUDIO_MODE_CS</computeroutput>: 3849 Client sync mode to prevent underflow or overflow of 3850 the client queue. 3600 3851 </para> 3601 3852 </listitem> … … 3608 3859 <computeroutput>vrdeproperty 3609 3860 "Audio/LogPath=<value>"</computeroutput> where 3610 <value> is the absolute path of the Audio log file.3861 <value> is the absolute path of the audio log file. 3611 3862 </para> 3612 3863 </listitem> … … 3620 3871 <percent></computeroutput>: Sets the image quality for 3621 3872 video redirection. See 3622 <xref 3873 <xref 3623 3874 linkend="vrde-videochannel" />. 3624 3875 </para> … … 3627 3878 <listitem> 3628 3879 <para> 3629 <computeroutput>setvideomodehint</computeroutput> requests3880 <computeroutput>setvideomodehint</computeroutput>: Requests 3630 3881 that the guest system change to a particular video mode. This 3631 3882 requires that the Guest Additions be installed, and will not … … 3636 3887 <listitem> 3637 3888 <para> 3638 <computeroutput>screenshotpng</computeroutput> takes a3889 <computeroutput>screenshotpng</computeroutput>: Takes a 3639 3890 screenshot of the guest display and saves it in PNG format. 3640 3891 </para> … … 3643 3894 <listitem> 3644 3895 <para> 3645 <computeroutput>record on|off</computeroutput> enables or 3646 disables recording a VM session into a WebM/VP8 file. 3647 </para> 3648 </listitem> 3649 3650 <listitem> 3651 <para> 3652 <computeroutput>recordscreens all|<screen ID> 3653 [<screen ID> ...]]</computeroutput> allows to specify 3654 which screens of the VM are being recorded. This setting 3655 cannot be changed while recording is enabled. Each 3656 screen is recorded into a separate file. 3657 </para> 3658 </listitem> 3659 3660 <listitem> 3661 <para> 3662 <computeroutput>recordfile <file></computeroutput> 3663 sets the filename VirtualBox uses to save the recorded 3664 content. This setting cannot be changed while recording 3896 <computeroutput>recording on|off</computeroutput> enables or 3897 disables the recording of a VM session into a WebM/VP8 file. 3898 When this option value is <computeroutput>on</computeroutput>, 3899 recording begins when the VM session starts. 3900 </para> 3901 </listitem> 3902 3903 <listitem> 3904 <para> 3905 <computeroutput>recordingscreens 3906 all|<replaceable>screen-ID</replaceable> 3907 [<replaceable>screen-ID</replaceable> ...]</computeroutput> 3908 enables you to specify which VM screens to record. The 3909 recording for each screen that you specify is saved to its own 3910 file. You cannot modify this setting while recording is 3911 enabled. 3912 </para> 3913 </listitem> 3914 3915 <listitem> 3916 <para> 3917 <computeroutput>recordingfile 3918 <replaceable>filename</replaceable></computeroutput> specifies 3919 the file in which to save the recording. You cannot modify 3920 this setting while recording is enabled. 3921 </para> 3922 </listitem> 3923 3924 <listitem> 3925 <para> 3926 <computeroutput>recordingvideores 3927 <replaceable>width</replaceable>x<replaceable>height</replaceable></computeroutput> 3928 specifies the resolution of the recorded video in pixels. You 3929 cannot modify this setting while recording is enabled. 3930 </para> 3931 </listitem> 3932 3933 <listitem> 3934 <!-- @todo r=andy Clarify rate. --> 3935 3936 <para> 3937 <computeroutput>recordingvideorate 3938 <replaceable>bit-rate</replaceable></computeroutput> specifies 3939 the bit rate of the video in kilobits per second. Increasing 3940 this value improves the appearance of the video at the cost of 3941 an increased file size. You cannot modify this setting while 3942 recording is enabled. 3943 </para> 3944 </listitem> 3945 3946 <listitem> 3947 <para> 3948 <computeroutput>recordingvideofps 3949 <replaceable>fps</replaceable></computeroutput> specifies the 3950 maximum number of video frames per second (FPS) to record. 3951 Frames that have a higher frequency are skipped. Increasing 3952 this value reduces the number of skipped frames and increases 3953 the file size. You cannot modify this setting while recording 3665 3954 is enabled. 3666 3955 </para> … … 3668 3957 3669 3958 <listitem> 3670 <para> 3671 <computeroutput>recordvideores <width> 3672 <height></computeroutput> sets the resolution (in 3673 pixels) of the recorded video. This setting cannot be changed 3674 while recording is enabled. 3675 </para> 3676 </listitem> 3677 3678 <listitem> 3679 <para> 3680 <computeroutput>recordvideorate <rate></computeroutput> 3681 sets the bitrate in kilobits (kb) per second. Increasing this 3682 value makes the video look better for the cost of an increased 3683 file size. This setting cannot be changed while recording is enabled. 3684 </para> 3685 </listitem> 3686 3687 <listitem> 3688 <para> 3689 <computeroutput>recordvideofps <fps></computeroutput> sets 3690 the maximum number of frames per second (FPS) to be recorded. 3691 Frames with a higher frequency will be skipped. Reducing this 3692 value increases the number of skipped frames and reduces the 3693 file size. This setting cannot be changed while recording is enabled. 3694 </para> 3695 </listitem> 3696 3697 <listitem> 3698 <para> 3699 <computeroutput>recordmaxtime <ms></computeroutput> 3700 sets the maximum time in milliseconds the recording will 3701 be enabled since activation. The recording stops when the 3702 defined time interval has elapsed. If this value is zero the 3703 recording is not limited by time. This setting cannot be 3704 changed while recording is enabled. 3705 </para> 3706 </listitem> 3707 3708 <listitem> 3709 <para> 3710 <computeroutput>recordmaxsize <MB></computeroutput> 3711 limits the maximum size of the recorded file, in MB. The 3712 recording stops when the file size has reached the specified 3713 size. If this value is zero the recording will not be limited 3714 by file size. This setting cannot be changed while recording 3715 is enabled. 3716 </para> 3717 </listitem> 3718 3719 <listitem> 3720 <para> 3721 <computeroutput>recordopts 3722 <key=value>[,<key=value> ...]</computeroutput> can 3723 be used to specify additional recording options. These 3724 options only are for advanced users and must be specified in a 3725 comma-separated key=value format, e.g. 3726 <computeroutput>foo=bar,a=b</computeroutput>. This setting 3727 cannot be changed while recording is enabled. 3728 </para> 3729 </listitem> 3730 3731 <listitem> 3732 <para> 3733 The <computeroutput>setcredentials</computeroutput> operation 3734 is used for remote logons in Windows guests. See 3959 <!-- @todo r=andy Clarify time format. --> 3960 3961 <para> 3962 <computeroutput>recordingmaxtime 3963 <replaceable>seconds</replaceable></computeroutput> specifies 3964 the maximum amount time to record in seconds. The recording 3965 stops after the specified number of seconds elapses. If this 3966 value is zero, the recording continues until you stop the 3967 recording. 3968 </para> 3969 </listitem> 3970 3971 <listitem> 3972 <para> 3973 <computeroutput>recordingmaxsize 3974 <replaceable>MB</replaceable></computeroutput> specifies the 3975 maximum size of the recorded video file in megabytes. The 3976 recording stops when the file reaches the specified size. If 3977 this value is zero, the recording continues until you stop the 3978 recording. You cannot modify this setting while recording is 3979 enabled. 3980 </para> 3981 </listitem> 3982 3983 <listitem> 3984 <para> 3985 <computeroutput>recordingopts 3986 <replaceable>keyword</replaceable>=<replaceable>value</replaceable>[,<replaceable>keyword</replaceable>=<replaceable>value</replaceable> 3987 ...]</computeroutput> specifies additional recording options 3988 in a comma-separated keyword-value format. For example, 3989 <computeroutput>foo=bar,a=b</computeroutput>. You cannot 3990 modify this setting while recording is enabled. 3991 </para> 3992 3993 <para> 3994 Only use this option only if you are an advanced user. For 3995 information about keywords, see <emphasis>Oracle VM VirtualBox 3996 Programming Guide and Reference</emphasis>. 3997 </para> 3998 </listitem> 3999 4000 <listitem> 4001 <para> 4002 <computeroutput>setcredentials</computeroutput>: Used for 4003 remote logins on Windows guests. See 3735 4004 <xref linkend="autologon" />. 3736 4005 </para> … … 3740 4009 <para> 3741 4010 <computeroutput>teleport --host <name> --port 3742 <port></computeroutput> can be used to configure a VM as3743 a target for teleporting. <name> specifies the virtual3744 machine name. <port> specifies the port on the virtual3745 machine which should listen for teleporting requests from3746 other virtual machines. It can be any free TCP/IP port number,3747 such as 6000.See <xref linkend="teleporting" />.4011 <port></computeroutput>: Configures a VM as a target for 4012 teleporting. <name> specifies the virtual machine name. 4013 <port> specifies the port on the virtual machine which 4014 should listen for teleporting requests from other virtual 4015 machines. It can be any free TCP/IP port number, such as 6000. 4016 See <xref linkend="teleporting" />. 3748 4017 </para> 3749 4018 … … 3753 4022 <para> 3754 4023 <computeroutput>--maxdowntime 3755 <msec></computeroutput>: specifies the maximum3756 downtime (milliseconds)for the teleporting target VM.4024 <msec></computeroutput>: Specifies the maximum 4025 downtime, in milliseconds, for the teleporting target VM. 3757 4026 Optional. 3758 4027 </para> … … 3762 4031 <para> 3763 4032 <computeroutput>--password 3764 <password></computeroutput>: indicates that the 3765 teleporting request will only succeed if the source 3766 machine specifies the same password as the one given with 3767 this command. Optional. 4033 <password></computeroutput>: The teleporting request 4034 will only succeed if the source machine specifies the same 4035 password as the one given with this command. Optional. 3768 4036 </para> 3769 4037 </listitem> … … 3772 4040 <para> 3773 4041 <computeroutput>--passwordfile <password 3774 file></computeroutput>: indicates that the teleporting3775 request will only succeed if the source machine specifies3776 the same password as the one specified in the password3777 file withthe path specified with this command. Use4042 file></computeroutput>: The teleporting request will 4043 only succeed if the source machine specifies the same 4044 password as the one specified in the password file with 4045 the path specified with this command. Use 3778 4046 <computeroutput>stdin</computeroutput> to read the 3779 4047 password from stdin. Optional. … … 3787 4055 <para> 3788 4056 <computeroutput>plugcpu|unplugcpu <id></computeroutput>: 3789 If CPU hot-plugging is enabled, this adds a virtual CPU to the3790 virtual machines (or removes one).4057 If CPU hot-plugging is enabled, this setting adds and removes 4058 a virtual CPU to the virtual machine. 3791 4059 <computeroutput><id></computeroutput> specifies the 3792 4060 index of the virtual CPU to be added or removed and must be a 3793 number from 0 to the maximum n o. of CPUs configured. CPU 0 can3794 never be removed.4061 number from 0 to the maximum number of CPUs configured. CPU 0 4062 can never be removed. 3795 4063 </para> 3796 4064 </listitem> … … 3799 4067 <para> 3800 4068 The <computeroutput>cpuexecutioncap 3801 <1-100></computeroutput>: This operation controls how3802 much cpu time a virtual CPU can use. A value of 50 implies a3803 single virtualCPU can use up to 50% of a single host CPU.4069 <1-100></computeroutput>: Controls how much CPU time a 4070 virtual CPU can use. A value of 50 implies a single virtual 4071 CPU can use up to 50% of a single host CPU. 3804 4072 </para> 3805 4073 </listitem> … … 3808 4076 <para> 3809 4077 <computeroutput>webcam attach <path|alias> 3810 [<key=value>[;<key=value>...]]</computeroutput>: 3811 This operation attaches a webcam to a running VM. Specify the 3812 absolute path of the webcam on the host operating system, or 3813 use its alias, obtained by using the command: VBoxManage list 3814 webcams. 3815 </para> 3816 3817 <para> 3818 Note that alias '.0' means default video input device on the 3819 host operating system, '.1', '.2', etc. mean first, second, 3820 etc. video input device. The device order is host-specific. 3821 </para> 3822 3823 <para> 3824 The optional settings parameter is a ';' delimited list of 3825 name/value pairs, enabling configuration of the emulated 4078 [<keyword=value>[;<keyword=value>...]]</computeroutput>: 4079 Attaches a webcam to a running VM. Specify the absolute path 4080 of the webcam on the host operating system, or use its alias, 4081 obtained by using the command: <command>VBoxManage list 4082 webcams</command>. 4083 </para> 4084 4085 <para> 4086 Note that alias '.0' means the default video input device on 4087 the host operating system, '.1', '.2', etc. mean first, 4088 second, etc. video input device. The device order is 4089 host-specific. 4090 </para> 4091 4092 <para> 4093 The optional settings parameter is a 4094 <computeroutput>;</computeroutput> delimited list of 4095 name-value pairs, enabling configuration of the emulated 3826 4096 webcam device. 3827 4097 </para> … … 3832 4102 3833 4103 <para> 3834 MaxFramerate (default no maximum limit) - this specifies the 3835 highest rate (frames/sec) at which video frames are sent to 3836 the guest. Higher frame rates increase CPU load, so this 3837 setting can be useful when there is a need to reduce CPU load. 3838 Its default 'value' is 'no maximum limit', thus enabling the 3839 guest to use all frame rates supported by the host webcam. 3840 </para> 3841 3842 <para> 3843 MaxPayloadTransferSize (default 3060 bytes) - this specifies 3844 the maximum number of bytes the emulated webcam can send to 3845 the guest in one buffer. The default is used by some webcams. 4104 MaxFramerate: Specifies the highest rate in frames per second, 4105 at which video frames are sent to the guest. Higher frame 4106 rates increase CPU load, so this setting can be useful when 4107 there is a need to reduce CPU load. The default setting is 4108 <computeroutput>no maximum limit</computeroutput>, thus 4109 enabling the guest to use all frame rates supported by the 4110 host webcam. 4111 </para> 4112 4113 <para> 4114 MaxPayloadTransferSize: Specifies the maximum number of bytes 4115 the emulated webcam can send to the guest in one buffer. The 4116 default setting is 3060 bytes, which is used by some webcams. 3846 4117 Higher values can slightly reduce CPU load, if the guest is 3847 4118 able to use larger buffers. Note that higher … … 3854 4125 <para> 3855 4126 <computeroutput>webcam detach 3856 <path|alias></computeroutput>: This operation detachesa3857 webcam from a running VM. Specify the absolute path ofthe3858 webcam on the host, or use its alias (obtained fromwebcam3859 list below).3860 </para> 3861 3862 <para> 3863 Note the points below relating to specific Host Operating3864 Systems:3865 </para> 3866 3867 < para>3868 Windows hosts 3869 </para>3870 3871 <para>3872 When the webcam device is detached from the host, the emulated3873 webcam device is automatically detachedfrom the guest.3874 </para>3875 3876 <para> 3877 Mac OS X hosts3878 </para>3879 3880 <para>3881 OS X version 10.7 or newer is required. 3882 </para>3883 3884 <para>3885 When the webcam device is detached from the host, the emulated3886 webcam device remains attached to the guest and must be3887 manually detached using the VBoxManage controlvm "VM name"3888 webcam detach command.3889 </para> 3890 3891 <para>3892 Linux hosts3893 </para>3894 3895 <para>3896 When the webcam is detached from the host, the emulatedwebcam3897 device is automatically detached from the guest only if the3898 webcam is streaming video. If the emulated webcam is inactive,3899 it should be manually detached using the VBoxManage controlvm3900 "VM name" webcam detach command. 3901 </ para>3902 </listitem> 3903 3904 <listitem> 3905 <para> 3906 <computeroutput>webcam list</computeroutput>: This operation3907 lists webcams attached to the running VM. The output is a list3908 of absolute paths or aliases that were used for attaching the3909 webcams to the VM using the 'webcam attach' command above.4127 <path|alias></computeroutput>: Detaches a webcam from a 4128 running VM. Specify the absolute path of the webcam on the 4129 host, or use its alias obtained from the <command>webcam 4130 list</command> command. 4131 </para> 4132 4133 <para> 4134 Please note the following points, relating to specific host 4135 operating systems: 4136 </para> 4137 4138 <itemizedlist> 4139 4140 <listitem> 4141 <para> 4142 Windows hosts: When the webcam device is detached from the 4143 host, the emulated webcam device is automatically detached 4144 from the guest. 4145 </para> 4146 </listitem> 4147 4148 <listitem> 4149 <para> 4150 Mac OS X hosts: OS X version 10.7 or newer is required. 4151 </para> 4152 4153 <para> 4154 When the webcam device is detached from the host, the 4155 emulated webcam device remains attached to the guest and 4156 must be manually detached using the <command>VBoxManage 4157 controlvm webcam detach</command> command. 4158 </para> 4159 </listitem> 4160 4161 <listitem> 4162 <para> 4163 Linux hosts: When the webcam is detached from the host, 4164 the emulated webcam device is automatically detached from 4165 the guest only if the webcam is streaming video. If the 4166 emulated webcam is inactive, it should be manually 4167 detached using the <command>VBoxManage controlvm webcam 4168 detach</command> command. 4169 </para> 4170 </listitem> 4171 4172 </itemizedlist> 4173 </listitem> 4174 4175 <listitem> 4176 <para> 4177 <computeroutput>webcam list</computeroutput>: Lists webcams 4178 attached to the running VM. The output is a list of absolute 4179 paths or aliases that were used for attaching the webcams to 4180 the VM using the <command>webcam attach</command> command. 3910 4181 </para> 3911 4182 </listitem> … … 3915 4186 <computeroutput>addencpassword <id> <password 3916 4187 file>|- [--removeonsuspend 3917 <yes|no>]</computeroutput>: This operation supplies an 3918 encrypted VM specified by <id> with the encryption 3919 password to enable a headless start. Either specify the 3920 absolute path of a password file on the host file system: 3921 <password file>, or use a '-' to instruct VBoxManage to 3922 prompt the user for the encryption password. 4188 <yes|no>]</computeroutput>: Supplies an encrypted VM 4189 specified by <id> with the encryption password to enable 4190 a headless start. Either specify the absolute path of a 4191 password file on the host file system: <password file>, 4192 or use <option>-</option> to instruct 4193 <command>VBoxManage</command> to prompt the user for the 4194 encryption password. 3923 4195 </para> 3924 4196 3925 4197 <para> 3926 4198 <computeroutput>--removeonsuspend 3927 <yes|no></computeroutput> specifies whether to3928 remove/keep the password from/in VM memory when the VM is4199 <yes|no></computeroutput>: Specifies whether to remove 4200 the passsword or keep the password in VM memory when the VM is 3929 4201 suspended. If the VM has been suspended and the password has 3930 4202 been removed, the user needs to resupply the password before … … 3934 4206 </para> 3935 4207 3936 <para> 3937 Note: On VirtualBox versions 5.0 and later, data stored on 3938 hard disk images can be transparently encrypted for the guest. 3939 VirtualBox uses the AES algorithm in XTS mode and supports 128 3940 or 256 bit data encryption keys (DEK). The DEK is stored 3941 encrypted in the medium properties, and is decrypted during VM 3942 startup by supplying the encryption password. 3943 </para> 3944 3945 <para> 3946 The "VBoxManage encryptmedium" operation is used to create a 3947 DEK encrypted medium. See 4208 <note> 4209 <para> 4210 On &product-name; versions 5.0 and later, data stored on 4211 hard disk images can be transparently encrypted for the 4212 guest. &product-name; uses the AES algorithm in XTS mode and 4213 supports 128 or 256 bit data encryption keys (DEK). The DEK 4214 is stored encrypted in the medium properties, and is 4215 decrypted during VM startup by supplying the encryption 4216 password. 4217 </para> 4218 </note> 4219 4220 <para> 4221 The <command>VBoxManage encryptmedium</command> command is 4222 used to create a DEK encrypted medium. See 3948 4223 <xref linkend="diskencryption-encryption" />. When starting an 3949 encrypted VM from a VirtualBox GUI app, the user will be4224 encrypted VM from the &product-name; GUI, the user will be 3950 4225 prompted for the encryption password. 3951 4226 </para> 3952 4227 3953 4228 <para> 3954 For a headless encrypted VM start, use :4229 For a headless encrypted VM start, use the folowing command: 3955 4230 </para> 3956 4231 … … 3960 4235 3961 4236 <para> 3962 followed by:4237 Then supply the required encryption password as follows: 3963 4238 </para> 3964 4239 … … 3967 4242 </screen> 3968 4243 3969 <para> 3970 to supply the encryption password required. 3971 </para> 4244 <para></para> 3972 4245 </listitem> 3973 4246 … … 3975 4248 <para> 3976 4249 <computeroutput>removeencpassword <id></computeroutput>: 3977 This operation removes encryption password authorization for 3978 password <id> for all encrypted media attached to the 3979 VM. 3980 </para> 3981 </listitem> 3982 3983 <listitem> 3984 <para> 3985 <computeroutput>removeallencpasswords</computeroutput>: This 3986 operation removes encryption password authorization for all 3987 passwords for all encrypted media attached to the VM. 4250 Removes encryption password authorization for password 4251 <id> for all encrypted media attached to the VM. 4252 </para> 4253 </listitem> 4254 4255 <listitem> 4256 <para> 4257 <computeroutput>removeallencpasswords</computeroutput>: 4258 Removes encryption password authorization for all passwords 4259 for all encrypted media attached to the VM. 4260 </para> 4261 </listitem> 4262 4263 <listitem> 4264 <para> 4265 <computeroutput>changeuartmode <1-N></computeroutput>: 4266 Changes the connection mode for a given virtual serial port. 3988 4267 </para> 3989 4268 </listitem> … … 3999 4278 <para> 4000 4279 This command discards the saved state of a virtual machine which 4001 is not currently running , which will cause its operating system to4002 restart next time you start it. This is the equivalent of pulling4003 o ut the power cable on a physical machine, and should be avoided4004 if possible.4280 is not currently running. This will cause the VM's operating 4281 system to restart next time you start it. This is the equivalent 4282 of pulling out the power cable on a physical machine, and should 4283 be avoided if possible. 4005 4284 </para> 4006 4285 … … 4012 4291 4013 4292 <para> 4014 If you have a saved state file4293 If you have a Saved state file 4015 4294 (<computeroutput>.sav</computeroutput>) that is separate from the 4016 VM configuration, you can use this command to "adopt" the file. 4017 This will change the VM to saved state and when you start it, 4018 VirtualBox will attempt to restore it from the saved state file 4019 you indicated. This command should only be used in special setups. 4295 VM configuration, you can use this command to 4296 <emphasis>adopt</emphasis> the file. This will change the VM to 4297 saved state and when you start it, &product-name; will attempt to 4298 restore it from the saved state file you indicated. This command 4299 should only be used in special setups. 4020 4300 </para> 4021 4301 … … 4032 4312 optionally a virtual machine saved state file if the snapshot was 4033 4313 taken while the machine was running. After a snapshot has been 4034 taken, VirtualBox creates differencing hard disk for each normal4035 hard disk associated with the machine so that when a snapshot is4036 restored, the contents of the virtual machine's virtual hard disks4037 can be quickly reset by simply dropping the pre-existing4038 differencing files.4314 taken, &product-name; creates a differencing hard disk for each 4315 normal hard disk associated with the machine so that when a 4316 snapshot is restored, the contents of the virtual machine's 4317 virtual hard disks can be quickly reset by simply dropping the 4318 preexisting differencing files. 4039 4319 </para> 4040 4320 … … 4052 4332 4053 4333 <para> 4054 The <com puteroutput>take</computeroutput> operation takes a4055 snapshot of the current state of the virtual machine. You must4056 supply a name for the snapshot and can optionally supply a4057 description. The new snapshot is inserted into the snapshots tree4058 as a child of the current snapshot and then becomes the new4059 current snapshot. The4060 <computeroutput>--description</computeroutput> parameter allows to4061 describe the snapshot. If <computeroutput>--live</computeroutput>4062 is specified, the VM will not be stopped during the snapshot4063 creation (live snapshotting).4064 </para> 4065 4066 <para> 4067 The <com puteroutput>delete</computeroutput> operation deletes a4068 s napshot (specified by name or by UUID). This can take a while to4069 finish since the differencing images associated with the snapshot4070 mightneed to be merged with their child differencing images.4071 </para> 4072 4073 <para> 4074 The <com puteroutput>restore</computeroutput> operation will4075 restore the given snapshot (specified by name or by UUID) by4076 resetting the virtual machine's settings and current state to that4077 of the snapshot. The previous current state of the machine will be4078 lost. After this, the given snapshot becomes the new "current"4079 s napshot so that subsequent snapshots are inserted under the4080 snapshot from whichwas restored.4081 </para> 4082 4083 <para> 4084 The <com puteroutput>restorecurrent</computeroutput> operation is a4085 shortcut to restore the current snapshot (i.e. the snapshot from4086 which the current state is derived). This subcommand is equivalent4087 t o using the "restore" subcommand with the name or UUID of the4088 current snapshot, except that it avoids the extra step of4334 The <command>take</command> operation takes a snapshot of the 4335 current state of the virtual machine. You must supply a name for 4336 the snapshot and can optionally supply a description. The new 4337 snapshot is inserted into the snapshots tree as a child of the 4338 current snapshot and then becomes the new current snapshot. The 4339 <computeroutput>--description</computeroutput> parameter enables 4340 you to describe the snapshot. If 4341 <computeroutput>--live</computeroutput> is specified, the VM will 4342 not be stopped during the snapshot creation. This is called live 4343 snapshotting. 4344 </para> 4345 4346 <para> 4347 The <command>delete</command> operation deletes a snapshot, 4348 specified by name or by UUID. This can take a while to finish 4349 since the differencing images associated with the snapshot might 4350 need to be merged with their child differencing images. 4351 </para> 4352 4353 <para> 4354 The <command>restore</command> operation will restore the given 4355 snapshot, specified by name or by UUID, by resetting the virtual 4356 machine's settings and current state to that of the snapshot. The 4357 previous current state of the machine will be lost. After this, 4358 the given snapshot becomes the new current snapshot so that 4359 subsequent snapshots are inserted under the snapshot from which 4360 was restored. 4361 </para> 4362 4363 <para> 4364 The <command>restorecurrent</command> operation is a shortcut to 4365 restore the current snapshot, which is the snapshot from which the 4366 current state is derived. This subcommand is equivalent to using 4367 the <command>restore</command> subcommand with the name or UUID of 4368 the current snapshot, except that it avoids the extra step of 4089 4369 determining that name or UUID. 4090 4370 </para> 4091 4371 4092 4372 <para> 4093 With the <com puteroutput>edit</computeroutput> operation, you can4094 change thename or description of an existing snapshot.4095 </para> 4096 4097 <para> 4098 The <com puteroutput>list</computeroutput> operation shows all4099 snapshots of avirtual machine.4100 </para> 4101 4102 <para> 4103 With the <com puteroutput>showvminfo</computeroutput> operation,4104 you can view the virtual machine settings that were stored with an4105 existingsnapshot.4373 With the <command>edit</command> operation, you can change the 4374 name or description of an existing snapshot. 4375 </para> 4376 4377 <para> 4378 The <command>list</command> operation shows all snapshots of a 4379 virtual machine. 4380 </para> 4381 4382 <para> 4383 With the <command>showvminfo</command> operation, you can view the 4384 virtual machine settings that were stored with an existing 4385 snapshot. 4106 4386 </para> 4107 4387 … … 4114 4394 <para> 4115 4395 This command removes a hard disk, DVD, or floppy image from a 4116 VirtualBox media registry. 4117 4118 <footnote> 4119 4120 <para> 4121 Before VirtualBox 4.0, it was necessary to call VBoxManage 4122 openmedium before a medium could be attached to a virtual 4123 machine; that call "registered" the medium with the global 4124 VirtualBox media registry. With VirtualBox 4.0 this is no 4125 longer necessary; media are added to media registries 4126 automatically. The "closemedium" call has been retained, 4127 however, to allow for explicitly removing a medium from a 4128 registry. 4129 </para> 4130 4131 </footnote> 4396 &product-name; media registry. 4132 4397 </para> 4133 4398 … … 4148 4413 4149 4414 <para> 4150 This command attaches /modifies/removes a storage medium connected4151 to a storage controller that was previously added with the4152 <computeroutput>storagectl</computeroutput> command. The syntax is4153 asfollows:4415 This command attaches, modifies, and removes a storage medium 4416 connected to a storage controller that was previously added with 4417 the <command>storagectl</command> command. The syntax is as 4418 follows: 4154 4419 </para> 4155 4420 … … 4185 4450 4186 4451 <para> 4187 A number of parameters are commonly required. The ones at the end 4188 of the list are required only for iSCSI targets, as described 4189 below. 4190 </para> 4191 4192 <para> 4193 The common parameters are: 4452 A number of parameters are commonly required. Some parameters are 4453 required only for iSCSI targets. 4454 </para> 4455 4456 <para> 4457 The common parameters are as follows: 4194 4458 </para> 4195 4459 … … 4217 4481 Name of the storage controller. Mandatory. The list of the 4218 4482 storage controllers currently attached to a VM can be 4219 obtained with <computeroutput>VBoxManage 4220 showvminfo</computeroutput>. See 4483 obtained with <command>VBoxManage showvminfo</command>. See 4221 4484 <xref linkend="vboxmanage-showvminfo" />. 4222 4485 </para> … … 4260 4523 <para> 4261 4524 Define the type of the drive to which the medium is being 4262 attached /detached/modified. This argument can only be4525 attached, detached, or modified. This argument can only be 4263 4526 omitted if the type of medium can be determined from either 4264 4527 the medium given with the … … 4284 4547 <listitem> 4285 4548 <para> 4286 "none": Any existing device should be removed from the 4287 given slot. 4288 </para> 4289 </listitem> 4290 4291 <listitem> 4292 <para> 4293 "emptydrive": For a virtual DVD or floppy drive only, 4294 this makes the device slot behaves like a removeable 4295 drive into which no media has been inserted. 4296 </para> 4297 </listitem> 4298 4299 <listitem> 4300 <para> 4301 "additions": For a virtual DVD drive only, this attaches 4302 the <emphasis>VirtualBox Guest Additions</emphasis> 4303 image to the given device slot. 4549 <computeroutput>none</computeroutput>: Any existing 4550 device should be removed from the given slot. 4551 </para> 4552 </listitem> 4553 4554 <listitem> 4555 <para> 4556 <computeroutput>emptydrive</computeroutput>: For a 4557 virtual DVD or floppy drive only, this makes the device 4558 slot behave like a removeable drive into which no media 4559 has been inserted. 4560 </para> 4561 </listitem> 4562 4563 <listitem> 4564 <para> 4565 <computeroutput>additions</computeroutput>: For a 4566 virtual DVD drive only, this attaches the 4567 <emphasis>VirtualBox Guest Additions</emphasis> image to 4568 the given device slot. 4304 4569 </para> 4305 4570 </listitem> … … 4308 4573 <para> 4309 4574 If a UUID is specified, it must be the UUID of a storage 4310 medium that is already known to VirtualBox (e.g. because4311 it has been attached to another virtual machine). See4312 <xref linkend="vboxmanage-list" /> for how to list known4313 media. This medium is then attached to the given device4314 slot.4575 medium that is already known to &product-name;. For 4576 example, because it has been attached to another virtual 4577 machine. See <xref linkend="vboxmanage-list" /> for 4578 details of how to list known media. This medium is then 4579 attached to the given device slot. 4315 4580 </para> 4316 4581 </listitem> … … 4319 4584 <para> 4320 4585 If a filename is specified, it must be the full path of 4321 an existing disk image (ISO, RAW, VDI, VMDK or other), 4322 which is then attached to the given device slot. 4323 </para> 4324 </listitem> 4325 4326 <listitem> 4327 <para> 4328 "host:<drive>": For a virtual DVD or floppy drive 4329 only, this connects the given device slot to the 4330 specified DVD or floppy drive on the host computer. 4331 </para> 4332 </listitem> 4333 4334 <listitem> 4335 <para> 4336 "iscsi": For virtual hard disks only, this allows for 4337 specifying an iSCSI target. In this case, more 4338 parameters must be given. See the description below. 4586 an existing disk image in ISO, RAW, VDI, VMDK, or other 4587 format. The disk image is then attached to the given 4588 device slot. 4589 </para> 4590 </listitem> 4591 4592 <listitem> 4593 <para> 4594 <computeroutput>host:<drive></computeroutput>: For 4595 a virtual DVD or floppy drive only, this connects the 4596 given device slot to the specified DVD or floppy drive 4597 on the host computer. 4598 </para> 4599 </listitem> 4600 4601 <listitem> 4602 <para> 4603 <computeroutput>iscsi</computeroutput>: For virtual hard 4604 disks only, this is used for specifying an iSCSI target. 4605 In this case, additional parameters must be given. These 4606 are described below. 4339 4607 </para> 4340 4608 </listitem> … … 4344 4612 <para> 4345 4613 Some of the above changes, in particular for removeable 4346 media (floppies and CDs/DVDs), can be effected while a VM is4347 running. Others, such as device changes or changes in hard4348 disk device slots, require the VM to be powered off.4614 media such as floppies and CDs/DVDs, can be effected while a 4615 VM is running. Others, such as device changes or changes in 4616 hard disk device slots, require the VM to be powered off. 4349 4617 </para> 4350 4618 </listitem> … … 4359 4627 <para> 4360 4628 Defines how this medium behaves with respect to snapshots 4361 and write operations. See <xref linkend="hdimagewrites" /> 4362 for details. 4629 and write operations. See <xref linkend="hdimagewrites" />. 4363 4630 </para> 4364 4631 </listitem> … … 4392 4659 broken VM configurations if any other VM is referring to the 4393 4660 same media already. The most frequently used variant is 4394 <code>--setuuid ""</code>, which assigns a new (random) UUID 4395 to an image. This is useful to resolve the duplicate UUID 4396 errors if one duplicated an image using file copy utilities. 4661 <computeroutput>--setuuid ""</computeroutput>, which assigns 4662 a new random UUID to an image. This option is useful for 4663 resolving duplicate UUID errors if you duplicated an image 4664 using a file copy utility. 4397 4665 </para> 4398 4666 </listitem> … … 4422 4690 <para> 4423 4691 For a virtual DVD drive only, you can configure the behavior 4424 for guest-triggered medium eject. If this is set to "on",4425 the eject has only temporary effects. If the VM is powered4426 off and restarted the originally configured medium will be4427 stillin the drive.4692 for guest-triggered medium eject. If this is set to on, the 4693 eject has only a temporary effect. If the VM is powered off 4694 and restarted the originally configured medium will be still 4695 in the drive. 4428 4696 </para> 4429 4697 </listitem> … … 4437 4705 <listitem> 4438 4706 <para> 4439 This switch allows to enable the non-rotational flag for4440 virtual hard disks. Some guests (i.e. Windows 7+) treat such4441 disks like SSDs and do not perform disk fragmentationon4442 such media.4707 Enables you to enable the non-rotational flag for virtual 4708 hard disks. Some guests, such as Windows 7 or later, treat 4709 such disks like SSDs and do not perform disk fragmentation 4710 on such media. 4443 4711 </para> 4444 4712 </listitem> … … 4452 4720 <listitem> 4453 4721 <para> 4454 This switch enables the auto-discard feature for the virtual4455 hard disks. This specifies that a VDI image will be shrunk4456 in response to the trim command from the guest OS. The4457 followingrequirements must be met:4722 Enables the auto-discard feature for a virtual hard disks. 4723 This specifies that a VDI image will be shrunk in response 4724 to the trim command from the guest OS. The following 4725 requirements must be met: 4458 4726 </para> 4459 4727 … … 4468 4736 <listitem> 4469 4737 <para> 4470 The size of the cleared area must be at least 1MB. 4471 </para> 4472 </listitem> 4473 4474 <listitem> 4475 <para> 4476 VirtualBox will only trim whole 1 MB blocks. The VDIs 4477 themselves are organized into 1 MB blocks, so this will 4478 only work if the space being TRIM-ed is at least a 1 MB 4479 contiguous block at a 1 MB boundary. On Windows, 4480 occasional defrag (with "defrag.exe /D"), or under Linux 4481 running "btrfs filesystem defrag" as a background cron 4482 job may be beneficial. 4738 The size of the cleared area must be at least 1 MB. 4739 </para> 4740 </listitem> 4741 4742 <listitem> 4743 <para> 4744 &product-name; will only trim whole 1 MB blocks. The 4745 VDIs themselves are organized into 1 MB blocks, so this 4746 will only work if the space being trimmed is at least a 4747 1 MB contiguous block at a 1 MB boundary. On Windows, 4748 occasional defragmentation with <command>defrag.exe 4749 /D</command>, or on Linux running <command>btrfs 4750 filesystem defrag</command> as a background cron job may 4751 be beneficial. 4483 4752 </para> 4484 4753 </listitem> … … 4486 4755 </itemizedlist> 4487 4756 4488 <para> 4489 Notes: the Guest OS must be configured to issue trim 4490 command, and typically this means that the guest OS is made 4491 to 'see' the disk as an SSD. Ext4 supports -o discard mount 4492 flag; OSX probably requires additional settings. Windows 4493 ought to automatically detect and support SSDs - at least in 4494 versions 7, 8 and 10. Linux exFAT driver (courtesy of 4495 Samsung) supports the trim command. 4496 </para> 4757 <note> 4758 <para> 4759 The Guest OS must be configured to issue the 4760 <command>trim</command> command, and typically this means 4761 that the guest OS is made to see the disk as an SSD. Ext4 4762 supports the -o discard mount flag. Mac OS X probably 4763 requires additional settings. Windows should automatically 4764 detect and support SSDs, at least in versions 7, 8, and 4765 10. The Linux exFAT driver from Samsung supports the 4766 <command>trim</command> command. 4767 </para> 4768 </note> 4497 4769 4498 4770 <para> … … 4503 4775 4504 4776 <para> 4505 Alternatively, there are ad hoc methods to issue trim, e.g. 4506 Linux fstrim command, part of util-linux package. Earlier 4507 solutions required a user to zero out unused areas, e.g. 4508 using zerofree, and explicitly compact the disk - only 4509 possible when the VM is offline. 4777 Alternatively, there are other methods to issue trim. For 4778 example, the Linux <command>fstrim</command> command, part 4779 of the util-linux package. Earlier solutions required a user 4780 to zero out unused areas, using zerofree or similar, and to 4781 compact the disk. This is only possible when the VM is 4782 offline. 4510 4783 </para> 4511 4784 </listitem> … … 4535 4808 unmounts the DVD/CD/Floppy or mounts a new DVD/CD/Floppy 4536 4809 even if the previous one is locked down by the guest for 4537 reading. Again, see <xref linkend="storage-cds" /> for 4538 details. 4810 reading. See <xref linkend="storage-cds" />. 4539 4811 </para> 4540 4812 </listitem> … … 4544 4816 4545 4817 <para> 4546 When "iscsi"is used with the4818 When <computeroutput>iscsi</computeroutput> is used with the 4547 4819 <computeroutput>--medium</computeroutput> parameter for iSCSI 4548 4820 support, additional parameters must or can be used. See also … … 4559 4831 <listitem> 4560 4832 <para> 4561 The host name or IP address of the iSCSI target ; required.4833 The host name or IP address of the iSCSI target. Required. 4562 4834 </para> 4563 4835 </listitem> … … 4572 4844 <para> 4573 4845 Target name string. This is determined by the iSCSI target 4574 and used to identify the storage resource ; required.4846 and used to identify the storage resource. Required. 4575 4847 </para> 4576 4848 </listitem> … … 4610 4882 <listitem> 4611 4883 <para> 4612 Hex 4884 Hex-encoded Logical Unit Number of the target resource. 4613 4885 Optional. Often, this value is zero. 4614 4886 </para> … … 4624 4896 <listitem> 4625 4897 <para> 4626 Username and password (initiator secret) for target4627 authentication, if required. Optional.4628 4629 <note> 4630 <para>4631 Username and password are stored without encryption, in4632 clear text, in the XML machine configuration file if no4633 settings password is provided. When a settings password4634 was specified the first time, the password is stored4635 encrypted. Alternatively to providing the password on4636 the command line, a reference to a file containing the4637 text can be provided instead via the passwordfile4638 option.4639 < /para>4640 </ note>4641 </ para>4898 Username and password, called the initiator secret, for 4899 target authentication, if required. Optional. 4900 </para> 4901 4902 <note> 4903 <para> 4904 Username and password are stored without encryption, in 4905 clear text, in the XML machine configuration file if no 4906 settings password is provided. When a settings password is 4907 specified for the first time, the password is stored in 4908 encrypted form. As an alternative to providing the 4909 password on the command line, a reference to a file 4910 containing the text can be provided using the 4911 <computeroutput>passwordfile</computeroutput> option. 4912 </para> 4913 </note> 4642 4914 </listitem> 4643 4915 </varlistentry> … … 4650 4922 <listitem> 4651 4923 <para> 4652 iSCSI Initiator (optional). 4653 </para> 4654 4655 <para> 4656 Note: Microsoft iSCSI Initiator is a system, such as a 4657 server that attaches to an IP network and initiates requests 4658 and receives responses from an iSCSI target. The SAN 4659 components in Microsoft iSCSI Initiator are largely 4660 analogous to Fibre Channel SAN components, and they include 4661 the following: 4662 </para> 4663 4664 <para> 4665 To transport blocks of iSCSI commands over the IP network, 4666 an iSCSI driver must be installed on the iSCSI host. An 4667 iSCSI driver is included with Microsoft iSCSI Initiator. 4668 </para> 4669 4670 <para> 4671 A gigabit Ethernet adapter that transmits 1000 megabits per 4672 second (Mbps) is recommended for the connection to an iSCSI 4673 target. Like standard 10/100 adapters, most gigabit adapters 4674 use a pre-existing Category 5 or Category 6E cable. Each 4675 port on the adapter is identified by a unique IP address. 4676 </para> 4677 4678 <para> 4679 An iSCSI target is any device that receives iSCSI commands. 4680 The device can be an end node, such as a storage device, or 4681 it can be an intermediate device, such as a network bridge 4682 between IP and Fibre Channel devices. Each port on the 4683 storage array controller or network bridge is identified by 4684 one or more IP addresses 4685 </para> 4924 iSCSI Initiator. Optional. 4925 </para> 4926 4927 <para> 4928 Microsoft iSCSI Initiator is a system, such as a server that 4929 attaches to an IP network and initiates requests and 4930 receives responses from an iSCSI target. The SAN components 4931 in Microsoft iSCSI Initiator are largely analogous to Fibre 4932 Channel SAN components, and they include the following: 4933 </para> 4934 4935 <itemizedlist> 4936 4937 <listitem> 4938 <para> 4939 To transport blocks of iSCSI commands over the IP 4940 network, an iSCSI driver must be installed on the iSCSI 4941 host. An iSCSI driver is included with Microsoft iSCSI 4942 Initiator. 4943 </para> 4944 </listitem> 4945 4946 <listitem> 4947 <para> 4948 A gigabit Ethernet adapter that transmits 1000 megabits 4949 per second (Mbps) is recommended for the connection to 4950 an iSCSI target. Like standard 10/100 adapters, most 4951 gigabit adapters use a preexisting Category 5 or 4952 Category 6E cable. Each port on the adapter is 4953 identified by a unique IP address. 4954 </para> 4955 </listitem> 4956 4957 <listitem> 4958 <para> 4959 An iSCSI target is any device that receives iSCSI 4960 commands. The device can be an end node, such as a 4961 storage device, or it can be an intermediate device, 4962 such as a network bridge between IP and Fibre Channel 4963 devices. Each port on the storage array controller or 4964 network bridge is identified by one or more IP addresses 4965 </para> 4966 </listitem> 4967 4968 </itemizedlist> 4686 4969 </listitem> 4687 4970 </varlistentry> … … 4694 4977 <listitem> 4695 4978 <para> 4696 If specified, connect to the iSCSI target viaInternal4979 If specified, connect to the iSCSI target using Internal 4697 4980 Networking. This needs further configuration, see 4698 4981 <xref linkend="iscsi-intnet" />. … … 4710 4993 4711 4994 <para> 4712 This command attaches /modifies/removes a storage controller. After4713 this, virtual media can be attached to the controller with the4714 <computeroutput>storageattach</computeroutput> command.4715 </para> 4716 4717 <para> 4718 The syntax is as follows:4995 This command attaches, modifies, and removes a storage controller. 4996 After this, virtual media can be attached to the controller with 4997 the <command>storageattach</command> command. 4998 </para> 4999 5000 <para> 5001 The syntax for this command is as follows: 4719 5002 </para> 4720 5003 … … 4732 5015 4733 5016 <para> 4734 where the parameters mean:5017 The parameters are as follows: 4735 5018 </para> 4736 5019 … … 4846 5129 <listitem> 4847 5130 <para> 4848 Removes the storage controller from the VM config .5131 Removes the storage controller from the VM configuration. 4849 5132 </para> 4850 5133 </listitem> … … 4860 5143 4861 5144 <para> 4862 This command creates/deletes/modifies/shows bandwidth groups of 4863 the given virtual machine: 5145 This command creates, deletes, modifies, and shows bandwidth 5146 groups of the given virtual machine. 5147 </para> 4864 5148 4865 5149 <screen>VBoxManage bandwidthctl <uuid|vmname> … … 4868 5152 remove <name> | 4869 5153 list [--machinereadable]</screen> 4870 </para>4871 5154 4872 5155 <para> … … 4878 5161 <listitem> 4879 5162 <para> 4880 <computeroutput>add</computeroutput>, creates a new bandwidth 4881 group of a given type. 4882 </para> 4883 </listitem> 4884 4885 <listitem> 4886 <para> 4887 <computeroutput>set</computeroutput>, modifies the limit for 4888 an existing bandwidth group. 4889 </para> 4890 </listitem> 4891 4892 <listitem> 4893 <para> 4894 <computeroutput>remove</computeroutput>, destroys a bandwidth 4895 group. 4896 </para> 4897 </listitem> 4898 4899 <listitem> 4900 <para> 4901 <computeroutput>list</computeroutput>, shows all bandwidth 4902 groups defined for the given VM. Use the 5163 <command>add</command>: Creates a new bandwidth group of a 5164 given type. 5165 </para> 5166 </listitem> 5167 5168 <listitem> 5169 <para> 5170 <command>set</command>: Modifies the limit for an existing 5171 bandwidth group. 5172 </para> 5173 </listitem> 5174 5175 <listitem> 5176 <para> 5177 <command>remove</command>: Deletes a bandwidth group. 5178 </para> 5179 </listitem> 5180 5181 <listitem> 5182 <para> 5183 <command>list</command>: Shows all bandwidth groups defined 5184 for the given VM. Use the 4903 5185 <computeroutput>--machinereadable</computeroutput> option to 4904 5186 produce the same output, but in machine readable format. This … … 4910 5192 4911 5193 <para> 4912 The parameters mean the following:5194 The parameters are as follows: 4913 5195 </para> 4914 5196 … … 4967 5249 megabytes per second. The unit can be changed by specifying 4968 5250 one of the following suffixes: 4969 <computeroutput>k</computeroutput> for kilobits /s,4970 <computeroutput>m</computeroutput> for megabits /s,4971 <computeroutput>g</computeroutput> for gigabits /s,4972 <computeroutput>K</computeroutput> for kilobytes /s,4973 <computeroutput>M</computeroutput> for megabytes /s,4974 <computeroutput>G</computeroutput> for gigabytes /s.5251 <computeroutput>k</computeroutput> for kilobits per second, 5252 <computeroutput>m</computeroutput> for megabits per second, 5253 <computeroutput>g</computeroutput> for gigabits per second, 5254 <computeroutput>K</computeroutput> for kilobytes per second, 5255 <computeroutput>M</computeroutput> for megabytes per second, 5256 <computeroutput>G</computeroutput> for gigabytes per second. 4975 5257 </para> 4976 5258 </listitem> … … 5002 5284 <para> 5003 5285 This command shows information about a medium, notably its size, 5004 its size on disk, its type and the virtual machines which use it. 5005 5006 <note> 5007 <para> 5008 For compatibility with earlier versions of VirtualBox, the 5009 "showvdiinfo" command is also supported and mapped internally 5010 to the "showmediuminfo" command. 5011 </para> 5012 </note> 5013 </para> 5286 its size on disk, its type, and the virtual machines which use it. 5287 </para> 5288 5289 <note> 5290 <para> 5291 For compatibility with earlier versions of &product-name;, the 5292 <command>showvdiinfo</command> command is also supported and 5293 mapped internally to the <command>showmediuminfo</command> 5294 command. 5295 </para> 5296 </note> 5014 5297 5015 5298 <screen>VBoxManage showmediuminfo [disk|dvd|floppy] <uuid|filename></screen> 5016 5299 5017 5300 <para> 5018 The medium must be specified either by its UUID (if the medium is5019 registered ) or by its filename. Registered images can be listed by5020 <computeroutput>VBoxManage list hdds</computeroutput>,5021 <computeroutput>VBoxManage list dvds</computeroutput>, or5022 <computeroutput>VBoxManage list floppies</computeroutput>, as5023 appropriate. See<xref linkend="vboxmanage-list" />.5301 The medium must be specified either by its UUID, if the medium is 5302 registered, or by its filename. Registered images can be listed 5303 using <command>VBoxManage list hdds</command>, <command>VBoxManage 5304 list dvds</command>, or <command>VBoxManage list 5305 floppies</command>, as appropriate. See 5306 <xref linkend="vboxmanage-list" />. 5024 5307 </para> 5025 5308 … … 5041 5324 5042 5325 <para> 5043 where the parameters mean:5326 The parameters are as follows: 5044 5327 </para> 5045 5328 … … 5066 5349 <listitem> 5067 5350 <para> 5068 <megabytes> Specifies the image capacity, in 1 MB 5069 units. Optional. 5351 Specifies the image capacity, in 1 MB units. Optional. 5070 5352 </para> 5071 5353 </listitem> … … 5096 5378 <para> 5097 5379 Specifies the file format for the output file. Available 5098 options are VDI, VMDK, VHD. Default is VDI. Optional. 5099 </para> 5100 </listitem> 5101 </varlistentry> 5102 5103 <varlistentry> 5104 <term> 5105 <computeroutput>--variant 5106 Standard,Fixed,Split2G,Stream,ESX</computeroutput> 5107 </term> 5108 5109 <listitem> 5110 <para> 5111 Specifies any required file format variant(s) for the output 5112 file. It is a comma-separated list of variant flags. Not all 5380 options are VDI, VMDK, VHD. The default format is VDI. 5381 Optional. 5382 </para> 5383 </listitem> 5384 </varlistentry> 5385 5386 <varlistentry> 5387 <term> 5388 <computeroutput>--variant</computeroutput> 5389 </term> 5390 5391 <listitem> 5392 <para> 5393 Specifies any required file format variants for the output 5394 file. This is a comma-separated list of variant flags. 5395 Options are Standard,Fixed,Split2G,Stream,ESX. Not all 5113 5396 combinations are supported, and specifying mutually 5114 5397 incompatible flags results in an error message. Optional. … … 5121 5404 <note> 5122 5405 <para> 5123 For compatibility with earlier versions of VirtualBox, the 5124 "createvdi" and "createhd" commands are also supported and 5125 mapped internally to the "createmedium" command. 5406 For compatibility with earlier versions of &product-name;, the 5407 <command>createvdi</command> and <command>createhd</command> 5408 commands are also supported and mapped internally to the 5409 <command>createmedium</command> command. 5126 5410 </para> 5127 5411 </note> … … 5134 5418 5135 5419 <para> 5136 With the <com puteroutput>modifymedium</computeroutput> command,5137 you can change the characteristics of a disk image after it has5138 been created:5420 With the <command>modifymedium</command> command, you can change 5421 the characteristics of a disk image after it has been created. 5422 </para> 5139 5423 5140 5424 <screen>VBoxManage modifymedium [disk|dvd|floppy] <uuid|filename> … … 5148 5432 [--setlocation <path>]</screen> 5149 5433 5150 5151 5152 For compatibility with earlier versions of VirtualBox, the5153 "modifyvdi" and "modifyhd" commands are also supported and5154 mapped internally to the "modifymedium" command.5155 < /para>5156 </ note>5157 </ para>5158 5159 <para> 5160 The disk image to modify must be specified either by its UUID (if5161 the medium is registered )or by its filename. Registered images5162 can be listed by <computeroutput>VBoxManage list5163 hdds</computeroutput>, see <xref linkend="vboxmanage-list" />. A5164 filename must be specified as a valid path, either as an absolute5165 path or as a relative pathstarting from the current directory.5434 <note> 5435 <para> 5436 For compatibility with earlier versions of &product-name;, the 5437 <command>modifyvdi</command> and <command>modifyhd</command> 5438 commands are also supported and mapped internally to the 5439 <command>modifymedium</command> command. 5440 </para> 5441 </note> 5442 5443 <para> 5444 The disk image to modify must be specified either by its UUID, if 5445 the medium is registered, or by its filename. Registered images 5446 can be listed using <command>VBoxManage list hdds</command>, see 5447 <xref linkend="vboxmanage-list" />. A filename must be specified 5448 as a valid path, either as an absolute path or as a relative path 5449 starting from the current directory. 5166 5450 </para> 5167 5451 … … 5184 5468 <listitem> 5185 5469 <para> 5186 For immutable (differencing) hard disks only, the 5187 <computeroutput>--autoreset on|off</computeroutput> option 5188 determines whether the disk is automatically reset on every VM 5189 startup, see <xref linkend="hdimagewrites" />. The default is 5190 "on". 5470 For immutable hard disks only, the <computeroutput>--autoreset 5471 on|off</computeroutput> option determines whether the disk is 5472 automatically reset on every VM startup. See 5473 <xref linkend="hdimagewrites" />. By default, autoreset is on. 5191 5474 </para> 5192 5475 </listitem> … … 5195 5478 <para> 5196 5479 The <computeroutput>--compact</computeroutput> option can be 5197 used to compact disk images, i.e. remove blocks that only 5198 contains zeroes. This will shrink a dynamically allocated 5199 image again; it will reduce the <emphasis>physical</emphasis> 5200 size of the image without affecting the logical size of the 5201 virtual disk. Compaction works both for base images and for 5202 diff images created as part of a snapshot. 5480 used to compact disk images. Compacting removes blocks that 5481 only contains zeroes. Using this option will shrink a 5482 dynamically allocated image. It will reduce the 5483 <emphasis>physical</emphasis> size of the image without 5484 affecting the logical size of the virtual disk. Compaction 5485 works both for base images and for differencing images created 5486 as part of a snapshot. 5203 5487 </para> 5204 5488 … … 5207 5491 space in the guest system first be zeroed out using a suitable 5208 5492 software tool. For Windows guests, you can use the 5209 <computeroutput>sdelete</computeroutput> tool provided by 5210 Microsoft. Execute <computeroutput>sdelete -z</computeroutput> 5211 in the guest to zero the free disk space before compressing 5212 the virtual disk image. For Linux, use the 5213 <code>zerofree</code> utility which supports ext2/ext3 5214 filesystems. For Mac OS X guests, use the <code>diskutil 5215 secureErase freespace 0 /</code> command line from an elevated 5216 Terminal. 5493 <command>sdelete</command> tool provided by Microsoft. Run 5494 <command>sdelete -z</command> in the guest to zero the free 5495 disk space, before compressing the virtual disk image. For 5496 Linux, use the <command>zerofree</command> utility which 5497 supports ext2/ext3 filesystems. For Mac OS X guests, use the 5498 <computeroutput>diskutil secureErase freespace 0 5499 /</computeroutput> command from an elevated Terminal. 5217 5500 </para> 5218 5501 … … 5229 5512 <para> 5230 5513 The <computeroutput>--resize x</computeroutput> option, where 5231 x is the desired new total space in 5232 <emphasis role="bold">megabytes</emphasis> enables you to 5514 x is the desired new total space in megabytes enables you to 5233 5515 change the capacity of an existing image. This adjusts the 5234 5516 <emphasis>logical</emphasis> size of a virtual disk without 5235 5517 affecting the physical size much. 5236 5237 <footnote> 5238 5239 <para> 5240 Image resizing was added with VirtualBox 4.0. 5241 </para> 5242 5243 </footnote> 5244 5245 This currently works only for VDI and VHD formats, and only 5246 for the dynamically allocated variants, and can only be used 5247 to expand (not shrink) the capacity. For example, if you 5248 originally created a 10 GB disk which is now full, you can use 5249 the <computeroutput>--resize 15360</computeroutput> command to 5250 change the capacity to 15 GB (15,360 MB) without having to 5251 create a new image and copy all data from within a virtual 5252 machine. Note however that this only changes the drive 5518 </para> 5519 5520 <para> 5521 This option currently works only for VDI and VHD formats, and 5522 only for the dynamically allocated variants. It can only be 5523 used to expand, but not shrink, the capacity. For example, if 5524 you originally created a 10 GB disk which is now full, you can 5525 use the <computeroutput>--resize 15360</computeroutput> 5526 command to change the capacity to 15 GB (15,360 MB) without 5527 having to create a new image and copy all data from within a 5528 virtual machine. Note however that this only changes the drive 5253 5529 capacity. You will typically next need to use a partition 5254 5530 management tool inside the guest to adjust the main partition … … 5272 5548 </listitem> 5273 5549 5274 <listitem> 5275 <para> 5276 The <computeroutput>--setlocation <path></computeroutput> 5277 option can be used to set new location <path> of the 5278 medium on the host file system if the medium had been moved 5279 for any reasons. The path can be either relative to the 5280 current directory or absolute. 5281 </para> 5282 5283 <para> 5284 Note, the new location is used as is, without any sanity checks, 5285 so user is responsible to set correct path. 5286 </para> 5287 </listitem> 5550 <listitem> 5551 <para> 5552 The <computeroutput>--setlocation 5553 <path></computeroutput> option can be used to set the 5554 new location <path> of the medium on the host file 5555 system if the medium has been moved for any reasons. The path 5556 can be either relative to the current directory or absolute. 5557 </para> 5558 5559 <note> 5560 <para> 5561 The new location is used as is, without any sanity checks. 5562 The user is responsible for setting the correct path. 5563 </para> 5564 </note> 5565 </listitem> 5288 5566 5289 5567 </itemizedlist> … … 5296 5574 5297 5575 <para> 5298 This command duplicates a virtual disk /DVD/floppy medium to a new5299 medium, usually an image file, with a new unique identifier5576 This command duplicates a virtual disk, DVD, or floppy medium to a 5577 new medium, usually an image file, with a new unique identifier 5300 5578 (UUID). The new image can be transferred to another host system or 5301 reimported into VirtualBox using the Virtual Media Manager. See5302 <xref linkend="vdis" /> and <xref linkend="cloningvdis" />. The5303 syntax is as follows:5579 reimported into &product-name; using the Virtual Media Manager. 5580 See <xref linkend="vdis" /> and <xref linkend="cloningvdis" />. 5581 The syntax is as follows: 5304 5582 </para> 5305 5583 … … 5313 5591 The medium to clone as well as the target image must be described 5314 5592 either by its UUIDs, if the mediums are registered, or by its 5315 filename. Registered images can be listed by 5316 <computeroutput>VBoxManage list hdds</computeroutput>. See 5317 <xref linkend="vboxmanage-list" />. A filename must be specified 5318 as valid path, either as an absolute path or as a relative path 5319 starting from the current directory. 5593 filename. Registered images can be listed by <command>VBoxManage 5594 list hdds</command>. See <xref linkend="vboxmanage-list" />. A 5595 filename must be specified as valid path, either as an absolute 5596 path or as a relative path starting from the current directory. 5320 5597 </para> 5321 5598 … … 5333 5610 <listitem> 5334 5611 <para> 5335 Allow to choose a file format for the output file different5336 f rom the file format of the input file.5612 Set a file format for the output file different from the 5613 file format of the input file. 5337 5614 </para> 5338 5615 </listitem> … … 5346 5623 <listitem> 5347 5624 <para> 5348 Allow to choose a file format variant for the output file.5349 It is a comma-separated list of variant flags. Not all5350 combinations are supported, and specifying inconsistent5351 flags will resultin an error message.5625 Set a file format variant for the output file. This is a 5626 comma-separated list of variant flags. Not all combinations 5627 are supported, and specifying inconsistent flags will result 5628 in an error message. 5352 5629 </para> 5353 5630 </listitem> … … 5376 5653 <note> 5377 5654 <para> 5378 For compatibility with earlier versions of VirtualBox, the 5379 "clonevdi" and "clonehd" commands are still supported and mapped 5380 internally to the "clonehd disk" command. 5655 For compatibility with earlier versions of &product-name;, the 5656 <command>clonevdi</command> and <command>clonehd</command> 5657 commands are still supported and mapped internally to the 5658 <command>clonehd disk</command> command. 5381 5659 </para> 5382 5660 </note> … … 5389 5667 5390 5668 <para> 5391 This command sets up, gets or deletes a medium property. The5392 syntaxis as follows:5669 This command sets, gets, or deletes a medium property. The syntax 5670 is as follows: 5393 5671 </para> 5394 5672 … … 5402 5680 Use <computeroutput><disk|dvd|floppy></computeroutput> 5403 5681 to optionally specify the type of medium: disk (hard drive), 5404 dvd or floppy.5682 dvd, or floppy. 5405 5683 </para> 5406 5684 </listitem> … … 5409 5687 <para> 5410 5688 Use <computeroutput><uuid|filename></computeroutput> to 5411 supply either the uuid or absolute path of the medium/image to5412 be encrypted.5689 supply either the UUID or absolute path of the medium or 5690 image. 5413 5691 </para> 5414 5692 </listitem> … … 5439 5717 Use <computeroutput><disk|dvd|floppy></computeroutput> 5440 5718 to optionally specify the type of medium: disk (hard drive), 5441 dvd or floppy.5719 dvd, or floppy. 5442 5720 </para> 5443 5721 </listitem> … … 5446 5724 <para> 5447 5725 Use <computeroutput><uuid|filename></computeroutput> to 5448 supply either the uuid or absolute path of the medium/image to5449 be encrypted.5726 supply either the UUID or absolute path of the medium or 5727 image. 5450 5728 </para> 5451 5729 </listitem> … … 5469 5747 Use <computeroutput><disk|dvd|floppy></computeroutput> 5470 5748 to optionally specify the type of medium: disk (hard drive), 5471 dvd or floppy.5749 dvd, or floppy. 5472 5750 </para> 5473 5751 </listitem> … … 5476 5754 <para> 5477 5755 Use <computeroutput><uuid|filename></computeroutput> to 5478 supply either the uuid or absolute path of the medium/image. 5756 supply either the UUID or absolute path of the medium or 5757 image. 5479 5758 </para> 5480 5759 </listitem> … … 5496 5775 5497 5776 <para> 5498 This command is used to create a DEK encrypted medium /image. See5499 <xref linkend="diskencryption-encryption" />.5777 This command is used to create a DEK encrypted medium or image. 5778 See <xref linkend="diskencryption-encryption" />. 5500 5779 </para> 5501 5780 … … 5514 5793 <listitem> 5515 5794 <para> 5516 use <computeroutput><uuid|filename></computeroutput> to5517 supply the uuid or absolute path of the medium/image to be5795 Use <computeroutput><uuid|filename></computeroutput> to 5796 supply the UUID or absolute path of the medium or image to be 5518 5797 encrypted. 5519 5798 </para> … … 5524 5803 Use <computeroutput>--newpassword 5525 5804 <file|-></computeroutput> to supply a new encryption 5526 password ; either specify the absolute pathname of a password5805 password. Either specify the absolute pathname of a password 5527 5806 file on the host operating system, or 5528 5807 <computeroutput>-</computeroutput> to prompt you for the … … 5535 5814 <listitem> 5536 5815 <para> 5537 use <computeroutput>--oldpassword5816 Use <computeroutput>--oldpassword 5538 5817 <file|-></computeroutput> to supply any old encryption 5539 password ; either specify the absolute pathname of a password5818 password. Either specify the absolute pathname of a password 5540 5819 file on the host operating system, or 5541 5820 <computeroutput>-</computeroutput> to prompt you for the old … … 5544 5823 5545 5824 <para> 5546 Use this option to gain access to an encrypted medium/image to 5547 change its password using 5548 <computeroutput>--newpassword</computeroutput> and/or change 5549 its encryption using 5550 <computeroutput>--cipher</computeroutput>. 5825 Use this option to gain access to an encrypted medium or image 5826 to either change its password using 5827 <computeroutput>--newpassword</computeroutput> or change its 5828 encryption using <computeroutput>--cipher</computeroutput>. 5551 5829 </para> 5552 5830 </listitem> … … 5555 5833 <para> 5556 5834 Use <computeroutput>--cipher <cipher></computeroutput> 5557 to specify the cipher to use for encryption ; this can be5835 to specify the cipher to use for encryption. This can be 5558 5836 either <computeroutput>AES-XTS128-PLAIN64</computeroutput> or 5559 5837 <computeroutput>AES-XTS256-PLAIN64</computeroutput>. … … 5562 5840 <para> 5563 5841 Use this option to change any existing encryption on the 5564 medium/image, or setup new encryption on it for the 1st time. 5842 medium or image, or to set up new encryption on it for the 5843 first time. 5565 5844 </para> 5566 5845 </listitem> … … 5570 5849 Use <computeroutput>--newpasswordid <password 5571 5850 id></computeroutput> to supply the new password identifier. 5572 This can be freelychosen by the user, and is used for correct5851 This can be chosen by the user, and is used for correct 5573 5852 identification when supplying multiple passwords during VM 5574 5853 startup. … … 5592 5871 <para> 5593 5872 This command is used to check the current encryption password on a 5594 DEK encrypted medium /image. See5873 DEK encrypted medium or image. See 5595 5874 <xref linkend="diskencryption-encryption" />. 5596 5875 </para> … … 5608 5887 <para> 5609 5888 Use <computeroutput><uuid|filename></computeroutput> to 5610 supply the uuid or absolute path of the medium/image to be5889 supply the UUID or absolute path of the medium or image to be 5611 5890 checked. 5612 5891 </para> … … 5632 5911 5633 5912 <para> 5634 This command converts a raw disk image to a VirtualBox Disk Image5635 (VDI) file. The syntax is as follows:5913 This command converts a raw disk image to a &product-name; Disk 5914 Image (VDI) file. The syntax is as follows: 5636 5915 </para> 5637 5916 … … 5646 5925 5647 5926 <para> 5648 where the parameters mean:5927 The parameters are as follows: 5649 5928 </para> 5650 5929 … … 5671 5950 <listitem> 5672 5951 <para> 5673 Select the disk image format to create. Default is VDI.5674 Other options are VMDK and VHD.5952 Select the disk image format to create. The default format 5953 is VDI. Other options are VMDK and VHD. 5675 5954 </para> 5676 5955 </listitem> … … 5684 5963 <listitem> 5685 5964 <para> 5686 Allow to choose a file format variant for the output file.5687 It is a comma-separated list of variant flags. Not all5688 combinations are supported, and specifying inconsistent5689 flags will resultin an error message.5965 Choose a file format variant for the output file. This is a 5966 comma-separated list of variant flags. Not all combinations 5967 are supported, and specifying inconsistent flags will result 5968 in an error message. 5690 5969 </para> 5691 5970 </listitem> … … 5699 5978 <listitem> 5700 5979 <para> 5701 Allow to specifiy the UUID of the output file.5980 Specify the UUID of the output file. 5702 5981 </para> 5703 5982 </listitem> … … 5707 5986 5708 5987 <para> 5709 The second form forces VBoxManage to read the content for the disk5710 image from standard input (useful for using that command in a5711 pipe).5712 </para>5713 5714 <para> 5715 5716 5717 For compatibility with earlier versions of VirtualBox, the5718 "convertdd" command is also supported and mapped internally to5719 the "convertfromraw" command.5720 </para>5721 </ note>5722 </ para>5988 The <command>stdin</command> form of the command forces 5989 <command>VBoxManage</command> to read the content of the disk 5990 image from standard input. This useful when using the command in a 5991 pipe. 5992 </para> 5993 5994 <note> 5995 <para> 5996 For compatibility with earlier versions of &product-name;, the 5997 <command>convertdd</command> command is also supported and 5998 mapped internally to the <command>convertfromraw</command> 5999 command. 6000 </para> 6001 </note> 5723 6002 5724 6003 </sect1> … … 5729 6008 5730 6009 <para> 5731 These commands let you attach and retrieve string data toa5732 virtual machine or to a VirtualBox configuration, by specifying5733 <computeroutput>global</computeroutput> instead of a virtual5734 machine name. You must specify a key as a text string to associate5735 t he data with, which you can later use to retrieve it. For5736 example:6010 These commands enable you to attach and retrieve string data for a 6011 virtual machine or for a &product-name; configuration, by 6012 specifying <computeroutput>global</computeroutput> instead of a 6013 virtual machine name. You must specify a keyword as a text string 6014 to associate the data with, which you can later use to retrieve 6015 it. For example: 5737 6016 </para> 5738 6017 … … 5741 6020 5742 6021 <para> 5743 would associate the string "2006.01.01" with the key installdate 5744 for the virtual machine Fedora5, and "2006.02.02" on the machine 5745 SUSE10. You could retrieve the information as follows: 6022 This example would associate the string "2006.01.01" with the 6023 keyword installdate for the virtual machine Fedora5, and 6024 "2006.02.02" on the machine SUSE10. You could then retrieve the 6025 information as follows: 5746 6026 </para> 5747 6027 … … 5749 6029 5750 6030 <para> 5751 which would return6031 This would return the following: 5752 6032 </para> 5753 6033 … … 5759 6039 5760 6040 <para> 5761 You could retrieve the information for all key s as follows:6041 You could retrieve the information for all keywords as follows: 5762 6042 </para> 5763 6043 … … 5765 6045 5766 6046 <para> 5767 To remove a key , the <computeroutput>setextradata</computeroutput>5768 command must be run without specifying data, only the key. For6047 To remove a keyword, the <command>setextradata</command> command 6048 must be run without specifying data, only the keyword. For 5769 6049 example: 5770 6050 </para> … … 5780 6060 <para> 5781 6061 This command is used to change global settings which affect the 5782 entire VirtualBox installation. Some of these correspond to the 5783 settings in the "Global settings" dialog in the graphical user 5784 interface. The following properties are available: 6062 entire &product-name; installation. Some of these correspond to 6063 the settings in the <emphasis role="bold">Global 6064 Settings</emphasis> dialog in the graphical user interface. The 6065 following properties are available: 5785 6066 </para> 5786 6067 … … 5794 6075 <listitem> 5795 6076 <para> 5796 This specifies the default folder in which virtual machine6077 Specifies the default folder in which virtual machine 5797 6078 definitions are kept. See <xref linkend="vboxconfigdata" />. 5798 6079 </para> … … 5807 6088 <listitem> 5808 6089 <para> 5809 This specifies whether VirtualBoxwill make exclusive use of6090 Specifies whether &product-name; will make exclusive use of 5810 6091 the hardware virtualization extensions (Intel VT-x or AMD-V) 5811 6092 of the host system's processor. See … … 5825 6106 <listitem> 5826 6107 <para> 5827 This specifies which library to use when "external"5828 authentication has been selected for a particular virtual5829 machine. See<xref linkend="vbox-auth" />.6108 Specifies which library to use when external authentication 6109 has been selected for a particular virtual machine. See 6110 <xref linkend="vbox-auth" />. 5830 6111 </para> 5831 6112 </listitem> … … 5839 6120 <listitem> 5840 6121 <para> 5841 This specifies which library the web service uses to5842 authenticate users. For details about the VirtualBox web5843 service, please refer to the separate VirtualBox SDK5844 reference. See<xref6122 Specifies which library the web service uses to authenticate 6123 users. For details about the &product-name; web service, see 6124 the &product-name; SDK reference, 6125 <xref 5845 6126 linkend="VirtualBoxAPI" />. 5846 6127 </para> … … 5855 6136 <listitem> 5856 6137 <para> 5857 This specifies which library implements the VirtualBox5858 RemoteDesktop Extension.6138 Specifies which library implements the VirtualBox Remote 6139 Desktop Extension. 5859 6140 </para> 5860 6141 </listitem> … … 5868 6149 <listitem> 5869 6150 <para> 5870 This selects how many rotated (old) VM logs are kept.6151 Selects how many rotated VM logs are retained. 5871 6152 </para> 5872 6153 </listitem> … … 5880 6161 <listitem> 5881 6162 <para> 5882 This selects the path to the autostart database. See6163 Selects the path to the autostart database. See 5883 6164 <xref linkend="autostart" />. 5884 6165 </para> … … 5893 6174 <listitem> 5894 6175 <para> 5895 This selects the global default VM frontend setting. See6176 Selects the global default VM frontend setting. See 5896 6177 <xref linkend="vboxmanage-startvm" />. 5897 6178 </para> … … 5906 6187 <listitem> 5907 6188 <para> 5908 This configures the VBoxSVC release logging details. 5909 5910 <footnote> 5911 5912 <para> 5913 <ulink url="http://www.virtualbox.org/wiki/VBoxLogging">http://www.virtualbox.org/wiki/VBoxLogging</ulink>. 5914 </para> 5915 5916 </footnote> 6189 Configures the VBoxSVC release logging details. See 6190 <ulink url="http://www.virtualbox.org/wiki/VBoxLogging">http://www.virtualbox.org/wiki/VBoxLogging</ulink>. 6191 </para> 6192 </listitem> 6193 </varlistentry> 6194 6195 <varlistentry> 6196 <term> 6197 <computeroutput>proxymode</computeroutput> 6198 </term> 6199 6200 <listitem> 6201 <para> 6202 Configures the mode for an HTTP proxy server. 6203 </para> 6204 </listitem> 6205 </varlistentry> 6206 6207 <varlistentry> 6208 <term> 6209 <computeroutput>proxyurl</computeroutput> 6210 </term> 6211 6212 <listitem> 6213 <para> 6214 Configures the URL for an HTTP proxy server. Used when a 6215 manual proxy is configured using the 6216 <computeroutput>manual</computeroutput> setting of the 6217 <computeroutput>proxymode</computeroutput> property. 5917 6218 </para> 5918 6219 </listitem> … … 5962 6263 5963 6264 <para> 5964 The <computeroutput>usbfilter</computeroutput> commands are used 5965 for working with USB filters in virtual machines, or global 5966 filters which affect the whole VirtualBox setup. Global filters 5967 are applied before machine-specific filters, and may be used to 5968 prevent devices from being captured by any virtual machine. Global 5969 filters are always applied in a particular order, and only the 5970 first filter which fits a device is applied. So for example, if 5971 the first global filter says to hold (make available) a particular 5972 Kingston memory stick device and the second to ignore all Kingston 5973 devices, that memory stick will be available to any machine with 5974 an appropriate filter, but no other Kingston device will. 5975 </para> 5976 5977 <para> 5978 When creating a USB filter using <computeroutput>usbfilter 5979 add</computeroutput>, you must supply three or four mandatory 5980 parameters. The index specifies the position in the list at which 5981 the filter should be placed. If there is already a filter at that 5982 position, then it and the following ones will be shifted back one 5983 place. Otherwise the new filter will be added onto the end of the 5984 list. The <computeroutput>target</computeroutput> parameter 5985 selects the virtual machine that the filter should be attached to 5986 or use "global" to apply it to all virtual machines. 5987 <computeroutput>name</computeroutput> is a name for the new filter 5988 and for global filters, <computeroutput>action</computeroutput> 5989 says whether to allow VMs access to devices that fit the filter 5990 description ("hold") or not to give them access ("ignore"). In 5991 addition, you should specify parameters to filter by. You can find 5992 the parameters for devices attached to your system using 5993 <computeroutput>VBoxManage list usbhost</computeroutput>. Finally, 5994 you can specify whether the filter should be active, and for local 5995 filters, whether they are for local devices, remote (over an RDP 5996 connection) or either. 5997 </para> 5998 5999 <para> 6000 When you modify a USB filter using <computeroutput>usbfilter 6001 modify</computeroutput>, you must specify the filter by index and 6002 by target, which is either a virtual machine or "global". See the 6003 output of <computeroutput>VBoxManage list 6004 usbfilters</computeroutput> to find global filter indexes and 6005 <computeroutput>VBoxManage showvminfo</computeroutput> to find 6006 indexes for individual machines. The properties which can be 6007 changed are the same as for <computeroutput>usbfilter 6008 add</computeroutput>. To remove a filter, use 6009 <computeroutput>usbfilter remove</computeroutput> and specify the 6010 index and the target. 6011 </para> 6012 6013 <para> 6014 The following is a list of the additional 6015 <computeroutput>usbfilter add</computeroutput> and 6016 <computeroutput>usbfilter modify</computeroutput> options, with 6017 detailed explanations on how to use them. 6265 The <command>usbfilter</command> commands are used for working 6266 with USB filters in virtual machines, or global filters which 6267 affect the whole &product-name; setup. Global filters are applied 6268 before machine-specific filters, and may be used to prevent 6269 devices from being captured by any virtual machine. Global filters 6270 are always applied in a particular order, and only the first 6271 filter which fits a device is applied. For example, if the first 6272 global filter says to hold, or make available, a particular 6273 Kingston memory stick device and the second filter says to ignore 6274 all Kingston devices. That particular Kingston memory stick will 6275 be available to any machine with the appropriate filter, but no 6276 other Kingston device will. 6277 </para> 6278 6279 <para> 6280 When creating a USB filter using <command>usbfilter add</command>, 6281 you must supply three or four mandatory parameters. The index 6282 specifies the position in the list at which the filter should be 6283 placed. If there is already a filter at that position, then it and 6284 the following ones will be shifted back one place. Otherwise, the 6285 new filter will be added onto the end of the list. The 6286 <computeroutput>target</computeroutput> parameter selects the 6287 virtual machine that the filter should be attached to or use 6288 <computeroutput>global</computeroutput> to apply it to all virtual 6289 machines. <computeroutput>name</computeroutput> is a name for the 6290 new filter. For global filters, 6291 <computeroutput>action</computeroutput> says whether to allow VMs 6292 access to devices that fit the filter description (hold) or not to 6293 give them access (ignore). In addition, you should specify 6294 parameters to filter by. You can find the parameters for devices 6295 attached to your system using <command>VBoxManage list 6296 usbhost</command>. Finally, you can specify whether the filter 6297 should be active. For local filters, whether they are for local 6298 devices, remote devices over an RDP connection, or either. 6299 </para> 6300 6301 <para> 6302 When you modify a USB filter using <command>usbfilter 6303 modify</command>, you must specify the filter by index and by 6304 target, which is either a virtual machine or 6305 <computeroutput>global</computeroutput>. See the output of 6306 <command>VBoxManage list usbfilters</command> to find global 6307 filter indexes and <command>VBoxManage showvminfo</command> to 6308 find indexes for individual machines. The properties which can be 6309 changed are the same as for <command>usbfilter add</command>. To 6310 remove a filter, use <command>usbfilter remove</command> and 6311 specify the index and the target. 6312 </para> 6313 6314 <para> 6315 The following is a list of the additional <command>usbfilter 6316 add</command> and <command>usbfilter modify</command> options, 6317 with details of how to use them. 6018 6318 </para> 6019 6319 … … 6022 6322 <listitem> 6023 6323 <para> 6024 <computeroutput>--action ignore|hold</computeroutput> Specifies6025 whether devices that fit the filter description are allowed6026 a ccess by machines ("hold"), or have access denied ("ignore").6027 Applies to global filters only.6028 </para> 6029 </listitem> 6030 6031 <listitem> 6032 <para> 6033 <computeroutput>--active yes|no</computeroutput> Specifies6324 <computeroutput>--action ignore|hold</computeroutput>: 6325 Specifies whether devices that fit the filter description are 6326 allowed access by machines (hold), or have access denied 6327 (ignore). Applies to global filters only. 6328 </para> 6329 </listitem> 6330 6331 <listitem> 6332 <para> 6333 <computeroutput>--active yes|no</computeroutput>: Specifies 6034 6334 whether the USB Filter is active or temporarily disabled. For 6035 6335 <computeroutput>usbfilter create</computeroutput> the default … … 6040 6340 <listitem> 6041 6341 <para> 6042 <computeroutput>--vendorid 6043 <XXXX>|""</computeroutput>Specifies a vendor ID filter - 6044 the string representation for the exact matching has the form 6045 XXXX, where X is the hex digit (including leading zeroes). 6046 </para> 6047 </listitem> 6048 6049 <listitem> 6050 <para> 6051 <computeroutput>--productid 6052 <XXXX>|""</computeroutput>Specifies a product ID filter 6053 - The string representation for the exact matching has the 6054 form XXXX, where X is the hex digit (including leading 6055 zeroes). 6056 </para> 6057 </listitem> 6058 6059 <listitem> 6060 <para> 6061 <computeroutput>--revision 6062 <IIFF>|""</computeroutput>Specifies a revision ID filter 6063 - the string representation for the exact matching has the 6064 form IIFF, where I is the decimal digit of the integer part of 6065 the revision, and F is the decimal digit of its fractional 6066 part (including leading and trailing zeros). Note that for 6067 interval filters, it's best to use the hex form, because the 6068 revision is stored as a 16 bit packed BCD value; so the 6069 expression int:0x0100-0x0199 will match any revision from 1.0 6070 to 1.99 inclusive. 6342 <computeroutput>--vendorid <XXXX>|""</computeroutput>: 6343 Specifies a vendor ID filter. The string representation for an 6344 exact match has the form XXXX, where X is the hexadecimal 6345 digit, including leading zeroes. 6346 </para> 6347 </listitem> 6348 6349 <listitem> 6350 <para> 6351 <computeroutput>--productid <XXXX>|""</computeroutput>: 6352 Specifies a product ID filter. The string representation for 6353 an exact match has the form XXXX, where X is the hexadecimal 6354 digit, including leading zeroes. 6355 </para> 6356 </listitem> 6357 6358 <listitem> 6359 <para> 6360 <computeroutput>--revision <IIFF>|""</computeroutput>: 6361 Specifies a revision ID filter. The string representation for 6362 an exact match has the form IIFF, where I is the decimal digit 6363 of the integer part of the revision, and F is the decimal 6364 digit of its fractional part, including leading and trailing 6365 zeros. Note that for interval filters, it is best to use the 6366 hexadecimal form, because the revision is stored as a 16-bit 6367 packed BCD value. Therefore, the expression int:0x0100-0x0199 6368 will match any revision from 1.0 to 1.99 inclusive. 6071 6369 </para> 6072 6370 </listitem> … … 6075 6373 <para> 6076 6374 <computeroutput>--manufacturer 6077 <string>|""</computeroutput>Specifies a manufacturer ID 6078 filter, as a string. 6079 </para> 6080 </listitem> 6081 6082 <listitem> 6083 <para> 6084 <computeroutput>--product 6085 <string>|""</computeroutput>Specifies a product ID 6086 filter, as a string. 6087 </para> 6088 </listitem> 6089 6090 <listitem> 6091 <para> 6092 <computeroutput>--remote yes|no""</computeroutput>Specifies a 6093 remote filter - indicating whether the device is physically 6375 <string>|""</computeroutput>: Specifies a manufacturer 6376 ID filter, as a string. 6377 </para> 6378 </listitem> 6379 6380 <listitem> 6381 <para> 6382 <computeroutput>--product <string>|""</computeroutput>: 6383 Specifies a product ID filter, as a string. 6384 </para> 6385 </listitem> 6386 6387 <listitem> 6388 <para> 6389 <computeroutput>--remote yes|no""</computeroutput>: Specifies 6390 a remote filter, indicating whether the device is physically 6094 6391 connected to a remote VRDE client or to a local host machine. 6095 6392 Applies to VM filters only. … … 6100 6397 <para> 6101 6398 <computeroutput>--serialnumber 6102 <string>|""</computeroutput> Specifies a serial number6399 <string>|""</computeroutput>: Specifies a serial number 6103 6400 filter, as a string. 6104 6401 </para> … … 6108 6405 <para> 6109 6406 <computeroutput>--maskedinterfaces 6110 <XXXXXXXX></computeroutput> Specifies a masked interface6111 filter, for hiding one or more USB interfaces from the guest.6112 The value is a bit mask where the set bits correspond to the6113 USB interfaces that should be hidden, or masked off. This6114 feature only works on Linux hosts.6407 <XXXXXXXX></computeroutput>: Specifies a masked 6408 interface filter, for hiding one or more USB interfaces from 6409 the guest. The value is a bit mask where the set bits 6410 correspond to the USB interfaces that should be hidden, or 6411 masked off. This feature only works on Linux hosts. 6115 6412 </para> 6116 6413 </listitem> … … 6131 6428 6132 6429 <para> 6133 This command allows you to share folders on the host computer with6134 guest operating systems. For this, the guest systems must have a6135 version of the VirtualBox Guest Additions installed which supports6136 this functionality.6430 This command enables you to share folders on the host computer 6431 with guest operating systems. For this, the guest systems must 6432 have a version of the &product-name; Guest Additions installed 6433 which supports this functionality. 6137 6434 </para> 6138 6435 … … 6145 6442 <listitem> 6146 6443 <para> 6147 <computeroutput><uuid|vmname></computeroutput> Specifies 6148 the UUID or name of the VM whose guest operating system will 6149 be sharing folders with the host computer. Mandatory. 6150 </para> 6151 </listitem> 6152 6153 <listitem> 6154 <para> 6155 <computeroutput>--name <name></computeroutput> Specifies 6156 the name of the share. Each share has a unique name within the 6157 namespace of the host operating system. Mandatory. 6158 </para> 6159 </listitem> 6160 6161 <listitem> 6162 <para> 6163 <computeroutput>-hostpath <hostpath></computeroutput> 6444 <computeroutput><uuid|vmname></computeroutput>: 6445 Specifies the UUID or name of the VM whose guest operating 6446 system will be sharing folders with the host computer. 6447 Mandatory. 6448 </para> 6449 </listitem> 6450 6451 <listitem> 6452 <para> 6453 <computeroutput>--name <name></computeroutput>: 6454 Specifies the name of the share. Each share has a unique name 6455 within the namespace of the host operating system. Mandatory. 6456 </para> 6457 </listitem> 6458 6459 <listitem> 6460 <para> 6461 <computeroutput>-hostpath <hostpath></computeroutput>: 6164 6462 Specifies the absolute path on the host operating system of 6165 the folder/directory to be shared with the guest operating6166 system.Mandatory.6167 </para> 6168 </listitem> 6169 6170 <listitem> 6171 <para> 6172 <computeroutput>-transient</computeroutput> Specifies that the6173 share is 'transient', meaning that it can be added and removed6174 at runtime and does not persist after the VM has stopped.6175 Optional.6176 </para> 6177 </listitem> 6178 6179 <listitem> 6180 <para> 6181 <computeroutput>-readonly</computeroutput> Specifies that the6463 the directory to be shared with the guest operating system. 6464 Mandatory. 6465 </para> 6466 </listitem> 6467 6468 <listitem> 6469 <para> 6470 <computeroutput>-transient</computeroutput>: Specifies that 6471 the share is transient, meaning that it can be added and 6472 removed at runtime and does not persist after the VM has 6473 stopped. Optional. 6474 </para> 6475 </listitem> 6476 6477 <listitem> 6478 <para> 6479 <computeroutput>-readonly</computeroutput>: Specifies that the 6182 6480 share has only read-only access to files at the host path. 6183 6481 </para> … … 6185 6483 <para> 6186 6484 By default, shared folders have read/write access to the files 6187 at the host path. More specifically, on Linux distros - shared 6188 folders are mounted with 770 io permissions with root user and 6189 vboxsf as the group, and using this option the io permissions 6190 change to 700. Optional. 6191 </para> 6192 </listitem> 6193 6194 <listitem> 6195 <para> 6196 <computeroutput>-automount</computeroutput> Specifies that the 6197 share will be automatically mounted. On Linux distros, this 6198 will be to either /media/USER/sf_<name> or 6199 /media/sf_<name> - depending on your guest OS. Where 6200 <name> is the share name. Optional. 6485 on the host path. On Linux distributions, shared folders are 6486 mounted with 770 file permissions with root user and vboxsf as 6487 the group. Using this option the file permissions change to 6488 700. Optional. 6489 </para> 6490 </listitem> 6491 6492 <listitem> 6493 <para> 6494 <computeroutput>-automount</computeroutput>: Specifies that 6495 the share will be automatically mounted. On Linux 6496 distributions, this will be to either 6497 <computeroutput>/media/USER/sf_<name></computeroutput> 6498 or <computeroutput>/media/sf_<name></computeroutput>, 6499 where <name> is the share named. The actual location 6500 depends on the guest OS. Optional. 6201 6501 </para> 6202 6502 </listitem> … … 6211 6511 6212 6512 <para> 6213 This command allows you to delete shared folders on the host6513 This command enables you to delete shared folders on the host 6214 6514 computer shares with the guest operating systems. For this, the 6215 guest systems must have a version of the VirtualBoxGuest6515 guest systems must have a version of the &product-name; Guest 6216 6516 Additions installed which supports this functionality. 6217 6517 </para> … … 6225 6525 <listitem> 6226 6526 <para> 6227 <computeroutput><uuid|vmname></computeroutput> Specifies6228 the UUID or name of the VM whose guest operating system is6229 s haring folders with the host computer. Mandatory.6230 </para> 6231 </listitem> 6232 6233 <listitem> 6234 <para> 6235 <computeroutput>--name <name></computeroutput> Specifies6236 the name of the share to be removed. Each share has a unique6237 name within the namespace of the host operating system.6238 Mandatory.6239 </para> 6240 </listitem> 6241 6242 <listitem> 6243 <para> 6244 <computeroutput>-transient</computeroutput> Specifies that the6245 share is 'transient', meaning that it can be added and removed6246 at runtime and does not persist after the VM has stopped.6247 Optional.6527 <computeroutput><uuid|vmname></computeroutput>: 6528 Specifies the UUID or name of the VM whose guest operating 6529 system is sharing folders with the host computer. Mandatory. 6530 </para> 6531 </listitem> 6532 6533 <listitem> 6534 <para> 6535 <computeroutput>--name <name></computeroutput>: 6536 Specifies the name of the share to be removed. Each share has 6537 a unique name within the namespace of the host operating 6538 system. Mandatory. 6539 </para> 6540 </listitem> 6541 6542 <listitem> 6543 <para> 6544 <computeroutput>-transient</computeroutput>: Specifies that 6545 the share is transient, meaning that it can be added and 6546 removed at runtime and does not persist after the VM has 6547 stopped. Optional. 6248 6548 </para> 6249 6549 </listitem> … … 6262 6562 6263 6563 <para> 6264 The "guestproperty" commands allow you to get or set properties of6265 a running virtual machine. See6266 <xref linkend="guestadd-guestprops" /> for an introduction. As6267 explained there, guest properties are arbitrary key/value string6268 pairs which can be written to and read from by either the guest or6269 the host, so they can be used as a low-volume communication6270 channel for strings, provided that a guest is running and has the6271 Guest Additions installed. In addition, a number of values whose6272 keys begin with "/VirtualBox/" are automatically set and6273 maintained by the Guest Additions.6564 The <command>guestproperty</command> commands enable you to get or 6565 set properties of a running virtual machine. See 6566 <xref linkend="guestadd-guestprops" />. Guest properties are 6567 arbitrary keyword-value string pairs which can be written to and 6568 read from by either the guest or the host, so they can be used as 6569 a low-volume communication channel for strings, provided that a 6570 guest is running and has the Guest Additions installed. In 6571 addition, a number of values whose keywords begin with 6572 <computeroutput>/VirtualBox/</computeroutput>are automatically set 6573 and maintained by the Guest Additions. 6274 6574 </para> 6275 6575 … … 6277 6577 The following subcommands are available, where 6278 6578 <computeroutput><vm></computeroutput> can either be a VM 6279 name or a VM UUID, as with the other VBoxManage commands: 6579 name or a VM UUID, as with the other <command>VBoxManage</command> 6580 commands: 6280 6581 </para> 6281 6582 … … 6285 6586 <para> 6286 6587 <computeroutput>enumerate <vm> [--patterns 6287 <pattern>]</computeroutput>: This lists all the guest6588 <pattern>]</computeroutput>: Lists all the guest 6288 6589 properties that are available for the given VM, including the 6289 6590 value. This list will be very limited if the guest's service 6290 process cannot be contacted, e.g.because the VM is not6591 process cannot be contacted, for example because the VM is not 6291 6592 running or the Guest Additions are not installed. 6292 6593 </para> … … 6303 6604 <listitem> 6304 6605 <para> 6305 <computeroutput>*</computeroutput> (asterisk): represents6306 any number of characters ; for example,6606 <computeroutput>*</computeroutput> (asterisk): Represents 6607 any number of characters. For example, 6307 6608 "<computeroutput>/VirtualBox*</computeroutput>" would 6308 6609 match all properties beginning with "/VirtualBox". … … 6313 6614 <para> 6314 6615 <computeroutput>?</computeroutput> (question mark): 6315 represents a single arbitrary character; for example,6616 Represents a single arbitrary character. For example, 6316 6617 "<computeroutput>fo?</computeroutput>" would match both 6317 6618 "foo" and "for". … … 6321 6622 <listitem> 6322 6623 <para> 6323 <computeroutput>|</computeroutput> (pipe symbol): can be6324 used to specify multiple alternative patterns ; for6624 <computeroutput>|</computeroutput> (pipe symbol): Can be 6625 used to specify multiple alternative patterns. For 6325 6626 example, "<computeroutput>s*|t*</computeroutput>" would 6326 6627 match anything starting with either "s" or "t". … … 6333 6634 <listitem> 6334 6635 <para> 6335 <computeroutput>get <vm> <property> 6336 </computeroutput>: This retrieves the value of a single 6337 property only. If the property cannot be found (e.g. because 6338 the guest is not running), this will print 6636 <computeroutput>get <vm> 6637 <property></computeroutput>: Retrieves the value of a 6638 single property only. If the property cannot be found, for 6639 example because the guest is not running, the following 6640 message is shown: 6641 </para> 6339 6642 6340 6643 <screen>No value set!</screen> 6341 </para>6342 6644 </listitem> 6343 6645 … … 6345 6647 <para> 6346 6648 <computeroutput>set <vm> <property> [<value> 6347 [--flags <flags>]]</computeroutput>: This allows you to6348 set a guest property by specifying the keyand value. If6649 [--flags <flags>]]</computeroutput>: Enables you to set 6650 a guest property by specifying the keyword and value. If 6349 6651 <computeroutput><value></computeroutput> is omitted, the 6350 6652 property is deleted. With … … 6366 6668 <para> 6367 6669 <computeroutput>TRANSRESET</computeroutput>: The value 6368 will be deleted as soon as the VM restarts and/or exits.6670 will be deleted as soon as the VM restarts or exits. 6369 6671 </para> 6370 6672 </listitem> … … 6399 6701 <para> 6400 6702 <computeroutput>wait <vm> <pattern> --timeout 6401 <timeout></computeroutput>: This waits for a particular6402 value described by "pattern"to change or to be deleted or6403 created. The pattern rules are the same as for the "enumerate"6404 subcommand above.6703 <timeout></computeroutput>: Waits for a particular value 6704 described by the pattern string to change or to be deleted or 6705 created. The pattern rules are the same as for the 6706 <command>enumerate</command> subcommand. 6405 6707 </para> 6406 6708 </listitem> … … 6409 6711 <para> 6410 6712 <computeroutput>delete <vm> 6411 <property></computeroutput>: Deletes a formerly set6412 guest property.6713 <property></computeroutput>: Deletes a guest property 6714 which has been set previously. 6413 6715 </para> 6414 6716 </listitem> … … 6423 6725 6424 6726 <para> 6425 The <com puteroutput>guestcontrol</computeroutput> commands enable6426 control of theguest from the host. See6727 The <command>guestcontrol</command> commands enable control of the 6728 guest from the host. See 6427 6729 <xref 6428 6730 linkend="guestadd-guestcontrol" /> for an introduction. … … 6430 6732 6431 6733 <para> 6432 guestcontrol has two sets of subcommands. The first set requires 6433 guest credentials to be specified, the second does not. 6434 </para> 6435 6436 <para> 6437 The first set of subcommands is of the form: 6734 The <command>guestcontrol</command> command has two sets of 6735 subcommands. The first set requires guest credentials to be 6736 specified, the second does not. 6737 </para> 6738 6739 <para> 6740 The first set of subcommands is of the following form: 6438 6741 </para> 6439 6742 … … 6446 6749 6447 6750 <para> 6448 The "common-options" are:6751 The common options are as follows: 6449 6752 </para> 6450 6753 … … 6457 6760 6458 6761 <para> 6459 Where details of the common options for the first set of6460 subcommands are:6762 The common options for the first set of subcommands are explained 6763 in the following list. 6461 6764 </para> 6462 6765 … … 6544 6847 6545 6848 <para> 6546 The first set of subcommands :6849 The first set of subcommands are as follows: 6547 6850 </para> 6548 6851 … … 6551 6854 <listitem> 6552 6855 <para> 6553 < emphasis role="bold"><computeroutput>run</computeroutput></emphasis>6554 Executes a guest program - forwarding stdout, stderr and stdin6555 to/from thehost until it completes.6856 <computeroutput>run</computeroutput>: Executes a guest 6857 program, forwarding stdout, stderr, and stdin to and from the 6858 host until it completes. 6556 6859 </para> 6557 6860 … … 6589 6892 <para> 6590 6893 Specifies the absolute path of the executable on the 6591 guest OS file system. Mandatory. e.g.:6894 guest OS file system. Mandatory. For example: 6592 6895 <computeroutput>C:\Windows\System32\calc.exe</computeroutput>. 6593 6896 </para> … … 6602 6905 <listitem> 6603 6906 <para> 6604 Specifies the maximum time (microseconds) that the 6605 executable can run, during which VBoxManage receives its 6606 output. Optional. If unspecified, VBoxManage waits 6607 indefinitely for the process to end, or an error occurs. 6907 Specifies the maximum time, in microseconds, that the 6908 executable can run, during which 6909 <command>VBoxManage</command> receives its output. 6910 Optional. If unspecified, <command>VBoxManage</command> 6911 waits indefinitely for the process to end, or an error 6912 occurs. 6608 6913 </para> 6609 6914 </listitem> … … 6618 6923 <listitem> 6619 6924 <para> 6620 Sets /modifies/unsets environment variable(s)in the6925 Sets, modifies, and unsets environment variables in the 6621 6926 environment in which the program will run. Optional. 6622 6927 </para> … … 6625 6930 The guest process is created with the standard default 6626 6931 guest OS environment. Use this option to modify that 6627 default environment. To set /modify a variable use:6932 default environment. To set or modify a variable use: 6628 6933 <computeroutput><NAME>=<VALUE></computeroutput>. 6629 6934 To unset a variable use: … … 6632 6937 6633 6938 <para> 6634 Any spaces in names/values should be enclosed by quotes. 6635 </para> 6636 6637 <para> 6638 To set/modify/unset multiple variables, use multiple 6639 instances of the 6939 Any spaces in names and values should be enclosed by 6940 quotes. 6941 </para> 6942 6943 <para> 6944 To set, modify, and unset multiple variables, use 6945 multiple instances of the 6640 6946 <computeroutput>--E|--putenv</computeroutput> option. 6641 6947 </para> … … 6650 6956 <listitem> 6651 6957 <para> 6652 Disables escaped double quoting (e.g. \"fred\")on6958 Disables escaped double quoting, such as \"fred\", on 6653 6959 arguments passed to the executed program. Optional. 6654 6960 </para> … … 6688 6994 <listitem> 6689 6995 <para> 6690 Does not wait /waits until the guest process ends and6996 Does not wait or waits until the guest process ends and 6691 6997 receives its exit code and reason/flags. In the case of 6692 --wait-stdout - while the process runs, VBoxManage 6693 receives its stdout. Optional. 6998 <computeroutput>--wait-stdout</computeroutput>, 6999 <command>VBoxManage</command> receives its stdout while 7000 the process runs. Optional. 6694 7001 </para> 6695 7002 </listitem> … … 6703 7010 <listitem> 6704 7011 <para> 6705 Does not wait/waits until the guest process ends and 6706 receives its exit code and reason/flags. In case of 6707 --wait-stderr - while the process runs, VBoxManage 6708 receives its stderr. Optional. 7012 Does not wait or waits until the guest process ends and 7013 receives its exit code, error messages, and flags. In 7014 the case of 7015 <computeroutput>--wait-stderr</computeroutput>, 7016 <command>VBoxManage</command> receives its stderr while 7017 the process runs. Optional. 6709 7018 </para> 6710 7019 </listitem> … … 6748 7057 <listitem> 6749 7058 <para> 6750 Specifies program name, followed by one or more7059 Specifies the program name, followed by one or more 6751 7060 arguments to pass to the program. Optional. 6752 7061 </para> 6753 7062 6754 7063 <para> 6755 Note: Any spaces in arguments should be enclosed by 6756 quotes. 7064 Any spaces in arguments should be enclosed by quotes. 6757 7065 </para> 6758 7066 </listitem> … … 6761 7069 </variablelist> 6762 7070 6763 <para> 6764 <note> 6765 <para> 6766 On Windows there are certain limitations for graphical 6767 applications; please see <xref linkend="KnownIssues" /> 6768 for more information. 6769 </para> 6770 </note> 6771 6772 Examples: 7071 <note> 7072 <para> 7073 On Windows there are certain limitations for graphical 7074 applications. See <xref linkend="KnownIssues" />. 7075 </para> 7076 </note> 7077 7078 <para> 7079 Examples of using the <command>guestcontrol run</command> 7080 command are as follows: 7081 </para> 6773 7082 6774 7083 <screen>VBoxManage --nologo guestcontrol "My VM" run --exe "/bin/ls" … … 6778 7087 --username foo --passwordfile bar.txt --wait-exit --wait-stdout</screen> 6779 7088 7089 <para> 6780 7090 Note that the double backslashes in the second example are 6781 only required on Unix hosts. 6782 </para> 6783 6784 <para> 6785 <note> 6786 <para> 6787 For certain commands a user name of an existing user 6788 account on the guest must be specified; anonymous 6789 executions are not supported for security reasons. A user 6790 account password, however, is optional and depends on the 6791 guest's OS security policy or rules. If no password is 6792 specified for a given user name, an empty password will be 6793 used. On certain OSes like Windows the security policy may 6794 needs to be adjusted in order to allow user accounts with 6795 an empty password set. Also, global domain rules might 6796 apply and therefore cannot be changed. 6797 </para> 6798 </note> 6799 </para> 6800 6801 <para> 6802 Starting at VirtualBox 4.1.2 guest process execution by 6803 default is limited to serve up to 5 guest processes at a time. 6804 If a new guest process gets started which would exceed this 6805 limit, the oldest not running guest process will be discarded 6806 in order to be able to run that new process. Also, retrieving 6807 output from this old guest process will not be possible 6808 anymore then. If all 5 guest processes are still active and 6809 running, starting a new guest process will result in an 6810 appropriate error message. 6811 </para> 6812 6813 <para> 6814 To raise or lower the guest process execution limit, either 6815 the guest property 6816 <computeroutput>/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept</computeroutput> 6817 or VBoxService' command line by specifying 6818 <computeroutput>--control-procs-max-kept</computeroutput> 6819 needs to be modified. A restart of the guest OS is required 6820 afterwards. To serve unlimited guest processes, a value of 6821 <computeroutput>0</computeroutput> needs to be set (not 6822 recommended). 6823 </para> 6824 </listitem> 6825 6826 <listitem> 6827 <para> 6828 <emphasis role="bold"><computeroutput>start</computeroutput></emphasis> 6829 Executes a guest program until it completes. 6830 </para> 6831 6832 <screen>VBoxManage guestcontrol <uuid|vmname> start [common-options] 6833 [--exe <path to executable>] [--timeout <msec>] 6834 [-E|--putenv <NAME>[=<VALUE>]] [--unquoted-args] 6835 [--ignore-operhaned-processes] [--profile] 6836 -- <program/arg0> [argument1] ... [argumentN]] 6837 </screen> 6838 6839 <para> 6840 Where the options are: 6841 </para> 6842 6843 <variablelist> 6844 6845 <varlistentry> 6846 <term> 6847 <computeroutput><uuid|vmname></computeroutput> 6848 </term> 6849 6850 <listitem> 6851 <para> 6852 Specifies the VM UUID or VM name. Mandatory. 6853 </para> 6854 </listitem> 6855 </varlistentry> 6856 6857 <varlistentry> 6858 <term> 6859 <computeroutput>--exe <path to 6860 executable></computeroutput> 6861 </term> 6862 6863 <listitem> 6864 <para> 6865 Specifies the absolute path of the executable on the 6866 guest OS file system. Mandatory. e.g.: 6867 <computeroutput>C:\Windows\System32\calc.exe</computeroutput> 6868 </para> 6869 </listitem> 6870 </varlistentry> 6871 6872 <varlistentry> 6873 <term> 6874 <computeroutput>--timeout <msec></computeroutput> 6875 </term> 6876 6877 <listitem> 6878 <para> 6879 Specifies the maximum time (microseconds) that the 6880 executable can run. Optional. If unspecified, VBoxManage 6881 waits indefinitely for the process to end, or an error 6882 occurs. 6883 </para> 6884 </listitem> 6885 </varlistentry> 6886 6887 <varlistentry> 6888 <term> 6889 <computeroutput>-E|--putenv <NAME>=<VALUE> 6890 </computeroutput> 6891 </term> 6892 6893 <listitem> 6894 <para> 6895 Sets/modifies/unsets environment variable(s) in the 6896 environment in which the program will run. Optional. 6897 </para> 6898 6899 <para> 6900 The guest process is created with the standard default 6901 guest OS environment. Use this option to modify that 6902 default environment. To set/modify a variable use: 6903 <computeroutput><NAME>=<VALUE></computeroutput>. 6904 To unset a variable use: 6905 <computeroutput><NAME>=</computeroutput> 6906 </para> 6907 6908 <para> 6909 Any spaces in names/values should be enclosed by quotes. 6910 </para> 6911 6912 <para> 6913 To set/modify/unset multiple variables, use multiple 6914 instances of the 6915 <computeroutput>--E|--putenv</computeroutput> option. 6916 </para> 6917 </listitem> 6918 </varlistentry> 6919 6920 <varlistentry> 6921 <term> 6922 <computeroutput>--unquoted-args</computeroutput> 6923 </term> 6924 6925 <listitem> 6926 <para> 6927 Disables escaped double quoting (e.g. \"fred\") on 6928 arguments passed to the executed program. Optional. 6929 </para> 6930 </listitem> 6931 </varlistentry> 6932 6933 <varlistentry> 6934 <term> 6935 <computeroutput>--ignore-operhaned-processes</computeroutput> 6936 </term> 6937 6938 <listitem> 6939 <para> 6940 Ignores orphaned processes. Not yet implemented. 6941 Optional. 6942 </para> 6943 </listitem> 6944 </varlistentry> 6945 6946 <varlistentry> 6947 <term> 6948 <computeroutput>--profile</computeroutput> 6949 </term> 6950 6951 <listitem> 6952 <para> 6953 Use a profile. Not yet implemented. Optional. 6954 </para> 6955 </listitem> 6956 </varlistentry> 6957 6958 <varlistentry> 6959 <term> 6960 <computeroutput>[-- <program/arg0> 6961 [<argument1>] ... 6962 [<argumentN>]]</computeroutput> 6963 </term> 6964 6965 <listitem> 6966 <para> 6967 Specifies program name, followed by one or more 6968 arguments to pass to the program. Optional. 6969 </para> 6970 6971 <para> 6972 Note: Any spaces in arguments should be enclosed by 6973 quotes. 6974 </para> 6975 </listitem> 6976 </varlistentry> 6977 6978 </variablelist> 7091 only required on UNIX hosts. 7092 </para> 6979 7093 6980 7094 <note> 6981 7095 <para> 6982 On Windows there are certain limitations for graphical6983 applications; please see <xref linkend="KnownIssues" /> for6984 more information.6985 </para>6986 </note>6987 6988 <para>6989 Examples:6990 6991 <screen>VBoxManage --nologo guestcontrol "My VM" start --exe "/bin/ls"6992 --username foo --passwordfile bar.txt --wait-exit --wait-stdout -- -l /usr</screen>6993 6994 <screen>VBoxManage --nologo guestcontrol "My VM" start --exe "c:\\windows\\system32\\ipconfig.exe"6995 --username foo --passwordfile bar.txt --wait-exit --wait-stdout</screen>6996 6997 Note that the double backslashes in the second example are6998 only required on Unix hosts.6999 </para>7000 7001 <note>7002 <para>7003 7096 For certain commands a user name of an existing user account 7004 on the guest must be specified ; anonymous executions are not7097 on the guest must be specified. Anonymous executions are not 7005 7098 supported for security reasons. A user account password, 7006 7099 however, is optional and depends on the guest's OS security … … 7015 7108 7016 7109 <para> 7017 Starting at VirtualBox4.1.2 guest process execution by7018 default is limited to serve up to 5 guest processes at a time.7019 If a new guest process gets started which would exceed this7020 limit, the oldest not running guest process will be discarded7021 in order to be able to run that new process. Also, retrieving7022 output from this old guest process will not be possible7023 anymore then. If all 5 guest processes are still active and7024 running, starting a new guest process will result in an7025 appropriate error message.7110 Starting at &product-name; 4.1.2 guest process execution by 7111 default is limited to serve up to five guest processes at a 7112 time. If a new guest process gets started which would exceed 7113 this limit, the oldest not running guest process will be 7114 discarded in order to be able to run that new process. Also, 7115 retrieving output from this old guest process will not be 7116 possible anymore then. If all five guest processes are still 7117 active and running, starting a new guest process will result 7118 in an appropriate error message. 7026 7119 </para> 7027 7120 7028 7121 <para> 7029 7122 To raise or lower the guest process execution limit, either 7030 the guest property7123 use the guest property 7031 7124 <computeroutput>/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept</computeroutput> 7032 or VBoxService'command line by specifying7125 or <command>VBoxService</command> command line by specifying 7033 7126 <computeroutput>--control-procs-max-kept</computeroutput> 7034 7127 needs to be modified. A restart of the guest OS is required 7035 7128 afterwards. To serve unlimited guest processes, a value of 7036 <computeroutput>0</computeroutput> needs to be set (not 7037 recommended). 7038 </para> 7039 </listitem> 7040 7041 <listitem> 7042 <para> 7043 <emphasis role="bold"><computeroutput>copyfrom</computeroutput></emphasis> 7044 Copies files from the guest to the host file system. (Note - 7045 only with Guest Additions 4.0 or later installed). 7129 <computeroutput>0</computeroutput> needs to be set, but this 7130 is not recommended. 7131 </para> 7132 </listitem> 7133 7134 <listitem> 7135 <para> 7136 <computeroutput>start</computeroutput>: Executes a guest 7137 program until it completes. 7138 </para> 7139 7140 <screen>VBoxManage guestcontrol <uuid|vmname> start [common-options] 7141 [--exe <path to executable>] [--timeout <msec>] 7142 [-E|--putenv <NAME>[=<VALUE>]] [--unquoted-args] 7143 [--ignore-operhaned-processes] [--profile] 7144 -- <program/arg0> [argument1] ... [argumentN]] 7145 </screen> 7146 7147 <para> 7148 Where the options are as follows: 7149 </para> 7150 7151 <variablelist> 7152 7153 <varlistentry> 7154 <term> 7155 <computeroutput><uuid|vmname></computeroutput> 7156 </term> 7157 7158 <listitem> 7159 <para> 7160 Specifies the VM UUID or VM name. Mandatory. 7161 </para> 7162 </listitem> 7163 </varlistentry> 7164 7165 <varlistentry> 7166 <term> 7167 <computeroutput>--exe <path to 7168 executable></computeroutput> 7169 </term> 7170 7171 <listitem> 7172 <para> 7173 Specifies the absolute path of the executable on the 7174 guest OS file system. Mandatory. For example: 7175 <computeroutput>C:\Windows\System32\calc.exe</computeroutput> 7176 </para> 7177 </listitem> 7178 </varlistentry> 7179 7180 <varlistentry> 7181 <term> 7182 <computeroutput>--timeout <msec></computeroutput> 7183 </term> 7184 7185 <listitem> 7186 <para> 7187 Specifies the maximum time, in microseconds, that the 7188 executable can run. Optional. If unspecified, 7189 <command>VBoxManage</command> waits indefinitely for the 7190 process to end, or an error occurs. 7191 </para> 7192 </listitem> 7193 </varlistentry> 7194 7195 <varlistentry> 7196 <term> 7197 <computeroutput>-E|--putenv <NAME>=<VALUE> 7198 </computeroutput> 7199 </term> 7200 7201 <listitem> 7202 <para> 7203 Sets, modifies, and unsets environment variables in the 7204 environment in which the program will run. Optional. 7205 </para> 7206 7207 <para> 7208 The guest process is created with the standard default 7209 guest OS environment. Use this option to modify that 7210 default environment. To set or modify a variable use: 7211 <computeroutput><NAME>=<VALUE></computeroutput>. 7212 To unset a variable use: 7213 <computeroutput><NAME>=</computeroutput> 7214 </para> 7215 7216 <para> 7217 Any spaces in names and values should be enclosed by 7218 quotes. 7219 </para> 7220 7221 <para> 7222 To set, modify, or unset multiple variables, use 7223 multiple instances of the 7224 <computeroutput>--E|--putenv</computeroutput> option. 7225 </para> 7226 </listitem> 7227 </varlistentry> 7228 7229 <varlistentry> 7230 <term> 7231 <computeroutput>--unquoted-args</computeroutput> 7232 </term> 7233 7234 <listitem> 7235 <para> 7236 Disables escaped double quoting, such as \"fred\", on 7237 arguments passed to the executed program. Optional. 7238 </para> 7239 </listitem> 7240 </varlistentry> 7241 7242 <varlistentry> 7243 <term> 7244 <computeroutput>--ignore-operhaned-processes</computeroutput> 7245 </term> 7246 7247 <listitem> 7248 <para> 7249 Ignores orphaned processes. Not yet implemented. 7250 Optional. 7251 </para> 7252 </listitem> 7253 </varlistentry> 7254 7255 <varlistentry> 7256 <term> 7257 <computeroutput>--profile</computeroutput> 7258 </term> 7259 7260 <listitem> 7261 <para> 7262 Use a profile. Not yet implemented. Optional. 7263 </para> 7264 </listitem> 7265 </varlistentry> 7266 7267 <varlistentry> 7268 <term> 7269 <computeroutput>[-- <program/arg0> 7270 [<argument1>] ... 7271 [<argumentN>]]</computeroutput> 7272 </term> 7273 7274 <listitem> 7275 <para> 7276 Specifies the program name, followed by one or more 7277 arguments to pass to the program. Optional. 7278 </para> 7279 7280 <para> 7281 Any spaces in arguments should be enclosed by quotes. 7282 </para> 7283 </listitem> 7284 </varlistentry> 7285 7286 </variablelist> 7287 7288 <note> 7289 <para> 7290 On Windows there are certain limitations for graphical 7291 applications. See <xref linkend="KnownIssues" />. 7292 </para> 7293 </note> 7294 7295 <para> 7296 Examples of using the <command>guestcontrol start</command> 7297 command are as follows: 7298 </para> 7299 7300 <screen>VBoxManage --nologo guestcontrol "My VM" start --exe "/bin/ls" 7301 --username foo --passwordfile bar.txt --wait-exit --wait-stdout -- -l /usr</screen> 7302 7303 <screen>VBoxManage --nologo guestcontrol "My VM" start --exe "c:\\windows\\system32\\ipconfig.exe" 7304 --username foo --passwordfile bar.txt --wait-exit --wait-stdout</screen> 7305 7306 <para> 7307 Note that the double backslashes in the second example are 7308 only required on UNIX hosts. 7309 </para> 7310 7311 <note> 7312 <para> 7313 For certain commands a user name of an existing user account 7314 on the guest must be specified. Anonymous executions are not 7315 supported for security reasons. A user account password, 7316 however, is optional and depends on the guest's OS security 7317 policy or rules. If no password is specified for a given 7318 user name, an empty password will be used. On certain OSes 7319 like Windows the security policy may needs to be adjusted in 7320 order to allow user accounts with an empty password set. 7321 Also, global domain rules might apply and therefore cannot 7322 be changed. 7323 </para> 7324 </note> 7325 7326 <para> 7327 Starting at &product-name; 4.1.2 guest process execution by 7328 default is limited to serve up to five guest processes at a 7329 time. If a new guest process gets started which would exceed 7330 this limit, the oldest not running guest process will be 7331 discarded in order to be able to run that new process. Also, 7332 retrieving output from this old guest process will not be 7333 possible anymore then. If all five guest processes are still 7334 active and running, starting a new guest process will result 7335 in an appropriate error message. 7336 </para> 7337 7338 <para> 7339 To raise or lower the guest process execution limit, either 7340 use the guest property 7341 <computeroutput>/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept</computeroutput> 7342 or <command>VBoxService</command> command line by specifying 7343 <computeroutput>--control-procs-max-kept</computeroutput> 7344 needs to be modified. A restart of the guest OS is required 7345 afterwards. To serve unlimited guest processes, a value of 7346 <computeroutput>0</computeroutput> needs to be set, but this 7347 is not recommended. 7348 </para> 7349 </listitem> 7350 7351 <listitem> 7352 <para> 7353 <computeroutput>copyfrom</computeroutput>: Copies files from 7354 the guest to the host file system. Only available with Guest 7355 Additions 4.0 or later installed. 7046 7356 </para> 7047 7357 … … 7052 7362 7053 7363 <para> 7054 Where the parameters are :7364 Where the parameters are as follows: 7055 7365 </para> 7056 7366 … … 7089 7399 <listitem> 7090 7400 <para> 7091 Enables recursive copying of files /directories from the7092 specified guest file system directory. Optional.7401 Enables recursive copying of files and directories from 7402 the specified guest file system directory. Optional. 7093 7403 </para> 7094 7404 </listitem> … … 7104 7414 <para> 7105 7415 Specifies the absolute path of the host file system 7106 destination directory. Mandatory. e.g.7416 destination directory. Mandatory. For example: 7107 7417 <computeroutput>C:\Temp</computeroutput>. 7108 7418 </para> … … 7118 7428 <listitem> 7119 7429 <para> 7120 Specifies the absolute path (s) of guest file system7121 file(s) to be copied. Mandatory. e.g.7430 Specifies the absolute paths of guest file system files 7431 to be copied. Mandatory. For example: 7122 7432 <computeroutput>C:\Windows\System32\calc.exe</computeroutput>. 7123 Wildcards can be used in the expression (s), e.g.7433 Wildcards can be used in the expressions. For example: 7124 7434 <computeroutput>C:\Windows\System*\*.dll</computeroutput>. 7125 7435 </para> … … 7132 7442 <listitem> 7133 7443 <para> 7134 < emphasis role="bold"><computeroutput>copyto</computeroutput></emphasis>7135 Copies files from the host to the guest file system. (Note -7136 only with Guest Additions 4.0 or later installed).7444 <computeroutput>copyto</computeroutput>: Copies files from the 7445 host to the guest file system. Only available with Guest 7446 Additions 4.0 or later installed. 7137 7447 </para> 7138 7448 … … 7143 7453 7144 7454 <para> 7145 Where the parameters are :7455 Where the parameters are as follows: 7146 7456 </para> 7147 7457 … … 7180 7490 <listitem> 7181 7491 <para> 7182 Enables recursive copying of files /directories from the7183 specified host file system directory(ies). Optional.7492 Enables recursive copying of files and directories from 7493 the specified host file system directory. Optional. 7184 7494 </para> 7185 7495 </listitem> … … 7195 7505 <para> 7196 7506 Specifies the absolute path of the guest file system 7197 destination directory. Mandatory. e.g.7507 destination directory. Mandatory. For example: 7198 7508 <computeroutput>C:\Temp</computeroutput>. 7199 7509 </para> … … 7209 7519 <listitem> 7210 7520 <para> 7211 Specifies the absolute path (s) of host file system7212 file(s) to be copied. Mandatory. e.g.7521 Specifies the absolute paths of host file system files 7522 to be copied. Mandatory. For example: 7213 7523 <computeroutput>C:\Windows\System32\calc.exe</computeroutput>. 7214 Wildcards can be used in the expression (s), e.g.7524 Wildcards can be used in the expressions. For example: 7215 7525 <computeroutput>C:\Windows\System*\*.dll</computeroutput>. 7216 7526 </para> … … 7223 7533 <listitem> 7224 7534 <para> 7225 < emphasis role="bold"><computeroutput>md|mkdir|createdir|createdirectory</computeroutput></emphasis>7226 Creates one or more director y(ies) on the guest file system.7227 (Note - only with Guest Additions 4.0 or later installed).7535 <computeroutput>md|mkdir|createdir|createdirectory</computeroutput>: 7536 Creates one or more directories on the guest file system. Only 7537 available with Guest Additions 4.0 or later installed. 7228 7538 </para> 7229 7539 … … 7233 7543 7234 7544 <para> 7235 Where the parameters are :7545 Where the parameters are as follows: 7236 7546 </para> 7237 7547 … … 7257 7567 <listitem> 7258 7568 <para> 7259 Creates any absent parent director y(ies) of the7260 specifieddirectory. Optional.7261 </para> 7262 7263 <para> 7264 e.g.If specified directory is7569 Creates any absent parent directories of the specified 7570 directory. Optional. 7571 </para> 7572 7573 <para> 7574 For example: If specified directory is 7265 7575 <computeroutput>D:\Foo\Bar</computeroutput> and 7266 7576 <computeroutput>D:\Foo</computeroutput> is absent, it … … 7280 7590 <para> 7281 7591 Specifies the permission mode on the specified 7282 directory(ies) (and any parents, where 7283 <computeroutput>--parents</computeroutput> option used). 7284 Currently octal modes (e.g. 7285 <computeroutput>0755</computeroutput>) only are 7286 supported. 7592 directories, and any parents, if the 7593 <computeroutput>--parents</computeroutput> option is 7594 used. Currently octal modes only, such as. 7595 <computeroutput>0755</computeroutput>, are supported. 7287 7596 </para> 7288 7597 </listitem> … … 7297 7606 <listitem> 7298 7607 <para> 7299 Specifies list of absolute path(s) of directory(ies) to7300 be created on guest file system. Mandatory. e.g.7608 Specifies a list of absolute paths of directories to be 7609 created on guest file system. Mandatory. For example: 7301 7610 <computeroutput>D:\Foo\Bar</computeroutput>. 7302 7611 </para> 7303 7612 7304 7613 <para> 7305 All parent directories must already exist unless switch7306 <computeroutput>--parents</computeroutput> used. (e.g.7307 in the above example7308 <computeroutput>D:\Foo</computeroutput> ). The specified7614 All parent directories must already exist unless the 7615 switch <computeroutput>--parents</computeroutput> is 7616 used. For example, in the above example 7617 <computeroutput>D:\Foo</computeroutput>. The specified 7309 7618 user must have sufficient rights to create the specified 7310 director y(ies), and any parents that need to be created.7619 directories, and any parents that need to be created. 7311 7620 </para> 7312 7621 </listitem> … … 7318 7627 <listitem> 7319 7628 <para> 7320 < emphasis role="bold"><computeroutput>rmdir|removedir|removedirectory</computeroutput></emphasis>7321 Deletes specified guest file system directories. (Only with7322 installed Guest Additions 4.3.2 and later).7629 <computeroutput>rmdir|removedir|removedirectory</computeroutput>: 7630 Deletes specified guest file system directories. Only 7631 available with installed Guest Additions 4.3.2 and later. 7323 7632 </para> 7324 7633 … … 7329 7638 7330 7639 <para> 7331 Where the parameters are :7640 Where the parameters are as follows: 7332 7641 </para> 7333 7642 … … 7366 7675 <listitem> 7367 7676 <para> 7368 Specifies list of the absolute path(s) of directory(ies)7369 tobe deleted on guest file system. Mandatory. Wildcards7370 are allowed. e.g.7677 Specifies a list of the absolute paths of directories to 7678 be deleted on guest file system. Mandatory. Wildcards 7679 are allowed. For example: 7371 7680 <computeroutput>D:\Foo\*Bar</computeroutput>. The 7372 7681 specified user must have sufficient rights to delete the 7373 specified director y(ies).7682 specified directories. 7374 7683 </para> 7375 7684 </listitem> … … 7381 7690 <listitem> 7382 7691 <para> 7383 < emphasis role="bold"><computeroutput>rm|removefile</computeroutput></emphasis>7384 Deletes specified files on the guest file system. (Onlywith7385 installed Guest Additions 4.3.2 and later ).7692 <computeroutput>rm|removefile</computeroutput>: Deletes 7693 specified files on the guest file system. Only available with 7694 installed Guest Additions 4.3.2 and later. 7386 7695 </para> 7387 7696 … … 7391 7700 7392 7701 <para> 7393 Where the parameters are :7702 Where the parameters are as follows: 7394 7703 </para> 7395 7704 … … 7415 7724 <listitem> 7416 7725 <para> 7417 Enforce operation (override any requests for7418 confirmations ). Optional.7726 Enforce operation and override any requests for 7727 confirmations. Optional. 7419 7728 </para> 7420 7729 </listitem> … … 7429 7738 <listitem> 7430 7739 <para> 7431 Specifies list of absolute path(s) of file(s)to be7740 Specifies a list of absolute paths of files to be 7432 7741 deleted on guest file system. Mandatory. Wildcards are 7433 allowed. e.g.7742 allowed. For example: 7434 7743 <computeroutput>D:\Foo\Bar\text*.txt</computeroutput>. 7435 7744 The specified user should have sufficient rights to 7436 delete the specified file (s).7745 delete the specified files. 7437 7746 </para> 7438 7747 </listitem> … … 7444 7753 <listitem> 7445 7754 <para> 7446 <emphasis role="bold"><computeroutput>mv|move|ren|rename</computeroutput></emphasis> 7447 This subcommand renames file(s) and/or directory(ies) on the 7448 guest file system. (Only with installed Guest Additions 4.3.2 7449 and later). 7755 <computeroutput>mv|move|ren|rename</computeroutput>: Renames 7756 files and/or directories on the guest file system. Only 7757 available with installed Guest Additions 4.3.2 and later. 7450 7758 </para> 7451 7759 … … 7454 7762 7455 7763 <para> 7456 Where the parameters are :7764 Where the parameters are as follows: 7457 7765 </para> 7458 7766 … … 7479 7787 <listitem> 7480 7788 <para> 7481 Specifies absolute path (s) of file(s) and/or single7482 directory to be moved/renamed on guest file system.7483 Mandatory. Wildcards are allowed in file names(s). The7484 s pecified user should have sufficient rights to access7485 the specified file(s).7789 Specifies absolute paths of files or a single directory 7790 to be moved and renamed on guest file system. Mandatory. 7791 Wildcards are allowed in file names. The specified user 7792 should have sufficient rights to access the specified 7793 files. 7486 7794 </para> 7487 7795 </listitem> … … 7495 7803 <listitem> 7496 7804 <para> 7497 Specifies the absolute path of the destination 7498 file/directory to which the file(s) are to be moved.7499 Mandatory. If only one file to be moved, <dest>7500 can be file or directory, else it must be a directory.7501 The specified user must have sufficient rights to access7502 the destination file/directory.7805 Specifies the absolute path of the destination file or 7806 directory to which the files are to be moved. Mandatory. 7807 If only one file to be moved, <dest> can be file 7808 or directory, else it must be a directory. The specified 7809 user must have sufficient rights to access the 7810 destination file or directory. 7503 7811 </para> 7504 7812 </listitem> … … 7510 7818 <listitem> 7511 7819 <para> 7512 < emphasis role="bold"><computeroutput>mktemp|createtemp|createtemporary</computeroutput></emphasis>7513 Creates a temporary file /directory on the guest file system,7514 to assist subsequent copying of files from the host to the7515 guest file systems. By default, the file/directory is created7516 in the guest's platform specific temp directory. Not currently7517 supported. (Only with installed Guest Additions 4.2 and7518 later).7820 <computeroutput>mktemp|createtemp|createtemporary</computeroutput>: 7821 Creates a temporary file or directory on the guest file 7822 system, to assist subsequent copying of files from the host to 7823 the guest file systems. By default, the file or directory is 7824 created in the guest's platform specific temp directory. Not 7825 currently supported. Only available with installed Guest 7826 Additions 4.2 and later. 7519 7827 </para> 7520 7828 … … 7525 7833 7526 7834 <para> 7527 The parameters are :7835 The parameters are as follows: 7528 7836 </para> 7529 7837 … … 7562 7870 <listitem> 7563 7871 <para> 7564 Enforces secure file /directory creation. Optional. The7565 permission mode is set to7872 Enforces secure file and directory creation. Optional. 7873 The permission mode is set to 7566 7874 <computeroutput>0755</computeroutput>. Operation fails 7567 7875 if it cannot be performed securely. … … 7578 7886 <para> 7579 7887 Specifies the permission mode of the specified 7580 directory. Optional. Currently only octal modes (e.g.7581 <computeroutput>0755</computeroutput> )are supported.7888 directory. Optional. Currently only octal modes, such as 7889 <computeroutput>0755</computeroutput>, are supported. 7582 7890 </para> 7583 7891 </listitem> … … 7593 7901 <para> 7594 7902 Specifies the absolute path of the directory on the 7595 guest file system into which the file/directory7596 specified in will be created. Optional. If unspecified,7597 theplatform-specific temp directory is used.7903 guest file system where the file or directory specified 7904 will be created. Optional. If unspecified, the 7905 platform-specific temp directory is used. 7598 7906 </para> 7599 7907 </listitem> … … 7608 7916 <para> 7609 7917 Specifies a file name without a directory path, 7610 containing at least one sequence comprising three7611 c onsecutive 'X' characters, or ending in 'X'. Mandatory.7918 containing at least one sequence of three consecutive X 7919 characters, or ending in X. Mandatory. 7612 7920 </para> 7613 7921 </listitem> … … 7619 7927 <listitem> 7620 7928 <para> 7621 < emphasis role="bold"><computeroutput>stat</computeroutput></emphasis>7622 Displays file or file system status(es)on the guest.7929 <computeroutput>stat</computeroutput>: Displays file or file 7930 system statuses on the guest. 7623 7931 </para> 7624 7932 … … 7627 7935 7628 7936 <para> 7629 Where the parameters are :7937 Where the parameters are as follows: 7630 7938 </para> 7631 7939 … … 7652 7960 <listitem> 7653 7961 <para> 7654 Specifies absolute path (s) of file(s) and/or file7655 system(s) on guest file system. Mandatory. e.g.7962 Specifies absolute paths of files or file systems on the 7963 guest file system. Mandatory. For example: 7656 7964 <computeroutput>/home/foo/a.out</computeroutput>. The 7657 7965 specified user should have sufficient rights to access 7658 the specified file (s)/file system(s).7966 the specified files or file systems. 7659 7967 </para> 7660 7968 </listitem> … … 7675 7983 7676 7984 <para> 7677 The "common-options" are:7985 The common options are as follows: 7678 7986 </para> 7679 7987 … … 7683 7991 7684 7992 <para> 7685 Where details of the common options for the second set of7686 subcommands are:7993 Details of the common options for the second set of subcommands 7994 are as follows: 7687 7995 </para> 7688 7996 … … 7696 8004 <listitem> 7697 8005 <para> 7698 Makes the sub -command execution more verbose. Optional.8006 Makes the subcommand execution more verbose. Optional. 7699 8007 </para> 7700 8008 </listitem> … … 7708 8016 <listitem> 7709 8017 <para> 7710 Makes the sub -command execution quieter. Optional.8018 Makes the subcommand execution quieter. Optional. 7711 8019 </para> 7712 8020 </listitem> … … 7716 8024 7717 8025 <para> 7718 The second set of subcommands :8026 The second set of subcommands are as follows: 7719 8027 </para> 7720 8028 … … 7723 8031 <listitem> 7724 8032 <para> 7725 < emphasis role="bold"><computeroutput>list</computeroutput></emphasis>7726 Lists guest control configuration and status data, e.g. open7727 guest sessions, guest processesand files.8033 <computeroutput>list</computeroutput>: Lists guest control 8034 configuration and status data. For example: open guest 8035 sessions, guest processes, and files. 7728 8036 </para> 7729 8037 … … 7732 8040 7733 8041 <para> 7734 Where the parameters are :8042 Where the parameters are as follows: 7735 8043 </para> 7736 8044 … … 7767 8075 <listitem> 7768 8076 <para> 7769 < emphasis role="bold"><computeroutput>closeprocess</computeroutput></emphasis>7770 Terminates guest processes specified by PID(s))running in7771 guest session(s), specified by the session ID or name(s).8077 <computeroutput>closeprocess</computeroutput>: Terminates 8078 guest processes specified by PIDs running in a guest session, 8079 specified by the session ID or name. 7772 8080 </para> 7773 8081 … … 7777 8085 7778 8086 <para> 7779 Where the parameters are :8087 Where the parameters are as follows: 7780 8088 </para> 7781 8089 … … 7839 8147 <listitem> 7840 8148 <para> 7841 < emphasis role="bold"><computeroutput>closesession</computeroutput></emphasis>7842 Closes specified guest sessions, specified either by session7843 ID orname.8149 <computeroutput>closesession</computeroutput>: Closes 8150 specified guest sessions, specified either by session ID or 8151 name. 7844 8152 </para> 7845 8153 … … 7848 8156 7849 8157 <para> 7850 Where the parameters are :8158 Where the parameters are as follows: 7851 8159 </para> 7852 8160 … … 7910 8218 <listitem> 7911 8219 <para> 7912 < emphasis role="bold"><computeroutput>updatega|updateadditions|updateguestadditions</computeroutput></emphasis>7913 Ugrades Guest Additions already installed on the guest. (Only7914 a lready installed Guest Additions 4.0 and later).7915 </para> 7916 7917 <screen>VBoxManage guestcontrol <uuid|vmname> updatega|updateadditions|updateguestadditions 8220 <computeroutput>updatega|updateadditions|updateguestadditions</computeroutput>: 8221 Ugrades Guest Additions already installed on the guest. Only 8222 available for already installed Guest Additions 4.0 and later. 8223 </para> 8224 8225 <screen>VBoxManage guestcontrol <uuid|vmname> updatega|updateadditions|updateguestadditions 7918 8226 [common-options] 7919 8227 [--source <New .ISO path>] … … 7922 8230 7923 8231 <para> 7924 Where the parameters are :8232 Where the parameters are as follows: 7925 8233 </para> 7926 8234 … … 7947 8255 <listitem> 7948 8256 <para> 7949 Specifies the absolute path on guest file system of the7950 .ISO file forGuest Additions update. Mandatory.8257 Specifies the absolute path on the guest file system of 8258 the .ISO file for the Guest Additions update. Mandatory. 7951 8259 </para> 7952 8260 </listitem> … … 7960 8268 <listitem> 7961 8269 <para> 7962 Indicates that VBoxManage starts the usual updating 7963 process on the guest and then waits until the actual 7964 Guest Additions updating begins, at which point 7965 VBoxManage self-terminates. Optional. 7966 </para> 7967 7968 <para> 7969 Default behavior is that VBoxManage waits for completion 7970 of the Guest Additions update before terminating. Use of 7971 this option is sometimes necessary, as a running 7972 VBoxManage can affect the interaction between the 7973 installer and the guest OS. 8270 Indicates that <command>VBoxManage</command> starts the 8271 usual updating process on the guest and then waits until 8272 the actual Guest Additions updating begins, at which 8273 point <command>VBoxManage</command> self-terminates. 8274 Optional. 8275 </para> 8276 8277 <para> 8278 Default behavior is that <command>VBoxManage</command> 8279 waits for completion of the Guest Additions update 8280 before terminating. Use of this option is sometimes 8281 necessary, as a running <command>VBoxManage</command> 8282 can affect the interaction between the installer and the 8283 guest OS. 7974 8284 </para> 7975 8285 </listitem> … … 8001 8311 <listitem> 8002 8312 <para> 8003 < emphasis role="bold"><computeroutput>watch</computeroutput></emphasis>8004 This subcommand prints current guestcontrol activity.8313 <computeroutput>watch</computeroutput>: Prints current guest 8314 control activity. 8005 8315 </para> 8006 8316 … … 8009 8319 8010 8320 <para> 8011 Where the parameters are :8321 Where the parameters are as follows: 8012 8322 </para> 8013 8323 … … 8047 8357 8048 8358 <para> 8049 Metric data is collected and retained internally ; it may be8050 retrieved at any time with the <com puteroutput>VBoxManage metrics8051 query</com puteroutput> subcommand. The data is available as long8052 as the background <computeroutput>VBoxSVC</computeroutput> process8053 is alive. That process terminates shortly after all VMs and8054 frontendshave been closed.8359 Metric data is collected and retained internally. It may be 8360 retrieved at any time with the <command>VBoxManage metrics 8361 query</command> subcommand. The data is available as long as the 8362 background <computeroutput>VBoxSVC</computeroutput> process is 8363 alive. That process terminates shortly after all VMs and frontends 8364 have been closed. 8055 8365 </para> 8056 8366 8057 8367 <para> 8058 8368 By default no metrics are collected at all. Metrics collection 8059 does not start until <com puteroutput>VBoxManage metrics8060 setup</computeroutput> is invoked with a proper sampling interval8061 and the number of metrics to be retained. The interval is measured8062 in seconds. For example, to enable collecting the host processor8063 and memory usage metrics every second and keeping the 5 most8064 current samples,the following command can be used:8369 does not start until <command>VBoxManage metrics setup</command> 8370 is invoked with a proper sampling interval and the number of 8371 metrics to be retained. The interval is measured in seconds. For 8372 example, to enable collecting the host processor and memory usage 8373 metrics every second and keeping the five most current samples, 8374 the following command can be used: 8065 8375 </para> 8066 8376 … … 8070 8380 Metric collection can only be enabled for started VMs. Collected 8071 8381 data and collection settings for a particular VM will disappear as 8072 soon as it shuts down. Use <computeroutput>VBoxManage metrics list 8073 </computeroutput> subcommand to see which metrics are currently 8074 available. You can also use 8075 <computeroutput>--list</computeroutput> option with any subcommand 8076 that modifies metric settings to find out which metrics were 8077 affected. 8078 </para> 8079 8080 <para> 8081 Note that the <computeroutput>VBoxManage metrics 8082 setup</computeroutput> subcommand discards all samples that may 8083 have been previously collected for the specified set of objects 8084 and metrics. 8382 soon as it shuts down. Use <command>VBoxManage metrics list 8383 </command> subcommand to see which metrics are currently 8384 available. You can also use <option>--list</option> option with 8385 any subcommand that modifies metric settings to find out which 8386 metrics were affected. 8387 </para> 8388 8389 <para> 8390 Note that the <command>VBoxManage metrics setup</command> 8391 subcommand discards all samples that may have been previously 8392 collected for the specified set of objects and metrics. 8085 8393 </para> 8086 8394 8087 8395 <para> 8088 8396 To enable or disable metrics collection without discarding the 8089 data <computeroutput>VBoxManage metrics enable</computeroutput> 8090 and <computeroutput>VBoxManage metrics disable</computeroutput> 8091 subcommands can be used. Note that these subcommands expect 8092 metrics, not submetrics, like <code>CPU/Load</code> or 8093 <code>RAM/Usage</code> as parameters. In other words enabling 8094 <code>CPU/Load/User</code> while disabling 8095 <code>CPU/Load/Kernel</code> is not supported. 8397 data, <command>VBoxManage metrics enable</command> and 8398 <command>VBoxManage metrics disable</command> subcommands can be 8399 used. Note that these subcommands expect metrics as parameters, 8400 not submetrics such as <computeroutput>CPU/Load</computeroutput> 8401 or <computeroutput>RAM/Usage</computeroutput>. In other words 8402 enabling <computeroutput>CPU/Load/User</computeroutput> while 8403 disabling <computeroutput>CPU/Load/Kernel</computeroutput> is not 8404 supported. 8096 8405 </para> 8097 8406 8098 8407 <para> 8099 8408 The host and VMs have different sets of associated metrics. 8100 Available metrics can be listed with <com puteroutput>VBoxManage8101 metrics list</computeroutput> subcommand.8409 Available metrics can be listed with <command>VBoxManage metrics 8410 list</command> subcommand. 8102 8411 </para> 8103 8412 … … 8113 8422 <para> 8114 8423 Subcommands may apply to all objects and metrics or can be limited 8115 to one object or/and a list of metrics. If no objects or metrics8116 aregiven in the parameters, the subcommands will apply to all8424 to one object and a list of metrics. If no objects or metrics are 8425 given in the parameters, the subcommands will apply to all 8117 8426 available metrics of all objects. You may use an asterisk 8118 ("<computeroutput>*</computeroutput>")to explicitly specify that8427 "<computeroutput>*</computeroutput>" to explicitly specify that 8119 8428 the command should be applied to all objects or metrics. Use 8120 "host" as the object name to limit the scope of the command to 8121 host-related metrics. To limit the scope to a subset of metrics, 8122 use a metric list with names separated by commas. 8429 <computeroutput>host</computeroutput> as the object name to limit 8430 the scope of the command to host-related metrics. To limit the 8431 scope to a subset of metrics, use a metric list with names 8432 separated by commas. 8123 8433 </para> 8124 8434 8125 8435 <para> 8126 8436 For example, to query metric data on the CPU time spent in user 8127 and kernel modes by the virtual machine named "test", you can use8128 the following command:8437 and kernel modes by the virtual machine named 8438 <computeroutput>test</computeroutput>, use the following command: 8129 8439 </para> 8130 8440 … … 8144 8454 <listitem> 8145 8455 <para> 8146 This subcommand shows the parameters of the currently8147 existing metrics. Note that VM-specific metrics are only8148 available when aparticular VM is running.8456 Shows the parameters of the currently existing metrics. Note 8457 that VM-specific metrics are only available when a 8458 particular VM is running. 8149 8459 </para> 8150 8460 </listitem> … … 8158 8468 <listitem> 8159 8469 <para> 8160 This subcommand sets the interval between taking two samples8161 of metric data and the number of samplesretained8162 internally. The retained data is available for displaying8163 with the <code>query</code> subcommand. The8470 Sets the interval between taking two samples of metric data 8471 and the number of samples retained internally. The retained 8472 data is available for displaying with the 8473 <command>query</command> subcommand. The 8164 8474 <computeroutput>--list </computeroutput> option shows which 8165 8475 metrics have been modified as the result of the command … … 8176 8486 <listitem> 8177 8487 <para> 8178 This subcommand "resumes" data collection after it has been 8179 stopped with <code>disable</code> subcommand. Note that 8180 specifying submetrics as parameters will not enable 8181 underlying metrics. Use 8182 <computeroutput>--list</computeroutput> to find out if the 8183 command did what was expected. 8488 Resumes data collection after it has been stopped with the 8489 <command>disable</command> subcommand. Note that specifying 8490 submetrics as parameters will not enable underlying metrics. 8491 Use <computeroutput>--list</computeroutput> to find out if 8492 the command worked as expected. 8184 8493 </para> 8185 8494 </listitem> … … 8193 8502 <listitem> 8194 8503 <para> 8195 This subcommand "suspends" data collection without affecting 8196 collection parameters or collected data. Note that 8197 specifying submetrics as parameters will not disable 8198 underlying metrics. Use 8199 <computeroutput>--list</computeroutput> to find out if the 8200 command did what was expected. 8504 Suspends data collection without affecting collection 8505 parameters or collected data. Note that specifying 8506 submetrics as parameters will not disable underlying 8507 metrics. Use <computeroutput>--list</computeroutput> to find 8508 out if the command worked as expected. 8201 8509 </para> 8202 8510 </listitem> … … 8210 8518 <listitem> 8211 8519 <para> 8212 This subcommand retrieves and displays the currently 8213 retained metric data. 8214 8215 <note> 8216 <para> 8217 The <code>query</code> subcommand does not remove or 8218 "flush" retained data. If you query often enough you 8219 will see how old samples are gradually being "phased 8220 out" by new samples. 8221 </para> 8222 </note> 8223 </para> 8520 Retrieves and displays the currently retained metric data. 8521 </para> 8522 8523 <note> 8524 <para> 8525 The <command>query</command> subcommand does not remove or 8526 flush retained data. If you query often enough you will 8527 see how old samples are gradually being phased out by new 8528 samples. 8529 </para> 8530 </note> 8224 8531 </listitem> 8225 8532 </varlistentry> … … 8232 8539 <listitem> 8233 8540 <para> 8234 This subcommand sets the interval between taking two samples 8235 of metric data and the number of samples retained 8236 internally. The collected data is displayed periodically 8237 until Ctrl-C is pressed unless the 8238 <computeroutput>--detach</computeroutput> option is 8239 specified. With the 8541 Sets the interval between taking two samples of metric data 8542 and the number of samples retained internally. The collected 8543 data is displayed periodically until Ctrl+C is pressed, 8544 unless the <computeroutput>--detach</computeroutput> option 8545 is specified. With the 8240 8546 <computeroutput>--detach</computeroutput> option, this 8241 subcommand operates the same way as <code>setup</code> does. 8242 The <computeroutput>--list</computeroutput> option shows 8243 which metrics match the specified filter. 8547 subcommand operates the same way as 8548 <computeroutput>setup</computeroutput> does. The 8549 <computeroutput>--list</computeroutput> option shows which 8550 metrics match the specified filter. 8244 8551 </para> 8245 8552 </listitem> … … 8268 8575 internal network is chosen when the NAT service is created, and 8269 8576 the internal network will be created if it does not already exist. 8270 An example command to create a NAT network:8577 The following is an example command to create a NAT network: 8271 8578 </para> 8272 8579 … … 8274 8581 8275 8582 <para> 8276 Here, "natnet1" is the name of the internal network to be used and 8277 "192.168.15.0/24" is the network address and mask of the NAT 8278 service interface. By default, in this static configuration the 8279 gateway will be assigned the address 192.168.15.1, the address 8280 after the interface address, though this is subject to change. 8281 </para> 8282 8283 <para> 8284 To add a DHCP server to the NAT network after creation: 8583 Here, <computeroutput>natnet1</computeroutput> is the name of the 8584 internal network to be used and 8585 <computeroutput>192.168.15.0/24</computeroutput> is the network 8586 address and mask of the NAT service interface. By default, in this 8587 static configuration the gateway will be assigned the address 8588 192.168.15.1, the address after the interface address, though this 8589 is subject to change. 8590 </para> 8591 8592 <para> 8593 To add a DHCP server to the NAT network after creation, run the 8594 following command: 8285 8595 </para> 8286 8596 … … 8288 8598 8289 8599 <para> 8290 Below are the subcommands for 8291 <emphasis role="bold"><computeroutput>VBoxManage natnetwork 8292 </computeroutput></emphasis> 8600 The subcommands for <command>VBoxManage natnetwork</command> are 8601 as follows: 8293 8602 </para> 8294 8603 … … 8305 8614 8306 8615 <para> 8307 <emphasis role="bold"><computeroutput>VBoxManage natnetwork 8308 add</computeroutput></emphasis> Creates a new internal network 8309 interface, and adds a NAT network service. This command is a 8310 prerequisite for enabling attachment of VMs to the NAT network. 8311 Parameters are as follows: 8616 <command>VBoxManage natnetwork add</command>: Creates a new 8617 internal network interface, and adds a NAT network service. This 8618 command is a prerequisite for enabling attachment of VMs to the 8619 NAT network. Parameters are as follows: 8312 8620 </para> 8313 8621 … … 8334 8642 <listitem> 8335 8643 <para> 8336 Where <network> specifies the static(default)/DHCP 8337 network address and mask of the NAT service interface. 8644 Where <network> specifies the static or DHCP network 8645 address and mask of the NAT service interface. The default 8646 is a static network address. 8338 8647 </para> 8339 8648 </listitem> … … 8347 8656 <listitem> 8348 8657 <para> 8349 Enables /disables the NAT network service.8658 Enables and disables the NAT network service. 8350 8659 </para> 8351 8660 </listitem> … … 8359 8668 <listitem> 8360 8669 <para> 8361 Enables/disables DHCP server specified by --netname; its use 8362 also indicates that it is a DHCP server. 8670 Enables and disables a DHCP server specified by 8671 <computeroutput>--netname</computeroutput>. Use of this 8672 option also indicates that it is a DHCP server. 8363 8673 </para> 8364 8674 </listitem> … … 8372 8682 <listitem> 8373 8683 <para> 8374 Enables IPv4 port forwarding, rule specified by8684 Enables IPv4 port forwarding, with a rule specified by 8375 8685 <rule>. 8376 8686 </para> … … 8385 8695 <listitem> 8386 8696 <para> 8387 Enables IPv4 loopback interface, rule specified by 8697 Enables the IPv4 loopback interface, with a rule specified 8698 by <rule>. 8699 </para> 8700 </listitem> 8701 </varlistentry> 8702 8703 <varlistentry> 8704 <term> 8705 <computeroutput>--ipv6 on|off</computeroutput> 8706 </term> 8707 8708 <listitem> 8709 <para> 8710 Enables and disables IPv6. The default setting is IPv4, 8711 disabling IPv6 enables IPv4. 8712 </para> 8713 </listitem> 8714 </varlistentry> 8715 8716 <varlistentry> 8717 <term> 8718 <computeroutput>--port-forward-6 <rule></computeroutput> 8719 </term> 8720 8721 <listitem> 8722 <para> 8723 Enables IPv6 port forwarding, with a rule specified by 8388 8724 <rule>. 8389 8725 </para> … … 8393 8729 <varlistentry> 8394 8730 <term> 8395 <computeroutput>--ipv6 on|off</computeroutput>8396 </term>8397 8398 <listitem>8399 <para>8400 Enables/disables IPv6 (default is IPv4, disables gives8401 IPv4).8402 </para>8403 </listitem>8404 </varlistentry>8405 8406 <varlistentry>8407 <term>8408 <computeroutput>--port-forward-6 <rule></computeroutput>8409 </term>8410 8411 <listitem>8412 <para>8413 Enables IPv6 port forwarding, rule specified by8414 <rule>.8415 </para>8416 </listitem>8417 </varlistentry>8418 8419 <varlistentry>8420 <term>8421 8731 <computeroutput>--loopback-6 <rule></computeroutput> 8422 8732 </term> … … 8424 8734 <listitem> 8425 8735 <para> 8426 Enables IPv6 loopback interface, rule specified by8427 <rule>.8736 Enables the IPv6 loopback interface, with a rule specified 8737 by <rule>. 8428 8738 </para> 8429 8739 </listitem> … … 8435 8745 8436 8746 <para> 8437 <emphasis role="bold"><computeroutput>VBoxManage natnetwork 8438 remove</computeroutput></emphasis> Removes a NAT network service. 8439 Parameters are as follows: 8747 <command>VBoxManage natnetwork remove</command>: Removes a NAT 8748 network service. Parameters are as follows: 8440 8749 </para> 8441 8750 … … 8470 8779 8471 8780 <para> 8472 <emphasis role="bold"><computeroutput>VBoxManage natnetwork 8473 modify</computeroutput></emphasis> Modifies an existing NAT 8474 network service. Parameters are as follows: 8781 <command>VBoxManage natnetwork modify</command>: Modifies an 8782 existing NAT network service. Parameters are as follows: 8475 8783 </para> 8476 8784 … … 8497 8805 <listitem> 8498 8806 <para> 8499 Where <network> specifies the new static(default)/DHCP 8500 network address and mask of the NAT service interface. 8807 Where <network> specifies the new static or DHCP 8808 network address and mask of the NAT service interface. The 8809 default is a static network address. 8501 8810 </para> 8502 8811 </listitem> … … 8510 8819 <listitem> 8511 8820 <para> 8512 Enables /disables the NAT network service.8821 Enables and disables the NAT network service. 8513 8822 </para> 8514 8823 </listitem> … … 8522 8831 <listitem> 8523 8832 <para> 8524 Enables (and if absent, adds)/disables (if any) DHCP server. 8833 Enables and disables a DHCP server. If a DHCP server is not 8834 present, using enable adds a new DHCP server. 8525 8835 </para> 8526 8836 </listitem> … … 8534 8844 <listitem> 8535 8845 <para> 8536 Enables IPv4 port forwarding, rule specified by8846 Enables IPv4 port forwarding, with a rule specified by 8537 8847 <rule>. 8538 8848 </para> … … 8547 8857 <listitem> 8548 8858 <para> 8549 Enables IPv4 loopback interface, rule specified by 8859 Enables the IPv4 loopback interface, with a rule specified 8860 by <rule>. 8861 </para> 8862 </listitem> 8863 </varlistentry> 8864 8865 <varlistentry> 8866 <term> 8867 <computeroutput>--ipv6 on|off</computeroutput> 8868 </term> 8869 8870 <listitem> 8871 <para> 8872 Enables and disables IPv6. The default setting is IPv4, 8873 disabling IPv6 enables IPv4. 8874 </para> 8875 </listitem> 8876 </varlistentry> 8877 8878 <varlistentry> 8879 <term> 8880 <computeroutput>--port-forward-6 <rule></computeroutput> 8881 </term> 8882 8883 <listitem> 8884 <para> 8885 Enables IPv6 port forwarding, with a rule specified by 8550 8886 <rule>. 8551 8887 </para> … … 8555 8891 <varlistentry> 8556 8892 <term> 8557 <computeroutput>--ipv6 on|off</computeroutput>8558 </term>8559 8560 <listitem>8561 <para>8562 Enables/disables IPv6 (default is IPv4, disables gives8563 IPv4).8564 </para>8565 </listitem>8566 </varlistentry>8567 8568 <varlistentry>8569 <term>8570 <computeroutput>--port-forward-6 <rule></computeroutput>8571 </term>8572 8573 <listitem>8574 <para>8575 Enables IPv6 port forwarding, rule specified by8576 <rule>.8577 </para>8578 </listitem>8579 </varlistentry>8580 8581 <varlistentry>8582 <term>8583 8893 <computeroutput>--loopback-6 <rule></computeroutput> 8584 8894 </term> … … 8586 8896 <listitem> 8587 8897 <para> 8588 Enables IPv6 loopback interface, rule specified by8898 Enables IPv6 loopback interface, with a rule specified by 8589 8899 <rule>. 8590 8900 </para> … … 8598 8908 8599 8909 <para> 8600 < emphasis role="bold"><computeroutput>VBoxManage natnetwork8601 s tart</computeroutput></emphasis> Starts specified NAT network8602 service and any associated DHCP server.Parameters are as follows:8910 <command>VBoxManage natnetwork start</command>: Starts the 8911 specified NAT network service and any associated DHCP server. 8912 Parameters are as follows: 8603 8913 </para> 8604 8914 … … 8624 8934 8625 8935 <para> 8626 < emphasis role="bold"><computeroutput>VBoxManage natnetwork8627 stop</computeroutput></emphasis> Stops specified NAT network8628 service and any DHCP server. Parameters are asfollows:8936 <command>VBoxManage natnetwork stop</command>: Stops the specified 8937 NAT network service and any DHCP server. Parameters are as 8938 follows: 8629 8939 </para> 8630 8940 … … 8649 8959 8650 8960 <para> 8651 < emphasis role="bold"><computeroutput>VBoxManage natnetwork8652 list</computeroutput></emphasis> Lists all NAT network services8653 with optional filtering. Parameters are asfollows:8961 <command>VBoxManage natnetwork list</command>: Lists all NAT 8962 network services, with optional filtering. Parameters are as 8963 follows: 8654 8964 </para> 8655 8965 … … 8663 8973 <listitem> 8664 8974 <para> 8665 Where <pattern> is optional filtering pattern.8975 Where <pattern> is an optional filtering pattern. 8666 8976 </para> 8667 8977 </listitem> … … 8677 8987 8678 8988 <para> 8679 With "hostonlyif" you can change the IP configuration of a8680 host-only network interface. For a description of host-only8681 networking, see <xref linkend="network_hostonly" />. Each8682 host-only interface is identified by a name and can either use the8683 i nternal DHCP server or a manual IP configuration, both IP4 and8684 IP6.8989 The <command>hostonlyif</command> command enables you to change 8990 the IP configuration of a host-only network interface. For a 8991 description of host-only networking, see 8992 <xref linkend="network_hostonly" />. Each host-only interface is 8993 identified by a name and can either use the internal DHCP server 8994 or a manual IP configuration, both IP4 and IP6. 8685 8995 </para> 8686 8996 … … 8698 9008 <listitem> 8699 9009 <para> 8700 Configure a host-only interface9010 Configures a host-only interface. 8701 9011 </para> 8702 9012 </listitem> … … 8738 9048 8739 9049 <para> 8740 The "dhcpserver" commands allow you to control the DHCP server 8741 that is built into VirtualBox. You may find this useful when using 8742 internal or host-only networking. Theoretically, you can enable it 8743 for a bridged network as well, but that will likely cause 8744 conflicts with other DHCP servers in your physical network. 9050 The <command>dhcpserver</command> commands enable you to control 9051 the DHCP server that is built into &product-name;. You may find 9052 this useful when using internal or host-only networking. 9053 Theoretically, you can also enable it for a bridged network, but 9054 that may cause conflicts with other DHCP servers in your physical 9055 network. 8745 9056 </para> 8746 9057 … … 8778 9089 8779 9090 <para> 8780 Alternatively, you can also use the 8781 <computeroutput>--netname</computeroutput> option as with 8782 internal networks if you know the host-only network's name. 8783 You can see the names with <computeroutput>VBoxManage list 8784 hostonlyifs</computeroutput>. See 9091 Alternatively, you can also use the <option>--netname</option> 9092 option as with internal networks if you know the host-only 9093 network's name. You can see the names with <command>VBoxManage 9094 list hostonlyifs</command>. See 8785 9095 <xref linkend="vboxmanage-list" />. 8786 9096 </para> … … 8799 9109 <para> 8800 9110 With <computeroutput>--ip</computeroutput>, specify the IP 8801 address of the DHCP server itself.9111 address of the DHCP server. 8802 9112 </para> 8803 9113 </listitem> … … 8814 9124 With <computeroutput>--lowerip</computeroutput> and 8815 9125 <computeroutput>--upperip</computeroutput>, you can specify 8816 the lowest and highest IP address , respectively, that the DHCP8817 server will hand outto clients.9126 the lowest and highest IP address that the DHCP server will 9127 assign to clients. 8818 9128 </para> 8819 9129 </listitem> 8820 9130 8821 9131 </itemizedlist> 9132 9133 <para> 9134 You can specify additional DHCP options with the 9135 <computeroutput>--options</computeroutput> command option. Use 9136 <computeroutput>--id</computeroutput> and 9137 <computeroutput>--value</computeroutput> to configure a number and 9138 string pair corresponding to the DHCP option. Use 9139 <computeroutput>--remove</computeroutput> to remove a DHCP option. 9140 </para> 9141 9142 <para> 9143 The <computeroutput>--vm</computeroutput> and 9144 <computeroutput>--nic</computeroutput> settings enable you to 9145 configure DHCP options for a specific network adapter used by the 9146 named VM. 9147 </para> 8822 9148 8823 9149 <para> 8824 9150 Finally, you must specify 8825 9151 <computeroutput>--enable</computeroutput> or the DHCP server will 8826 be created in the disabled state , doing nothing.8827 </para> 8828 8829 <para> 8830 After this, VirtualBox will automatically start the DHCP server8831 for given internal or host-only network as soon as the first8832 virtual machine which uses that network is started.8833 </para>8834 8835 <para> 8836 Reversely, use <computeroutput>VBoxManage dhcpserver8837 remove</computeroutput> with the given <computeroutput>--netname8838 <network_name></computeroutput> or <computeroutput>--ifname8839 <hostonly_if_name></computeroutput> to remove the DHCP8840 server again for the given internal or host-only network.8841 </para>8842 8843 <para> 8844 To modify the settings of a DHCP server created earlier with8845 <computeroutput>VBoxManage dhcpserver add</computeroutput>, you8846 can use <computeroutput>VBoxManage dhcpserver8847 modify</computeroutput> for a given network or host-only interface8848 n ame. This has the same parameters as <computeroutput>VBoxManage8849 dhcpserver add</computeroutput>.9152 be created in the disabled state and will not be running. 9153 </para> 9154 9155 <para> 9156 After this, &product-name; will automatically start the DHCP 9157 server for the specified internal network or host-only network as 9158 soon as the first virtual machine which uses that network is 9159 started. 9160 </para> 9161 9162 <para> 9163 Use <command>VBoxManage dhcpserver remove</command> with the given 9164 <computeroutput>--netname <network_name></computeroutput> or 9165 <computeroutput>--ifname <hostonly_if_name></computeroutput> 9166 to remove the DHCP server for the specified internal network or 9167 host-only network. 9168 </para> 9169 9170 <para> 9171 To modify the settings of a DHCP server created using 9172 <command>VBoxManage dhcpserver add</command>, you can use 9173 <command>VBoxManage dhcpserver modify</command> for a given 9174 network or host-only interface name. This has the same parameters 9175 as <command>VBoxManage dhcpserver add</command>. 8850 9176 </para> 8851 9177 … … 8857 9183 8858 9184 <para> 8859 The "usbdevsource" commands enable you to add and remove USB8860 devices globally.9185 The <command>usbdevsource</command> commands enable you to add and 9186 remove USB devices globally. 8861 9187 </para> 8862 9188 … … 8871 9197 8872 9198 <para> 8873 Where the command line options are :9199 Where the command line options are as follows: 8874 9200 </para> 8875 9201 … … 8878 9204 <listitem> 8879 9205 <para> 8880 <source name> specifies the ID of the 'source' USB 8881 device to be added. Mandatory. 8882 </para> 8883 </listitem> 8884 8885 <listitem> 8886 <para> 8887 --backend <backend> specifies the USB proxy service 8888 backend to use. Mandatory. 8889 </para> 8890 </listitem> 8891 8892 <listitem> 8893 <para> 8894 --address <address> specifies the backend specific 8895 address. Mandatory. 9206 <computeroutput><source name></computeroutput>: 9207 Specifies the ID of the source USB device to be added. 9208 Mandatory. 9209 </para> 9210 </listitem> 9211 9212 <listitem> 9213 <para> 9214 <computeroutput>--backend <backend></computeroutput>: 9215 Specifies the USB proxy service backend to use. Mandatory. 9216 </para> 9217 </listitem> 9218 9219 <listitem> 9220 <para> 9221 <computeroutput> --address <address></computeroutput>: 9222 Specifies the backend specific address. Mandatory. 8896 9223 </para> 8897 9224 </listitem> … … 8907 9234 8908 9235 <para> 8909 Where the command line options are :9236 Where the command line options are as follows: 8910 9237 </para> 8911 9238 … … 8914 9241 <listitem> 8915 9242 <para> 8916 <source name> specifies the ID of the 'source' USB 8917 device to be removed. Mandatory. 9243 <computeroutput><source name></computeroutput>: 9244 Specifies the ID of the source USB device to be removed. 9245 Mandatory. 8918 9246 </para> 8919 9247 </listitem> … … 8923 9251 </sect1> 8924 9252 8925 <xi:include href="user_man_VBoxManage-mediumio.xml" x mlns:xi="http://www.w3.org/2001/XInclude" />8926 8927 <xi:include href="user_man_VBoxManage-debugvm.xml" x mlns:xi="http://www.w3.org/2001/XInclude" />8928 8929 <xi:include href="user_man_VBoxManage-extpack.xml" x mlns:xi="http://www.w3.org/2001/XInclude" />8930 8931 <xi:include href="user_man_VBoxManage-unattended.xml" x mlns:xi="http://www.w3.org/2001/XInclude" />9253 <xi:include href="user_man_VBoxManage-mediumio.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" /> 9254 9255 <xi:include href="user_man_VBoxManage-debugvm.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" /> 9256 9257 <xi:include href="user_man_VBoxManage-extpack.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" /> 9258 9259 <xi:include href="user_man_VBoxManage-unattended.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" /> 8932 9260 8933 9261 </chapter> -
trunk/doc/manual/en_US/user_VirtualBoxAPI.xml
r73278 r76078 7 7 <chapter id="VirtualBoxAPI"> 8 8 9 <title> VirtualBoxProgramming Interfaces</title>9 <title>&product-name; Programming Interfaces</title> 10 10 11 11 <para> 12 VirtualBoxcomes with comprehensive support for third-party13 developers. The so-called "Main API" of VirtualBoxexposes the12 &product-name; comes with comprehensive support for third-party 13 developers. The so-called "Main API" of &product-name; exposes the 14 14 entire feature set of the virtualization engine. It is completely 15 documented and available to anyone who wishes to control VirtualBox16 programmatically.15 documented and available to anyone who wishes to control 16 &product-name; programmatically. 17 17 </para> 18 18 … … 29 29 Development Kit (SDK)</emphasis>. The SDK is available for download 30 30 from 31 <ulink 31 <ulink 32 32 url="http://www.virtualbox.org">http://www.virtualbox.org</ulink>. 33 33 In particular, the SDK comes with a Programming Guide and Reference -
trunk/doc/manual/user_ChangeLogImpl.xml
r76052 r76078 1 1 <?xml version="1.0" encoding="UTF-8"?> 2 3 2 <!-- Release change log structure 4 3 … … 24 23 Host-related entries 25 24 Guest-related entries --> 26 27 <chapter> <!-- HACK ALERT! Seems we must have a single top level element for xi:include to work. 25 <chapter> 26 27 <!-- HACK ALERT! Seems we must have a single top level element for xi:include to work. 28 28 So, we use chapter and xpointer="xpointer(/chapter/)" with xi:include. --> 29 29 30 30 <sect1> 31 <title>Version 6.0.0 release candidate 1 (2018-xx-xx)</title> 32 33 <para>This is a major update. The following major new features 34 were added:</para> 31 32 <title>Version 6.0.0_RC1 (2018-xx-xx)</title> 33 34 <para> 35 This is a major update. The following major new features were 36 added: 37 </para> 35 38 36 39 <itemizedlist> … … 43 46 </itemizedlist> 44 47 45 <para>In addition, the following items were fixed and/or added:</para> 48 <para> 49 In addition, the following items were fixed or added: 50 </para> 46 51 47 52 <itemizedlist> … … 52 57 53 58 </itemizedlist> 54 </sect1> 55 56 <sect1> 57 <title>Version 6.0.0 BETA3 (2018-11-30)</title>58 59 60 </sect1> 61 <sect1> 62 <title>Version 6.0.0_BETA3 (2018-11-30)</title> 63 59 64 <para>This is a beta release. The following major new features 60 65 were added:</para> 61 62 <itemizedlist> 63 66 67 <itemizedlist> 68 64 69 <listitem> 65 70 <para>OCI integration: exporting a VM is now possible from the command line 66 67 </listitem> 68 71 interface (VBoxManage)</para> 72 </listitem> 73 69 74 <listitem> 70 75 <para>OCI integration: all virtualized shapes are supported, e.g. 71 72 </listitem> 73 76 VM.Standard2.*</para> 77 </listitem> 78 74 79 <listitem> 75 80 <para>Devices/graphics: enable support for VMSVGA graphics device emulation 76 77 </listitem> 78 81 by default</para> 82 </listitem> 83 79 84 <listitem> 80 85 <para>VBoxManage: support for DHCP options</para> 81 86 </listitem> 82 87 83 88 <listitem> 84 89 <para>Windows guests: support VMSVGA in the Windows Additions</para> 85 90 </listitem> 86 87 </itemizedlist> 88 91 92 </itemizedlist> 93 89 94 <para>In addition, the following items were fixed and/or added:</para> 90 91 <itemizedlist> 92 95 96 <itemizedlist> 97 93 98 <listitem> 94 99 <para>Serial: allow changing the serial port attachment while the 95 100 VM is running (bug #6115)</para> 96 101 </listitem> 97 102 98 103 <listitem> 99 104 <para>Linux hosts: support Linux 4.20 (thank you Larry Finger)</para> 100 105 </listitem> 101 106 102 107 <listitem> 103 108 <para>Linux guests: support Linux 4.20 (thank you Larry Finger)</para> 104 109 </listitem> 105 110 106 111 <listitem> 107 112 <para>Linux guests: support VMSVGA in the Linux and X11 Additions</para> 108 113 </listitem> 109 110 </itemizedlist> 111 </sect1> 112 113 <sect1> 114 <title>Version 6.0.0 BETA2 (2018-11-15)</title>115 114 115 </itemizedlist> 116 </sect1> 117 118 <sect1> 119 <title>Version 6.0.0_BETA2 (2018-11-15)</title> 120 116 121 <para>This is a beta release. The following major new features 117 122 were added:</para> 118 119 <itemizedlist> 120 123 124 <itemizedlist> 125 121 126 <listitem> 122 127 <para>User interface: a new file manager enabling user to control the guest file system and copy file objects between host and guest.</para> 123 128 </listitem> 124 125 </itemizedlist> 126 129 130 </itemizedlist> 131 127 132 <para>In addition, the following items were fixed and/or added:</para> 128 129 <itemizedlist> 130 133 134 <itemizedlist> 135 131 136 <listitem> 132 137 <para>Oracle Cloud integration fixes and improvements</para> 133 138 </listitem> 134 139 135 140 <listitem> 136 141 <para>User interface: many improvements</para> 137 142 </listitem> 138 143 139 144 <listitem> 140 145 <para>Audio/Video recording fixes and improvements</para> 141 146 </listitem> 142 147 143 148 <listitem> 144 149 <para>Devices: new BusLogic ISA variant</para> 145 150 </listitem> 146 151 147 152 <listitem> 148 153 <para>Devices: serial port fixes</para> 149 154 </listitem> 150 155 151 156 <listitem> 152 157 <para>BIOS: fixes</para> 153 158 </listitem> 154 159 155 160 <listitem> 156 161 <para>API: transparently resize disk images when merging if 157 158 </listitem> 159 162 possible</para> 163 </listitem> 164 160 165 <listitem> 161 166 <para>Solaris: installer fixes</para> 162 167 </listitem> 163 168 164 169 <listitem> 165 170 <para>Windows Guest Additions: fix incorrect tablet co-ordinate 166 167 </listitem> 168 171 handling with recent Windows 10 builds</para> 172 </listitem> 173 169 174 <listitem> 170 175 <para>Guest Additions: improved shared folder auto-mounting</para> 171 176 </listitem> 172 177 173 178 <listitem> 174 179 <para>OS/2 Guest Additions: initial shared folder support</para> 175 180 </listitem> 176 177 </itemizedlist> 178 </sect1> 179 180 <sect1> 181 <title>Version 6.0.0 BETA1 (2018-10-22)</title>182 181 182 </itemizedlist> 183 </sect1> 184 185 <sect1> 186 <title>Version 6.0.0_BETA1 (2018-10-22)</title> 187 183 188 <para>This is a beta release. The following major new features 184 189 were added:</para> 185 186 <itemizedlist> 187 190 191 <itemizedlist> 192 188 193 <listitem> 189 194 <para>OCI Integration: implemented support for exporting a VM to 190 195 Oracle Cloud Infrastructure</para> 191 196 </listitem> 192 197 193 198 <listitem> 194 199 <para>User interface: greatly improved HiDPI and scaling support, 195 196 197 </listitem> 198 200 including better using host HiDPI support, HiDPI icons, 201 improved detection and per-machine configuration</para> 202 </listitem> 203 199 204 <listitem> 200 205 <para>User interface: major rework of interface style with improved 201 202 </listitem> 203 206 ease of access for application and machine set-up</para> 207 </listitem> 208 204 209 <listitem> 205 210 <para>User interface: an improved logviewer widget.</para> 206 211 </listitem> 207 212 208 213 <listitem> 209 214 <para>User interface: several improvements to import appliance and clone virtual machine wizards including (not limited to) enabling user to select non-default folders per machine.</para> 210 215 </listitem> 211 216 212 217 <listitem> 213 218 <para>User interface: a new floppy disk creation widget enabling user to create/add a (optionally formatted) floppy disk.</para> 214 219 </listitem> 215 220 216 221 <listitem> 217 222 <para>User interface: a new media selection widget enabling the user to select one of the already known media or select a disk image file.</para> 218 223 </listitem> 219 220 </itemizedlist> 221 222 <para>In addition, the following items were fixed and/or added:</para>223 224 <itemizedlist> 225 224 225 </itemizedlist> 226 227 <para>In addition, the following items were fixed and/or added:</para> 228 229 <itemizedlist> 230 226 231 <listitem> 227 232 <para>User interface: video and audio recording can now be separately 228 229 </listitem> 230 233 enabled</para> 234 </listitem> 235 231 236 <listitem> 232 237 <para>Audio: implemented support for attaching / detaching VRDE 233 238 audio drivers at runtime</para> 234 239 </listitem> 235 240 236 241 <listitem> 237 242 <para>Guest Control: various new APIs and features were implemented 238 243 (see SDK documentation for more)</para> 239 244 </listitem> 240 245 241 246 <listitem> 242 247 <para>Networking: Added a workaround for older guests which do not enable 243 248 bus mastering for the virtio PCI device</para> 244 249 </listitem> 245 250 246 251 <listitem> 247 252 <para>iSCSI: In cases where there is no ambiguity, the LUN of an iSCSI … … 250 255 </para> 251 256 </listitem> 252 257 253 258 <listitem> 254 259 <para>ACPI: Up to four custom ACPI tables can now be configured for a VM 255 260 </para> 256 261 </listitem> 257 258 </itemizedlist> 259 </sect1> 260 261 <sect1> 262 <title>Version 5.2.6 (2018-01-15)</title> 263 264 <para>This is a maintenance release. The following items were fixed and/or 265 added:</para> 266 267 <itemizedlist> 268 269 <listitem> 270 <para>GUI: fixed occasional screen corruption when host screen resolution 271 is changed</para> 272 </listitem> 273 274 <listitem> 275 <para>User interface: increase proposed disk size when creating new VMs 276 for Windows 7 and newer</para> 277 </listitem> 278 279 <listitem> 280 <para>User interface: various improvements for high resolution 281 screens</para> 282 </listitem> 283 284 <listitem> 285 <para>VMM: Fixed problems using 256MB VRAM in raw-mode VMs</para> 286 </listitem> 287 288 <listitem> 289 <para>Audio: implemented support for audio playback and recording for 290 macOS guests</para> 291 </listitem> 292 293 <listitem> 294 <para>Audio: further timing improvements for Windows 10 guests</para> 295 </listitem> 296 297 <listitem> 298 <para>Linux hosts: fixed problem accessing mini-toolbar under 299 XFCE (bug #17280, contributed by Dusan Gallo)</para> 300 </listitem> 301 302 </itemizedlist> 303 </sect1> 304 305 <sect1> 306 <title>Version 5.2.4 (2017-12-19)</title> 307 308 <para>This is a maintenance release. The following items were fixed and/or 309 added:</para> 310 311 <itemizedlist> 312 313 <listitem> 314 <para>User interface: Adjusting desktop file for X11 window managers 315 (bug #17312)</para> 316 </listitem> 317 318 <listitem> 319 <para>User interface: various high resolution display adjustments</para> 320 </listitem> 321 322 <listitem> 323 <para>Audio: fixed SB16 volume handling (5.2 regression)</para> 324 </listitem> 325 326 <listitem> 327 <para>Audio: various fixes</para> 328 </listitem> 329 330 <listitem> 331 <para>USB/OHCI: fixed a problem where OHCI emulation might sporadically drop data transfers</para> 332 </listitem> 333 334 <listitem> 335 <para>Linux hosts: fixed screen corruption when the host screen changes 336 and a virtual machine window is maximized</para> 337 </listitem> 338 339 <listitem> 340 <para>X11 Guest Additions: fixed a hang at the GNOME Shell login screen 341 with 3D enabled (5.2 regression, bugs #17189 and #17190)</para> 342 </listitem> 343 344 </itemizedlist> 345 </sect1> 346 347 <sect1> 348 <title>Version 5.2.2 (2017-11-22)</title> 349 350 <para>This is a maintenance release. The following items were fixed and/or 351 added:</para> 352 353 <itemizedlist> 354 355 <listitem> 356 <para>User interface: various improvements for high resolution screens</para> 357 </listitem> 358 359 <listitem> 360 <para>User interface: added functionality to duplicate optical and floppy 361 images</para> 362 </listitem> 363 364 <listitem> 365 <para>User interface: various improvements for the virtual media manager</para> 366 </listitem> 367 368 <listitem> 369 <para>VMM: fixed emulation so that Plan 9 guests can start once more 370 (5.1.0 regression)</para> 371 </listitem> 372 373 <listitem> 374 <para>Storage: fixed regression breaking iSCSI (bug #17196)</para> 375 </listitem> 376 377 <listitem> 378 <para>Audio: added HDA support for more exotic guests (e.g. Haiku)</para 379 > 380 </listitem> 381 382 <listitem> 383 <para>Serial: fixed hanging I/O when using named pipes on Windows 384 (5.2.0 regression; bug #17227)</para> 385 </listitem> 386 387 <listitem> 388 <para>Serial: fixed broken communication with certain devices on Linux 389 hosts</para> 390 </listitem> 391 392 <listitem> 393 <para>Bridged networking: fixed duplicate EtherType in VLAN/priority tags 394 on Linux (5.2.0 regression; bug #17277)</para> 395 </listitem> 396 397 <listitem> 398 <para>USB/OHCI: improved behavior so that the controller state after a VM reset 399 is closer to the initial state after VM start</para> 400 </listitem> 401 402 <listitem> 403 <para>EFI: fixed HFS+ driver which in rare cases failed to access most files 404 on a volume</para> 405 </listitem> 406 407 <listitem> 408 <para>Shared clipboard: fixed hang with OS X host and Linux guest 409 (bug #15782)</para> 410 </listitem> 411 412 <listitem> 413 <para>Linux hosts: fixed kernel module compilation and start failures 414 with Linux kernel 4.14 (bug #17267)</para> 415 </listitem> 416 417 <listitem> 418 <para>X11 hosts: better handle WM_CLASS setting (bug #12534)</para> 419 </listitem> 420 421 <listitem> 422 <para>Linux guests: fixed kernel module compilation and other problems 423 with Linux kernel 4.14</para> 424 </listitem> 425 426 <listitem> 427 <para>Linux guests: fixed various 5.2.0 regressions (bugs #17163, 428 #17203)</para> 429 </listitem> 430 431 </itemizedlist> 432 </sect1> 433 434 <sect1> 435 <title>Version 5.2.0 (2017-10-17)</title> 436 437 <para>This is a major update. The following major new features 438 were added:</para> 439 440 <itemizedlist> 441 442 <listitem> 443 <para>VM export to Oracle Cloud (OPC)</para> 444 </listitem> 445 446 <listitem> 447 <para>Unattended guest installation (bug #5810; see <xref 448 linkend="basic-unattended" />)</para> 449 </listitem> 450 451 <listitem> 452 <para>Overhauled VM selector GUI (improved tools VM / global 453 tools handling, new icons)</para> 454 </listitem> 455 456 <listitem> 457 <para>Added experimental audio support for video recording</para> 458 </listitem> 459 460 </itemizedlist> 461 462 <para>In addition, the following items were fixed and/or added:</para> 463 464 <itemizedlist> 465 466 <listitem> 467 <para>VMM: fixed reason for recent Linux kernels on also recent CPU 468 models warning about "XSAVE consistency problem"</para> 469 </listitem> 470 471 <listitem> 472 <para>GUI: Virtual Media Manager rework allowing to manage media 473 attributes, like size, location, type and description</para> 474 </listitem> 475 476 <listitem> 477 <para>GUI: Host-only Network Manager implemented to simplify managing 478 corresponding networks and their attributes</para> 479 </listitem> 480 481 <listitem> 482 <para>GUI: Snapshot Pane rework allowing to manage snapshot 483 attributes, like name and description; reworked snapshot details 484 which looks more clear, corresponds to VM Details pane and reflects 485 current VM state difference according to last snapshot taken</para> 486 </listitem> 487 488 <listitem> 489 <para>GUI: Audio settings extended with possibility to enable/disable 490 audio input/output; corresponding changed were done to Audio 491 and Video Capture settings pages; VM Devices menu and status-bar 492 extended with corresponding actions and indicator as well</para> 493 </listitem> 494 495 <listitem> 496 <para>GUI: improvements with accessibility support</para> 497 </listitem> 498 499 <listitem> 500 <para>GUI: Fixed double mouse cursor when using mouse integration 501 without Guest Additions, actually a Qt 5.6 bug fixed with QT 5.6.3 502 (Mac OS X hosts only; bug #15610)</para> 503 </listitem> 504 505 <listitem> 506 <para>Audio: implemented (optional) device enumeration support for 507 audio backends</para> 508 </listitem> 509 510 <listitem> 511 <para>Audio: implemented support for host device callbacks (e.g. when 512 adding or removing an audio device)</para> 513 </listitem> 514 515 <listitem> 516 <para>Audio: HDA emulation now uses asynchronous data processing in 517 separate threads</para> 518 </listitem> 519 520 <listitem> 521 <para>Audio: implemented ability to enable or disable audio 522 input / output on-the-fly</para> 523 </listitem> 524 525 <listitem> 526 <para>Storage: implemented support for CUE/BIN images as CD/DVD media 527 including multiple tracks</para> 528 </listitem> 529 530 <listitem> 531 <para>Storage: implemented support for the controller memory buffer 532 feature for NVMe</para> 533 </listitem> 534 535 <listitem> 536 <para>Storage: first milestone of the I/O stack redesign landed</para> 537 </listitem> 538 539 <listitem> 540 <para>E1000: Fix for Windows XP freeze when booting with unplugged 541 cable</para> 542 </listitem> 543 544 <listitem> 545 <para>NAT network: do not skip some port forwarding setup when 546 multiple VMs are active (Windows hosts only; bug #17041)</para> 547 </listitem> 548 549 <listitem> 550 <para>Serial: fixed extremely rare misbehavior on VM poweroff</para> 551 </listitem> 552 553 <listitem> 554 <para>EFI: better video mode handling, supporting custom video 555 modes and easier configuration (bug #6783)</para> 556 </listitem> 557 558 <listitem> 559 <para>BIOS: properly report floppy logical sectors per track for 560 unusual formats</para> 561 </listitem> 562 563 <listitem> 564 <para>BIOS: update ATA disk parameter table vectors only if there is 565 actually a corresponding ATA disk attached</para> 566 </listitem> 567 568 <listitem> 569 <para>PXE: speed up booting by better handling pending packets when 570 the link is not up yet</para> 571 </listitem> 572 573 <listitem> 574 <para>VBoxManage: handle CPUID sub-leaf overrides better</para> 575 </listitem> 576 577 <listitem> 578 <para>Windows Additions: fix several 3D related crashes</para> 579 </listitem> 580 581 <listitem> 582 <para>Solaris hosts: allow increasing MTU size for host-only adapter to 583 9706 bytes to support jumbo frames</para> 584 </listitem> 585 586 <listitem> 587 <para>Linux Additions: on systems using systemd, make sure that only 588 the Guest Additions timesync service is active</para> 589 </listitem> 590 591 <listitem> 592 <para>many unlisted fixes and improvements</para> 593 </listitem> 594 595 </itemizedlist> 596 </sect1> 597 598 <sect1> 599 <title>Version 5.1.32 (2018-01-15)</title> 600 601 <para>This is a maintenance release. The following items were fixed and/or 602 added:</para> 603 604 <itemizedlist> 605 606 <listitem> 607 <para>GUI: fixed occasional screen corruption when host screen resolution 608 is changed</para> 609 </listitem> 610 611 <listitem> 612 <para>User interface: increase proposed disk size when creating new VMs 613 for Windows 7 and newer</para> 614 </listitem> 615 616 <listitem> 617 <para>Serial: fixed broken communication with certain devices on Linux 618 hosts</para> 619 </listitem> 620 621 <listitem> 622 <para>VMM: Fixed problems using 256MB VRAM in raw-mode VMs</para> 623 </listitem> 624 625 <listitem> 626 <para>Audio: added HDA support for more exotic guests (e.g. Haiku)</para> 627 </listitem> 628 629 <listitem> 630 <para>Audio: fixed playback with ALSA backend (5.1.28 regression)</para> 631 </listitem> 632 633 <listitem> 634 <para>USB/OHCI: fixed a problem where OHCI emulation might sporadically 635 drop data transfers</para> 636 </listitem> 637 638 <listitem> 639 <para>Windows hosts: VirtualBoxManager in the Python API no longer calls 640 CoUninitialize when destroyed</para> 641 </listitem> 642 643 <listitem> 644 <para>Linux hosts: fixed VBoxNetFlt kernel module compilation failure 645 with Linux kernel 4.14</para> 646 </listitem> 647 648 <listitem> 649 <para>Linux guests: fixed kernel module compilation and other problems 650 with Linux kernel 4.14</para> 651 </listitem> 652 653 </itemizedlist> 654 </sect1> 655 656 <sect1> 657 <title>Version 5.1.30 (2017-10-16)</title> 658 659 <para>This is a maintenance release. The following items were fixed and/or 660 added:</para> 661 662 <itemizedlist> 663 664 <listitem> 665 <para>GUI: translation updates</para> 666 </listitem> 667 668 <listitem> 669 <para>GUI: Fixed double mouse cursor when using mouse integration 670 without Guest Additions, actually a Qt 5.6 bug fixed with QT 5.6.3 671 (Mac OS X hosts only; bug #15610)</para> 672 </listitem> 673 674 <listitem> 675 <para>Solaris hosts: allow increasing MTU size for host-only adapter to 676 9706 bytes to support jumbo frames</para> 677 </listitem> 678 679 <listitem> 680 <para>Linux hosts: glibc 2.26 compile fix</para> 681 </listitem> 682 683 <listitem> 684 <para>Windows Additions: 3D related crash fix (bugs #17082, #17092)</para> 685 </listitem> 686 687 </itemizedlist> 688 </sect1> 689 690 <sect1> 691 <title>Version 5.1.28 (2017-09-13)</title> 692 693 <para>This is a maintenance release. The following items were fixed and/or 694 added:</para> 695 696 <itemizedlist> 697 698 <listitem> 699 <para>GUI: mouse events did not reach host windows behind the transparent 700 VM window (Mac OS X hosts only; bug #16246)</para> 701 </listitem> 702 703 <listitem> 704 <para>Audio: fixed accidental crashes when using the AC'97 sound 705 emulation (bug #16959)</para> 706 </listitem> 707 708 <listitem> 709 <para>Audio: fixed crash when default input or output devices have changed 710 (bugs #16968, #16969, #17004)</para> 711 </listitem> 712 <listitem> 713 <para>Audio: fixed recording when using the ALSA backend</para> 714 </listitem> 715 716 <listitem> 717 <para>Audio: fixed handle leak when using the OSS backend</para> 718 </listitem> 719 720 <listitem> 721 <para>E1000: fixed a crash related to VLAN traffic over internal 722 network (5.1.26 regression; bug #16960)</para> 723 </listitem> 724 725 <listitem> 726 <para>NAT: apply <emphasis>--natbindip1</emphasis> to TCP connections 727 (bug #16478)</para> 728 </listitem> 729 730 <listitem> 731 <para>OVF: when importing an appliance with XHCI controller, don't 732 add an OHCI controller</para> 733 </listitem> 734 <listitem> 735 <para>Mac OS X hosts: fixed a GUI crash if Spotlight is used from 736 file dialogs (5.1.20 regression; bugs #16935, #16953)</para> 737 </listitem> 738 739 <listitem> 740 <para>Linux hosts: fixed creating fixed sized VDI images 741 (bug #17010)</para> 742 </listitem> 743 744 <listitem> 745 <para>Linux hosts / guests: fixes for Linux 4.4 of openSUSE Leap 42.3 746 (bug #16966)</para> 747 </listitem> 748 749 <listitem> 750 <para>Bridged networking: align outgoing packet at word boundary, 751 preventing Windows host crash in MsLbfoProvider</para> 752 </listitem> 753 754 <listitem> 755 <para>Linux Additions: kernel drm driver support for custom EL7 756 Linux 3.10 kernel</para> 757 </listitem> 758 759 <listitem> 760 <para>Solaris Additions: hide an informational message on the bootup 761 console</para> 762 </listitem> 763 764 </itemizedlist> 765 </sect1> 766 767 <sect1> 768 <title>Version 5.1.26 (2017-07-27)</title> 769 770 <para>This is a maintenance release. The following items were fixed and/or 771 added:</para> 772 773 <itemizedlist> 774 775 <listitem> 776 <para>VMM: reset the TSC on VM reset to work around a Windows bug 777 (bug #16643)</para> 778 </listitem> 779 780 <listitem> 781 <para>Audio: fixed memory leak when enabled with VRDP connections 782 (5.1.24 regression; bug #16928)</para> 783 </listitem> 784 785 <listitem> 786 <para>Audio: fixed creation of too many sound sinks on Linux hosts when 787 using the PulseAudio backend (bug #16938)</para> 788 </listitem> 789 790 <listitem> 791 <para>Audio: implemented record gain registers for AC'97 emulation; 792 those are needed for newer Ubuntu guests which rely on those when controlling 793 gain and muting the recording (capturing) levels</para> 794 </listitem> 795 796 <listitem> 797 <para>Storage: fixed hang when using the emulated NVMe controller with the 798 SPDK (bug #16945)</para> 799 </listitem> 800 801 <listitem> 802 <para>Mouse: double click was not working with a precision touchpad 803 (bug #14632)</para> 804 </listitem> 805 806 <listitem> 807 <para>Linux hosts: properly bring up host-only network interfaces with 808 <emphasis>iproute</emphasis> (5.1.24 regression; bug #16911)</para> 809 </listitem> 810 811 <listitem> 812 <para>Linux hosts: provide Python 3 libraries for deb/rpm packages</para> 813 </listitem> 814 815 <listitem> 816 <para>Windows hosts: make it possible to use host-only networking 817 without having bridged networking installed</para> 818 </listitem> 819 820 <listitem> 821 <para>Windows guests: fixed automatic logons for Vista and newer 822 Windows guests (5.1.24 regression; bug #16921)</para> 823 </listitem> 824 825 </itemizedlist> 826 </sect1> 827 828 <sect1> 829 <title>Version 5.1.24 (2017-07-18)</title> 830 831 <para>This is a maintenance release. The following items were fixed and/or 832 added:</para> 833 834 <itemizedlist> 835 836 <listitem> 837 <para>VMM: mask the VME CPUID capability on AMD Ryzen processors 838 for now to make certain guests works, for example Windows XP</para> 839 </listitem> 840 841 <listitem> 842 <para>VMM: emulate more SSE2 instructions</para> 843 </listitem> 844 845 <listitem> 846 <para>VMM: properly clear the <emphasis>TF</emphasis> and 847 <emphasis>AC</emphasis> flags when dispatching real-mode 848 interrupts</para> 849 </listitem> 850 851 <listitem> 852 <para>GUI: fixes to make the mini-toolbar work with recent versions 853 of KDE / Plasma (bug #16325)</para> 854 </listitem> 855 856 <listitem> 857 <para>GUI: fixed a potential crash when a VM with multiple screens is 858 running in full screen / seamless mode and a host screen is removed, 859 for example when connecting to the host via RDP</para> 860 </listitem> 861 862 <listitem> 863 <para>GUI: fixed initial size hints for guests which 864 set intermediate sizes before responding (bug #16593)</para> 865 </listitem> 866 867 <listitem> 868 <para>GUI: prevent stopped screen updates or black screen on reboot 869 in a multi-screen setup under certain conditions</para> 870 </listitem> 871 872 <listitem> 873 <para>Audio: many improvements for Windows 10 guests (bugs #15189, 874 #15925, #16170, #16682, #16794 and others)</para> 875 </listitem> 876 877 <listitem> 878 <para>Storage: fixed possible crash when using Intels SPDK</para> 879 </listitem> 880 881 <listitem> 882 <para>API: use the correct file name of the VM machine state if the 883 VM settings directory is renamed, for example during grouping / 884 ungrouping a VM (bugs #16074 and #16745)</para> 885 </listitem> 886 887 <listitem> 888 <para>API: return the correct error code if powering up a VM fails</para> 889 </listitem> 890 891 <listitem> 892 <para>API: video recording did not automatically start at VM start 893 when enabled in the VM settings (bug #16803)</para> 894 </listitem> 895 896 <listitem> 897 <para>API: when relocating a medium, check that the target path is 898 fully qualified</para> 899 </listitem> 900 901 <listitem> 902 <para>EFI: fix for VMs with more than 3504MB RAM (bug #11103)</para> 903 </listitem> 904 905 <listitem> 906 <para>Host-only adapter: correctly determine IPv4 netmasks on Windows 907 hosts (bug #16826)</para> 908 </listitem> 909 910 <listitem> 911 <para>NAT network: properly do the refcounting for starting / stopping 912 the NAT / DHCP services if the NAT network is changed while the 913 adapter network connection type is anything else but NAT network</para> 914 </listitem> 915 916 <listitem> 917 <para>VBoxManage: fixed <emphasis>controlvm videocapfile</emphasis> 918 (bug #16779)</para> 919 </listitem> 920 921 <listitem> 922 <para>Windows hosts: another fix for Windows insider builds 923 (bug #16892)</para> 924 </listitem> 925 926 <listitem> 927 <para>Windows hosts: fixed crashes if driver verifier is enabled 928 (bug #15741)</para> 929 </listitem> 930 931 <listitem> 932 <para>Linux / Mac OS X hosts: more fixes for loading shared libraries 933 (5.1.20 regression; bugs #16778, #16693)</para> 934 </listitem> 935 936 <listitem> 937 <para>Linux hosts / guests: Linux 4.12 fixes (bugs #16725, #16800)</para> 938 </listitem> 939 940 <listitem> 941 <para>Linux hosts / guests: reduce the kernel stack consumption for 942 Linux kernels with <emphasis>CONFIG_CPUMASK_OFFSTACK</emphasis> 943 defined</para> 944 </listitem> 945 946 <listitem> 947 <para>Linux hosts / guests: fixes for kernel modules built with gcc-7 948 (bug #16772)</para> 949 </listitem> 950 951 <listitem> 952 <para>Linux hosts / guests: Linux 4.13 fix (bug #16887)</para> 953 </listitem> 954 955 <listitem> 956 <para>Linux hosts: don't depend on <emphasis>net-tools</emphasis> on newer 957 distributions as this package is deprecated in favour of 958 <emphasis>iproute</emphasis> (bug #16764)</para> 959 </listitem> 960 961 <listitem> 962 <para>Linux hosts: make 2D video acceleration available for older 963 Linux distributions (5.1 regression; bug #16858)</para> 964 </listitem> 965 966 <listitem> 967 <para>Linux Additions: fix for dynamic resizing with Oracle Linux 6 968 with UEK4</para> 969 </listitem> 970 971 <listitem> 972 <para>Linux Additions: make Fedora 25 and 26 Alpha work when 3D 973 pass-through is enabled</para> 974 </listitem> 975 976 <listitem> 977 <para>Linux Additions: no longer recommend removing distribution- 978 installed Additions if they are updated to our guidelines</para> 979 </listitem> 980 981 </itemizedlist> 982 </sect1> 983 984 <sect1> 985 <title>Version 5.1.22 (2017-04-28)</title> 986 987 <para>This is a maintenance release. The following items were fixed and/or 988 added:</para> 989 990 <itemizedlist> 991 992 <listitem> 993 <para>VMM: fixed <emphasis>VERR_IEM_INSTR_NOT_IMPLEMENTED</emphasis> 994 Guru Meditation under certain conditions (5.1 regression; 995 mostly Mac OS X hosts; bugs #15693, #15801, #16274, #16569, #16663)</para> 996 </listitem> 997 998 <listitem> 999 <para>VMM: fixed software virtualization on Solaris hosts 1000 (5.1.20 regression)</para> 1001 </listitem> 1002 1003 <listitem> 1004 <para>Storage: fixed a potential hang under rare circumstances 1005 (bug #16677)</para> 1006 </listitem> 1007 1008 <listitem> 1009 <para>Storage: fixed a potential crash under rare circumstances 1010 (asynchronous I/O disabled or during maintenance file operations 1011 like merging snapshots)</para> 1012 </listitem> 1013 1014 <listitem> 1015 <para>Linux hosts: make the ALSA backend work again as well as 1016 loading the GL libraries on certain hosts (5.1.20 regression; 1017 bugs #16667, #16693)</para> 1018 </listitem> 1019 1020 <listitem> 1021 <para>Linux Additions: fixed mount.vboxsf symlink problem (5.1.20 1022 regression; bug #16670)</para> 1023 </listitem> 1024 1025 </itemizedlist> 1026 </sect1> 1027 1028 <sect1> 1029 <title>Version 5.1.20 (2017-04-18)</title> 1030 1031 <para>This is a maintenance release. The following items were fixed and/or 1032 added:</para> 1033 1034 <itemizedlist> 1035 1036 <listitem> 1037 <para>GUI: don't check if the Extension Pack is up-to-date if the user 1038 is about to install a new Extension Pack (bug #16317)</para> 1039 </listitem> 1040 1041 <listitem> 1042 <para>GUI: fixed a possible crash when switching a multi-monitor VM 1043 into full-screen or seamless mode</para> 1044 </listitem> 1045 1046 <listitem> 1047 <para>GUI: fixed non-literal shortcuts if the keyboard is not captured 1048 (5.1.10 regression; Windows hosts only)</para> 1049 </listitem> 1050 1051 <listitem> 1052 <para>GUI: several mini-toolbar fixes in full-screen / seamless mode 1053 (X11 hosts only)</para> 1054 </listitem> 1055 1056 <listitem> 1057 <para>GUI: don't crash on restoring defaults in the 1058 <emphasis>appliance import</emphasis> dialog</para> 1059 </listitem> 1060 1061 <listitem> 1062 <para>Windows Additions: another fix for automatic logins for Windows 1063 Vista and newer (bug #15904)</para> 1064 </listitem> 1065 1066 <listitem> 1067 <para>ICH9: fix for Windows guests with a huge amount (>64G) of guest 1068 memory</para> 1069 </listitem> 1070 1071 <listitem> 1072 <para>BIOS: fixed El Torito hard disk emulation geometry calculation 1073 (thanks Dwight Engen)</para> 1074 </listitem> 1075 1076 </itemizedlist> 1077 </sect1> 1078 1079 <sect1> 1080 <title>Version 5.1.18 (2017-03-15)</title> 1081 1082 <para>This is a maintenance release. The following items were fixed and/or 1083 added:</para> 1084 1085 <itemizedlist> 1086 1087 <listitem> 1088 <para>Shared Folders: fixed case insensitive filename access 1089 (5.1.16 regression; Windows guests only; bug #16549)</para> 1090 </listitem> 1091 1092 <listitem> 1093 <para>Shared Folders: fixed access to long pathes 1094 (5.1.16 regression; Windows guests only; bugs #14651, #16564)</para> 1095 </listitem> 1096 1097 <listitem> 1098 <para>API: fixed snapshot handling of medium attachments and PCI device 1099 attachments (bug #16545)</para> 1100 </listitem> 1101 1102 <listitem> 1103 <para>API: make 32-bit Windows guests boot again with software 1104 virtualization if the ICH9 chipset is used (5.1.16 regression)</para> 1105 </listitem> 1106 1107 <listitem> 1108 <para>VBoxBugReport: fixed VM log collection issue</para> 1109 </listitem> 1110 1111 <listitem> 1112 <para>Linux hosts: fixed autostart service script (bug #14955)</para> 1113 </listitem> 1114 1115 <listitem> 1116 <para>Windows Additions: fixed automatic logins for Windows Vista and 1117 newer (5.1.4 regression; bug #15904)</para> 1118 </listitem> 1119 1120 </itemizedlist> 1121 </sect1> 1122 1123 <sect1> 1124 <title>Version 5.1.16 (2017-03-08)</title> 1125 1126 <para>This is a maintenance release. The following items were fixed and/or 1127 added:</para> 1128 1129 <itemizedlist> 1130 1131 <listitem> 1132 <para>VMM: don't access the <emphasis>MSR_IA32_SMM_MONITOR_CTL</emphasis> 1133 MSR if <emphasis>dual-monitor treatment</emphasis> is not available 1134 (KVM workaround, bug #14965)</para> 1135 </listitem> 1136 1137 <listitem> 1138 <para>VMM: another fix for handling certain MSRs on ancient CPUs 1139 without VT-x support for MSR bitmaps</para> 1140 </listitem> 1141 1142 <listitem> 1143 <para>VMM: fixed <emphasis>VERR_SSM_LOAD_CPUID_MISMATCH</emphasis> 1144 errors when restoring a saved state with SMP guests on hosts without 1145 the <emphasis>CPUID/HTT</emphasis> bit set (bug #16428)</para> 1146 </listitem> 1147 1148 <listitem> 1149 <para>VMM: fixed a bug in call gate emulation</para> 1150 </listitem> 1151 1152 <listitem> 1153 <para>VMM: <emphasis>FWAIT</emphasis> instruction fix</para> 1154 </listitem> 1155 1156 <listitem> 1157 <para>VMM: fixed a sporadic guest hang under certain conditions</para> 1158 </listitem> 1159 1160 <listitem> 1161 <para>GUI: hide the mini-toolbar from the taskbar and the pager on 1162 certain X11 hosts</para> 1163 </listitem> 1164 1165 <listitem> 1166 <para>GUI: better error handling on the global settings / network / 1167 host-only / DHCP server settings</para> 1168 </listitem> 1169 1170 <listitem> 1171 <para>GUI: fixes for full-screen with multiple screens</para> 1172 </listitem> 1173 1174 <listitem> 1175 <para>Host-only Network: fixed host-only adapter creation issue preventing 1176 VirtualBox installation on Windows 10 hosts (bug #16379)</para> 1177 </listitem> 1178 1179 <listitem> 1180 <para>NAT network: fixed two potential crashes in the DHCP server</para> 1181 </listitem> 1182 1183 <listitem> 1184 <para>ICH9: fixed incorrect initialization of the primary bus for PCI 1185 bridges (5.1.14 regression)</para> 1186 </listitem> 1187 1188 <listitem> 1189 <para>Storage: LsiLogic fix for Windows 10</para> 1190 </listitem> 1191 1192 <listitem> 1193 <para>USB: fixed not being able to attach certain USB devices having 1194 invalid characters in the device strings (5.0.18 regression; bug #15956)</para> 1195 </listitem> 1196 1197 <listitem> 1198 <para>USB: several fixes for the USB/IP support (bug #16462)</para> 1199 </listitem> 1200 1201 <listitem> 1202 <para>VBoxSVC: fixed another crash during shutdown under rare 1203 circumstances</para> 1204 </listitem> 1205 1206 <listitem> 1207 <para>VBoxSVC: fixed a stack overflow on (Windows debug builds 1208 only; bug #16409)</para> 1209 </listitem> 1210 1211 <listitem> 1212 <para>OVF: when importing an appliance handle more than 10 network 1213 adapters if the OVA was created by VirtualBox (bug #16401)</para> 1214 </listitem> 1215 1216 <listitem> 1217 <para>OVF: fixes for exporting and importing appliances with many 1218 disks (bug #16402)</para> 1219 </listitem> 1220 1221 <listitem> 1222 <para>VBoxManage: fixed regression with <emphasis>modifyhd 1223 --resize</emphasis> (bug #16311)</para> 1224 </listitem> 1225 1226 <listitem> 1227 <para>rdesktop-vrdp: source code tarball fixes</para> 1228 </listitem> 1229 1230 <listitem> 1231 <para>Linux Installers: do not rebuild kernel modules unnecessarily 1232 (bug #16408)</para> 1233 </listitem> 1234 1235 <listitem> 1236 <para>Linux hosts: added an action for opening the VM manager 1237 window to the .desktop file</para> 1238 </listitem> 1239 1240 <listitem> 1241 <para>Linux hosts / guests: Linux 4.11 compile fixes (bug #16506)</para> 1242 </listitem> 1243 1244 <listitem> 1245 <para>Linux Additions: added <emphasis>vboxsf</emphasis> FS modules 1246 alias (bug #16404)</para> 1247 </listitem> 1248 1249 <listitem> 1250 <para>Linux Additions: fix for the shared folders kernel module to 1251 compile on Linux 4.10</para> 1252 </listitem> 1253 1254 <listitem> 1255 <para>Linux Additions: properly install the Linux kernel module 1256 override rule on distributions without /etc/depmod.d</para> 1257 </listitem> 1258 1259 <listitem> 1260 <para>Windows Additions: fixed a crash with recent Windows 10 builds 1261 if 3D is disabled (bug #15973)</para> 1262 </listitem> 1263 1264 </itemizedlist> 1265 </sect1> 1266 1267 <sect1> 1268 <title>Version 5.1.14 (2017-01-16)</title> 1269 1270 <para>This is a maintenance release. The following items were fixed and/or 1271 added:</para> 1272 1273 <itemizedlist> 1274 1275 <listitem> 1276 <para>VMM: fixed emulation of certain instructions for 64-bit guests 1277 on 32-bit hosts</para> 1278 </listitem> 1279 1280 <listitem> 1281 <para>VMM: properly handle certain MSRs for 64-bit guests on ancient 1282 CPUs without VT-x support for MSR bitmaps (bug #13886)</para> 1283 </listitem> 1284 1285 <listitem> 1286 <para>GUI: fixed a crash with multimonitor setups under certain 1287 conditions</para> 1288 </listitem> 1289 1290 <listitem> 1291 <para>GUI: allow cloning of snapshots when the VM is running</para> 1292 </listitem> 1293 1294 <listitem> 1295 <para>NVMe: fixed compatibility with the Storage Performance Development 1296 Kit (SPDK, bug #16368)</para> 1297 </listitem> 1298 1299 <listitem> 1300 <para>VBoxSVC: fixed a crash under rare circumstances</para> 1301 </listitem> 1302 1303 <listitem> 1304 <para>VBoxManage: added a sanity check to 1305 <emphasis>modifymedium --resize</emphasis> to prevent users from 1306 resizing their hard disk from 1GB to 1PB (bug #16311)</para> 1307 </listitem> 1308 1309 <listitem> 1310 <para>Windows hosts: another fix for recent Windows 10 hosts</para> 1311 </listitem> 1312 1313 <listitem> 1314 <para>Linux hosts: Linux 4.10 fixes</para> 1315 </listitem> 1316 1317 <listitem> 1318 <para>Linux Additions: fixed protocol error during certain operations on 1319 shared folders (bug #8463)</para> 1320 </listitem> 1321 1322 </itemizedlist> 1323 </sect1> 1324 1325 <sect1> 1326 <title>Version 5.1.12 (2016-12-20)</title> 1327 1328 <para>This is a maintenance release. The following items were fixed and/or 1329 added:</para> 1330 1331 <itemizedlist> 1332 1333 <listitem> 1334 <para>VMM: fixed <emphasis>VERR_IEM_ASPECT_NOT_IMPLEMENTED</emphasis> 1335 Guru Meditations with certain Linux guests if KVM paravirtualization 1336 is enabled (5.1 regression; bugs #15613 and #16251)</para> 1337 </listitem> 1338 1339 <listitem> 1340 <para>VMM: fixed <emphasis>VERR_VMX_UNABLE_TO_START_VM</emphasis> 1341 Guru Meditations under rare conditions</para> 1342 </listitem> 1343 1344 <listitem> 1345 <para>GUI: prevent a crash under certain conditions if the VM is 1346 terminated very early</para> 1347 </listitem> 1348 1349 <listitem> 1350 <para>GUI: fixed certain keyboard capture issues (5.1.10 regression; 1351 Mac OS X hosts only; bug #16150)</para> 1352 </listitem> 1353 1354 <listitem> 1355 <para>GUI: fixed dragging guest windows in seamless mode with the 1356 keyboard captured (X11 hosts only; bug #15837)</para> 1357 </listitem> 1358 1359 <listitem> 1360 <para>GUI: fixed a problem where the <emphasis>new version detected</emphasis> 1361 dialog was covered by the <emphasis>appliance import</emphasis> dialog 1362 (Mac OS X hosts only; bug #16238)</para> 1363 </listitem> 1364 1365 <listitem> 1366 <para>Storage: fixed NVMe reset processing when doing 1367 <emphasis>rmmod nvme; modprobe nvme</emphasis> in a Linux guest 1368 (bug #16080)</para> 1369 </listitem> 1370 1371 <listitem> 1372 <para>Storage: fixed creating a snapshot when the VM is running 1373 and an NVMe controller is present</para> 1374 </listitem> 1375 1376 <listitem> 1377 <para>Storage: fixed a problem with the LsiLogic SCSI controller where 1378 requests could be lost with SMP guests</para> 1379 </listitem> 1380 1381 <listitem> 1382 <para>E1000: fixed "cable disconnected" issue (Mac OS X guests only; 1383 5.1.10 regression; bug #16260)</para> 1384 </listitem> 1385 1386 <listitem> 1387 <para>E1000: fixed "TX unit hang" issue (Linux guests only; 1388 5.1.10 regression; bug #16221)</para> 1389 </listitem> 1390 1391 <listitem> 1392 <para>Parallel ports: fixed port enumeration on Windows host (bugs 1393 #15872 and #16127)</para> 1394 </listitem> 1395 1396 <listitem> 1397 <para>API: don't crash when sanitizing certain VM names 1398 (bug #16299)</para> 1399 </listitem> 1400 1401 <listitem> 1402 <para>Linux hosts: automatically disable asynchronous I/O on Linux 2.6.18 1403 kernels as high I/O load may trigger kernel oopses on these kernels if 1404 this feature is enabled</para> 1405 </listitem> 1406 1407 <listitem> 1408 <para>Linux hosts / guests: Linux 2.6.28 compile fix (bug #16267)</para> 1409 </listitem> 1410 1411 <listitem> 1412 <para>Linux hosts: compile Linux 4.9 compile fix (bug #16286)</para> 1413 </listitem> 1414 1415 <listitem> 1416 <para>Linux Additions: warn the user about a known bug with older 1417 Linux guests (e.g. Debian 7) requiring manual work to get 3D 1418 working (bug #15319)</para> 1419 </listitem> 1420 1421 <listitem> 1422 <para>Linux Additions: fix the graphics driver build with Linux 1423 4.10 and later (bug #16298)</para> 1424 </listitem> 1425 1426 <listitem> 1427 <para>Windows Additions: fixed a crash in the WDDM driver under 1428 certain conditions</para> 1429 </listitem> 1430 1431 </itemizedlist> 1432 </sect1> 1433 1434 <sect1> 1435 <title>Version 5.1.10 (2016-11-21)</title> 1436 1437 <para>This is a maintenance release. The following items were fixed and/or 1438 added:</para> 1439 1440 <itemizedlist> 1441 1442 <listitem> 1443 <para>GUI: the USB filter settings dialog should allow to specify the 1444 USB revision in hexadecimal format (bug #15400)</para> 1445 </listitem> 1446 1447 <listitem> 1448 <para>GUI: fixed crash on certain hosts when pressing certain key 1449 combinations (Windows hosts only; bug #15719)</para> 1450 </listitem> 1451 1452 <listitem> 1453 <para>GUI: fixed issue with updating the available-geometry on 1454 host-screen work-area resize</para> 1455 </listitem> 1456 1457 <listitem> 1458 <para>GUI: don't crash / hang on certain environments if accessibility 1459 support is enabled</para> 1460 </listitem> 1461 1462 <listitem> 1463 <para>GUI: fixed various issues in Unscaled HiDPI Output mode 1464 (bug #15707)</para> 1465 </listitem> 1466 1467 <listitem> 1468 <para>GUI: extend the VM Input menu with 1469 <emphasis>Print Screen</emphasis>-related actions</para> 1470 </listitem> 1471 1472 <listitem> 1473 <para>GUI: improved handling of inserting the Guest Additions ISO image 1474 by trying all available optical drives rather than only the first one 1475 and by not asking the user if he wants to force unmounting (which 1476 doesn't work in most cases anyway)</para> 1477 </listitem> 1478 1479 <listitem> 1480 <para>API: default to RTC using UTC for Solaris 11 guests</para> 1481 </listitem> 1482 1483 <listitem> 1484 <para>Settings: be less restrictive when reading a VM configuration 1485 containing a host-only adapter without an interface name</para> 1486 </listitem> 1487 1488 <listitem> 1489 <para>Storage: fixed resizing VDI images resulting in an 1490 unbootable image under certain circumstances (bug #15983)</para> 1491 </listitem> 1492 1493 <listitem> 1494 <para>NAT: fixed several 5.1.8 regressions on Mac OS X and Windows 1495 hosts (bug #16084)</para> 1496 </listitem> 1497 1498 <listitem> 1499 <para>Audio: fixed a few 5.1.x regressions by using the audio code 1500 from 5.0.x until the audio overhaul is completed</para> 1501 </listitem> 1502 1503 <listitem> 1504 <para>VBoxManage: fixed documentation of the 1505 <emphasis>storagectl</emphasis> command (bug #15971)</para> 1506 </listitem> 1507 1508 <listitem> 1509 <para>Build system: another fix for building VirtualBox on systems 1510 which default to Python 3</para> 1511 </listitem> 1512 1513 <listitem> 1514 <para>Windows hosts: hardening fix for Windows 10 build 14971 (bug #16202)</para> 1515 </listitem> 1516 1517 <listitem> 1518 <para>Windows Additions: properly start the VirtualBox guest services even 1519 if the guest user name contains special characters (bug #15982)</para> 1520 </listitem> 1521 1522 <listitem> 1523 <para>Solaris Additions: fixed preemptible mouse notification callback being 1524 executed under a spinlock for Solaris guests</para> 1525 </listitem> 1526 1527 <listitem> 1528 <para>Linux hosts / guests: Linux 4.9 fixes (bugs #16155 and #16064)</para> 1529 </listitem> 1530 1531 <listitem> 1532 <para>Linux Additions: fixed Linux kernel module override rule 1533 (thanks Mark Furneaux)</para> 1534 </listitem> 1535 1536 </itemizedlist> 1537 </sect1> 1538 1539 <sect1> 1540 <title>Version 5.1.8 (2016-10-18)</title> 1541 1542 <para>This is a maintenance release. The following items were fixed and/or 1543 added:</para> 1544 1545 <itemizedlist> 1546 1547 <listitem> 1548 <para>GUI: fixed keyboard shortcut handling regressions (Mac OS X hosts 1549 only; bugs #15937 and #15938)</para> 1550 </listitem> 1551 1552 <listitem> 1553 <para>GUI: fixed keyboard handling regression for separate UI (Windows 1554 hosts only; bugs #15928)</para> 1555 </listitem> 1556 1557 <listitem> 1558 <para>NAT: don't exceed the maximum number of "search" suffixes. 1559 Patch from bug #15948</para> 1560 </listitem> 1561 1562 <listitem> 1563 <para>NAT: fixed parsing of port-forwarding rules with a name which 1564 contains a slash (bug #16002)</para> 1565 </listitem> 1566 1567 <listitem> 1568 <para>NAT Network: when the host has only loopback nameserver 1569 that cannot be mapped to the guests (e.g. dnsmasq running on 1570 127.0.1.1), make DHCP supply NAT Network DNS proxy as 1571 nameserver</para> 1572 </listitem> 1573 1574 <listitem> 1575 <para>Bridged Network: prevent flooding syslog with packet allocation 1576 error messages (bug #15569)</para> 1577 </listitem> 1578 1579 <listitem> 1580 <para>Audio: now using Audio Queues on Mac OS X hosts</para> 1581 </listitem> 1582 1583 <listitem> 1584 <para>Audio: fixed recording with the PulseAudio backend (5.1 regression)</para> 1585 </listitem> 1586 1587 <listitem> 1588 <para>Audio: various bugfixes</para> 1589 </listitem> 1590 1591 <listitem> 1592 <para>Snapshots: fixed regression in 5.1.4 for deleting snapshots with 1593 several disks (bug #15831)</para> 1594 </listitem> 1595 1596 <listitem> 1597 <para>Snapshots: crash fix and better error reporting when snapshot 1598 deletion failed</para> 1599 </listitem> 1600 1601 <listitem> 1602 <para>Storage: some fixes for the NVMe emulation with Windows guests</para> 1603 </listitem> 1604 1605 <listitem> 1606 <para>API: fixed initialization of SAS controllers (bug #15972)</para> 1607 </listitem> 1608 1609 <listitem> 1610 <para>Build system: make it possible to build VBox on systems which 1611 default to Python 3</para> 1612 </listitem> 1613 1614 <listitem> 1615 <para>Windows hosts: detect certain cases of 1616 <emphasis>REGDB_E_CLASSNOTREG</emphasis> errors and print a helpful 1617 error message</para> 1618 </listitem> 1619 1620 <listitem> 1621 <para>Windows hosts: adapted to changes in Windows 10 build 14901 1622 (bug #15944)</para> 1623 </listitem> 1624 1625 <listitem> 1626 <para>Windows hosts: better support for processor groups on Windows 7 1627 and later which is required on certain hosts with many CPUs</para> 1628 </listitem> 1629 1630 <listitem> 1631 <para>Windows installer / Additions: added option to prevent creating 1632 of start menu items (bug #15922)</para> 1633 </listitem> 1634 1635 <listitem> 1636 <para>Windows Additions / VGA: if the guest's power management turns 1637 a virtual screen off, blank the corresponding VM window rather than 1638 hide the window</para> 1639 </listitem> 1640 1641 <listitem> 1642 <para>Windows Additions: fixed a generic bug which could lead to 1643 freezing shared folders (bug #15662)</para> 1644 </listitem> 1645 1646 <listitem> 1647 <para>Linux hosts / guests: fix for kernels with 1648 <emphasis>CONFIG_CPUMASK_OFFSTACK</emphasis> set (bug #16020)</para> 1649 </listitem> 1650 1651 <listitem> 1652 <para>Linux Additions: don't require all virtual consoles be in text 1653 mode. This should fix cases when the guest is booted with a graphical 1654 boot screen (bug #15683)</para> 1655 </listitem> 1656 1657 <listitem> 1658 <para>Linux Additions: added depmod overrides for the vboxguest and vboxsf 1659 kernel modules to fix conflicts with modules shipped by certain Linux 1660 distributions</para> 1661 </listitem> 1662 1663 <listitem> 1664 <para>X11 Additions: disable 3D on the guest if the host does not 1665 provide enough capabilities (bug #15860)</para> 1666 </listitem> 1667 1668 </itemizedlist> 1669 </sect1> 1670 1671 <sect1> 1672 <title>Version 5.1.6 (2016-09-12)</title> 1673 1674 <para>This is a maintenance release. The following items were fixed and/or 1675 added:</para> 1676 1677 <itemizedlist> 1678 1679 <listitem> 1680 <para>GUI: fixed issue with opening '.vbox' files and it's aliases</para> 1681 </listitem> 1682 1683 <listitem> 1684 <para>GUI: keyboard grabbing fixes (bugs #15771 and #15745)</para> 1685 </listitem> 1686 1687 <listitem> 1688 <para>GUI: fix for passing through Ctrl + mouse-click (Mac OS X hosts only; 1689 bug #15714)</para> 1690 </listitem> 1691 1692 <listitem> 1693 <para>GUI: fixed automatic deletion of extension pack files (bugs #11352 1694 and #14742)</para> 1695 </listitem> 1696 1697 <listitem> 1698 <para>USB: fixed showing unknown device instead of the manufacturer or 1699 product description under certain circumstances (5.1.0 regression; 1700 bug #15764)</para> 1701 </listitem> 1702 1703 <listitem> 1704 <para>XHCI: another fix for a hanging guest under certain conditions 1705 as result of the fix for bug #15747, this time for Windows 7 guests</para> 1706 </listitem> 1707 1708 <listitem> 1709 <para>Serial: fixed high CPU usage with certain USB to serial converters 1710 on Linux hosts (bug #7796)</para> 1711 </listitem> 1712 1713 <listitem> 1714 <para>Storage: fixed attaching stream optimized VMDK images (bug #14764)</para> 1715 </listitem> 1716 1717 <listitem> 1718 <para>Storage: reject image variants which are unsupported by the 1719 backend (bug #7227)</para> 1720 </listitem> 1721 1722 <listitem> 1723 <para>Storage: fixed loading saved states created with VirtualBox 5.0.10 1724 and older when using a SCSI controller (bug #15865)</para> 1725 </listitem> 1726 1727 <listitem> 1728 <para>Storage: fixed broken NVMe emulation if the host I/O cache setting 1729 is enabled</para> 1730 </listitem> 1731 1732 <listitem> 1733 <para>Storage: fixed using multiple NVMe controllers if ICH9 is used</para> 1734 </listitem> 1735 1736 <listitem> 1737 <para>NVMe: fixed a crash during reset which could happen under certain 1738 circumstances</para> 1739 </listitem> 1740 1741 <listitem> 1742 <para>Audio: fixed microphone input (5.1.2 regression; bugs #14386 and 1743 #15802)</para> 1744 </listitem> 1745 1746 <listitem> 1747 <para>Audio: fixed crashes under certain conditions (5.1.0 1748 regression; bug #15887 and others)</para> 1749 </listitem> 1750 1751 <listitem> 1752 <para>Audio: fixed recording with the ALSA backend (5.1 regression)</para> 1753 </listitem> 1754 1755 <listitem> 1756 <para>Audio: fixed stream access mode with OSS backend (5.1 regression, 1757 thanks to Jung-uk Kim)</para> 1758 </listitem> 1759 1760 <listitem> 1761 <para>E1000: do also return masked bits when reading the ICR register, 1762 this fixes booting from iPXE (5.1.2 regression; bug #15846)</para> 1763 </listitem> 1764 1765 <listitem> 1766 <para>BIOS: fixed 4bpp scanline calculation (bug #15787)</para> 1767 </listitem> 1768 1769 <listitem> 1770 <para>API: relax the check for the version attribute in OVF/OVA 1771 appliances (bug #15856)</para> 1772 </listitem> 1773 1774 <listitem> 1775 <para>Windows hosts: fixed crashes when terminating the VM selector 1776 or other VBox COM clients (bug #15726 and others)</para> 1777 </listitem> 1778 1779 <listitem> 1780 <para>Linux Installer: fixed path to the documentation in .rpm 1781 packages (5.1.0 regression)</para> 1782 </listitem> 1783 1784 <listitem> 1785 <para>Linux Installer: fixed the vboxdrv.sh script to prevent an 1786 SELinux complaint (bug #15816)</para> 1787 </listitem> 1788 1789 <listitem> 1790 <para>Linux hosts: don't use 32-bit legacy capabilities</para> 1791 </listitem> 1792 1793 <listitem> 1794 <para>Linux Additions: Linux 4.8 fix for the kernel display driver 1795 (bugs #15890 and #15896)</para> 1796 </listitem> 1797 1798 <listitem> 1799 <para>Linux Additions: don't load the kernel modules provided by the 1800 Linux distribution but load the kernel modules from the official Guest 1801 Additions package instead (bug #15324)</para> 1802 </listitem> 1803 1804 <listitem> 1805 <para>Linux Additions: fix dynamic resizing problems in recent 1806 Linux guests (bug #15875)</para> 1807 </listitem> 1808 1809 <listitem> 1810 <para>User Manual: fixed error in the VBoxManage chapter for the 1811 <emphasis>getextradata enumerate</emphasis> example (bug #15862)</para> 1812 </listitem> 1813 1814 </itemizedlist> 1815 </sect1> 1816 1817 <sect1> 1818 <title>Version 5.1.4 (2016-08-16)</title> 1819 1820 <para>This is a maintenance release. The following items were fixed and/or 1821 added:</para> 1822 1823 <itemizedlist> 1824 1825 <listitem> 1826 <para>GUI: show actual VM uptime in the session information window</para> 1827 </listitem> 1828 1829 <listitem> 1830 <para>Audio: re-enabled speakers for Mac OS X guests (5.1.0 regression; 1831 bug #15611)</para> 1832 </listitem> 1833 1834 <listitem> 1835 <para>Audio: fixed crashes under certain conditions</para> 1836 </listitem> 1837 1838 <listitem> 1839 <para>USB: fixed a hang under certain conditions</para> 1840 </listitem> 1841 1842 <listitem> 1843 <para>USB: fixed a hanging guest under certain conditions (bug #15747)</para> 1844 </listitem> 1845 1846 <listitem> 1847 <para>PIIX4: implemented dummy SMBus controller to prevent annoying 1848 Linux kernel warnings about uninitialized SMBus base address 1849 (bug #9517)</para> 1850 </listitem> 1851 1852 <listitem> 1853 <para>NVMe: several fixes to improve stability, fixed a crash while 1854 saving a VM state</para> 1855 </listitem> 1856 1857 <listitem> 1858 <para>VMDK: fixed an issue creating fixed size images with certain 1859 sizes and the Split2G option enabled (bug #15748)</para> 1860 </listitem> 1861 1862 <listitem> 1863 <para>VHDX: fixed cloning images with VBoxManage clonehd 1864 (bug #14288)</para> 1865 </listitem> 1866 1867 <listitem> 1868 <para>Storage: fixed broken bandwidth limitation when the limit is very 1869 low (bug #14982)</para> 1870 </listitem> 1871 1872 <listitem> 1873 <para>EFI: fixed sending debug messages in the EFI firmware if a serial 1874 port is enabled (bug #12161)</para> 1875 </listitem> 1876 1877 <listitem> 1878 <para>OVF: when importing appliances, make sure that the version of the 1879 embedded VirtualBox specific settings is processed, to get the 1880 default settings handling right</para> 1881 </listitem> 1882 1883 <listitem> 1884 <para>VBoxManage: Don't try to set the medium type if there is no change 1885 (bug #13850)</para> 1886 </listitem> 1887 1888 <listitem> 1889 <para>Linux installer: fixed some scripting issues (bugs #15701 1890 and #15702)</para> 1891 </listitem> 1892 1893 <listitem> 1894 <para>Linux installer: fixed a path issue on certain Linux 1895 distributions (bug #15717)</para> 1896 </listitem> 1897 1898 <listitem> 1899 <para>Windows hosts: fixed corrupted mouse pointers with some Linux 1900 and Solaris guests (bug #15665)</para> 1901 </listitem> 1902 1903 <listitem> 1904 <para>Linux Additions: made the video driver work on 32-bit guests 1905 with large video memory sizes (bug #15621)</para> 1906 </listitem> 1907 1908 <listitem> 1909 <para>Linux Additions: made the video driver work on kernel 4.7 and 1910 later (bug #15769)</para> 1911 </listitem> 1912 1913 <listitem> 1914 <para>Linux Additions: converted a failure message to an informational 1915 one when drivers could not be stopped during upgrade (bug 1916 #15692)</para> 1917 </listitem> 1918 1919 <listitem> 1920 <para>Linux Additions: made the video driver work around an X server 1921 bug which cause screen refresh to stop (bug #15511)</para> 1922 </listitem> 1923 1924 <listitem> 1925 <para>Windows Additions: auto-resizing fixes for Windows 10 guests 1926 (bug #15257)</para> 1927 </listitem> 1928 1929 <listitem> 1930 <para>Windows Additions: fixed VBoxTray problems with Windows 2000 1931 (bug #15661)</para> 1932 </listitem> 1933 1934 </itemizedlist> 1935 </sect1> 1936 1937 <sect1> 1938 <title>Version 5.1.2 (2016-07-21)</title> 1939 1940 <para>This is a maintenance release. The following items were fixed and/or 1941 added:</para> 1942 1943 <itemizedlist> 1944 1945 <listitem> 1946 <para>VMM: several fixes</para> 1947 </listitem> 1948 1949 <listitem> 1950 <para>GUI: fixed screenshot if the VM is started in separate mode</para> 1951 </listitem> 1952 1953 <listitem> 1954 <para>GUI: fixed issue with double-click/opening registered file types 1955 (.vbox and .vbox-extpack) on Mac OS X (bug #15648)</para> 1956 </listitem> 1957 1958 <listitem> 1959 <para>GUI: fixed a bug which made it impossible close some error/warning 1960 messages using the close button</para> 1961 </listitem> 1962 1963 <listitem> 1964 <para>GUI: weakened the control over the VM window behavior allowing to resize 1965 it across multiple screens and to use in Snap Assist techniques</para> 1966 </listitem> 1967 1968 <listitem> 1969 <para>GUI: jump to the second tab of the session information window 1970 (5.1.0 regression)</para> 1971 </listitem> 1972 1973 <listitem> 1974 <para>GUI: fix for Alt-Tab</para> 1975 </listitem> 1976 1977 <listitem> 1978 <para>Storage: fixed creating fixed size VHD images (bug #15601)</para> 1979 </listitem> 1980 1981 <listitem> 1982 <para>Storage: fixed a hang during power off if the VM was suspended 1983 before and a NVMe controller is configured</para> 1984 </listitem> 1985 1986 <listitem> 1987 <para>USB: fixed a crash under certain conditions</para> 1988 </listitem> 1989 1990 <listitem> 1991 <para>Audio: make AC'97 volume control work again (5.1.0 regression; 1992 bug #15598)</para> 1993 </listitem> 1994 1995 <listitem> 1996 <para>Audio: fixed rare VM hangs when using AC'97 emulation</para> 1997 </listitem> 1998 1999 <listitem> 2000 <para>Audio: SB16 fixes</para> 2001 </listitem> 2002 2003 <listitem> 2004 <para>EFI: fixed access to devices attached to SATA port 2 and 2005 higher (bug #15607)</para> 2006 </listitem> 2007 2008 <listitem> 2009 <para>OVA: fix for checking certain signatures</para> 2010 </listitem> 2011 2012 <listitem> 2013 <para>OVA: fixed MAC address generation for appliances created by 2014 VirtualBox (5.1.0 regression; bug #15623)</para> 2015 </listitem> 2016 2017 <listitem> 2018 <para>API: fixed audio settings handling for older config files 2019 (bug #15626)</para> 2020 </listitem> 2021 2022 <listitem> 2023 <para>API: fixed truncation of USB product/vendor IDs on Linux 2024 hosts (5.1.0 regression; bug #15644)</para> 2025 </listitem> 2026 2027 <listitem> 2028 <para>API: fixed VRDP with authentication (bug #15653)</para> 2029 </listitem> 2030 2031 <listitem> 2032 <para>API: don't crash if there is no graphics controller configured 2033 (bug #15628)</para> 2034 </listitem> 2035 2036 <listitem> 2037 <para>Linux hosts: fixed EL5 builds (bug #15634)</para> 2038 </listitem> 2039 2040 <listitem> 2041 <para>non-Windows hosts: fixed a crash during shutdown under rare 2042 circumstances (bug #15568)</para> 2043 </listitem> 2044 2045 <listitem> 2046 <para>Linux Additions: fixed SELinux issue which prevented certain 2047 Linux guests to work in 3D mode (bug #15574)</para> 2048 </listitem> 2049 2050 <listitem> 2051 <para>User Manual: updates</para> 2052 </listitem> 2053 2054 </itemizedlist> 2055 </sect1> 2056 2057 <sect1> 2058 <title>Version 5.1.0 (2016-07-12)</title> 2059 2060 <para>This is a major update. The following major new features 2061 were added:</para> 2062 2063 <itemizedlist> 2064 2065 <listitem> 2066 <para>VMM: new APIC and I/O APIC implementations that result in significantly improved 2067 performance in certain situations (for example with networking, bug #15295)</para> 2068 </listitem> 2069 2070 <listitem> 2071 <para>VMM: added support for Hyper-V paravirtualized debugging of Windows guests</para> 2072 </listitem> 2073 2074 <listitem> 2075 <para>VMM: emulate even more MMIO and shadow pagetable exits without going back to 2076 user mode</para> 2077 </listitem> 2078 2079 <listitem> 2080 <para>GUI: overall migration to Qt5 (bug #11775)</para> 2081 </listitem> 2082 2083 <listitem> 2084 <para>GUI: passive API event listener improving the VM GUI performance and 2085 response time</para> 2086 </listitem> 2087 2088 <listitem> 2089 <para>Audio: added HDA (High Definition Audio) support for newer Linux guests</para> 2090 </listitem> 2091 2092 <listitem> 2093 <para>Audio: added on-demand timers which should improve the overall performance 2094 and reduce the CPU consumption</para> 2095 </listitem> 2096 2097 <listitem> 2098 <para>Audio: more fine-grained volume control for the AC'97 emulation, which now also 2099 takes the master volume control into account</para> 2100 </listitem> 2101 2102 <listitem> 2103 <para>better support for Python 3</para> 2104 </listitem> 2105 2106 </itemizedlist> 2107 2108 <para>In addition, the following items were fixed and/or added:</para> 2109 2110 <itemizedlist> 2111 2112 <listitem> 2113 <para>VMM: activate the x2APIC by default for Linux guests</para> 2114 </listitem> 2115 2116 <listitem> 2117 <para>VMM: many more fixes</para> 2118 </listitem> 2119 2120 <listitem> 2121 <para>GUI: the <emphasis>Detach UI</emphasis> action is now a part of the 2122 VM Machine menu</para> 2123 </listitem> 2124 2125 <listitem> 2126 <para>GUI: reworked session information window</para> 2127 </listitem> 2128 2129 <listitem> 2130 <para>GUI: the new VM wizard now allows to choose the VM location for the VM 2131 which is being created</para> 2132 </listitem> 2133 2134 <listitem> 2135 <para>GUI: fixed location of touch events in unscaled HiDPI mode 2136 (bugs #14366, #14367)</para> 2137 </listitem> 2138 2139 <listitem> 2140 <para>GUI: various bugfixes and internal cleanup</para> 2141 </listitem> 2142 2143 <listitem> 2144 <para>Storage: use <emphasis>fallocate()</emphasis> or similar if present to speed 2145 up creating fixed-sized disk images (bug #5967)</para> 2146 </listitem> 2147 2148 <listitem> 2149 <para>Storage: implemented NVMHCI-compatible storage controller</para> 2150 </listitem> 2151 2152 <listitem> 2153 <para>Audio: various bugfixes and infrastructure improvements</para> 2154 </listitem> 2155 2156 <listitem> 2157 <para>E1000: implemented interrupt throttling for performance improvements</para> 2158 </listitem> 2159 2160 <listitem> 2161 <para>EFI: many improvements, for example allow to boot from USB</para> 2162 </listitem> 2163 2164 <listitem> 2165 <para>OVF: improved handling of signed manifests</para> 2166 </listitem> 2167 2168 <listitem> 2169 <para>API: Windows XP guests and Windows 2003 server guests now default to 2170 the E1000 T Server network card</para> 2171 </listitem> 2172 2173 <listitem> 2174 <para>VBoxSVC: fixed several memory leaks when handling .dmg images</para> 2175 </listitem> 2176 2177 <listitem> 2178 <para>Installers: ship VBoxBugReport</para> 2179 </listitem> 2180 2181 <listitem> 2182 <para>Windows hosts: reworked COM proxy (e.g. bug #8298)</para> 2183 </listitem> 2184 2185 <listitem> 2186 <para>Linux installers: no longer rely on DKMS for module rebuilding</para> 2187 </listitem> 2188 2189 <listitem> 2190 <para>Linux Additions: fix a problem when updating the initramfs after 2191 the guest modules are compiled (bug #15579)</para> 2192 </listitem> 2193 2194 <listitem> 2195 <para>Linux Additions: try to fix a problem where the OpenGL libraries 2196 where loaded by the X server when we only support X clients 2197 (bug #15574)</para> 2198 </listitem> 2199 2200 </itemizedlist> 2201 2202 </sect1> 2203 2204 <sect1> 2205 <title>Version 5.0.24 (2016-06-28)</title> 2206 2207 <para>This is a maintenance release. The following items were fixed and/or 2208 added:</para> 2209 2210 <itemizedlist> 2211 2212 <listitem> 2213 <para>VMM: reverted to the old I/O-APIC code for now to fix certain 2214 regressions with 5.0.22 (bug #15529). This means that the networking 2215 performance with certain guests will drop to the 5.0.20 level 2216 (bug #15295). One workaround is to disable GRO for Linux guests</para> 2217 </listitem> 2218 2219 <listitem> 2220 <para>Main: when taking a screenshot, don't save garbage for blanked 2221 screens</para> 2222 </listitem> 2223 2224 <listitem> 2225 <para>NAT: correctly parse resolv.conf file with multiple 2226 separators (5.0.22 regression)</para> 2227 </listitem> 2228 2229 <listitem> 2230 <para>Storage: fixed a possible corruption of stream optimized 2231 VMDK images from VMware when opened in read/write mode for the 2232 first time</para> 2233 </listitem> 2234 2235 <listitem> 2236 <para>ACPI: notify the guest when the battery / AC state changes instead 2237 of relying on guest polling</para> 2238 </listitem> 2239 2240 <listitem> 2241 <para>Linux hosts: fixed <emphasis>VERR_VMM_SET_JMP_ABORTED_RESUME</emphasis> 2242 Guru Meditations on hosts with Linux 4.6 or later (bug #15439)</para> 2243 </listitem> 2244 2245 <listitem> 2246 <para>Solaris hosts: make the GUI work on Solaris 10 again (bug #15549)</para> 2247 </listitem> 2248 2249 </itemizedlist> 2250 </sect1> 2251 2252 <sect1> 2253 <title>Version 5.0.22 (2016-06-16)</title> 2254 2255 <para>This is a maintenance release. The following items were fixed and/or 2256 added:</para> 2257 2258 <itemizedlist> 2259 2260 <listitem> 2261 <para>VMM: fixes for certain Intel Atom hosts (bug #14915)</para> 2262 </listitem> 2263 2264 <listitem> 2265 <para>VMM: properly restore the complete FPU state for 32-bit guests 2266 on 64-bit hosts on Intel Sandy Bridge and Ivy Bridge CPUs</para> 2267 </listitem> 2268 2269 <listitem> 2270 <para>VMM: new I/O-APIC implementation fixing several bugs and improving 2271 the performance under certain conditions (bug #15295 and others)</para> 2272 </listitem> 2273 2274 <listitem> 2275 <para>VMM: fixed a potential Linux guest panic on AMD hosts</para> 2276 </listitem> 2277 2278 <listitem> 2279 <para>VMM: fixed a potential hang with 32-bit EFI guests on 2280 Intel CPUs (VT-x without unrestricted guest execution)</para> 2281 </listitem> 2282 2283 <listitem> 2284 <para>GUI: don't allow to start subsequent separate VM instances</para> 2285 </listitem> 2286 2287 <listitem> 2288 <para>GUI: raised upper limit for video capture screen resolution 2289 (bug #15432)</para> 2290 </listitem> 2291 2292 <listitem> 2293 <para>GUI: warn if the VM has less than 128MB VRAM configured and 3D 2294 enabled</para> 2295 </listitem> 2296 2297 <listitem> 2298 <para>Main: when monitoring DNS configuration changes on Windows hosts 2299 avoid false positives from competing DHCP renewals. This should fix 2300 NAT link flaps when host has multiple DHCP configured interfaces, in 2301 particular when the host uses OpnVPN</para> 2302 </listitem> 2303 2304 <listitem> 2305 <para>Main: properly display an error message if the VRDE server 2306 cannot be enabled at runtime, for example because another service 2307 is using the same port</para> 2308 </listitem> 2309 2310 <listitem> 2311 <para>NAT: Initialize guest address guess for wildcard 2312 port-forwarding rules with default guest address (bug #15412)</para> 2313 </listitem> 2314 2315 <listitem> 2316 <para>VGA: fix for a problem which made certain legacy guests crash 2317 under certain conditions (bug #14811)</para> 2318 </listitem> 2319 2320 <listitem> 2321 <para>OVF: fixed import problems for some appliances using an AHCI 2322 controller created by 3rd party applications</para> 2323 </listitem> 2324 2325 <listitem> 2326 <para>SDK: reduced memory usage in the webservice Java bindings</para> 2327 </listitem> 2328 2329 <listitem> 2330 <para>Windows hosts: fixed performance regresson with SMP guests 2331 (5.0 regression)</para> 2332 </listitem> 2333 2334 <listitem> 2335 <para>Windows hosts: fixes for the shared clipboard</para> 2336 </listitem> 2337 2338 <listitem> 2339 <para>Windows hosts: Windows hardening fix</para> 2340 </listitem> 2341 2342 <listitem> 2343 <para>Windows Additions: fixes to retain the guest display layout 2344 when resizing or disabling the guest monitors</para> 2345 </listitem> 2346 2347 <listitem> 2348 <para>Linux hosts: EL 6.8 fix (bug #15411)</para> 2349 </listitem> 2350 2351 <listitem> 2352 <para>Linux hosts: Linux 4.7 fix (bug #15459)</para> 2353 </listitem> 2354 2355 <listitem> 2356 <para>Linux Additions: Linux 4.7 fixes (bug #15444)</para> 2357 </listitem> 2358 2359 <listitem> 2360 <para>Linux Additions: fix for certain 32-bit guests (5.0.18 2361 regression; bug #15320)</para> 2362 </listitem> 2363 2364 <listitem> 2365 <para>Linux Additions: fixed mouse pointer offset (5.0.18 2366 regression; bug #15324)</para> 2367 </listitem> 2368 2369 <listitem> 2370 <para>Linux Additions: made old X.Org releases work again with 2371 kernels 3.11 and later (5.0.18 regression; bug #15319)</para> 2372 </listitem> 2373 2374 <listitem> 2375 <para>Linux Additions: fixed X.Org crash after hard guest reset 2376 (5.0.18 regression; bug #15354)</para> 2377 </listitem> 2378 2379 <listitem> 2380 <para>Linux Additions: don't stop the X11 setup if loading the 2381 shared folders module fails (5.0.18 regression)</para> 2382 </listitem> 2383 2384 <listitem> 2385 <para>Linux Additions: don't complain if the Drag and Drop service 2386 is not available on the host</para> 2387 </listitem> 2388 2389 <listitem> 2390 <para>Solaris Additions: added support for X.org 1.18</para> 2391 </listitem> 2392 2393 </itemizedlist> 2394 </sect1> 2395 2396 <sect1> 2397 <title>Version 5.0.20 (2016-04-28)</title> 2398 2399 <para>This is a maintenance release. The following items were fixed and/or 2400 added:</para> 2401 2402 <itemizedlist> 2403 2404 <listitem> 2405 <para>Storage: fixed a regression causing write requests from the BIOS 2406 to cause a Guru Meditation with the LsiLogic SCSI controller 2407 (5.0.18 regression; bug #15317)</para> 2408 </listitem> 2409 2410 <listitem> 2411 <para>Storage: several emulation fixes in the BusLogic SCSI 2412 controller emulation</para> 2413 </listitem> 2414 2415 <listitem> 2416 <para>NAT Network: support TCP in DNS proxy (same problem as 2417 in bug #14736 for NAT)</para> 2418 </listitem> 2419 2420 <listitem> 2421 <para>NAT: rework handling of port-forwarding rules (bug #13570)</para> 2422 </listitem> 2423 2424 <listitem> 2425 <para>NAT: rewrite host resolver to handle more query types 2426 and make it asynchronous so that a stalled lookup doesn't block all 2427 NAT traffic</para> 2428 </listitem> 2429 2430 <listitem> 2431 <para>Snapshots: don't crash when restoring a snapshot which has more 2432 network adapters than the current state (ie when the snapshot uses 2433 ICH9 and the current state uses PIIX3)</para> 2434 </listitem> 2435 2436 <listitem> 2437 <para>Guest Control: various bugfixes for the <emphasis>copyfrom</emphasis> 2438 and <emphasis>copyto</emphasis> commands / API (bug #14336)</para> 2439 </listitem> 2440 2441 <listitem> 2442 <para>VBoxManage: list processor features on <emphasis>list 2443 hostinfo</emphasis> (bug #15334)</para> 2444 </listitem> 2445 2446 <listitem> 2447 <para>Linux hosts: fix for Linux 4.5 if 2448 <emphasis>CONFIG_NET_CLS_ACT</emphasis> is enabled (bug #15327)</para> 2449 </listitem> 2450 2451 <listitem> 2452 <para>Windows hosts: another fix for recent Windows 10 insider builds 2453 (bug #15337)</para> 2454 </listitem> 2455 2456 <listitem> 2457 <para>Windows hosts: make it work on Windows XP again (5.0.18 2458 regression)</para> 2459 </listitem> 2460 2461 <listitem> 2462 <para>Windows Additions: fixed performance issues with PowerPoint 2463 2010 and the WDDM graphics drivers if Aero is disabled</para> 2464 </listitem> 2465 2466 </itemizedlist> 2467 2468 </sect1> 2469 2470 <sect1> 2471 <title>Version 5.0.18 (2016-04-18)</title> 2472 2473 <para>This is a maintenance release. The following items were fixed and/or 2474 added:</para> 2475 2476 <itemizedlist> 2477 2478 <listitem> 2479 <para>GUI: position off-screen windows to be fully visible again on relaunch 2480 in consistence with default-behavior (bug #15226)</para> 2481 </listitem> 2482 2483 <listitem> 2484 <para>GUI: fixed the <emphasis>View</emphasis> menu / 2485 <emphasis>Full-screen Mode</emphasis> behavior on Mac OS X El Capitan</para> 2486 </listitem> 2487 2488 <listitem> 2489 <para>GUI: fixed a test which allowed to encrypt a hard disk with an 2490 empty password</para> 2491 </listitem> 2492 2493 <listitem> 2494 <para>GUI: fixed a crash under certain conditions during VM shutdown</para> 2495 </listitem> 2496 2497 <listitem> 2498 <para>GUI: fixed the size of the VM list scrollbar in the VM selector 2499 when entering a group</para> 2500 </listitem> 2501 2502 <listitem> 2503 <para>PC speaker passthrough: fixes (Linux hosts only; bug #627)</para> 2504 </listitem> 2505 2506 <listitem> 2507 <para>Drag and drop: several fixes</para> 2508 </listitem> 2509 2510 <listitem> 2511 <para>SATA: fixed hotplug flag handling when EFI is used</para> 2512 </listitem> 2513 2514 <listitem> 2515 <para>Storage: fixed handling of encrypted disk images with SCSI 2516 controllers (bug #14812)</para> 2517 </listitem> 2518 2519 <listitem> 2520 <para>Storage: fixed possible crash with Solaris 7 if the BusLogic 2521 SCSI controller is used</para> 2522 </listitem> 2523 2524 <listitem> 2525 <para>USB: properly purge non-ASCII characters from USB strings 2526 (bugs #8801, #15222)</para> 2527 </listitem> 2528 2529 <listitem> 2530 <para>NAT Network: fixed 100% CPU load in VBoxNetNAT on Mac OS X 2531 under certain circumstances (bug #15223)</para> 2532 </listitem> 2533 2534 <listitem> 2535 <para>ACPI: fixed ACPI tables to make the display color management 2536 settings available again for older Windows versions (4.3.22 2537 regression)</para> 2538 </listitem> 2539 2540 <listitem> 2541 <para>Guest Control: fixed <emphasis>VBoxManage copyfrom</emphasis> 2542 command (bug #14336)</para> 2543 </listitem> 2544 2545 <listitem> 2546 <para>Snapshots: fixed several problems when removing older snapshots 2547 (bug #15206)</para> 2548 </listitem> 2549 2550 <listitem> 2551 <para>VBoxManage: fixed <emphasis>--verbose</emphasis> output of the 2552 <emphasis>guestcontrol</emphasis> command</para> 2553 </listitem> 2554 2555 <listitem> 2556 <para>Windows hosts: hardening fixes required for recent Windows 10 2557 insider builds (bugs #15245, #15296)</para> 2558 </listitem> 2559 2560 <listitem> 2561 <para>Windows hosts: fixed support of jumbo frames in with bridged 2562 networking (5.0.16 regression; bug #15209)</para> 2563 </listitem> 2564 2565 <listitem> 2566 <para>Windows hosts: don't prevent receiving multicast traffic if 2567 host-only adapters are installed (bug #8698)</para> 2568 </listitem> 2569 2570 <listitem> 2571 <para>Linux hosts: added support for the new naming scheme of NVME disks when 2572 creating raw disks</para> 2573 </listitem> 2574 2575 <listitem> 2576 <para>Solaris hosts / guests: properly sign the kernel modules (bug #12608)</para> 2577 </listitem> 2578 2579 <listitem> 2580 <para>Linux hosts / guests: Linux 4.5 fixes (bug #15251)</para> 2581 </listitem> 2582 2583 <listitem> 2584 <para>Linux hosts / guests: Linux 4.6 fixes (bug #15298)</para> 2585 </listitem> 2586 2587 <listitem> 2588 <para>Linux Additions: added a kernel graphics driver to support graphics 2589 when X.Org does not have root rights (bug #14732)</para> 2590 </listitem> 2591 2592 <listitem> 2593 <para>Linux/Solaris Additions: fixed several issues causing Linux/Solatis 2594 guests using software rendering when 3D acceleration is available</para> 2595 </listitem> 2596 2597 <listitem> 2598 <para>Windows Additions: fixed a hang with PowerPoint 2010 and the WDDM 2599 drivers if Aero is disabled</para> 2600 </listitem> 2601 2602 </itemizedlist> 2603 2604 </sect1> 2605 2606 <sect1> 2607 <title>Version 5.0.16 (2016-03-04)</title> 2608 2609 <para>This is a maintenance release. The following items were fixed and/or 2610 added:</para> 2611 2612 <itemizedlist> 2613 2614 <listitem> 2615 <para>VMM: fixed a problem which could lead to a wrong guest behavior on 2616 AMD CPUs (bugs #14831 and #15186)</para> 2617 </listitem> 2618 2619 <listitem> 2620 <para>GUI: don't try to synchronize the HID LEDs if the VM window is not 2621 active or if it's minimized (Windows / Mac OS X hosts only; bug #14302)</para> 2622 </listitem> 2623 2624 <listitem> 2625 <para>GUI: prevent a crash during startup under rare conditions</para> 2626 </listitem> 2627 2628 <listitem> 2629 <para>GUI: sub-menu option to disable the guest-OS type overlay in the 2630 application dock icon on Mac OS X</para> 2631 </listitem> 2632 2633 <listitem> 2634 <para>GUI: position off-screen windows to be fully visible again on relaunch</para> 2635 </listitem> 2636 2637 <listitem> 2638 <para>GUI: hide the VT-x/AMD-V checkbox if raw-mode is not supported 2639 (usually Mac OS X hosts; bug #15178)</para> 2640 </listitem> 2641 2642 <listitem> 2643 <para>PC speaker passthrough: new experimental feature, available on 2644 Linux host only</para> 2645 </listitem> 2646 2647 <listitem> 2648 <para>Audio: several fixes for Mac OS X hosts + guests</para> 2649 </listitem> 2650 2651 <listitem> 2652 <para>Audio: properly handle default audio device changes (Windows hosts)</para> 2653 </listitem> 2654 2655 <listitem> 2656 <para>USB: serveral fixes for the xHCI controller (e.g. for webcam 2657 passthrough)</para> 2658 </listitem> 2659 2660 <listitem> 2661 <para>BIOS: fixed int15/AH=83/AL=00 function (4.2.0 regression)</para> 2662 </listitem> 2663 2664 <listitem> 2665 <para>iPXE: enable the HTTP download protocol on non-Linux hosts (bug #13628)</para> 2666 </listitem> 2667 2668 <listitem> 2669 <para>Shared folders: fixed a failure to load the saved state under 2670 certain circumstances (bug #6314)</para> 2671 </listitem> 2672 2673 <listitem> 2674 <para>Guest Control: added support for (cached) Active Directory authentication 2675 in case the domain controller is not reachable (anymore)</para> 2676 </listitem> 2677 2678 <listitem> 2679 <para>Serial ports: raised the number of serial ports per VM from 2 to 4 2680 (bug #9109)</para> 2681 </listitem> 2682 2683 <listitem> 2684 <para>Serial ports: fix for the TCP/IP backend (Windows hosts only; bug #15188)</para> 2685 </listitem> 2686 2687 <listitem> 2688 <para>SDK: make the Python webservice API binding work again (5.0 regression)</para> 2689 </listitem> 2690 2691 <listitem> 2692 <para>Seamless mode: fixed a crash under certain circumstances 2693 (bug #15106)</para> 2694 </listitem> 2695 2696 <listitem> 2697 <para>Linux hosts: fixed the /sbin/rcvboxdrv script as well as the missing 2698 shebang in two scripts (bugs #15055 and #15057)</para> 2699 </listitem> 2700 2701 <listitem> 2702 <para>Linux hosts: properly uninstall Python files installed by the 2703 .run installer</para> 2704 </listitem> 2705 2706 <listitem> 2707 <para>Windows hosts: hardening fix required for recent Windows insider 2708 builds (bug #14052)</para> 2709 </listitem> 2710 2711 <listitem> 2712 <para>Windows hosts: fixed Python installation path (bug #13131)</para> 2713 </listitem> 2714 2715 <listitem> 2716 <para>Windows hosts: support MTU larger than 2 KB with bridged 2717 networking (bug #15140)</para> 2718 </listitem> 2719 2720 <listitem> 2721 <para>Windows hosts / guests: properly sign binaries using a sha-256 2722 certificate (bug #15054)</para> 2723 </listitem> 2724 2725 <listitem> 2726 <para>Windows Additions: fixed guest property enumeration of logged-in 2727 users</para> 2728 </listitem> 2729 2730 <listitem> 2731 <para>Windows Additions: fixed sporadical failure of the graphics driver 2732 in Windows 10 guests (bug #14409)</para> 2733 </listitem> 2734 2735 <listitem> 2736 <para>Windows Additions: under rare circumstances no mouse movement 2737 events were delivered to the guest</para> 2738 </listitem> 2739 2740 </itemizedlist> 2741 </sect1> 2742 2743 <sect1> 2744 <title>Version 5.0.14 (2016-01-19)</title> 2745 2746 <para>This is a maintenance release. The following items were fixed and/or 2747 added:</para> 2748 2749 <itemizedlist> 2750 2751 <listitem> 2752 <para>GUI: properly limit the number of VCPUs to the number of physical 2753 cores on Mac OS X (bug #15018)</para> 2754 </listitem> 2755 2756 <listitem> 2757 <para>Audio: fixed a bug which prevented loading a saved state 2758 of a saved guests with HDA emulation (5.0.12 regression; bug #14981)</para> 2759 </listitem> 2760 2761 <listitem> 2762 <para>Audio: don't crash if the backend is unable to initialize 2763 (bug #14960)</para> 2764 </listitem> 2765 2766 <listitem> 2767 <para>Audio: fixed audio capture on Mac OS X (bug #14386)</para> 2768 </listitem> 2769 2770 <listitem> 2771 <para>Storage: fixed a possible crash when attaching the same ISO image 2772 multiple times to the same VM (bug #14951)</para> 2773 </listitem> 2774 2775 <listitem> 2776 <para>BIOS: properly report if two floppy drives are attached</para> 2777 </listitem> 2778 2779 <listitem> 2780 <para>USB: fixed a problem with filters which would not capture the 2781 device under certain circumstances (5.0.10 regression; bug #15042)</para> 2782 </listitem> 2783 2784 <listitem> 2785 <para>ExtPack: black-list Extension Packs older than 4.3.30 due to 2786 incompatible changes not being properly handled in the past</para> 2787 </listitem> 2788 2789 <listitem> 2790 <para>Windows hosts: fixed a regression which caused robocopy 2791 to fail (bug #14958)</para> 2792 </listitem> 2793 2794 <listitem> 2795 <para>Linux hosts: properly create the <emphasis>/sbin/rcvboxdrv</emphasis> 2796 symbolic link (5.0.12 regression; bug #14989)</para> 2797 </listitem> 2798 2799 <listitem> 2800 <para>Mac OS X hosts: several fixes for USB on El Capitan (bug #14677)</para> 2801 </listitem> 2802 2803 <listitem> 2804 <para>Linux Additions: fixes for Linux 4.5 (bug #15032)</para> 2805 </listitem> 2806 2807 </itemizedlist> 2808 </sect1> 2809 2810 <sect1> 2811 <title>Version 5.0.12 (2015-12-18)</title> 2812 2813 <para>This is a maintenance release. The following items were fixed and/or 2814 added:</para> 2815 2816 <itemizedlist> 2817 2818 <listitem> 2819 <para>GUI: fixed wrong scrolling behaviour in the VM selector window 2820 when a VM item is dragged out of the chooser-pane area</para> 2821 </listitem> 2822 2823 <listitem> 2824 <para>GUI: fixed the validation of IPv6 port-forwarding rules</para> 2825 </listitem> 2826 2827 <listitem> 2828 <para>GUI: suppress the first-run wizard if a CD/DVD medium is 2829 inserted using the selector UI</para> 2830 </listitem> 2831 2832 <listitem> 2833 <para>GUI: fixed the Ctrl+Break key sequence scan codes 2834 (bug #14927)</para> 2835 </listitem> 2836 2837 <listitem> 2838 <para>GUI: improved handling of text selection mouse pointer (bug #750)</para> 2839 </listitem> 2840 2841 <listitem> 2842 <para>Host services: fixed a crash during VM shutdown under rare 2843 conditions (5.0.6 regression; bug #14841)</para> 2844 </listitem> 2845 2846 <listitem> 2847 <para>Shared folders: fixed a sharing violation if a file is opened 2848 to check the attributes (Windows hosts only; bug #14450)</para> 2849 </listitem> 2850 2851 <listitem> 2852 <para>Webcam: passthrough fix for certain devices (Mac OS X hosts only)</para> 2853 </listitem> 2854 2855 <listitem> 2856 <para>XHCI: fixed broken emulation if software virtualization is used</para> 2857 </listitem> 2858 2859 <listitem> 2860 <para>XHCI: several fixes</para> 2861 </listitem> 2862 2863 <listitem> 2864 <para>3D: fixed state handling under certain conditions (bug #13487)</para> 2865 </listitem> 2866 2867 <listitem> 2868 <para>Audio: several fixes</para> 2869 </listitem> 2870 2871 <listitem> 2872 <para>BIOS: added LBA64 support for being able to boot from huge hard 2873 disks(bug #7415)</para> 2874 </listitem> 2875 2876 <listitem> 2877 <para>EFI: fix for Windows 10 guests</para> 2878 </listitem> 2879 2880 <listitem> 2881 <para>ExtPack: before installing an Extension Pack check if there are 2882 VMs running to prevent file system locking issues</para> 2883 </listitem> 2884 2885 <listitem> 2886 <para>rdesktop-vrdp: source code tarball fixes</para> 2887 </listitem> 2888 2889 <listitem> 2890 <para>Windows hosts: fixed hang when using VBoxAuthSimple library for 2891 VRDP external authentication (bug #14931)</para> 2892 </listitem> 2893 2894 <listitem> 2895 <para>Windows hosts: fixed a regression which prevented it to attach to 2896 a physical network adapter having TCP/IP disabled (bug #14578)</para> 2897 </listitem> 2898 2899 <listitem> 2900 <para>Windows hosts: fixed a regression which caused multi-port adapters 2901 to be shown as a single adapter (bugs #14558, #14622)</para> 2902 </listitem> 2903 2904 <listitem> 2905 <para>Windows hosts: fixed a regression which caused created host-only 2906 adapters to not appear in the list (bug #14437)</para> 2907 </listitem> 2908 2909 <listitem> 2910 <para>Windows hosts: fixed host-only adapter creation issues related 2911 to Windows 10 (bugs #14040, #14545)</para> 2912 </listitem> 2913 2914 <listitem> 2915 <para>Linux hosts: .desktop file compatibility issue (bug #14808)</para> 2916 </listitem> 2917 2918 <listitem> 2919 <para>Linux hosts / guests: fixes for RHEL 7.2 (bug #14866)</para> 2920 </listitem> 2921 2922 <listitem> 2923 <para>Linux hosts: the command for recompiling the host kernel modules 2924 was changed again, to <emphasis>/sbin/rcvboxdrv setup</emphasis> (bug 2925 #14723)</para> 2926 </listitem> 2927 2928 <listitem> 2929 <para>Linux hosts: some fixes for PCI passthrough (still highly 2930 experimental)</para> 2931 </listitem> 2932 2933 <listitem> 2934 <para>Linux/Mac OS X hosts: fixed a VM hang during startup under certain 2935 circumstances (bug #14933)</para> 2936 </listitem> 2937 2938 <listitem> 2939 <para>Solaris hosts: added Python 2.7 bindings</para> 2940 </listitem> 2941 2942 <listitem> 2943 <para>Mac OS X hosts: fixed a possible crash when the default input or 2944 output audio device changes</para> 2945 </listitem> 2946 2947 <listitem> 2948 <para>Mac OS X hosts: fixed a panic under certain conditions</para> 2949 </listitem> 2950 2951 <listitem> 2952 <para>Linux Additions: prevent the compiler from doing dead-code 2953 elemination on vital code in guest / host communication (bug #14497)</para> 2954 </listitem> 2955 2956 <listitem> 2957 <para>Linux Additions: when mounting a shared folder, explicitly pass 2958 the share name so that /proc/mounts contains this name instead of 'none'</para> 2959 </listitem> 2960 2961 <listitem> 2962 <para>Linux Additions: workaround for a systemd problem in conjunction 2963 with SELinux which prevented to properly enable the 'vboxadd' service 2964 during while upgrading the Additions</para> 2965 </listitem> 2966 2967 </itemizedlist> 2968 </sect1> 2969 2970 <sect1> 2971 <title>Version 5.0.10 (2015-11-10)</title> 2972 2973 <para>This is a maintenance release. The following items were fixed and/or 2974 added:</para> 2975 2976 <itemizedlist> 2977 2978 <listitem> 2979 <para>VMM: improved support for certain Intel Atom CPUs (bug #14773)</para> 2980 </listitem> 2981 2982 <listitem> 2983 <para>VMM: system register emulation fix (5.0 regression; bug #14515)</para> 2984 </listitem> 2985 2986 <listitem> 2987 <para>GUI: fixed immediate screenshot issue (bug #14108)</para> 2988 </listitem> 2989 2990 <listitem> 2991 <para>GUI: fixed another 3D overlay window reparenting issue when the 2992 VM is switched to full-screen mode on X11 hosts</para> 2993 </listitem> 2994 2995 <listitem> 2996 <para>GUI: fixed help index (bug #14722)</para> 2997 </listitem> 2998 2999 <listitem> 3000 <para>GUI: fixed state synchronization issue in the VM manager window 3001 when VM was paused from its runtime window</para> 3002 </listitem> 3003 3004 <listitem> 3005 <para>Audio: fixed suspending/resuming audio streams on VM 3006 pause/unpause (bug #14784)</para> 3007 </listitem> 3008 3009 <listitem> 3010 <para>Audio: properly reset AC'97 audio streams, otherwise there is 3011 silence until a non-48 kHz stream is played</para> 3012 </listitem> 3013 3014 <listitem> 3015 <para>Audio: fixed a small emulation quirk of the AD1980 codec of the 3016 HDA device to make recent linux guests work (bug #14653)</para> 3017 </listitem> 3018 3019 <listitem> 3020 <para>USB: serveral fixes for the xHCI controller</para> 3021 </listitem> 3022 3023 <listitem> 3024 <para>USB: fixed a crash under certain conditions on hosts with Linux 3025 kernels older than version 3.3</para> 3026 </listitem> 3027 3028 <listitem> 3029 <para>USB: better identification of certain USB devices</para> 3030 </listitem> 3031 3032 <listitem> 3033 <para>NAT: support TCP in DNS proxy (bug #14736)</para> 3034 </listitem> 3035 3036 <listitem> 3037 <para>NAT Network: fixed sporadic crashes on Windows hosts (bug #13899)</para> 3038 </listitem> 3039 3040 <listitem> 3041 <para>API: when creating differencing images (e.g. as part of a snapshot 3042 or cloning a VM) use the same disk image variant as the parent image 3043 if possible, which means that e.g. a diff image for a VMDK image 3044 split into 2 GB files will also be split (bug #14764)</para> 3045 </listitem> 3046 3047 <listitem> 3048 <para>API: event queue handling fixes preventing loss of certain events 3049 at runtime (e.g. new webcam attached), particularly important on Mac 3050 OS X hosts</para> 3051 </listitem> 3052 3053 <listitem> 3054 <para>Webcam: passthrough fix for certain devices (Windows hosts only)</para> 3055 </listitem> 3056 3057 <listitem> 3058 <para>VBoxManage: don't crash on <emphasis>snapshot restorecurrent / 3059 edit</emphasis> if the VM has no snapshots</para> 3060 </listitem> 3061 3062 <listitem> 3063 <para>VBoxManage: don't crash on <emphasis>controlvm 3064 addencpassword</emphasis> (bug #14729)</para> 3065 </listitem> 3066 3067 <listitem> 3068 <para>Mac OS X hosts: use the correct kernel on certain hosts</para> 3069 </listitem> 3070 3071 <listitem> 3072 <para>Windows hosts: fixed VRDP external authentication</para> 3073 </listitem> 3074 3075 <listitem> 3076 <para>Windows hosts: allow to use a shared folder path with extended-length 3077 path prefix (5.0 regression; bug #14651)</para> 3078 </listitem> 3079 3080 <listitem> 3081 <para>Windows hosts: fix a crash in the netfilter host driver under 3082 certain conditions (bug #14799)</para> 3083 </listitem> 3084 3085 <listitem> 3086 <para>Windows host installer: documented and fixed public properties which 3087 can be used to control the installation to some extent</para> 3088 </listitem> 3089 3090 <listitem> 3091 <para>Windows host installer: fixed not starting the actual installation 3092 when showing the version information or help dialogs</para> 3093 </listitem> 3094 3095 <listitem> 3096 <para>X11 Additions: added basic support for X.Org Server 1.18 (3D 3097 requires additional fixes)</para> 3098 </listitem> 3099 3100 </itemizedlist> 3101 </sect1> 3102 3103 <sect1> 3104 <title>Version 5.0.8 (2015-10-20)</title> 3105 3106 <para>This is a maintenance release. The following items were fixed and/or 3107 added:</para> 3108 3109 <itemizedlist> 3110 3111 <listitem> 3112 <para>GUI: Mac OS X: Restore green zoom button for VM windows 3113 (it was hidden in previous release to avoid native full-screen issues). 3114 For Yosemite and El Capitan this button should work accordingly to the 3115 Apple HIG: Full-screen by default, maximize if the user holds the 3116 Option key</para> 3117 </listitem> 3118 3119 <listitem> 3120 <para>Serial ports: fixed wrong IRQ number for the first serial port in 3121 the ACPI tables (5.0.6 regression; bug #14659)</para> 3122 </listitem> 3123 3124 <listitem> 3125 <para>API: fixed a 5.0 regression in <emphasis>VBoxManage setproperty 3126 defaultfrontend</emphasis> (bug #14696)</para> 3127 </listitem> 3128 3129 <listitem> 3130 <para>VBoxManage/vbox-img: conversion to RAW images could result in 3131 a disk image containing all zeroes</para> 3132 </listitem> 3133 3134 <listitem> 3135 <para>Linux hosts: several fixes for systemd integration in .deb / .rpm 3136 packages (e.g. bug #14665). The command for recompiling the host kernel 3137 modules was changed to <emphasis>/sbin/vboxconfig</emphasis></para> 3138 </listitem> 3139 3140 <listitem> 3141 <para>Linux hosts: make host-only interfaces report operstate UP 3142 only when they have VMs attached (bug #14526)</para> 3143 </listitem> 3144 3145 <listitem> 3146 <para>Mac OS X hosts: fix bpf capture and accounting of traffic 3147 on bridged and host-only interfaces (bug #14553)</para> 3148 </listitem> 3149 3150 <listitem> 3151 <para>Windows guests: fixed 3D rendering issues on high resolution 3152 displays</para> 3153 </listitem> 3154 3155 <listitem> 3156 <para>Windows Additions: fixed problems with 3D acceleration on Windows 3157 hosts with Intel HD graphics (bug #14670)</para> 3158 </listitem> 3159 3160 <listitem> 3161 <para>Linux Additions: fix service starting on Debian systems with 3162 systemd installed but not in use (bug #14683)</para> 3163 </listitem> 3164 3165 </itemizedlist> 3166 3167 </sect1> 3168 3169 <sect1> 3170 <title>Version 5.0.6 (2015-10-02)</title> 3171 3172 <para>This is a maintenance release. The following items were fixed and/or 3173 added:</para> 3174 3175 <itemizedlist> 3176 3177 <listitem> 3178 <para>GUI: the update check now uses the HTTP system proxy settings by 3179 default</para> 3180 </listitem> 3181 3182 <listitem> 3183 <para>GUI: About dialog improvements. Copyable version text, do not close 3184 dialog on mouse-clicks and focus losing, explicit close button at the 3185 bottom of dialog and disabled close button fix on OS X. (bugs #9912, 3186 #12749)</para> 3187 </listitem> 3188 3189 <listitem> 3190 <para>GUI: fixed bug when re-assigning shortcuts (bug #14565)</para> 3191 </listitem> 3192 3193 <listitem> 3194 <para>GUI: fixed default focus button in message-box dialogs (bug #14486)</para> 3195 </listitem> 3196 3197 <listitem> 3198 <para>GUI: fixed settings dialog which is opened if the network settings 3199 need to be changed at VM startup (5.0 regression; bug #14601)</para> 3200 </listitem> 3201 3202 <listitem> 3203 <para>GUI: fixed crash during VM start if an early error message needs 3204 to be shown, for example Linux kernel modules not present (bug #14646)</para> 3205 </listitem> 3206 3207 <listitem> 3208 <para>Bridged Networking: fixed handling of guest DHCP requests without UDP 3209 checksum when bridging to a wireless interface (bug #14615)</para> 3210 </listitem> 3211 3212 <listitem> 3213 <para>Audio: latency fixes (Windows hosts only; bug #4088)</para> 3214 </listitem> 3215 3216 <listitem> 3217 <para>Guest Control: correctly set <emphasis>USERNAME</emphasis> and 3218 <emphasis>USERPROFILE</emphasis> environment variables (Windows 3219 guests only)</para> 3220 </listitem> 3221 3222 <listitem> 3223 <para>Guest Control: several fixes</para> 3224 </listitem> 3225 3226 <listitem> 3227 <para>API: properly restore NAT port forwarding rules when reverting to 3228 a snapshot</para> 3229 </listitem> 3230 3231 <listitem> 3232 <para>Parallel ports: Several fixes allowing to enable two parallel ports 3233 for a VM</para> 3234 </listitem> 3235 3236 <listitem> 3237 <para>VBoxManage: fixed wrong output of <emphasis>debugvm show</emphasis> 3238 command</para> 3239 </listitem> 3240 3241 <listitem> 3242 <para>VBoxManage: fixed hang when specifying logging groups with 3243 <emphasis>debugvm log</emphasis> starting with 3244 <emphasis>h</emphasis>, for example <emphasis>hex</emphasis></para> 3245 </listitem> 3246 3247 <listitem> 3248 <para>Windows hosts: renamed <emphasis>VBoxStartup.log</emphasis> to 3249 <emphasis>VBoxHardening.log</emphasis> and provide this log file in 3250 the GUI log viewer</para> 3251 </listitem> 3252 3253 <listitem> 3254 <para>Windows hosts: fixed a small memory leak in the Windows host interface 3255 driver (VBoxNetAdp) which caused a BSOD if the driver verifier is enabled 3256 (bug #14562)</para> 3257 </listitem> 3258 3259 <listitem> 3260 <para>Windows hosts: fixed a failure to start VMs on hosts where dsound.dll 3261 is not available (bug #14574)</para> 3262 </listitem> 3263 3264 <listitem> 3265 <para>Windows hosts: another fix for <emphasis>VERR_LDR_MISMATCH_NATIVE</emphasis> 3266 errors (bug #14579)</para> 3267 </listitem> 3268 3269 <listitem> 3270 <para>Windows hosts: fixed host-to-guest communication with bridged networking 3271 (bugs #14326, #14457)</para> 3272 </listitem> 3273 3274 <listitem> 3275 <para>Windows hosts: fixed broken data receiving from the serial device with 3276 the named pipe backend if Kaspersky AV is installed</para> 3277 </listitem> 3278 3279 <listitem> 3280 <para>Linux hosts: Linux 4.3 compile fixes</para> 3281 </listitem> 3282 3283 <listitem> 3284 <para>Linux hosts: installer fix for certain systems (bug #14627)</para> 3285 </listitem> 3286 3287 <listitem> 3288 <para>Linux hosts / guests: native systemd support for the host/guest 3289 installer scripts. The scripts for re-compiling the kernel modules 3290 are now located at /sbin/rcvboxdrv (host) and /sbin/rcvboxadd 3291 (Guest Additions)</para> 3292 </listitem> 3293 3294 <listitem> 3295 <para>Mac OS X hosts: GUI-related fixes for El Capitan</para> 3296 </listitem> 3297 3298 <listitem> 3299 <para>Mac OS X hosts: fixed a problem with capturing USB devices under 3300 El Capitan</para> 3301 </listitem> 3302 3303 <listitem> 3304 <para>Mac OS X hosts: allow colon character on shared folders (bug #14554)</para> 3305 </listitem> 3306 3307 <listitem> 3308 <para>Linux Additions: properly set the VBoxService process ID in the PID 3309 file (bug #14571)</para> 3310 </listitem> 3311 3312 <listitem> 3313 <para>Linux Additions: Guest Control fixes (bug #14573)</para> 3314 </listitem> 3315 3316 <listitem> 3317 <para>Windows Additions: fixed shutting down VBoxTray when running with 3318 older VirtualBox host versions</para> 3319 </listitem> 3320 3321 <listitem> 3322 <para>Windows Additions: fixed video playback with VLC and Windows Media 3323 Player when the WDDM driver is used and 3D is not used</para> 3324 </listitem> 3325 3326 <listitem> 3327 <para>Windows Additions: prevent a possible VLC crash when the WDDM driver 3328 is used and 3D is enabled by implementing YV12 surfaces</para> 3329 </listitem> 3330 3331 </itemizedlist> 3332 </sect1> 3333 3334 <sect1> 3335 <title>Version 5.0.4 (2015-09-08)</title> 3336 3337 <para>This is a maintenance release. The following items were fixed and/or 3338 added:</para> 3339 3340 <itemizedlist> 3341 3342 <listitem> 3343 <para>VMM: fixed an issue with Windows 10 guest kernel debugging over the 3344 network for Hyper-V paravirtualized VMs</para> 3345 </listitem> 3346 3347 <listitem> 3348 <para>VMM: fixed a bug which prevented reading the saved state of the 3349 'PATM' unit from VirtualBox 4.3.x (bug #14512)</para> 3350 </listitem> 3351 3352 <listitem> 3353 <para>GUI: changed default OS type for Windows from Windows XP to Windows 7</para> 3354 </listitem> 3355 3356 <listitem> 3357 <para>GUI: added another pre-defined guest screen resolution (bug #14384)</para> 3358 </listitem> 3359 3360 <listitem> 3361 <para>GUI: fixed update check which was broken due to changing the 3362 location of the root certificates (bug #13096)</para> 3363 </listitem> 3364 3365 <listitem> 3366 <para>GUI: fixed issues with synchronization of Caps lock / Num lock / Scroll 3367 lock on Windows hosts (bug #14302)</para> 3368 </listitem> 3369 3370 <listitem> 3371 <para>GUI: don't crash during VM shutdown if 2D video acceleration and 3D support 3372 are enabled (Mac OS X hosts only)</para> 3373 </listitem> 3374 3375 <listitem> 3376 <para>GUI: several seamless fixes for certain X11 window managers, also when 3377 used in multi-screen setups</para> 3378 </listitem> 3379 3380 <listitem> 3381 <para>GUI: Log window size, position and cursor-position fixes</para> 3382 </listitem> 3383 3384 <listitem> 3385 <para>Audio: fixed playing leftover/deprecated audio samples</para> 3386 </listitem> 3387 3388 <listitem> 3389 <para>Audio: fixed playing audio after suspending the host (5.0 regression; 3390 Linux hosts using the ALSA backend)</para> 3391 </listitem> 3392 3393 <listitem> 3394 <para>Audio: fixed playing short audio samples which were chopped off 3395 formerly</para> 3396 </listitem> 3397 3398 <listitem> 3399 <para>Audio: fixed distortions on OS X when the sample rate of the guest stream 3400 and host device don't match</para> 3401 </listitem> 3402 3403 <listitem> 3404 <para>Storage: fixed raw disk access and flat VMDK image access which would 3405 be always opened readonly (5.0.2 regression; bugs #14425, #14461)</para> 3406 </listitem> 3407 3408 <listitem> 3409 <para>Storage: fixed initial encryption of VDI images after they were 3410 compacted (bug #14496)</para> 3411 </listitem> 3412 3413 <listitem> 3414 <para>VGA: fix for certain graphics modes (bug #14516)</para> 3415 </listitem> 3416 3417 <listitem> 3418 <para>NAT: don't freeze while the VM is paused if the network attachment 3419 mode is changed from/to NAT with activated port forwarding</para> 3420 </listitem> 3421 3422 <listitem> 3423 <para>OVF: fixed duplicate USB controller entries in exported OVA/OVF 3424 (bug #14462)</para> 3425 </listitem> 3426 3427 <listitem> 3428 <para>Shared Folders: fixed a path separator issue (bug #14434)</para> 3429 </listitem> 3430 3431 <listitem> 3432 <para>Drag and drop: fixed crashes on OS X hosts when doing host-to-guest 3433 transfers</para> 3434 </listitem> 3435 3436 <listitem> 3437 <para>VBoxManage: another attempt to not deny changing the network adapter 3438 type at VM runtime (5.0 regression; bug #14308)</para> 3439 </listitem> 3440 3441 <listitem> 3442 <para>VBoxManage: fixed broken <emphasis>guestcontrol <VM-Name> list</emphasis> 3443 command (5.0 regression)</para> 3444 </listitem> 3445 3446 <listitem> 3447 <para>VBoxManage: fixed broken Guest Control stdout/stderr output (5.0 regression)</para> 3448 </listitem> 3449 3450 <listitem> 3451 <para>Mac OS X hosts: fixed remaining problems with activated SMAP (Broadwell 3452 and later; bug #14412)</para> 3453 </listitem> 3454 3455 <listitem> 3456 <para>Mac OS X hosts: fixed broken 3D support (5.0.2 regression; 3457 bug #14476)</para> 3458 </listitem> 3459 3460 <listitem> 3461 <para>Linux hosts: Linux 4.2 fix</para> 3462 </listitem> 3463 3464 <listitem> 3465 <para>Linux hosts: don't crash on older Linux distributions if the DBus 3466 service isn't running (bug #14543)</para> 3467 </listitem> 3468 3469 <listitem> 3470 <para>Windows hosts: fixed the <emphasis>VERR_LDR_MISMATCH_NATIVE</emphasis> 3471 error message (bug #14420)</para> 3472 </listitem> 3473 3474 <listitem> 3475 <para>Windows hosts: fix for Windows 10 build 10525 and later (bug #14502)</para> 3476 </listitem> 3477 3478 <listitem> 3479 <para>Windows hosts: fixed network adapter enumeration on Windows 10 (bug #14437)</para> 3480 </listitem> 3481 3482 <listitem> 3483 <para>Windows hosts: prevent intermittent host network disconnects during 3484 VM start/shutdown with bridged networking (bug #14500)</para> 3485 </listitem> 3486 3487 <listitem> 3488 <para>Windows Additions: fixed the call to the memory allocation function 3489 (bug #14415)</para> 3490 </listitem> 3491 3492 <listitem> 3493 <para>Linux Additions: be more forgiving if the compilation of the 3494 vboxvideo module fails (bug #14547)</para> 3495 </listitem> 3496 3497 <listitem> 3498 <para>X11 Additions: fixed a number of small issues with dynamic 3499 resizing and full-screen and seamless modes</para> 3500 </listitem> 3501 3502 </itemizedlist> 3503 3504 </sect1> 3505 <sect1> 3506 <title>Version 5.0.2 (2015-08-13)</title> 3507 3508 <para>This is a maintenance release. The following items were fixed and/or 3509 added:</para> 3510 3511 <itemizedlist> 3512 3513 <listitem> 3514 <para>VMM: added support for guest crash report MSRs with Hyper-V 3515 paravirtualization</para> 3516 </listitem> 3517 3518 <listitem> 3519 <para>VMM: fixed an issue causing artificially high load averages on 3520 Linux hosts</para> 3521 </listitem> 3522 3523 <listitem> 3524 <para>VMM: fixed a kernel panic with thread-context hooks caused by 3525 incompatible changes made to Linux 4.2 kernels</para> 3526 </listitem> 3527 3528 <listitem> 3529 <para>VMM: fixed a saved state issue with VT-x/AMD-V disabled 3530 (5.0 regression; bug #14304)</para> 3531 </listitem> 3532 3533 <listitem> 3534 <para>VMM: fixed <emphasis>VERR_SUPDRV_TSC_DELTA_MEASUREMENT_FAILED</emphasis> 3535 Guru Meditations on certain AMD CPUs (5.0 regression; bug #14370)</para> 3536 </listitem> 3537 3538 <listitem> 3539 <para>VMM: fixed a crash while creating a guest core dumps via the VM 3540 debug facility (5.0 regression)</para> 3541 </listitem> 3542 3543 <listitem> 3544 <para>VMM: This release has AVX2 passthrough disabled on every host and 3545 AVX passthrough disabled for 64-bit VMs on 32-bit hosts. This will be 3546 properly fixed in a future 5.0.x maintenance release (see e.g. bug #14262)</para> 3547 </listitem> 3548 3549 <listitem> 3550 <para>GUI: fixed rare hang and crash on VM shutdown/poweroff</para> 3551 </listitem> 3552 3553 <listitem> 3554 <para>GUI: X11: fixed few crashes caused by the Qt <emphasis>alien 3555 widgets</emphasis> feature</para> 3556 </listitem> 3557 3558 <listitem> 3559 <para>GUI: X11: fixed various mini-toolbar geometry quirks like positioning, z-order, 3560 transparency issues on certain window managers (bug #14257)</para> 3561 </listitem> 3562 3563 <listitem> 3564 <para>GUI: X11: fixed mini-toolbar minimize button issue under certain window managers 3565 (bug #14284)</para> 3566 </listitem> 3567 3568 <listitem> 3569 <para>GUI: VM menu actions availability should now be properly updated on 3570 full-screen/seamless/scaled mode switches</para> 3571 </listitem> 3572 3573 <listitem> 3574 <para>GUI: disk encryption password validation should be performed 3575 when user confirmed the password, not after each entered symbol</para> 3576 </listitem> 3577 3578 <listitem> 3579 <para>GUI: do not change the VM/group selection in the VM Manager to the newly 3580 created VM if it was created by another client (e.g. VBoxManage)</para> 3581 </listitem> 3582 3583 <listitem> 3584 <para>GUI: Mac OS X: do not treat 'almost maximized' VM windows as 'maximized', 3585 watch for the strict window geometry instead</para> 3586 </listitem> 3587 3588 <listitem> 3589 <para>GUI: improve the quality in scaled mode under some circumstances 3590 (5.0 regression; bug #14303)</para> 3591 </listitem> 3592 3593 <listitem> 3594 <para>VBoxManage: do not deny changing the network adapter type at 3595 VM runtime (5.0 regression; bug #14308)</para> 3596 </listitem> 3597 3598 <listitem> 3599 <para>VRDP: allow Windows 10 RDP clients (bug #14216)</para> 3600 </listitem> 3601 3602 <listitem> 3603 <para>Audio: fix a possible crash on VM process termination 3604 (5.0 regression)</para> 3605 </listitem> 3606 3607 <listitem> 3608 <para>Storage: improved raw disk access on OS X by unmounting 3609 any accessed volume before first use and prevent any mount attempt 3610 by the host (bug #14219)</para> 3611 </listitem> 3612 3613 <listitem> 3614 <para>3D: basic support for saving/restoring display lists</para> 3615 </listitem> 3616 3617 <listitem> 3618 <para>Drag and drop: fixed guest to host transfers on OS X hosts</para> 3619 </listitem> 3620 3621 <listitem> 3622 <para>Drag and drop: fixed memory leak on Windows guests</para> 3623 </listitem> 3624 3625 <listitem> 3626 <para>Shared Folders: fixed a problem with accessing CIFS shares 3627 (bug #14252)</para> 3628 </listitem> 3629 3630 <listitem> 3631 <para>Shared Folders: improved path conversion between hosts and 3632 guests with different path separators (bug #14153)</para> 3633 </listitem> 3634 3635 <listitem> 3636 <para>API: skip resetting of immutable media when the VM in saved 3637 state is started (bug #13957)</para> 3638 </listitem> 3639 3640 <listitem> 3641 <para>API: fixed method for setting medium IDs which used zero (invalid) 3642 UUIDs instead random (valid) UUIDs if no UUIDs were passed (bug #14350)</para> 3643 </listitem> 3644 3645 <listitem> 3646 <para>API: for Windows host fix detection of API client crashes which 3647 have a session open</para> 3648 </listitem> 3649 3650 <listitem> 3651 <para>OVF: properly export all VBox features including the setting 3652 for paravirtualization (bug #14390)</para> 3653 </listitem> 3654 3655 <listitem> 3656 <para>Mac OS X hosts: El Capitan USB fixes</para> 3657 </listitem> 3658 3659 <listitem> 3660 <para>Windows hosts: fixed crash when opening Windows dialogs 3661 from the VM process on Windows 10 (bug #14351)</para> 3662 </listitem> 3663 3664 <listitem> 3665 <para>Windows hosts: fixed host-only adapter creation issues on 3666 Windows 10 (bug #14040)</para> 3667 </listitem> 3668 3669 <listitem> 3670 <para>Windows hosts: fixed audio on Windows 10 (bug #14432)</para> 3671 </listitem> 3672 3673 <listitem> 3674 <para>Linux hosts: more fixes for activated SMAP on Linux 3.19 3675 and newer (Broadwell and later; bug #13961)</para> 3676 </listitem> 3677 3678 <listitem> 3679 <para>Linux hosts: check then name space before attaching to a host 3680 network interface (bug #13795)</para> 3681 </listitem> 3682 3683 <listitem> 3684 <para>Linux Additions: Linux 4.2 fixes (bug #14227)</para> 3685 </listitem> 3686 3687 <listitem> 3688 <para>Linux Additions: improved the performance of 3689 <emphasis>stat()</emphasis> to speed up certain file operations 3690 on shared folders</para> 3691 </listitem> 3692 3693 <listitem> 3694 <para>Windows Additions: fixed a potential crash in the WDDM driver 3695 with Windows 10 (bug #14190)</para> 3696 </listitem> 3697 3698 <listitem> 3699 <para>Solaris Additions: added support for X.Org Server 1.17</para> 3700 </listitem> 3701 3702 <listitem> 3703 <para>X11 Additions: various seamless mode fixes, including 3704 invisible windows under LXDE</para> 3705 </listitem> 3706 3707 </itemizedlist> 3708 </sect1> 3709 3710 <sect1> 3711 <title>Version 5.0.0 (2015-07-09)</title> 3712 3713 <para>This is a major update. The following major new features 3714 were added:</para> 3715 3716 <itemizedlist> 3717 3718 <listitem> 3719 <para>Paravirtualization support for Windows and Linux guests to improve 3720 time-keeping accuracy and performance (see <xref linkend="gimproviders" />)</para> 3721 </listitem> 3722 3723 <listitem> 3724 <para>Make more instruction set extensions available to the guest when 3725 running with hardware-assisted virtualization and nested paging. Among 3726 others this includes: SSE 4.1, SSE4.2, AVX, AVX-2, AES-NI, 3727 <emphasis>POPCNT</emphasis>, <emphasis>RDRAND</emphasis> and 3728 <emphasis>RDSEED</emphasis></para> 3729 </listitem> 3730 3731 <listitem> 3732 <para>xHCI Controller to support USB 3 devices 3733 (see <xref linkend="settings-usb" />)</para> 3734 </listitem> 3735 3736 <listitem> 3737 <para>Drag and drop support (bidirectional) for Windows, Linux and Solaris guests</para> 3738 </listitem> 3739 3740 <listitem> 3741 <para>Disk image encryption (see <xref linkend="diskencryption" />)</para> 3742 </listitem> 3743 3744 <listitem> 3745 <para>VMs can now be started in <emphasis>separate mode</emphasis>. The VM 3746 process is started headless while the frontend runs as a separate process 3747 which can be terminated without stopping the VM</para> 3748 </listitem> 3749 3750 <listitem> 3751 <para>GUI: VM guest-content scaling support (including 3D acceleration)</para> 3752 </listitem> 3753 3754 <listitem> 3755 <para>GUI: New User Interface settings page for customizing status-bar, 3756 menu-bar and guest-content scaling</para> 3757 </listitem> 3758 3759 <listitem> 3760 <para>GUI: New Encryption settings tab for customizing encryption options for 3761 disk images</para> 3762 </listitem> 3763 3764 <listitem> 3765 <para>GUI: HiDPI support including application icons and optional unscaled HiDPI 3766 output on Mac OS X (including 3D acceleration)</para> 3767 </listitem> 3768 3769 <listitem> 3770 <para>GUI: Hotplugging support for SATA disks</para> 3771 </listitem> 3772 3773 <listitem> 3774 <para>New, modular audio architecture for providing a better abstraction of the host 3775 audio backends</para> 3776 </listitem> 3777 3778 <listitem> 3779 <para>Support for the NDIS6 networking framework on Windows (default on Vista 3780 and later)</para> 3781 </listitem> 3782 3783 </itemizedlist> 3784 3785 <para>In addition, the following items were fixed and/or added:</para> 3786 3787 <itemizedlist> 3788 3789 <listitem> 3790 <para>VMM: improved timing on Solaris hosts with older VT-x hosts 3791 without preemption timers</para> 3792 </listitem> 3793 3794 <listitem> 3795 <para>VMM: further improvements for TSC frequency measurements and 3796 guest timekeeping</para> 3797 </listitem> 3798 3799 <listitem> 3800 <para>VMM: debug facility now includes the guest CPU's 3801 FPU/SSE/extended state in the core dump</para> 3802 </listitem> 3803 3804 <listitem> 3805 <para>VMM: fixed a hang under rare conditions on 32-bit hosts</para> 3806 </listitem> 3807 3808 <listitem> 3809 <para>VMM: several fixes</para> 3810 </listitem> 3811 3812 <listitem> 3813 <para>GUI: improved HID LEDs synchronization for Mac and Windows hosts. 3814 The physical LEDs state now restored together with the VM state</para> 3815 </listitem> 3816 3817 <listitem> 3818 <para>GUI: take the guest screen aspect ratio into account for the 3819 preview window</para> 3820 </listitem> 3821 3822 <listitem> 3823 <para>GUI: provide direct access to storage media in the VM selector</para> 3824 </listitem> 3825 3826 <listitem> 3827 <para>GUI: allow to save the VM state from the selector even if the VM 3828 is already paused</para> 3829 </listitem> 3830 3831 <listitem> 3832 <para>VBoxManage: when exporting an appliance, support the suppression 3833 of MAC addresses, which means they will be always recreated on 3834 import, avoiding duplicate MAC addresses for VMs which are imported 3835 several times</para> 3836 </listitem> 3837 3838 <listitem> 3839 <para>VBoxManage: now supports renaming storage controllers and USB controllers</para> 3840 </listitem> 3841 3842 <listitem> 3843 <para>Guest Control: major overhaul, for example fixing wrong parameter quoting 3844 (bug #13157)</para> 3845 </listitem> 3846 3847 <listitem> 3848 <para>USB: added USB traffic capturing (see <xref linkend="usbtrafficcapturing" />)</para> 3849 </listitem> 3850 3851 <listitem> 3852 <para>Made resizing X11 guests work more reliably</para> 3853 </listitem> 3854 3855 <listitem> 3856 <para>API: block the removal of the current snapshot if it has child 3857 snapshots (only relevant for VMs without snapshottable hard disks, 3858 their presence always prevented removal), which resulted in VM 3859 config corruption</para> 3860 </listitem> 3861 3862 <listitem> 3863 <para>API: mark VM configs with snapshots but without current snapshot 3864 as inaccessible, as this combination is nonsense</para> 3865 </listitem> 3866 3867 <listitem> 3868 <para>API: fix information for some automatically generated events 3869 (only with XPCOM, Windows host was not affected), which caused 3870 errors when getting some of the attributes over the webservice 3871 (bug #12379)</para> 3872 </listitem> 3873 3874 <listitem> 3875 <para>API: fix crashes in Java API clients using the XPCOM binding, 3876 happened with output parameters only (bug #11232)</para> 3877 </listitem> 3878 3879 <listitem> 3880 <para>API: a number of settings (e.g. network settings) can now also 3881 be changed when the VM is in saved state</para> 3882 </listitem> 3883 3884 <listitem> 3885 <para>API: fixed incorrect resuming of VMs on host-resume unless they were 3886 previously paused due to a host-suspend</para> 3887 </listitem> 3888 3889 <listitem> 3890 <para>API: don't lose the saved state and "current state changed" flag 3891 during cloning of a VM</para> 3892 </listitem> 3893 3894 <listitem> 3895 <para>API: OS type description consistency fix (bug #14162)</para> 3896 </listitem> 3897 3898 <listitem> 3899 <para>VBoxSVC: don't keep the support driver permanently open</para> 3900 </listitem> 3901 3902 <listitem> 3903 <para>Main/Properties: properly drop transient guest properties when 3904 the VM is powered off</para> 3905 </listitem> 3906 3907 <listitem> 3908 <para>VRDP: fixed a couple of races which may cause a crash during 3909 VM poweroff</para> 3910 </listitem> 3911 3912 <listitem> 3913 <para>ExtPack: don't fail if the TMP directory contains non-latin1 3914 characters (bug #14159)</para> 3915 </listitem> 3916 3917 <listitem> 3918 <para>3D: fix potential race in which might cause a crash on VM 3919 termination</para> 3920 </listitem> 3921 3922 <listitem> 3923 <para>3D: fixed a possible memory leak in the host service</para> 3924 </listitem> 3925 3926 <listitem> 3927 <para>Serial: new TCP/IP backend (see <xref linkend="serialports"/>)</para> 3928 </listitem> 3929 3930 <listitem> 3931 <para>Storage: added USB mass storage device class 3932 (see <xref linkend="harddiskcontrollers"/>)</para> 3933 </listitem> 3934 3935 <listitem> 3936 <para>Storage: added <emphasis>vbox-img</emphasis> standalone tool for 3937 direct manipulation of virtual hard disk images without VBoxManage</para> 3938 </listitem> 3939 3940 <listitem> 3941 <para>Storage: fixed crash as a result of I/O errors in certain conditions 3942 (bug #13105)</para> 3943 </listitem> 3944 3945 <listitem> 3946 <para>NAT: fixed several potential crashes</para> 3947 </listitem> 3948 3949 <listitem> 3950 <para>NAT: don't forcibly reset/drop all connections when the link goes 3951 down</para> 3952 </listitem> 3953 3954 <listitem> 3955 <para>Netsniffer: properly handle changing of the trace file name 3956 at VM runtime</para> 3957 </listitem> 3958 3959 <listitem> 3960 <para>Audio: fixed audio output and input when changing the default audio device 3961 more than once on OS X</para> 3962 </listitem> 3963 3964 <listitem> 3965 <para>Audio: fixed audio input on OS X under certain circumstances</para> 3966 </listitem> 3967 3968 <listitem> 3969 <para>ICH9: fixed the interrupt disable logic for MSI interrupts; should 3970 fix old Linux guests with AHCI</para> 3971 </listitem> 3972 3973 <listitem> 3974 <para>USB: improve playback with USB sound devices attached to the emulated 3975 OHCI controller</para> 3976 </listitem> 3977 3978 <listitem> 3979 <para>Audio: provide Linux guests a different AC'97 audio codec type so Linux 3980 ALSA does not mis-detect the link speed (default for new VMs)</para> 3981 </listitem> 3982 3983 <listitem> 3984 <para>BIOS: fix for booting from SCSI CD/DVD media</para> 3985 </listitem> 3986 3987 <listitem> 3988 <para>BIOS: fix for reads partially beyond end of disk (bug #14021)</para> 3989 </listitem> 3990 3991 <listitem> 3992 <para>VRDP: fixed listening for IPv6 on some systems (bug #14038)</para> 3993 </listitem> 3994 3995 <listitem> 3996 <para>rdesktop-vrdp: upgraded to version 1.8.3</para> 3997 </listitem> 3998 3999 <listitem> 4000 <para>Linux hosts: fixed a bug which made the netfilter driver ignore 4001 certain events (bug #12264)</para> 4002 </listitem> 4003 4004 <listitem> 4005 <para>Mac OS X hosts: El Capitan fixes</para> 4006 </listitem> 4007 4008 <listitem> 4009 <para>Mac OS X hosts: fixed a bug which might trigger a host kernel panic 4010 if a VM is started and another hypervisor is active</para> 4011 </listitem> 4012 4013 <listitem> 4014 <para>Solaris hosts: Solaris 12 installer fix</para> 4015 </listitem> 4016 4017 <listitem> 4018 <para>Guest Additions: added a heartbeat service 4019 (see <xref linkend="heartbeatservice" />)</para> 4020 </listitem> 4021 4022 <listitem> 4023 <para>Linux hosts / guests: support for Linux distributions using systemd 4024 without sysv emulation (e.g. ArchLinux)</para> 4025 </listitem> 4026 4027 <listitem> 4028 <para>Windows Additions/WDDM: improved video memory utilization and 4029 allow more/bigger guest screens with large resolutions (including HiDPI) 4030 </para> 4031 </listitem> 4032 4033 <listitem> 4034 <para>Linux Additions: added <emphasis>-s</emphasis> parameter to 4035 <emphasis>mount.vboxsf</emphasis> to be sloppy with invalid parameters</para> 4036 </listitem> 4037 4038 <listitem> 4039 <para>X11 Additions: fixed wrong DPI value (bug #14151)</para> 4040 </listitem> 4041 4042 <listitem> 4043 <para>Mac OS X guests: limit the CPU family for legacy guests</para> 4044 </listitem> 4045 4046 <listitem> 4047 <para>Solaris Additions: added quiesce support to co-operate with Solaris' 4048 fast-reboot feature</para> 4049 </listitem> 4050 4051 </itemizedlist> 4052 4053 </sect1> 4054 4055 <sect1> 4056 <title>Version 4.3.28 (2015-05-13)</title> 4057 4058 <para>This is a maintenance release. The following items were fixed and/or 4059 added:</para> 4060 4061 <itemizedlist> 4062 4063 <listitem> 4064 <para>VMM: fixed a Guru Meditation when rebooting certain guests (for 4065 example Solaris doing fast reboot) by fixing the implementation for INIT IPI</para> 4066 </listitem> 4067 4068 <listitem> 4069 <para>VMM: added some information for diagnosing rare 4070 <emphasis>VERR_VMX_INVALID_VMXON_PTR</emphasis> Guru Meditations (VT-x only)</para> 4071 </listitem> 4072 4073 <listitem> 4074 <para>GUI: HID LEDs sync: prevent synchronization if VM window has no focus 4075 (Windows and Mac OS X hosts only)</para> 4076 </listitem> 4077 4078 <listitem> 4079 <para>GUI: fixed drag and drop moving the cursor between guest screens on 4080 certain hosts</para> 4081 </listitem> 4082 4083 <listitem> 4084 <para>3D: fixed a crash on restoring the VM state on X11 hosts (bug #12737)</para> 4085 </listitem> 4086 4087 <listitem> 4088 <para>3D: fixed a crash on restoring the VM state</para> 4089 </listitem> 4090 4091 <listitem> 4092 <para>3D: fixed a crash on Linux guest shutdown (bug #12772)</para> 4093 </listitem> 4094 4095 <listitem> 4096 <para>VRDP: fixed incompatibility with rdesktop 1.8.3</para> 4097 </listitem> 4098 4099 <listitem> 4100 <para>VRDP: fixed listening for IPv6 on some systems (bug #14038)</para> 4101 </listitem> 4102 4103 <listitem> 4104 <para>Storage: don't crash if creating an asynchronous I/O context 4105 fails (e.g. when starting many VMs) and show a proper error message</para> 4106 </listitem> 4107 4108 <listitem> 4109 <para>Floppy: several fixes</para> 4110 </listitem> 4111 4112 <listitem> 4113 <para>Audio: improved the behavior of the volume control for the 4114 HD audio device emulation</para> 4115 </listitem> 4116 4117 <listitem> 4118 <para>USB: increase the number of supported drivers from 3 to 5 4119 (Windows hosts only)</para> 4120 </listitem> 4121 4122 <listitem> 4123 <para>PS/2 keyboard: synchronize the LED state on VM restore 4124 (Windows and Mac OS X hosts only)</para> 4125 </listitem> 4126 4127 <listitem> 4128 <para>NAT Network: when running multiple NAT networks with multiple VMs, 4129 only stop the respective services when stopping VMs (bug #14090)</para> 4130 </listitem> 4131 4132 <listitem> 4133 <para>NAT: don't kill UDP bindings on ICMP errors (bug #13475)</para> 4134 </listitem> 4135 4136 <listitem> 4137 <para>NAT: bandwidth limit now works properly with NAT (bug #11485)</para> 4138 </listitem> 4139 4140 <listitem> 4141 <para>BIOS: fixed the returned size value of the VBE 2.0 PMI function 0Ah 4142 (4.2.0 regression; bug #14096)</para> 4143 </listitem> 4144 4145 <listitem> 4146 <para>Guest Control: fixed parameter quoting in Windows guests 4147 (bug #13157)</para> 4148 </listitem> 4149 4150 <listitem> 4151 <para>Webcam passthrough improvements for Linux (V4L2) hosts to support more 4152 webcam models</para> 4153 </listitem> 4154 4155 <listitem> 4156 <para>API: don't fail starting a VM with <emphasis>VBOX_E_INVALID_OBJECT_STATE</emphasis> 4157 under certain conditions (bug #13617)</para> 4158 </listitem> 4159 4160 <listitem> 4161 <para>API: be more verbose on <emphasis>VBOX_E_INVALID_OBJECT_STATE</emphasis> 4162 if a medium is attached to a running VM (bug #13560)</para> 4163 </listitem> 4164 4165 <listitem> 4166 <para>API: fixed a bug which could result in losing certain screen resize 4167 events with multi-monitor guests</para> 4168 </listitem> 4169 4170 <listitem> 4171 <para>rdesktop-vrdp: fixed path to the keymaps (bug #12066)</para> 4172 </listitem> 4173 4174 <listitem> 4175 <para>rdesktop-vrdp: switch to version 1.8.3</para> 4176 </listitem> 4177 4178 <listitem> 4179 <para>Windows hosts: more hardening fixes (e.g. bugs #14051, #14052)</para> 4180 </listitem> 4181 4182 <listitem> 4183 <para>Linux hosts: another fix for activated SMAP on Linux 3.19 4184 and newer (Broadwell and later; bug #13961)</para> 4185 </listitem> 4186 4187 <listitem> 4188 <para>Linux hosts: Linux 4.1 compile fix (bug #14081)</para> 4189 </listitem> 4190 4191 <listitem> 4192 <para>Solaris hosts: fixed using of VNIC templates with Crossbow based 4193 bridged networking to be compatible with vanity interface names</para> 4194 </listitem> 4195 4196 <listitem> 4197 <para>Mac OS X hosts: fixed crash during VM termination under rare 4198 circumstances</para> 4199 </listitem> 4200 4201 <listitem> 4202 <para>Windows Additions/WDDM: improved video memory utilization and allow 4203 more/bigger guest screens with large resolutions (including HiDPI)</para> 4204 </listitem> 4205 4206 <listitem> 4207 <para>X11 Additions: prevent flickering when updating mouse cursor</para> 4208 </listitem> 4209 4210 <listitem> 4211 <para>Solaris Additions: fixed incorrect usage of 'prtconf' while 4212 installing Guest Additions (Solaris 10 only)</para> 4213 </listitem> 4214 4215 </itemizedlist> 4216 </sect1> 4217 4218 <sect1> 4219 <title>Version 4.3.26 (2015-03-16)</title> 4220 4221 <para>This is a maintenance release. The following items were fixed and/or 4222 added:</para> 4223 4224 <itemizedlist> 4225 4226 <listitem> 4227 <para>GUI: in the snapshots pane, protect the age of snapshots against 4228 wrong host time (bug #13955)</para> 4229 </listitem> 4230 4231 <listitem> 4232 <para>NAT Network: fixed a bug which prevented to propagate any DNS 4233 name server / domain / search string information to the NAT network 4234 (4.3.24 regression; bugs #13915, #13918)</para> 4235 </listitem> 4236 4237 <listitem> 4238 <para>NAT Network: don't delay the shutdown of VBoxSVC on 4239 Windows hosts</para> 4240 </listitem> 4241 4242 <listitem> 4243 <para>Mouse support: the mouse could not be moved under rare 4244 conditions if no Guest Additions are installed (4.3.24 regression; 4245 bug #13935)</para> 4246 </listitem> 4247 4248 <listitem> 4249 <para>Storage: if the guest ejects a virtual CD/DVD medium, make the 4250 change permanent (bugs #9858, #12885)</para> 4251 </listitem> 4252 4253 <listitem> 4254 <para>VGA: made saving secondary screen sizes possible in X11 guests</para> 4255 </listitem> 4256 4257 <listitem> 4258 <para>SDK: fixed the VirtualBox.tlb file (4.3.20 regression; bug #13943)</para> 4259 </listitem> 4260 4261 <listitem> 4262 <para>rdesktop-vrdp: make it work with USB devices again 4263 (4.3.14 regression; bug #13901)</para> 4264 </listitem> 4265 4266 <listitem> 4267 <para>USB: fixed a possible BSOD on Windows hosts under rare conditions</para> 4268 </listitem> 4269 4270 <listitem> 4271 <para>iPXE: enable the HTTP download protocol on non-Linux hosts (bug #13628)</para> 4272 </listitem> 4273 4274 <listitem> 4275 <para>Mac OS X hosts: don't panic on hosts with activated SMAP (Broadwell 4276 and later; bug #13951)</para> 4277 </listitem> 4278 4279 <listitem> 4280 <para>Linux hosts: don't crash Linux 4.0 hosts (bug #13835)</para> 4281 </listitem> 4282 4283 </itemizedlist> 4284 </sect1> 4285 4286 <sect1> 4287 <title>Version 4.3.24 (2015-03-02)</title> 4288 4289 <para>This is a maintenance release. The following items were fixed and/or 4290 added:</para> 4291 4292 <itemizedlist> 4293 4294 <listitem> 4295 <para>VMM: emulation fix for the <emphasis>ENTER</emphasis> instruction 4296 under certain conditions; fixes Solaris 10 guests (VT-x without 4297 unrestricted guest execution)</para> 4298 </listitem> 4299 4300 <listitem> 4301 <para>VMM: fix for handling NMIs on Linux hosts with X2APIC enabled</para> 4302 </listitem> 4303 4304 <listitem> 4305 <para>NAT/NAT Network: fix connection drops when the host's DHCP lease 4306 was renewed (4.3.22 regression; Windows hosts only; bug #13839)</para> 4307 </listitem> 4308 4309 <listitem> 4310 <para>NAT: don't crash on an empty domain list when switching the 4311 DNS host configuration (4.3.22 regression; Mac OS X hosts only; 4312 bug #13874)</para> 4313 </listitem> 4314 4315 <listitem> 4316 <para>PXE: re-enable it on Windows hosts (4.3.22 regression; Windows hosts 4317 only; bug #13842) 4318 </para> 4319 </listitem> 4320 4321 <listitem> 4322 <para>Shared Folders: fixed a problem with Windows guests (4.3.22 regression; 4323 bug #13786)</para> 4324 </listitem> 4325 4326 <listitem> 4327 <para>Audio: improved record quality when using the DirectSound audio 4328 backend</para> 4329 </listitem> 4330 4331 <listitem> 4332 <para>VBoxManage: when executing the <emphasis>controlvm</emphasis> command 4333 take care that the corresponding VM runtime changes are saved permanently 4334 (bug #13892)</para> 4335 </listitem> 4336 4337 <listitem> 4338 <para>Windows Installer: properly install the 32-bit version of VBoxRes.dll 4339 on 32-bit hosts (bug #13876)</para> 4340 </listitem> 4341 4342 <listitem> 4343 <para>Linux hosts / guests: Linux 4.0 fixes (bug #13835)</para> 4344 </listitem> 4345 4346 <listitem> 4347 <para>OS/2 Additions: fixed mouse integration (4.3.22 regression; 4348 bug #13825)</para> 4349 </listitem> 4350 4351 </itemizedlist> 4352 </sect1> 4353 4354 <sect1> 4355 <title>Version 4.3.22 (2015-02-12)</title> 4356 4357 <para>This is a maintenance release. The following items were fixed and/or 4358 added:</para> 4359 4360 <itemizedlist> 4361 4362 <listitem> 4363 <para>VMM: refined measurement of TSC frequency on the host, improves 4364 timekeeping for guests</para> 4365 </listitem> 4366 4367 <listitem> 4368 <para>VMM: decreased CPU load resulting from guest MMIO writes to the 4369 virtual APIC</para> 4370 </listitem> 4371 4372 <listitem> 4373 <para>VMM: fixed interception of debug exceptions, observed while using 4374 the dbx debugger on Solaris guests (VT-x only)</para> 4375 </listitem> 4376 4377 <listitem> 4378 <para>GUI: 3D overlay window positioning code improved, fixed potential 4379 misplacement of 3D accelerated guest graphics content</para> 4380 </listitem> 4381 4382 <listitem> 4383 <para>GUI: fixed accident SSL authentication failures during update 4384 check on Windows hosts (bug #12969)</para> 4385 </listitem> 4386 4387 <listitem> 4388 <para>GUI: never send the "ACPI power" keyboard scancode to the guest, 4389 we have the ACPI power button for that</para> 4390 </listitem> 4391 4392 <listitem> 4393 <para>GUI: was unable to properly restore seamless mode VM from 4394 snapshot/saved-state under some circumstances</para> 4395 </listitem> 4396 4397 <listitem> 4398 <para>VBoxHeadless: don't crash if 3D is enabled in the VM settings 4399 (bug #10250)</para> 4400 </listitem> 4401 4402 <listitem> 4403 <para>ATA: fixed several passthrough issues (bugs #12310, #1360)</para> 4404 </listitem> 4405 4406 <listitem> 4407 <para>Audio: fixed DirectSound failure when the the host has no audio 4408 input device (Windows hosts only; bug #9205)</para> 4409 </listitem> 4410 4411 <listitem> 4412 <para>SB16: fixed compatibility issue (bug #13769)</para> 4413 </listitem> 4414 4415 <listitem> 4416 <para>Storage: fixed broken CD/DVD passthrough when using the 4417 IDE controller (bug #12310)</para> 4418 </listitem> 4419 4420 <listitem> 4421 <para>NAT: new ping proxy for Windows hosts (bug #11871)</para> 4422 </listitem> 4423 4424 <listitem> 4425 <para>NAT: Properly report outbound connect(2) failures to 4426 guest with TCP RST or ICMP (bug #10525)</para> 4427 </listitem> 4428 4429 <listitem> 4430 <para>NAT Network: no need for frequent wakeups in VBoxNetDHCP 4431 and VBoxNetNAT (bug #11681)</para> 4432 </listitem> 4433 4434 <listitem> 4435 <para>Host-only adapter: prevent Windows from creating an "Unidentified 4436 network" (bug #9688)</para> 4437 </listitem> 4438 4439 <listitem> 4440 <para>Bridged Networking: don't leak host-to-guest traffic to 4441 the wireless network when bridging to a wireless interface 4442 (bug #13714)</para> 4443 </listitem> 4444 4445 <listitem> 4446 <para>Main: fixed a possible race when changing the medium leading 4447 to a deadlock under rare conditions (bug #13722)</para> 4448 </listitem> 4449 4450 <listitem> 4451 <para>VBoxManage: fixed return code if starting a VM failed 4452 (bug #13773)</para> 4453 </listitem> 4454 4455 <listitem> 4456 <para>Settings: on Windows host, do not use environment variable HOME 4457 at all, the settings location is derived from the user profile 4458 directory (bug #7689)</para> 4459 </listitem> 4460 4461 <listitem> 4462 <para>API: fixed 2 deadlock opportunities related to medium handling 4463 (bugs #13789, #13801, thank you Alexander Urakov)</para> 4464 </listitem> 4465 4466 <listitem> 4467 <para>API: fixed bug in XPCOM which created too few worker threads, 4468 sporadically resulting in a deadlock (bug #13802, thank you Alexander 4469 Urakov)</para> 4470 </listitem> 4471 4472 <listitem> 4473 <para>SDK: fixed a garbage collection leak in the Python VirtualBox 4474 webservice API binding (bug #13817)</para> 4475 </listitem> 4476 4477 <listitem> 4478 <para>Linux hosts: fixes for activated SMAP (Broadwell and later, 4479 bug #13820)</para> 4480 </listitem> 4481 4482 <listitem> 4483 <para>X11 guests: prevent unwanted hiding of guest screens 4484 on multi-monitor guests (bug #13287)</para> 4485 </listitem> 4486 4487 <listitem> 4488 <para>X11 guests: added support for X.Org Server 1.17</para> 4489 </listitem> 4490 4491 <listitem> 4492 <para>X11 Additions: fixed a memory leak in VBoxService if libdbus 4493 is available but dbus-daemon isn't running (bug #13770)</para> 4494 </listitem> 4495 4496 <listitem> 4497 <para>Windows Additions: prevent VBox WDDM driver from loading if host 4498 reports weak OpenGL capabilities. 3D content now can be shown over 4499 Remote Desktop connection</para> 4500 </listitem> 4501 4502 <listitem> 4503 <para>Winodws Additions: some fixes for recent Windows 10 Previews</para> 4504 </listitem> 4505 4506 <listitem> 4507 <para>Linux Additions: fixed a compatibility issue with 64-bit 4508 Linux 2.4 kernels</para> 4509 </listitem> 4510 4511 <listitem> 4512 <para>Linux Additions: fixed a potential use-after-free when unloading 4513 the VBoxGuest module</para> 4514 </listitem> 4515 4516 <listitem> 4517 <para>Linux Additions: Linux 3.19 fixes (bug #13741)</para> 4518 </listitem> 4519 4520 </itemizedlist> 4521 </sect1> 4522 4523 <sect1> 4524 <title>Version 4.3.20 (2014-11-21)</title> 4525 4526 <para>This is a maintenance release. The following items were fixed and/or 4527 added:</para> 4528 4529 <itemizedlist> 4530 4531 <listitem> 4532 <para>VMM: fixed reboot hang of 32-bit Windows SMP guests (bugs #13319, 4533 #13462)</para> 4534 </listitem> 4535 4536 <listitem> 4537 <para>VMM: proper <emphasis>Math Fault</emphasis> handling with certain 4538 legacy guests (bug #9042, AMD hosts)</para> 4539 </listitem> 4540 4541 <listitem> 4542 <para>VMM: fixed a Guru Meditation <emphasis>VINF_EM_TRIPLE_FAULT</emphasis> 4543 on older CPUs that don't support MSR bitmaps (VT-x only; 4544 bugs #13034, #13125, #13311, #13425, #13426, #13463, #13585)</para> 4545 </listitem> 4546 4547 <listitem> 4548 <para>GUI: fix 3D overlay window reparenting issue when VM goes to 4549 full-screen mode on X11 hosts</para> 4550 </listitem> 4551 4552 <listitem> 4553 <para>GUI: fix occasional loss of focus in full-screen mode on X11 4554 host systems (4.3.16 regression)</para> 4555 </listitem> 4556 4557 <listitem> 4558 <para>GUI: Mac OS X: wizards should have Cancel button 4559 (bug #12541)</para> 4560 </listitem> 4561 4562 <listitem> 4563 <para>GUI: added a global option to prevent automatic raising of the 4564 new window by mouse move with multi-screen guests (bug #8878)</para> 4565 </listitem> 4566 4567 <listitem> 4568 <para>API: accept remote display port 0 as the default RDP port 4569 (bug #8534)</para> 4570 </listitem> 4571 4572 <listitem> 4573 <para>VBoxManage: fixed crash when executing <emphasis>showvminfo</emphasis> 4574 command under certain circumstances (bug #13190)</para> 4575 </listitem> 4576 4577 <listitem> 4578 <para>ACPI: fixed occassional Guru Meditations in ACPI timer code 4579 (4.3.18 regression; bug #13521)</para> 4580 </listitem> 4581 4582 <listitem> 4583 <para>EFI: improved performance of IDE disk access</para> 4584 </listitem> 4585 4586 <listitem> 4587 <para>EFI: fixed a bug in the EFI video driver which prevented 4588 Windows to boot in UEFI mode (bug #12022)</para> 4589 </listitem> 4590 4591 <listitem> 4592 <para>EFI: properly announce the amount of RAM for big VMs 4593 (bugs #11103 and #13211)</para> 4594 </listitem> 4595 4596 <listitem> 4597 <para>Storage: fixed a crash under certain cicrumstances when a medium 4598 was ejected from a drive attached to the SATA controller without 4599 inserting a new medium before pausing or closing the VM 4600 (4.3.16 regression) </para> 4601 </listitem> 4602 4603 <listitem> 4604 <para>Storage: fixed an interrupt acknowledge issue causing hanging guests 4605 or slower I/O (4.3.18 regression)</para> 4606 </listitem> 4607 4608 <listitem> 4609 <para>Storage: fixed broken resume after the VM was suspended due to 4610 a full disk if host I/O caching is used</para> 4611 </listitem> 4612 4613 <listitem> 4614 <para>Storage: fixed a Guru Meditation under certain conditions when 4615 using the DevLsiLogic controller with VMs running in software 4616 virtualization mode (4.3 regression; bugs #12254, #12655, #12709, 4617 #12774, #12886)</para> 4618 </listitem> 4619 4620 <listitem> 4621 <para>Guest Control: fixed a bug which might lead to a crash during 4622 recursive copy</para> 4623 </listitem> 4624 4625 <listitem> 4626 <para>SDK: Java COM bindings fixes</para> 4627 </listitem> 4628 4629 <listitem> 4630 <para>iPXE: enable the HTTP download protocol (bug #13628)</para> 4631 </listitem> 4632 4633 <listitem> 4634 <para>Runtime: do not use a fixed stack size creating temporary threads 4635 during initialization (bug #13038)</para> 4636 </listitem> 4637 4638 <listitem> 4639 <para>Windows hosts: fixed more startup problems on certain Windows hosts due 4640 to conflicts with anti-virus software; better error reporting 4641 (4.3.14 regression; bug #13187)</para> 4642 </listitem> 4643 4644 <listitem> 4645 <para>Windows hosts: fixed DirectSound host audio failure under certain conditions 4646 (bug #13418)</para> 4647 </listitem> 4648 4649 <listitem> 4650 <para>Windows hosts: fixed additional cases of 4.3.14 regression 4651 whereby AltGr stopped working for some people (bug #13216)</para> 4652 </listitem> 4653 4654 <listitem> 4655 <para>Windows Additions: preserve guest monitor layout when resizing 4656 Windows 7 or newer guests</para> 4657 </listitem> 4658 4659 <listitem> 4660 <para>Linux Additions: Linux 3.18 compile fixes (bug #13515)</para> 4661 </listitem> 4662 4663 </itemizedlist> 4664 </sect1> 4665 4666 <sect1> 4667 <title>Version 4.3.18 (2014-10-10)</title> 4668 4669 <para>This is a maintenance release. The following items were fixed and/or 4670 added:</para> 4671 4672 <itemizedlist> 4673 4674 <listitem> 4675 <para>VMM: fixed a potential misbehavior after restoring the A20 state 4676 from a saved state</para> 4677 </listitem> 4678 4679 <listitem> 4680 <para>GUI: fixed full-screen mode mini-toolbar related regressions 4681 for different platforms and window managers (bug #13369)</para> 4682 </listitem> 4683 4684 <listitem> 4685 <para>GUI: X11: fixed full-screen mode Unity panels quirk caused by 4686 mini-toolbar code changes in last release (bug #13365)</para> 4687 </listitem> 4688 4689 <listitem> 4690 <para>GUI: X11: added possibility to use legacy full-screen mode 4691 as the new one can cause multi-screen issues under Unity, see 4692 <xref linkend="legacy-fullscreen-mode" xreflabel="here"/> (bug #13365)</para> 4693 </listitem> 4694 4695 <listitem> 4696 <para>GUI: Mac OS X: fixed full-screen mode artifact causing black screen 4697 when 3D acceleration was enabled on 10.10 Yosemite hosts (bug #13448)</para> 4698 </listitem> 4699 4700 <listitem> 4701 <para>GUI: Mac OS X: fixed regression in user-space swiping from/to 4702 VBox in full-screen mode</para> 4703 </listitem> 4704 4705 <listitem> 4706 <para>GUI: Mac OS X: fixed issue with switching to VBox in full-screen 4707 mode through Alt+Tab and Mission Control</para> 4708 </listitem> 4709 4710 <listitem> 4711 <para>Storage: fixed data corruption when resizing huge VHD images under 4712 certain circumstances (bug #11960)</para> 4713 </listitem> 4714 4715 <listitem> 4716 <para>Storage: fixed a rare hang during startup when the BIOS enumerates the 4717 storage devices attached to the SATA controller</para> 4718 </listitem> 4719 4720 <listitem> 4721 <para>Storage: follow the spec with AHCI interrupt acknowledge (bug #13474)</para> 4722 </listitem> 4723 4724 <listitem> 4725 <para>Storage: fixed broken iSCSI authentication (4.3.14 regression; bugs #13386, 4726 #13435)</para> 4727 </listitem> 4728 4729 <listitem> 4730 <para>NAT Network: properly parse port forwarding rules to allow UDP 4731 rules</para> 4732 </listitem> 4733 4734 <listitem> 4735 <para>USB: fixed a crash on Linux hosts with older Linux kernels (bug #13400) and 4736 several other fixes</para> 4737 </listitem> 4738 4739 <listitem> 4740 <para>ACPI: fixed ACPI timer anomalies (bug #12076)</para> 4741 </listitem> 4742 4743 <listitem> 4744 <para>Guest Control: fixed a memory leak (bug #13434)</para> 4745 </listitem> 4746 4747 <listitem> 4748 <para>Main: when removing a VM, do also remove the VBoxStartup.log file 4749 which might exist on Windows hosts (bug #13478)</para> 4750 </listitem> 4751 4752 <listitem> 4753 <para>Windows hosts: fixed more startup problems on certain Windows hosts due 4754 to conflicts with anti-virus software; better error reporting 4755 (4.3.14 regression; bug #13187)</para> 4756 </listitem> 4757 4758 <listitem> 4759 <para>Windows hosts: propagate the process startup information to the child 4760 process (4.3.14 regression; bug #13243)</para> 4761 </listitem> 4762 4763 <listitem> 4764 <para>Mac OS X hosts: don't force using the discrete GPU (bug #11111)</para> 4765 </listitem> 4766 4767 <listitem> 4768 <para>Windows Additions: some Windows 10 tweaks</para> 4769 </listitem> 4770 4771 <listitem> 4772 <para>X11 guests: fix a bug handling video driver display properties 4773 which prevented GNOME Shell on Fedora 21 from starting</para> 4774 </listitem> 4775 4776 <listitem> 4777 <para>Linux hosts / guests: fixed a few remaining warnings in the kernel 4778 log if memory allocation fails (bug #11171)</para> 4779 </listitem> 4780 4781 </itemizedlist> 4782 </sect1> 4783 4784 <sect1> 4785 <title>Version 4.3.16 (2014-09-09)</title> 4786 4787 <para>This is a maintenance release. The following items were fixed and/or 4788 added:</para> 4789 4790 <itemizedlist> 4791 4792 <listitem> 4793 <para>VMM: fixed restoring 32-bit FPU state on 64-bit capable VMs 4794 and restoring guest FPU in raw-mode VMs (bug #12646; 4.3 regression)</para> 4795 </listitem> 4796 4797 <listitem> 4798 <para>GUI: properly restore normal/scale mode guest-screen size 4799 after exiting full-screen/seamless mode</para> 4800 </listitem> 4801 4802 <listitem> 4803 <para>GUI: mini-toolbar should provoke less artifacts/conflicts with 4804 3D guest rendering</para> 4805 </listitem> 4806 4807 <listitem> 4808 <para>GUI: Mac OS X: Native full-screen multi-screen transition 4809 was able to blackout host-screens for nearly minute</para> 4810 </listitem> 4811 4812 <listitem> 4813 <para>GUI: X11: Modern window managers should now use native full-screen 4814 multi-screen mapping API</para> 4815 </listitem> 4816 4817 <listitem> 4818 <para>GUI: added extradata item for configuring the mouse capture 4819 behavior, see <xref linkend="mouse-capture" xreflabel="here"/> 4820 (bug #3506)</para> 4821 </listitem> 4822 4823 <listitem> 4824 <para>Storage: fixed a VBoxSVC crash when querying an iSCSI target with 4825 authentication configured (4.3.14 regression)</para> 4826 </listitem> 4827 4828 <listitem> 4829 <para>Storage: fixed a rare data corruption during reads if another 4830 allocating write is running concurrently and accesses the same range</para> 4831 </listitem> 4832 4833 <listitem> 4834 <para>Storage: fixed a rare crash for certain VHD images from other products</para> 4835 </listitem> 4836 4837 <listitem> 4838 <para>Storage: fixed a rare release assertion when using the AHCI controller</para> 4839 </listitem> 4840 4841 <listitem> 4842 <para>Floppy: fixed read errors and guest memory corruption when running 4843 under control of QEMM</para> 4844 </listitem> 4845 4846 <listitem> 4847 <para>3D: added experimental support for rendering on offline GPUs for Mac OS X host</para> 4848 </listitem> 4849 4850 <listitem> 4851 <para>3D: fixed white window appearing on entering FullScreen mode on Mac OS X host</para> 4852 </listitem> 4853 4854 <listitem> 4855 <para>3D: fixed video recording support for 3D data regression (bug #13073)</para> 4856 </listitem> 4857 4858 <listitem> 4859 <para>3D: fixes for MS Office 2013 support</para> 4860 </listitem> 4861 4862 <listitem> 4863 <para>3D: several fixes</para> 4864 </listitem> 4865 4866 <listitem> 4867 <para>Bridged Networking: improved IPv6 support when bridging 4868 to a wireless interface</para> 4869 </listitem> 4870 4871 <listitem> 4872 <para>NAT: prevent internal DNS service from stuck in host-resolver mode 4873 when host was switched from one network to another one while host was 4874 sleeping (Mac OS X hosts)</para> 4875 </listitem> 4876 4877 <listitem> 4878 <para>NAT: preserve DF (if possible) and TOS when proxying 4879 outbound UDP datagrams (bugs #9440, #12309)</para> 4880 </listitem> 4881 4882 <listitem> 4883 <para>NAT: don't let multicast datagrams out (bug #7338)</para> 4884 </listitem> 4885 4886 <listitem> 4887 <para>NAT: fixed handling of large incoming UDP datagrams on 4888 Windows hosts (bug #12136)</para> 4889 </listitem> 4890 4891 <listitem> 4892 <para>NAT: fixed handling of the RFC 1533 DHCP PAD option</para> 4893 </listitem> 4894 4895 <listitem> 4896 <para>NAT Network: fixed inbound half-close on Windows hosts</para> 4897 </listitem> 4898 4899 <listitem> 4900 <para>NAT Network: preserve IPv4 DF (if possible), TTL, TOS 4901 and IPv6 Hop Limit when proxying outbound UDP 4902 datagrams</para> 4903 </listitem> 4904 4905 <listitem> 4906 <para>VRDP: fixed a rare crash when using remote audio input</para> 4907 </listitem> 4908 4909 <listitem> 4910 <para>USB: fixed several regressions from 4.3.14 (bug #13320)</para> 4911 </listitem> 4912 4913 <listitem> 4914 <para>Audio: made the HDA sound emulation work with certain Mac OS X guests 4915 (e.g. Mountain Lion)</para> 4916 </listitem> 4917 4918 <listitem> 4919 <para>Windows hosts: fixed startup problems on certain Windows hosts due 4920 to conflicts with anti-virus software (4.3.14 regression; bug #13187)</para> 4921 </listitem> 4922 4923 <listitem> 4924 <para>Windows hosts: fixed 4.3.14 regression whereby AltGr stopped 4925 working for some people (bug #13216)</para> 4926 </listitem> 4927 4928 <listitem> 4929 <para>X11 hosts: made the extra key on Brazilian Thinkpads work 4930 (bug #8745)</para> 4931 </listitem> 4932 4933 <listitem> 4934 <para>X11 hosts: fixed a problem of input focus cycles and immediately 4935 released key presses in full screen mode (bug #13238)</para> 4936 </listitem> 4937 4938 <listitem> 4939 <para>Linux hosts: fixed flooding the kernel log with USB related messages 4940 when passing through certain USB devices to a VM (bug #13085)</para> 4941 </listitem> 4942 4943 <listitem> 4944 <para>Linux guests: stop applications crashing when <emphasis>drm_wait_vblank</emphasis> 4945 is called (bug #13265)</para> 4946 </listitem> 4947 4948 <listitem> 4949 <para>Linux guests: fix a crash in gnome-session (bug #13335)</para> 4950 </listitem> 4951 4952 <listitem> 4953 <para>X11 guests: do not start VBoxClient over an SSH connection 4954 (bug #13107)</para> 4955 </listitem> 4956 4957 <listitem> 4958 <para>X11 guests: added support for X.Org Server 1.16 (bug #13207)</para> 4959 </listitem> 4960 4961 <listitem> 4962 <para>X11 guests: fixed a wrong parameter in the video driver which 4963 caused problems with full-screen X11 clients (bug #2748)</para> 4964 </listitem> 4965 4966 <listitem> 4967 <para>VirtualKD: introduced stub/loader device for speeding up Windows 4968 kernel debugging, details see <ulink type="" 4969 url="http://virtualkd.sysprogs.org/">http://virtualkd.sysprogs.org/</ulink></para> 4970 </listitem> 4971 4972 </itemizedlist> 4973 </sect1> 4974 4975 <sect1> 4976 <title>Version 4.3.14 (2014-07-15)</title> 4977 4978 <para>This is a maintenance release. The following items were fixed and/or 4979 added:</para> 4980 4981 <itemizedlist> 4982 4983 <listitem> 4984 <para>VMM: more fixes for MSR emulation on certain hardware (bugs 4985 #12784, #12949, #13034)</para> 4986 </listitem> 4987 4988 <listitem> 4989 <para>VMM: improve MSI handling under rare circumstances (only 4990 relevant for the ICH9 chipset)</para> 4991 </listitem> 4992 4993 <listitem> 4994 <para>VMM: fixed #UD exception for 64-bit guests with the EFER.SCE bit 4995 and the <emphasis>SYSCALL</emphasis> instruction (VT-x only; 4996 4.3 regression; bug #13008)</para> 4997 </listitem> 4998 4999 <listitem> 5000 <para>VMM: fixed timekeeping after resuming SMP guests</para> 5001 </listitem> 5002 5003 <listitem> 5004 <para>VMM: properly wake up a halted VCPU on NMI/SMI</para> 5005 </listitem> 5006 5007 <listitem> 5008 <para>GUI: fixed a potential crash</para> 5009 </listitem> 5010 5011 <listitem> 5012 <para>GUI: fixed stuck AltGr key on Windows hosts (bug #2537)</para> 5013 </listitem> 5014 5015 <listitem> 5016 <para>GUI: fixed a potential error during the version check</para> 5017 </listitem> 5018 5019 <listitem> 5020 <para>GUI: shortcut change should not require Enter/Return (or other 5021 trigger) to confirm (bugs #12828, #12847, #12937, #13087)</para> 5022 </listitem> 5023 5024 <listitem> 5025 <para>GUI: fixed update check which was broken due to changing the 5026 location of the root certificates (bug #13096)</para> 5027 </listitem> 5028 5029 <listitem> 5030 <para>VBoxManage: fixed typo in <emphasis>showvminfo --machinereadable</emphasis> 5031 (bug #13176)</para> 5032 </listitem> 5033 5034 <listitem> 5035 <para>NAT: fixed inbound half-close (bug #13116)</para> 5036 </listitem> 5037 5038 <listitem> 5039 <para>NAT: fixed slow upload speed under certain conditions 5040 (bug #10034)</para> 5041 </listitem> 5042 5043 <listitem> 5044 <para>NAT Network: fixed potential loss of inbound TCP data</para> 5045 </listitem> 5046 5047 <listitem> 5048 <para>NAT Network: fixed potential infinite stalls of TCP 5049 connections over IPv6</para> 5050 </listitem> 5051 5052 <listitem> 5053 <para>NAT Network: fixed resets of TCP connections on Windows 5054 hosts</para> 5055 </listitem> 5056 5057 <listitem> 5058 <para>NAT Network: fixed inbound half-close on Mac OS X hosts</para> 5059 </listitem> 5060 5061 <listitem> 5062 <para>NAT Network: fixed socket leak on Solaris hosts</para> 5063 </listitem> 5064 5065 <listitem> 5066 <para>NAT Network: fixed ping of mapped host loopback on Mac OS X 5067 and Solaris hosts, fixed proxying of IMCP errors on Mac OS X</para> 5068 </listitem> 5069 5070 <listitem> 5071 <para>Host-Only Network: fixed SNMP <emphasis>ifConnectorPresent</emphasis> 5072 value on Windows (bug #13143)</para> 5073 </listitem> 5074 5075 <listitem> 5076 <para>Storage: fixed a possible crash with CD/DVD passthrough under 5077 certain circumstances</para> 5078 </listitem> 5079 5080 <listitem> 5081 <para>Storage: fixed a crash when trying to open an inaccessible QED 5082 or QCOW image (bug #12613)</para> 5083 </listitem> 5084 5085 <listitem> 5086 <para>Storage: fixed data corruption or read errors under rare 5087 circumstances</para> 5088 </listitem> 5089 5090 <listitem> 5091 <para>AHCI: fixed a crash under rare circumstances</para> 5092 </listitem> 5093 5094 <listitem> 5095 <para>USB: performance fixes</para> 5096 </listitem> 5097 5098 <listitem> 5099 <para>ICH9: properly reset MSI capability on reset</para> 5100 </listitem> 5101 5102 <listitem> 5103 <para>Keyboard: active modifier keys during suspend were stuck after 5104 resuming the host</para> 5105 </listitem> 5106 5107 <listitem> 5108 <para>3D: fixed misbehavior with huge guests (i.e. guest more than 5109 4GB guest memory</para> 5110 </listitem> 5111 5112 <listitem> 5113 <para>3D: several fixes</para> 5114 </listitem> 5115 5116 <listitem> 5117 <para>API: properly detect the Windows 8.1 guest OS type (bug #13090)</para> 5118 </listitem> 5119 5120 <listitem> 5121 <para>ExtPack: cleanup of dangling uninstallation directories</para> 5122 </listitem> 5123 5124 <listitem> 5125 <para>Linux hosts / guests: compile fix for EL7 (bug #12638)</para> 5126 </listitem> 5127 5128 <listitem> 5129 <para>Linux Additions: made 3D pass-through work with recent versions 5130 of Mesa in the guest (bug #12941)</para> 5131 </listitem> 5132 5133 <listitem> 5134 <para>Linux Additions: Linux 3.16 fixes (bug #13123)</para> 5135 </listitem> 5136 5137 <listitem> 5138 <para>Mac OS X hosts: when scanning for host CD/DVD devices also consider 5139 BlueRay devices</para> 5140 </listitem> 5141 5142 <listitem> 5143 <para>Mac OS X hosts: fixed host shutdown and reboot delay caused by running VBoxSVC 5144 process in some cases</para> 5145 </listitem> 5146 5147 <listitem> 5148 <para>OS/2 Additions: fixed gengradd.dll library name (bug #12785)</para> 5149 </listitem> 5150 5151 <listitem> 5152 <para>Solaris Additions: fixed permissions of files and directories 5153 located on shared folders</para> 5154 </listitem> 5155 5156 <listitem> 5157 <para>Windows host installer: fixed the need for rebooting Windows after 5158 installation or upgrade, extended logging for NetFlt/NetAdp (un)installation</para> 5159 </listitem> 5160 5161 </itemizedlist> 5162 5163 </sect1> 5164 5165 <sect1> 5166 <title>Version 4.3.12 (2014-05-16)</title> 5167 5168 <para>This is a maintenance release. The following items were fixed and/or 5169 added:</para> 5170 5171 <itemizedlist> 5172 5173 <listitem> 5174 <para>VMM: fixed an occasional Guru Meditation (Mac OS X hosts only; 5175 bugs #12727, #12954)</para> 5176 </listitem> 5177 5178 <listitem> 5179 <para>VMM: fixed a rare condition that would fail to invalidate guest TLB 5180 entries or would invalidate them when not required (Windows hosts only)</para> 5181 </listitem> 5182 5183 <listitem> 5184 <para>VMM: fixed a <emphasis>VERR_NOT_SUPPORTED</emphasis> Guru Meditation 5185 seen with certain guests, e.g. OpenServer 5.0.7</para> 5186 </listitem> 5187 5188 <listitem> 5189 <para>VMM: more fixes for MSR emulation on certain hardware (bugs #12240, 5190 #12875)</para> 5191 </listitem> 5192 5193 <listitem> 5194 <para>GUI: fixed mouse positioning with mouse integration disabled and 5195 multiple guest screens (Windows hosts only; bug #9059)</para> 5196 </listitem> 5197 5198 <listitem> 5199 <para>GUI: fixed crash in VM manager (bug #12878)</para> 5200 </listitem> 5201 5202 <listitem> 5203 <para>GUI: fixed crash under rare conditions on entering/exiting 5204 full-screen/seamless mode</para> 5205 </listitem> 5206 5207 <listitem> 5208 <para>Shared Clipboard: don't stop working after taking a snapshot 5209 (bug #12700)</para> 5210 </listitem> 5211 5212 <listitem> 5213 <para>AHCI: fixed a crash under rare circumstances</para> 5214 </listitem> 5215 5216 <listitem> 5217 <para>API: fixed a hang during VM shutdown under rare conditions</para> 5218 </listitem> 5219 5220 <listitem> 5221 <para>NAT: fixed generation of malformed ICMP error datagrams (4.3.10 regression)</para> 5222 </listitem> 5223 5224 <listitem> 5225 <para>NAT: fixed potential crash in DNS proxy</para> 5226 </listitem> 5227 5228 <listitem> 5229 <para>NAT Network: don't drop port forwarding rules after some time</para> 5230 </listitem> 5231 5232 <listitem> 5233 <para>NAT: fixed ARP cache corruption and network loss in Windows guest caused 5234 by iSCSI service activity</para> 5235 </listitem> 5236 5237 <listitem> 5238 <para>USB: improved check if a storage device is currently mounted to the host 5239 when the device is about to be attached to the VM (Mac OS X hosts only; #11038)</para> 5240 </listitem> 5241 5242 <listitem> 5243 <para>3D support: several fixes, including better support for Ubuntu 14.04</para> 5244 </listitem> 5245 5246 <listitem> 5247 <para>VRDP: fixed a potential crash on client disconnect (bug #12858)</para> 5248 </listitem> 5249 5250 <listitem> 5251 <para>VBoxSVC: fixed a race when a new client is started a few seconds after 5252 the last client terminated (Windows hosts only; bugs #11309, #12509)</para> 5253 </listitem> 5254 5255 <listitem> 5256 <para>VBoxSVC: fixed VirtualBox.xml registry corruption after VM renaming</para> 5257 </listitem> 5258 5259 <listitem> 5260 <para>VBoxSVC: fixed a potential crash caused by incorrect USB device filter 5261 (Mac OS X hosts only; #11038)</para> 5262 </listitem> 5263 5264 <listitem> 5265 <para>Windows hosts: partly support 32-bit COM on 64-bit systems</para> 5266 </listitem> 5267 5268 <listitem> 5269 <para>Windows host installer: implemented merge module (msm) support</para> 5270 </listitem> 5271 5272 <listitem> 5273 <para>Linux hosts: fixed dependency of boot script on older Debian systems 5274 (bug #12262)</para> 5275 </listitem> 5276 5277 <listitem> 5278 <para>Linux guests: fix symbolic link to shared folder helper 5279 (bug #12879)</para> 5280 </listitem> 5281 5282 <listitem> 5283 <para>Linux Additions: don't crash VBoxService during guest execute for 5284 users without a password (bug #12994)</para> 5285 </listitem> 5286 5287 <listitem> 5288 <para>Linux Additions: fixed a bug in guest execution where the guest process 5289 terminated with <emphasis>VERR_INTERRUPTED</emphasis> to the host</para> 5290 </listitem> 5291 5292 </itemizedlist> 5293 5294 </sect1> 5295 5296 <sect1> 5297 <title>Version 4.3.10 (2014-03-26)</title> 5298 5299 <para>This is a maintenance release. The following items were fixed and/or 5300 added:</para> 5301 5302 <itemizedlist> 5303 5304 <listitem> 5305 <para>VMM: more work on improving the emulation of certain MSR registers 5306 on certain host CPUs (e.g. bugs #12734, #12736, #12744, #12748, #12686, 5307 #12770)</para> 5308 </listitem> 5309 5310 <listitem> 5311 <para>VMM: fixed single-stepping for real-mode guests (VT-x without 5312 unrestricted guest execution) and some I/O instructions (bug #12636)</para> 5313 </listitem> 5314 5315 <listitem> 5316 <para>VMM: fixed a potential problem with COW pages if nested paging is 5317 not available</para> 5318 </listitem> 5319 5320 <listitem> 5321 <para>GUI: Mac OS X: experimental native full screen support for 5322 Mountain Lion and Mavericks (bug #12292)</para> 5323 </listitem> 5324 5325 <listitem> 5326 <para>GUI: Mac OS X: removed the mini-toolbar minimize button which 5327 doesn't work under Mac OS X full screen mode anyway</para> 5328 </listitem> 5329 5330 <listitem> 5331 <para>GUI: experimental HID LEDs synchronization for Windows and Mac OS X hosts: 5332 fixed keyboard re-synchronization if the feature is disabled (as done by default; 5333 bug #12758)</para> 5334 </listitem> 5335 5336 <listitem> 5337 <para>GUI: fixed a potential crash when opening the preferences menu 5338 (bug #12862)</para> 5339 </listitem> 5340 5341 <listitem> 5342 <para>OVF: fixed a crash of the VirtualBox Manager when re-starting guest 5343 export (bug #12586)</para> 5344 </listitem> 5345 5346 <listitem> 5347 <para>3D support: several fixes</para> 5348 </listitem> 5349 5350 <listitem> 5351 <para>HGCM: fixed a problem with saved states which could cause several 5352 guest misbehavior after a VM was started from a saved state</para> 5353 </listitem> 5354 5355 <listitem> 5356 <para>Storage: fixed a bug preventing to compact differential snapshots 5357 under certain conditions</para> 5358 </listitem> 5359 5360 <listitem> 5361 <para>VBoxSVC: fixed a segmentation fault on Linux hosts if a very long path 5362 exists under /dev (bug #12760)</para> 5363 </listitem> 5364 5365 <listitem> 5366 <para>API: fixed guest misbehavior under certain conditions if a storage 5367 medium was attached or removed at VM runtime</para> 5368 </listitem> 5369 5370 <listitem> 5371 <para>Windows installer: make the <emphasis>--silent</emphasis> 5372 parameter work again (bug #12764)</para> 5373 </listitem> 5374 5375 <listitem> 5376 <para>Mac OS X Networking: prevent local traffic (VM-to/from-host) from 5377 leaking to wire (bug #12750)</para> 5378 </listitem> 5379 5380 <listitem> 5381 <para>Windows Additions: fixed the environment for guest processes 5382 (4.3.8 regression; bug #12782)</para> 5383 </listitem> 5384 5385 <listitem> 5386 <para>Windows Additions/WDDM: fixed divide by zero exception with 5387 multiple guest screens under certain conditions</para> 5388 </listitem> 5389 5390 <listitem> 5391 <para>Windows Additions/WDDM: fixed crashes with 2D video 5392 acceleration enabled (4.3.8 regression; bug #12745)</para> 5393 </listitem> 5394 5395 <listitem> 5396 <para>Linux Additions: install correctly on Ubuntu guest systems 5397 with a /usr/lib64 directory (bug #12513)</para> 5398 </listitem> 5399 5400 <listitem> 5401 <para>X11 Additions: fix for the VBoxClient process not exiting 5402 correctly (bug #12348) and consuming too much processor time</para> 5403 </listitem> 5404 5405 </itemizedlist> 5406 </sect1> 5407 5408 <sect1> 5409 <title>Version 4.3.8 (2014-02-25)</title> 5410 5411 <para>This is a maintenance release. The following items were fixed and/or 5412 added:</para> 5413 5414 <itemizedlist> 5415 5416 <listitem> 5417 <para>VMM: more work on improving the emulation of certain MSR registers 5418 (e.g. bugs #12224, #12544)</para> 5419 </listitem> 5420 5421 <listitem> 5422 <para>VMM: fixed a <emphasis>VERR_INVALID_RPL</emphasis> Guru Meditation 5423 when booting certain guests (bug #11350)</para> 5424 </listitem> 5425 5426 <listitem> 5427 <para>VMM: experimental support for SSE 4.1 / SSE 4.2 passthrough, see 5428 the user manual how to enable it (bug #8651)</para> 5429 </listitem> 5430 5431 <listitem> 5432 <para>VMM: fix for recent Linux kernels with software virtualization</para> 5433 </listitem> 5434 5435 <listitem> 5436 <para>GUI: experimental HID LEDs synchronization for Windows hosts, see 5437 <xref linkend="hidledssync" xreflabel="here"/></para> 5438 </listitem> 5439 5440 <listitem> 5441 <para>GUI: warn the user if the Oracle Extension Pack is not installed and 5442 the user tries to activate the remote display feature (bug #9104)</para> 5443 </listitem> 5444 5445 <listitem> 5446 <para>GUI: make sure that a minimized guest (using mini toolbar in 5447 full screen / seamless mode) keeps the minimized state (bug #12199)</para> 5448 </listitem> 5449 5450 <listitem> 5451 <para>GUI: popup banner's "do not show this message again" check-box 5452 replaced with corresponding button</para> 5453 </listitem> 5454 5455 <listitem> 5456 <para>GUI: network adapter cables can now be connected/disconnected directly through 5457 the running virtual machine Devices / Network menu a Network status-bar 5458 indicator</para> 5459 </listitem> 5460 5461 <listitem> 5462 <para>GUI: the new VM wizard now proposes 64-bit guests on 64-bit hosts 5463 by default; better distinction between 32-bit OS types 64-bit OS types 5464 (bug #12533)</para> 5465 </listitem> 5466 5467 <listitem> 5468 <para>GUI: better error message if appliance import fails 5469 (bug #12657)</para> 5470 </listitem> 5471 5472 <listitem> 5473 <para>GUI: allow to set host-combination to 'None' using the Global settings 5474 / Input page (bug #12730)</para> 5475 </listitem> 5476 5477 <listitem> 5478 <para>GUI: don't switch the guest to a black screen during online snapshot 5479 merge (4.3 regression)</para> 5480 </listitem> 5481 5482 <listitem> 5483 <para>VBoxManage: when exporting an appliance, support the suppression 5484 of MAC addresses, which means they will be always recreated on 5485 import, avoiding duplicate MAC addresses for VMs which are imported 5486 several times</para> 5487 </listitem> 5488 5489 <listitem> 5490 <para>AHCI: fixed a VM hang during suspend under certain circumstances</para> 5491 </listitem> 5492 5493 <listitem> 5494 <para>AHCI: fixed a VM hang during online snapshot merge under certain 5495 circumstances</para> 5496 </listitem> 5497 5498 <listitem> 5499 <para>AHCI: fixed a bug which resulted in Windows XP guest hangs if a 5500 SATA CDROM is attached (bug #12417)</para> 5501 </listitem> 5502 5503 <listitem> 5504 <para>AHCI: fixed a Guru Meditation under certain conditions</para> 5505 </listitem> 5506 5507 <listitem> 5508 <para>AHCI: ejecting a CD/DVD medium failed under certain conditions</para> 5509 </listitem> 5510 5511 <listitem> 5512 <para>AHCI: disk hotplugging fixes</para> 5513 </listitem> 5514 5515 <listitem> 5516 <para>NAT: transparent handling of host sleep/resume and network configuration 5517 changes if the dnsproxy is enabled or if the hostresolver is used 5518 (bug #12441)</para> 5519 </listitem> 5520 5521 <listitem> 5522 <para>NAT: fixed crash and misbehaviour under some circumstances with 5523 ICMP packets having TTL=1</para> 5524 </listitem> 5525 5526 <listitem> 5527 <para>NAT Network: fixed IPv6 reassembly</para> 5528 </listitem> 5529 5530 <listitem> 5531 <para>NAT Network: ping proxy implemented</para> 5532 </listitem> 5533 5534 <listitem> 5535 <para>OVF: fixed reading of the OVF 0.9 section element 5536 (4.3 regression; bug #12345)</para> 5537 </listitem> 5538 5539 <listitem> 5540 <para>OVF: several fixes</para> 5541 </listitem> 5542 5543 <listitem> 5544 <para>3D support: several fixes, multiscreen fixes (e.g. bug #9124)</para> 5545 </listitem> 5546 5547 <listitem> 5548 <para>3D support: include 3D content in captured videos (bug #12666)</para> 5549 </listitem> 5550 5551 <listitem> 5552 <para>3D support: include 3D content in captured screenshot (bug #11758)</para> 5553 </listitem> 5554 5555 <listitem> 5556 <para>VGA: proper handling of legacy graphics modes if the Guest 5557 Additions are active (bug #6649)</para> 5558 </listitem> 5559 5560 <listitem> 5561 <para>USB: fixed crash during isochronous transfer under rare 5562 circumstances</para> 5563 </listitem> 5564 5565 <listitem> 5566 <para>BIOS: better disk geometry handling of SCSI drives</para> 5567 </listitem> 5568 5569 <listitem> 5570 <para>API: fix crashes in Java API clients using the XPCOM binding, 5571 happened with output parameters only (bug #11232)</para> 5572 </listitem> 5573 5574 <listitem> 5575 <para>VBoxSVC: documented the handling of host power management events 5576 (see <xref linkend="hostpowertweaks" xreflabel="here"/>) and 5577 added an extradata item for configuring the handling of the battery-low 5578 event (bug #9925)</para> 5579 </listitem> 5580 5581 <listitem> 5582 <para>VBoxSVC: fixed a bug which could trigger a crash if a VM snapshot 5583 was restored the second time and the VM has associated bandwidth groups 5584 (bug #12569)</para> 5585 </listitem> 5586 5587 <listitem> 5588 <para>VBoxSVC: properly detect ifconfig if located in <emphasis>/bin</emphasis> 5589 (bug #12713)</para> 5590 </listitem> 5591 5592 <listitem> 5593 <para>Shared Folders: fixed a failure to restore transient shared folders 5594 when starting a VM from a saved state (bug #12578)</para> 5595 </listitem> 5596 5597 <listitem> 5598 <para>Mac OS X hosts: fixed issue when the application icon was frozen in 5599 the dock if the bridging interface was not connected to a network 5600 (bug #12241)</para> 5601 </listitem> 5602 5603 <listitem> 5604 <para>Linux hosts: also consider the physical package ID when determining 5605 the number of physical CPU cores</para> 5606 </listitem> 5607 5608 <listitem> 5609 <para>Linux hosts / guests: don't warn in kernel log if memory allocation 5610 fails (bug #11171)</para> 5611 </listitem> 5612 5613 <listitem> 5614 <para>Solaris hosts: fixed the autostart SMF script (bug #11720)</para> 5615 </listitem> 5616 5617 <listitem> 5618 <para>Windows hosts: fixes for non-ANSI code page user names and similar 5619 environment contents (bug #12596)</para> 5620 </listitem> 5621 5622 <listitem> 5623 <para>Windows hosts / guests: fixed setting and using a guest user's process 5624 environment variables (relevant for Guest Control)</para> 5625 </listitem> 5626 5627 <listitem> 5628 <para>Windows Additions: fixed handle leaks in VBoxTray (bug #12563)</para> 5629 </listitem> 5630 5631 <listitem> 5632 <para>Windows Additions: fixed a crash while detecting active guest users</para> 5633 </listitem> 5634 5635 <listitem> 5636 <para>Windows Additions: fixed restoring backed up D3D files on 5637 XPDM -> WDDM upgrade</para> 5638 </listitem> 5639 5640 <listitem> 5641 <para>Guest Control: fixed setting and using a guest user's process 5642 environment variables</para> 5643 </listitem> 5644 5645 <listitem> 5646 <para>Linux Additions: support Enterprise Linux 6.5 kernels 5647 (bug #12505)</para> 5648 </listitem> 5649 5650 <listitem> 5651 <para>Linux Additions: fixed CPU hot-remove on newer Linux kernels</para> 5652 </listitem> 5653 5654 <listitem> 5655 <para>Linux / Solaris Additions: don't automount a shared folder which is already 5656 mounted</para> 5657 </listitem> 5658 5659 <listitem> 5660 <para>X11 Additions: support X.Org Server 1.15 (bug #12623)</para> 5661 </listitem> 5662 5663 </itemizedlist> 5664 5665 </sect1> 5666 5667 <sect1> 5668 <title>Version 4.3.6 (2013-12-18)</title> 5669 5670 <para>This is a maintenance release. The following items were fixed and/or 5671 added:</para> 5672 5673 <itemizedlist> 5674 5675 <listitem> 5676 <para>VMM: fixed a Guru Meditation <emphasis>VINF_EM_TRIPLE_FAULT</emphasis> 5677 caused by VMCB caching with nested paging on certain AMD CPUs (bug #12451)</para> 5678 </listitem> 5679 5680 <listitem> 5681 <para>VMM: fixed a Guru Meditation <emphasis>VERR_VMX_UNEXPECTED_INTERRUPTION_EXIT_TYPE</emphasis> 5682 while intercepting debug exceptions (VT-x only; bug #12410)</para> 5683 </listitem> 5684 5685 <listitem> 5686 <para>VMM: fixed a Guru Meditation <emphasis>VERR_SVM_UNEXPECTED_EXIT</emphasis> 5687 while intercepting debug register accesses (AMD-V only; bug #12481)</para> 5688 </listitem> 5689 5690 <listitem> 5691 <para>VMM: fixed a <emphasis>VERR_SSM_STRUCTURE_MAGIC</emphasis> error when trying 5692 to load a saved state made with VBox 4.3.4 when VT-x/AMD-V is disabled. Unfortunately, 5693 VBox 4.3.4 produced broken saved states for this configuration so you have to discard 5694 these states (bug #12414)</para> 5695 </listitem> 5696 5697 <listitem> 5698 <para>VMM: added a few more MSRs to the whitelist required by certain guests 5699 (bug #12245)</para> 5700 </listitem> 5701 5702 <listitem> 5703 <para>GUI: fixed deleting of inaccessible VMs (4.3 regression; bug 5704 #12205)</para> 5705 </listitem> 5706 5707 <listitem> 5708 <para>GUI: fixed warnings in VM settings / number of guest processors 5709 (bug #12480)</para> 5710 </listitem> 5711 5712 <listitem> 5713 <para>Main: don't automatically enable 64-bit guests on 64-bit hosts if 5714 VT-x/AMD-V is not available (bug #12424)</para> 5715 </listitem> 5716 5717 <listitem> 5718 <para>Main: always expose the DMI memory information to Windows 2012 guests 5719 (bug #12017)</para> 5720 </listitem> 5721 5722 <listitem> 5723 <para>Main: fixed occasional crashes on guest display resolution change 5724 (bug #7063)</para> 5725 </listitem> 5726 5727 <listitem> 5728 <para>Main: fixed reporting back temporary name when calling 5729 <emphasis>IGuestSession::DirectoryCreateTemp()</emphasis> (bug #12498)</para> 5730 </listitem> 5731 5732 <listitem> 5733 <para>API: fix for a hang when launching a GUI VM through the API, which crashes 5734 due to GUI unavailability</para> 5735 </listitem> 5736 5737 <listitem> 5738 <para>Storage: fix for <emphasis>BLKCACHE_IOERR</emphasis> runtime errors under 5739 rare circumstances (bug #11030)</para> 5740 </listitem> 5741 5742 <listitem> 5743 <para>Network: allow to start more than 5 PCNet instances (bug #12426)</para> 5744 </listitem> 5745 5746 <listitem> 5747 <para>E1000: if the cable was disconnected before the guest initialized 5748 the device, the link status was not properly set to 'down' after the 5749 initialization completed despite the fact that there was no connection</para> 5750 </listitem> 5751 5752 <listitem> 5753 <para>3D support: fixed offset of guest 3D image elements (Mac OS X Retina 5754 hosts only; bug #11021)</para> 5755 </listitem> 5756 5757 <listitem> 5758 <para>Solaris hosts: fixed accessing the host driver from non-global zones 5759 (4.3 regression; bug #12271)</para> 5760 </listitem> 5761 5762 </itemizedlist> 5763 5764 </sect1> 5765 5766 <sect1> 5767 <title>Version 4.3.4 (2013-11-29)</title> 5768 5769 <para>This is a maintenance release. The following items were fixed and/or 5770 added:</para> 5771 5772 <itemizedlist> 5773 5774 <listitem> 5775 <para>VMM: fix for a bug in the Local APIC emulation causing a BSOD when 5776 booting certain guests (4.3.0 regression; bug #12240)</para> 5777 </listitem> 5778 5779 <listitem> 5780 <para>VMM: fixed loading of saved states if VT-x/AMD-V was disabled 5781 (4.3.2 regression; bug #12291)</para> 5782 </listitem> 5783 5784 <listitem> 5785 <para>VMM: fixed single-stepping inside the guest for certain 5786 instructions (VT-x only; bug #10947)</para> 5787 </listitem> 5788 5789 <listitem> 5790 <para>VMM: fixed a performance issue involving APIC accesses after rebooting 5791 a VM (4.3.0 regression; VT-x only; bug #12296)</para> 5792 </listitem> 5793 5794 <listitem> 5795 <para>VMM: fixed TPR patching to be enabled for 32-bit guests even when 5796 the chosen guest type is 64-bit (4.3.0 regression; AMD-V only)</para> 5797 </listitem> 5798 5799 <listitem> 5800 <para>VMM: fixed occasional <emphasis>VINF_EM_TRIPLE_FAULT</emphasis> errors on 5801 hosts without the unrestricted guest execution feature (bug #12198)</para> 5802 </listitem> 5803 5804 <listitem> 5805 <para>GUI: don't bother the user with the BPP warning if no 5806 Guest Additions are installed</para> 5807 </listitem> 5808 5809 <listitem> 5810 <para>GUI: fixed machine-window paint artifacts on VM reboot / guest-screen 5811 resize</para> 5812 </listitem> 5813 5814 <listitem> 5815 <para>GUI: make sure the assigned license and description are attached to 5816 the exported appliance</para> 5817 </listitem> 5818 5819 <listitem> 5820 <para>GUI: fixed bugs in close VM action restrictions handling (bug #12333)</para> 5821 </listitem> 5822 5823 <listitem> 5824 <para>GUI: fixed incorrect wizards text colors for some unusual 5825 look and feel styles (bug #11743)</para> 5826 </listitem> 5827 5828 <listitem> 5829 <para>GUI: should restore seamless mode as soon as possible after 5830 VM reboot or shutdown</para> 5831 </listitem> 5832 5833 <listitem> 5834 <para>GUI: fixes for medium enumeration</para> 5835 </listitem> 5836 5837 <listitem> 5838 <para>GUI: the OS X hot corners were not accessible while a VirtualBox VM 5839 is running (Mac OS X hosts only; bug #4139)</para> 5840 </listitem> 5841 5842 <listitem> 5843 <para>GUI: fixed an old bug which bared the host from cleanly shutdown / reboot 5844 if the VM selector window is open (Mac OS X hosts only; bug #8254)</para> 5845 </listitem> 5846 5847 <listitem> 5848 <para>Host-only Network: fixed creating of host-only network interfaces 5849 (4.3.0 regression; bug #12182)</para> 5850 </listitem> 5851 5852 <listitem> 5853 <para>NAT: don't run into an infinite loop in case the host cannot 5854 access any DNS server (4.3.0 regression; bug #12300)</para> 5855 </listitem> 5856 5857 <listitem> 5858 <para>NAT: don't re-connect the cable if the DNS information changes 5859 and the cable was disconnected before (4.3.0 regression; bug #12225)</para> 5860 </listitem> 5861 5862 <listitem> 5863 <para>NAT: fixed several issues with automatically starting / 5864 terminating of NAT networks on VM start / stop and configuration 5865 changes</para> 5866 </listitem> 5867 5868 <listitem> 5869 <para>VBoxNetDHCP: don't block prevent VBoxSVC from terminating 5870 (bug #12264)</para> 5871 </listitem> 5872 5873 <listitem> 5874 <para>2D Video acceleration: fix crashes on presentation mode switches 5875 (bug #9194)</para> 5876 </listitem> 5877 5878 <listitem> 5879 <para>BusLogic: allow to run VMs with more than one BusLogic SCSI 5880 controller enabled</para> 5881 </listitem> 5882 5883 <listitem> 5884 <para>Keyboard: fixed a VM crash if a VM was resumed from a saved state 5885 where at least one key was pressed (bug #11289)</para> 5886 </listitem> 5887 5888 <listitem> 5889 <para>VBoxSVC: fixed a heap corruption under certain conditions (4.3.0 5890 regression)</para> 5891 </listitem> 5892 5893 <listitem> 5894 <para>VBoxSVC: fixed a race leading to a hang during initialization 5895 (bug #12349)</para> 5896 </listitem> 5897 5898 <listitem> 5899 <para>OVF: fixed import logic for OVF appliances containing multiple 5900 VMs</para> 5901 </listitem> 5902 5903 <listitem> 5904 <para>OVF: improved logic for finding an appropriate image format 5905 during OVF import</para> 5906 </listitem> 5907 5908 <listitem> 5909 <para>API: block the removal of the current snapshot if it has child 5910 snapshots (only relevant for VMs without snapshottable hard disks, 5911 their presence always prevented removal), which resulted in VM 5912 config corruption</para> 5913 </listitem> 5914 5915 <listitem> 5916 <para>API: mark VM configs with snapshots but without current snapshot 5917 as inaccessible, as this combination is nonsense</para> 5918 </listitem> 5919 5920 <listitem> 5921 <para>API: fixed information for some automatically generated events 5922 (only with XPCOM, Windows host was not affected), which caused 5923 errors when getting some of the attributes over the webservice 5924 (bug #12379)</para> 5925 </listitem> 5926 5927 <listitem> 5928 <para>SDK: extended the functionality coverage for the C bindings</para> 5929 </listitem> 5930 5931 <listitem> 5932 <para>Guest Control: various bugfixes and improved VBoxManage help 5933 (bugs #8072, #11044, #12336, #12338, #12346, #12371)</para> 5934 </listitem> 5935 5936 <listitem> 5937 <para>Windows hosts: another attempt to fix the massive DPC latency 5938 (bug #6242)</para> 5939 </listitem> 5940 5941 <listitem> 5942 <para>Windows host installer: make registering file extensions optional, 5943 contributed by Tal Aloni (bug #8009)</para> 5944 </listitem> 5945 5946 <listitem> 5947 <para>Mac OS X hosts: properly sign the kernel extensions for Mavericks 5948 hosts (bug #12256)</para> 5949 </listitem> 5950 5951 <listitem> 5952 <para>Mac OS X hosts: fixed a bug where the VirtualBox dock icon was 5953 not properly removed from the dock after a VM terminated preventing 5954 Mavericks hosts from shutting down (bug #12241)</para> 5955 </listitem> 5956 5957 <listitem> 5958 <para>Mac OS X hosts: fixed minor installer issue (bug #12275)</para> 5959 </listitem> 5960 5961 <listitem> 5962 <para>Linux hosts / guests: Linux 3.13 compile fixes (bug #12358)</para> 5963 </listitem> 5964 5965 <listitem> 5966 <para>Linux guests: build the vboxvideo kernel module correctly on 5967 OL/RHEL 6.1 guests (bug #11996)</para> 5968 </listitem> 5969 5970 <listitem> 5971 <para>Linux guests: make 3D work on Slackware 14.1 5972 (bug #12320 comments 3 and 4)</para> 5973 </listitem> 5974 5975 <listitem> 5976 <para>Guest Additions/3D: fixed an occasional dead-lock (bug #12319)</para> 5977 </listitem> 5978 5979 <listitem> 5980 <para>Windows Additions/3D: fixed possible memory leaking (bug #12228)</para> 5981 </listitem> 5982 5983 <listitem> 5984 <para>Windows Additions/XPDM: use separate tables containing valid video 5985 modes for each virtual monitor</para> 5986 </listitem> 5987 5988 <listitem> 5989 <para>Windows Additions: fixed automatic logins for Vista and newer Windows 5990 guests (bug #12332)</para> 5991 </listitem> 5992 5993 </itemizedlist> 5994 </sect1> 5995 5996 <sect1> 5997 <title>Version 4.3.2 (2013-11-01)</title> 5998 5999 <para>This is a maintenance release. The following items were fixed and/or 6000 added:</para> 6001 6002 <itemizedlist> 6003 6004 <listitem> 6005 <para>VMM: fixed restoring of the auxiliary TSC MSR in VT-x that caused host 6006 BSODs on Windows 8.1 hosts and unpredictable behavior on other hosts 6007 (bug #12237)</para> 6008 </listitem> 6009 6010 <listitem> 6011 <para>VMM: provide fake values for a couple of MSRs to make more guests happy on 6012 certain hosts</para> 6013 </listitem> 6014 6015 <listitem> 6016 <para>VMM: fixed detection of VT-x on certain machines where the BIOS would 6017 not set the VMX LOCK feature bit, which affected the VM settings in the GUI</para> 6018 </listitem> 6019 6020 <listitem> 6021 <para>VMM: fixed TPR threshold which caused BSODs on Windows XP guests 6022 that use the I/O APIC (VT-x only; bug #12227)</para> 6023 </listitem> 6024 6025 <listitem> 6026 <para>VMM: fixed PATM saved state incompatibility for software virtualized 6027 VMs (bug #12222)</para> 6028 </listitem> 6029 6030 <listitem> 6031 <para>VMM: don't fail if AMD-V isn't available if the VM is configured 6032 to use software virtualization</para> 6033 </listitem> 6034 6035 <listitem> 6036 <para>GUI: fixed guest resize breakage on visual representation mode change 6037 (when switching from normal to full screen etc)</para> 6038 </listitem> 6039 6040 <listitem> 6041 <para>GUI: make sure the guest screen is resized after restoring a VM from a 6042 saved state if the host screen size changed</para> 6043 </listitem> 6044 6045 <listitem> 6046 <para>GUI: disabled SCROLL LED sync from HID LEDs synchronization 6047 (Mac OS X hosts only)</para> 6048 </listitem> 6049 6050 <listitem> 6051 <para>Webcam passthrough improvements including GUI support (see 6052 <xref linkend="webcam-passthrough" />)</para> 6053 </listitem> 6054 6055 <listitem> 6056 <para>Guest Control: implemented more <computeroutput>IGuestSession</computeroutput> 6057 methods</para> 6058 </listitem> 6059 6060 <listitem> 6061 <para>Guest Control: added support for deleting and renaming guest files + directories in 6062 VBoxManage</para> 6063 </listitem> 6064 6065 <listitem> 6066 <para>Guest Control: various bugfixes</para> 6067 </listitem> 6068 6069 <listitem> 6070 <para>API: incorrect handling of hardware UUID default value, resulting 6071 in an all zero DMI/SMBIOS UUID, which leads to Windows requesting 6072 re-activation (4.3 regression; bug #12244)</para> 6073 </listitem> 6074 6075 <listitem> 6076 <para>3D support: fixed crash on shutdown if 2D video acceleration is enabled 6077 (Mac OS X hosts only)</para> 6078 </listitem> 6079 6080 <listitem> 6081 <para>3D support: miscellaneous fixes</para> 6082 </listitem> 6083 6084 <listitem> 6085 <para>Storage: fixed detection of CD/DVD media when switching from an empty 6086 to a host drive with passthrough enabled</para> 6087 </listitem> 6088 6089 <listitem> 6090 <para>Storage: fixed hang of the VM process when the disk is full under certain 6091 circumstances</para> 6092 </listitem> 6093 6094 <listitem> 6095 <para>NAT: listen for changes of NAT Network setting at runtime</para> 6096 </listitem> 6097 6098 <listitem> 6099 <para>NAT: NAT Network DHCP server now saves leases to a persistent 6100 storage</para> 6101 </listitem> 6102 6103 <listitem> 6104 <para>Main: monitor changes in host DNS configuration</para> 6105 </listitem> 6106 6107 <listitem> 6108 <para>Mac OS X host: reworked a mechanism of adding a VM desktop alias 6109 from the VM selector</para> 6110 </listitem> 6111 6112 <listitem> 6113 <para>Mac OS X installer: remove old kernel extensions during upgrade 6114 (bug #12258)</para> 6115 </listitem> 6116 6117 <listitem> 6118 <para>Linux Additions: correctly set umask before installing 6119 (bug #12166)</para> 6120 </listitem> 6121 6122 <listitem> 6123 <para>X11 Additions/3D: fix freezes starting 3D desktop (bug #11503, 6124 thank you Sam Spilsbury)</para> 6125 </listitem> 6126 6127 <listitem> 6128 <para>X11 Additions/3D: fix depth buffer support (bug #11905)</para> 6129 </listitem> 6130 6131 <listitem> 6132 <para>X11 Additions/3D: fix Age Of Empires 3 rendering (bug #11331)</para> 6133 </listitem> 6134 6135 <listitem> 6136 <para>Windows Additions/3D: fix Google Earth plugin rendering</para> 6137 </listitem> 6138 6139 <listitem> 6140 <para>Windows Additions/WDDM: autoresize fixes</para> 6141 </listitem> 6142 6143 </itemizedlist> 6144 </sect1> 6145 6146 <sect1> 6147 <title>Version 4.3.0 (2013-10-15)</title> 6148 6149 <para>This is a major update. The following major new features 6150 were added:</para> 6151 6152 <itemizedlist> 6153 6154 <listitem> 6155 <para>VMM: major rewrite of the VT-x code and the AMD-V code including 6156 many bug fixes and performance improvements (for example bug #9659)</para> 6157 </listitem> 6158 6159 <listitem> 6160 <para>VMM: introduced a lightweight instruction interpreter for 6161 situations not handled by hardware virtualization</para> 6162 </listitem> 6163 6164 <listitem> 6165 <para>GUI: extended messaging mechanism (new non-modal popup overlays 6166 used to show non-critical warnings and provide user with additional information)</para> 6167 </listitem> 6168 6169 <listitem> 6170 <para>GUI: keyboard shortcuts management (input page of global preferences 6171 extended with possibility to edit general keyboard shortcuts for 6172 VirtualBox Manager and Virtual Machine)</para> 6173 </listitem> 6174 6175 <listitem> 6176 <para>GUI: video capturing support (bug #4766)</para> 6177 </listitem> 6178 6179 <listitem> 6180 <para>Added USB touch device emulation</para> 6181 </listitem> 6182 6183 <listitem> 6184 <para>Added experimental support for webcam passthrough 6185 complementing USB passthrough (see <xref linkend="webcam-passthrough" />)</para> 6186 </listitem> 6187 6188 <listitem> 6189 <para>Added SCSI CD-ROM emulation, including boot support</para> 6190 </listitem> 6191 6192 <listitem> 6193 <para>VRDP: support for IPv6</para> 6194 </listitem> 6195 6196 <listitem> 6197 <para>Guest Control: guest sessions now are running in dedicated, impersonated 6198 session processes (needs at least Guest Additions 4.3 installed)</para> 6199 </listitem> 6200 6201 <listitem> 6202 <para>Guest Control: implemented <computeroutput>IGuestFile</computeroutput> 6203 support</para> 6204 </listitem> 6205 6206 <listitem> 6207 <para>NAT: experimental virtual router mode: several VMs are 6208 attached to the same internal network and share one NAT 6209 service (see <xref linkend="network_nat_service" />) 6210 </para> 6211 </listitem> 6212 6213 </itemizedlist> 6214 6215 <para>In addition, the following items were fixed and/or added:</para> 6216 6217 <itemizedlist> 6218 6219 <listitem> 6220 <para>VMM: significantly improved performance of NetWare 5.x/6.x 6221 guests on host systems without nested paging support</para> 6222 </listitem> 6223 6224 <listitem> 6225 <para>VMM: fixed losing host NMIs while in VT-x guest-context</para> 6226 </listitem> 6227 6228 <listitem> 6229 <para>VMM: changed order of actions in emulated task switch 6230 (bug #10532)</para> 6231 </listitem> 6232 6233 <listitem> 6234 <para>VMM: allow to activate VT-x while in SMX mode and provide more 6235 information if that is not possible</para> 6236 </listitem> 6237 6238 <listitem> 6239 <para>GUI: update check uses https</para> 6240 </listitem> 6241 6242 <listitem> 6243 <para>GUI: numerous minor internal cleanups and bug fixes</para> 6244 </listitem> 6245 6246 <listitem> 6247 <para>GUI: HID LEDs synchronization when switching between guest window(s) 6248 and host (Mac OS X hosts only)</para> 6249 </listitem> 6250 6251 <listitem> 6252 <para>GUI, VBoxManage: when unregistering a VM, also unregister the 6253 hard disk images which are used exclusively (bug #10311)</para> 6254 </listitem> 6255 6256 <listitem> 6257 <para>GUI: use the number of physical presented processor cores instead of 6258 the number of logical processor cores to check if the users assigned 6259 too many virtual CPUs to the guest</para> 6260 </listitem> 6261 6262 <listitem> 6263 <para>Snapshots: made live snapshots work again (bug #9255)</para> 6264 </listitem> 6265 6266 <listitem> 6267 <para>Teleportation: made it work again (bug #9455)</para> 6268 </listitem> 6269 6270 <listitem> 6271 <para>Storage: implemented AHA-154x compatibility mode in the 6272 emulated BusLogic SCSI HBA</para> 6273 </listitem> 6274 6275 <listitem> 6276 <para>Storage: significantly improved performance of large ATAPI PIO 6277 transfers (BeOS, Minix 3 guests affected)</para> 6278 </listitem> 6279 6280 <listitem> 6281 <para>Storage: added floppy formatting emulation (NB: cannot be used 6282 to change existing media geometry) 6283 </para> 6284 </listitem> 6285 6286 <listitem> 6287 <para>Settings: global and per-VM default frontend configuration, 6288 useful to select the use of alternative VM frontends</para> 6289 </listitem> 6290 6291 <listitem> 6292 <para>Settings: limit depth of snapshot tree to 250 levels, as more 6293 will lead to decreased performance and may trigger crashes</para> 6294 </listitem> 6295 6296 <listitem> 6297 <para>Settings: the per-VM hwvirtextexcl setting has been replaced 6298 by a global hwvirtexclusive property</para> 6299 </listitem> 6300 6301 <listitem> 6302 <para>Main: new event queue implementation which does not use the host's 6303 native event queue for processing VirtualBox events anymore</para> 6304 </listitem> 6305 6306 <listitem> 6307 <para>Main: eliminate the use of SysV semaphores on all host OSes 6308 other than Windows, namely Linux, Solaris and Mac OS X, with the 6309 consequence that no system reconfiguration is needed to run more 6310 than approximately 100 VMs</para> 6311 </listitem> 6312 6313 <listitem> 6314 <para>Main: use the XDG standard configuration folder instead of 6315 .VirtualBox on systems where it is appropriate (bug #5099)</para> 6316 </listitem> 6317 6318 <listitem> 6319 <para>Main: extension pack framework can now support loading HGCM 6320 modules, contributed by Jeff Westphal</para> 6321 </listitem> 6322 6323 <listitem> 6324 <para>VBoxManage: list more information about hard disk/DVD/floppy 6325 media, and support the <computeroutput>--long</computeroutput> 6326 option to show really all available details</para> 6327 </listitem> 6328 6329 <listitem> 6330 <para>VBoxManage: added support for optional command line parameters for 6331 the automatic Guest Additions update</para> 6332 </listitem> 6333 6334 <listitem> 6335 <para>VBoxManage: added support for listing active guest sessions, guest 6336 processes and/or guest files via 6337 <computeroutput>guestcontrol list <all|sessions|processes|files></computeroutput> 6338 </para> 6339 </listitem> 6340 6341 <listitem> 6342 <para>VBoxManage: added support for closing active guest sessions via 6343 <computeroutput>guestcontrol session close --session-id <ID>| 6344 --session-name <name or pattern>|--all</computeroutput> 6345 </para> 6346 </listitem> 6347 6348 <listitem> 6349 <para>VBoxManage: added support for terminating active guest processes via 6350 <computeroutput>guestcontrol process kill|close|terminate --session-id <ID>| 6351 --session-name <name or pattern> <PID> ... <PID n></computeroutput> 6352 or 6353 <computeroutput>guestcontrol [p[s]]kill --session-id <ID>| 6354 --session-name <name or pattern> <PID> ... <PID n></computeroutput> 6355 </para> 6356 </listitem> 6357 6358 <listitem> 6359 <para>VBoxManage: added support for watching guest sessions via 6360 <computeroutput>guestcontrol watch</computeroutput> 6361 </para> 6362 </listitem> 6363 6364 <listitem> 6365 <para>VBoxManage: added <computeroutput>modifyvm --triplefaultreset</computeroutput> 6366 to make the VM reset on triple fault instead of triggering a Guru Meditation 6367 (see <xref linkend="vboxmanage-modifyvm"/>)</para> 6368 </listitem> 6369 6370 <listitem> 6371 <para>3D support: several fixes</para> 6372 </listitem> 6373 6374 <listitem> 6375 <para>3D support: several fixes for Mac OS X hosts</para> 6376 </listitem> 6377 6378 <listitem> 6379 <para>OVF: several fixes</para> 6380 </listitem> 6381 6382 <listitem> 6383 <para>Extpack Installer: make it work if the file is located in a folder with 6384 special characters</para> 6385 </listitem> 6386 6387 <listitem> 6388 <para>Keyboard: fix for reporting key sequences like Ctrl+Alt+Del 6389 for the USB keyboard emulation</para> 6390 </listitem> 6391 6392 <listitem> 6393 <para>Shared Clipboard/X11: support for BMP-format images, contributed 6394 by François Revol</para> 6395 </listitem> 6396 6397 <listitem> 6398 <para>Mac OS X hosts: limited support for Mac OS X 10.9 (Mavericks)</para> 6399 </listitem> 6400 6401 <listitem> 6402 <para>Mac OS X hosts: use a launchd script instead of the deprecated 6403 StartupItem mechanism (bug #8940)</para> 6404 </listitem> 6405 6406 <listitem> 6407 <para>Windows hosts: don't cause massive DPC latency (only on certain 6408 hosts; still needs improving; bug #6242)</para> 6409 </listitem> 6410 6411 <listitem> 6412 <para>Windows hosts: consider symlinks when retrieving volume information 6413 (bug #11962)</para> 6414 </listitem> 6415 6416 <listitem> 6417 <para>Windows hosts: fixed an issue with USB2 devices being inaccessible 6418 when plugged into USB 3.0 ports</para> 6419 </listitem> 6420 6421 <listitem> 6422 <para>Windows Additions: fixed misbehavior with guest display 6423 power management (WDDM driver only; bug #11170)</para> 6424 </listitem> 6425 6426 <listitem> 6427 <para>Windows Additions: fixed memory leak caused by WTSQuerySessionInformation() 6428 on Windows 2000 guests (bug #12072)</para> 6429 </listitem> 6430 6431 <listitem> 6432 <para>Windows Additions: ability to track guest user idle times through 6433 the newly introduced event <emphasis>IGuestUserStateChangedEvent</emphasis></para> 6434 </listitem> 6435 6436 <listitem> 6437 <para>Linux Additions: fixed udev detection in the init script 6438 with Linux 3.x kernels</para> 6439 </listitem> 6440 6441 </itemizedlist> 6442 262 263 </itemizedlist> 6443 264 </sect1> 6444 265
Note:
See TracChangeset
for help on using the changeset viewer.