Changeset 82350 in vbox
- Timestamp:
- Dec 3, 2019 6:44:23 PM (5 years ago)
- Location:
- trunk/doc/manual
- Files:
-
- 3 added
- 23 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/doc/manual/Config.kmk
r82058 r82350 297 297 '<!ENTITY VBOX_PRODUCT '\''<trademark class="registered">Oracle</trademark> VM <trademark class="registered">VirtualBox</trademark>'\'' >' \ 298 298 '' \ 299 '<!-- Entities for O TN-->' \300 '<!ENTITY o tn-base-url "https://www.oracle.com/technetwork">' \301 '<!ENTITY o tn-doc-tab "&otn-base-url;/server-storage/virtualbox/documentation/index.html">'299 '<!-- Entities for Oracle Help Center -->' \ 300 '<!ENTITY ohc-base-url "https://docs.oracle.com/en">' \ 301 '<!ENTITY ohc-doc-page "&ohc-base-url;/virtualization/virtualbox/index.html">' 302 302 303 303 endif # VBOX_XML_ENTITIES -
trunk/doc/manual/en_US/UserManual.xml
r76786 r82350 9 9 <!-- VBox bookinfo section --> 10 10 11 <bookinfo>11 <bookinfo> 12 12 13 <title>&VBOX_PRODUCT;</title>13 <title>&VBOX_PRODUCT;</title> 14 14 15 15 <subtitle>User Manual</subtitle> -
trunk/doc/manual/en_US/user_AdvancedTopics.xml
r81589 r82350 30 30 31 31 <para> 32 Since Windows NT, Windows has provided a modular system login 33 subsystem, called Winlogon, which can be customized and extended 34 by means of so-called GINA (Graphical Identification and 35 Authentication) modules. With Windows Vista and Windows 7, the 36 GINA modules were replaced with a new mechanism called 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. 32 Windows provides a modular system login subsystem, called 33 Winlogon, which can be customized and extended by means of 34 so-called GINA (Graphical Identification and Authentication) 35 modules. In Windows Vista and later releases, the GINA modules 36 were replaced with a new mechanism called credential providers. 37 The &product-name; Guest Additions for Windows come with both, a 38 GINA and a credential provider module, and therefore enable any 39 Windows guest to perform automated logins. 41 40 </para> 42 41 … … 44 43 To activate the &product-name; GINA or credential provider 45 44 module, install the Guest Additions using the command line 46 switch < computeroutput>/with_autologon</computeroutput>. All the47 following manual steps required for installing these modules48 will be thendone by the installer.45 switch <option>/with_autologon</option>. All the following 46 manual steps required for installing these modules will be then 47 done by the installer. 49 48 </para> 50 49 … … 52 51 To manually install the &product-name; GINA module, extract the 53 52 Guest Additions as shown in 54 <xref linkend="windows-guest-file-extraction" /> and copy the55 file <computeroutput>VBoxGINA.dll</computeroutput> to the56 Windows <computeroutput>SYSTEM32</computeroutput> directory.57 Then, in the registry, createthe following key with a value of58 < computeroutput>VBoxGINA.dll</computeroutput>:53 <xref linkend="windows-guest-file-extraction" />, and copy the 54 <filename>VBoxGINA.dll</filename> file to the Windows 55 <filename>SYSTEM32</filename> directory. In the registry, create 56 the following key with a value of 57 <filename>VBoxGINA.dll</filename>: 59 58 </para> 60 59 … … 64 63 <para> 65 64 The &product-name; GINA module is implemented as a wrapper 66 around the standard Windows GINA module,67 <computeroutput>MSGINA.DLL</computeroutput>. As a result, it68 may not work correctly with thirdparty GINA modules.65 around the <filename>MSGINA.DLL</filename> standard Windows 66 GINA module. As a result, it might not work correctly with 67 third-party GINA modules. 69 68 </para> 70 69 </note> … … 73 72 To manually install the &product-name; credential provider 74 73 module, extract the Guest Additions as shown in 75 <xref 76 linkend="windows-guest-file-extraction" /> and copy 77 the file <computeroutput>VBoxCredProv.dll</computeroutput> to 78 the Windows <computeroutput>SYSTEM32</computeroutput> directory. 79 In the registry, create the following keys: 74 <xref linkend="windows-guest-file-extraction" /> and copy the 75 <filename>VBoxCredProv.dll</filename> file to the Windows 76 <filename>SYSTEM32</filename> directory. In the registry, create 77 the following keys: 80 78 </para> 81 79 … … 88 86 89 87 <para> 90 All default values, the key named 91 <computeroutput>Default</computeroutput>, must be set to 92 <computeroutput>VBoxCredProv</computeroutput>. 93 </para> 94 95 <para> 96 Create a new string named as follows, with a value of 97 <computeroutput>Apartment</computeroutput>. 88 All default values, the key named <literal>Default</literal>, 89 must be set to <literal>VBoxCredProv</literal>. 90 </para> 91 92 <para> 93 Create the following string and assign it a value of 94 <literal>Apartment</literal>. 98 95 </para> 99 96 … … 105 102 </para> 106 103 107 <screen> VBoxManage controlvm "Windows XP" setcredentials "John Doe" "secretpassword" "DOMTEST"</screen>104 <screen>$ VBoxManage controlvm "Windows XP" setcredentials "John Doe" "secretpassword" "DOMTEST"</screen> 108 105 109 106 <para> … … 127 124 128 125 <para> 129 Depending on the particular variant of the Windows guest, the130 followingrestrictions apply:126 Depending on the Windows guest version, the following 127 restrictions apply: 131 128 </para> 132 129 … … 138 135 login subsystem needs to be configured to use the classic 139 136 login dialog, as the &product-name; GINA module does not 140 support the XP-style welcome dialog.137 support the Windows XP-style welcome dialog. 141 138 </para> 142 139 </listitem> … … 147 144 and Windows 10 guests.</emphasis> The login subsystem does 148 145 not support the so-called Secure Attention Sequence, 149 < computeroutput>Ctrl+Alt+Del</computeroutput>. As a result,150 the guest's group policy settings need to be changed to not151 use the Secure Attention Sequence. Also, the user name given152 is only compared to the true user name, not the user153 friendly name. This means that when you rename a user, you154 s till have to supply the original user name as Windows never155 renames useraccounts internally.146 <literal>Ctrl+Alt+Del</literal>. As a result, the guest's 147 group policy settings need to be changed to not use the 148 Secure Attention Sequence. Also, the user name given is only 149 compared to the true user name, not the user friendly name. 150 This means that when you rename a user, you still have to 151 supply the original user name as Windows never renames user 152 accounts internally. 156 153 </para> 157 154 </listitem> … … 163 160 Service</emphasis>, formerly known as Terminal Services, is 164 161 disabled by default. To enable it, create the following 165 registry key with a < computeroutput>DWORD</computeroutput>166 value of <computeroutput>1</computeroutput>.162 registry key with a <literal>DWORD</literal> value of 163 <literal>1</literal>. 167 164 </para> 168 165 … … 177 174 </para> 178 175 179 <screen> VBoxManage setextradata "Windows XP" VBoxInternal/Devices/VMMDev/0/Config/KeepCredentials 1</screen>176 <screen>$ VBoxManage setextradata "Windows XP" VBoxInternal/Devices/VMMDev/0/Config/KeepCredentials 1</screen> 180 177 181 178 <para> … … 205 202 206 203 <para> 207 The < computeroutput>pam_vbox.so</computeroutput> module itself204 The <filename>pam_vbox.so</filename> module itself 208 205 <emphasis>does not</emphasis> do an actual verification of the 209 206 credentials passed to the guest OS. Instead it relies on other 210 modules such as < computeroutput>pam_unix.so</computeroutput> or211 < computeroutput>pam_unix2.so</computeroutput> down in the PAM212 stack to do the actual validation using the credentials213 retrieved by <computeroutput>pam_vbox.so</computeroutput>.214 Therefore <computeroutput>pam_vbox.so</computeroutput> has to be215 on top of theauthentication PAM service list.207 modules such as <filename>pam_unix.so</filename> or 208 <filename>pam_unix2.so</filename> down in the PAM stack to do 209 the actual validation using the credentials retrieved by 210 <filename>pam_vbox.so</filename>. Therefore 211 <filename>pam_vbox.so</filename> has to be on top of the 212 authentication PAM service list. 216 213 </para> 217 214 218 215 <note> 219 216 <para> 220 The <computeroutput>pam_vbox.so</computeroutput> module only 221 supports the <computeroutput>auth</computeroutput> primitive. 222 Other primitives such as 223 <computeroutput>account</computeroutput>, 224 <computeroutput>session</computeroutput>, or 225 <computeroutput>password</computeroutput> are not supported. 217 The <filename>pam_vbox.so</filename> module only supports the 218 <literal>auth</literal> primitive. Other primitives such as 219 <literal>account</literal>, <literal>session</literal>, or 220 <literal>password</literal> are not supported. 226 221 </para> 227 222 </note> 228 223 229 224 <para> 230 The < computeroutput>pam_vbox.so</computeroutput> module is231 shipped as part of the Guest Additions but it is not installed232 and/or activated on the guest OS by default. In order to install233 it, it has to becopied from234 < computeroutput>/opt/VBoxGuestAdditions-<version>/other/</computeroutput>225 The <filename>pam_vbox.so</filename> module is shipped as part 226 of the Guest Additions but it is not installed and/or activated 227 on the guest OS by default. In order to install it, it has to be 228 copied from 229 <filename>/opt/VBoxGuestAdditions-<replaceable>version</replaceable>/other/</filename> 235 230 to the security modules directory. This is usually 236 < computeroutput>/lib/security/</computeroutput> on 32-bit Linux237 guests or <computeroutput>/lib64/security/</computeroutput> on238 64-bit Linux guests. Please refer to your guest OS documentation239 for the correct PAMmodule directory.240 </para> 241 242 <para> 243 For example, to use < computeroutput>pam_vbox.so</computeroutput>244 with a Ubuntu Linux guest OS and the GNOME Desktop Manager (GDM)245 to log in users automatically with the credentials passed by the246 host,configure the guest OS as follows:231 <filename>/lib/security/</filename> on 32-bit Linux guests or 232 <filename>/lib64/security/</filename> on 64-bit Linux guests. 233 Please refer to your guest OS documentation for the correct PAM 234 module directory. 235 </para> 236 237 <para> 238 For example, to use <filename>pam_vbox.so</filename> with a 239 Ubuntu Linux guest OS and the GNOME Desktop Manager (GDM) to log 240 in users automatically with the credentials passed by the host, 241 configure the guest OS as follows: 247 242 </para> 248 243 … … 251 246 <listitem> 252 247 <para> 253 Copy the < computeroutput>pam_vbox.so</computeroutput> module254 to thesecurity modules directory. In this case,255 < computeroutput>/lib/security</computeroutput>.248 Copy the <filename>pam_vbox.so</filename> module to the 249 security modules directory. In this case, 250 <filename>/lib/security</filename>. 256 251 </para> 257 252 </listitem> … … 260 255 <para> 261 256 Edit the PAM configuration file for GDM, found at 262 <computeroutput>/etc/pam.d/gdm</computeroutput>. Add the 263 line <computeroutput>auth requisite 264 pam_vbox.so</computeroutput> at the top. Additionally, in 265 most Linux distributions there is a file called 266 <computeroutput>/etc/pam.d/common-auth</computeroutput>. 267 This file is included in many other services, like the GDM 268 file mentioned above. There you also have to add the line 269 <computeroutput>auth requisite pam_vbox.so</computeroutput>. 257 <filename>/etc/pam.d/gdm</filename>. Add the line 258 <literal>auth requisite pam_vbox.so</literal> at the top. 259 Additionally, in most Linux distributions there is a file 260 called <filename>/etc/pam.d/common-auth</filename>. This 261 file is included in many other services, like the GDM file 262 mentioned above. There you also have to add the line 263 <literal>auth requisite pam_vbox.so</literal>. 270 264 </para> 271 265 </listitem> … … 274 268 <para> 275 269 If authentication against the shadow database using 276 <computeroutput>pam_unix.so</computeroutput> or 277 <computeroutput>pam_unix2.so</computeroutput> is desired, 278 the argument <computeroutput>try_first_pass</computeroutput> 279 for <computeroutput>pam_unix.so</computeroutput> or 280 <computeroutput>use_first_pass</computeroutput> for 281 <computeroutput>pam_unix2.so</computeroutput> is needed in 282 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 285 <computeroutput>/etc/pam.d/common-auth</computeroutput>, to 286 the end of the line referencing 287 <computeroutput>pam_unix.so</computeroutput>. This argument 288 tells the PAM module to use credentials already present in 289 the stack, such as the ones provided by the &product-name; 290 PAM module. 270 <filename>pam_unix.so</filename> or 271 <filename>pam_unix2.so</filename> is desired, the argument 272 <literal>try_first_pass</literal> for 273 <filename>pam_unix.so</filename> or 274 <literal>use_first_pass</literal> for 275 <filename>pam_unix2.so</filename> is needed in order to pass 276 the credentials from the &product-name; module to the shadow 277 database authentication module. For Ubuntu, this needs to be 278 added to <filename>/etc/pam.d/common-auth</filename>, to the 279 end of the line referencing 280 <filename>pam_unix.so</filename>. This argument tells the 281 PAM module to use credentials already present in the stack, 282 such as the ones provided by the &product-name; PAM module. 291 283 </para> 292 284 </listitem> … … 303 295 <para> 304 296 To make deployment easier, you can pass the argument 305 < computeroutput>debug</computeroutput> right after the306 < computeroutput>pam_vbox.so</computeroutput> statement. Debug307 log outputwill then be recorded using syslog.297 <literal>debug</literal> right after the 298 <filename>pam_vbox.so</filename> statement. Debug log output 299 will then be recorded using syslog. 308 300 </para> 309 301 310 302 <note> 311 303 <para> 312 By default, <com puteroutput>pam_vbox</computeroutput> will not313 wait for credentials to arrive from the host. When a login314 prompt is shown, for example by GDM/KDM or the text console,315 and pam_vbox does not yet have credentials it does not wait316 until they arrive. Instead the next module in the PAM stack,317 depending on the PAM configuration, will have the chance for318 authentication.304 By default, <command>pam_vbox</command> does not wait for 305 credentials to arrive from the host. When a login prompt is 306 shown, for example by GDM/KDM or the text console, and 307 <command>pam_vbox</command> does not yet have credentials it 308 does not wait until they arrive. Instead the next module in 309 the PAM stack, depending on the PAM configuration, will have 310 the chance for authentication. 319 311 </para> 320 312 </note> 321 313 322 314 <para> 323 <com puteroutput>pam_vbox</computeroutput> supports various guest324 p roperty parameters that are located in325 < computeroutput>/VirtualBox/GuestAdd/PAM/</computeroutput>.326 These parameters allow pam_vboxto wait for credentials to be315 <command>pam_vbox</command> supports various guest property 316 parameters that are located in 317 <filename>/VirtualBox/GuestAdd/PAM/</filename>. These parameters 318 allow <command>pam_vbox</command> to wait for credentials to be 327 319 provided by the host and optionally can show a message while 328 320 waiting for those. The following guest properties can be set: … … 333 325 <listitem> 334 326 <para> 335 <computeroutput>CredsWait</computeroutput>: Set to 1 if 336 pam_vbox should start waiting until credentials arrive from 337 the host. Until then no other authentication methods such as 338 manually logging in will be available. If this property is 339 empty or gets deleted no waiting for credentials will be 340 performed and pam_vbox will act like before. This property 341 must be set read-only for the guest 342 (<computeroutput>RDONLYGUEST</computeroutput>). 327 <literal>CredsWait</literal>: Set to 1 if 328 <command>pam_vbox</command> should start waiting until 329 credentials arrive from the host. Until then no other 330 authentication methods such as manually logging in will be 331 available. If this property is empty or gets deleted no 332 waiting for credentials will be performed and 333 <command>pam_vbox</command> will act like before. This 334 property must be set read-only for the guest 335 (<literal>RDONLYGUEST</literal>). 343 336 </para> 344 337 </listitem> … … 346 339 <listitem> 347 340 <para> 348 < computeroutput>CredsWaitAbort</computeroutput>: Aborts349 waiting for credentials when set to any value. Can be set350 from host andthe guest.341 <literal>CredsWaitAbort</literal>: Aborts waiting for 342 credentials when set to any value. Can be set from host and 343 the guest. 351 344 </para> 352 345 </listitem> … … 354 347 <listitem> 355 348 <para> 356 < computeroutput>CredsWaitTimeout</computeroutput>: Timeout,357 in seconds, to let pam_vbox wait for credentials to arrive.358 When no credentials arrive within this timeout,359 authentication of pam_vbox will be set to failed and the360 next PAM module in chain will be asked. If this property is361 not specified, set to 0 or an invalid value, an infinite362 timeout will be used. This property must be set read-only363 for the guest364 (< computeroutput>RDONLYGUEST</computeroutput>).349 <literal>CredsWaitTimeout</literal>: Timeout, in seconds, to 350 let <command>pam_vbox</command> wait for credentials to 351 arrive. When no credentials arrive within this timeout, 352 authentication of <command>pam_vbox</command> will be set to 353 failed and the next PAM module in chain will be asked. If 354 this property is not specified, set to 0 or an invalid 355 value, an infinite timeout will be used. This property must 356 be set read-only for the guest 357 (<literal>RDONLYGUEST</literal>). 365 358 </para> 366 359 </listitem> … … 369 362 370 363 <para> 371 To customize pam_vbox further there are the following guest372 properties:364 To customize <command>pam_vbox</command> further there are the 365 following guest properties: 373 366 </para> 374 367 … … 377 370 <listitem> 378 371 <para> 379 < computeroutput>CredsMsgWaiting</computeroutput>: Custom380 message showed while pam_vbox is waiting for credentials381 from the host. This property must be set read-only for the382 guest (<computeroutput>RDONLYGUEST</computeroutput>).372 <literal>CredsMsgWaiting</literal>: Custom message showed 373 while pam_vbox is waiting for credentials from the host. 374 This property must be set read-only for the guest 375 (<literal>RDONLYGUEST</literal>). 383 376 </para> 384 377 </listitem> … … 386 379 <listitem> 387 380 <para> 388 < computeroutput>CredsMsgWaitTimeout</computeroutput>: Custom389 message showed when waiting for credentials by pam_vbox has390 timed out. For example, they did not arrive within time.391 This property must be set read-only for the guest392 (<computeroutput>RDONLYGUEST</computeroutput>).381 <literal>CredsMsgWaitTimeout</literal>: Custom message 382 showed when waiting for credentials by 383 <command>pam_vbox</command> has timed out. For example, they 384 did not arrive within time. This property must be set 385 read-only for the guest (<literal>RDONLYGUEST</literal>). 393 386 </para> 394 387 </listitem> … … 398 391 <note> 399 392 <para> 400 If a pam_vbox guest property does not have the correct flag401 set (<computeroutput>RDONLYGUEST</computeroutput>) the393 If a <command>pam_vbox</command> guest property does not have 394 the correct flag set (<literal>RDONLYGUEST</literal>) the 402 395 property is ignored and, depending on the property, a default 403 396 value will be used. This can result in pam_vbox not waiting 404 397 for credentials. Consult the appropriate syslog file for more 405 information and use the <computeroutput>debug</computeroutput> 406 option. 398 information and use the <literal>debug</literal> option. 407 399 </para> 408 400 </note> … … 413 405 414 406 <para> 415 &product-name; comes with a n owngreeter module, named416 vbox-greeter. The module can be used with LightDM 1.0.1 or417 later. LightDM is the default display manager sinceUbuntu418 10.11 and therefore also canbe used for automated guest407 &product-name; comes with a greeter module, named 408 <command>vbox-greeter</command>, that can be used with 409 LightDM. LightDM is the default display manager for Ubuntu 410 Linux and therefore can also be used for automated guest 419 411 logins. 420 412 </para> 421 413 422 414 <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 437 <computeroutput>--with-autologon</computeroutput> switch when 438 starting the VBoxLinuxAdditions.run file: 415 <command>vbox-greeter</command> does not need the 416 <command>pam_vbox</command> module described in 417 <xref linkend="autologon_unix"/>in order to function. It comes 418 with its own authentication mechanism provided by LightDM. 419 However, to provide maximum flexibility both modules can be 420 used together on the same guest. 421 </para> 422 423 <para> 424 As with the <command>pam_vbox</command> module, 425 <command>vbox-greeter</command> is shipped as part of the 426 Guest Additions but it is not installed or activated on the 427 guest OS by default. To install 428 <command>vbox-greeter</command> automatically upon Guest 429 Additions installation, use the 430 <option>--with-autologon</option> option when starting the 431 <command>VBoxLinuxAdditions.run</command> file: 439 432 </para> 440 433 … … 442 435 443 436 <para> 444 For manual or postponed installation, the 445 <computeroutput>vbox-greeter.desktop</computeroutput> file has 446 to be copied from 447 <computeroutput>/opt/VBoxGuestAdditions-<version>/other/</computeroutput> 448 to the <computeroutput>xgreeters</computeroutput> directory 449 This is usually 450 <computeroutput>/usr/share/xgreeters/</computeroutput>. Please 451 refer to your guest OS documentation for the correct LightDM 437 For manual or postponed installation, copy the 438 <filename>vbox-greeter.desktop</filename> file from 439 <filename>/opt/VBoxGuestAdditions-<version>/other/</filename> 440 to the <filename>xgreeters</filename> directory, which is 441 usually <filename>/usr/share/xgreeters/</filename>. See your 442 guest OS documentation for the name of the correct LightDM 452 443 greeter directory. 453 444 </para> 454 445 455 446 <para> 456 The vbox-greeter module itself already was installed by the457 &product-name; Guest Additions installer and residesin458 < computeroutput>/usr/sbin/</computeroutput>. To enable459 vbox-greeter as the standard greeter module, the file460 <computeroutput>/etc/lightdm/lightdm.conf</computeroutput>461 needs to be edited:447 The <command>vbox-greeter</command> module is installed by the 448 &product-name; Guest Additions installer and is located in 449 <filename>/usr/sbin/</filename>. To enable 450 <command>vbox-greeter</command> as the standard greeter 451 module, edit the file 452 <filename>/etc/lightdm/lightdm.conf</filename> as follows: 462 453 </para> 463 454 … … 470 461 <listitem> 471 462 <para> 472 The LightDM server needs to be fully restarted in order473 for vbox-greeter to be used as the default greeter. As474 root, run <computeroutput>service lightdm475 --full-restart</computeroutput> on Ubuntu, or simply463 The LightDM server must be fully restarted in order for 464 <command>vbox-greeter</command> to be used as the 465 default greeter. As <literal>root</literal> on Ubuntu, 466 run <command>service lightdm --full-restart</command> or 476 467 restart the guest. 477 468 </para> … … 480 471 <listitem> 481 472 <para> 482 vbox-greeter is independent of the graphical session 483 chosen by the user, such as Gnome, KDE, or Unity. 484 However, it requires FLTK 1.3 for representing its own 485 user interface. 473 <command>vbox-greeter</command> is independent of the 474 graphical session you choose, such as Gnome, KDE, or 475 Unity. However, <command>vbox-greeter</command> does 476 require FLTK 1.3 or later to implement its own user 477 interface. 486 478 </para> 487 479 </listitem> … … 494 486 further customize the login experience. For automatically 495 487 logging in users, the same guest properties apply as for 496 pam_vbox. See <xref linkend="autologon_unix" />. 497 </para> 498 499 <para> 500 In addition to the above mentioned guest properties, 501 vbox-greeter allows further customization of its user 502 interface. These special guest properties all reside in 503 <computeroutput>/VirtualBox/GuestAdd/Greeter/</computeroutput>: 488 <command>pam_vbox</command>. See 489 <xref linkend="autologon_unix" />. 490 </para> 491 492 <para> 493 In addition to the previously mentioned guest properties, 494 <command>vbox-greeter</command> enables you to further 495 customize its user interface. The following guest properties 496 are located in the 497 <filename>/VirtualBox/GuestAdd/Greeter/</filename> directory: 504 498 </para> 505 499 … … 508 502 <listitem> 509 503 <para> 510 <computeroutput>HideRestart</computeroutput>: Set to 1 if 511 vbox-greeter should hide the button to restart the guest. 512 This property must be set read-only for the guest 513 (<computeroutput>RDONLYGUEST</computeroutput>). 514 </para> 515 </listitem> 516 517 <listitem> 518 <para> 519 <computeroutput>HideShutdown</computeroutput>: Set to 1 if 520 vbox-greeter should hide the button to shutdown the guest. 521 This property must be set read-only for the guest 522 (<computeroutput>RDONLYGUEST</computeroutput>). 523 </para> 524 </listitem> 525 526 <listitem> 527 <para> 528 <computeroutput>BannerPath</computeroutput>: Path to a 529 .PNG file for using it as a banner on the top. The image 530 size must be 460 x 90 pixels, any bit depth. This property 531 must be set read-only for the guest 532 (<computeroutput>RDONLYGUEST</computeroutput>). 533 </para> 534 </listitem> 535 536 <listitem> 537 <para> 538 <computeroutput>UseTheming</computeroutput>: Set to 1 for 539 turning on the following theming options. This property 540 must be set read-only for the guest 541 (<computeroutput>RDONLYGUEST</computeroutput>). 542 </para> 543 </listitem> 544 545 <listitem> 546 <para> 547 <computeroutput>Theme/BackgroundColor</computeroutput>: 548 Hexadecimal RRGGBB color for the background. This property 549 must be set read-only for the guest 550 (<computeroutput>RDONLYGUEST</computeroutput>). 551 </para> 552 </listitem> 553 554 <listitem> 555 <para> 556 <computeroutput>Theme/LogonDialog/HeaderColor</computeroutput>: 504 <literal>HideRestart</literal>: Set to 1 if 505 <command>vbox-greeter</command> should hide the button to 506 restart the guest. This property must be set read-only for 507 the guest (<literal>RDONLYGUEST</literal>). 508 </para> 509 </listitem> 510 511 <listitem> 512 <para> 513 <literal>HideShutdown</literal>: Set to 1 if 514 <command>vbox-greeter</command> should hide the button to 515 shutdown the guest. This property must be set read-only 516 for the guest (<literal>RDONLYGUEST</literal>). 517 </para> 518 </listitem> 519 520 <listitem> 521 <para> 522 <literal>BannerPath</literal>: Path to a 523 <filename>.PNG</filename> file to use as a banner image on 524 the top of the greeter. The image size must be 460 x 90 525 pixels, any bit depth. This property must be set read-only 526 for the guest (<literal>RDONLYGUEST</literal>). 527 </para> 528 </listitem> 529 530 <listitem> 531 <para> 532 <literal>UseTheming</literal>: Set to 1 for turning on the 533 following theming options. This property must be set 534 read-only for the guest (<literal>RDONLYGUEST</literal>). 535 </para> 536 </listitem> 537 538 <listitem> 539 <para> 540 <literal>Theme/BackgroundColor</literal>: Hexadecimal 541 RRGGBB color for the background. This property must be set 542 read-only for the guest (<literal>RDONLYGUEST</literal>). 543 </para> 544 </listitem> 545 546 <listitem> 547 <para> 548 <literal>Theme/LogonDialog/HeaderColor</literal>: 557 549 Hexadecimal RRGGBB foreground color for the header text. 558 550 This property must be set read-only for the guest 559 (< computeroutput>RDONLYGUEST</computeroutput>).560 </para> 561 </listitem> 562 563 <listitem> 564 <para> 565 < computeroutput>Theme/LogonDialog/BackgroundColor</computeroutput>:551 (<literal>RDONLYGUEST</literal>). 552 </para> 553 </listitem> 554 555 <listitem> 556 <para> 557 <literal>Theme/LogonDialog/BackgroundColor</literal>: 566 558 Hexadecimal RRGGBB color for the login dialog background. 567 559 This property must be set read-only for the guest 568 (< computeroutput>RDONLYGUEST</computeroutput>).569 </para> 570 </listitem> 571 572 <listitem> 573 <para> 574 < computeroutput>Theme/LogonDialog/ButtonColor</computeroutput>:560 (<literal>RDONLYGUEST</literal>). 561 </para> 562 </listitem> 563 564 <listitem> 565 <para> 566 <literal>Theme/LogonDialog/ButtonColor</literal>: 575 567 Hexadecimal RRGGBB background color for the login dialog 576 568 button. This property must be set read-only for the guest 577 (< computeroutput>RDONLYGUEST</computeroutput>).569 (<literal>RDONLYGUEST</literal>). 578 570 </para> 579 571 </listitem> … … 584 576 <para> 585 577 The same restrictions for the guest properties above apply 586 as for the ones specified in the pam_vbox section. 578 as for the ones specified in the <literal>pam_vbox</literal> 579 section. 587 580 </para> 588 581 </note> … … 603 596 604 597 <para> 605 Beginning with Windows NT 4.0, Microsoft offers a system606 prepar ation tool called Sysprep, to prepare a Windows system for607 deployment or redistribution. Whereas Windows 2000 and XP ship608 with Sysprep on the installation medium, the tool also is609 available for download on the Microsoft web site. In a standard610 in stallation of Windows Vista and 7, Sysprep is already611 included. Sysprep mainly consists of an executable called612 <computeroutput>sysprep.exe</computeroutput> which is invoked by613 the user to put the Windows installation intopreparation mode.598 Microsoft offers a system preparation tool called Sysprep, to 599 prepare a Windows system for deployment or redistribution. Some 600 Windows releases include Sysprep on the installation medium, but 601 the tool is also available for download from the Microsoft web 602 site. In a standard For most Windows versions, Sysprep is 603 included in a default installation. Sysprep mainly consists of 604 an executable called <command>sysprep.exe</command> which is 605 invoked by the user to put the Windows installation into 606 preparation mode. 614 607 </para> 615 608 … … 620 613 <xref linkend="guestadd-guestcontrol" /> for details of how to 621 614 use this feature with the special identifier 622 <computeroutput>sysprep</computeroutput> as the program to 623 execute, along with the user name 624 <computeroutput>sysprep</computeroutput> and password 625 <computeroutput>sysprep</computeroutput> for the credentials. 626 Sysprep then gets launched with the required system rights. 615 <literal>sysprep</literal> as the program to execute, along with 616 the user name <literal>sysprep</literal> and password 617 <literal>sysprep</literal> for the credentials. Sysprep is then 618 started with the required system rights. 627 619 </para> 628 620 629 621 <note> 630 622 <para> 631 Specifying the location of "sysprep.exe" is 632 <emphasis 633 role="bold">not possible</emphasis>. Instead 634 the following paths are used, based on the operating system: 623 Specifying the location of <command>sysprep.exe</command> is 624 <emphasis role="bold">not possible</emphasis>. Instead the 625 following paths are used, based on the Windows release: 635 626 </para> 636 627 … … 639 630 <listitem> 640 631 <para> 641 < computeroutput>C:\sysprep\sysprep.exe</computeroutput>642 for Windows NT 4.0, 2000 and XP643 </para> 644 </listitem> 645 646 <listitem> 647 <para> 648 < computeroutput>%WINDIR%\System32\Sysprep\sysprep.exe</computeroutput>649 for Windows Vista , 2008 Server and 7632 <filename>C:\sysprep\sysprep.exe</filename> for Windows XP 633 and earlier 634 </para> 635 </listitem> 636 637 <listitem> 638 <para> 639 <filename>%WINDIR%\System32\sysprep\sysprep.exe</filename> 640 for Windows Vista and later 650 641 </para> 651 642 </listitem> … … 673 664 <para> 674 665 The &product-name; Guest Additions contain several different 675 drivers. If for any reason you do not wish to set them all up, 676 you can install the Guest Additions using the following command: 677 </para> 678 679 <screen> sh ./VBoxLinuxAdditions.run no_setup</screen> 680 681 <para> 682 After this, you will need to at least compile the kernel modules 683 by running the command as root: 684 </para> 685 686 <screen> rcvboxadd setup</screen> 687 688 <para> 689 You will need to replace <emphasis>lib</emphasis> by 690 <emphasis>lib64</emphasis> on some 64bit guests, and on older 691 guests without the udev service you will need to add the 692 <emphasis>vboxadd</emphasis> service to the default runlevel to 693 ensure that the modules get loaded. 694 </para> 695 696 <para> 697 To setup the time synchronization service, add the service 698 vboxadd-service to the default runlevel. To set up the X11 and 699 OpenGL part of the Guest Additions, run the following command: 700 </para> 701 702 <screen> rcvboxadd-x11 setup</screen> 703 704 <para> 705 You do not need to enable any services for this. 706 </para> 707 708 <para> 709 To recompile the guest kernel modules, use this command: 710 </para> 711 712 <screen> rcvboxadd setup</screen> 713 714 <para> 715 After compilation you should reboot your guest to ensure that 716 the new modules are actually used. 666 drivers. If you do not want to configure them all, use the 667 following command to install the Guest Additions: 668 </para> 669 670 <screen>$ sh ./VBoxLinuxAdditions.run no_setup</screen> 671 672 <para> 673 After running this script, run the <command>rcvboxadd 674 setup</command> command as <literal>root</literal> to compile 675 the kernel modules. 676 </para> 677 678 <para> 679 On some 64-bit guests, you must replace <filename>lib</filename> 680 with <filename>lib64</filename>. On older guests that do not run 681 the <command>udev</command> service, you must add the 682 <command>vboxadd</command> service to the default runlevel to 683 ensure that the modules are loaded. 684 </para> 685 686 <para> 687 To set up the time synchronization service, add the 688 <command>vboxadd-service</command> service to the default 689 runlevel. To set up the X11 and OpenGL part of the Guest 690 Additions, run the <command>rcvboxadd-x11 setup</command> 691 command. Note that you do not need to enable additional 692 services. 693 </para> 694 695 <para> 696 Use the <command>rcvboxadd setup</command> to recompile the 697 guest kernel modules. 698 </para> 699 700 <para> 701 After compilation, reboot your guest to ensure that the new 702 modules are loaded. 717 703 </para> 718 704 … … 731 717 732 718 <para> 733 The &product-name; Guest Additions include the following drivers 734 for X.Org versions: 735 </para> 736 737 <itemizedlist> 738 739 <listitem> 740 <para> 741 X11R6.8/X11R6.9 and XFree86 version 4.3 (vboxvideo_drv_68.o 742 and vboxmouse_drv_68.o) 743 </para> 744 </listitem> 745 746 <listitem> 747 <para> 748 X11R7.0 (vboxvideo_drv_70.so and vboxmouse_drv_70.so) 749 </para> 750 </listitem> 751 752 <listitem> 753 <para> 754 X11R7.1 (vboxvideo_drv_71.so and vboxmouse_drv_71.so) 755 </para> 756 </listitem> 757 758 <listitem> 759 <para> 760 X.Org Server versions 1.3 and later (vboxvideo_drv_13.so 761 vboxmouse_drv_13.so, and later versions). 762 </para> 763 </listitem> 764 765 </itemizedlist> 766 767 <para> 768 By default these drivers can be found in the folowing directory: 769 </para> 770 771 <para> 772 <computeroutput>/opt/VBoxGuestAdditions-<version>/other/</computeroutput> 719 The &product-name; Guest Additions includes drivers for X.Org. 720 By default these drivers are in the following directory: 721 </para> 722 723 <para> 724 <filename>/opt/VBoxGuestAdditions-<replaceable>version</replaceable>/other/</filename> 773 725 </para> 774 726 … … 780 732 <para> 781 733 For graphics integration to work correctly, the X server must 782 load the vboxvideo driver. Many recent X server versions look 783 for it automatically if they see that they are running in 784 &product-name;. For an optimal user experience the guest kernel 785 drivers must be loaded and the Guest Additions tool VBoxClient 786 must be running as a client in the X session. For mouse 787 integration to work correctly, the guest kernel drivers must be 788 loaded and in addition, in X servers from X.Org X11R6.8 to 789 X11R7.1 and in XFree86 version 4.3 the right vboxmouse driver 790 must be loaded and associated with /dev/mouse or /dev/psaux. In 791 X.Org server 1.3 or later a driver for a PS/2 mouse must be 792 loaded and the right vboxmouse driver must be associated with 793 /dev/vboxguest. 734 load the <literal>vboxvideo</literal> driver. Many recent X 735 server versions look for it automatically if they see that they 736 are running in &product-name;. For an optimal user experience, 737 the guest kernel drivers must be loaded and the Guest Additions 738 tool <command>VBoxClient</command> must be running as a client 739 in the X session. 740 </para> 741 742 <para> 743 For mouse integration to work correctly, the guest kernel 744 drivers must be loaded. In addition, for legacy X servers the 745 correct <literal>vboxmouse</literal> driver must be loaded and 746 associated with <filename>/dev/mouse</filename> or 747 <filename>/dev/psaux</filename>. For most guests, a driver for a 748 PS/2 mouse must be loaded and the correct vboxmouse driver must 749 be associated with <filename>/dev/vboxguest</filename>. 794 750 </para> 795 751 … … 799 755 virtual video memory allocated to the virtual machine, minus a 800 756 small amount used by the guest driver, as described in 801 <xref 802 linkend="settings-display" />. The driver will offer 803 a range of standard modes at least up to the default guest 804 resolution for all active guest monitors. In X.Org Server 1.3 805 and later the default mode can be changed by setting the output 806 property VBOX_MODE to "<width>x<height>" for any 807 guest monitor. When VBoxClient and the kernel drivers are active 808 this is done automatically when the host requests a mode change. 809 The driver for older versions can only receive new modes by 810 querying the host for requests at regular intervals. 811 </para> 812 813 <para> 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: 757 <xref linkend="settings-display" />. The driver will offer a 758 range of standard modes at least up to the default guest 759 resolution for all active guest monitors. The default mode can 760 be changed by setting the output property VBOX_MODE to 761 "<width>x<height>" for any guest monitor. When 762 VBoxClient and the kernel drivers are active this is done 763 automatically when the host requests a mode change. The driver 764 for older versions can only receive new modes by querying the 765 host for requests at regular intervals. 766 </para> 767 768 <para> 769 With legacy X Servers before version 1.3, you can also add your 770 own modes to the X server configuration file. Add them to the 771 "Modes" list in the "Display" subsection of the "Screen" 772 section. For example, the following section has a custom 773 2048x800 resolution mode added: 819 774 </para> 820 775 … … 864 819 </para> 865 820 866 <screen>VBoxManage modifyvm "VM name" --cpuhotplug on</screen> 867 868 <para> 869 The <computeroutput>--cpus</computeroutput> option is used to 870 specify the maximum number of CPUs that the virtual machine can 871 have: 872 </para> 873 874 <screen>VBoxManage modifyvm "VM name" --cpus 8</screen> 821 <screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> --cpuhotplug on</screen> 822 823 <para> 824 The <option>--cpus</option> option is used to specify the maximum 825 number of CPUs that the virtual machine can have: 826 </para> 827 828 <screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> --cpus 8</screen> 875 829 876 830 <para> 877 831 When the VM is off, you can then add and remove virtual CPUs with 878 the <com puteroutput>modifyvm --plugcpu</computeroutput> and879 <com puteroutput>--unplugcpu</computeroutput> subcommands, which832 the <command>VBoxManage modifyvm --plugcpu</command> and 833 <command>VBoxManage modifyvm --unplugcpu</command> commands, which 880 834 take the number of the virtual CPU as a parameter, as follows: 881 835 </para> 882 836 883 <screen> VBoxManage modifyvm "VM name"--plugcpu 3884 VBoxManage modifyvm "VM name"--unplugcpu 3</screen>837 <screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> --plugcpu 3 838 $ VBoxManage modifyvm <replaceable>VM-name</replaceable> --unplugcpu 3</screen> 885 839 886 840 <para> … … 890 844 <para> 891 845 While the VM is running, CPUs can be added and removed with the 892 <com puteroutput>controlvm plugcpu</computeroutput> and893 <com puteroutput>unplugcpu</computeroutput> commands instead, as894 follows:895 </para> 896 897 <screen> VBoxManage controlvm "VM name"plugcpu 3898 VBoxManage controlvm "VM name"unplugcpu 3</screen>846 <command>VBoxManage controlvm plugcpu</command> and 847 <command>VBoxManage controlvm unplugcpu</command> commands 848 instead, as follows: 849 </para> 850 851 <screen>$ VBoxManage controlvm <replaceable>VM-name</replaceable> plugcpu 3 852 $ VBoxManage controlvm <replaceable>VM-name</replaceable> unplugcpu 3</screen> 899 853 900 854 <para> 901 855 See <xref linkend="vboxmanage-modifyvm" /> and 902 <xref 903 linkend="vboxmanage-controlvm" /> for details. 856 <xref linkend="vboxmanage-controlvm" /> for details. 904 857 </para> 905 858 … … 918 871 </para> 919 872 920 <screen> echo 1 > /sys/devices/system/cpu/cpu<id>/online</screen>873 <screen>$ echo 1 > /sys/devices/system/cpu/cpu<id>/online</screen> 921 874 922 875 </sect1> 923 876 924 877 <!--<sect1 id="pcipassthrough"> 925 878 926 879 <title>PCI Passthrough</title> … … 928 881 <para> 929 882 When running on Linux hosts with a kernel version later than 930 < computeroutput>2.6.31</computeroutput>, experimental host PCI931 devicespassthrough is available.883 <literal>2.6.31</literal>, experimental host PCI devices 884 passthrough is available. 932 885 </para> 933 886 934 887 <note> 935 888 <para> 936 The PCI passthrough module is shipped as a &product-name;889 The PCI passthrough module is shipped as an &product-name; 937 890 extension package, which must be installed separately. See 938 <xref 939 linkend="intro-installing" />. 891 <xref linkend="intro-installing" />. 940 892 </para> 941 893 </note> … … 954 906 <para> 955 907 To be fully functional, PCI passthrough support in &product-name; 956 depends upon an IOMMU hardware unit which is not yet too widely957 available. If the device uses bus mastering, for example it958 performs DMA to the OS memory on its own, then an IOMMU is959 required. Otherwise such DMA transactions may write to the wrong960 physical memory address as the device DMA engine is programmed961 using a device-specific protocol to perform memory transactions.962 The IOMMU functions as translation unit mapping physical memory963 access requests from the device using knowledge of the guest964 physical address to host physical addressestranslation rules.908 depends upon an IOMMU hardware unit. If the device uses bus 909 mastering, for example it performs DMA to the OS memory on its 910 own, then an IOMMU is required. Otherwise such DMA transactions 911 may write to the wrong physical memory address as the device DMA 912 engine is programmed using a device-specific protocol to perform 913 memory transactions. The IOMMU functions as translation unit 914 mapping physical memory access requests from the device using 915 knowledge of the guest physical address to host physical addresses 916 translation rules. 965 917 </para> 966 918 … … 1010 962 <para> 1011 963 Your Linux kernel was compiled with IOMMU support, including 1012 DMA remapping. See the 1013 <computeroutput>CONFIG_DMAR</computeroutput> kernel 964 DMA remapping. See the <literal>CONFIG_DMAR</literal> kernel 1014 965 compilation option. The PCI stub driver 1015 (<computeroutput>CONFIG_PCI_STUB</computeroutput>) is required 1016 as well. 966 (<literal>CONFIG_PCI_STUB</literal>) is required as well. 1017 967 </para> 1018 968 </listitem> … … 1021 971 <para> 1022 972 Your Linux kernel recognizes and uses the IOMMU unit. The 1023 <computeroutput>intel_iommu=on</computeroutput> boot option 1024 could be needed. Search for DMAR and PCI-DMA in kernel boot 1025 log. 973 <literal>intel_iommu=on</literal> boot option could be needed. 974 Search for DMAR and PCI-DMA in kernel boot log. 1026 975 </para> 1027 976 </listitem> … … 1046 995 <para> 1047 996 The first column is a PCI address, in the format 1048 < computeroutput>bus:device.function</computeroutput>. This address1049 could be used to identify the device for further operations. For1050 example, to attach a PCI network controller on the system listed1051 above to the second PCI bus in the guest, as device 5, function 0,1052 use the following command:1053 </para> 1054 1055 <screen> VBoxManage modifyvm "VM name" --pciattach 02:00.0@01:05.0</screen>997 <literal><replaceable>bus</replaceable>:<replaceable>device</replaceable>.<replaceable>function</replaceable></literal>. 998 This address could be used to identify the device for further 999 operations. For example, to attach a PCI network controller on the 1000 system listed above to the second PCI bus in the guest, as device 1001 5, function 0, use the following command: 1002 </para> 1003 1004 <screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> -\-pciattach 02:00.0@01:05.0</screen> 1056 1005 1057 1006 <para> … … 1059 1008 </para> 1060 1009 1061 <screen> VBoxManage modifyvm "VM name" --pcidetach 02:00.0</screen>1010 <screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> -\-pcidetach 02:00.0</screen> 1062 1011 1063 1012 <para> … … 1107 1056 </itemizedlist> 1108 1057 1109 </sect1> 1058 </sect1>--> 1110 1059 1111 1060 <sect1 id="webcam-passthrough"> … … 1118 1067 1119 1068 <para> 1120 &product-name; 4.3 includes an experimental feature which1121 enables a guest to use a host webcam. This complements the1122 general USB passthrough support which was the typical way of1123 using host webcams in earlier versions. The webcam passthrough1124 support can handle non-USB video sources in theory, but this is1125 completely untested.1069 &product-name; includes a feature called <emphasis>webcam 1070 passthrough</emphasis>, which enables a guest to use a host 1071 webcam. This complements the general USB passthrough support 1072 which was the typical way of using host webcams in legacy 1073 releases. The webcam passthrough support can handle non-USB 1074 video sources in theory, but this is completely untested. 1126 1075 </para> 1127 1076 … … 1130 1079 The webcam passthrough module is shipped as part of the 1131 1080 &product-name; extension pack, which must be installed 1132 separately. See <xref 1133 linkend="intro-installing" />. 1081 separately. See <xref linkend="intro-installing" />. 1134 1082 </para> 1135 1083 </note> … … 1158 1106 </para> 1159 1107 1160 <screen> VBoxManage list webcams</screen>1108 <screen>$ VBoxManage list webcams</screen> 1161 1109 1162 1110 <para> … … 1180 1128 </para> 1181 1129 1182 <screen>VBoxManage controlvm "VM name" webcam attach [host_path|alias [settings]]</screen>1130 <screen>VBoxManage controlvm <replaceable>VM name</replaceable> webcam attach [<replaceable>host_path</replaceable>|<replaceable>alias</replaceable> [<replaceable>settings</replaceable>]]</screen> 1183 1131 1184 1132 <para> … … 1187 1135 1188 1136 <para> 1189 The <computeroutput>settings</computeroutput> parameter is a 1190 string 1191 <computeroutput>Setting1=Value1;Setting2=Value2</computeroutput>, 1192 which enables you to configure the emulated webcam device. 1193 The following settings are supported: 1137 The <literal>settings</literal> parameter is a string 1138 <literal>Setting1=Value1;Setting2=Value2</literal>, which 1139 enables you to configure the emulated webcam device. The 1140 following settings are supported: 1194 1141 </para> 1195 1142 … … 1198 1145 <listitem> 1199 1146 <para> 1200 < computeroutput>MaxFramerate</computeroutput>: The1201 highest rate at which video frames are sent to the1202 guest. A higher frame rate requires more CPU power.1203 Therefore sometimes it is useful to set a lower limit.1204 Default is no limit and allow the guest to use all frame1205 rates supported by thehost webcam.1147 <literal>MaxFramerate</literal>: The highest rate at 1148 which video frames are sent to the guest. A higher frame 1149 rate requires more CPU power. Therefore sometimes it is 1150 useful to set a lower limit. Default is no limit and 1151 allow the guest to use all frame rates supported by the 1152 host webcam. 1206 1153 </para> 1207 1154 </listitem> … … 1209 1156 <listitem> 1210 1157 <para> 1211 <computeroutput>MaxPayloadTransferSize</computeroutput>: 1212 How many bytes the emulated webcam can send to the guest 1213 at a time. Default value is 3060 bytes, which is used by 1214 some webcams. Higher values can slightly reduce CPU 1215 load, if the guest is able to use larger buffers. 1216 However, a high 1217 <computeroutput>MaxPayloadTransferSize</computeroutput> 1218 might be not supported by some guests. 1158 <literal>MaxPayloadTransferSize</literal>: How many 1159 bytes the emulated webcam can send to the guest at a 1160 time. Default value is 3060 bytes, which is used by some 1161 webcams. Higher values can slightly reduce CPU load, if 1162 the guest is able to use larger buffers. However, a high 1163 <literal>MaxPayloadTransferSize</literal> might be not 1164 supported by some guests. 1219 1165 </para> 1220 1166 </listitem> … … 1228 1174 </para> 1229 1175 1230 <screen>VBoxManage controlvm "VM name" webcam detach [host_path|alias]</screen>1176 <screen>VBoxManage controlvm <replaceable>VM-name</replaceable> webcam detach [<replaceable>host_path</replaceable>|<replaceable>alias</replaceable>]</screen> 1231 1177 </listitem> 1232 1178 … … 1236 1182 </para> 1237 1183 1238 <screen>VBoxManage controlvm "VM name"webcam list</screen>1184 <screen>VBoxManage controlvm <replaceable>VM-name</replaceable> webcam list</screen> 1239 1185 1240 1186 <para> … … 1265 1211 1266 1212 <para> 1267 OS X version 10.9 or later is required.1213 Mac OS X version 10.9 or later is required. 1268 1214 </para> 1269 1215 … … 1271 1217 When the webcam device is detached from the host, the emulated 1272 1218 webcam device remains attached to the guest and must be manually 1273 detached using the <computeroutput>VBoxManage controlvm "VM 1274 name" webcam detach</computeroutput> command. 1219 detached using the <command>VBoxManage controlvm 1220 <replaceable>VM-name</replaceable> webcam detach</command> 1221 command. 1275 1222 </para> 1276 1223 … … 1285 1232 device is automatically detached from the guest only if the 1286 1233 webcam is streaming video. If the emulated webcam is inactive it 1287 should be manually detached using the <com puteroutput>VBoxManage1288 controlvm "VM name" webcam detach</computeroutput> command.1289 </para>1290 1291 <para> 1292 Aliases <computeroutput>.0</computeroutput> and1293 <computeroutput>.1</computeroutput> are mapped to1294 <computeroutput>/dev/video0</computeroutput>, alias1295 < computeroutput>.2</computeroutput> is mapped to1296 < computeroutput>/dev/video1</computeroutput> and so forth.1234 should be manually detached using the <command>VBoxManage 1235 controlvm <replaceable>VM-name</replaceable> webcam 1236 detach</command> command. 1237 </para> 1238 1239 <para> 1240 Aliases <filename>.0</filename> and <filename>.1</filename> are 1241 mapped to <filename>/dev/video0</filename>, alias 1242 <filename>.2</filename> is mapped to 1243 <filename>/dev/video1</filename> and so forth. 1297 1244 </para> 1298 1245 … … 1321 1268 Additional video modes can be configured for each VM using the 1322 1269 extra data facility. The extra data key is called 1323 < computeroutput>CustomVideoMode<x></computeroutput> with1324 <computeroutput>x</computeroutput> being a number from 1 to 16.1270 <literal>CustomVideoMode<replaceable>x</replaceable></literal> 1271 with <replaceable>x</replaceable> being a number from 1 to 16. 1325 1272 Please note that modes will be read from 1 until either the 1326 1273 following number is not defined or 16 is reached. The following … … 1329 1276 </para> 1330 1277 1331 <screen> VBoxManage setextradata "VM name""CustomVideoMode1" "1400x1050x16"</screen>1278 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> "CustomVideoMode1" "1400x1050x16"</screen> 1332 1279 1333 1280 <para> 1334 1281 The VESA mode IDs for custom video modes start at 1335 < computeroutput>0x160</computeroutput>. In order to use the1336 above defined custom video mode, the following command line has1337 to be supplied toLinux:1282 <literal>0x160</literal>. In order to use the above defined 1283 custom video mode, the following command line has to be supplied 1284 to Linux: 1338 1285 </para> 1339 1286 … … 1362 1309 seamless mode or sending a video mode hint using 1363 1310 <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: 1367 </para> 1311 will want, but if you have different needs, you can change it by 1312 issuing one of the following commands from the command line: 1313 </para> 1314 1315 <itemizedlist> 1316 1317 <listitem> 1318 <para> 1319 Remove all limits on guest resolutions. 1320 </para> 1368 1321 1369 1322 <screen>VBoxManage setextradata global GUI/MaxGuestResolution any</screen> 1370 1371 <para> 1372 will remove all limits on guest resolutions. 1373 </para> 1374 1375 <screen>VBoxManage setextradata global GUI/MaxGuestResolution >width,height<</screen> 1376 1377 <para> 1378 manually specifies a maximum resolution. 1379 </para> 1323 </listitem> 1324 1325 <listitem> 1326 <para> 1327 Manually specify a maximum resolution. 1328 </para> 1329 1330 <screen>VBoxManage setextradata global GUI/MaxGuestResolution <replaceable>width</replaceable>x<replaceable>height</replaceable></screen> 1331 </listitem> 1332 1333 <listitem> 1334 <para> 1335 Restore the default settings to all guest VMs. 1336 </para> 1380 1337 1381 1338 <screen>VBoxManage setextradata global GUI/MaxGuestResolution auto</screen> 1382 1383 <para> 1384 restores the default settings. Note that these settings apply 1385 globally to all guest systems, not just to a single machine. 1386 </para> 1339 </listitem> 1340 1341 </itemizedlist> 1387 1342 1388 1343 </sect2> … … 1410 1365 to access its virtual hard disk without going through the host 1411 1366 OS file system. The actual performance difference for image 1412 files vs. raw disk varies greatly depending on the overhead of1413 the host file system, whether dynamically growing images are1414 used, and on host OS caching strategies. The caching indirectly1415 also affects other aspects such as failure behavior. For1416 example, whether the virtual disk contains all data written1367 files compared to raw disk varies greatly depending on the 1368 overhead of the host file system, whether dynamically growing 1369 images are used, and on host OS caching strategies. The caching 1370 indirectly also affects other aspects such as failure behavior. 1371 For example, whether the virtual disk contains all data written 1417 1372 before a host OS crash. Consult your host OS documentation for 1418 1373 details on this. … … 1466 1421 </para> 1467 1422 1468 <screen> VBoxManage internalcommands createrawvmdk -filename /path/to/file.vmdk1469 1470 1471 <para> 1472 This creates the image1473 < computeroutput>/path/to/file.vmdk</computeroutput>, which1474 must be an absolute path. All data will be read and written1475 from <computeroutput>/dev/sda</computeroutput>.1423 <screen>$ VBoxManage internalcommands createrawvmdk -filename \ 1424 /path/to/file.vmdk -rawdisk /dev/sda</screen> 1425 1426 <para> 1427 This creates the 1428 <filename>/<replaceable>path-to-file</replaceable>.vmdk</filename> 1429 file image that must be an absolute path. All data is read and 1430 written from <filename>/dev/sda</filename>. 1476 1431 </para> 1477 1432 1478 1433 <para> 1479 1434 On a Windows host, instead of the above device specification, 1480 for example use 1481 <computeroutput>\\.\PhysicalDrive0</computeroutput>. On a Mac 1482 OS X host, instead of the above device specification use for 1483 example <computeroutput>/dev/disk1</computeroutput>. Note that 1484 on OS X you can only get access to an entire disk if no volume 1485 is mounted from it. 1435 for example use <filename>\\.\PhysicalDrive0</filename>. On a 1436 Mac OS X host, instead of the above device specification use 1437 for example <filename>/dev/disk1</filename>. Note that on Mac 1438 OS X you can only get access to an entire disk if no volume is 1439 mounted from it. 1486 1440 </para> 1487 1441 … … 1490 1444 device. Read/write access is also later needed when using the 1491 1445 image from a virtual machine. On some host platforms, such as 1492 Windows Vista and later, raw disk access may be restricted and1493 not permittedby the host OS in some situations.1446 Windows, raw disk access may be restricted and not permitted 1447 by the host OS in some situations. 1494 1448 </para> 1495 1449 … … 1500 1454 </para> 1501 1455 1502 <screen> VBoxManage storageattach WindowsXP --storagectl "IDE Controller"1456 <screen>$ VBoxManage storageattach WindowsXP --storagectl "IDE Controller" \ 1503 1457 --port 0 --device 0 --type hdd --medium /path/to/file.vmdk</screen> 1504 1458 … … 1534 1488 </para> 1535 1489 1536 <screen> VBoxManage internalcommands createrawvmdk -filename /path/to/file.vmdk1537 -rawdisk /dev/sda -partitions 1,5</screen>1490 <screen>$ VBoxManage internalcommands createrawvmdk -filename \ 1491 /path/to/file.vmdk -rawdisk /dev/sda -partitions 1,5</screen> 1538 1492 1539 1493 <para> 1540 1494 The command is identical to the one for full hard disk access, 1541 except for the additional 1542 <computeroutput>-partitions</computeroutput> parameter. This 1543 example would create the image 1544 <computeroutput>/path/to/file.vmdk</computeroutput>, which 1545 must be absolute, and partitions 1 and 5 of 1546 <computeroutput>/dev/sda</computeroutput> would be made 1547 accessible to the guest. 1495 except for the additional <option>-partitions</option> 1496 parameter. This example would create the image 1497 <filename>/<replaceable>path-to-file</replaceable>.vmdk</filename>, 1498 which must be absolute, and partitions 1 and 5 of 1499 <filename>/dev/sda</filename> would be made accessible to the 1500 guest. 1548 1501 </para> 1549 1502 … … 1557 1510 <para> 1558 1511 On a Windows host, instead of the above device specification, 1559 use for example 1560 <computeroutput>\\.\PhysicalDrive0</computeroutput>. On a Mac 1561 OS X host, instead of the above device specification use 1562 <computeroutput>/dev/disk1</computeroutput>, for example. Note 1563 that on OS X you can only use partitions which are not 1564 mounted. Eject the respective volume first. Partition numbers 1565 are the same on Linux, Windows, and Mac OS X hosts. 1512 use for example <filename>\\.\PhysicalDrive0</filename>. On a 1513 Mac OS X host, instead of the above device specification use 1514 <filename>/dev/disk1</filename>, for example. Note that on OS 1515 X you can only use partitions which are not mounted. Eject the 1516 respective volume first. Partition numbers are the same on 1517 Linux, Windows, and Mac OS X hosts. 1566 1518 </para> 1567 1519 … … 1571 1523 </para> 1572 1524 1573 <screen> VBoxManage internalcommands listpartitions -rawdisk /dev/sda</screen>1525 <screen>$ VBoxManage internalcommands listpartitions -rawdisk /dev/sda</screen> 1574 1526 1575 1527 <para> … … 1596 1548 </para> 1597 1549 1598 <screen> VBoxManage internalcommands createrawvmdk -filename /path/to/file.vmdk1599 -rawdisk /dev/sda -partitions 1,5 -relative</screen>1550 <screen>$ VBoxManage internalcommands createrawvmdk -filename \ 1551 /path/to/file.vmdk -rawdisk /dev/sda -partitions 1,5 -relative</screen> 1600 1552 1601 1553 <para> 1602 1554 When used from a virtual machine, the image will then refer 1603 1555 not to the entire disk, but only to the individual partitions. 1604 In this example, < computeroutput>/dev/sda1</computeroutput>1605 and <computeroutput>/dev/sda5</computeroutput>. As a1606 consequence, read/write access is only required for the1607 affected partitions, not for the entire disk. During creation1608 however, read-only access to the entire disk is required to1609 obtain the partitioninginformation.1556 In this example, <filename>/dev/sda1</filename> and 1557 <filename>/dev/sda5</filename>. As a consequence, read/write 1558 access is only required for the affected partitions, not for 1559 the entire disk. During creation however, read-only access to 1560 the entire disk is required to obtain the partitioning 1561 information. 1610 1562 </para> 1611 1563 … … 1616 1568 This enables for example the guest to boot directly to 1617 1569 Windows, while the host boots Linux from the "same" disk. For 1618 this purpose the < computeroutput>-mbr</computeroutput>1619 parameter is provided. It specifies a file name from which to1620 take the MBR code. The partition table is not modified at all,1621 s o a MBR file from a system with totally different1622 partitioning can be used. Anexample of this is:1623 </para> 1624 1625 <screen> VBoxManage internalcommands createrawvmdk -filename /path/to/file.vmdk1626 -rawdisk /dev/sda -partitions 1,5 -mbr winxp.mbr</screen>1570 this purpose the <option>-mbr</option> option is provided. It 1571 specifies a file name from which to take the MBR code. The 1572 partition table is not modified at all, so a MBR file from a 1573 system with totally different partitioning can be used. An 1574 example of this is: 1575 </para> 1576 1577 <screen>$ VBoxManage internalcommands createrawvmdk -filename 1578 /path/to/file.vmdk -rawdisk /dev/sda -partitions 1,5 -mbr winxp.mbr</screen> 1627 1579 1628 1580 <para> … … 1651 1603 </para> 1652 1604 1653 <screen> VBoxManage setextradata "VM name"1654 1655 VBoxManage setextradata "VM name" 1656 1657 VBoxManage setextradata "VM name" 1658 1605 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 1606 "VBoxInternal/Devices/ahci/0/Config/Port0/SerialNumber" "serial" 1607 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 1608 "VBoxInternal/Devices/ahci/0/Config/Port0/FirmwareRevision" "firmware" 1609 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 1610 "VBoxInternal/Devices/ahci/0/Config/Port0/ModelNumber" "model"</screen> 1659 1611 1660 1612 <para> … … 1671 1623 </para> 1672 1624 1673 <screen> VBoxManage setextradata "VM name"1674 1675 VBoxManage setextradata "VM name" 1676 1677 VBoxManage setextradata "VM name" 1678 1679 1680 <para> 1681 For hard disks it is also possible tomark the drive as having a1682 non-rotational medium with:1683 </para> 1684 1685 <screen> VBoxManage setextradata "VM name"1686 1625 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 1626 "VBoxInternal/Devices/piix3ide/0/Config/PrimaryMaster/SerialNumber" "serial" 1627 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 1628 "VBoxInternal/Devices/piix3ide/0/Config/PrimaryMaster/FirmwareRevision" "firmware" 1629 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 1630 "VBoxInternal/Devices/piix3ide/0/Config/PrimaryMaster/ModelNumber" "model"</screen> 1631 1632 <para> 1633 For hard disks, you can mark the drive as having a 1634 non-rotational medium by using the following command: 1635 </para> 1636 1637 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 1638 "VBoxInternal/Devices/ahci/0/Config/Port0/NonRotational" "1"</screen> 1687 1639 1688 1640 <para> … … 1691 1643 </para> 1692 1644 1693 <screen> VBoxManage setextradata "VM name"1694 1695 VBoxManage setextradata "VM name"1696 1697 VBoxManage setextradata "VM name"1698 1645 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 1646 "VBoxInternal/Devices/ahci/0/Config/Port0/ATAPIVendorId" "vendor" 1647 VBoxManage setextradata <replaceable>VM-name</replaceable> \ 1648 "VBoxInternal/Devices/ahci/0/Config/Port0/ATAPIProductId" "product" 1649 VBoxManage setextradata <replaceable>VM-name</replaceable> \ 1650 "VBoxInternal/Devices/ahci/0/Config/Port0/ATAPIRevision" "revision"</screen> 1699 1651 1700 1652 <para> … … 1731 1683 </para> 1732 1684 1733 <screen>VBoxManage setextradata "VM name" VBoxInternal/Devices/IntNetIP/0/Trusted 1 1734 VBoxManage setextradata "VM name" VBoxInternal/Devices/IntNetIP/0/Config/MAC 08:00:27:01:02:0f 1735 VBoxManage setextradata "VM name" VBoxInternal/Devices/IntNetIP/0/Config/IP 10.0.9.1 1736 VBoxManage setextradata "VM name" VBoxInternal/Devices/IntNetIP/0/Config/Netmask 255.255.255.0 1737 VBoxManage setextradata "VM name" VBoxInternal/Devices/IntNetIP/0/LUN#0/Driver IntNet 1738 VBoxManage setextradata "VM name" VBoxInternal/Devices/IntNetIP/0/LUN#0/Config/Network MyIntNet 1739 VBoxManage setextradata "VM name" VBoxInternal/Devices/IntNetIP/0/LUN#0/Config/TrunkType 2 1740 VBoxManage setextradata "VM name" VBoxInternal/Devices/IntNetIP/0/LUN#0/Config/IsService 1</screen> 1685 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 1686 VBoxInternal/Devices/IntNetIP/0/Trusted 1 1687 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 1688 VBoxInternal/Devices/IntNetIP/0/Config/MAC 08:00:27:01:02:0f 1689 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 1690 VBoxInternal/Devices/IntNetIP/0/Config/IP 10.0.9.1 1691 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 1692 VBoxInternal/Devices/IntNetIP/0/Config/Netmask 255.255.255.0 1693 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 1694 VBoxInternal/Devices/IntNetIP/0/LUN#0/Driver IntNet 1695 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 1696 VBoxInternal/Devices/IntNetIP/0/LUN#0/Config/Network MyIntNet 1697 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 1698 VBoxInternal/Devices/IntNetIP/0/LUN#0/Config/TrunkType 2 1699 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 1700 VBoxInternal/Devices/IntNetIP/0/LUN#0/Config/IsService 1</screen> 1741 1701 1742 1702 <para> 1743 1703 Finally the iSCSI disk must be attached with the 1744 < computeroutput>--intnet</computeroutput> option to tell the1745 iSCSI initiator touse internal networking, as follows:1746 </para> 1747 1748 <screen> VBoxManage storageattach ... --medium iscsi1749 -- server 10.0.9.30 --target iqn.2008-12.com.sun:sampletarget --intnet</screen>1704 <option>--intnet</option> option to tell the iSCSI initiator to 1705 use internal networking, as follows: 1706 </para> 1707 1708 <screen>$ VBoxManage storageattach ... --medium iscsi --server 10.0.9.30 \ 1709 --target iqn.2008-12.com.sun:sampletarget --intnet</screen> 1750 1710 1751 1711 <para> … … 1767 1727 </sect1> 1768 1728 1769 <sect1 id="serialports-legacy-cmds">1770 1771 <title>Legacy Commands for Using Serial Ports</title>1772 1773 <para>1774 In legacy releases, &product-name; provided support for virtual1775 serial ports. This was rather complicated to set up, requiring a1776 sequence of <command>VBoxManage setextradata</command> statements.1777 That method of setting up serial ports is no longer necessary and1778 <emphasis>deprecated.</emphasis> To set up virtual serial ports,1779 use the methods described in <xref linkend="serialports" />.1780 </para>1781 1782 <note>1783 <para>1784 For backwards compatibility, the legacy1785 <computeroutput>setextradata</computeroutput> statements, whose1786 description is retained below from the old version of the1787 manual, take <emphasis>precedence</emphasis> over the new way of1788 configuring serial ports. As a result, if configuring serial1789 ports the new way does not work, make sure the VM in question1790 does not have old configuration data such as below still active.1791 </para>1792 </note>1793 1794 <para>1795 The legacy sequence of configuring a serial port used the1796 following commands:1797 </para>1798 1799 <screen>VBoxManage setextradata "VM name"1800 "VBoxInternal/Devices/serial/0/Config/IRQ" 41801 VBoxManage setextradata "VM name"1802 "VBoxInternal/Devices/serial/0/Config/IOBase" 0x3f81803 VBoxManage setextradata "VM name"1804 "VBoxInternal/Devices/serial/0/LUN#0/Driver" Char1805 VBoxManage setextradata "VM name"1806 "VBoxInternal/Devices/serial/0/LUN#0/AttachedDriver/Driver" NamedPipe1807 VBoxManage setextradata "VM name"1808 "VBoxInternal/Devices/serial/0/LUN#0/AttachedDriver/Config/Location" "\\.\pipe\vboxCOM1"1809 VBoxManage setextradata "VM name"1810 "VBoxInternal/Devices/serial/0/LUN#0/AttachedDriver/Config/IsServer" 1</screen>1811 1812 <para>1813 This sets up a serial port in the guest with the default settings1814 for COM1 (IRQ 4, I/O address 0x3f8) and the1815 <computeroutput>Location</computeroutput> setting assumes that1816 this configuration is used on a Windows host, because the Windows1817 named pipe syntax is used. Keep in mind that on Windows hosts a1818 named pipe must always start with1819 <computeroutput>\\.\pipe\</computeroutput>. On Linux the same1820 configuration settings apply, except that the path name for the1821 <computeroutput>Location</computeroutput> can be chosen more1822 freely. Local domain sockets can be placed anywhere, provided the1823 user running &product-name; has the permission to create a new1824 file in the directory. The final command above defines that1825 &product-name; acts as a server. It creates the named pipe itself1826 instead of connecting to an already existing one.1827 </para>1828 1829 </sect1>1830 1831 1729 <sect1 id="changenat"> 1832 1730 … … 1839 1737 <para> 1840 1738 In NAT mode, the guest network interface is assigned to the IPv4 1841 range < computeroutput>10.0.x.0/24</computeroutput> by default1842 where <computeroutput>x</computeroutput> corresponds to the1739 range <literal>10.0.<replaceable>x</replaceable>.0/24</literal> 1740 by default where <replaceable>x</replaceable> corresponds to the 1843 1741 instance of the NAT interface +2. So 1844 <computeroutput>x</computeroutput> is 2 when there is only one 1845 NAT instance active. In that case the guest is assigned to the 1846 address <computeroutput>10.0.2.15</computeroutput>, the gateway 1847 is set to <computeroutput>10.0.2.2</computeroutput> and the name 1848 server can be found at 1849 <computeroutput>10.0.2.3</computeroutput>. 1742 <replaceable>x</replaceable> is 2 when there is only one NAT 1743 instance active. In that case the guest is assigned to the 1744 address <literal>10.0.2.15</literal>, the gateway is set to 1745 <literal>10.0.2.2</literal> and the name server can be found at 1746 <literal>10.0.2.3</literal>. 1850 1747 </para> 1851 1748 … … 1855 1752 </para> 1856 1753 1857 <screen>VBoxManage modifyvm "VM name" --natnet1 "192.168/16"</screen> 1754 <screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> \ 1755 --natnet1 "192.168/16"</screen> 1858 1756 1859 1757 <para> 1860 1758 This command would reserve the network addresses from 1861 < computeroutput>192.168.0.0</computeroutput> to1862 < computeroutput>192.168.254.254</computeroutput> for the first1863 NAT network instance of "VM name". The guest IP would be1864 assigned to <computeroutput>192.168.0.15</computeroutput> and1865 thedefault gateway could be found at1866 < computeroutput>192.168.0.2</computeroutput>.1759 <literal>192.168.0.0</literal> to 1760 <literal>192.168.254.254</literal> for the first NAT network 1761 instance of <replaceable>VM-name</replaceable> The guest IP 1762 would be assigned to <literal>192.168.0.15</literal> and the 1763 default gateway could be found at 1764 <literal>192.168.0.2</literal>. 1867 1765 </para> 1868 1766 … … 1881 1779 </para> 1882 1780 1883 <screen>VBoxManage modifyvm "VM name" --nattftpserver1 10.0.2.2 1884 VBoxManage modifyvm "VM name" --nattftpfile1 /srv/tftp/boot/MyPXEBoot.pxe</screen> 1781 <screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> \ 1782 --nattftpserver1 10.0.2.2 1783 $ VBoxManage modifyvm <replaceable>VM-name</replaceable> \ 1784 --nattftpfile1 /srv/tftp/boot/MyPXEBoot.pxe</screen> 1885 1785 1886 1786 </sect2> … … 1893 1793 The &product-name; NAT stack performance is often determined by 1894 1794 its interaction with the host's TCP/IP stack and the size of 1895 several buffers, <computeroutput>SO_RCVBUF</computeroutput> and 1896 <computeroutput>SO_SNDBUF</computeroutput>. For certain setups 1897 users might want to adjust the buffer size for a better 1898 performance. This can by achieved using the following commands, 1899 where values are in kilobytes and can range from 8 to 1024: 1900 </para> 1901 1902 <screen>VBoxManage modifyvm "VM name" --natsettings1 16000,128,128,0,0</screen> 1795 several buffers, <literal>SO_RCVBUF</literal> and 1796 <literal>SO_SNDBUF</literal>. For certain setups users might 1797 want to adjust the buffer size for a better performance. This 1798 can by achieved using the following commands, where values are 1799 in kilobytes and can range from 8 to 1024: 1800 </para> 1801 1802 <screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> \ 1803 --natsettings1 16000,128,128,0,0</screen> 1903 1804 1904 1805 <para> … … 1932 1833 </para> 1933 1834 1934 <screen>VBoxManage modifyvm "VM name" --natbindip1 "10.45.0.2"</screen> 1835 <screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> \ 1836 --natbindip1 "10.45.0.2"</screen> 1935 1837 1936 1838 <para> … … 1956 1858 </para> 1957 1859 1958 <screen> VBoxManage modifyvm "VM name"--natdnsproxy1 on</screen>1860 <screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> --natdnsproxy1 on</screen> 1959 1861 1960 1862 </sect2> … … 1973 1875 </para> 1974 1876 1975 <screen> VBoxManage modifyvm "VM name"--natdnshostresolver1 on</screen>1877 <screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> --natdnshostresolver1 on</screen> 1976 1878 1977 1879 <para> … … 2000 1902 </para> 2001 1903 2002 <screen>VBoxManage setextradata "VM name" \ 2003 "VBoxInternal/Devices/{pcnet,e1000}/0/LUN#0/AttachedDriver/Config/HostResolverMappings/ \ 2004 <unique rule name of interception rule>/HostIP" <IPv4> 2005 VBoxManage setextradata "VM name" \ 2006 "VBoxInternal/Devices/{pcnet,e1000}/0/LUN#0/AttachedDriver/Config/HostResolverMappings/ \ 2007 <unique rule name>/HostName" <name of host></screen> 1904 <screen>VBoxManage setextradata <replaceable>VM-name</replaceable> \ 1905 "VBoxInternal/Devices/{pcnet,e1000}/0/LUN#0/AttachedDriver/Config/HostResolverMappings/ \ 1906 <replaceable>unique-rule-name-of-interception-rule</replaceable>/HostIP" <replaceable>IPv4</replaceable> 1907 1908 VBoxManage setextradata <replaceable>VM-name</replaceable> \ 1909 "VBoxInternal/Devices/{pcnet,e1000}/0/LUN#0/AttachedDriver/Config/HostResolverMappings/ \ 1910 <replaceable>unique-rule-name</replaceable>/HostName" <replaceable>hostname</replaceable></screen> 2008 1911 2009 1912 <para> … … 2012 1915 </para> 2013 1916 2014 <screen>VBoxManage setextradata "VM name" \ 2015 "VBoxInternal/Devices/{pcnet,e1000}/0/LUN#0/AttachedDriver/Config/HostResolverMappings/ \ 2016 <unique rule name>/HostIP" <IPv4> 2017 VBoxManage setextradata "VM name" \ 2018 "VBoxInternal/Devices/{pcnet,e1000}/0/LUN#0/AttachedDriver/Config/HostResolverMappings/ \ 2019 <unique rule name>/HostNamePattern" <hostpattern></screen> 2020 2021 <para> 2022 The host pattern may include <computeroutput>"|", "?" and 2023 "*"</computeroutput>. 1917 <screen>VBoxManage setextradata <replaceable>VM-name</replaceable> \ 1918 "VBoxInternal/Devices/{pcnet,e1000}/0/LUN#0/AttachedDriver/Config/HostResolverMappings/ \ 1919 <replaceable>unique-rule-name</replaceable>/HostIP" <replaceable>IPv4</replaceable> 1920 1921 VBoxManage setextradata <replaceable>VM-name</replaceable> \ 1922 "VBoxInternal/Devices/{pcnet,e1000}/0/LUN#0/AttachedDriver/Config/HostResolverMappings/ \ 1923 <replaceable>unique-rule-name</replaceable>/HostNamePattern" <replaceable>hostpattern</replaceable></screen> 1924 1925 <para> 1926 The host name pattern can include the following wildcard 1927 characters: pipe (<literal>|</literal>), question mark 1928 (<literal>?</literal>), and asterisk (<literal>*</literal>). 2024 1929 </para> 2025 1930 … … 2030 1935 </para> 2031 1936 2032 <screen>VBoxManage setextradata "VM name" \ 2033 "VBoxInternal/Devices/e1000/0/LUN#0/AttachedDriver/Config/HostResolverMappings/ \ 2034 all_blocked_site/HostIP" 127.0.0.1 2035 VBoxManage setextradata "VM name" \ 2036 "VBoxInternal/Devices/e1000/0/LUN#0/AttachedDriver/Config/HostResolverMappings/ \ 2037 all_blocked_site/HostNamePattern" "*.blocked-site.*|*.fb.org"</screen> 1937 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 1938 "VBoxInternal/Devices/e1000/0/LUN#0/AttachedDriver/Config/HostResolverMappings/all_blocked_site/HostIP" 127.0.0.1 1939 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 1940 "VBoxInternal/Devices/e1000/0/LUN#0/AttachedDriver/Config/HostResolverMappings/all_blocked_site/HostNamePattern" "*.blocked-site.*|*.fb.org"</screen> 2038 1941 2039 1942 <para> … … 2056 1959 the most protocols like SSH, FTP and so on. Though some 2057 1960 protocols might need a more transparent behavior or may depend 2058 on the real port number the packet was sent from. It is possible2059 t o change the NAT mode using the <command>VBoxManage</command>2060 frontend with the following commands:2061 </para> 2062 2063 <screen>VBoxManage modifyvm "VM name"--nataliasmode1 proxyonly</screen>2064 2065 <screen> VBoxManage modifyvm "Linux Guest" --nataliasmode1 sameports</screen>1961 on the real port number the packet was sent from. You can change 1962 the NAT mode by using the following commands: 1963 </para> 1964 1965 <screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> \ 1966 --nataliasmode1 proxyonly</screen> 1967 1968 <screen>$ VBoxManage modifyvm "Linux Guest" --nataliasmode1 sameports</screen> 2066 1969 2067 1970 <para> … … 2083 1986 for a specific VM. Use the following commands to configure the DMI 2084 1987 BIOS information. In case your VM is configured to use EFI 2085 firmware you need to replace 2086 <computeroutput>pcbios</computeroutput> by 2087 <computeroutput>efi</computeroutput> in the keys. 1988 firmware you need to replace <literal>pcbios</literal> by 1989 <literal>efi</literal> in the keys. 2088 1990 </para> 2089 1991 … … 2095 1997 </para> 2096 1998 2097 <screen> VBoxManage setextradata "VM name"2098 2099 VBoxManage setextradata "VM name" 2100 2101 VBoxManage setextradata "VM name" 2102 2103 VBoxManage setextradata "VM name" 2104 2105 VBoxManage setextradata "VM name" 2106 2107 VBoxManage setextradata "VM name" 2108 2109 VBoxManage setextradata "VM name" 2110 1999 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2000 "VBoxInternal/Devices/pcbios/0/Config/DmiBIOSVendor" "BIOS Vendor" 2001 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2002 "VBoxInternal/Devices/pcbios/0/Config/DmiBIOSVersion" "BIOS Version" 2003 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2004 "VBoxInternal/Devices/pcbios/0/Config/DmiBIOSReleaseDate" "BIOS Release Date" 2005 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2006 "VBoxInternal/Devices/pcbios/0/Config/DmiBIOSReleaseMajor" 1 2007 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2008 "VBoxInternal/Devices/pcbios/0/Config/DmiBIOSReleaseMinor" 2 2009 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2010 "VBoxInternal/Devices/pcbios/0/Config/DmiBIOSFirmwareMajor" 3 2011 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2012 "VBoxInternal/Devices/pcbios/0/Config/DmiBIOSFirmwareMinor" 4</screen> 2111 2013 </listitem> 2112 2014 … … 2116 2018 </para> 2117 2019 2118 <screen> VBoxManage setextradata "VM name"2119 2120 VBoxManage setextradata "VM name" 2121 2122 VBoxManage setextradata "VM name" 2123 2124 VBoxManage setextradata "VM name" 2125 2126 VBoxManage setextradata "VM name" 2127 2128 VBoxManage setextradata "VM name" 2129 2130 VBoxManage setextradata "VM name" 2131 "VBoxInternal/Devices/pcbios/0/Config/DmiSystemUuid" 2132 2020 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2021 "VBoxInternal/Devices/pcbios/0/Config/DmiSystemVendor" "System Vendor" 2022 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2023 "VBoxInternal/Devices/pcbios/0/Config/DmiSystemProduct" "System Product" 2024 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2025 "VBoxInternal/Devices/pcbios/0/Config/DmiSystemVersion" "System Version" 2026 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2027 "VBoxInternal/Devices/pcbios/0/Config/DmiSystemSerial" "System Serial" 2028 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2029 "VBoxInternal/Devices/pcbios/0/Config/DmiSystemSKU" "System SKU" 2030 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2031 "VBoxInternal/Devices/pcbios/0/Config/DmiSystemFamily" "System Family" 2032 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2033 "VBoxInternal/Devices/pcbios/0/Config/DmiSystemUuid" \ 2034 "9852bf98-b83c-49db-a8de-182c42c7226b"</screen> 2133 2035 </listitem> 2134 2036 … … 2138 2040 </para> 2139 2041 2140 <screen> VBoxManage setextradata "VM name"2141 2142 VBoxManage setextradata "VM name" 2143 2144 VBoxManage setextradata "VM name" 2145 2146 VBoxManage setextradata "VM name" 2147 2148 VBoxManage setextradata "VM name" 2149 2150 VBoxManage setextradata "VM name" 2151 2152 VBoxManage setextradata "VM name" 2153 2042 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2043 "VBoxInternal/Devices/pcbios/0/Config/DmiBoardVendor" "Board Vendor" 2044 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2045 "VBoxInternal/Devices/pcbios/0/Config/DmiBoardProduct" "Board Product" 2046 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2047 "VBoxInternal/Devices/pcbios/0/Config/DmiBoardVersion" "Board Version" 2048 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2049 "VBoxInternal/Devices/pcbios/0/Config/DmiBoardSerial" "Board Serial" 2050 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2051 "VBoxInternal/Devices/pcbios/0/Config/DmiBoardAssetTag" "Board Tag" 2052 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2053 "VBoxInternal/Devices/pcbios/0/Config/DmiBoardLocInChass" "Board Location" 2054 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2055 "VBoxInternal/Devices/pcbios/0/Config/DmiBoardBoardType" 10</screen> 2154 2056 </listitem> 2155 2057 … … 2159 2061 </para> 2160 2062 2161 <screen> VBoxManage setextradata "VM name"2162 2163 VBoxManage setextradata "VM name" 2164 2165 VBoxManage setextradata "VM name" 2166 2167 VBoxManage setextradata "VM name" 2168 2169 VBoxManage setextradata "VM name" 2170 2063 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2064 "VBoxInternal/Devices/pcbios/0/Config/DmiChassisVendor" "Chassis Vendor" 2065 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2066 "VBoxInternal/Devices/pcbios/0/Config/DmiChassisType" 3 2067 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2068 "VBoxInternal/Devices/pcbios/0/Config/DmiChassisVersion" "Chassis Version" 2069 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2070 "VBoxInternal/Devices/pcbios/0/Config/DmiChassisSerial" "Chassis Serial" 2071 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2072 "VBoxInternal/Devices/pcbios/0/Config/DmiChassisAssetTag" "Chassis Tag"</screen> 2171 2073 </listitem> 2172 2074 … … 2176 2078 </para> 2177 2079 2178 <screen> VBoxManage setextradata "VM name"2179 2180 VBoxManage setextradata "VM name" 2181 2080 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2081 "VBoxInternal/Devices/pcbios/0/Config/DmiProcManufacturer" "GenuineIntel" 2082 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2083 "VBoxInternal/Devices/pcbios/0/Config/DmiProcVersion" "Pentium(R) III"</screen> 2182 2084 </listitem> 2183 2085 … … 2187 2089 </para> 2188 2090 2189 <screen> VBoxManage setextradata "VM name"2190 2191 VBoxManage setextradata "VM name" 2192 2091 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2092 "VBoxInternal/Devices/pcbios/0/Config/DmiOEMVBoxVer" "vboxVer_1.2.3" 2093 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2094 "VBoxInternal/Devices/pcbios/0/Config/DmiOEMVBoxRev" "vboxRev_12345"</screen> 2193 2095 </listitem> 2194 2096 … … 2198 2100 If a DMI string is not set, the default value of &product-name; is 2199 2101 used. To set an empty string use 2200 < computeroutput>"<EMPTY>"</computeroutput>.2102 <literal>"<EMPTY>"</literal>. 2201 2103 </para> 2202 2104 … … 2206 2108 strings. If such a string is a valid number, the parameter is 2207 2109 treated as number and the VM will most probably refuse to start 2208 with an < computeroutput>VERR_CFGM_NOT_STRING</computeroutput>2209 error. In thatcase, use2210 < computeroutput>"string:<value>"</computeroutput>. For2110 with an <literal>VERR_CFGM_NOT_STRING</literal> error. In that 2111 case, use 2112 <literal>"string:<replaceable>value</replaceable>"</literal>. For 2211 2113 example: 2212 2114 </para> 2213 2115 2214 <screen> VBoxManage setextradata "VM name"2215 2116 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2117 "VBoxInternal/Devices/pcbios/0/Config/DmiSystemSerial" "string:1234"</screen> 2216 2118 2217 2119 <para> … … 2222 2124 </para> 2223 2125 2224 <screen> dmidecode -t0</screen>2126 <screen>$ dmidecode -t0</screen> 2225 2127 2226 2128 <para> … … 2228 2130 </para> 2229 2131 2230 <screen> dmidecode -t1</screen>2132 <screen>$ dmidecode -t1</screen> 2231 2133 2232 2134 </sect1> … … 2237 2139 2238 2140 <para> 2239 &product-name; can be configured to present up to four custom ACPI 2240 tables to the guest. A command such as the following can be used 2241 to configure custom ACPI tables. Note that CustomTable1, 2242 CustomTable2, and CustomTable3 are available in addition to 2243 CustomTable0. 2244 </para> 2245 2246 <screen>VBoxManage setextradata "VM name" 2141 You can configure &product-name; to present up to four custom ACPI 2142 tables to the guest. Use a command such as the following to 2143 configure custom ACPI tables. Note that 2144 <literal>CustomTable1</literal>, <literal>CustomTable2</literal>, 2145 and <literal>CustomTable3</literal> are available in addition to 2146 <literal>CustomTable0</literal>. 2147 </para> 2148 2149 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 2247 2150 "VBoxInternal/Devices/acpi/0/Config/CustomTable0" "/path/to/table.bin"</screen> 2248 2151 … … 2252 2155 8 and later guests. On Linux hosts, one of the system's ACPI 2253 2156 tables can be read from 2254 < computeroutput>/sys/firmware/acpi/tables/</computeroutput>.2157 <filename>/sys/firmware/acpi/tables/</filename>. 2255 2158 </para> 2256 2159 … … 2283 2186 </para> 2284 2187 2285 <screen> VBoxManage setextradata "VM name""VBoxInternal/TM/TSCTiedToExecution" 1</screen>2188 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxInternal/TM/TSCTiedToExecution" 1</screen> 2286 2189 2287 2190 <para> … … 2289 2192 </para> 2290 2193 2291 <screen> VBoxManage setextradata "VM name""VBoxInternal/TM/TSCTiedToExecution"</screen>2194 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxInternal/TM/TSCTiedToExecution"</screen> 2292 2195 2293 2196 <para> … … 2311 2214 </para> 2312 2215 2313 <screen> VBoxManage setextradata "VM name""VBoxInternal/TM/WarpDrivePercentage" 200</screen>2216 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxInternal/TM/WarpDrivePercentage" 200</screen> 2314 2217 2315 2218 <para> … … 2317 2220 </para> 2318 2221 2319 <screen> VBoxManage setextradata "VM name""VBoxInternal/TM/WarpDrivePercentage" 50</screen>2222 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxInternal/TM/WarpDrivePercentage" 50</screen> 2320 2223 2321 2224 <para> … … 2347 2250 </para> 2348 2251 2349 <screen>VBoxManage guestproperty set "VM name" "/VirtualBox/GuestAdd/VBoxService/PARAMETER" VALUE</screen> 2350 2351 <para> 2352 where <computeroutput>PARAMETER</computeroutput> is one of the 2353 following: 2252 <screen>$ VBoxManage guestproperty set <replaceable>VM-name</replaceable> "/VirtualBox/GuestAdd/VBoxService/<replaceable>property</replaceable>" <replaceable>value</replaceable></screen> 2253 2254 <para> 2255 <replaceable>property</replaceable> is one of the following: 2354 2256 </para> 2355 2257 … … 2358 2260 <varlistentry> 2359 2261 <term> 2360 < computeroutput>--timesync-interval</computeroutput>2262 <option>--timesync-interval</option> 2361 2263 </term> 2362 2264 … … 2371 2273 <varlistentry> 2372 2274 <term> 2373 < computeroutput>--timesync-min-adjust</computeroutput>2275 <option>--timesync-min-adjust</option> 2374 2276 </term> 2375 2277 … … 2385 2287 <varlistentry> 2386 2288 <term> 2387 < computeroutput>--timesync-latency-factor</computeroutput>2289 <option>--timesync-latency-factor</option> 2388 2290 </term> 2389 2291 … … 2408 2310 <varlistentry> 2409 2311 <term> 2410 < computeroutput>--timesync-max-latency</computeroutput>2312 <option>--timesync-max-latency</option> 2411 2313 </term> 2412 2314 … … 2421 2323 <varlistentry> 2422 2324 <term> 2423 < computeroutput>--timesync-set-threshold</computeroutput>2325 <option>--timesync-set-threshold</option> 2424 2326 </term> 2425 2327 … … 2435 2337 <varlistentry> 2436 2338 <term> 2437 < computeroutput>--timesync-set-start</computeroutput>2339 <option>--timesync-set-start</option> 2438 2340 </term> 2439 2341 … … 2447 2349 <varlistentry> 2448 2350 <term> 2449 <computeroutput>--timesync-set-on-restore 2450 0|1</computeroutput> 2351 <option>--timesync-set-on-restore 0|1</option> 2451 2352 </term> 2452 2353 … … 2481 2382 </para> 2482 2383 2483 <screen> VBoxManage setextradata "VM name""VBoxInternal/Devices/VMMDev/0/Config/GetHostTimeDisabled" 1</screen>2384 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxInternal/Devices/VMMDev/0/Config/GetHostTimeDisabled" 1</screen> 2484 2385 2485 2386 </sect2> … … 2490 2391 2491 2392 <title>Installing the Alternate Bridged Networking Driver on Oracle Solaris 11 2492 hosts</title>2393 Hosts</title> 2493 2394 2494 2395 <para> 2495 2396 &product-name; includes a network filter driver that utilizes 2496 2397 Oracle Solaris 11's Crossbow functionality. By default, this new 2497 driver is installed for Oracle Solaris 11 hosts , builds 159 and2498 above, that have supportfor it.2398 driver is installed for Oracle Solaris 11 hosts that have support 2399 for it. 2499 2400 </para> 2500 2401 … … 2505 2406 </para> 2506 2407 2507 <screen> touch /etc/vboxinst_vboxflt</screen>2408 <screen>$ touch /etc/vboxinst_vboxflt</screen> 2508 2409 2509 2410 <para> … … 2513 2414 </para> 2514 2415 2515 <screen> touch /etc/vboxinst_vboxbow</screen>2416 <screen>$ touch /etc/vboxinst_vboxbow</screen> 2516 2417 2517 2418 <para> … … 2520 2421 </para> 2521 2422 2522 <screen> modinfo | grep vbox</screen>2423 <screen>$ modinfo | grep vbox</screen> 2523 2424 2524 2425 <para> … … 2538 2439 for configuring VMs over VLANs. An &product-name; VNIC template is 2539 2440 a VNIC whose name starts with 2540 < computeroutput>vboxvnic_template</computeroutput>. The string is2441 <filename>vboxvnic_template</filename>. The string is 2541 2442 case-sensitive. 2542 2443 </para> … … 2554 2455 </para> 2555 2456 2556 <screen> dladm create-vnic -t -l nge0 -v 23 vboxvnic_template0</screen>2557 2558 <para> 2559 This will create a temporary VNIC template over interface "nge0"2560 with the VLAN ID 23. To create VNIC templates that are persistent2561 across host reboots, skip the <computeroutput>-t</computeroutput>2562 parameter in the above command. You may check the current state of2563 links using the following command:2457 <screen># dladm create-vnic -t -l nge0 -v 23 vboxvnic_template0</screen> 2458 2459 <para> 2460 This will create a temporary VNIC template over interface 2461 <command>nge0</command> with the VLAN ID 23. To create VNIC 2462 templates that are persistent across host reboots, skip the 2463 <option>-t</option> parameter in the above command. You may check 2464 the current state of links using the following command: 2564 2465 </para> 2565 2466 … … 2576 2477 <para> 2577 2478 Once the VNIC template is created, any VMs that need to be on VLAN 2578 23 over the interface <com puteroutput>nge0</computeroutput> can be2579 configured tobridge using this VNIC template.2479 23 over the interface <command>nge0</command> can be configured to 2480 bridge using this VNIC template. 2580 2481 </para> 2581 2482 … … 2590 2491 <para> 2591 2492 VNIC templates can be created with additional properties such as 2592 bandwidth limits, CPU fanout etc. Refer to your Oracle Solaris 2593 network documentation on how to accomplish this. These additional 2594 properties, if any, are also applied to VMs which bridge using the 2595 VNIC template. 2493 bandwidth limits and CPU fanout. Refer to your Oracle Solaris 2494 network documentation for details. The additional properties are 2495 also applied to VMs which bridge using the VNIC template. 2596 2496 </para> 2597 2497 … … 2615 2515 </para> 2616 2516 2617 <screen> ifconfig vboxnet0 unplumb</screen>2517 <screen># ifconfig vboxnet0 unplumb</screen> 2618 2518 2619 2519 <para> … … 2623 2523 </para> 2624 2524 2625 <screen> rem_drv vboxnet</screen>2525 <screen># rem_drv vboxnet</screen> 2626 2526 2627 2527 <para> 2628 2528 Edit the file 2629 <computeroutput>/platform/i86pc/kernel/drv/vboxnet.conf</computeroutput> 2630 and add a line for the new interface we want to add as shown 2631 below: 2529 <filename>/platform/i86pc/kernel/drv/vboxnet.conf</filename> and 2530 add a line for the new interface we want to add as shown below: 2632 2531 </para> 2633 2532 … … 2645 2544 </para> 2646 2545 2647 <screen> add_drv vboxnet</screen>2546 <screen># add_drv vboxnet</screen> 2648 2547 2649 2548 <para> … … 2653 2552 </para> 2654 2553 2655 <screen> dladm show-phys2554 <screen>$ dladm show-phys 2656 2555 LINK MEDIA STATE SPEED DUPLEX DEVICE 2657 2556 net0 Ethernet up 100 full e1000g0 … … 2665 2564 </para> 2666 2565 2667 <screen> dladm rename-link net2 vboxnet1</screen>2668 2669 <para> 2670 Now plumb all the interfaces using <com puteroutput>ifconfig2671 vboxnet X plumb</computeroutput>, where 'X' would be 1 in this2672 case. Once the interface is plumbed, it may be configured like any2673 other network interface. Refer to the2674 <computeroutput>ifconfig</computeroutput> documentation for2675 f urther details.2566 <screen># dladm rename-link net2 vboxnet1</screen> 2567 2568 <para> 2569 Now plumb all the interfaces using <command>ifconfig 2570 vboxnet<replaceable>X</replaceable> plumb</command>, where 2571 <replaceable>X</replaceable> would be 1 in this case. Once the 2572 interface is plumbed, it may be configured like any other network 2573 interface. Refer to the <command>ifconfig</command> documentation 2574 for further details. 2676 2575 </para> 2677 2576 … … 2679 2578 To make the settings for the newly added interfaces persistent 2680 2579 across reboots, you will need to edit the files 2681 <computeroutput>/etc/inet/netmasks</computeroutput>, and if you 2682 are using NWAM <computeroutput>/etc/nwam/llp</computeroutput> and 2683 add the appropriate entries to set the netmask and static IP for 2684 each of those interfaces. The &product-name; installer only 2685 updates these configuration files for the one "vboxnet0" interface 2686 it creates by default. 2580 <filename>/etc/inet/netmasks</filename>, and if you are using NWAM 2581 <filename>/etc/nwam/llp</filename> and add the appropriate entries 2582 to set the netmask and static IP for each of those interfaces. The 2583 &product-name; installer only updates these configuration files 2584 for the one "vboxnet0" interface it creates by default. 2687 2585 </para> 2688 2586 … … 2704 2602 </para> 2705 2603 2706 <screen> VBoxManage setextradata "VM name"VBoxInternal2/CoreDumpEnabled 1</screen>2604 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> VBoxInternal2/CoreDumpEnabled 1</screen> 2707 2605 2708 2606 <para> … … 2711 2609 </para> 2712 2610 2713 <screen> VBoxManage setextradata "VM name" VBoxInternal2/CoreDumpDir <path-to-directory></screen>2611 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> VBoxInternal2/CoreDumpDir <replaceable>path-to-directory</replaceable></screen> 2714 2612 2715 2613 <para> … … 2729 2627 </para> 2730 2628 2731 <screen> VBoxManage setextradata "VM name"VBoxInternal2/CoreDumpReplaceSystemDump 12732 VBoxManage setextradata "VM name"VBoxInternal2/CoreDumpLive 1</screen>2629 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> VBoxInternal2/CoreDumpReplaceSystemDump 1 2630 $ VBoxManage setextradata <replaceable>VM-name</replaceable> VBoxInternal2/CoreDumpLive 1</screen> 2733 2631 2734 2632 <para> … … 2738 2636 2739 2637 <para> 2740 Setting <computeroutput>CoreDumpReplaceSystemDump</computeroutput> 2741 sets up the VM to override the host's core dumping mechanism and 2742 in the event of any crash only the &product-name; CoreDumper would 2743 produce the core file. 2744 </para> 2745 2746 <para> 2747 Setting <computeroutput>CoreDumpLive</computeroutput> sets up the 2748 VM to produce cores whenever the VM process receives a 2749 <computeroutput>SIGUSR2</computeroutput> signal. After producing 2750 the core file, the VM will not be terminated and will continue to 2751 run. You can thus take cores of the VM process using the following 2752 command: 2753 </para> 2754 2755 <screen>kill -s SIGUSR2 <VM-process-id></screen> 2756 2757 <para> 2758 Core files produced by the &product-name; CoreDumper are of the 2759 form 2760 <computeroutput>core.vb.<ProcessName>.<ProcessID></computeroutput>, 2761 for example 2762 <computeroutput>core.vb.VBoxHeadless.11321</computeroutput>. 2638 Setting <literal>CoreDumpReplaceSystemDump</literal> sets up the 2639 VM to override the host's core dumping mechanism and in the event 2640 of any crash only the &product-name; CoreDumper would produce the 2641 core file. 2642 </para> 2643 2644 <para> 2645 Setting <literal>CoreDumpLive</literal> sets up the VM to produce 2646 cores whenever the VM process receives a 2647 <literal>SIGUSR2</literal> signal. After producing the core file, 2648 the VM will not be terminated and will continue to run. You can 2649 thus take cores of the VM process using the following command: 2650 </para> 2651 2652 <screen>$ kill -s SIGUSR2 <replaceable>VM-process-id</replaceable></screen> 2653 2654 <para> 2655 The &product-name; CoreDumper creates core files of the form 2656 <filename>core.vb.<replaceable>process-name</replaceable>.<replaceable>process-ID</replaceable></filename> 2657 such as <filename>core.vb.VBoxHeadless.11321</filename>. 2763 2658 </para> 2764 2659 … … 2793 2688 </para> 2794 2689 2795 <screen> VBoxManage setproperty hwvirtexclusive off</screen>2690 <screen>$ VBoxManage setproperty hwvirtexclusive off</screen> 2796 2691 2797 2692 <para> … … 2818 2713 </para> 2819 2714 2820 <screen>VBoxManage setextradata global GUI/Customizations OPTION[,OPTION...]</screen>2821 2822 <para> 2823 where <computeroutput>OPTION</computeroutput> is one of the2824 following keywords:2715 <screen>VBoxManage setextradata global GUI/Customizations <replaceable>property</replaceable>[,<replaceable>property</replaceable> ...]</screen> 2716 2717 <para> 2718 <replaceable>property</replaceable> is one of the following 2719 properties: 2825 2720 </para> 2826 2721 … … 2829 2724 <varlistentry> 2830 2725 <term> 2831 < computeroutput>noSelector</computeroutput>2726 <literal>noSelector</literal> 2832 2727 </term> 2833 2728 … … 2843 2738 <varlistentry> 2844 2739 <term> 2845 < computeroutput>noMenuBar</computeroutput>2740 <literal>noMenuBar</literal> 2846 2741 </term> 2847 2742 … … 2855 2750 <varlistentry> 2856 2751 <term> 2857 < computeroutput>noStatusBar</computeroutput>2752 <literal>noStatusBar</literal> 2858 2753 </term> 2859 2754 … … 2872 2767 </para> 2873 2768 2874 <screen> VBoxManage setextradata global GUI/Customizations</screen>2769 <screen>$ VBoxManage setextradata global GUI/Customizations</screen> 2875 2770 2876 2771 </sect2> … … 2886 2781 </para> 2887 2782 2888 <screen> VBoxManage setextradata "VM name" SETTINGtrue</screen>2889 2890 <para> 2891 where <computeroutput>SETTING</computeroutput> can be:2783 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> <replaceable>property</replaceable> true</screen> 2784 2785 <para> 2786 <replaceable>property</replaceable> can be any of the following: 2892 2787 </para> 2893 2788 … … 2896 2791 <varlistentry> 2897 2792 <term> 2898 < computeroutput>GUI/HideDetails</computeroutput>2793 <literal>GUI/HideDetails</literal> 2899 2794 </term> 2900 2795 … … 2910 2805 <varlistentry> 2911 2806 <term> 2912 < computeroutput>GUI/PreventReconfiguration</computeroutput>2807 <literal>GUI/PreventReconfiguration</literal> 2913 2808 </term> 2914 2809 … … 2924 2819 <varlistentry> 2925 2820 <term> 2926 < computeroutput>GUI/PreventSnapshotOperations</computeroutput>2821 <literal>GUI/PreventSnapshotOperations</literal> 2927 2822 </term> 2928 2823 … … 2937 2832 <varlistentry> 2938 2833 <term> 2939 < computeroutput>GUI/HideFromManager</computeroutput>2834 <literal>GUI/HideFromManager</literal> 2940 2835 </term> 2941 2836 … … 2949 2844 <varlistentry> 2950 2845 <term> 2951 < computeroutput>GUI/PreventApplicationUpdate</computeroutput>2846 <literal>GUI/PreventApplicationUpdate</literal> 2952 2847 </term> 2953 2848 … … 2963 2858 2964 2859 <para> 2965 Please note that these settings wouldnot prevent the user from2966 reconfiguring the VM by using <command>VBoxManage2967 modifyvm</command> .2860 Note that these settings do not prevent the user from 2861 reconfiguring the VM by using the <command>VBoxManage 2862 modifyvm</command> command. 2968 2863 </para> 2969 2864 … … 2979 2874 </para> 2980 2875 2981 <screen>VBoxManage setextradata global GUI/RestrictedGlobalSettingsPages OPTION[,OPTION...]</screen> 2982 2983 <para> 2984 where <computeroutput>OPTION</computeroutput> is one of the 2985 following keywords: 2876 <screen>$ VBoxManage setextradata global GUI/RestrictedGlobalSettingsPages <replaceable>property</replaceable>[,<replaceable>property</replaceable>...]</screen> 2877 2878 <para> 2879 <replaceable>property</replaceable> is one of the following: 2986 2880 </para> 2987 2881 … … 2990 2884 <varlistentry> 2991 2885 <term> 2992 < computeroutput>General</computeroutput>2886 <literal>General</literal> 2993 2887 </term> 2994 2888 … … 3003 2897 <varlistentry> 3004 2898 <term> 3005 < computeroutput>Input</computeroutput>2899 <literal>Input</literal> 3006 2900 </term> 3007 2901 … … 3016 2910 <varlistentry> 3017 2911 <term> 3018 < computeroutput>Update</computeroutput>2912 <literal>Update</literal> 3019 2913 </term> 3020 2914 … … 3029 2923 <varlistentry> 3030 2924 <term> 3031 < computeroutput>Language</computeroutput>2925 <literal>Language</literal> 3032 2926 </term> 3033 2927 … … 3042 2936 <varlistentry> 3043 2937 <term> 3044 < computeroutput>Display</computeroutput>2938 <literal>Display</literal> 3045 2939 </term> 3046 2940 … … 3055 2949 <varlistentry> 3056 2950 <term> 3057 < computeroutput>Network</computeroutput>2951 <literal>Network</literal> 3058 2952 </term> 3059 2953 … … 3068 2962 <varlistentry> 3069 2963 <term> 3070 < computeroutput>Extensions</computeroutput>2964 <literal>Extensions</literal> 3071 2965 </term> 3072 2966 … … 3081 2975 <varlistentry> 3082 2976 <term> 3083 < computeroutput>Proxy</computeroutput>2977 <literal>Proxy</literal> 3084 2978 </term> 3085 2979 … … 3095 2989 3096 2990 <para> 3097 This is a global setting. Any combination of the above is 3098 allowed. To restore the default behavior, use 3099 </para> 3100 3101 <screen>VBoxManage setextradata global GUI/RestrictedGlobalSettingsPages</screen> 2991 This is a global setting. You can specify any combination of 2992 properties. To restore the default behavior, use the following 2993 command: 2994 </para> 2995 2996 <screen>$ VBoxManage setextradata global GUI/RestrictedGlobalSettingsPages</screen> 3102 2997 3103 2998 </sect2> … … 3115 3010 3116 3011 <para> 3117 where < computeroutput>OPTION</computeroutput> is one of the3118 followingkeywords:3012 where <literal>OPTION</literal> is one of the following 3013 keywords: 3119 3014 </para> 3120 3015 … … 3123 3018 <varlistentry> 3124 3019 <term> 3125 < computeroutput>All</computeroutput>3020 <literal>All</literal> 3126 3021 </term> 3127 3022 … … 3135 3030 <varlistentry> 3136 3031 <term> 3137 <computeroutput>Application</computeroutput> 3138 </term> 3139 3140 <listitem> 3141 <para> 3142 Do not show <emphasis role="bold">Application/File</emphasis> menu in the VM window. 3143 </para> 3144 </listitem> 3145 </varlistentry> 3146 3147 <varlistentry> 3148 <term> 3149 <computeroutput>Machine</computeroutput> 3032 <literal>Application</literal> 3033 </term> 3034 3035 <listitem> 3036 <para> 3037 Do not show 3038 <emphasis role="bold">Application/File</emphasis> menu in 3039 the VM window. 3040 </para> 3041 </listitem> 3042 </varlistentry> 3043 3044 <varlistentry> 3045 <term> 3046 <literal>Machine</literal> 3150 3047 </term> 3151 3048 … … 3160 3057 <varlistentry> 3161 3058 <term> 3162 < computeroutput>View</computeroutput>3059 <literal>View</literal> 3163 3060 </term> 3164 3061 … … 3173 3070 <varlistentry> 3174 3071 <term> 3175 <computeroutput>Input</computeroutput> 3176 </term> 3177 3178 <listitem> 3179 <para> 3180 Do not show <emphasis role="bold">Input</emphasis> menu in the VM window. 3181 </para> 3182 </listitem> 3183 </varlistentry> 3184 3185 <varlistentry> 3186 <term> 3187 <computeroutput>Devices</computeroutput> 3072 <literal>Input</literal> 3073 </term> 3074 3075 <listitem> 3076 <para> 3077 Do not show <emphasis role="bold">Input</emphasis> menu in 3078 the VM window. 3079 </para> 3080 </listitem> 3081 </varlistentry> 3082 3083 <varlistentry> 3084 <term> 3085 <literal>Devices</literal> 3188 3086 </term> 3189 3087 … … 3198 3096 <varlistentry> 3199 3097 <term> 3200 < computeroutput>Help</computeroutput>3098 <literal>Help</literal> 3201 3099 </term> 3202 3100 … … 3211 3109 <varlistentry> 3212 3110 <term> 3213 < computeroutput>Debug</computeroutput>3111 <literal>Debug</literal> 3214 3112 </term> 3215 3113 … … 3227 3125 3228 3126 <para> 3229 This is a per-VM or global setting. Any combination of the above is 3230 allowed. To restore the default behavior, use 3127 This is a per-VM or global setting. Any combination of the above 3128 is allowed. To restore the default behavior, use the following 3129 command: 3231 3130 </para> 3232 3131 … … 3243 3142 3244 3143 <para> 3245 where < computeroutput>OPTION</computeroutput> is one of the3246 followingkeywords:3144 where <literal>OPTION</literal> is one of the following 3145 keywords: 3247 3146 </para> 3248 3147 … … 3251 3150 <varlistentry> 3252 3151 <term> 3253 < computeroutput>All</computeroutput>3152 <literal>All</literal> 3254 3153 </term> 3255 3154 … … 3263 3162 <varlistentry> 3264 3163 <term> 3265 < computeroutput>About</computeroutput>3164 <literal>About</literal> 3266 3165 </term> 3267 3166 … … 3276 3175 <varlistentry> 3277 3176 <term> 3278 <computeroutput>Preferences</computeroutput> 3279 </term> 3280 3281 <listitem> 3282 <para> 3283 Do not show the <emphasis role="bold">Preferences</emphasis> 3284 menu item in this menu. 3285 </para> 3286 </listitem> 3287 </varlistentry> 3288 3289 <varlistentry> 3290 <term> 3291 <computeroutput>NetworkAccessManager</computeroutput> 3292 </term> 3293 3294 <listitem> 3295 <para> 3296 Do not show the <emphasis role="bold">Network Operations Manager</emphasis> 3297 menu item in this menu. 3298 </para> 3299 </listitem> 3300 </varlistentry> 3301 3302 <varlistentry> 3303 <term> 3304 <computeroutput>ResetWarnings</computeroutput> 3305 </term> 3306 3307 <listitem> 3308 <para> 3309 Do not show the <emphasis role="bold">Reset All Warnings</emphasis> 3310 menu item in this menu. 3311 </para> 3312 </listitem> 3313 </varlistentry> 3314 3315 <varlistentry> 3316 <term> 3317 <computeroutput>Close</computeroutput> 3177 <literal>Preferences</literal> 3178 </term> 3179 3180 <listitem> 3181 <para> 3182 Do not show the 3183 <emphasis role="bold">Preferences</emphasis> menu item in 3184 this menu. 3185 </para> 3186 </listitem> 3187 </varlistentry> 3188 3189 <varlistentry> 3190 <term> 3191 <literal>NetworkAccessManager</literal> 3192 </term> 3193 3194 <listitem> 3195 <para> 3196 Do not show the <emphasis role="bold">Network Operations 3197 Manager</emphasis> menu item in this menu. 3198 </para> 3199 </listitem> 3200 </varlistentry> 3201 3202 <varlistentry> 3203 <term> 3204 <literal>ResetWarnings</literal> 3205 </term> 3206 3207 <listitem> 3208 <para> 3209 Do not show the <emphasis role="bold">Reset All 3210 Warnings</emphasis> menu item in this menu. 3211 </para> 3212 </listitem> 3213 </varlistentry> 3214 3215 <varlistentry> 3216 <term> 3217 <literal>Close</literal> 3318 3218 </term> 3319 3219 … … 3329 3229 3330 3230 <para> 3331 This is a per-VM or global setting. Any combination of the above is 3332 allowed. To restore the default behavior, use 3231 This is a per-VM or global setting. Any combination of the above 3232 is allowed. To restore the default behavior, use the following 3233 command: 3333 3234 </para> 3334 3235 … … 3343 3244 3344 3245 <para> 3345 where < computeroutput>OPTION</computeroutput> is one of the3346 followingkeywords:3246 where <literal>OPTION</literal> is one of the following 3247 keywords: 3347 3248 </para> 3348 3249 … … 3351 3252 <varlistentry> 3352 3253 <term> 3353 < computeroutput>All</computeroutput>3254 <literal>All</literal> 3354 3255 </term> 3355 3256 … … 3363 3264 <varlistentry> 3364 3265 <term> 3365 < computeroutput>SettingsDialog</computeroutput>3266 <literal>SettingsDialog</literal> 3366 3267 </term> 3367 3268 … … 3376 3277 <varlistentry> 3377 3278 <term> 3378 < computeroutput>TakeSnapshot</computeroutput>3279 <literal>TakeSnapshot</literal> 3379 3280 </term> 3380 3281 … … 3389 3290 <varlistentry> 3390 3291 <term> 3391 < computeroutput>InformationDialog</computeroutput>3292 <literal>InformationDialog</literal> 3392 3293 </term> 3393 3294 … … 3402 3303 <varlistentry> 3403 3304 <term> 3404 < computeroutput>FileManagerDialog</computeroutput>3305 <literal>FileManagerDialog</literal> 3405 3306 </term> 3406 3307 … … 3413 3314 </varlistentry> 3414 3315 3415 3416 <varlistentry>3417 <term>3418 <computeroutput>Pause</computeroutput>3419 </term> 3420 3421 <listitem>3422 <para>3423 Do not show the <emphasis role="bold">Pause</emphasis>menu item in this menu.3424 </para> 3425 </listitem> 3426 </varlistentry> 3427 3428 <varlistentry> 3429 <term> 3430 < computeroutput>Reset</computeroutput>3431 </term> 3432 3433 <listitem> 3434 <para> 3435 Do not show the <emphasis role="bold">Reset</emphasis> menu item in this menu.3436 </para>3437 </listitem>3438 </varlistentry>3439 3440 3441 <varlistentry> 3442 <term> 3443 < computeroutput>Shutdown</computeroutput>3316 <varlistentry> 3317 <term> 3318 <literal>Pause</literal> 3319 </term> 3320 3321 <listitem> 3322 <para> 3323 Do not show the <emphasis role="bold">Pause</emphasis> 3324 menu item in this menu. 3325 </para> 3326 </listitem> 3327 </varlistentry> 3328 3329 <varlistentry> 3330 <term> 3331 <literal>Reset</literal> 3332 </term> 3333 3334 <listitem> 3335 <para> 3336 Do not show the <emphasis role="bold">Reset</emphasis> 3337 menu item in this menu. 3338 </para> 3339 </listitem> 3340 </varlistentry> 3341 3342 <varlistentry> 3343 <term> 3344 <literal>Shutdown</literal> 3444 3345 </term> 3445 3346 … … 3455 3356 3456 3357 <para> 3457 This is a per-VM or global setting. Any combination of the above is3458 allowed. To restore the default behavior, use3358 This is a per-VM or global setting. Any combination of the above 3359 is allowed. To restore the default behavior, use 3459 3360 </para> 3460 3361 … … 3469 3370 3470 3371 <para> 3471 where < computeroutput>OPTION</computeroutput> is one of the3472 followingkeywords:3372 where <literal>OPTION</literal> is one of the following 3373 keywords: 3473 3374 </para> 3474 3375 … … 3477 3378 <varlistentry> 3478 3379 <term> 3479 < computeroutput>All</computeroutput>3380 <literal>All</literal> 3480 3381 </term> 3481 3382 … … 3489 3390 <varlistentry> 3490 3391 <term> 3491 <computeroutput>Fullscreen</computeroutput> 3492 </term> 3493 3494 <listitem> 3495 <para> 3496 Do not show the <emphasis role="bold">Full-screen Mode</emphasis> menu item in this menu. 3497 </para> 3498 </listitem> 3499 </varlistentry> 3500 3501 <varlistentry> 3502 <term> 3503 <computeroutput>Seamless</computeroutput> 3392 <literal>Fullscreen</literal> 3393 </term> 3394 3395 <listitem> 3396 <para> 3397 Do not show the <emphasis role="bold">Full-screen 3398 Mode</emphasis> menu item in this menu. 3399 </para> 3400 </listitem> 3401 </varlistentry> 3402 3403 <varlistentry> 3404 <term> 3405 <literal>Seamless</literal> 3504 3406 </term> 3505 3407 … … 3514 3416 <varlistentry> 3515 3417 <term> 3516 < computeroutput>Scale</computeroutput>3418 <literal>Scale</literal> 3517 3419 </term> 3518 3420 … … 3527 3429 <varlistentry> 3528 3430 <term> 3529 < computeroutput>GuestAutoresize</computeroutput>3431 <literal>GuestAutoresize</literal> 3530 3432 </term> 3531 3433 … … 3540 3442 <varlistentry> 3541 3443 <term> 3542 < computeroutput>AdjustWindow</computeroutput>3444 <literal>AdjustWindow</literal> 3543 3445 </term> 3544 3446 … … 3553 3455 <varlistentry> 3554 3456 <term> 3555 <computeroutput>TakeScreenshot</computeroutput> 3556 </term> 3557 3558 <listitem> 3559 <para> 3560 Do not show the 3561 <emphasis role="bold">Take Screenshot...</emphasis> menu item in 3562 this menu. 3563 </para> 3564 </listitem> 3565 </varlistentry> 3566 3567 <varlistentry> 3568 <term> 3569 <computeroutput>Recording</computeroutput> 3570 </term> 3571 3572 <listitem> 3573 <para> 3574 Do not show the 3575 <emphasis role="bold">Recording</emphasis> menu item in 3576 this menu. 3577 </para> 3578 </listitem> 3579 </varlistentry> 3580 3581 <varlistentry> 3582 <term> 3583 <computeroutput>VRDEServer</computeroutput> 3584 </term> 3585 3586 <listitem> 3587 <para> 3588 Do not show the 3589 <emphasis role="bold">Remote Display</emphasis> menu item in 3590 this menu. 3591 </para> 3592 </listitem> 3593 </varlistentry> 3594 3595 <varlistentry> 3596 <term> 3597 <computeroutput>MenuBar</computeroutput> 3598 </term> 3599 3600 <listitem> 3601 <para> 3602 Do not show the 3603 <emphasis role="bold">Menu Bar</emphasis> menu item in 3604 this menu. 3605 </para> 3606 </listitem> 3607 </varlistentry> 3608 3609 <varlistentry> 3610 <term> 3611 <computeroutput>MenuBarSettings</computeroutput> 3612 </term> 3613 3614 <listitem> 3615 <para> 3616 Do not show the 3617 <emphasis role="bold">Menu Bar Settings...</emphasis> menu item in 3618 this menu. 3619 </para> 3620 </listitem> 3621 </varlistentry> 3622 3623 <varlistentry> 3624 <term> 3625 <computeroutput>StatusBar</computeroutput> 3626 </term> 3627 3628 <listitem> 3629 <para> 3630 Do not show the 3631 <emphasis role="bold">Status Bar</emphasis> menu item in 3632 this menu. 3633 </para> 3634 </listitem> 3635 </varlistentry> 3636 3637 <varlistentry> 3638 <term> 3639 <computeroutput>StatusbarSettings</computeroutput> 3640 </term> 3641 3642 <listitem> 3643 <para> 3644 Do not show the 3645 <emphasis role="bold">Statusbar Settings...</emphasis> menu item in 3646 this menu. 3457 <literal>TakeScreenshot</literal> 3458 </term> 3459 3460 <listitem> 3461 <para> 3462 Do not show the <emphasis role="bold">Take 3463 Screenshot...</emphasis> menu item in this menu. 3464 </para> 3465 </listitem> 3466 </varlistentry> 3467 3468 <varlistentry> 3469 <term> 3470 <literal>Recording</literal> 3471 </term> 3472 3473 <listitem> 3474 <para> 3475 Do not show the <emphasis role="bold">Recording</emphasis> 3476 menu item in this menu. 3477 </para> 3478 </listitem> 3479 </varlistentry> 3480 3481 <varlistentry> 3482 <term> 3483 <literal>VRDEServer</literal> 3484 </term> 3485 3486 <listitem> 3487 <para> 3488 Do not show the <emphasis role="bold">Remote 3489 Display</emphasis> menu item in this menu. 3490 </para> 3491 </listitem> 3492 </varlistentry> 3493 3494 <varlistentry> 3495 <term> 3496 <literal>MenuBar</literal> 3497 </term> 3498 3499 <listitem> 3500 <para> 3501 Do not show the <emphasis role="bold">Menu Bar</emphasis> 3502 menu item in this menu. 3503 </para> 3504 </listitem> 3505 </varlistentry> 3506 3507 <varlistentry> 3508 <term> 3509 <literal>MenuBarSettings</literal> 3510 </term> 3511 3512 <listitem> 3513 <para> 3514 Do not show the <emphasis role="bold">Menu Bar 3515 Settings...</emphasis> menu item in this menu. 3516 </para> 3517 </listitem> 3518 </varlistentry> 3519 3520 <varlistentry> 3521 <term> 3522 <literal>StatusBar</literal> 3523 </term> 3524 3525 <listitem> 3526 <para> 3527 Do not show the <emphasis role="bold">Status 3528 Bar</emphasis> menu item in this menu. 3529 </para> 3530 </listitem> 3531 </varlistentry> 3532 3533 <varlistentry> 3534 <term> 3535 <literal>StatusbarSettings</literal> 3536 </term> 3537 3538 <listitem> 3539 <para> 3540 Do not show the <emphasis role="bold">Statusbar 3541 Settings...</emphasis> menu item in this menu. 3647 3542 </para> 3648 3543 </listitem> … … 3652 3547 3653 3548 <para> 3654 This is a per-VM or global setting. Any combination of the above is3655 allowed. To restore the default behavior, use3656 </para> 3657 3658 3659 3660 <para>3549 This is a per-VM or global setting. Any combination of the above 3550 is allowed. To restore the default behavior, use 3551 </para> 3552 3553 <screen>VBoxManage setextradata "VM name"|global GUI/RestrictedRuntimeViewMenuActions</screen> 3554 3555 <para> 3661 3556 Use the following command to disable certain actions of the 3662 3557 <emphasis role="bold">Input</emphasis> menu: … … 3666 3561 3667 3562 <para> 3668 where < computeroutput>OPTION</computeroutput> is one of the3669 followingkeywords:3563 where <literal>OPTION</literal> is one of the following 3564 keywords: 3670 3565 </para> 3671 3566 … … 3674 3569 <varlistentry> 3675 3570 <term> 3676 < computeroutput>All</computeroutput>3571 <literal>All</literal> 3677 3572 </term> 3678 3573 … … 3685 3580 3686 3581 <varlistentry> 3687 <term> 3688 <computeroutput>Keyboard</computeroutput> 3689 </term> 3690 3691 <listitem> 3692 <para> 3693 Do not show the 3694 <emphasis role="bold">Keyboard</emphasis> menu item in 3695 this menu. 3696 </para> 3697 </listitem> 3698 </varlistentry> 3699 3700 <varlistentry> 3701 <term> 3702 <computeroutput>KeyboardSettings</computeroutput> 3703 </term> 3704 3705 <listitem> 3706 <para> 3707 Do not show the 3708 <emphasis role="bold">Keyboard Settings...</emphasis> menu item in 3709 this menu. 3710 </para> 3711 </listitem> 3712 </varlistentry> 3713 3714 <varlistentry> 3715 <term> 3716 <computeroutput>SoftKeyboard</computeroutput> 3717 </term> 3718 3719 <listitem> 3720 <para> 3721 Do not show the 3722 <emphasis role="bold">Soft Keyboard...</emphasis> menu item in 3723 this menu. 3724 </para> 3725 </listitem> 3726 </varlistentry> 3727 3728 <varlistentry> 3729 <term> 3730 <computeroutput>TypeCAD</computeroutput> 3731 </term> 3732 3733 <listitem> 3734 <para> 3735 Do not show the 3736 <emphasis role="bold">Insert Ctrl-Alt-Del</emphasis> menu item in 3737 this menu. 3738 </para> 3739 </listitem> 3740 </varlistentry> 3741 3742 <varlistentry> 3743 <term> 3744 <computeroutput>TypeCABS</computeroutput> 3745 </term> 3746 3747 <listitem> 3748 <para> 3749 Do not show the 3750 <emphasis role="bold">Insert Ctrl-Alt-Backspace</emphasis> menu item in 3751 this menu. 3752 </para> 3753 </listitem> 3754 </varlistentry> 3755 3756 <varlistentry> 3757 <term> 3758 <computeroutput>TypeCtrlBreak</computeroutput> 3759 </term> 3760 3761 <listitem> 3762 <para> 3763 Do not show the 3764 <emphasis role="bold">Insert Ctrl-Break</emphasis> menu item in 3765 this menu. 3766 </para> 3767 </listitem> 3768 </varlistentry> 3769 3770 <varlistentry> 3771 <term> 3772 <computeroutput>TypeInsert</computeroutput> 3773 </term> 3774 3775 <listitem> 3776 <para> 3777 Do not show the 3778 <emphasis role="bold">Insert Insert</emphasis> menu item in 3779 this menu. 3780 </para> 3781 </listitem> 3782 </varlistentry> 3783 3784 <varlistentry> 3785 <term> 3786 <computeroutput>TypePrintScreen</computeroutput> 3787 </term> 3788 3789 <listitem> 3790 <para> 3791 Do not show the 3792 <emphasis role="bold">Insert Print Screen</emphasis> menu item in 3793 this menu. 3794 </para> 3795 </listitem> 3796 </varlistentry> 3797 3798 <varlistentry> 3799 <term> 3800 <computeroutput>TypeAltPrintScreen</computeroutput> 3801 </term> 3802 3803 <listitem> 3804 <para> 3805 Do not show the 3806 <emphasis role="bold">Insert Alt Print Screen</emphasis> menu item in 3807 this menu. 3808 </para> 3809 </listitem> 3810 </varlistentry> 3811 3812 <varlistentry> 3813 <term> 3814 <computeroutput>TypeHostKeyCombo</computeroutput> 3815 </term> 3816 3817 <listitem> 3818 <para> 3819 Do not show the 3820 <emphasis role="bold">Insert Host Key Combo</emphasis> menu item in 3821 this menu. 3822 </para> 3823 </listitem> 3824 </varlistentry> 3825 3826 <varlistentry> 3827 <term> 3828 <computeroutput>MouseIntegration</computeroutput> 3829 </term> 3830 3831 <listitem> 3832 <para> 3833 Do not show the 3834 <emphasis role="bold">MouseIntegration</emphasis> menu item in 3835 this menu. 3836 </para> 3837 </listitem> 3582 <term> 3583 <literal>Keyboard</literal> 3584 </term> 3585 3586 <listitem> 3587 <para> 3588 Do not show the <emphasis role="bold">Keyboard</emphasis> 3589 menu item in this menu. 3590 </para> 3591 </listitem> 3592 </varlistentry> 3593 3594 <varlistentry> 3595 <term> 3596 <literal>KeyboardSettings</literal> 3597 </term> 3598 3599 <listitem> 3600 <para> 3601 Do not show the <emphasis role="bold">Keyboard 3602 Settings...</emphasis> menu item in this menu. 3603 </para> 3604 </listitem> 3605 </varlistentry> 3606 3607 <varlistentry> 3608 <term> 3609 <literal>SoftKeyboard</literal> 3610 </term> 3611 3612 <listitem> 3613 <para> 3614 Do not show the <emphasis role="bold">Soft 3615 Keyboard...</emphasis> menu item in this menu. 3616 </para> 3617 </listitem> 3618 </varlistentry> 3619 3620 <varlistentry> 3621 <term> 3622 <literal>TypeCAD</literal> 3623 </term> 3624 3625 <listitem> 3626 <para> 3627 Do not show the <emphasis role="bold">Insert 3628 Ctrl-Alt-Del</emphasis> menu item in this menu. 3629 </para> 3630 </listitem> 3631 </varlistentry> 3632 3633 <varlistentry> 3634 <term> 3635 <literal>TypeCABS</literal> 3636 </term> 3637 3638 <listitem> 3639 <para> 3640 Do not show the <emphasis role="bold">Insert 3641 Ctrl-Alt-Backspace</emphasis> menu item in this menu. 3642 </para> 3643 </listitem> 3644 </varlistentry> 3645 3646 <varlistentry> 3647 <term> 3648 <literal>TypeCtrlBreak</literal> 3649 </term> 3650 3651 <listitem> 3652 <para> 3653 Do not show the <emphasis role="bold">Insert 3654 Ctrl-Break</emphasis> menu item in this menu. 3655 </para> 3656 </listitem> 3657 </varlistentry> 3658 3659 <varlistentry> 3660 <term> 3661 <literal>TypeInsert</literal> 3662 </term> 3663 3664 <listitem> 3665 <para> 3666 Do not show the <emphasis role="bold">Insert 3667 Insert</emphasis> menu item in this menu. 3668 </para> 3669 </listitem> 3670 </varlistentry> 3671 3672 <varlistentry> 3673 <term> 3674 <literal>TypePrintScreen</literal> 3675 </term> 3676 3677 <listitem> 3678 <para> 3679 Do not show the <emphasis role="bold">Insert Print 3680 Screen</emphasis> menu item in this menu. 3681 </para> 3682 </listitem> 3683 </varlistentry> 3684 3685 <varlistentry> 3686 <term> 3687 <literal>TypeAltPrintScreen</literal> 3688 </term> 3689 3690 <listitem> 3691 <para> 3692 Do not show the <emphasis role="bold">Insert Alt Print 3693 Screen</emphasis> menu item in this menu. 3694 </para> 3695 </listitem> 3696 </varlistentry> 3697 3698 <varlistentry> 3699 <term> 3700 <literal>TypeHostKeyCombo</literal> 3701 </term> 3702 3703 <listitem> 3704 <para> 3705 Do not show the <emphasis role="bold">Insert Host Key 3706 Combo</emphasis> menu item in this menu. 3707 </para> 3708 </listitem> 3709 </varlistentry> 3710 3711 <varlistentry> 3712 <term> 3713 <literal>MouseIntegration</literal> 3714 </term> 3715 3716 <listitem> 3717 <para> 3718 Do not show the 3719 <emphasis role="bold">MouseIntegration</emphasis> menu 3720 item in this menu. 3721 </para> 3722 </listitem> 3838 3723 </varlistentry> 3839 3724 3840 3725 </variablelist> 3841 <para> 3842 This is a per-VM or global setting. Any combination of the above is 3843 allowed. To restore the default behavior, use 3844 </para> 3845 3846 <screen>VBoxManage setextradata "VM name"|global GUI/RestrictedRuntimeInputMenuActions</screen> 3726 3727 <para> 3728 This is a per-VM or global setting. Any combination of the above 3729 is allowed. To restore the default behavior, use 3730 </para> 3731 3732 <screen>VBoxManage setextradata "VM name"|global GUI/RestrictedRuntimeInputMenuActions</screen> 3847 3733 3848 3734 <para> … … 3854 3740 3855 3741 <para> 3856 where < computeroutput>OPTION</computeroutput> is one of the3857 following keywordsto disable actions in the3742 where <literal>OPTION</literal> is one of the following keywords 3743 to disable actions in the 3858 3744 <emphasis role="bold">Devices</emphasis> menu: 3859 3745 </para> … … 3863 3749 <varlistentry> 3864 3750 <term> 3865 < computeroutput>All</computeroutput>3751 <literal>All</literal> 3866 3752 </term> 3867 3753 … … 3875 3761 <varlistentry> 3876 3762 <term> 3877 <computeroutput>HardDrives</computeroutput> 3878 </term> 3879 3880 <listitem> 3881 <para> 3882 Do not show the <emphasis role="bold">Hard Disks</emphasis> menu item in this menu. 3883 </para> 3884 </listitem> 3885 </varlistentry> 3886 3887 <varlistentry> 3888 <term> 3889 <computeroutput>OpticalDevices</computeroutput> 3763 <literal>HardDrives</literal> 3764 </term> 3765 3766 <listitem> 3767 <para> 3768 Do not show the <emphasis role="bold">Hard 3769 Disks</emphasis> menu item in this menu. 3770 </para> 3771 </listitem> 3772 </varlistentry> 3773 3774 <varlistentry> 3775 <term> 3776 <literal>OpticalDevices</literal> 3890 3777 </term> 3891 3778 … … 3900 3787 <varlistentry> 3901 3788 <term> 3902 < computeroutput>FloppyDevices</computeroutput>3789 <literal>FloppyDevices</literal> 3903 3790 </term> 3904 3791 … … 3913 3800 <varlistentry> 3914 3801 <term> 3915 <computeroutput>Audio</computeroutput> 3916 </term> 3917 3918 <listitem> 3919 <para> 3920 Do not show the <emphasis role="bold">Audio</emphasis> 3921 menu item in this menu. 3922 </para> 3923 </listitem> 3924 </varlistentry> 3925 3926 <varlistentry> 3927 <term> 3928 <computeroutput>Network</computeroutput> 3929 </term> 3930 3931 <listitem> 3932 <para> 3933 Do not show the <emphasis role="bold">Network</emphasis> 3934 menu item in this menu. 3935 </para> 3936 </listitem> 3937 </varlistentry> 3938 3939 3940 <varlistentry> 3941 <term> 3942 <computeroutput>NetworkSettings</computeroutput> 3802 <literal>Audio</literal> 3803 </term> 3804 3805 <listitem> 3806 <para> 3807 Do not show the <emphasis role="bold">Audio</emphasis> 3808 menu item in this menu. 3809 </para> 3810 </listitem> 3811 </varlistentry> 3812 3813 <varlistentry> 3814 <term> 3815 <literal>Network</literal> 3816 </term> 3817 3818 <listitem> 3819 <para> 3820 Do not show the <emphasis role="bold">Network</emphasis> 3821 menu item in this menu. 3822 </para> 3823 </listitem> 3824 </varlistentry> 3825 3826 <varlistentry> 3827 <term> 3828 <literal>NetworkSettings</literal> 3943 3829 </term> 3944 3830 … … 3953 3839 <varlistentry> 3954 3840 <term> 3955 < computeroutput>USBDevices</computeroutput>3956 </term> 3957 3958 <listitem> 3959 <para> 3960 Do not show the <emphasis role="bold">USB 3961 </emphasis> menuitem in this menu.3962 </para> 3963 </listitem> 3964 </varlistentry> 3965 3966 <varlistentry> 3967 <term> 3968 < computeroutput>WebCams</computeroutput>3969 </term> 3970 3971 <listitem> 3972 <para> 3973 Do not show the <emphasis role="bold">WebCams 3974 </emphasis>menu item in this menu.3975 </para> 3976 </listitem> 3977 </varlistentry> 3978 3979 <varlistentry> 3980 <term> 3981 < computeroutput>SharedFolders</computeroutput>3982 </term> 3983 3984 <listitem> 3985 <para> 3986 Do not show the <emphasis role="bold">Shared Folders</emphasis>3987 3988 </para> 3989 </listitem> 3990 </varlistentry> 3991 3992 <varlistentry> 3993 <term> 3994 < computeroutput>SharedFoldersSettings</computeroutput>3841 <literal>USBDevices</literal> 3842 </term> 3843 3844 <listitem> 3845 <para> 3846 Do not show the <emphasis role="bold">USB </emphasis> menu 3847 item in this menu. 3848 </para> 3849 </listitem> 3850 </varlistentry> 3851 3852 <varlistentry> 3853 <term> 3854 <literal>WebCams</literal> 3855 </term> 3856 3857 <listitem> 3858 <para> 3859 Do not show the <emphasis role="bold">WebCams </emphasis> 3860 menu item in this menu. 3861 </para> 3862 </listitem> 3863 </varlistentry> 3864 3865 <varlistentry> 3866 <term> 3867 <literal>SharedFolders</literal> 3868 </term> 3869 3870 <listitem> 3871 <para> 3872 Do not show the <emphasis role="bold">Shared 3873 Folders</emphasis> menu item in this menu. 3874 </para> 3875 </listitem> 3876 </varlistentry> 3877 3878 <varlistentry> 3879 <term> 3880 <literal>SharedFoldersSettings</literal> 3995 3881 </term> 3996 3882 … … 4005 3891 <varlistentry> 4006 3892 <term> 4007 < computeroutput>SharedClipboard</computeroutput>3893 <literal>SharedClipboard</literal> 4008 3894 </term> 4009 3895 … … 4018 3904 <varlistentry> 4019 3905 <term> 4020 < computeroutput>DragAndDrop</computeroutput>3906 <literal>DragAndDrop</literal> 4021 3907 </term> 4022 3908 … … 4031 3917 <varlistentry> 4032 3918 <term> 4033 < computeroutput>InstallGuestTools</computeroutput>3919 <literal>InstallGuestTools</literal> 4034 3920 </term> 4035 3921 … … 4045 3931 4046 3932 <para> 4047 This is a per-VM or global setting. Any combination of the above is4048 allowed. To restore the default behavior, use3933 This is a per-VM or global or global setting. Any combination of 3934 the above is allowed. To restore the default behavior, use 4049 3935 </para> 4050 3936 … … 4059 3945 4060 3946 <para> 4061 where <computeroutput>OPTION</computeroutput> is one of the 4062 following keywords to disable actions in the 4063 <emphasis>Debug</emphasis> menu, which is normally completely 4064 disabled: 3947 where <literal>OPTION</literal> is one of the following keywords 3948 to disable actions in the <emphasis>Debug</emphasis> menu, which 3949 is normally completely disabled: 4065 3950 </para> 4066 3951 … … 4069 3954 <varlistentry> 4070 3955 <term> 4071 < computeroutput>All</computeroutput>3956 <literal>All</literal> 4072 3957 </term> 4073 3958 … … 4081 3966 <varlistentry> 4082 3967 <term> 4083 < computeroutput>Statistics</computeroutput>3968 <literal>Statistics</literal> 4084 3969 </term> 4085 3970 … … 4095 3980 <varlistentry> 4096 3981 <term> 4097 < computeroutput>CommandLine</computeroutput>3982 <literal>CommandLine</literal> 4098 3983 </term> 4099 3984 … … 4108 3993 <varlistentry> 4109 3994 <term> 4110 < computeroutput>Logging</computeroutput>3995 <literal>Logging</literal> 4111 3996 </term> 4112 3997 … … 4122 4007 <varlistentry> 4123 4008 <term> 4124 < computeroutput>LogDialog</computeroutput>4009 <literal>LogDialog</literal> 4125 4010 </term> 4126 4011 … … 4135 4020 <varlistentry> 4136 4021 <term> 4137 < computeroutput>GuestControlConsole</computeroutput>4022 <literal>GuestControlConsole</literal> 4138 4023 </term> 4139 4024 … … 4149 4034 4150 4035 <para> 4151 This is a per-VM or global setting. Any combination of the above is4152 allowed. To restore the default behavior, use4036 This is a per-VM or global setting. Any combination of the above 4037 is allowed. To restore the default behavior, use 4153 4038 </para> 4154 4039 … … 4163 4048 4164 4049 <para> 4165 where <computeroutput>OPTION</computeroutput> is one of the 4166 following keywords to disable actions in the 4167 <emphasis role="bold">Help</emphasis> menu, which is normally 4168 completely disabled: 4050 where <literal>OPTION</literal> is one of the following keywords 4051 to disable actions in the <emphasis role="bold">Help</emphasis> 4052 menu, which is normally completely disabled: 4169 4053 </para> 4170 4054 … … 4173 4057 <varlistentry> 4174 4058 <term> 4175 < computeroutput>All</computeroutput>4059 <literal>All</literal> 4176 4060 </term> 4177 4061 … … 4185 4069 <varlistentry> 4186 4070 <term> 4187 < computeroutput>Contents</computeroutput>4071 <literal>Contents</literal> 4188 4072 </term> 4189 4073 … … 4199 4083 <varlistentry> 4200 4084 <term> 4201 < computeroutput>WebSite</computeroutput>4085 <literal>WebSite</literal> 4202 4086 </term> 4203 4087 … … 4211 4095 4212 4096 <varlistentry> 4213 4214 <computeroutput>BugTracker</computeroutput>4215 4216 4217 4218 4219 Do not show the4220 <emphasis role="bold">VirtualBox Bug Tracker...</emphasis> menu item in4221 this menu.4222 </para>4223 </listitem>4224 </varlistentry> 4225 4226 <varlistentry>4227 < term>4228 <computeroutput>Forums</computeroutput>4229 </term> 4230 4231 < listitem>4232 <para>4233 Do not show the4234 <emphasis role="bold">VirtualBox Forums...</emphasis> menu item in this menu.4235 </para>4236 </listitem>4237 </varlistentry> 4238 4239 <varlistentry>4240 < term>4241 <computeroutput>Oracle</computeroutput>4242 </term> 4243 4244 < listitem>4245 <para>4246 Do not show the4247 <emphasis role="bold">Oracle Web Site...</emphasis> menu item in this menu.4248 </para>4249 </listitem>4250 </varlistentry> 4251 4252 <varlistentry>4253 <term>4254 <computeroutput>About</computeroutput>4255 </term> 4256 4257 <listitem>4258 <para>4259 Do not show the <emphasis role="bold">About VirtualBox...</emphasis>4260 menu item in this menu. Only fornon-Mac OS X hosts.4097 <term> 4098 <literal>BugTracker</literal> 4099 </term> 4100 4101 <listitem> 4102 <para> 4103 Do not show the <emphasis role="bold">VirtualBox Bug 4104 Tracker...</emphasis> menu item in this menu. 4105 </para> 4106 </listitem> 4107 </varlistentry> 4108 4109 <varlistentry> 4110 <term> 4111 <literal>Forums</literal> 4112 </term> 4113 4114 <listitem> 4115 <para> 4116 Do not show the <emphasis role="bold">VirtualBox 4117 Forums...</emphasis> menu item in this menu. 4118 </para> 4119 </listitem> 4120 </varlistentry> 4121 4122 <varlistentry> 4123 <term> 4124 <literal>Oracle</literal> 4125 </term> 4126 4127 <listitem> 4128 <para> 4129 Do not show the <emphasis role="bold">Oracle Web 4130 Site...</emphasis> menu item in this menu. 4131 </para> 4132 </listitem> 4133 </varlistentry> 4134 4135 <varlistentry> 4136 <term> 4137 <literal>About</literal> 4138 </term> 4139 4140 <listitem> 4141 <para> 4142 Do not show the <emphasis role="bold">About 4143 VirtualBox...</emphasis> menu item in this menu. Only for 4144 non-Mac OS X hosts. 4261 4145 </para> 4262 4146 </listitem> … … 4266 4150 4267 4151 <para> 4268 This is a per-VM or global setting. Any combination of the above is4269 allowed. To restore the default behavior, use4152 This is a per-VM or global setting. Any combination of the above 4153 is allowed. To restore the default behavior, use 4270 4154 </para> 4271 4155 … … 4285 4169 4286 4170 <para> 4287 where < computeroutput>OPTION</computeroutput> is one of the4288 followingkeywords:4171 where <literal>OPTION</literal> is one of the following 4172 keywords: 4289 4173 </para> 4290 4174 … … 4293 4177 <varlistentry> 4294 4178 <term> 4295 < computeroutput>HardDisks</computeroutput>4179 <literal>HardDisks</literal> 4296 4180 </term> 4297 4181 … … 4307 4191 <varlistentry> 4308 4192 <term> 4309 < computeroutput>OpticalDisks</computeroutput>4193 <literal>OpticalDisks</literal> 4310 4194 </term> 4311 4195 … … 4321 4205 <varlistentry> 4322 4206 <term> 4323 < computeroutput>FloppyDisks</computeroutput>4207 <literal>FloppyDisks</literal> 4324 4208 </term> 4325 4209 … … 4335 4219 <varlistentry> 4336 4220 <term> 4337 < computeroutput>Network</computeroutput>4221 <literal>Network</literal> 4338 4222 </term> 4339 4223 … … 4350 4234 <varlistentry> 4351 4235 <term> 4352 < computeroutput>USB</computeroutput>4236 <literal>USB</literal> 4353 4237 </term> 4354 4238 … … 4362 4246 <varlistentry> 4363 4247 <term> 4364 < computeroutput>SharedFolders</computeroutput>4248 <literal>SharedFolders</literal> 4365 4249 </term> 4366 4250 … … 4374 4258 <varlistentry> 4375 4259 <term> 4376 < computeroutput>Capture</computeroutput>4260 <literal>Capture</literal> 4377 4261 </term> 4378 4262 … … 4386 4270 <varlistentry> 4387 4271 <term> 4388 < computeroutput>Features</computeroutput>4272 <literal>Features</literal> 4389 4273 </term> 4390 4274 … … 4398 4282 <varlistentry> 4399 4283 <term> 4400 < computeroutput>Mouse</computeroutput>4284 <literal>Mouse</literal> 4401 4285 </term> 4402 4286 … … 4410 4294 <varlistentry> 4411 4295 <term> 4412 < computeroutput>Keyboard</computeroutput>4296 <literal>Keyboard</literal> 4413 4297 </term> 4414 4298 … … 4423 4307 4424 4308 <para> 4425 This is a per-VM or global setting. Any combination of the above is4426 allowed. If all options are specified, no icons are displayed in4427 the status bar of the VM window. To restore the default4309 This is a per-VM or global setting. Any combination of the above 4310 is allowed. If all options are specified, no icons are displayed 4311 in the status bar of the VM window. To restore the default 4428 4312 behavior, use 4429 4313 </para> … … 4441 4325 </para> 4442 4326 4443 <screen>VBoxManage setextradata "VM name" GUI/RestrictedVisualStates OPTION[,OPTION...]</screen> 4444 4445 <para> 4446 where <computeroutput>OPTION</computeroutput> is one of the 4447 following keywords: 4327 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> GUI/RestrictedVisualStates <replaceable>property</replaceable>[,<replaceable>property</replaceable>...]</screen> 4328 4329 <para> 4330 <replaceable>property</replaceable> is one of the following: 4448 4331 </para> 4449 4332 … … 4452 4335 <varlistentry> 4453 4336 <term> 4454 < computeroutput>Fullscreen</computeroutput>4337 <literal>Fullscreen</literal> 4455 4338 </term> 4456 4339 … … 4464 4347 <varlistentry> 4465 4348 <term> 4466 < computeroutput>Seamless</computeroutput>4349 <literal>Seamless</literal> 4467 4350 </term> 4468 4351 … … 4476 4359 <varlistentry> 4477 4360 <term> 4478 < computeroutput>Scale</computeroutput>4361 <literal>Scale</literal> 4479 4362 </term> 4480 4363 … … 4489 4372 4490 4373 <para> 4491 This is a per-VM setting. Any combination of the above is 4492 allowed. To restore the default behavior, use 4493 </para> 4494 4495 <screen>VBoxManage setextradata "VM name" GUI/RestrictedVisualStates</screen> 4374 This is a per-VM setting. You can specify any combination of 4375 properties. To restore the default behavior, use the following 4376 command: 4377 </para> 4378 4379 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> GUI/RestrictedVisualStates</screen> 4496 4380 4497 4381 </sect2> … … 4512 4396 </para> 4513 4397 4514 <screen> VBoxManage setextradata global GUI/Input/MachineShortcuts "FullscreenMode=F,...."</screen>4398 <screen>$ VBoxManage setextradata global GUI/Input/MachineShortcuts "FullscreenMode=F,...."</screen> 4515 4399 4516 4400 <para> … … 4539 4423 <row> 4540 4424 <entry><para> 4541 < computeroutput>TakeSnapshot</computeroutput>4425 <literal>TakeSnapshot</literal> 4542 4426 </para></entry> 4543 4427 <entry><para> … … 4550 4434 <row> 4551 4435 <entry><para> 4552 < computeroutput>TakeScreenshot</computeroutput>4436 <literal>TakeScreenshot</literal> 4553 4437 </para></entry> 4554 4438 <entry><para> … … 4561 4445 <row> 4562 4446 <entry><para> 4563 < computeroutput>MouseIntegration</computeroutput>4447 <literal>MouseIntegration</literal> 4564 4448 </para></entry> 4565 4449 <entry><para> … … 4572 4456 <row> 4573 4457 <entry><para> 4574 < computeroutput>TypeCAD</computeroutput>4458 <literal>TypeCAD</literal> 4575 4459 </para></entry> 4576 4460 <entry><para> … … 4583 4467 <row> 4584 4468 <entry><para> 4585 < computeroutput>TypeCABS</computeroutput>4469 <literal>TypeCABS</literal> 4586 4470 </para></entry> 4587 4471 <entry><para> … … 4594 4478 <row> 4595 4479 <entry><para> 4596 < computeroutput>Pause</computeroutput>4480 <literal>Pause</literal> 4597 4481 </para></entry> 4598 4482 <entry><para> … … 4605 4489 <row> 4606 4490 <entry><para> 4607 < computeroutput>Reset</computeroutput>4491 <literal>Reset</literal> 4608 4492 </para></entry> 4609 4493 <entry><para> … … 4614 4498 <row> 4615 4499 <entry><para> 4616 < computeroutput>SaveState</computeroutput>4500 <literal>SaveState</literal> 4617 4501 </para></entry> 4618 4502 <entry><para></para></entry> … … 4623 4507 <row> 4624 4508 <entry><para> 4625 < computeroutput>Shutdown</computeroutput>4509 <literal>Shutdown</literal> 4626 4510 </para></entry> 4627 4511 <entry><para> … … 4634 4518 <row> 4635 4519 <entry><para> 4636 < computeroutput>PowerOff</computeroutput>4520 <literal>PowerOff</literal> 4637 4521 </para></entry> 4638 4522 <entry><para></para></entry> … … 4643 4527 <row> 4644 4528 <entry><para> 4645 < computeroutput>Close</computeroutput>4529 <literal>Close</literal> 4646 4530 </para></entry> 4647 4531 <entry><para> … … 4654 4538 <row> 4655 4539 <entry><para> 4656 < computeroutput>FullscreenMode</computeroutput>4540 <literal>FullscreenMode</literal> 4657 4541 </para></entry> 4658 4542 <entry><para> … … 4665 4549 <row> 4666 4550 <entry><para> 4667 < computeroutput>SeamlessMode</computeroutput>4551 <literal>SeamlessMode</literal> 4668 4552 </para></entry> 4669 4553 <entry><para> … … 4676 4560 <row> 4677 4561 <entry><para> 4678 < computeroutput>ScaleMode</computeroutput>4562 <literal>ScaleMode</literal> 4679 4563 </para></entry> 4680 4564 <entry><para> … … 4687 4571 <row> 4688 4572 <entry><para> 4689 < computeroutput>GuestAutoResize</computeroutput>4573 <literal>GuestAutoResize</literal> 4690 4574 </para></entry> 4691 4575 <entry><para> … … 4698 4582 <row> 4699 4583 <entry><para> 4700 < computeroutput>WindowAdjust</computeroutput>4584 <literal>WindowAdjust</literal> 4701 4585 </para></entry> 4702 4586 <entry><para> … … 4709 4593 <row> 4710 4594 <entry><para> 4711 < computeroutput>PopupMenu</computeroutput>4595 <literal>PopupMenu</literal> 4712 4596 </para></entry> 4713 4597 <entry><para> … … 4721 4605 <row> 4722 4606 <entry><para> 4723 < computeroutput>SettingsDialog</computeroutput>4607 <literal>SettingsDialog</literal> 4724 4608 </para></entry> 4725 4609 <entry><para> … … 4732 4616 <row> 4733 4617 <entry><para> 4734 < computeroutput>InformationDialog</computeroutput>4618 <literal>InformationDialog</literal> 4735 4619 </para></entry> 4736 4620 <entry><para> … … 4743 4627 <row> 4744 4628 <entry><para> 4745 < computeroutput>NetworkAdaptersDialog</computeroutput>4629 <literal>NetworkAdaptersDialog</literal> 4746 4630 </para></entry> 4747 4631 <entry><para></para></entry> … … 4752 4636 <row> 4753 4637 <entry><para> 4754 < computeroutput>SharedFoldersDialog</computeroutput>4638 <literal>SharedFoldersDialog</literal> 4755 4639 </para></entry> 4756 4640 <entry><para></para></entry> … … 4761 4645 <row> 4762 4646 <entry><para> 4763 < computeroutput>InstallGuestAdditions</computeroutput>4647 <literal>InstallGuestAdditions</literal> 4764 4648 </para></entry> 4765 4649 <entry><para> … … 4779 4663 </para> 4780 4664 4781 <screen> VBoxManage setextradata global GUI/Input/MachineShortcuts "FullscreenMode=None,SeamlessMode=None"</screen>4665 <screen>$ VBoxManage setextradata global GUI/Input/MachineShortcuts "FullscreenMode=None,SeamlessMode=None"</screen> 4782 4666 4783 4667 </sect2> … … 4792 4676 </para> 4793 4677 4794 <screen>VBoxManage setextradata "VM name" GUI/RestrictedCloseActions OPTION[,OPTION...]</screen> 4795 4796 <para> 4797 where <computeroutput>OPTION</computeroutput> is one of the 4798 following keywords: 4678 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> GUI/RestrictedCloseActions <replaceable>property</replaceable>[,<replaceable>property</replaceable>...]</screen> 4679 4680 <para> 4681 <replaceable>property</replaceable> is one of the following: 4799 4682 </para> 4800 4683 … … 4803 4686 <varlistentry> 4804 4687 <term> 4805 < computeroutput>SaveState</computeroutput>4688 <literal>SaveState</literal> 4806 4689 </term> 4807 4690 … … 4816 4699 <varlistentry> 4817 4700 <term> 4818 < computeroutput>Shutdown</computeroutput>4701 <literal>Shutdown</literal> 4819 4702 </term> 4820 4703 … … 4829 4712 <varlistentry> 4830 4713 <term> 4831 < computeroutput>PowerOff</computeroutput>4714 <literal>PowerOff</literal> 4832 4715 </term> 4833 4716 … … 4841 4724 <varlistentry> 4842 4725 <term> 4843 < computeroutput>PowerOffRestoringSnapshot</computeroutput>4726 <literal>PowerOffRestoringSnapshot</literal> 4844 4727 </term> 4845 4728 … … 4854 4737 <varlistentry> 4855 4738 <term> 4856 < computeroutput>Detach</computeroutput>4739 <literal>Detach</literal> 4857 4740 </term> 4858 4741 … … 4868 4751 4869 4752 <para> 4870 This is a per-VM setting. Any combination of the above is4871 allowed. If all options are specified, the VM cannot be shut4872 down at all.4753 This is a per-VM setting. You can specify any combination of 4754 properties. If all properties are specified, the VM cannot be 4755 shut down. 4873 4756 </para> 4874 4757 … … 4886 4769 </para> 4887 4770 4888 <screen>VBoxManage setextradata "VM name" GUI/DefaultCloseAction ACTION</screen> 4889 4890 <para> 4891 where <computeroutput>ACTION</computeroutput> is one of the 4892 following keywords: 4771 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> GUI/DefaultCloseAction <replaceable>action</replaceable></screen> 4772 4773 <para> 4774 <replaceable>action</replaceable> is one of the following: 4893 4775 </para> 4894 4776 … … 4897 4779 <varlistentry> 4898 4780 <term> 4899 < computeroutput>SaveState</computeroutput>4781 <literal>SaveState</literal> 4900 4782 </term> 4901 4783 … … 4909 4791 <varlistentry> 4910 4792 <term> 4911 < computeroutput>Shutdown</computeroutput>4793 <literal>Shutdown</literal> 4912 4794 </term> 4913 4795 … … 4922 4804 <varlistentry> 4923 4805 <term> 4924 < computeroutput>PowerOff</computeroutput>4806 <literal>PowerOff</literal> 4925 4807 </term> 4926 4808 … … 4934 4816 <varlistentry> 4935 4817 <term> 4936 < computeroutput>PowerOffRestoringSnapshot</computeroutput>4818 <literal>PowerOffRestoringSnapshot</literal> 4937 4819 </term> 4938 4820 … … 4947 4829 <varlistentry> 4948 4830 <term> 4949 < computeroutput>Detach</computeroutput>4831 <literal>Detach</literal> 4950 4832 </term> 4951 4833 … … 4960 4842 4961 4843 <para> 4962 This is a per-VM setting. Any combination of the above is4963 allowed. If all options are specified, the VM cannot be shut4964 down at all.4844 This is a per-VM setting. You can specify any combination of 4845 properties. If all properties are specified, the VM cannot be 4846 shut down. 4965 4847 </para> 4966 4848 … … 4982 4864 </para> 4983 4865 4984 <screen>VBoxManage setextradata "VM name" GUI/GuruMeditationHandler MODE</screen> 4985 4986 <para> 4987 where <computeroutput>MODE</computeroutput> is one of the 4988 following keywords: 4866 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> GUI/GuruMeditationHandler <replaceable>mode</replaceable></screen> 4867 4868 <para> 4869 <replaceable>mode</replaceable> is one of the following: 4989 4870 </para> 4990 4871 … … 4993 4874 <varlistentry> 4994 4875 <term> 4995 < computeroutput>Default</computeroutput>4876 <literal>Default</literal> 4996 4877 </term> 4997 4878 … … 5006 4887 <varlistentry> 5007 4888 <term> 5008 < computeroutput>PowerOff</computeroutput>4889 <literal>PowerOff</literal> 5009 4890 </term> 5010 4891 … … 5020 4901 <varlistentry> 5021 4902 <term> 5022 < computeroutput>Ignore</computeroutput>4903 <literal>Ignore</literal> 5023 4904 </term> 5024 4905 … … 5062 4943 </para> 5063 4944 5064 <screen>VBoxManage setextradata "VM name" GUI/MouseCapturePolicy MODE</screen> 5065 5066 <para> 5067 where <computeroutput>MODE</computeroutput> is one of the 5068 following keywords: 4945 <screen>VBoxManage setextradata <replaceable>VM-name</replaceable> GUI/MouseCapturePolicy <replaceable>mode</replaceable></screen> 4946 4947 <para> 4948 <replaceable>mode</replaceable> is one of the following: 5069 4949 </para> 5070 4950 … … 5073 4953 <varlistentry> 5074 4954 <term> 5075 < computeroutput>Default</computeroutput>4955 <literal>Default</literal> 5076 4956 </term> 5077 4957 … … 5085 4965 <varlistentry> 5086 4966 <term> 5087 < computeroutput>HostComboOnly</computeroutput>4967 <literal>HostComboOnly</literal> 5088 4968 </term> 5089 4969 … … 5097 4977 <varlistentry> 5098 4978 <term> 5099 < computeroutput>Disabled</computeroutput>4979 <literal>Disabled</literal> 5100 4980 </term> 5101 4981 … … 5146 5026 <sect2 id="restrict-network-attachments"> 5147 5027 5148 <title>Removing Certain Modes of Networking from the GUI</title> 5149 5150 <para> 5151 It is possible to remove networking modes from 5152 &product-name; GUI. To achieve this: 5153 </para> 5154 5155 <screen>VBoxManage setextradata global GUI/RestrictedNetworkAttachmentTypes OPTION[,OPTION...]</screen> 5156 5157 <para> 5158 where <computeroutput>OPTION</computeroutput> is one of the 5159 following keywords: 5028 <title>Removing Certain Modes of Networking From the GUI</title> 5029 5030 <para> 5031 It is possible to remove networking modes from &product-name; 5032 GUI. To do this, use the following command: 5033 </para> 5034 5035 <screen>VBoxManage setextradata global GUI/RestrictedNetworkAttachmentTypes <replaceable>property</replaceable>[,<replaceable>property</replaceable>...]</screen> 5036 5037 <para> 5038 <replaceable>property</replaceable> is one of the following: 5160 5039 </para> 5161 5040 … … 5164 5043 <varlistentry> 5165 5044 <term> 5166 < computeroutput>NAT</computeroutput>5045 <literal>NAT</literal> 5167 5046 </term> 5168 5047 … … 5177 5056 <varlistentry> 5178 5057 <term> 5179 < computeroutput>NATNetwork</computeroutput>5180 </term> 5181 5182 <listitem> 5183 <para> 5184 Remove the <emphasis role="bold">NAT network</emphasis> option5185 from the GUI.5186 </para> 5187 </listitem> 5188 </varlistentry> 5189 5190 <varlistentry> 5191 <term> 5192 < computeroutput>BridgetAdapter</computeroutput>5193 </term> 5194 5195 <listitem> 5196 <para> 5197 Remove the <emphasis role="bold">Bridged networking</emphasis> option5198 from the GUI.5199 </para> 5200 </listitem> 5201 </varlistentry> 5202 5203 <varlistentry> 5204 <term> 5205 < computeroutput>InternalNetwork</computeroutput>5206 </term> 5207 5208 <listitem> 5209 <para> 5210 Remove the <emphasis role="bold">Internal networking</emphasis> option5211 from the GUI.5212 </para> 5213 </listitem> 5214 </varlistentry> 5215 5216 <varlistentry> 5217 <term> 5218 < computeroutput>HostOnlyAdapter</computeroutput>5219 </term> 5220 5221 <listitem> 5222 <para> 5223 Remove the <emphasis role="bold">Host Only networking</emphasis> option5224 from the GUI.5225 </para> 5226 </listitem> 5227 </varlistentry> 5228 5229 <varlistentry> 5230 <term> 5231 < computeroutput>GenericDriver</computeroutput>5232 </term> 5233 5234 <listitem> 5235 <para> 5236 Remove the <emphasis role="bold">Generic networking</emphasis> option5237 from the GUI.5058 <literal>NATNetwork</literal> 5059 </term> 5060 5061 <listitem> 5062 <para> 5063 Remove the <emphasis role="bold">NAT network</emphasis> 5064 option from the GUI. 5065 </para> 5066 </listitem> 5067 </varlistentry> 5068 5069 <varlistentry> 5070 <term> 5071 <literal>BridgedAdapter</literal> 5072 </term> 5073 5074 <listitem> 5075 <para> 5076 Remove the <emphasis role="bold">Bridged 5077 networking</emphasis> option from the GUI. 5078 </para> 5079 </listitem> 5080 </varlistentry> 5081 5082 <varlistentry> 5083 <term> 5084 <literal>InternalNetwork</literal> 5085 </term> 5086 5087 <listitem> 5088 <para> 5089 Remove the <emphasis role="bold">Internal 5090 networking</emphasis> option from the GUI. 5091 </para> 5092 </listitem> 5093 </varlistentry> 5094 5095 <varlistentry> 5096 <term> 5097 <literal>HostOnlyAdapter</literal> 5098 </term> 5099 5100 <listitem> 5101 <para> 5102 Remove the <emphasis role="bold">Host Only 5103 networking</emphasis> option from the GUI. 5104 </para> 5105 </listitem> 5106 </varlistentry> 5107 5108 <varlistentry> 5109 <term> 5110 <literal>GenericDriver</literal> 5111 </term> 5112 5113 <listitem> 5114 <para> 5115 Remove the <emphasis role="bold">Generic 5116 networking</emphasis> option from the GUI. 5238 5117 </para> 5239 5118 </listitem> … … 5242 5121 </variablelist> 5243 5122 5244 5245 <para>5246 This is a global setting. Any combination of the above is5247 allowed. To restore the default behavior, use5123 <para> 5124 This is a global setting. You can specify any combination of 5125 properties. To restore the default behavior, use the following 5126 command: 5248 5127 </para> 5249 5128 5250 5129 <screen>VBoxManage setextradata global GUI/RestrictedNetworkAttachmentTypes</screen> 5251 5130 5252 5253 5131 </sect2> 5132 5254 5133 </sect1> 5255 5134 … … 5259 5138 5260 5139 <para> 5261 The &product-name; web service, 5262 <computeroutput>vboxwebsrv</computeroutput>, is used for 5263 controlling &product-name; remotely. It is documented in detail in 5264 the &product-name; Software Development Kit (SDK). See 5265 <xref linkend="VirtualBoxAPI" />. As the client base using this 5266 interface is growing, we added start scripts for the various 5267 operation systems we support. The following sections describe how 5268 to use them. The &product-name; web service is never started 5269 automatically as a result of a standard installation. 5140 The &product-name; web service, <command>vboxwebsrv</command>, is 5141 used for controlling &product-name; remotely. It is documented in 5142 detail in the &product-name; Software Development Kit (SDK). See 5143 <xref linkend="VirtualBoxAPI" />. Web service start scripts are 5144 available for supported host operating systems. The following 5145 sections describe how to use the scripts. The &product-name; web 5146 service is never started automatically as a result of a standard 5147 installation. 5270 5148 </para> 5271 5149 … … 5277 5155 On Linux, the web service can be automatically started during 5278 5156 host boot by adding appropriate parameters to the file 5279 <computeroutput>/etc/default/virtualbox</computeroutput>. There 5280 is one mandatory parameter, 5281 <computeroutput>VBOXWEB_USER</computeroutput>, which must be set 5282 to the user which will later start the VMs. The parameters in 5283 the following table all start with the 5284 <computeroutput>VBOXWEB_</computeroutput> prefix string. For 5285 example: <computeroutput>VBOXWEB_HOST</computeroutput> and 5286 <computeroutput>VBOXWEB_PORT</computeroutput>. 5157 <filename>/etc/default/virtualbox</filename>. There is one 5158 mandatory parameter, <literal>VBOXWEB_USER</literal>, which must 5159 be set to the user which will later start the VMs. The 5160 parameters in the following table all start with the 5161 <literal>VBOXWEB_</literal> prefix string. For example: 5162 <literal>VBOXWEB_HOST</literal> and 5163 <literal>VBOXWEB_PORT</literal>. 5287 5164 </para> 5288 5165 … … 5306 5183 <row> 5307 5184 <entry><para> 5308 < computeroutput>USER</computeroutput>5185 <literal>USER</literal> 5309 5186 </para></entry> 5310 5187 <entry><para> … … 5315 5192 <row> 5316 5193 <entry><para> 5317 < computeroutput>HOST</computeroutput>5194 <literal>HOST</literal> 5318 5195 </para></entry> 5319 5196 <entry><para> … … 5326 5203 <row> 5327 5204 <entry><para> 5328 < computeroutput>PORT</computeroutput>5205 <literal>PORT</literal> 5329 5206 </para></entry> 5330 5207 <entry><para> … … 5337 5214 <row> 5338 5215 <entry><para> 5339 < computeroutput>SSL_KEYFILE</computeroutput>5216 <literal>SSL_KEYFILE</literal> 5340 5217 </para></entry> 5341 5218 <entry><para> … … 5346 5223 <row> 5347 5224 <entry><para> 5348 < computeroutput>SSL_PASSWORDFILE</computeroutput>5225 <literal>SSL_PASSWORDFILE</literal> 5349 5226 </para></entry> 5350 5227 <entry><para> … … 5355 5232 <row> 5356 5233 <entry><para> 5357 < computeroutput>SSL_CACERT</computeroutput>5234 <literal>SSL_CACERT</literal> 5358 5235 </para></entry> 5359 5236 <entry><para> … … 5364 5241 <row> 5365 5242 <entry><para> 5366 < computeroutput>SSL_CAPATH</computeroutput>5243 <literal>SSL_CAPATH</literal> 5367 5244 </para></entry> 5368 5245 <entry><para> … … 5373 5250 <row> 5374 5251 <entry><para> 5375 < computeroutput>SSL_DHFILE</computeroutput>5252 <literal>SSL_DHFILE</literal> 5376 5253 </para></entry> 5377 5254 <entry><para> … … 5382 5259 <row> 5383 5260 <entry><para> 5384 < computeroutput>SSL_RANDFILE</computeroutput>5261 <literal>SSL_RANDFILE</literal> 5385 5262 </para></entry> 5386 5263 <entry><para> … … 5391 5268 <row> 5392 5269 <entry><para> 5393 < computeroutput>TIMEOUT</computeroutput>5270 <literal>TIMEOUT</literal> 5394 5271 </para></entry> 5395 5272 <entry><para> … … 5402 5279 <row> 5403 5280 <entry><para> 5404 < computeroutput>CHECK_INTERVAL</computeroutput>5281 <literal>CHECK_INTERVAL</literal> 5405 5282 </para></entry> 5406 5283 <entry><para> … … 5413 5290 <row> 5414 5291 <entry><para> 5415 < computeroutput>THREADS</computeroutput>5292 <literal>THREADS</literal> 5416 5293 </para></entry> 5417 5294 <entry><para> … … 5424 5301 <row> 5425 5302 <entry><para> 5426 < computeroutput>KEEPALIVE</computeroutput>5303 <literal>KEEPALIVE</literal> 5427 5304 </para></entry> 5428 5305 <entry><para> … … 5436 5313 <row> 5437 5314 <entry><para> 5438 < computeroutput>ROTATE</computeroutput>5315 <literal>ROTATE</literal> 5439 5316 </para></entry> 5440 5317 <entry><para> … … 5447 5324 <row> 5448 5325 <entry><para> 5449 < computeroutput>LOGSIZE</computeroutput>5326 <literal>LOGSIZE</literal> 5450 5327 </para></entry> 5451 5328 <entry><para> … … 5458 5335 <row> 5459 5336 <entry><para> 5460 < computeroutput>LOGINTERVAL</computeroutput>5337 <literal>LOGINTERVAL</literal> 5461 5338 </para></entry> 5462 5339 <entry><para> … … 5473 5350 5474 5351 <para> 5475 Setting the parameter 5476 <computeroutput>SSL_KEYFILE</computeroutput> enables the SSL/TLS5477 support. Using encryption is strongly encouraged, as otherwise5478 everything, including passwords, is transferred inclear text.5352 Setting the parameter <literal>SSL_KEYFILE</literal> enables the 5353 SSL/TLS support. Using encryption is strongly encouraged, as 5354 otherwise everything, including passwords, is transferred in 5355 clear text. 5479 5356 </para> 5480 5357 … … 5497 5374 5498 5375 <para> 5499 <xref linkend="table-websrv-config-params"/> showing the5376 The table in <xref linkend="vboxwebsrv-linux"/> showing the 5500 5377 parameter names and defaults also applies for Oracle Solaris. 5501 5378 The parameter names must be changed to lowercase and a prefix of 5502 < computeroutput>config/</computeroutput> has to be added. For5503 example: <computeroutput>config/user</computeroutput> or5504 < computeroutput>config/ssl_keyfile</computeroutput>. If you make5505 any change, do not forget to run the following command to put5506 the changesinto effect immediately:5379 <literal>config/</literal> has to be added. For example: 5380 <literal>config/user</literal> or 5381 <literal>config/ssl_keyfile</literal>. If you make any change, 5382 do not forget to run the following command to put the changes 5383 into effect immediately: 5507 5384 </para> 5508 5385 … … 5538 5415 On Mac OS X, launchd is used to start the &product-name; 5539 5416 webservice. An example configuration file can be found in 5540 <computeroutput>$HOME/Library/LaunchAgents/org.virtualbox.vboxwebsrv.plist</computeroutput>. 5541 It can be enabled by changing the 5542 <computeroutput>Disabled</computeroutput> key from 5543 <computeroutput>true</computeroutput> to 5544 <computeroutput>false</computeroutput>. To manually start the 5545 service use the following command: 5417 <filename>$HOME/Library/LaunchAgents/org.virtualbox.vboxwebsrv.plist</filename>. 5418 It can be enabled by changing the <literal>Disabled</literal> 5419 key from <literal>true</literal> to <literal>false</literal>. To 5420 manually start the service use the following command: 5546 5421 </para> 5547 5422 … … 5555 5430 <para> 5556 5431 <ulink 5557 url="https://developer.apple.com/library/mac/documentation/MacOSX/Conceptual/BPSystemStartup/Chapters/CreatingLaunchdJobs.html" >https://developer.apple.com/library/mac/documentation/MacOSX/Conceptual/BPSystemStartup/Chapters/CreatingLaunchdJobs.html</ulink>.5432 url="https://developer.apple.com/library/mac/documentation/MacOSX/Conceptual/BPSystemStartup/Chapters/CreatingLaunchdJobs.html" />. 5558 5433 </para> 5559 5434 … … 5568 5443 <para> 5569 5444 The memory ballooning service, formerly known as 5570 <com puteroutput>VBoxBalloonCtrl</computeroutput>, was renamed to5571 VBoxWatchdog. This service now incorporates the following host5572 services that aremeant to be run in a server environment:5445 <command>VBoxBalloonCtrl</command>, was renamed to VBoxWatchdog. 5446 This service now incorporates the following host services that are 5447 meant to be run in a server environment: 5573 5448 </para> 5574 5449 … … 5767 5642 <listitem> 5768 5643 <para> 5769 < computeroutput>none</computeroutput>. This has no effect.5644 <literal>none</literal>. This has no effect. 5770 5645 </para> 5771 5646 </listitem> … … 5773 5648 <listitem> 5774 5649 <para> 5775 <computeroutput>pause</computeroutput>. Pauses the execution 5776 of a VM. 5650 <literal>pause</literal>. Pauses the execution of a VM. 5777 5651 </para> 5778 5652 </listitem> … … 5780 5654 <listitem> 5781 5655 <para> 5782 < computeroutput>poweroff</computeroutput>. Shuts down the VM5783 by pressing the virtual power button. The VM will not have5784 the chance ofsaving any data or veto the shutdown process.5656 <literal>poweroff</literal>. Shuts down the VM by pressing 5657 the virtual power button. The VM will not have the chance of 5658 saving any data or veto the shutdown process. 5785 5659 </para> 5786 5660 </listitem> … … 5788 5662 <listitem> 5789 5663 <para> 5790 < computeroutput>save</computeroutput>. Saves the current5791 machine state and powers off the VM afterwards. If saving5792 the machine statefails the VM will be paused.5664 <literal>save</literal>. Saves the current machine state and 5665 powers off the VM afterwards. If saving the machine state 5666 fails the VM will be paused. 5793 5667 </para> 5794 5668 </listitem> … … 5796 5670 <listitem> 5797 5671 <para> 5798 <computeroutput>shutdown</computeroutput>. Shuts down the VM 5799 in a gentle way by sending an 5800 <computeroutput>ACPI</computeroutput> shutdown event to the 5801 VM's operating system. The OS then has the chance of doing a 5802 clean shutdown. 5672 <literal>shutdown</literal>. Shuts down the VM in a gentle 5673 way by sending an <literal>ACPI</literal> shutdown event to 5674 the VM's operating system. The OS then has the chance of 5675 doing a clean shutdown. 5803 5676 </para> 5804 5677 </listitem> … … 5815 5688 For more advanced options and parameters like verbose logging 5816 5689 check the built-in command line help accessible with 5817 < computeroutput>--help</computeroutput>.5690 <option>--help</option>. 5818 5691 </para> 5819 5692 … … 5827 5700 On Linux, the watchdog service can be automatically started 5828 5701 during host boot by adding appropriate parameters to the file 5829 <computeroutput>/etc/default/virtualbox</computeroutput>. There 5830 is one mandatory parameter, 5831 <computeroutput>VBOXWATCHDOG_USER</computeroutput>, which must 5832 be set to the user which will later start the VMs. For backward 5833 compatibility you can also specify 5834 <computeroutput>VBOXBALLOONCTRL_USER</computeroutput>. 5702 <filename>/etc/default/virtualbox</filename>. There is one 5703 mandatory parameter, <literal>VBOXWATCHDOG_USER</literal>, which 5704 must be set to the user which will later start the VMs. For 5705 backward compatibility you can also specify 5706 <literal>VBOXBALLOONCTRL_USER</literal>. 5835 5707 </para> 5836 5708 5837 5709 <para> 5838 5710 The parameters in the following table all start with the 5839 <computeroutput>VBOXWATCHDOG_</computeroutput> prefix string. 5840 For example: 5841 <computeroutput>VBOXWATCHDOG_BALLOON_INTERVAL</computeroutput> 5842 and <computeroutput>VBOXWATCHDOG_LOGSIZE</computeroutput>. 5843 Legacy parameters such as 5844 <computeroutput>VBOXBALLOONCTRL_INTERVAL</computeroutput> can 5845 still be used. 5711 <literal>VBOXWATCHDOG_</literal> prefix string. For example: 5712 <literal>VBOXWATCHDOG_BALLOON_INTERVAL</literal> and 5713 <literal>VBOXWATCHDOG_LOGSIZE</literal>. Legacy parameters such 5714 as <literal>VBOXBALLOONCTRL_INTERVAL</literal> can still be 5715 used. 5846 5716 </para> 5847 5717 … … 5865 5735 <row> 5866 5736 <entry><para> 5867 < computeroutput>USER</computeroutput>5737 <literal>USER</literal> 5868 5738 </para></entry> 5869 5739 <entry><para> … … 5874 5744 <row> 5875 5745 <entry><para> 5876 < computeroutput>ROTATE</computeroutput>5746 <literal>ROTATE</literal> 5877 5747 </para></entry> 5878 5748 <entry><para> … … 5885 5755 <row> 5886 5756 <entry><para> 5887 < computeroutput>LOGSIZE</computeroutput>5757 <literal>LOGSIZE</literal> 5888 5758 </para></entry> 5889 5759 <entry><para> … … 5896 5766 <row> 5897 5767 <entry><para> 5898 < computeroutput>LOGINTERVAL</computeroutput>5768 <literal>LOGINTERVAL</literal> 5899 5769 </para></entry> 5900 5770 <entry><para> … … 5908 5778 <row> 5909 5779 <entry><para> 5910 < computeroutput>BALLOON_INTERVAL</computeroutput>5780 <literal>BALLOON_INTERVAL</literal> 5911 5781 </para></entry> 5912 5782 <entry><para> … … 5920 5790 <row> 5921 5791 <entry><para> 5922 < computeroutput>BALLOON_INCREMENT</computeroutput>5792 <literal>BALLOON_INCREMENT</literal> 5923 5793 </para></entry> 5924 5794 <entry><para> … … 5931 5801 <row> 5932 5802 <entry><para> 5933 < computeroutput>BALLOON_DECREMENT</computeroutput>5803 <literal>BALLOON_DECREMENT</literal> 5934 5804 </para></entry> 5935 5805 <entry><para> … … 5942 5812 <row> 5943 5813 <entry><para> 5944 < computeroutput>BALLOON_LOWERLIMIT</computeroutput>5814 <literal>BALLOON_LOWERLIMIT</literal> 5945 5815 </para></entry> 5946 5816 <entry><para> … … 5953 5823 <row> 5954 5824 <entry><para> 5955 < computeroutput>BALLOON_SAFETYMARGIN</computeroutput>5825 <literal>BALLOON_SAFETYMARGIN</literal> 5956 5826 </para></entry> 5957 5827 <entry><para> … … 5988 5858 <xref linkend="table-vboxwatchdog-config-params"/> also applies 5989 5859 for Oracle Solaris. The parameter names must be changed to 5990 lowercase and a prefix of 5991 <computeroutput>config/</computeroutput> has to be added. For 5992 example: <computeroutput>config/user</computeroutput> or 5993 <computeroutput>config/balloon_safetymargin</computeroutput>. If 5994 you made any change, do not forget to run the following command 5995 to put the changes into effect immediately: 5860 lowercase and a prefix of <literal>config/</literal> has to be 5861 added. For example: <literal>config/user</literal> or 5862 <literal>config/balloon_safetymargin</literal>. If you made any 5863 change, do not forget to run the following command to put the 5864 changes into effect immediately: 5996 5865 </para> 5997 5866 … … 6061 5930 </para> 6062 5931 6063 <screen>VBoxManage modifyvm "VM name"--vrdeproperty VNCPassword=secret</screen>5932 <screen>VBoxManage modifyvm <replaceable>VM-name</replaceable> --vrdeproperty VNCPassword=secret</screen> 6064 5933 6065 5934 <para> … … 6095 5964 <para> 6096 5965 On Linux, the autostart service is activated by setting two 6097 variables in 6098 <computeroutput>/etc/default/virtualbox</computeroutput>. The 6099 first one is <computeroutput>VBOXAUTOSTART_DB</computeroutput> 6100 which contains an absolute path to the autostart database 6101 directory. The directory should have write access for every user 6102 who should be able to start virtual machines automatically. 6103 Furthermore the directory should have the sticky bit set. The 6104 second variable is 6105 <computeroutput>VBOXAUTOSTART_CONFIG</computeroutput> which 6106 points the service to the autostart configuration file which is 6107 used during boot to determine whether to allow individual users 6108 to start a VM automatically and configure startup delays. The 6109 configuration file can be placed in 6110 <computeroutput>/etc/vbox</computeroutput> and contains several 6111 options. One is <computeroutput>default_policy</computeroutput> 6112 which controls whether the autostart service allows or denies to 6113 start a VM for users which are not in the exception list. The 6114 exception list starts with 6115 <computeroutput>exception_list</computeroutput> and contains a 6116 comma separated list with usernames. Furthermore a separate 6117 startup delay can be configured for every user to avoid 6118 overloading the host. A sample configuration is given below: 5966 variables in <filename>/etc/default/virtualbox</filename>. The 5967 first one is <literal>VBOXAUTOSTART_DB</literal> which contains 5968 an absolute path to the autostart database directory. The 5969 directory should have write access for every user who should be 5970 able to start virtual machines automatically. Furthermore the 5971 directory should have the sticky bit set. The second variable is 5972 <literal>VBOXAUTOSTART_CONFIG</literal> which points the service 5973 to the autostart configuration file which is used during boot to 5974 determine whether to allow individual users to start a VM 5975 automatically and configure startup delays. The configuration 5976 file can be placed in <filename>/etc/vbox</filename> and 5977 contains several options. One is 5978 <literal>default_policy</literal> which controls whether the 5979 autostart service allows or denies to start a VM for users which 5980 are not in the exception list. The exception list starts with 5981 <literal>exception_list</literal> and contains a comma separated 5982 list with usernames. Furthermore a separate startup delay can be 5983 configured for every user to avoid overloading the host. A 5984 sample configuration is given below: 6119 5985 </para> 6120 5986 … … 6135 6001 allow = false 6136 6002 } 6137 6138 6139 <para> 6140 Every user who wants to enable autostart for individual machines6141 has toset the path to the autostart database directory with the6003 </screen> 6004 6005 <para> 6006 Any user who wants to enable autostart for individual machines 6007 must set the path to the autostart database directory with the 6142 6008 following command: 6143 6009 </para> 6144 6010 6145 <screen>VBoxManage setproperty autostartdbpath <Autostart directory></screen>6011 <screen>VBoxManage setproperty autostartdbpath <replaceable>autostart-directory</replaceable></screen> 6146 6012 6147 6013 </sect2> … … 6153 6019 <para> 6154 6020 On Oracle Solaris hosts, the &product-name; autostart daemon is 6155 integrated into the SMF framework. To enable it you have to6156 point the service to an existing configuration file which has6157 the same format as on Linux, see6158 <xref linkend="autostart-linux" />. Forexample:6159 </para> 6160 6161 <screen> svccfg -s svc:/application/virtualbox/autostart:default setprop \6021 integrated into the SMF framework. To enable it you must point 6022 the service to an existing configuration file which has the same 6023 format as on Linux, see <xref linkend="autostart-linux" />. For 6024 example: 6025 </para> 6026 6027 <screen># svccfg -s svc:/application/virtualbox/autostart:default setprop \ 6162 6028 config/config=/etc/vbox/autostart.cfg</screen> 6163 6029 … … 6167 6033 </para> 6168 6034 6169 <screen> svcadm enable svc:/application/virtualbox/autostart:default</screen>6170 6171 <para> 6172 For more information about SMF, please refer to the Oracle6173 Solarisdocumentation.6035 <screen># svcadm enable svc:/application/virtualbox/autostart:default</screen> 6036 6037 <para> 6038 For more information about SMF, see the Oracle Solaris 6039 documentation. 6174 6040 </para> 6175 6041 … … 6183 6049 On Mac OS X, launchd is used to start the &product-name; 6184 6050 autostart service. An example configuration file can be found in 6185 < computeroutput>/Applications/VirtualBox.app/Contents/MacOS/org.virtualbox.vboxautostart.plist</computeroutput>.6051 <filename>/Applications/VirtualBox.app/Contents/MacOS/org.virtualbox.vboxautostart.plist</filename>. 6186 6052 To enable the service copy the file to 6187 <computeroutput>/Library/LaunchDaemons</computeroutput> and 6188 change the <computeroutput>Disabled</computeroutput> key from 6189 <computeroutput>true</computeroutput> to 6190 <computeroutput>false</computeroutput>. Furthermore replace the 6191 second parameter to an existing configuration file which has the 6192 same format as on Linux, see <xref linkend="autostart-linux" />. 6053 <filename>/Library/LaunchDaemons</filename> and change the 6054 <literal>Disabled</literal> key from <literal>true</literal> to 6055 <literal>false</literal>. Furthermore replace the second 6056 parameter to an existing configuration file which has the same 6057 format as on Linux, see <xref linkend="autostart-linux" />. 6193 6058 </para> 6194 6059 … … 6197 6062 </para> 6198 6063 6199 <screen> launchctl load /Library/LaunchDaemons/org.virtualbox.vboxautostart.plist</screen>6064 <screen># launchctl load /Library/LaunchDaemons/org.virtualbox.vboxautostart.plist</screen> 6200 6065 6201 6066 <para> … … 6206 6071 <para> 6207 6072 <ulink 6208 url="http://developer.apple.com/mac/library/documentation/MacOSX/Conceptual/BPSystemStartup/BPSystemStartup.html" >http://developer.apple.com/mac/library/documentation/MacOSX/Conceptual/BPSystemStartup/BPSystemStartup.html</ulink>.6073 url="http://developer.apple.com/mac/library/documentation/MacOSX/Conceptual/BPSystemStartup/BPSystemStartup.html" />. 6209 6074 </para> 6210 6075 … … 6213 6078 <sect2 id="autostart-windows"> 6214 6079 6215 <title>Windows: Starting the Autostart Service With windows service</title> 6216 6217 <para> 6218 On Windows, the autostarting is implemented as Windows service. 6219 The service is installed for every user with her/his own credentials. 6220 Before installing any autostart services on a system you have to define 6221 the <computeroutput>VBOXAUTOSTART_CONFIG</computeroutput> environment 6222 variable in the system variables with the path to the config file. 6223 The config file has the same format as on Linux, 6224 see <xref linkend="autostart-linux" />, except the user name 6225 can be specified using following formats: "user", "domain\user", 6226 ".\user" and "user@domain". 6227 </para> 6228 6229 <para> 6230 To activate the autostart ability for particular user a member of 6080 <title>Windows: Starting the Autostart Service With a Windows service</title> 6081 6082 <para> 6083 On Windows, autostarting is implemented as a Windows service. 6084 The service is installed for every user with their own 6085 credentials. Before installing any autostart services on a 6086 system you first have to define the 6087 <literal>VBOXAUTOSTART_CONFIG</literal> environment variable in 6088 the system variables with the path to the autostart 6089 configuration file. The configuration file has the same format 6090 as on Linux, see <xref linkend="autostart-linux" />, except the 6091 user name can be specified using the following formats: "user", 6092 "domain\user", ".\user" and "user@domain". 6093 </para> 6094 6095 <para> 6096 To enable autostarting for a particular user, a member of the 6231 6097 administrators group must run the following command: 6232 6098 </para> 6233 6099 6234 6235 6236 <para> 6237 The password file should contain the password followed by a line break.6238 The rest of the file is ignored. The user will be asked for a password6239 if the password file is not specified.6240 </para> 6241 6242 <para> 6243 To remove the autostart ability for particular user a member of6100 <screen>VBoxAutostartSvc install --user=<user> [--password-file=<password_file>]</screen> 6101 6102 <para> 6103 The password file should contain the password followed by a line 6104 break. The rest of the file is ignored. The user will be asked 6105 for a password if the password file is not specified. 6106 </para> 6107 6108 <para> 6109 To disable autostarting for particular user, a member of the 6244 6110 administrators group must run the following command: 6245 6111 </para> 6246 6112 6247 <screen>VBoxAutostartSvc delete --user=<user></screen> 6248 6249 <para> 6250 The user can be specified for both commands using following formats: 6251 "user", "domain\user", ".\user" and "user@domain" 6252 </para> 6253 6254 <para> 6255 Note: 6256 </para> 6257 6258 <para> 6259 If user has changed his password a member of administrators group 6260 must either reinstall the service or change the service credentials 6261 using windows service manager. The autostart service can not be 6262 installed for users with empty passwords due to Windows security policies. 6113 <screen>VBoxAutostartSvc delete --user=<user></screen> 6114 6115 <para> 6116 If a user has changed their password then a member of the 6117 administrators group must either reinstall the service or change 6118 the service credentials using Windows Service Manager. Due to 6119 Windows security policies, the autostart service cannot be 6120 installed for users with empty passwords. 6263 6121 </para> 6264 6122 … … 6285 6143 </para> 6286 6144 6287 <screen>VBoxManage setextradata "VM name" "VBoxInternal2/SilentReconfigureWhilePaused" 1</screen> 6288 6289 <para> 6290 Storage attachments can be reconfigured while the VM is paused 6291 afterwards using: 6292 </para> 6293 6294 <screen>VBoxManage storageattach ...</screen> 6145 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxInternal2/SilentReconfigureWhilePaused" 1</screen> 6146 6147 <para> 6148 You can reconfigure storage attachments later while the VM is 6149 paused by using the <command>VBoxManage storageattach</command> 6150 command. 6151 </para> 6295 6152 6296 6153 </sect1> … … 6353 6210 </para> 6354 6211 6355 <screen> VBoxManage setextradata global "VBoxInternal2/SavestateOnBatteryLow" 0</screen>6212 <screen>$ VBoxManage setextradata global "VBoxInternal2/SavestateOnBatteryLow" 0</screen> 6356 6213 6357 6214 <para> … … 6362 6219 </para> 6363 6220 6364 <screen> VBoxManage setextradata global "VBoxInternal2/SavestateOnBatteryLow" 16365 VBoxManage setextradata "foo" "VBoxInternal2/SavestateOnBatteryLow" 0</screen>6221 <screen>$ VBoxManage setextradata global "VBoxInternal2/SavestateOnBatteryLow" 1 6222 $ VBoxManage setextradata "foo" "VBoxInternal2/SavestateOnBatteryLow" 0</screen> 6366 6223 6367 6224 <para> … … 6386 6243 </para> 6387 6244 6388 <screen>VBoxManage setextradata "VM name" VBoxInternal/CPUM/IsaExts/SSE4.1 0 6389 VBoxManage setextradata "VM name" VBoxInternal/CPUM/IsaExts/SSE4.2 0</screen> 6245 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 6246 VBoxInternal/CPUM/IsaExts/SSE4.1 0 6247 $ VBoxManage setextradata <replaceable>VM-name</replaceable> \ 6248 VBoxInternal/CPUM/IsaExts/SSE4.2 0</screen> 6390 6249 6391 6250 <para> … … 6407 6266 </para> 6408 6267 6409 <screen> VBoxManage setextradata "VM name"GUI/HidLedsSync 0</screen>6410 6411 <para> 6412 This is a per-VM setting , whichis enabled by default.6268 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> GUI/HidLedsSync 0</screen> 6269 6270 <para> 6271 This is a per-VM setting that is enabled by default. 6413 6272 </para> 6414 6273 … … 6428 6287 </para> 6429 6288 6430 <screen>VBoxManage controlvm "VM name" usbattach "device uuid|address" --capturefile "filename"</screen>6289 <screen>VBoxManage controlvm <replaceable>VM-name</replaceable> usbattach <replaceable>device uuid</replaceable>|<replaceable>address</replaceable> --capturefile <replaceable>filename</replaceable></screen> 6431 6290 6432 6291 <para> … … 6435 6294 </para> 6436 6295 6437 <screen>VBoxManage setextradata "VM name"\6438 VBoxInternal/Devices/usb-ehci/0/LUN#0/Config/CaptureFilename "filename"</screen>6296 <screen>VBoxManage setextradata <replaceable>VM-name</replaceable> \ 6297 VBoxInternal/Devices/usb-ehci/0/LUN#0/Config/CaptureFilename <replaceable>filename</replaceable></screen> 6439 6298 6440 6299 <para> 6441 6300 The command above enables capturing on the root hub attached to 6442 6301 the EHCI controller. To enable it for the OHCI or XHCI controller 6443 replace < computeroutput>usb-ehci</computeroutput> with6444 < computeroutput>usb-ohci</computeroutput> or6445 <computeroutput>usb-xhci</computeroutput>respectively.6302 replace <literal>usb-ehci</literal> with 6303 <literal>usb-ohci</literal> or <literal>usb-xhci</literal>, 6304 respectively. 6446 6305 </para> 6447 6306 … … 6471 6330 </para> 6472 6331 6473 <screen>VBoxManage setextradata "VM name"\6474 6332 <screen>VBoxManage setextradata <replaceable>VM-name</replaceable> \ 6333 VBoxInternal/Devices/VMMDev/0/Config/HeartbeatInterval 2000000000</screen> 6475 6334 6476 6335 <para> … … 6482 6341 </para> 6483 6342 6484 <screen>VBoxManage setextradata "VM name"\6485 6343 <screen>VBoxManage setextradata <replaceable>VM-name</replaceable> \ 6344 VBoxInternal/Devices/VMMDev/0/Config/HeartbeatTimeout 4000000000</screen> 6486 6345 6487 6346 <para> … … 6618 6477 </para> 6619 6478 6620 <screen>VBoxManage encryptmedium "uuid|filename"\6621 --newpassword "file|-" --cipher "cipher id" --newpasswordid "id"</screen>6479 <screen>VBoxManage encryptmedium <replaceable>uuid</replaceable>|<replaceable>filename</replaceable> \ 6480 --newpassword <replaceable>filename</replaceable>|- --cipher <replaceable>cipher-ID</replaceable> --newpasswordid "<replaceable>ID</replaceable></screen> 6622 6481 6623 6482 <para> … … 6630 6489 <para> 6631 6490 The cipher parameter specifies the cipher to use for encryption 6632 and can be either 6633 <computeroutput>AES-XTS128-PLAIN64</computeroutput> or 6634 <computeroutput>AES-XTS256-PLAIN64</computeroutput>. The 6635 specified password identifier can be freely chosen by the user 6636 and is used for correct identification when supplying multiple 6637 passwords during VM startup. 6491 and can be either <literal>AES-XTS128-PLAIN64</literal> or 6492 <literal>AES-XTS256-PLAIN64</literal>. The specified password 6493 identifier can be freely chosen by the user and is used for 6494 correct identification when supplying multiple passwords during 6495 VM startup. 6638 6496 </para> 6639 6497 … … 6660 6518 </para> 6661 6519 6662 <screen>VBoxManage controlvm "uuid|vmname" addencpassword "id" "password" [--removeonsuspend "yes|no"]</screen>6663 6664 <para> 6665 The <computeroutput>id</computeroutput> parameter must be the6666 same as the password identifier supplied when encrypting the6667 images. <computeroutput>password</computeroutput> is the6668 password used when encrypting the images. The user can6669 optionally specify <computeroutput>--removeonsuspend6670 "yes|no"</computeroutput> to specify whether to remove the6671 password from VM memory when the VM is suspended. Before the VM6672 can be resumed, the user needs to supply the passwords again.6673 This is useful when a VM is suspended by a host suspend event6674 and the user does not want the password to remainin memory.6520 <screen>VBoxManage controlvm <replaceable>uuid</replaceable>|<replaceable>vmname</replaceable> addencpassword <replaceable>ID</replaceable> <replaceable>password</replaceable> [--removeonsuspend yes|no]</screen> 6521 6522 <para> 6523 <replaceable>ID</replaceable> must be the same as the password 6524 identifier supplied when encrypting the images. 6525 <replaceable>password</replaceable> is the password used when 6526 encrypting the images. Optionally, you can specify 6527 <option>--removeonsuspend yes|no</option> to specify whether to 6528 remove the password from VM memory when the VM is suspended. 6529 Before the VM can be resumed, the user needs to supply the 6530 passwords again. This is useful when a VM is suspended by a host 6531 suspend event and the user does not want the password to remain 6532 in memory. 6675 6533 </para> 6676 6534 … … 6688 6546 </para> 6689 6547 6690 <screen>VBoxManage encryptmedium "uuid|filename" --oldpassword "file|-"</screen>6548 <screen>VBoxManage encryptmedium <replaceable>uuid</replaceable>|<replaceable>filename</replaceable> --oldpassword <replaceable>file</replaceable>|-</screen> 6691 6549 6692 6550 <para> … … 6705 6563 6706 6564 <para> 6707 In this section we cover debugging of guest operating systems6708 usinginterfaces supported by paravirtualization providers.6565 This section covers debugging of guest operating systems using 6566 interfaces supported by paravirtualization providers. 6709 6567 </para> 6710 6568 … … 6738 6596 <para> 6739 6597 Key: 6740 <emphasis role="bold">< computeroutput>enabled</computeroutput></emphasis>6598 <emphasis role="bold"><literal>enabled</literal></emphasis> 6741 6599 </para> 6742 6600 6743 6601 <para> 6744 Value: <computeroutput>0</computeroutput> or 6745 <computeroutput>1</computeroutput> 6602 Value: <literal>0</literal> or <literal>1</literal> 6746 6603 </para> 6747 6604 6748 6605 <para> 6749 Default: < computeroutput>0</computeroutput>6606 Default: <literal>0</literal> 6750 6607 </para> 6751 6608 6752 6609 <para> 6753 Specify <computeroutput>1</computeroutput> to enable the 6754 Hyper-V debug interface. If this key-value pair is not 6755 specified or the value is not 6756 <computeroutput>1</computeroutput>, the Hyper-V debug 6610 Specify <literal>1</literal> to enable the Hyper-V debug 6611 interface. If this key-value pair is not specified or the 6612 value is not <literal>1</literal>, the Hyper-V debug 6757 6613 interface is disabled regardless of other key-value pairs 6758 6614 being present. … … 6763 6619 <para> 6764 6620 Key: 6765 <emphasis role="bold">< computeroutput>address</computeroutput></emphasis>6621 <emphasis role="bold"><literal>address</literal></emphasis> 6766 6622 </para> 6767 6623 … … 6783 6639 <para> 6784 6640 Key: 6785 <emphasis role="bold">< computeroutput>port</computeroutput></emphasis>6641 <emphasis role="bold"><literal>port</literal></emphasis> 6786 6642 </para> 6787 6643 … … 6803 6659 <para> 6804 6660 Key: 6805 <emphasis role="bold">< computeroutput>vendor</computeroutput></emphasis>6661 <emphasis role="bold"><literal>vendor</literal></emphasis> 6806 6662 </para> 6807 6663 … … 6812 6668 6813 6669 <para> 6814 Default: When debugging is enabled: 6815 <computeroutput>Microsoft Hv</computeroutput>, otherwise: 6816 <computeroutput>VBoxVBoxVBox</computeroutput> 6670 Default: When debugging is enabled: <literal>Microsoft 6671 Hv</literal>, otherwise: <literal>VBoxVBoxVBox</literal> 6817 6672 </para> 6818 6673 … … 6827 6682 <para> 6828 6683 Key: 6829 <emphasis role="bold">< computeroutput>hypercallinterface</computeroutput>6684 <emphasis role="bold"><literal>hypercallinterface</literal> 6830 6685 </emphasis> 6831 6686 </para> 6832 6687 6833 6688 <para> 6834 Value: <computeroutput>0</computeroutput> or 6835 <computeroutput>1</computeroutput> 6689 Value: <literal>0</literal> or <literal>1</literal> 6836 6690 </para> 6837 6691 6838 6692 <para> 6839 Default: < computeroutput>0</computeroutput>6693 Default: <literal>0</literal> 6840 6694 </para> 6841 6695 … … 6849 6703 <listitem> 6850 6704 <para> 6851 Key: 6852 <emphasis role="bold"><computeroutput>vsinterface</computeroutput> 6705 Key: <emphasis role="bold"><literal>vsinterface</literal> 6853 6706 </emphasis> 6854 6707 </para> 6855 6708 6856 6709 <para> 6857 Value: <computeroutput>0</computeroutput> or 6858 <computeroutput>1</computeroutput> 6710 Value: <literal>0</literal> or <literal>1</literal> 6859 6711 </para> 6860 6712 6861 6713 <para> 6862 Default: When debugging is enabled, 6863 <computeroutput>1</computeroutput>, otherwise 6864 <computeroutput>0</computeroutput> 6714 Default: When debugging is enabled, <literal>1</literal>, 6715 otherwise <literal>0</literal> 6865 6716 </para> 6866 6717 … … 6913 6764 </para> 6914 6765 6915 <screen> VBoxManage showvminfo "VM name"</screen>6766 <screen>$ VBoxManage showvminfo <replaceable>VM-name</replaceable></screen> 6916 6767 </listitem> 6917 6768 … … 6929 6780 debug support, Windows 7 and Vista do not. To use Hyper-V 6930 6781 debugging with a Windows 7 or Vista guest, copy the file 6931 < computeroutput>kdvm.dll</computeroutput> from a Windows6932 8.0installation. This file is typically located in6933 < computeroutput>C:\Windows\System32</computeroutput>. Copy6934 it to the same location in your Windows 7/Vista guest.6935 Make sure you copy the 32-bit or 64-bit version of the DLL6936 which matchesyour guest OS.6782 <filename>kdvm.dll</filename> from a Windows 8.0 6783 installation. This file is typically located in 6784 <filename>C:\Windows\System32</filename>. Copy it to the 6785 same location in your Windows 7/Vista guest. Make sure you 6786 copy the 32-bit or 64-bit version of the DLL which matches 6787 your guest OS. 6937 6788 </para> 6938 6789 6939 6790 <note> 6940 6791 <para> 6941 Only Windows 8.0 ships 6942 <computeroutput>kdvm.dll</computeroutput>. Windows 8.1 6943 and newer Windows versions do not. 6792 Only Windows 8.0 ships <filename>kdvm.dll</filename>. 6793 Windows 8.1 and newer Windows versions do not. 6944 6794 </para> 6945 6795 </note> … … 6966 6816 </para> 6967 6817 6968 <screen> VBoxManage modifyvm "VM name"--paravirtdebug "enabled=1"</screen>6818 <screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> --paravirtdebug "enabled=1"</screen> 6969 6819 6970 6820 <para> … … 6975 6825 </para> 6976 6826 6977 <screen>VBoxManage modifyvm "VM name" --paravirtdebug "enabled=1,address=192.168.32.1,port=55000"</screen> 6827 <screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> \ 6828 --paravirtdebug "enabled=1,address=192.168.32.1,port=55000"</screen> 6978 6829 6979 6830 <para> … … 7071 6922 the <emphasis role="bold">NET</emphasis> tab, specify the 7072 6923 UDP port number you used in the 7073 <computeroutput>paravirtdebug</computeroutput> options. If 7074 you did not specify any, leave it as 50000. Ensure that 7075 the UDP port is not blocked by a firewall or other 7076 security software. 6924 <literal>paravirtdebug</literal> options. If you did not 6925 specify any, leave it as 50000. Ensure that the UDP port 6926 is not blocked by a firewall or other security software. 7077 6927 </para> 7078 6928 7079 6929 <para> 7080 6930 In the <emphasis role="bold">Key</emphasis> field, enter 7081 <computeroutput>1.2.3.4</computeroutput> or the encryption 7082 key from the <computeroutput>bcdedit</computeroutput> 7083 command in your Windows guest. 6931 <literal>1.2.3.4</literal> or the encryption key from the 6932 <command>bcdedit</command> command in your Windows guest. 7084 6933 </para> 7085 6934 … … 7167 7016 </para></entry> 7168 7017 <entry><para> 7169 < computeroutput>/dev/input/by-path/platform-pcspkr-event-spkr</computeroutput>7018 <filename>/dev/input/by-path/platform-pcspkr-event-spkr</filename> 7170 7019 </para></entry> 7171 7020 <entry><para> … … 7177 7026 2 7178 7027 </para></entry> 7179 <entry>< computeroutput>/dev/tty</computeroutput></entry>7028 <entry><filename>/dev/tty</filename></entry> 7180 7029 <entry><para> 7181 7030 Uses the terminal association of the VM process. VM … … 7188 7037 </para></entry> 7189 7038 <entry><para> 7190 < computeroutput>/dev/tty0</computeroutput> or7191 < computeroutput>/dev/vc/0</computeroutput>7039 <filename>/dev/tty0</filename> or 7040 <filename>/dev/vc/0</filename> 7192 7041 </para></entry> 7193 7042 <entry><para> 7194 Can only be used by user 7195 <computeroutput>root</computeroutput> or users with 7196 <computeroutput>cap_sys_tty_config</computeroutput> 7043 Can only be used by user <literal>root</literal> or 7044 users with <literal>cap_sys_tty_config</literal> 7197 7045 capability. 7198 7046 </para></entry> … … 7214 7062 </para></entry> 7215 7063 <entry><para> 7216 < computeroutput>/dev/tty</computeroutput>7064 <filename>/dev/tty</filename> 7217 7065 </para></entry> 7218 7066 <entry><para> … … 7251 7099 </para> 7252 7100 7253 <screen>VBoxManage setextradata "VM name" "VBoxInternal/Devices/i8254/0/Config/PassthroughSpeaker" N</screen> 7254 7255 <para> 7256 Replace <computeroutput>N</computeroutput> with the code 7257 representing the case you want to use. Changing this setting will 7258 take effect when the VM is started next. It is safe to enable PC 7259 speaker passthrough on all host OSes. It will only have an effect 7260 on Linux. 7261 </para> 7262 7263 <para> 7264 The VM log file, <computeroutput>VBox.log</computeroutput>, will 7265 contain lines with the prefix <computeroutput>PIT: 7266 speaker:</computeroutput> showing the PC speaker passthrough setup 7267 activities. It gives hints which device it picked or why it 7268 failed. 7101 <screen>VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxInternal/Devices/i8254/0/Config/PassthroughSpeaker" <replaceable>N</replaceable></screen> 7102 7103 <para> 7104 Replace <replaceable>N</replaceable> with the code representing 7105 the case you want to use. Changing this setting takes effect when 7106 you next start the VM. It is safe to enable PC speaker passthrough 7107 on all host OSes. It will only have an effect on Linux. 7108 </para> 7109 7110 <para> 7111 The VM log file, <filename>VBox.log</filename>, contains lines 7112 with the prefix <literal>PIT: speaker:</literal> showing the PC 7113 speaker passthrough setup activities. It gives hints which device 7114 it picked or why it failed. 7269 7115 </para> 7270 7116 … … 7273 7119 part. The real difficulty is making sure that &product-name; can 7274 7120 access the necessary device, because in a typical Linux install 7275 most of them can only be accessed by user 7276 <computeroutput>root</computeroutput>. You should follow the 7277 preferred way to persistently change this, such as by referring to 7278 your distribution's documentation. Since there are countless Linux 7279 distribution variants, we can only give the general hints that 7280 there is often a way to give the X11 session user access to 7281 additional devices, or you need to find a working solution using a 7282 udev configuration file. If everything fails you might try setting 7283 the permissions using a script which is run late enough in the 7284 host system startup. 7121 most of them can only be accessed by user <literal>root</literal>. 7122 You should follow the preferred way to persistently change this, 7123 such as by referring to your distribution's documentation. Since 7124 there are countless Linux distribution variants, we can only give 7125 the general hints that there is often a way to give the X11 7126 session user access to additional devices, or you need to find a 7127 working solution using a udev configuration file. If everything 7128 fails you might try setting the permissions using a script which 7129 is run late enough in the host system startup. 7285 7130 </para> 7286 7131 … … 7322 7167 7323 7168 <para> 7324 To enable support for passing through USB/IP devices, the device7325 server exporting the devices must be added with the following7326 command:7327 </para> 7328 7329 <screen>VBoxManage usbdevsource add "Unique name" --backend "USBIP" --address "Device server[:port]"</screen>7169 To enable support for passing through USB/IP devices, use the 7170 following command to add the device server that exports the 7171 devices: 7172 </para> 7173 7174 <screen>VBoxManage usbdevsource add <replaceable>unique-name</replaceable> --backend <replaceable>USB-IP</replaceable> --address <replaceable>device-server</replaceable>[:<replaceable>port</replaceable>]</screen> 7330 7175 7331 7176 <para> … … 7340 7185 </para> 7341 7186 7342 <screen> VBoxManage usbdevsource remove "Unique name"</screen>7187 <screen>$ VBoxManage usbdevsource remove <replaceable>unique-name</replaceable></screen> 7343 7188 7344 7189 <sect2 id="usbip-setup-server"> … … 7349 7194 This section gives a brief overview on how to set up a Linux 7350 7195 based system to act as a USB device server. The system on the 7351 server requires that the 7352 <computeroutput>usbip-core.ko</computeroutput> and 7353 <computeroutput>usbip-host.ko</computeroutput> kernel drivers 7354 are available, and that the USB/IP tools package is installed. 7355 The particular installation method for the necessary tools 7356 depends on which distribution is used. For example, for Debian 7357 based systems, the following command should be used to install 7358 the required tools: 7359 </para> 7360 7361 <screen>apt-get install usbip-utils</screen> 7196 server requires that the <filename>usbip-core.ko</filename> and 7197 <filename>usbip-host.ko</filename> kernel drivers are available, 7198 and that the USB/IP tools package is installed. The particular 7199 installation method for the necessary tools depends on which 7200 distribution is used. For example, for Debian based systems, use 7201 the following command to install the required tools: 7202 </para> 7203 7204 <screen>$ apt-get install usbip-utils</screen> 7362 7205 7363 7206 <para> … … 7385 7228 <para> 7386 7229 If everything is installed, the USB/IP server needs to be 7387 started as <computeroutput>root</computeroutput> using the 7388 following command: 7389 </para> 7390 7391 <screen>usbipd -D</screen> 7392 7393 <para> 7394 Refer to the documentation for the installed distribution to 7230 started as <literal>root</literal> using the following command: 7231 </para> 7232 7233 <screen># usbipd -D</screen> 7234 7235 <para> 7236 See the documentation for the installed distribution to 7395 7237 determine how to start the service when the system boots. 7396 7238 </para> … … 7402 7244 </para> 7403 7245 7404 <screen> usbip bind -b "bus identifier"</screen>7246 <screen># usbip bind -b "bus identifier"</screen> 7405 7247 7406 7248 <para> … … 7408 7250 </para> 7409 7251 7410 <screen> usbip bind -b 4-2</screen>7252 <screen># usbip bind -b 4-2</screen> 7411 7253 7412 7254 </sect2> … … 7449 7291 <note> 7450 7292 <para> 7451 When using this feature, you might experience significant7452 &product-name; performance degradation on some host systems.7293 When using this feature, some host systems might experience 7294 significant &product-name; performance degradation. 7453 7295 </para> 7454 7296 </note> … … 7461 7303 7462 7304 <para> 7463 &product-name; supports <emphasis>nested virtualization</emphasis>.7464 This feature enables the passthrough of hardware virtualization7465 functions to the guest VM. That means that you can install a7466 hypervisor, such as &product-name;, Oracle VM Server or KVM, on7467 a &product-name; guest. You can then create and run VMs within the7468 guest VM.7305 &product-name; supports <emphasis>nested 7306 virtualization</emphasis>. This feature enables the passthrough of 7307 hardware virtualization functions to the guest VM. That means that 7308 you can install a hypervisor, such as &product-name;, Oracle VM 7309 Server or KVM, on an &product-name; guest. You can then create and 7310 run VMs within the guest VM. 7469 7311 </para> 7470 7312 -
trunk/doc/manual/en_US/user_BasicConcepts.xml
r81233 r82350 458 458 459 459 <title>64-bit Guests</title> 460 461 <para>462 &product-name; enables you to run 64-bit guest OSes even on a463 32-bit host OS. To run a 64-bit guest OS on a 32-bit host464 system, ensure that you meet the following conditions:465 </para>466 467 <itemizedlist>468 469 <listitem>470 <para>471 You need a 64-bit processor that has hardware virtualization472 support. See <xref linkend="hwvirt" />.473 </para>474 </listitem>475 476 <listitem>477 <para>478 You must enable hardware virtualization for the particular479 VM that requires 64-bit support. Software virtualization is480 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 must487 select a 64-bit OS for the particular VM. Since supporting488 64 bits on 32-bit hosts incurs additional overhead,489 &product-name; only enables this support only upon explicit490 request.491 </para>492 493 <para>494 64-bit hosts typically come with hardware virtualization495 support. So, you can install a 64-bit guest OS in the guest496 regardless of the settings.497 </para>498 </listitem>499 500 </itemizedlist>501 460 502 461 <warning> … … 515 474 <para> 516 475 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 each519 selected 64-bit OS type. See<xref linkend="gui-createvm" />.476 of the VirtualBox Manager, &product-name; automatically uses the 477 correct settings for each selected 64-bit OS type. See 478 <xref linkend="gui-createvm" />. 520 479 </para> 521 480 … … 868 827 <listitem> 869 828 <para> 870 <emphasis role="bold">Input devices.</emphasis> By default, 871 &product-name; emulates a standard PS/2 keyboard and mouse. 872 These devices are supported by almost all past and present 873 OSes. 829 <emphasis role="bold">Input devices.</emphasis> &product-name; 830 can emulate a standard PS/2 keyboard and mouse. These devices 831 are supported by most guest OSes. 874 832 </para> 875 833 … … 877 835 In addition, &product-name; can provide virtual USB input 878 836 devices to avoid having to capture mouse and keyboard, as 879 described in <xref 880 linkend="keyb_mouse_normal" />. 881 </para> 882 </listitem> 883 884 <listitem> 885 <para> 886 <emphasis role="bold">Graphics.</emphasis> The &product-name; 887 graphics device, sometimes referred to as a VGA device, is not 888 based on any physical counterpart. This is unlike nearly all 889 other emulated devices. It is a simple, synthetic device which 890 provides compatibility with standard VGA and several extended 891 registers used by the VESA BIOS Extensions (VBE). 837 described in <xref linkend="keyb_mouse_normal" />. 838 </para> 839 </listitem> 840 841 <listitem> 842 <para> 843 <emphasis role="bold">Graphics.</emphasis> The default 844 &product-name; graphics device for Windows guests is an SVGA 845 device. For Linux guests, the default graphics device emulates 846 a VMware SVGA graphics device. See 847 <xref linkend="settings-screen"/>. 848 </para> 849 850 <para> 851 For legacy guest OSes, a VGA-compatible graphics device is 852 available. 892 853 </para> 893 854 </listitem> … … 896 857 <para> 897 858 <emphasis role="bold">Storage.</emphasis> &product-name; 898 currently emulates the standard ATA interface found on Intel 899 PIIX3/PIIX4 chips, the SATA (AHCI) interface, and two SCSI 900 adapters (LSI Logic and BusLogic). See 901 <xref linkend="harddiskcontrollers" /> for details. Whereas 902 providing one of these would be enough for &product-name; by 903 itself, this multitude of storage adapters is required for 904 compatibility with other hypervisors. Windows is particularly 905 picky about its boot devices, and migrating VMs between 906 hypervisors is very difficult or impossible if the storage 907 controllers are different. 859 emulates the most common types of hard disk controllers. See 860 <xref linkend="harddiskcontrollers" />. Whereas supporting 861 only one of these controllers would be enough for 862 &product-name; by itself, this multitude of storage adapters 863 is required for compatibility with other hypervisors. Windows 864 is very selective about its boot devices, and migrating VMs 865 between hypervisors is very difficult or impossible if the 866 storage controllers are different. 908 867 </para> 909 868 </listitem> … … 912 871 <para> 913 872 <emphasis role="bold">Networking.</emphasis> See 914 <xref 915 linkend="nichardware" />. 873 <xref linkend="nichardware" />. 916 874 </para> 917 875 </listitem> … … 920 878 <para> 921 879 <emphasis role="bold">USB.</emphasis> &product-name; emulates 922 three USB host controllers: xHCI, EHCI, and OHCI. While xHCI 923 handles all USB transfer speeds, only guest OSes released 924 approximately after 2011 support xHCI. Note that for Windows 7 925 guests, 3rd party drivers must be installed for xHCI support. 926 </para> 927 928 <para> 929 Older OSes typically support OHCI and EHCI. The two 880 these types of USB host controllers: xHCI, EHCI, and OHCI. 881 While xHCI handles all USB transfer speeds, some legacy guest 882 OSes may not support xHCI. Note that for some legacy Windows 883 guests, third party drivers must be installed for xHCI 884 support. 885 </para> 886 887 <para> 888 Legacy guest OSes typically support OHCI and EHCI. These two 930 889 controllers are needed because OHCI only handles USB low-speed 931 890 and full-speed devices (both USB 1.x and 2.0), while EHCI only … … 935 894 <para> 936 895 The emulated USB controllers do not communicate directly with 937 devices on the host but rather with a virtual USB layer which938 abstracts the USB protocol and enables the use of remote USB939 devices.896 devices on the host. Instead they communicate with a virtual 897 USB layer which abstracts the USB protocol and enables the use 898 of remote USB devices. 940 899 </para> 941 900 </listitem> … … 977 936 <listitem> 978 937 <para> 979 <emphasis role="bold">Name:</emphasis> The name under which 980 the VM is shown in the list of VMs in the main window. Under 981 this name, &product-name; also saves the VM's configuration 982 files. By changing the name, &product-name; renames these 983 files as well. As a result, you can only use characters 984 which are allowed in your host OS's file names. 938 <emphasis role="bold">Name:</emphasis> The name of the the 939 VM, as shown in the list of VMs in the main VirtualBox 940 Manager window. Using this name, &product-name; also saves 941 the VM's configuration files. If you change the name, 942 &product-name; renames these files as well. As a result, you 943 can only use characters which are allowed for file names on 944 your host OS. 985 945 </para> 986 946 … … 988 948 Note that internally, &product-name; uses unique identifiers 989 949 (UUIDs) to identify virtual machines. You can display these 990 with <command>VBoxManage</command>.950 using the <command>VBoxManage</command> commands. 991 951 </para> 992 952 </listitem> … … 1077 1037 enables support for drag and drop. Select an object, such as 1078 1038 a file, from the host or guest and directly copy or open it 1079 on the guest or host. Multiple per-VM drag and drop modes1080 allow restrictingaccess in either direction.1039 on the guest or host. Multiple drag and drop modes for a VM 1040 enable restricting of access in either direction. 1081 1041 </para> 1082 1042 … … 1148 1108 <note> 1149 1109 <para> 1150 All files related to the virtual machine except disk images are1151 stored unencrypted.1110 All files related to the virtual machine except disk images 1111 are stored unencrypted. 1152 1112 </para> 1153 1113 </note> … … 1234 1194 <para> 1235 1195 <emphasis role="bold">Chipset:</emphasis> You can select 1236 which chipset will be presented to the virtual machine. In 1237 legacy versions of &product-name;, PIIX3 was the only 1238 available option. For modern guest OSes such as Mac OS X, 1239 that old chipset is no longer well supported. As a result, 1240 &product-name; supports an emulation of the more modern ICH9 1241 chipset, which supports PCI express, three PCI buses, 1242 PCI-to-PCI bridges and Message Signaled Interrupts (MSI). 1243 This enables modern OSes to address more PCI devices and no 1244 longer requires IRQ sharing. Using the ICH9 chipset it is 1245 also possible to configure up to 36 network cards, up to 8 1246 network adapters with PIIX3. Note that the ICH9 support is 1247 experimental and not recommended for guest OSes which do not 1248 require it. 1196 which chipset will be presented to the virtual machine. 1197 PIIX3 is the default chipset for most guests. For some guest 1198 OSes such as Mac OS X, the PIIX3 chipset is not well 1199 supported. As a result, &product-name; supports an emulation 1200 of the ICH9 chipset, which supports PCI express, three PCI 1201 buses, PCI-to-PCI bridges and Message Signaled Interrupts 1202 (MSI). This enables modern OSes to address more PCI devices 1203 and no longer requires IRQ sharing. Using the ICH9 chipset 1204 it is also possible to configure up to 36 network cards, 1205 compared to a maximum of eight network adapters with PIIX3. 1206 Note that ICH9 support is experimental and not recommended 1207 for guest OSes which do not require it. 1249 1208 </para> 1250 1209 </listitem> … … 1253 1212 <para> 1254 1213 <emphasis role="bold">Pointing Device:</emphasis> The 1255 default virtual pointing device s for older guests is the1256 traditional PS/2 mouse. If set to <emphasis >USB1257 tablet</emphasis>, &product-name; reports to the virtual1214 default virtual pointing device for some guest OSes is the 1215 traditional PS/2 mouse. If set to <emphasis role="bold">USB 1216 Tablet</emphasis>, &product-name; reports to the virtual 1258 1217 machine that a USB tablet device is present and communicates 1259 mouse events to the virtual machine through this device. The 1260 third setting is a <emphasis>USB Multi-Touch 1261 Tablet</emphasis> which is suited for recent Windows guests. 1218 mouse events to the virtual machine through this device. 1219 Another setting is <emphasis role="bold">USB Multi-Touch 1220 Tablet</emphasis>, which is suitable for guests running 1221 Windows 8 or later. 1262 1222 </para> 1263 1223 … … 1277 1237 <para> 1278 1238 <emphasis role="bold">Enable I/O APIC:</emphasis> Advanced 1279 Programmable Interrupt Controllers (APICs) are a newerx861280 hardware feature that have replaced old-style Programmable1281 Interrupt Controllers (PICs) in recent years. With an I/O1282 APIC, OSes can use more than 16 interrupt requests (IRQs)1283 and therefore avoid IRQ sharingfor improved reliability.1239 Programmable Interrupt Controllers (APICs) are an x86 1240 hardware feature that have replaced Programmable Interrupt 1241 Controllers (PICs). With an I/O APIC, OSes can use more than 1242 16 interrupt requests (IRQs) and therefore avoid IRQ sharing 1243 for improved reliability. 1284 1244 </para> 1285 1245 1286 1246 <note> 1287 1247 <para> 1288 Enabling the I/O APIC is <emphasis>required</emphasis> for1289 64-bit guest OSes, especially Windows Vista. It is also1248 Enabling the I/O APIC is <emphasis>required</emphasis>, 1249 especially for 64-bit Windows guest OSes. It is also 1290 1250 required if you want to use more than one virtual CPU in a 1291 1251 virtual machine. … … 1302 1262 <warning> 1303 1263 <para> 1304 All Windows OSes starting with Windows 2000 install 1305 different kernels, depending on whether an I/O APIC is 1306 available. As with ACPI, the I/O APIC therefore 1307 <emphasis>must not be turned off after 1264 All Windows OSes install different kernels, depending on 1265 whether an I/O APIC is available. As with ACPI, the I/O 1266 APIC therefore <emphasis>must not be turned off after 1308 1267 installation</emphasis> of a Windows guest OS. Turning it 1309 1268 on after installation will have no effect however. … … 1343 1302 ACPI is the current industry standard to allow OSes to recognize 1344 1303 hardware, configure motherboards and other devices and manage 1345 power. As all modern PCs contain this feature and Windows and1346 Linux have been supporting it for years, it is also enabled by1347 default in &product-name;. ACPI can only be turned off using the1348 commandline. See <xref linkend="vboxmanage-modifyvm" />.1304 power. As most computers contain this feature and Windows and 1305 Linux support ACPI, it is also enabled by default in 1306 &product-name;. ACPI can only be turned off using the command 1307 line. See <xref linkend="vboxmanage-modifyvm" />. 1349 1308 </para> 1350 1309 1351 1310 <warning> 1352 1311 <para> 1353 All Windows OSes starting with Windows 2000 install different1354 kernels, depending on whether ACPI is available. This means1355 that ACPI <emphasis>must not be turned off</emphasis> after1356 installation of a Windows guest OS. However, turning it on1357 after installation will haveno effect.1312 All Windows OSes install different kernels, depending on 1313 whether ACPI is available. This means that ACPI <emphasis>must 1314 not be turned off</emphasis> after installation of a Windows 1315 guest OS. However, turning it on after installation will have 1316 no effect. 1358 1317 </para> 1359 1318 </warning> … … 1460 1419 accuracy and performance of guest OSes. The options 1461 1420 available are documented under the 1462 < computeroutput>paravirtprovider</computeroutput> option in1421 <option>--paravirtprovider</option> option in 1463 1422 <xref linkend="vboxmanage-modifyvm" />. For further details 1464 1423 on the paravirtualization providers, see … … 1470 1429 <para> 1471 1430 <emphasis role="bold">Hardware Virtualization:</emphasis> 1472 You can select for each virtual machine individually whether 1473 &product-name; should use software or hardware 1474 virtualization. 1431 You can configure hardware virtualization features for each 1432 virtual machine. 1475 1433 </para> 1476 1434 1477 1435 <itemizedlist> 1478 1479 <listitem>1480 <para>1481 <emphasis role="bold">Enable VT-x/AMD-V:</emphasis>1482 Enables Intel VT-x and AMD-V hardware extensions if the1483 host CPU supports them.1484 </para>1485 </listitem>1486 1436 1487 1437 <listitem> … … 1502 1452 <para> 1503 1453 Advanced users may be interested in technical details about 1504 software versus hardware virtualization. See 1505 <xref linkend="hwvirt" />. 1454 hardware virtualization. See <xref linkend="hwvirt" />. 1506 1455 </para> 1507 1456 </listitem> … … 1614 1563 <listitem> 1615 1564 <para> 1616 <emphasis role="bold">Enable 3D Acceleration:</emphasis> If1617 a virtual machine has Guest Additions installed, you can1618 select here whether the guest should support accelerated 3D1619 graphics. See <xref linkend="guestadd-3d" />.1620 </para>1621 </listitem>1622 1623 <listitem>1624 <para>1625 <emphasis role="bold">Enable 2D Video1626 Acceleration:</emphasis> If a virtual machine with Microsoft1627 Windows has Guest Additions installed, you can select here1628 whether the guest should support accelerated 2D video1629 graphics. See <xref linkend="guestadd-2d" />.1630 </para>1631 </listitem>1632 1633 <listitem>1634 <para>1635 1565 <emphasis role="bold">Graphics Controller:</emphasis> 1636 1566 Specifies the graphics adapter type used by the guest VM. … … 1661 1591 default graphics controller for Windows versions before 1662 1592 Windows 7 and for Oracle Solaris. 1593 </para> 1594 1595 <para> 1596 3D acceleration is not supported for this graphics 1597 controller. 1663 1598 </para> 1664 1599 </listitem> … … 1681 1616 1682 1617 </itemizedlist> 1618 </listitem> 1619 1620 <listitem> 1621 <para> 1622 <emphasis role="bold">Enable 3D Acceleration:</emphasis> If 1623 a virtual machine has Guest Additions installed, you can 1624 select here whether the guest should support accelerated 3D 1625 graphics. See <xref linkend="guestadd-3d" />. 1626 </para> 1627 </listitem> 1628 1629 <listitem> 1630 <para> 1631 <emphasis role="bold">Enable 2D Video 1632 Acceleration:</emphasis> If a virtual machine with Microsoft 1633 Windows has Guest Additions installed, you can select here 1634 whether the guest should support accelerated 2D video 1635 graphics. See <xref linkend="guestadd-2d" />. 1636 </para> 1683 1637 </listitem> 1684 1638 … … 1779 1733 <listitem> 1780 1734 <para> 1781 <emphasis role="bold"> Quality:</emphasis> Use the slider to1782 s et the the bit rate of the video in kilobits per second.1783 Increasing this value improves the appearance of the video1784 at the cost of an increased file size.1735 <emphasis role="bold">Video Quality:</emphasis> Use the 1736 slider to set the the bit rate of the video in kilobits per 1737 second. Increasing this value improves the appearance of the 1738 video at the cost of an increased file size. 1785 1739 </para> 1786 1740 </listitem> … … 1825 1779 1826 1780 <para> 1827 In a real PC, so-called <emphasis>storage controllers</emphasis>1828 con nect physical disk drives to the rest of the computer.1829 Similarly, &product-name; presents virtual storage controllers to1830 a virtual machine. Under each controller, the virtual devices,1831 such as hard disks, CD/DVD or floppy drives, attached to the1832 controller are shown.1781 In a real computer, so-called <emphasis>storage 1782 controllers</emphasis> connect physical disk drives to the rest of 1783 the computer. Similarly, &product-name; presents virtual storage 1784 controllers to a virtual machine. Under each controller, the 1785 virtual devices, such as hard disks, CD/DVD or floppy drives, 1786 attached to the controller are shown. 1833 1787 </para> 1834 1788 … … 1849 1803 <figure id="fig-storage-settings"> 1850 1804 <title>Storage Settings for a Virtual Machine</title> 1851 1805 <mediaobject> 1852 1806 <imageobject> 1853 1807 <imagedata align="center" fileref="images/vm-settings-harddisk.png" … … 1855 1809 </imageobject> 1856 1810 </mediaobject> 1857 </figure>1811 </figure> 1858 1812 1859 1813 <para> … … 1921 1875 To <emphasis role="bold">add another virtual hard disk, or a 1922 1876 CD/DVD or floppy drive</emphasis>, select the storage 1923 controller to which it should be added ( IDE, SATA, SCSI, SAS,1924 floppy controller) and then click the1877 controller to which it should be added (such as IDE, SATA, 1878 SCSI, SAS, floppy controller) and then click the 1925 1879 <emphasis role="bold">Add Disk</emphasis> button below the 1926 tree. You can then either select <emphasis role="bold"> Add1927 CD/DVD Device</emphasis> or <emphasis role="bold">AddHard1880 tree. You can then either select <emphasis role="bold">Optical 1881 Drive</emphasis> or <emphasis role="bold">Hard 1928 1882 Disk</emphasis>. If you clicked on a floppy controller, you 1929 1883 can add a floppy drive instead. Alternatively, right-click on … … 1932 1886 1933 1887 <para> 1934 On the right part of the window, you can then set the 1935 following: 1936 </para> 1937 1938 <orderedlist> 1888 A dialog is displayed, enabling you to select an existing disk 1889 image file or to create a new disk image file. Depending on 1890 the type of disk image, the dialog is called 1891 <emphasis role="bold">Hard Disk Selector</emphasis>, 1892 <emphasis role="bold">Optical Disk Selector</emphasis>, or 1893 <emphasis role="bold">Floppy Disk Selector</emphasis>. 1894 </para> 1895 1896 <para> 1897 See <xref linkend="vdidetails"/> for information on the image 1898 file types that are supported by &product-name;. 1899 </para> 1900 1901 <para> 1902 For virtual CD/DVD drives, the image files will typically be 1903 in the standard ISO format instead. Most commonly, you will 1904 select this option when installing an OS from an ISO file that 1905 you have obtained from the Internet. For example, most Linux 1906 distributions are available in this way. 1907 </para> 1908 1909 <para> 1910 Depending on the type of disk image, you can set the following 1911 <emphasis role="bold">Attributes</emphasis> for the disk image 1912 in the right part of the Storage settings page: 1913 </para> 1914 1915 <itemizedlist> 1939 1916 1940 1917 <listitem> … … 1952 1929 <listitem> 1953 1930 <para> 1954 The <emphasis role="bold">image file</emphasis> to use. 1955 </para> 1956 1957 <itemizedlist> 1958 1959 <listitem> 1960 <para> 1961 For virtual hard disks, a button with a drop-down list 1962 appears on the right, offering you to either select a 1963 <emphasis role="bold">virtual hard disk 1964 file</emphasis> using a standard file dialog or to 1965 <emphasis role="bold">create a new hard 1966 disk</emphasis> (image file). The latter option 1967 displays the <emphasis role="bold">Create New 1968 Disk</emphasis> wizard, described in 1969 <xref linkend="gui-createvm" />. 1970 </para> 1971 1972 <para> 1973 For virtual floppy drives, a dialog enables you to 1974 create and format a new floppy disk image 1975 automatically. 1976 </para> 1977 1978 <para> 1979 For details on the image file types that are 1980 supported, see <xref linkend="vdidetails" />. 1981 </para> 1982 </listitem> 1983 1984 <listitem> 1985 <para> 1986 For virtual CD/DVD drives, the image files will 1987 typically be in the standard ISO format instead. Most 1988 commonly, you will select this option when installing 1989 an OS from an ISO file that you have obtained from the 1990 Internet. For example, most Linux distributions are 1991 available in this way. 1992 </para> 1993 1994 <para> 1995 For virtual CD/DVD drives, the following additional 1996 options are available: 1997 </para> 1998 1999 <itemizedlist> 2000 2001 <listitem> 2002 <para> 2003 If you select <emphasis role="bold">Host 2004 Drive</emphasis> from the list, then the physical 2005 device of the host computer is connected to the 2006 VM, so that the guest OS can read from and write 2007 to your physical device. This is, for instance, 2008 useful if you want to install Windows from a real 2009 installation CD. In this case, select your host 2010 drive from the drop-down list presented. 2011 </para> 2012 2013 <para> 2014 If you want to write, or burn, CDs or DVDs using 2015 the host drive, you need to also enable the 2016 <emphasis role="bold">Passthrough</emphasis> 2017 option. See <xref linkend="storage-cds" />. 2018 </para> 2019 </listitem> 2020 2021 <listitem> 2022 <para> 2023 If you select <emphasis role="bold">Remove Disk 2024 from Virtual Drive</emphasis>, &product-name; will 2025 present an empty CD/DVD drive to the guest into 2026 which no media has been inserted. 2027 </para> 2028 </listitem> 2029 2030 </itemizedlist> 2031 </listitem> 2032 2033 </itemizedlist> 2034 </listitem> 2035 2036 </orderedlist> 1931 <emphasis role="bold">Solid-state Drive</emphasis> 1932 presents a virtual disk to the guest as a solid-state 1933 device. 1934 </para> 1935 </listitem> 1936 1937 <listitem> 1938 <para> 1939 <emphasis role="bold">Hot-pluggable</emphasis> presents a 1940 virtual disk to the guest as a hot-pluggable device. 1941 </para> 1942 </listitem> 1943 1944 <listitem> 1945 <para> 1946 For virtual CD/DVD drives, you can select 1947 <emphasis role="bold">Live CD/DVD</emphasis>. This means 1948 that the virtual optical disk is not removed from when the 1949 guest system ejects it. 1950 </para> 1951 </listitem> 1952 1953 </itemizedlist> 2037 1954 </listitem> 2038 1955 … … 2199 2116 <command>VBoxManage</command> command to set up virtual serial 2200 2117 ports. For the latter, see <xref linkend="vboxmanage-modifyvm" /> 2201 for information on the < computeroutput>--uart</computeroutput>,2202 < computeroutput>--uartmode</computeroutput> and2203 <computeroutput>--uarttype</computeroutput>options.2118 for information on the <option>--uart</option>, 2119 <option>--uartmode</option> and <option>--uarttype</option> 2120 options. 2204 2121 </para> 2205 2122 … … 2250 2167 I/O base address and interrupt (IRQ). 2251 2168 </para> 2252 2253 <para>2254 See also2255 <ulink2256 url="http://en.wikipedia.org/wiki/COM_(hardware_interface)">http://en.wikipedia.org/wiki/COM_(hardware_interface)</ulink>.2257 </para>2258 2169 </listitem> 2259 2170 … … 2280 2191 virtual serial port to a physical serial port on your 2281 2192 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. 2193 <literal>COM1</literal>. On Linux or Oracle Solaris hosts, 2194 it will be a device node like 2195 <filename>/dev/ttyS0</filename>. &product-name; will then 2196 simply redirect all data received from and sent to the 2197 virtual serial port to the physical device. 2288 2198 </para> 2289 2199 </listitem> … … 2304 2214 through a named pipe. The pipe name must be in the 2305 2215 format 2306 <computeroutput>\\.\pipe\<name></computeroutput> 2307 where <computeroutput><name></computeroutput> 2308 should identify the virtual machine but may be freely 2309 chosen. 2216 <filename>\\.\pipe\<replaceable>name</replaceable></filename> 2217 where <replaceable>name</replaceable> should identify 2218 the virtual machine but may be freely chosen. 2310 2219 </para> 2311 2220 </listitem> … … 2313 2222 <listitem> 2314 2223 <para> 2315 On a Mac , Linux, or Oracle Solaris host, a local2224 On a Mac OS, Linux, or Oracle Solaris host, a local 2316 2225 domain socket is used instead. The socket filename 2317 2226 must be chosen such that the user running 2318 2227 &product-name; has sufficient privileges to create and 2319 write to it. The < computeroutput>/tmp</computeroutput>2320 directoryis often a good candidate.2228 write to it. The <filename>/tmp</filename> directory 2229 is often a good candidate. 2321 2230 </para> 2322 2231 … … 2324 2233 On Linux there are various tools which can connect to 2325 2234 a local domain socket or create one in server mode. 2326 The most flexible tool is 2327 <computeroutput>socat</computeroutput> and is 2328 available as part of many distributions. 2235 The most flexible tool is <command>socat</command> and 2236 is available as part of many distributions. 2329 2237 </para> 2330 2238 </listitem> … … 2396 2304 a virtual null-modem cable over the Internet or LAN, 2397 2305 the other side can connect using TCP by specifying 2398 < computeroutput>hostname:port</computeroutput> in the2399 <emphasis role="bold">Path/Address</emphasis> field.2400 The TCP socket will act in client mode if you select2401 the <emphasis role="bold">Connect to Existing2306 <literal><replaceable>hostname</replaceable>:<replaceable>port</replaceable></literal> 2307 in the <emphasis role="bold">Path/Address</emphasis> 2308 field. The TCP socket will act in client mode if you 2309 select the <emphasis role="bold">Connect to Existing 2402 2310 Pipe/Socket</emphasis> check box. 2403 2311 </para> … … 2567 2475 in hexadecimal, and a colon separates the vendor from 2568 2476 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. 2477 <literal>046d:c016</literal> stands for Logitech as a 2478 vendor, and the M-UV69a Optical Wheel Mouse product. 2572 2479 </para> 2573 2480 … … 2651 2558 &product-name; to capture devices when they are plugged in, and 2652 2559 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 2560 virtual machine. System reboots are not necessary after 2561 installing the driver. Also, you do not need to replug devices 2562 for &product-name; to claim them. 2563 </para> 2564 2565 <para> 2566 On supported Linux hosts, &product-name; accesses USB devices 2661 2567 through special files in the file system. When &product-name; is 2662 2568 installed, these are made available to all users in the 2663 <computeroutput>vboxusers</computeroutput> system group. In 2664 order to be able to access USB from guest systems, make sure 2665 that you are a member of this group. 2666 </para> 2667 2668 <para> 2669 On older Linux hosts, USB devices are accessed using the 2670 <computeroutput>usbfs</computeroutput> file system. Therefore, 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 2680 <xref 2681 linkend="ts_usb-linux" /> for details about 2682 <computeroutput>usbfs</computeroutput>. 2569 <literal>vboxusers</literal> system group. In order to be able 2570 to access USB from guest systems, make sure that you are a 2571 member of this group. 2683 2572 </para> 2684 2573 … … 2760 2649 <para> 2761 2650 &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. 2651 Firmware Interface (EFI), which is an industry standard intended 2652 to replace the legacy BIOS as the primary interface for 2653 bootstrapping computers and certain system services later. 2766 2654 </para> 2767 2655 … … 3225 3113 <para> 3226 3114 It is currently not possible to manipulate EFI variables from 3227 within a running guest. For example, setting the "boot-args" 3228 variable by running the <computeroutput>nvram</computeroutput> 3229 tool in a Mac OS X guest will not work. As an alternative way, 3230 "VBoxInternal2/EfiBootArgs" extradata can be passed to a VM in 3231 order to set the "boot-args" variable. To change the "boot-args" 3232 EFI variable, use the following command: 3115 within a running guest. For example, setting the 3116 <literal>boot-args</literal> variable by running the 3117 <command>nvram</command> tool in a Mac OS X guest will not work. 3118 As an alternative method, 3119 <literal>VBoxInternal2/EfiBootArgs</literal> extradata can be 3120 passed to a VM in order to set the <literal>boot-args</literal> 3121 variable. To change the <literal>boot-args</literal> EFI 3122 variable, use the following command: 3233 3123 </para> 3234 3124 -
trunk/doc/manual/en_US/user_ChangeLog.xml
r76786 r82350 41 41 42 42 <para> 43 <ulink url="https://www.virtualbox.org/wiki/Changelog" >https://www.virtualbox.org/wiki/Changelog</ulink>.43 <ulink url="https://www.virtualbox.org/wiki/Changelog" />. 44 44 </para> 45 45 -
trunk/doc/manual/en_US/user_Frontends.xml
r82045 r82350 34 34 <para> 35 35 Oracle provides support for the VirtualBox Remote Display Protocol 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. 36 (VRDP) in such an &product-name; extension package. 40 37 </para> 41 38 … … 55 52 </para> 56 53 57 <screen>VBoxManage modifyvm "VM name" --vrde on</screen> 58 59 <para> 60 By default, the VRDP server uses TCP port 61 <computeroutput>3389</computeroutput>. You will need to change the 62 default port if you run more than one VRDP server, since the port 63 can only be used by one server at a time. You might also need to 64 change it on Windows hosts since the default port might already be 65 used by the RDP server that is built into Windows itself. Ports 66 5000 through 5050 are typically not used and might be a good 67 choice. 54 <screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> --vrde on</screen> 55 56 <para> 57 By default, the VRDP server uses TCP port <literal>3389</literal>. 58 You will need to change the default port if you run more than one 59 VRDP server, since the port can only be used by one server at a 60 time. You might also need to change it on Windows hosts since the 61 default port might already be used by the RDP server that is built 62 into Windows itself. Ports 5000 through 5050 are typically not 63 used and might be a good choice. 68 64 </para> 69 65 … … 76 72 dash between two port numbers to specify a range. The VRDP server 77 73 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" />. 74 the specified list. For example, <command>VBoxManage modifyvm 75 <replaceable>VM-name</replaceable> --vrdeport 76 5000,5010-5012</command> configures the server to bind to one of 77 the ports 5000, 5010, 5011, or 5012. See 78 <xref linkend="vboxmanage-modifyvm" />. 82 79 </para> 83 80 … … 92 89 93 90 <para> 94 Support for IPv6 has been implemented in &product-name; 4.3. If95 the host OS supports IPv6 the VRDP server will automatically96 listen for IPv6 connections inaddition to IPv4.91 &product-name; supports IPv6. If the host OS supports IPv6 the 92 VRDP server will automatically listen for IPv6 connections in 93 addition to IPv4. 97 94 </para> 98 95 … … 134 131 135 132 <para> 136 Replace < computeroutput>1.2.3.4</computeroutput> with the137 host IP address, and <computeroutput>3389</computeroutput>138 with a different port, ifnecessary.133 Replace <literal>1.2.3.4</literal> with the host IP address, 134 and <literal>3389</literal> with a different port, if 135 necessary. 139 136 </para> 140 137 … … 145 142 <para> 146 143 IPv6 addresses must be enclosed in square brackets to 147 specify a port. For example: < computeroutput>mstsc148 [fe80::1:2:3:4]:3389</ computeroutput>144 specify a port. For example: <literal>mstsc 145 [fe80::1:2:3:4]:3389</literal> 149 146 </para> 150 147 </listitem> … … 153 150 <para> 154 151 When connecting to localhost in order to test the 155 connection, the addresses 156 <computeroutput>localhost</computeroutput> and 157 <computeroutput>127.0.0.1</computeroutput> might not 158 work using <command>mstsc.exe</command>. Instead, the 159 address 160 <computeroutput>127.0.0.2[:3389]</computeroutput> has 161 to be used. 152 connection, the addresses <literal>localhost</literal> 153 and <literal>127.0.0.1</literal> might not work using 154 <command>mstsc.exe</command>. Instead, the address 155 <literal>127.0.0.2[:3389]</literal> has to be used. 162 156 </para> 163 157 </listitem> … … 181 175 </para> 182 176 183 <screen>rdesktop -a 16 -N 1.2.3.4:3389</screen> 184 185 <para> 186 Replace <computeroutput>1.2.3.4</computeroutput> with the 187 host IP address, and <computeroutput>3389</computeroutput> 188 with a different port, if necessary. The <computeroutput>-a 189 16</computeroutput> option requests a color depth of 16 bits 190 per pixel, which we recommend. For best performance, after 191 installation of the guest operating system, you should set 192 its display color depth to the same value. The 193 <computeroutput>-N</computeroutput> option enables use of 194 the NumPad keys. 177 <screen>$ rdesktop -a 16 -N 1.2.3.4:3389</screen> 178 179 <para> 180 Replace <literal>1.2.3.4</literal> with the host IP address, 181 and <literal>3389</literal> with a different port, if 182 necessary. The <option>-a 16</option> option requests a 183 color depth of 16 bits per pixel, which we recommend. For 184 best performance, after installation of the guest operating 185 system, you should set its display color depth to the same 186 value. The <option>-N</option> option enables use of the 187 NumPad keys. 195 188 </para> 196 189 </listitem> … … 207 200 <para> 208 201 If you run the KDE desktop, you can use 209 <com puteroutput>krdc</computeroutput>, the KDE RDP viewer. A210 typicalcommand line is as follows:211 </para> 212 213 <screen> krdc rdp://1.2.3.4:3389</screen>214 215 <para> 216 Replace < computeroutput>1.2.3.4</computeroutput> with the217 host IP address, and <computeroutput>3389</computeroutput>218 with a different port, if necessary. The "rdp://" prefix is219 required with krdcto switch it into RDP mode.202 <command>krdc</command>, the KDE RDP viewer. A typical 203 command line is as follows: 204 </para> 205 206 <screen>$ krdc rdp://1.2.3.4:3389</screen> 207 208 <para> 209 Replace <literal>1.2.3.4</literal> with the host IP address, 210 and <literal>3389</literal> with a different port, if 211 necessary. The <literal>rdp:// </literal> prefix is required 212 with <command>krdc</command> to switch it into RDP mode. 220 213 </para> 221 214 </listitem> … … 241 234 While any VM started from the VirtualBox Manager is capable of 242 235 running virtual machines remotely, it is not convenient to have 243 to run the full -fledged GUI if you never want to have VMs244 displayed locally in the first place. In particular, if you are245 running server hardware whose only purpose is to host VMs, and246 all your VMs are supposed to run remotely over VRDP, then it is247 pointless to have a graphical user interface on the server at248 all. This is especially true for Linux or Oracle Solaris hosts,249 as the VirtualBox Manager comes with dependencies on the Qt and250 SDL libraries. This is inconvenient if you would rather not have251 theX Window system on your server at all.236 to run the full GUI if you never want to have VMs displayed 237 locally in the first place. In particular, if you are running 238 server hardware whose only purpose is to host VMs, and all your 239 VMs are supposed to run remotely over VRDP, then it is pointless 240 to have a graphical user interface on the server at all. This is 241 especially true for Linux or Oracle Solaris hosts, as the 242 VirtualBox Manager comes with dependencies on the Qt and SDL 243 libraries. This is inconvenient if you would rather not have the 244 X Window system on your server at all. 252 245 </para> 253 246 254 247 <para> 255 248 &product-name; therefore comes with a front-end called 256 <com puteroutput>VBoxHeadless</computeroutput>, which produces no257 visible output on the host at all, but still can optionally deliver258 VRDPdata. This front-end has no dependencies on the X Window system249 <command>VBoxHeadless</command>, which produces no visible 250 output on the host at all, but still can optionally deliver VRDP 251 data. This front-end has no dependencies on the X Window system 259 252 on Linux and Oracle Solaris hosts. 260 253 </para> … … 262 255 <note> 263 256 <para> 264 Before &product-name; 1.6, the headless server was called265 <computeroutput>VBoxVRDP</computeroutput>. For the sake of266 backwards compatibility, the &product-name; installation still267 installs an executable with that name as well.257 In legacy releases of &product-name;, the headless server was 258 called <command>VBoxVRDP</command>. For backwards 259 compatibility, the &product-name; installation still includes 260 an executable with that name. 268 261 </para> 269 262 </note> 270 263 271 264 <para> 272 To start a virtual machine with 273 <computeroutput>VBoxHeadless</computeroutput>, you have the 274 following options: 265 To start a virtual machine with <command>VBoxHeadless</command>, 266 you have the following options: 275 267 </para> 276 268 … … 282 274 </para> 283 275 284 <screen>VBoxManage startvm "VM name" --type headless</screen> 285 286 <para> 287 The <computeroutput>--type</computeroutput> option causes 288 &product-name; to use 289 <computeroutput>VBoxHeadless</computeroutput> as the 290 front-end to the internal virtualization engine, instead of 291 the Qt front-end. 276 <screen>$ VBoxManage startvm <replaceable>VM-name</replaceable> --type headless</screen> 277 278 <para> 279 The <option>--type</option> option causes &product-name; to 280 use <command>VBoxHeadless</command> as the front-end to the 281 internal virtualization engine, instead of the Qt front-end. 292 282 </para> 293 283 </listitem> … … 298 288 </para> 299 289 300 <screen>VBoxHeadless --startvm <uuid|name></screen>290 <screen>VBoxHeadless --startvm <replaceable>uuid</replaceable>|<replaceable>vmname</replaceable></screen> 301 291 302 292 <para> … … 309 299 directly as a background process which has to be done 310 300 explicitly when directly starting with 311 <computeroutput>VBoxHeadless</computeroutput>. The full 312 documentation of the command is in 313 <xref linkend="man_vboxheadless"/>. 314 </para> 315 </listitem> 316 317 <listitem> 318 <para> 319 Start <computeroutput>VBoxHeadless</computeroutput> from the 320 VirtualBox Manager GUI, by pressing the Shift key when 321 starting a virtual machine or by selecting 301 <command>VBoxHeadless</command>. The full documentation of 302 the command is in <xref linkend="man_vboxheadless"/>. 303 </para> 304 </listitem> 305 306 <listitem> 307 <para> 308 Start <command>VBoxHeadless</command> from the VirtualBox 309 Manager GUI, by pressing the Shift key when starting a 310 virtual machine or by selecting 322 311 <emphasis role="bold">Headless Start</emphasis> from the 323 312 <emphasis role="bold">Machine</emphasis> menu. … … 328 317 329 318 <para> 330 When you use the <com puteroutput>VBoxHeadless</computeroutput>331 command to start a VM, the VRDP server will be enabled according332 to the VMconfiguration. You can override the VM's setting using333 < computeroutput>--vrde</computeroutput> command line parameter.334 To enable theVRDP server, start the VM as follows:335 </para> 336 337 <screen>VBoxHeadless --startvm <uuid|name>--vrde on</screen>319 When you use the <command>VBoxHeadless</command> command to 320 start a VM, the VRDP server will be enabled according to the VM 321 configuration. You can override the VM's setting using 322 <option>--vrde</option> command line parameter. To enable the 323 VRDP server, start the VM as follows: 324 </para> 325 326 <screen>VBoxHeadless --startvm <replaceable>uuid</replaceable>|<replaceable>vmname</replaceable> --vrde on</screen> 338 327 339 328 <para> … … 341 330 </para> 342 331 343 <screen>VBoxHeadless --startvm <uuid|name>--vrde off</screen>332 <screen>VBoxHeadless --startvm <replaceable>uuid</replaceable>|<replaceable>vmname</replaceable> --vrde off</screen> 344 333 345 334 <para> … … 348 337 </para> 349 338 350 <screen>VBoxHeadless --startvm <uuid|name>--vrde config</screen>339 <screen>VBoxHeadless --startvm <replaceable>uuid</replaceable>|<replaceable>vmname</replaceable> --vrde config</screen> 351 340 352 341 <para> … … 354 343 </para> 355 344 356 <screen>VBoxHeadless --startvm <uuid|name></screen>345 <screen>VBoxHeadless --startvm <replaceable>uuid</replaceable>|<replaceable>vmname</replaceable></screen> 357 346 358 347 <para> … … 398 387 <para> 399 388 A terminal connection to that host through which you can 400 access a command line, such as 401 <computeroutput>ssh</computeroutput>. 389 access a command line, such as <command>ssh</command>. 402 390 </para> 403 391 </listitem> … … 428 416 429 417 <para> 430 If you do not specify 431 <computeroutput>--register</computeroutput>, you will have 432 to manually use the <command>registervm</command> command 433 later. 434 </para> 435 436 <para> 437 You do not need to specify 438 <computeroutput>--ostype</computeroutput>, but doing so 439 selects some sensible default values for certain VM 418 If you do not specify <option>--register</option>, you will 419 have to manually use the <command>registervm</command> 420 command later. 421 </para> 422 423 <para> 424 You do not need to specify <option>--ostype</option>, but 425 doing so selects some sensible default values for certain VM 440 426 parameters. For example, the RAM size and the type of the 441 427 virtual network device. To get a complete list of supported … … 564 550 supports this extension. On Linux and Oracle Solaris hosts, the 565 551 &product-name; installation provides a suitable VRDP client 566 called <command>rdesktop-vrdp</command>. Recentversions of552 called <command>rdesktop-vrdp</command>. Some versions of 567 553 <command>uttsc</command>, a client tailored for the use with Sun 568 554 Ray thin clients, also support accessing remote USB devices. RDP … … 628 614 <para> 629 615 The default authentication library, 630 <com puteroutput>VBoxAuth</computeroutput>, authenticates631 against user credentials of the hosts. Depending on the632 hostplatform, this means the following:616 <command>VBoxAuth</command>, authenticates against user 617 credentials of the hosts. Depending on the host 618 platform, this means the following: 633 619 </para> 634 620 … … 637 623 <listitem> 638 624 <para> 639 On Linux hosts, 640 <computeroutput>VBoxAuth.so</computeroutput> 625 On Linux hosts, <command>VBoxAuth.so</command> 641 626 authenticates users against the host's PAM system. 642 627 </para> … … 645 630 <listitem> 646 631 <para> 647 On Windows hosts, 648 <computeroutput>VBoxAuth.dll</computeroutput> 632 On Windows hosts, <command>VBoxAuth.dll</command> 649 633 authenticates users against the host's WinLogon 650 634 system. … … 654 638 <listitem> 655 639 <para> 656 On Mac OS X hosts, 657 <computeroutput>VBoxAuth.dylib</computeroutput> 640 On Mac OS X hosts, <command>VBoxAuth.dylib</command> 658 641 authenticates users against the host's directory 659 642 service. … … 675 658 <para> 676 659 An additional library called 677 <com puteroutput>VBoxAuthSimple</computeroutput> performs660 <command>VBoxAuthSimple</command> performs 678 661 authentication against credentials configured in the 679 "extradata" section of a virtual machine's XML settings 680 file. This is probably the simplest way to get 681 authentication that does not depend on a running and 682 supported guest. The following steps are required: 662 <literal>extradata</literal> section of a virtual 663 machine's XML settings file. This is probably the 664 simplest way to get authentication that does not depend 665 on a running and supported guest. The following steps 666 are required: 683 667 </para> 684 668 … … 687 671 <listitem> 688 672 <para> 689 Enable 690 <computeroutput>VBoxAuthSimple</computeroutput> with 691 the following command: 673 Enable <command>VBoxAuthSimple</command> with the 674 following command: 692 675 </para> 693 676 … … 701 684 </para> 702 685 703 <screen>VBoxManage modifyvm "VM name"--vrdeauthtype external</screen>686 <screen>VBoxManage modifyvm <replaceable>VM-name</replaceable> --vrdeauthtype external</screen> 704 687 705 688 <para> 706 Replace < computeroutput><vm></computeroutput>707 with theVM name or UUID.689 Replace <replaceable>VM-name</replaceable> with the 690 VM name or UUID. 708 691 </para> 709 692 </listitem> … … 714 697 writing items into the machine's extradata. Since 715 698 the XML machine settings file, into whose 716 < computeroutput>extradata</computeroutput> section717 the password needs to be written, is a plain text718 file, &product-name; uses hashes to encrypt719 passwords. Thefollowing command must be used:699 <literal>extradata</literal> section the password 700 needs to be written, is a plain text file, 701 &product-name; uses hashes to encrypt passwords. The 702 following command must be used: 720 703 </para> 721 704 722 <screen>VBoxManage setextradata "VM name" "VBoxAuthSimple/users/<user>" <hash></screen>705 <screen>VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxAuthSimple/users/<replaceable>user</replaceable>" <replaceable>hash</replaceable></screen> 723 706 724 707 <para> 725 Replace <computeroutput><vm></computeroutput> 726 with the VM name or UUID, 727 <computeroutput><user></computeroutput> with 728 the user name who should be allowed to log in and 729 <computeroutput><hash></computeroutput> with 730 the encrypted password. As an example, to obtain the 731 hash value for the password 732 <computeroutput>secret</computeroutput>, you can use 733 the following command: 708 Replace <replaceable>VM-name</replaceable> with the 709 VM name or UUID, <replaceable>user</replaceable> 710 with the user name who should be allowed to log in 711 and <replaceable>hash</replaceable> with the 712 encrypted password. The following command example 713 obtains the hash value for the password 714 <literal>secret</literal>: 734 715 </para> 735 716 736 <screen>VBoxManage internalcommands passwordhash "secret"</screen> 737 738 <para> 739 This command will generate output similar to the 740 following: 741 </para> 742 743 <screen>2bb80d537b1da3e38bd30361aa855686bde0eacd7162fef6a25fe97bf527a25b</screen> 717 <screen>$ VBoxManage internalcommands passwordhash "secret" 718 2bb80d537b1da3e38bd30361aa855686bde0eacd7162fef6a25fe97bf527a25b</screen> 744 719 745 720 <para> 746 721 You then use <command>VBoxManage 747 722 setextradata</command> to store this value in the 748 machine's <computeroutput>extradata</computeroutput> 749 section. 723 machine's <literal>extradata</literal> section. 750 724 </para> 751 725 752 726 <para> 753 727 As a combined example, to set the password for the 754 user <computeroutput>john</computeroutput> and the 755 machine <computeroutput>My VM</computeroutput> to 756 <computeroutput>secret</computeroutput>, use this 757 command: 728 user <literal>john</literal> and the machine 729 <literal>My VM</literal> to 730 <literal>secret</literal>, use this command: 758 731 </para> 759 732 … … 814 787 <listitem> 815 788 <para> 816 <emphasis role="bold">RDP 4</emphasis> authentication was817 used historically. With RDP 4, the RDP client does not789 <emphasis role="bold">RDP 4</emphasis> authentication was 790 used historically. With RDP 4, the RDP client does not 818 791 perform any checks in order to verify the identity of the 819 792 server it connects to. Since user credentials can be … … 825 798 <listitem> 826 799 <para> 827 <emphasis role="bold">RDP 5.1</emphasis> authentication800 <emphasis role="bold">RDP 5.1</emphasis> authentication 828 801 employs a server certificate for which the client possesses 829 802 the public key. This way it is guaranteed that the server 830 803 possess the corresponding private key. However, as this 831 hard-coded private key became public some years ago, RDP 5.1804 hard-coded private key became public some years ago, RDP 5.1 832 805 authentication is also insecure. 833 806 </para> … … 836 809 <listitem> 837 810 <para> 838 <emphasis role="bold">RDP5.2</emphasis> authentication uses 839 Enhanced RDP Security, which means that an external security 840 protocol is used to secure the connection. RDP4 and RDP5.1 841 use Standard RDP Security. The VRDP server supports Enhanced 842 RDP Security with TLS protocol and, as a part of TLS 843 handshake, sends the server certificate to the client. 844 </para> 845 846 <para> 847 The <computeroutput>Security/Method</computeroutput> VRDE 848 property sets the desired security method, which is used for 849 a connection. Valid values are as follows: 811 <emphasis role="bold">RDP 5.2 or later</emphasis> 812 authentication uses Enhanced RDP Security, which means that 813 an external security protocol is used to secure the 814 connection. RDP 4 and RDP 5.1 use Standard RDP Security. The 815 VRDP server supports Enhanced RDP Security with TLS protocol 816 and, as a part of the TLS handshake, sends the server 817 certificate to the client. 818 </para> 819 820 <para> 821 The <literal>Security/Method</literal> VRDE property sets 822 the desired security method, which is used for a connection. 823 Valid values are as follows: 850 824 </para> 851 825 … … 875 849 876 850 <para> 877 The OpenSSL library version determines which versions of 878 TLS are supported. The &product-name; clients include at 879 least Version 1.1.0 of the OpenSSL library. This library 880 supports TLS versions 1.0, 1.1, and 1.2. Some clients 881 might include newer versions of the OpenSSL library and 882 thus support additional TLS versions. 851 The version of OpenSSL used by &product-name; supports 852 TLS versions 1.0, 1.1, 1.2, and 1.3. 883 853 </para> 884 854 </listitem> … … 891 861 </para> 892 862 893 <screen>vboxmanage modifyvm "VM name"--vrdeproperty "Security/Method=negotiate"</screen>894 895 <para> 896 If the < computeroutput>Security/Method</computeroutput>897 property is set to either Negotiate or TLS, the TLS protocol898 will be automatically used by the server, if the client899 supports TLS. However, in order to use TLS the server must900 possess the Server Certificate, the Server Private Key and901 theCertificate Authority (CA) Certificate. The following863 <screen>vboxmanage modifyvm <replaceable>VM-name</replaceable> --vrdeproperty "Security/Method=negotiate"</screen> 864 865 <para> 866 If the <literal>Security/Method</literal> property is set to 867 either Negotiate or TLS, the TLS protocol will be 868 automatically used by the server, if the client supports 869 TLS. However, in order to use TLS the server must possess 870 the Server Certificate, the Server Private Key and the 871 Certificate Authority (CA) Certificate. The following 902 872 example shows how to generate a server certificate. 903 873 </para> … … 939 909 </para> 940 910 941 <screen>vboxmanage modifyvm "VM name"\911 <screen>vboxmanage modifyvm <replaceable>VM-name</replaceable> \ 942 912 --vrdeproperty "Security/CACertificate=path/ca_cert.pem"</screen> 943 913 944 <screen>vboxmanage modifyvm "VM name"\914 <screen>vboxmanage modifyvm <replaceable>VM-name</replaceable> \ 945 915 --vrdeproperty "Security/ServerCertificate=path/server_cert.pem"</screen> 946 916 947 <screen>vboxmanage modifyvm "VM name"\917 <screen>vboxmanage modifyvm <replaceable>VM-name</replaceable> \ 948 918 --vrdeproperty "Security/ServerPrivateKey=path/server_key_private.pem"</screen> 949 919 </listitem> … … 954 924 As the client that connects to the server determines what type 955 925 of encryption will be used, with <command>rdesktop</command>, 956 the Linux RDP viewer, use the 957 <computeroutput>-4</computeroutput> or 958 <computeroutput>-5</computeroutput> options. 926 the Linux RDP viewer, use the <option>-4</option> or 927 <option>-5</option> options. 959 928 </para> 960 929 … … 978 947 </para> 979 948 980 <screen>VBoxManage modifyvm "VM name"--vrdemulticon on</screen>949 <screen>VBoxManage modifyvm <replaceable>VM-name</replaceable> --vrdemulticon on</screen> 981 950 982 951 </sect2> … … 994 963 <para> 995 964 The RDP client can select the virtual monitor number to connect 996 to using the <computeroutput>domain</computeroutput> login 997 parameter (<computeroutput>-d</computeroutput>). If the 998 parameter ends with <computeroutput>@</computeroutput> followed 999 by a number, &product-name; interprets this number as the screen 1000 index. The primary guest screen is selected with 1001 <computeroutput>@1</computeroutput>, the first secondary screen 1002 is <computeroutput>@2</computeroutput>, and so on. 1003 </para> 1004 1005 <para> 1006 The Microsoft RDP6 client does not let you specify a separate 965 to using the <literal>domain</literal> login parameter 966 (<option>-d</option>). If the parameter ends with 967 <literal>@</literal> followed by a number, &product-name; 968 interprets this number as the screen index. The primary guest 969 screen is selected with <literal>@1</literal>, the first 970 secondary screen is <literal>@2</literal>, and so on. 971 </para> 972 973 <para> 974 The Microsoft RDP 6 client does not let you specify a separate 1007 975 domain name. Instead, enter 1008 <computeroutput>domain\username</computeroutput> in the 1009 <emphasis role="bold">Username</emphasis> field. For example, 1010 <computeroutput>@2\name</computeroutput>. 1011 <computeroutput>name</computeroutput> must be supplied, and must 1012 be the name used to log in if the VRDP server is set up to 1013 require credentials. If it is not, you may use any text as the 1014 username. 976 <literal><replaceable>domain</replaceable>\<replaceable>username</replaceable></literal> 977 in the <emphasis role="bold">Username</emphasis> field. For 978 example, <literal>@2\<replaceable>name</replaceable></literal>. 979 <replaceable>name</replaceable> must be supplied, and must be 980 the name used to log in if the VRDP server is set up to require 981 credentials. If it is not, you may use any text as the username. 1015 982 </para> 1016 983 … … 1048 1015 </para> 1049 1016 1050 <screen>VBoxManage modifyvm "VM name"--vrdevideochannel on</screen>1017 <screen>VBoxManage modifyvm <replaceable>VM-name</replaceable> --vrdevideochannel on</screen> 1051 1018 1052 1019 <para> … … 1057 1024 </para> 1058 1025 1059 <screen>VBoxManage modifyvm "VM name"--vrdevideochannelquality 75</screen>1026 <screen>VBoxManage modifyvm <replaceable>VM-name</replaceable> --vrdevideochannelquality 75</screen> 1060 1027 1061 1028 </sect2> … … 1066 1033 1067 1034 <para> 1068 With &product-name; it is possible to disable display output, 1069 mouse and keyboard input, audio, remote USB, or clipboard 1070 individually in the VRDP server. 1035 You can disable display output, mouse and keyboard input, audio, 1036 remote USB, or clipboard individually in the VRDP server. 1071 1037 </para> 1072 1038 … … 1075 1041 </para> 1076 1042 1077 <screen> VBoxManage modifyvm "VM name"--vrdeproperty Client/DisableDisplay=11078 VBoxManage modifyvm "VM name"--vrdeproperty Client/DisableInput=11079 VBoxManage modifyvm "VM name"--vrdeproperty Client/DisableUSB=11080 VBoxManage modifyvm "VM name"--vrdeproperty Client/DisableAudio=11081 VBoxManage modifyvm "VM name"--vrdeproperty Client/DisableClipboard=11082 VBoxManage modifyvm "VM name"--vrdeproperty Client/DisableUpstreamAudio=1</screen>1043 <screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> --vrdeproperty Client/DisableDisplay=1 1044 $ VBoxManage modifyvm <replaceable>VM-name</replaceable> --vrdeproperty Client/DisableInput=1 1045 $ VBoxManage modifyvm <replaceable>VM-name</replaceable> --vrdeproperty Client/DisableUSB=1 1046 $ VBoxManage modifyvm <replaceable>VM-name</replaceable> --vrdeproperty Client/DisableAudio=1 1047 $ VBoxManage modifyvm <replaceable>VM-name</replaceable> --vrdeproperty Client/DisableClipboard=1 1048 $ VBoxManage modifyvm <replaceable>VM-name</replaceable> --vrdeproperty Client/DisableUpstreamAudio=1</screen> 1083 1049 1084 1050 <para> … … 1087 1053 </para> 1088 1054 1089 <screen> VBoxManage modifyvm "VM name"--vrdeproperty Client/DisableDisplay=</screen>1055 <screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> --vrdeproperty Client/DisableDisplay=</screen> 1090 1056 1091 1057 </sect2> … … 1174 1140 </para> 1175 1141 1176 <screen>VBoxManage modifyvm <targetvmname> --teleporter on --teleporterport <port></screen>1142 <screen>VBoxManage modifyvm <replaceable>targetvmname</replaceable> --teleporter on --teleporterport <replaceable>port</replaceable></screen> 1177 1143 1178 1144 <para> 1179 where <computeroutput><targetvmname></computeroutput> is 1180 the name of the virtual machine on the target host and 1181 <computeroutput><port></computeroutput> is a TCP/IP port 1182 number to be used on both the source and the target hosts. For 1183 example, use 6000. See 1184 <xref linkend="vboxmanage-modifyvm-teleport" />. 1145 <replaceable>targetvmname</replaceable> is the name of the 1146 virtual machine on the target host and 1147 <replaceable>port</replaceable> is a TCP/IP port number to be 1148 used on both the source and the target hosts. For example, use 1149 6000. See <xref linkend="vboxmanage-modifyvm" />. 1185 1150 </para> 1186 1151 </listitem> … … 1201 1166 </para> 1202 1167 1203 <screen>VBoxManage controlvm <sourcevmname> teleport --host <targethost> --port <port></screen>1168 <screen>VBoxManage controlvm <replaceable>sourcevmname</replaceable> teleport --host <replaceable>targethost</replaceable> --port <replaceable>port</replaceable></screen> 1204 1169 1205 1170 <para> 1206 where <computeroutput><sourcevmname></computeroutput> is 1207 the name of the virtual machine on the source host, which is 1208 the machine that is currently running. 1209 <computeroutput><targethost></computeroutput> is the 1210 host or IP name of the target host on which the machine is 1211 waiting for the teleport request, and 1212 <computeroutput><port></computeroutput> must be the same 1213 number as specified in the command on the target host. See 1214 <xref linkend="vboxmanage-controlvm" />. 1171 where <replaceable>sourcevmname</replaceable> is the name of 1172 the virtual machine on the source host, which is the machine 1173 that is currently running. 1174 <replaceable>targethost</replaceable> is the host or IP name 1175 of the target host on which the machine is waiting for the 1176 teleport request, and <replaceable>port</replaceable> must be 1177 the same number as specified in the command on the target 1178 host. See <xref linkend="vboxmanage-controlvm" />. 1215 1179 </para> 1216 1180 </listitem> … … 1234 1198 capabilities are presented to the guest operating system. 1235 1199 Advanced users can attempt to restrict these virtual CPU 1236 capabilities with the <com puteroutput>VBoxManage modifyvm1237 --cpuid</com puteroutput> command. See1238 <xref linkend="vboxmanage-modifyvm -teleport" />.1200 capabilities with the <command>VBoxManage modifyvm 1201 --cpuid</command> command. See 1202 <xref linkend="vboxmanage-modifyvm" />. 1239 1203 </para> 1240 1204 </note> … … 1244 1208 <xi:include href="user_man_VBoxHeadless.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" /> 1245 1209 1246 1247 1210 </chapter> -
trunk/doc/manual/en_US/user_Glossary.xml
r76078 r82350 138 138 application programming interfaces which can be accessed from 139 139 various other programming languages and applications. 140 &product-name; makes use of COM both internally and externally to141 provide a comprehensive API to 3rd party developers.140 &product-name; makes use of COM both internally and externally 141 to provide a comprehensive API to 3rd party developers. 142 142 </para> 143 143 … … 221 221 "command line interface". In the context of &product-name;, we 222 222 sometimes refer to the main graphical 223 <com puteroutput>VirtualBox</computeroutput> program as the224 "GUI", to differentiate it from the225 <command>VBoxManage</command>interface.223 <command>VirtualBox</command> program as the "GUI", to 224 differentiate it from the <command>VBoxManage</command> 225 interface. 226 226 </para> 227 227 … … 300 300 card. It is typically written in hexadecimal notation where 301 301 the bytes are separated by colons, such as 302 < computeroutput>00:17:3A:5E:CB:08</computeroutput>.302 <literal>00:17:3A:5E:CB:08</literal>. 303 303 </para> 304 304 … … 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, &product-name; can use NAT to342 easily share a host's physical networking hardware with its341 internal network from the Internet, &product-name; can use NAT 342 to easily share a host's physical networking hardware with its 343 343 virtual machines. See <xref 344 344 linkend="network_nat" />. … … 382 382 Physical Address Extension. This enables access to more than 4 383 383 GB of RAM, even in 32-bit environments. See 384 <xref 385 linkend="settings-general-advanced" />. 384 <xref linkend="settings-general-advanced" />. 386 385 </para> 387 386 … … 435 434 transferred in both directions. Typically graphics updates and 436 435 audio are sent from the remote machine and keyboard and mouse 437 input events are sent from the client. An &product-name; extension438 package by Oracle provides VRDP, an enhanced implementation of439 the relevant standards which is largely compatible with440 Microsoft's RDP implementation. See <xref linkend="vrde" />441 for details.436 input events are sent from the client. An &product-name; 437 extension package by Oracle provides VRDP, an enhanced 438 implementation of the relevant standards which is largely 439 compatible with Microsoft's RDP implementation. See 440 <xref linkend="vrde" /> for details. 442 441 </para> 443 442 … … 537 536 UNIX versions for backing up data on tape. The file format is 538 537 still widely used today. For example, with OVF archives using 539 an < computeroutput>.ova</computeroutput> file extension. See538 an <filename>.ova</filename> file extension. See 540 539 <xref 541 540 linkend="ovf" />. … … 561 560 and letters which can be computed dynamically and is 562 561 guaranteed to be unique. Generally, it is used as a global 563 handle to identify entities. &product-name; makes use of UUIDs to564 identify VMs, Virtual Disk Images (VDI files), and other562 handle to identify entities. &product-name; makes use of UUIDs 563 to identify VMs, Virtual Disk Images (VDI files), and other 565 564 entities. 566 565 </para> … … 581 580 582 581 <para> 583 Virtual Machine. A virtual computer that &product-name; enables584 you to run on top of your actual hardware. See582 Virtual Machine. A virtual computer that &product-name; 583 enables you to run on top of your actual hardware. See 585 584 <xref 586 585 linkend="virtintro" /> for details. … … 612 611 <para> 613 612 VirtualBox Remote Desktop Extension. This interface is built 614 into &product-name; to allow &product-name; extension packages to615 supply remote access to virtual machines. An &product-name;613 into &product-name; to allow &product-name; extension packages 614 to supply remote access to virtual machines. An &product-name; 616 615 extension package by Oracle provides VRDP support. See 617 616 <xref linkend="vrde" />. … … 689 688 infrastructure developed by the Mozilla browser project which 690 689 is similar to Microsoft COM and enables applications to 691 provide a modular programming interface. &product-name; makes use692 of XPCOM on Linux both internally and externally to provide a693 comprehensive API to third-party developers.690 provide a modular programming interface. &product-name; makes 691 use of XPCOM on Linux both internally and externally to 692 provide a comprehensive API to third-party developers. 694 693 </para> 695 694 -
trunk/doc/manual/en_US/user_GuestAdditions.xml
r76786 r82350 36 36 The &product-name; Guest Additions for all supported guest 37 37 operating systems are provided as a single CD-ROM image file which 38 is called <computeroutput>VBoxGuestAdditions.iso</computeroutput>. 39 This image file is located in the installation directory of 40 &product-name;. To install the Guest Additions for a particular 41 VM, you mount this ISO file in your VM as a virtual CD-ROM and 42 install from there. 38 is called <filename>VBoxGuestAdditions.iso</filename>. This image 39 file is located in the installation directory of &product-name;. 40 To install the Guest Additions for a particular VM, you mount this 41 ISO file in your VM as a virtual CD-ROM and install from there. 43 42 </para> 44 43 … … 56 55 you with seamless mouse support. You will only have one mouse 57 56 pointer and pressing the Host key is no longer required to 58 "free" the mouse from being captured by the guest OS. To make 59 this work, a special mouse driver is installed in the guest 60 that communicates with the "real" mouse driver on your host 61 and moves the guest mouse pointer accordingly. 57 <emphasis>free</emphasis> the mouse from being captured by the 58 guest OS. To make this work, a special mouse driver is 59 installed in the guest that communicates with the physical 60 mouse driver on your host and moves the guest mouse pointer 61 accordingly. 62 62 </para> 63 63 </listitem> … … 71 71 folder, and &product-name; will make it available to the guest 72 72 operating system as a network share, irrespective of whether 73 guest actually has a network. See 74 <xref 75 linkend="sharedfolders" />. 73 the guest actually has a network. See 74 <xref linkend="sharedfolders" />. 76 75 </para> 77 76 </listitem> … … 118 117 <emphasis role="bold">Generic host/guest communication 119 118 channels.</emphasis> The Guest Additions enable you to control 120 and monitor guest execution. The "guest properties" provide a121 generic string-based mechanism to exchange data bits between a122 guest and a host, some of which have special meanings for123 controlling and monitoring the guest. See124 <xref linkend="guestadd-guestprops" />.119 and monitor guest execution. The <emphasis>guest 120 properties</emphasis> provide a generic string-based mechanism 121 to exchange data bits between a guest and a host, some of 122 which have special meanings for controlling and monitoring the 123 guest. See <xref linkend="guestadd-guestprops" />. 125 124 </para> 126 125 … … 148 147 differs slightly, the time synchronization service attempts to 149 148 gradually and smoothly adjust the guest time in small 150 increments to either "catch up" or "lose"time. When the149 increments to either catch up or lose time. When the 151 150 difference is too great, for example if a VM paused for hours 152 151 or restored from saved state, the guest time is changed … … 199 198 To disable this update check for the Guest Additions of a given 200 199 virtual machine, set the value of its 201 < computeroutput>/VirtualBox/GuestAdd/CheckHostVersion</computeroutput>202 guest property to <computeroutput>0</computeroutput>. See200 <literal>/VirtualBox/GuestAdd/CheckHostVersion</literal> guest 201 property to <literal>0</literal>. See 203 202 <xref 204 203 linkend="guestadd-guestprops" />. … … 343 342 <listitem> 344 343 <para> 345 Select <emphasis role="bold"> Mount CD/DVD-ROM</emphasis>344 Select <emphasis role="bold">Optical Drives</emphasis> 346 345 from the <emphasis role="bold">Devices</emphasis> menu in 347 346 the virtual machine's menu bar and then 348 <emphasis role="bold">CD/DVD-ROM Image</emphasis>. This 349 displays the Virtual Media Manager, described in 350 <xref 351 linkend="vdis" />. 347 <emphasis role="bold">Choose/Create a Disk 348 Image</emphasis>. This displays the Virtual Media Manager, 349 described in <xref linkend="vdis" />. 352 350 </para> 353 351 </listitem> … … 358 356 <emphasis role="bold">Add</emphasis> and browse your host 359 357 file system for the 360 <computeroutput>VBoxGuestAdditions.iso</computeroutput> 361 file. 358 <filename>VBoxGuestAdditions.iso</filename> file. 362 359 </para> 363 360 … … 368 365 On a Windows host, this file is in the &product-name; 369 366 installation directory, usually in 370 < computeroutput>C:\Program371 files\Oracle\VirtualBox</ computeroutput>.367 <filename>C:\Program 368 files\Oracle\VirtualBox</filename>. 372 369 </para> 373 370 </listitem> … … 380 377 <emphasis role="bold">Show Package 381 378 Contents</emphasis>. The file is located in the 382 <computeroutput>Contents/MacOS</computeroutput> 383 folder. 379 <filename>Contents/MacOS</filename> folder. 384 380 </para> 385 381 </listitem> … … 388 384 <para> 389 385 On a Linux host, this file is in the 390 < computeroutput>additions</computeroutput> folder391 where youinstalled &product-name;, usually392 < computeroutput>/opt/VirtualBox/</computeroutput>.386 <filename>additions</filename> folder where you 387 installed &product-name;, usually 388 <filename>/opt/VirtualBox/</filename>. 393 389 </para> 394 390 </listitem> … … 397 393 <para> 398 394 On Oracle Solaris hosts, this file is in the 399 < computeroutput>additions</computeroutput> folder400 where youinstalled &product-name;, usually401 < computeroutput>/opt/VirtualBox</computeroutput>.395 <filename>additions</filename> folder where you 396 installed &product-name;, usually 397 <filename>/opt/VirtualBox</filename>. 402 398 </para> 403 399 </listitem> … … 409 405 <para> 410 406 In the Virtual Media Manager, select the ISO file and 411 click <emphasis role="bold">Select</emphasis> button. This412 mounts the ISO file and presents it to your Windows guest413 as a CD-ROM.407 click the <emphasis role="bold">Add</emphasis> button. 408 This mounts the ISO file and presents it to your Windows 409 guest as a CD-ROM. 414 410 </para> 415 411 </listitem> … … 422 418 Additions installation program from the Additions ISO. If the 423 419 Autostart feature has been turned off, choose 424 < computeroutput>VBoxWindowsAdditions.exe</computeroutput> from425 the CD/DVDdrive inside the guest to start the installer.420 <filename>VBoxWindowsAdditions.exe</filename> from the CD/DVD 421 drive inside the guest to start the installer. 426 422 </para> 427 423 … … 461 457 </para> 462 458 463 < orderedlist>459 <itemizedlist> 464 460 465 461 <listitem> … … 475 471 </listitem> 476 472 477 </ orderedlist>473 </itemizedlist> 478 474 479 475 <para> … … 510 506 Installing the code signing certificates on a Windows guest 511 507 can be done automatically. Use the 512 < computeroutput>VBoxCertUtil.exe</computeroutput> utility from513 the <computeroutput>cert</computeroutput> folder on the Guest514 Additionsinstallation CD.508 <filename>VBoxCertUtil.exe</filename> utility from the 509 <filename>cert</filename> folder on the Guest Additions 510 installation CD. 515 511 </para> 516 512 … … 536 532 <para> 537 533 Open a command line window on the guest and change to the 538 < computeroutput>cert</computeroutput> folder on the539 &product-name;Guest Additions CD.534 <filename>cert</filename> folder on the &product-name; 535 Guest Additions CD. 540 536 </para> 541 537 </listitem> … … 577 573 driver needs to be installed. To select this driver by 578 574 default, add the command line parameter 579 < computeroutput>/with_wddm</computeroutput> when invoking580 the Windows Guest Additions installer. This is only required581 for Vistaand Windows 7.575 <literal>/with_wddm</literal> when invoking the Windows 576 Guest Additions installer. This is only required for Vista 577 and Windows 7. 582 578 </para> 583 579 </note> … … 616 612 a 32-bit system, you must use the appropriate platform 617 613 installer. Use 618 <computeroutput>VBoxWindowsAdditions-x86.exe</computeroutput> 619 or 620 <computeroutput>VBoxWindowsAdditions-amd64.exe</computeroutput> 621 with the <computeroutput>/extract</computeroutput> parameter. 614 <filename>VBoxWindowsAdditions-x86.exe</filename> or 615 <filename>VBoxWindowsAdditions-amd64.exe</filename> with the 616 <literal>/extract</literal> parameter. 622 617 </para> 623 618 … … 657 652 <listitem> 658 653 <para> 659 Red hat Enterprise Linux as of version 3654 Red Hat Enterprise Linux as of version 3 660 655 </para> 661 656 </listitem> … … 744 739 <listitem> 745 740 <para> 746 Insert the 747 <computeroutput>VBoxGuestAdditions.iso</computeroutput> CD 741 Insert the <filename>VBoxGuestAdditions.iso</filename> CD 748 742 file into your Linux guest's virtual CD-ROM drive, as 749 743 described for a Windows guest in … … 830 824 into the virtual CD-ROM drive as described above. Then run the 831 825 installer for the current Guest Additions with the 832 < computeroutput>uninstall</computeroutput> parameter fromthe833 path that theCD image is mounted on in the guest, as follows:826 <literal>uninstall</literal> parameter from the path that the 827 CD image is mounted on in the guest, as follows: 834 828 </para> 835 829 … … 853 847 <para> 854 848 Replace 855 < computeroutput>/opt/VBoxGuestAdditions-<replaceable>version</replaceable></computeroutput>849 <filename>/opt/VBoxGuestAdditions-<replaceable>version</replaceable></filename> 856 850 with the correct Guest Additions installation directory. 857 851 </para> … … 917 911 <listitem> 918 912 <para> 919 Mount the 920 <computeroutput>VBoxGuestAdditions.iso</computeroutput> 921 file as your Oracle Solaris guest's virtual CD-ROM drive, 913 Mount the <filename>VBoxGuestAdditions.iso</filename> file 914 as your Oracle Solaris guest's virtual CD-ROM drive, 922 915 exactly the same way as described for a Windows guest in 923 916 <xref … … 1002 995 those for the other platforms. Mount the ISO in OS/2 as 1003 996 described previously. The OS/2 Guest Additions are located in 1004 the directory < computeroutput>\OS2</computeroutput>.997 the directory <filename>\OS2</filename>. 1005 998 </para> 1006 999 1007 1000 <para> 1008 1001 We do not provide an automatic installer at this time. See the 1009 < computeroutput>readme.txt</computeroutput> file in the CD-ROM1010 directory, which describes how to install the OS/2 Guest1011 Additionsmanually.1002 <filename>readme.txt</filename> file in the CD-ROM directory, 1003 which describes how to install the OS/2 Guest Additions 1004 manually. 1012 1005 </para> 1013 1006 … … 1027 1020 not require networking, only the Guest Additions. Shared folders 1028 1021 are supported with Windows 2000 or later, Linux, and Oracle 1029 Solaris guests. &product-name; release 6.0 includes experimental1030 support forMac OS X and OS/2 guests.1022 Solaris guests. &product-name; includes experimental support for 1023 Mac OS X and OS/2 guests. 1031 1024 </para> 1032 1025 … … 1104 1097 the VM is powered off. These can be created using a checkbox 1105 1098 in the VirtualBox Manager, or by using the 1106 < computeroutput>--transient</computeroutput> option of the1107 <command>VBoxManagesharedfolder add</command> command.1099 <option>--transient</option> option of the <command>VBoxManage 1100 sharedfolder add</command> command. 1108 1101 </para> 1109 1102 </listitem> … … 1116 1109 read files on the host. By default, shared folders are read-write. 1117 1110 Read-only folders can be created using a checkbox in the 1118 VirtualBox Manager, or with the 1119 <computeroutput>--readonly</computeroutput> option of the 1120 <command>VBoxManage sharedfolder add</command> command. 1111 VirtualBox Manager, or with the <option>--readonly</option> option 1112 of the <command>VBoxManage sharedfolder add</command> command. 1121 1113 </para> 1122 1114 … … 1189 1181 1190 1182 <para> 1191 While < computeroutput>vboxsvr</computeroutput> is a fixed1192 name, note that <computeroutput>vboxsrv</computeroutput>1193 would also work, replace <replaceable>x:</replaceable> with1194 the drive letter that youwant to use for the share, and1183 While <literal>vboxsvr</literal> is a fixed name, note that 1184 <literal>vboxsrv</literal> would also work, replace 1185 <replaceable>x:</replaceable> with the drive letter that you 1186 want to use for the share, and 1195 1187 <replaceable>sharename</replaceable> with the share name 1196 1188 specified with <command>VBoxManage</command>. … … 1207 1199 <para> 1208 1200 To mount a shared folder during boot, add the following 1209 entry to < computeroutput>/etc/fstab</computeroutput>:1201 entry to <filename>/etc/fstab</filename>: 1210 1202 </para> 1211 1203 … … 1223 1215 Replace <replaceable>sharename</replaceable>, use a 1224 1216 lowercase string, with the share name specified with 1225 <command>VBoxManage</command> or the GUI. Replace1226 <replaceable>mountpoint</replaceable> with the path where1227 you want the share to be mounted on the guest, such as1228 < computeroutput>/mnt/share</computeroutput>. The usual mount1229 rules apply. For example, create this directory first if it1230 doesnot exist yet.1217 <command>VBoxManage</command> or the VirtualBox Manager. 1218 Replace <replaceable>mountpoint</replaceable> with the path 1219 where you want the share to be mounted on the guest, such as 1220 <filename>/mnt/share</filename>. The usual mount rules 1221 apply. For example, create this directory first if it does 1222 not exist yet. 1231 1223 </para> 1232 1224 … … 1256 1248 This option sets the character set used for I/O operations. 1257 1249 Note that on Linux guests, if the 1258 <computeroutput>iocharset</computeroutput> option is not 1259 specified, then the Guest Additions driver will attempt to 1260 use the character set specified by the CONFIG_NLS_DEFAULT 1261 kernel option. If this option is not set either, then UTF-8 1262 is used. 1250 <literal>iocharset</literal> option is not specified, then 1251 the Guest Additions driver will attempt to use the character 1252 set specified by the CONFIG_NLS_DEFAULT kernel option. If 1253 this option is not set either, then UTF-8 is used. 1263 1254 </para> 1264 1255 … … 1272 1263 <para> 1273 1264 The generic mount options, documented in the 1274 <computeroutput>mount</computeroutput> manual page, apply 1275 also. Especially useful are the options 1276 <computeroutput>uid</computeroutput>, 1277 <computeroutput>gid</computeroutput> and 1278 <computeroutput>mode</computeroutput>, as they can allow 1279 access by normal users in read/write mode, depending on the 1280 settings, even if root has mounted the filesystem. 1265 <command>mount</command> manual page, apply also. Especially 1266 useful are the options <literal>uid</literal>, 1267 <literal>gid</literal> and <literal>mode</literal>, as they 1268 can allow access by normal users in read/write mode, 1269 depending on the settings, even if root has mounted the 1270 filesystem. 1281 1271 </para> 1282 1272 </listitem> … … 1294 1284 <para> 1295 1285 As with Windows guests, shared folders can also be accessed 1296 via UNC using <computeroutput>\\VBoxSF\</computeroutput>, 1297 <computeroutput>\\VBoxSvr\</computeroutput> or 1298 <computeroutput>\\VBoxSrv\</computeroutput> as the server 1299 name and the shared folder name as 1300 <replaceable>sharename</replaceable>. 1286 via UNC using <filename>\\VBoxSF\</filename>, 1287 <filename>\\VBoxSvr\</filename> or 1288 <filename>\\VBoxSrv\</filename> as the server name and the 1289 shared folder name as <replaceable>sharename</replaceable>. 1301 1290 </para> 1302 1291 </listitem> … … 1332 1321 <emphasis role="bold">Windows and OS/2 guests.</emphasis> 1333 1322 Search for a free drive letter, starting at 1334 < computeroutput>Z:</computeroutput>. If all drive letters1335 are assigned,the folder is not mounted.1323 <filename>Z:</filename>. If all drive letters are assigned, 1324 the folder is not mounted. 1336 1325 </para> 1337 1326 </listitem> … … 1341 1330 <emphasis role="bold">Linux and Oracle Solaris 1342 1331 guests.</emphasis> Folders are mounted under the 1343 < computeroutput>/media</computeroutput> directory. The1344 folder name is normalized (no spaces, slashes or colons) and1345 is prefixed with <computeroutput>sf_</computeroutput>.1332 <filename>/media</filename> directory. The folder name is 1333 normalized (no spaces, slashes or colons) and is prefixed 1334 with <filename>sf_</filename>. 1346 1335 </para> 1347 1336 1348 1337 <para> 1349 1338 For example, if you have a shared folder called 1350 <computeroutput>myfiles</computeroutput>, it will appear as 1351 <computeroutput>/media/sf_myfiles</computeroutput> in the 1352 guest. 1339 <filename>myfiles</filename>, it will appear as 1340 <filename>/media/sf_myfiles</filename> in the guest. 1353 1341 </para> 1354 1342 1355 1343 <para> 1356 1344 The guest properties 1357 < computeroutput>/VirtualBox/GuestAdd/SharedFolders/MountDir</computeroutput>1345 <literal>/VirtualBox/GuestAdd/SharedFolders/MountDir</literal> 1358 1346 and the more generic 1359 < computeroutput>/VirtualBox/GuestAdd/SharedFolders/MountPrefix</computeroutput>1347 <literal>/VirtualBox/GuestAdd/SharedFolders/MountPrefix</literal> 1360 1348 can be used to override the automatic mount directory and 1361 1349 prefix. See <xref linkend="guestadd-guestprops" />. … … 1369 1357 everyone in a Windows guest, including the guest user. For Linux 1370 1358 and Oracle Solaris guests, access is restricted to members of 1371 the group < computeroutput>vboxsf</computeroutput> and the1372 < computeroutput>root</computeroutput> user.1359 the group <literal>vboxsf</literal> and the 1360 <literal>root</literal> user. 1373 1361 </para> 1374 1362 … … 1383 1371 <para> 1384 1372 &product-name; enables you to drag and drop content from the host 1385 to the guest, and vice versa. For this to work the latest Guest1386 Additions must be installed on the guest.1373 to the guest, and vice versa. For this to work the latest version 1374 of the Guest Additions must be installed on the guest. 1387 1375 </para> 1388 1376 … … 1439 1427 <figure id="fig-drag-drop-options"> 1440 1428 <title>Drag and Drop Menu Options</title> 1441 1429 <mediaobject> 1442 1430 <imageobject> 1443 1431 <imagedata align="center" fileref="images/dnd-modes.png" … … 1617 1605 <para> 1618 1606 3D acceleration with Windows guests requires Windows 1619 2000 , Windows XP, Vista, or Windows 7. Apart from on1620 Windows 2000 guests, both OpenGL and Direct3D 8/9 are1621 supported on an experimentalbasis.1607 2000 or later. Apart from on Windows 2000 guests, both 1608 OpenGL and Direct3D 8/9 are supported on an experimental 1609 basis. 1622 1610 </para> 1623 1611 </listitem> … … 1692 1680 driver must be installed, which is available with the Guest 1693 1681 Additions installation. The WDDM driver is not installed by 1694 default for Vista and Windows 7 guest and must be1682 default for Vista and Windows 7 guests and must be 1695 1683 <emphasis>manually selected</emphasis> in the Guest Additions 1696 1684 installer by clicking <emphasis role="bold">No</emphasis> in the … … 1701 1689 1702 1690 <para> 1703 The Aero theme is not enabled by default. To enable it, do the 1704 following: 1705 </para> 1706 1707 <itemizedlist> 1708 1709 <listitem> 1710 <para> 1711 <emphasis role="bold">Windows Vista guests:</emphasis> 1712 Right-click on the desktop and select 1713 <emphasis role="bold">Personalize</emphasis>, then select 1714 <emphasis role="bold">Windows Color and 1715 Appearance</emphasis> in the 1716 <emphasis role="bold">Personalization</emphasis> window. In 1717 the <emphasis role="bold">Appearance Settings</emphasis> 1718 dialog, select <emphasis role="bold">Windows Aero</emphasis> 1719 and click <emphasis role="bold">OK</emphasis>. 1720 </para> 1721 </listitem> 1722 1723 <listitem> 1724 <para> 1725 <emphasis role="bold">Windows 7 guests:</emphasis> 1726 Right-click on the desktop and select 1727 <emphasis role="bold">Personalize</emphasis>. Select any 1728 Aero theme in the 1729 <emphasis role="bold">Personalization</emphasis> window. 1730 </para> 1731 </listitem> 1732 1733 </itemizedlist> 1734 1735 <para> 1736 Technically, &product-name; implements this by installing an 1737 additional hardware 3D driver inside your guest when the Guest 1738 Additions are installed. This driver acts as a hardware 3D 1739 driver and reports to the guest operating system that the 1740 virtual hardware is capable of 3D hardware acceleration. When an 1741 application in the guest then requests hardware acceleration 1742 through the OpenGL or Direct3D programming interfaces, these are 1743 sent to the host through a special communication tunnel 1744 implemented by &product-name;, and then the 1745 <emphasis>host</emphasis> performs the requested 3D operation 1746 using the host's programming interfaces. 1691 The Aero theme is not enabled by default on Windows. See your 1692 Windows platform documentation for details of how to enable the 1693 Aero theme. 1694 </para> 1695 1696 <para> 1697 Technically, &product-name; implements 3D acceleration by 1698 installing an additional hardware 3D driver inside the guest 1699 when the Guest Additions are installed. This driver acts as a 1700 hardware 3D driver and reports to the guest operating system 1701 that the virtual hardware is capable of 3D hardware 1702 acceleration. When an application in the guest then requests 1703 hardware acceleration through the OpenGL or Direct3D programming 1704 interfaces, these are sent to the host through a special 1705 communication tunnel implemented by &product-name;. The 1706 <emphasis>host</emphasis> then performs the requested 3D 1707 operation using the host's programming interfaces. 1747 1708 </para> 1748 1709 … … 1806 1767 through a special communication tunnel implemented by 1807 1768 &product-name;. On the host side, OpenGL is then used to 1808 implement color space transformation and scaling 1769 implement color space transformation and scaling. 1809 1770 </para> 1810 1771 … … 1829 1790 <listitem> 1830 1791 <para> 1831 Windows guests. Support was added in &product-name; 1.5.1792 Windows guests. 1832 1793 </para> 1833 1794 </listitem> … … 1836 1797 <para> 1837 1798 Supported Linux or Oracle Solaris guests running the X Window 1838 System. Support was added with &product-name; 1.6.1799 System. 1839 1800 </para> 1840 1801 </listitem> … … 1851 1812 <figure id="fig-seamless-windows"> 1852 1813 <title>Seamless Windows on a Host Desktop</title> 1853 1814 <mediaobject> 1854 1815 <imageobject> 1855 1816 <imagedata align="center" fileref="images/seamless.png" width="14cm" /> … … 1918 1879 version of the Guest Additions, users that are currently logged 1919 1880 into the guest OS, network statistics and more. These predefined 1920 properties are all prefixed with 1921 <computeroutput>/VirtualBox/</computeroutput> and organized into a 1922 hierarchical tree of keys. 1881 properties are all prefixed with <literal>/VirtualBox/</literal> 1882 and organized into a hierarchical tree of keys. 1923 1883 </para> 1924 1884 … … 1940 1900 <screen>$ VBoxManage guestproperty enumerate "Windows Vista III" 1941 1901 VirtualBox Command Line Management Interface Version <replaceable>version-number</replaceable> 1942 (C) 2005-201 8Oracle Corporation1902 (C) 2005-2019 Oracle Corporation 1943 1903 All rights reserved. 1944 1904 … … 1997 1957 <para> 1998 1958 To query the value of a single property, use the 1999 <com puteroutput>get</computeroutput> subcommand as follows:1959 <command>get</command> subcommand as follows: 2000 1960 </para> 2001 1961 2002 1962 <screen>$ VBoxManage guestproperty get "Windows Vista III" "/VirtualBox/GuestInfo/OS/Product" 2003 1963 VirtualBox Command Line Management Interface Version <replaceable>version-number</replaceable> 2004 (C) 2005-201 8Oracle Corporation1964 (C) 2005-2019 Oracle Corporation 2005 1965 All rights reserved. 2006 1966 … … 2009 1969 <para> 2010 1970 To add or change guest properties from the guest, use the tool 2011 <computeroutput>VBoxControl</computeroutput>. This tool is 2012 included in the Guest Additions of &product-name; 2.2 or later. 2013 When started from a Linux guest, this tool requires root 2014 privileges for security reasons: 1971 <command>VBoxControl</command>. This tool is included in the Guest 1972 Additions. When started from a Linux guest, this tool requires 1973 root privileges for security reasons. 2015 1974 </para> 2016 1975 2017 1976 <screen>$ sudo VBoxControl guestproperty enumerate 2018 1977 VirtualBox Guest Additions Command Line Management Interface Version <replaceable>version-number</replaceable> 2019 (C) 2005-201 8Oracle Corporation1978 (C) 2005-2019 Oracle Corporation 2020 1979 All rights reserved. 2021 1980 … … 2036 1995 2037 1996 <para> 2038 The properties 2039 <computeroutput>/VirtualBox/HostInfo/VBoxVer</computeroutput>, 2040 <computeroutput>/VirtualBox/HostInfo/VBoxVerExt</computeroutput> 2041 or <computeroutput>/VirtualBox/HostInfo/VBoxRev</computeroutput> 2042 can be waited on to detect that the VM state was restored from 2043 saved state or snapshot: 1997 The properties <literal>/VirtualBox/HostInfo/VBoxVer</literal>, 1998 <literal>/VirtualBox/HostInfo/VBoxVerExt</literal> or 1999 <literal>/VirtualBox/HostInfo/VBoxRev</literal> can be waited on 2000 to detect that the VM state was restored from saved state or 2001 snapshot: 2044 2002 </para> 2045 2003 … … 2048 2006 <para> 2049 2007 Similarly the 2050 < computeroutput>/VirtualBox/HostInfo/ResumeCounter</computeroutput>2051 can be used to detect that a VM was resumed from the paused2052 s tate or saved state.2008 <literal>/VirtualBox/HostInfo/ResumeCounter</literal> can be 2009 used to detect that a VM was resumed from the paused state or 2010 saved state. 2053 2011 </para> 2054 2012 … … 2070 2028 <figure id="fig-guest-control-fm"> 2071 2029 <title>Guest Control File Manager</title> 2072 2030 <mediaobject> 2073 2031 <imageobject> 2074 2032 <imagedata align="center" fileref="images/guest-fm.png" … … 2165 2123 2166 2124 <para> 2167 The Guest Additions enable starting of applications inside a VM 2168 from the host system. 2169 </para> 2170 2171 <para> 2172 For this to work, the application needs to be installed inside the 2125 The Guest Additions enable starting of applications inside a guest 2126 VM from the host system. This feature can be used to automate 2127 deployment of software within the guest. 2128 </para> 2129 2130 <para> 2131 For this to work, the application needs to be installed on the 2173 2132 guest. No additional software needs to be installed on the host. 2174 2133 Additionally, text mode output to stdout and stderr can be shown … … 2179 2138 2180 2139 <para> 2181 This feature can be used to automate deployment of software within2182 the guest.2183 </para>2184 2185 <para>2186 2140 The Guest Additions for Windows allow for automatic updating. This 2187 applies for already installed Guest Additions version 4.0 or2188 later. Also, copying files from host to the guest as well as2189 remotely creatingguest directories is available.2141 applies for already installed Guest Additions versions. Also, 2142 copying files from host to the guest as well as remotely creating 2143 guest directories is available. 2190 2144 </para> 2191 2145 … … 2234 2188 Memory ballooning does not work with large pages enabled. 2235 2189 To turn off large pages support for a VM, run 2236 <computeroutput>VBoxManage modifyvm <VM name> 2237 --largepages off</computeroutput> 2190 <command>VBoxManage modifyvm 2191 <replaceable>vmname</replaceable> --largepages 2192 off</command> 2238 2193 </para> 2239 2194 </listitem> … … 2303 2258 <para> 2304 2259 By default, no balloon memory is allocated. This is a VM 2305 setting, like other <com puteroutput>modifyvm</computeroutput>2306 settings, and therefore can only be set while the machine is2307 shut down. See<xref2260 setting, like other <command>modifyvm</command> settings, and 2261 therefore can only be set while the machine is shut down. See 2262 <xref 2308 2263 linkend="vboxmanage-modifyvm" />. 2309 2264 </para> … … 2341 2296 efficiently Page Fusion can reduce the amount of host memory 2342 2297 that is in use. It therefore works best if all VMs on a host run 2343 identical operating systems, such as Windows XP Service Pack 2. 2344 Instead of having a complete copy of each operating system in 2345 each VM, Page Fusion identifies the identical memory pages in 2346 use by these operating systems and eliminates the duplicates, 2347 sharing host memory between several machines. This is called 2348 <emphasis>deduplication</emphasis>. If a VM tries to modify a 2349 page that has been shared with other VMs, a new page is 2350 allocated again for that VM with a copy of the shared page. This 2351 is called <emphasis>copy on write</emphasis>. All this is fully 2352 transparent to the virtual machine. 2298 identical operating systems. Instead of having a complete copy 2299 of each operating system in each VM, Page Fusion identifies the 2300 identical memory pages in use by these operating systems and 2301 eliminates the duplicates, sharing host memory between several 2302 machines. This is called <emphasis>deduplication</emphasis>. If 2303 a VM tries to modify a page that has been shared with other VMs, 2304 a new page is allocated again for that VM with a copy of the 2305 shared page. This is called <emphasis>copy on write</emphasis>. 2306 All this is fully transparent to the virtual machine. 2353 2307 </para> 2354 2308 … … 2411 2365 <para> 2412 2366 You can observe Page Fusion operation using some metrics. 2413 <computeroutput>RAM/VMM/Shared</computeroutput> shows the total 2414 amount of fused pages, whereas the per-VM metric 2415 <computeroutput>Guest/RAM/Usage/Shared</computeroutput> will 2416 return the amount of fused memory for a given VM. See 2417 <xref 2418 linkend="vboxmanage-metrics" /> for information on 2419 how to query metrics. 2367 <literal>RAM/VMM/Shared</literal> shows the total amount of 2368 fused pages, whereas the per-VM metric 2369 <literal>Guest/RAM/Usage/Shared</literal> will return the amount 2370 of fused memory for a given VM. See 2371 <xref linkend="vboxmanage-metrics" /> for information on how to 2372 query metrics. 2420 2373 </para> 2421 2374 -
trunk/doc/manual/en_US/user_Installation.xml
r76786 r82350 26 26 For the various versions of Windows that are supported as host 27 27 operating systems, please refer to 28 <xref 29 linkend="hostossupport" />. 30 </para> 31 32 <para> 33 In addition, Windows Installer 1.1 or later must be present on 34 your system. This should be the case if you have all recent 35 Windows updates installed. 28 <xref linkend="hostossupport" />. 29 </para> 30 31 <para> 32 In addition, Windows Installer must be present on your system. 33 This should be the case for all supported Windows platforms. 36 34 </para> 37 35 … … 51 49 <listitem> 52 50 <para> 53 By double-clicking on the executable file, which contains 54 both 32-bit and 64-bit architectures. 51 By double-clicking on the executable file. 55 52 </para> 56 53 </listitem> … … 64 61 65 62 <para> 66 This will extract both installers into a temporary67 directory, along with .MSI files. Run the following command68 to toperform the installation:69 </para> 70 71 <screen>msiexec /i VirtualBox-<version>-<revision>- MultiArch_<x86|amd64>.msi</screen>63 This will extract the installer into a temporary directory, 64 along with the .MSI file. Run the following command to 65 perform the installation: 66 </para> 67 68 <screen>msiexec /i VirtualBox-<version>-<revision>-Win.msi</screen> 72 69 </listitem> 73 70 … … 114 111 <para> 115 112 See, for example: 116 <ulink 117 url="http://www.python.org/download/windows/">http://www.python.org/download/windows/</ulink>. 113 <ulink url="http://www.python.org/download/windows/" />. 118 114 </para> 119 115 120 116 <note> 121 117 <para> 122 Python version at least 2.6 is required. Since123 &product-name; 5.1, Python 3 is alsosupported.118 Python version at least 2.6 is required. Python 3 is also 119 supported. 124 120 </para> 125 121 </note> … … 137 133 138 134 <para> 139 The installer will create a &product-name; group in the Windows135 The installer will create an &product-name; group in the Windows 140 136 <emphasis role="bold">Start</emphasis> menu, which enables you 141 137 to launch the application and access its documentation. … … 152 148 <para> 153 149 Then, run either of the following commands on the extracted .MSI 154 file s. This will install &product-name; only for the current150 file. This will install &product-name; only for the current 155 151 user. 156 152 </para> … … 158 154 <screen>VirtualBox.exe -msiparams ALLUSERS=2</screen> 159 155 160 <screen>msiexec /i VirtualBox-<version>- MultiArch_<x86|amd64>.msi ALLUSERS=2</screen>156 <screen>msiexec /i VirtualBox-<version>-Win.msi ALLUSERS=2</screen> 161 157 162 158 <para> 163 159 If you do not want to install all features of &product-name;, 164 you can set the optional 165 <computeroutput>ADDLOCAL</computeroutput> parameter to 166 explicitly name the features to be installed. The following 160 you can set the optional <literal>ADDLOCAL</literal> parameter 161 to explicitly name the features to be installed. The following 167 162 features are available: 168 163 </para> … … 248 243 Python support 249 244 </para> 250 251 <note>252 <para>253 Python version at least 2.6 is required. Since254 &product-name; 5.1, Python 3 is also supported.255 </para>256 </note>257 245 </listitem> 258 246 </varlistentry> … … 267 255 <screen>VirtualBox.exe -msiparams ADDLOCAL=VBoxApplication,VBoxUSB</screen> 268 256 269 <screen>msiexec /i VirtualBox-<version>- MultiArch_<x86|amd64>.msi ADDLOCAL=VBoxApplication,VBoxUSB</screen>257 <screen>msiexec /i VirtualBox-<version>-Win.msi ADDLOCAL=VBoxApplication,VBoxUSB</screen> 270 258 271 259 <para> 272 260 The user is able to choose between NDIS5 and NDIS6 host network 273 261 filter drivers during the installation. This is done using a 274 command line parameter, 275 <computeroutput>NETWORKTYPE</computeroutput>. The NDIS6 driver 276 is default for Windows Vista and later. For older Windows 277 versions, the installer will automatically select the NDIS5 278 driver and this cannot be changed. For Windows Vista and later 279 the user can force an install of the legacy NDIS5 host network 280 filter driver by using 281 <computeroutput>NETWORKTYPE=NDIS5</computeroutput>. For example, 282 to install the NDIS5 driver on Windows 7 use either of the 283 following commands: 262 command line parameter, <literal>NETWORKTYPE</literal>. The 263 NDIS6 driver is the default for most supported Windows hosts. 264 For some legacy Windows versions, the installer will 265 automatically select the NDIS5 driver and this cannot be 266 changed. 267 </para> 268 269 <para> 270 You can force an install of the legacy NDIS5 host network filter 271 driver by specifying <literal>NETWORKTYPE=NDIS5</literal>. For 272 example, to install the NDIS5 driver on Windows 7 use either of 273 the following commands: 284 274 </para> 285 275 286 276 <screen>VirtualBox.exe -msiparams NETWORKTYPE=NDIS5</screen> 287 277 288 <screen>msiexec /i VirtualBox-<version>- MultiArch_<x86|amd64>.msi NETWORKTYPE=NDIS5</screen>278 <screen>msiexec /i VirtualBox-<version>-Win;.msi NETWORKTYPE=NDIS5</screen> 289 279 290 280 </sect2> … … 326 316 <screen>VirtualBox.exe -msiparams NAME=VALUE [...]</screen> 327 317 328 <screen>msiexec /i VirtualBox-<version>- MultiArch_<x86|amd64>.msi NAME=VALUE [...]</screen>318 <screen>msiexec /i VirtualBox-<version>-Win.msi NAME=VALUE [...]</screen> 329 319 330 320 <para> … … 345 335 346 336 <para> 347 Set to < computeroutput>1</computeroutput> to enable,348 <computeroutput>0</computeroutput>to disable. Default is 1.337 Set to <literal>1</literal> to enable, <literal>0</literal> 338 to disable. Default is 1. 349 339 </para> 350 340 </listitem> … … 361 351 362 352 <para> 363 Set to < computeroutput>1</computeroutput> to enable,364 <computeroutput>0</computeroutput>to disable. Default is 1.353 Set to <literal>1</literal> to enable, <literal>0</literal> 354 to disable. Default is 1. 365 355 </para> 366 356 </listitem> … … 379 369 380 370 <para> 381 Set to < computeroutput>1</computeroutput> to enable,382 <computeroutput>0</computeroutput>to disable. Default is 1.371 Set to <literal>1</literal> to enable, <literal>0</literal> 372 to disable. Default is 1. 383 373 </para> 384 374 </listitem> … … 395 385 396 386 <para> 397 Set to < computeroutput>1</computeroutput> to enable,398 <computeroutput>0</computeroutput>to disable. Default is 1.387 Set to <literal>1</literal> to enable, <literal>0</literal> 388 to disable. Default is 1. 399 389 </para> 400 390 </listitem> … … 416 406 <para> 417 407 For Mac OS X hosts, &product-name; ships in a 418 < computeroutput>dmg</computeroutput> disk image file. Perform419 the followingsteps to install on a Mac OS X host:408 <filename>dmg</filename> disk image file. Perform the following 409 steps to install on a Mac OS X host: 420 410 </para> 421 411 … … 424 414 <listitem> 425 415 <para> 426 Double-click on the < computeroutput>dmg</computeroutput>427 file, to mountthe contents.416 Double-click on the <filename>dmg</filename> file, to mount 417 the contents. 428 418 </para> 429 419 </listitem> … … 432 422 <para> 433 423 A window opens, prompting you to double-click on the 434 <computeroutput>VirtualBox.pkg</computeroutput> installer 435 file displayed in that window. 436 </para> 437 </listitem> 438 439 <listitem> 440 <para> 441 This will start the installer, which enables you to select 442 where to install &product-name;. 424 <filename>VirtualBox.pkg</filename> installer file displayed 425 in that window. 426 </para> 427 </listitem> 428 429 <listitem> 430 <para> 431 This starts the installer, which enables you to select where 432 to install &product-name;. 433 </para> 434 </listitem> 435 436 <listitem> 437 <para> 438 An &product-name; icon is added to the 439 <filename>Applications</filename> folder in the Finder. 443 440 </para> 444 441 </listitem> … … 446 443 </orderedlist> 447 444 448 <para>449 After installation, you can find an &product-name; icon in the450 "Applications" folder in the Finder.451 </para>452 453 445 </sect2> 454 446 … … 459 451 <para> 460 452 To uninstall &product-name;, open the disk image 461 < computeroutput>dmg</computeroutput> file and double-click on462 the uninstallicon shown.453 <filename>dmg</filename> file and double-click on the uninstall 454 icon shown. 463 455 </para> 464 456 … … 475 467 476 468 <para> 477 Mount the < computeroutput>dmg</computeroutput> disk image file,478 as described in the installation procedure, or use the following479 commandline:469 Mount the <filename>dmg</filename> disk image file, as described 470 in the installation procedure, or use the following command 471 line: 480 472 </para> 481 473 … … 502 494 <para> 503 495 For the various versions of Linux that are supported as host 504 operating systems, see <xref 505 linkend="hostossupport" />. 506 </para> 507 508 <para> 509 You will need to install the following packages on your Linux 496 operating systems, see <xref linkend="hostossupport" />. 497 </para> 498 499 <para> 500 You may need to install the following packages on your Linux 510 501 system before starting the installation. Some systems will do 511 502 this for you automatically when you install &product-name;. … … 523 514 <para> 524 515 SDL 1.2.7 or later. This graphics library is typically 525 called < computeroutput>libsdl</computeroutput> or similar.516 called <filename>libsdl</filename> or similar. 526 517 </para> 527 518 </listitem> … … 533 524 These packages are only required if you want to run the 534 525 &product-name; graphical user interfaces. In particular, 535 <com puteroutput>VirtualBox</computeroutput>, the graphical536 VirtualBox Manager, requires both Qt and SDL. If you only want537 to run<command>VBoxHeadless</command>, neither Qt nor SDL are526 <command>VirtualBox</command>, the graphical VirtualBox 527 Manager, requires both Qt and SDL. If you only want to run 528 <command>VBoxHeadless</command>, neither Qt nor SDL are 538 529 required. 539 530 </para> … … 544 535 <sect2 id="externalkernelmodules"> 545 536 546 <title>The &product-name; DriverModules</title>537 <title>The &product-name; Kernel Modules</title> 547 538 548 539 <para> 549 540 In order to run other operating systems in virtual machines 550 541 alongside your main operating system, &product-name; needs to 551 integrate very tightly into the system. To do this it installs a 552 driver module called <computeroutput>vboxdrv</computeroutput> 553 which does a lot of that work into the system kernel, which is 554 the part of the operating system which controls your processor 555 and physical hardware. Without this kernel module, you can still 556 use the VirtualBox Manager to configure virtual machines, but 557 they will not start. It also installs network drivers called 558 <computeroutput>vboxnetflt</computeroutput> and 559 <computeroutput>vboxnetadp</computeroutput> which enable virtual 560 machines to make more use of your computer's network 542 integrate very tightly with your system. To do this it installs 543 a driver module called <command>vboxdrv</command> into the 544 system kernel. The kernel is the part of the operating system 545 which controls your processor and physical hardware. Without 546 this kernel module, you can still use the VirtualBox Manager to 547 configure virtual machines, but they will not start. 548 </para> 549 550 <para> 551 Network drivers called <command>vboxnetflt</command> and 552 <command>vboxnetadp</command> are also installed. They enable 553 virtual machines to make more use of your computer's network 561 554 capabilities and are needed for any virtual machine networking 562 555 beyond the basic NAT mode. … … 565 558 <para> 566 559 Since distributing driver modules separately from the kernel is 567 not something which Linux supports well, the install process 568 creates the modules on the system where they will be used. This 569 usually means first installing software packages from the 570 distribution which are needed for the build process. Normally, 571 these will be the GNU compiler (GCC), GNU Make (make) and 572 packages containing header files for your kernel, as well as 573 making sure that all system updates are installed and that the 574 system is running the most up-to-date kernel included in the 575 distribution. <emphasis>The running kernel and the header files 576 must be updated to matching versions</emphasis>. The following 577 list includes some instructions for common distributions. For 578 most of them you may want to start by finding the version name 560 not something which Linux supports well, the &product-name; 561 install process creates the modules on the system where they 562 will be used. This means that you may need to install some 563 software packages from the distribution which are needed for the 564 build process. Required packages may include the following: 565 </para> 566 567 <itemizedlist> 568 569 <listitem> 570 <para> 571 GNU compiler (GCC) 572 </para> 573 </listitem> 574 575 <listitem> 576 <para> 577 GNU Make (make) 578 </para> 579 </listitem> 580 581 <listitem> 582 <para> 583 Kernel header files 584 </para> 585 </listitem> 586 587 </itemizedlist> 588 589 <para> 590 Also ensure that all system updates have been installed and that 591 your system is running the most up-to-date kernel for the 592 distribution. 593 </para> 594 595 <note> 596 <para> 597 The running kernel and the kernel header files must be updated 598 to matching versions. 599 </para> 600 </note> 601 602 <para> 603 The following list includes some details of the required files 604 for some common distributions. Start by finding the version name 579 605 of your kernel, using the command <command>uname -r</command> in 580 a terminal. The instructions assume that you have not changed 581 too much from the original installation, particularly not 582 installed a different kernel type. If you have, then you will 583 need to determine yourself what to set up. 606 a terminal. The list assumes that you have not changed too much 607 from the original installation, in particular that you have not 608 installed a different kernel type. 584 609 </para> 585 610 … … 590 615 With Debian and Ubuntu-based distributions, you must install 591 616 the correct version of the 592 <computeroutput>linux-headers</computeroutput>, usually 593 whichever of 594 <computeroutput>linux-headers-generic</computeroutput>, 595 <computeroutput>linux-headers-amd64</computeroutput>, 596 <computeroutput>linux-headers-i686</computeroutput> or 597 <computeroutput>linux-headers-i686-pae</computeroutput> best 598 matches the kernel version name. Also, the 599 <computeroutput>linux-kbuild</computeroutput> package if it 600 exists. Basic Ubuntu releases should have the correct 601 packages installed by default. 602 </para> 603 </listitem> 604 605 <listitem> 606 <para> 607 On Fedora, Redhat, Oracle Linux and many other RPM-based 617 <filename>linux-headers</filename>, usually whichever of 618 <filename>linux-headers-generic</filename>, 619 <filename>linux-headers-amd64</filename>, 620 <filename>linux-headers-i686</filename> or 621 <filename>linux-headers-i686-pae</filename> best matches the 622 kernel version name. Also, the 623 <filename>linux-kbuild</filename> package if it exists. 624 Basic Ubuntu releases should have the correct packages 625 installed by default. 626 </para> 627 </listitem> 628 629 <listitem> 630 <para> 631 On Fedora, Red Hat, Oracle Linux and many other RPM-based 608 632 systems, the kernel version sometimes has a code of letters 609 633 or a word close to the end of the version name. For example 610 "uek" for the Oracle Enterprise kernel or "default"or611 "de sktop" for the standard SUSE kernels. In this case, the612 package name is613 < computeroutput>kernel-uek-devel</computeroutput> or614 equivalent. Ifthere is no such code, it is usually615 < computeroutput>kernel-devel</computeroutput>.616 </para> 617 </listitem> 618 619 <listitem> 620 <para> 621 On older SUSE and openSUSE Linux, you must install the622 <computeroutput>kernel-source</computeroutput> and623 < computeroutput>kernel-syms</computeroutput> packages.634 "uek" for the Oracle Unbreakable Enterprise Kernel or 635 "default" or "desktop" for the standard kernels. In this 636 case, the package name is 637 <filename>kernel-uek-devel</filename> or equivalent. If 638 there is no such code, it is usually 639 <filename>kernel-devel</filename>. 640 </para> 641 </listitem> 642 643 <listitem> 644 <para> 645 On some SUSE and openSUSE Linux versions, you may need to 646 install the <filename>kernel-source</filename> and 647 <filename>kernel-syms</filename> packages. 624 648 </para> 625 649 </listitem> … … 635 659 <screen>rcvboxdrv setup</screen> 636 660 661 <sect3 id="kernel-modules-efi-secure-boot"> 662 663 <title>Kernel Modules and UEFI Secure Boot</title> 664 665 <para> 666 If you are running on a system using UEFI (Unified Extensible 667 Firmware Interface) Secure Boot, you may need to sign the 668 following kernel modules before you can load them: 669 </para> 670 671 <itemizedlist> 672 673 <listitem> 674 <para> 675 <command>vboxdrv</command> 676 </para> 677 </listitem> 678 679 <listitem> 680 <para> 681 <command>vboxnetadp</command> 682 </para> 683 </listitem> 684 685 <listitem> 686 <para> 687 <command>vboxnetflt</command> 688 </para> 689 </listitem> 690 691 <listitem> 692 <para> 693 <command>vboxpci</command> 694 </para> 695 </listitem> 696 697 </itemizedlist> 698 699 <para> 700 See your system documentation for details of the kernel module 701 signing process. 702 </para> 703 704 </sect3> 705 637 706 </sect2> 638 707 … … 645 714 native to various common Linux distributions. See 646 715 <xref linkend="hostossupport"/>. In addition, there is an 647 alternative generic installer (.run) which should work on most 648 Linux distributions. The generic installer packages are built on 649 EL5 systems and thus require reasonably old versions of glibc, 650 such as version 2.5, and other system libraries. 716 alternative generic installer (.run) which you can use on 717 supported Linux distributions. 651 718 </para> 652 719 653 720 <sect3 id="install-linux-debian-ubuntu"> 654 721 655 <title>Installing &product-name; from a Debian /Ubuntu Package</title>722 <title>Installing &product-name; from a Debian or Ubuntu Package</title> 656 723 657 724 <para> 658 725 Download the appropriate package for your distribution. The 659 following example s assume that you are installing to a 32-bit660 Ubuntu Wily system. Use <computeroutput>dpkg</computeroutput>661 t o install the Debian package,as follows:662 </para> 663 664 <screen>sudo dpkg -i virtualbox- 5.0_<replaceable>version-number</replaceable>_Ubuntu_wily_i386.deb</screen>726 following example assumes that you are installing to a 64-bit 727 Ubuntu Xenial system. Use <command>dpkg</command> to install 728 the Debian package,as follows: 729 </para> 730 731 <screen>sudo dpkg -i virtualbox-<replaceable>version-number</replaceable>_Ubuntu_xenial_amd64.deb</screen> 665 732 666 733 <para> … … 669 736 successful you will be shown a warning and the package will be 670 737 left unconfigured. Look at 671 <computeroutput>/var/log/vbox-install.log</computeroutput> to 672 find out why the compilation failed. You may have to install 673 the appropriate Linux kernel headers, see 674 <xref 675 linkend="externalkernelmodules" />. After 676 correcting any problems, run the following command: 738 <filename>/var/log/vbox-install.log</filename> to find out why 739 the compilation failed. You may have to install the 740 appropriate Linux kernel headers, see 741 <xref linkend="externalkernelmodules" />. After correcting any 742 problems, run the following command: 677 743 </para> 678 744 … … 687 753 module was successfully built, the installation script will 688 754 attempt to load that module. If this fails, please see 689 <xref 690 linkend="ts_linux-kernelmodule-fails-to-load" /> 691 for further information. 755 <xref linkend="ts_linux-kernelmodule-fails-to-load" /> for 756 further information. 692 757 </para> 693 758 … … 716 781 <para> 717 782 Unpacks the application files to the target directory 718 < computeroutput>/opt/VirtualBox/</computeroutput>, which719 c annot be changed.783 <filename>/opt/VirtualBox/</filename>, which cannot be 784 changed. 720 785 </para> 721 786 </listitem> … … 724 789 <para> 725 790 Builds and installs the &product-name; kernel modules: 726 <computeroutput>vboxdrv</computeroutput>, 727 <computeroutput>vboxnetflt</computeroutput>, and 728 <computeroutput>vboxnetadp</computeroutput>. 729 </para> 730 </listitem> 731 732 <listitem> 733 <para> 734 Creates <computeroutput>/sbin/rcvboxdrv</computeroutput>, 735 an init script to start the &product-name; kernel module. 791 <command>vboxdrv</command>, <command>vboxnetflt</command>, 792 and <command>vboxnetadp</command>. 793 </para> 794 </listitem> 795 796 <listitem> 797 <para> 798 Creates <filename>/sbin/rcvboxdrv</filename>, an init 799 script to start the &product-name; kernel module. 736 800 </para> 737 801 </listitem> … … 740 804 <para> 741 805 Creates a new system group called 742 <computeroutput>vboxusers</computeroutput>. 743 </para> 744 </listitem> 745 746 <listitem> 747 <para> 748 Creates symbolic links in 749 <computeroutput>/usr/bin</computeroutput> to a shell 750 script 751 <computeroutput>/opt/VirtualBox/VBox</computeroutput> 806 <literal>vboxusers</literal>. 807 </para> 808 </listitem> 809 810 <listitem> 811 <para> 812 Creates symbolic links in <filename>/usr/bin</filename> to 813 a shell script <filename>/opt/VirtualBox/VBox</filename> 752 814 which does some sanity checks and dispatches to the actual 753 815 executables: <command>VirtualBox</command>, … … 761 823 <para> 762 824 Creates 763 < computeroutput>/etc/udev/rules.d/60-vboxdrv.rules</computeroutput>,764 a description file for udev, if that is present, which765 makesthe USB devices accessible to all users in the766 < computeroutput>vboxusers</computeroutput> group.825 <filename>/etc/udev/rules.d/60-vboxdrv.rules</filename>, a 826 description file for udev, if that is present, which makes 827 the USB devices accessible to all users in the 828 <literal>vboxusers</literal> group. 767 829 </para> 768 830 </listitem> … … 771 833 <para> 772 834 Writes the installation directory to 773 < computeroutput>/etc/vbox/vbox.cfg</computeroutput>.835 <filename>/etc/vbox/vbox.cfg</filename>. 774 836 </para> 775 837 </listitem> … … 779 841 <para> 780 842 The installer must be executed as root with either 781 <computeroutput>install</computeroutput> or 782 <computeroutput>uninstall</computeroutput> as the first 783 parameter. For example: 843 <literal>install</literal> or <literal>uninstall</literal> as 844 the first parameter. For example: 784 845 </para> 785 846 … … 795 856 <para> 796 857 Add every user who needs to access USB devices from a 797 VirtualBox guests to the group 798 <computeroutput>vboxusers</computeroutput>. Either use the GUI799 user management tools or run the followingcommand as root:858 VirtualBox guests to the group <literal>vboxusers</literal>. 859 Either use the OS user management tools or run the following 860 command as root: 800 861 </para> 801 862 … … 811 872 <command>groups</command> command and add all these groups 812 873 in a comma-separated list to the command line after the 813 <option>-G</option> option. For example: 814 < computeroutput>usermod -G group1,group2,vboxusers815 username</computeroutput>.874 <option>-G</option> option. For example: <command>usermod -G 875 <replaceable>group1</replaceable>,<replaceable>group2</replaceable>,vboxusers 876 <replaceable>username</replaceable></command>. 816 877 </para> 817 878 </note> … … 833 894 <para> 834 895 This will unpack all the files needed for installation in the 835 directory <computeroutput>install</computeroutput> under the 836 current directory. The &product-name; application files are 837 contained in 838 <computeroutput>VirtualBox.tar.bz2</computeroutput> which you 839 can unpack to any directory on your system. For example: 896 directory <literal>install</literal> under the current 897 directory. The &product-name; application files are contained 898 in <filename>VirtualBox.tar.bz2</filename> which you can 899 unpack to any directory on your system. For example: 840 900 </para> 841 901 … … 852 912 <para> 853 913 The sources for &product-name;'s kernel module are provided in 854 the <computeroutput>src</computeroutput> directory. To build 855 the module, change to the directory and use the following 856 command: 914 the <filename>src</filename> directory. To build the module, 915 change to the directory and use the following command: 857 916 </para> 858 917 … … 878 937 you how to create the device node, depending on your Linux 879 938 system. The procedure is slightly different for a classical 880 Linux setup with a <computeroutput>/dev</computeroutput> 881 directory, a system with the now deprecated 882 <command>devfs</command> and a modern Linux system with 883 <command>udev</command>. 939 Linux setup with a <filename>/dev</filename> directory, a 940 system with the now deprecated <command>devfs</command> and a 941 modern Linux system with <command>udev</command>. 884 942 </para> 885 943 … … 893 951 894 952 <para> 895 Note that the < computeroutput>/dev/vboxdrv</computeroutput>896 kernel module device node must be owned by root:root and must897 beread/writable only for the user.953 Note that the <filename>/dev/vboxdrv</filename> kernel module 954 device node must be owned by root:root and must be 955 read/writable only for the user. 898 956 </para> 899 957 … … 908 966 <para> 909 967 This example assumes you installed &product-name; to the 910 < computeroutput>/opt/VirtualBox</computeroutput> directory.968 <filename>/opt/VirtualBox</filename> directory. 911 969 </para> 912 970 … … 971 1029 perform this task. To prevent any user interaction during 972 1030 installation, default values can be defined. A file 973 < computeroutput>vboxconf</computeroutput> can contain the974 following debconfsettings:1031 <literal>vboxconf</literal> can contain the following debconf 1032 settings: 975 1033 </para> 976 1034 … … 1008 1066 The RPM format does not provide a configuration system 1009 1067 comparable to the debconf system. See 1010 <xref 1011 linkend="linux_install_opts" /> for how to set 1012 some common installation options provided by &product-name;. 1068 <xref linkend="linux_install_opts" /> for how to set some 1069 common installation options provided by &product-name;. 1013 1070 </para> 1014 1071 … … 1022 1079 To configure the installation process for .deb and .rpm 1023 1080 packages, you can create a response file named 1024 < computeroutput>/etc/default/virtualbox</computeroutput>. The1025 automatic generation of the udev rule can be prevented with1026 thefollowing setting:1081 <filename>/etc/default/virtualbox</filename>. The automatic 1082 generation of the udev rule can be prevented with the 1083 following setting: 1027 1084 </para> 1028 1085 … … 1038 1095 <para> 1039 1096 If the following line is specified, the package installer will 1040 not try to build the <computeroutput>vboxdrv</computeroutput> 1041 kernel module if no module fitting the current kernel was 1042 found. 1097 not try to build the <command>vboxdrv</command> kernel module 1098 if no module fitting the current kernel was found. 1043 1099 </para> 1044 1100 … … 1055 1111 <para> 1056 1112 The Linux installers create the system user group 1057 <computeroutput>vboxusers</computeroutput> during installation. 1058 Any system user who is going to use USB devices from 1059 &product-name; guests must be a member of that group. A user can 1060 be made a member of the group 1061 <computeroutput>vboxusers</computeroutput> through the GUI 1062 user/group management or using the following command: 1113 <literal>vboxusers</literal> during installation. Any system 1114 user who is going to use USB devices from &product-name; guests 1115 must be a member of that group. A user can be made a member of 1116 the group <literal>vboxusers</literal> either by using the 1117 desktop user and group tools, or with the following command: 1063 1118 </para> 1064 1119 … … 1072 1127 1073 1128 <para> 1074 The easiest way to start a &product-name; program is by running1129 The easiest way to start an &product-name; program is by running 1075 1130 the program of your choice (<command>VirtualBox</command>, 1076 1131 <command>VBoxManage</command>, or … … 1084 1139 if you wish to execute &product-name; without installing it 1085 1140 first. You should start by compiling the 1086 <computeroutput>vboxdrv</computeroutput> kernel module and 1087 inserting it into the Linux kernel. &product-name; consists of a 1088 service daemon, <computeroutput>VBoxSVC</computeroutput>, and 1089 several application programs. The daemon is automatically 1090 started if necessary. All &product-name; applications will 1091 communicate with the daemon through UNIX local domain sockets. 1092 There can be multiple daemon instances under different user 1093 accounts and applications can only communicate with the daemon 1094 running under the user account as the application. The local 1095 domain socket resides in a subdirectory of your system's 1096 directory for temporary files called 1097 <computeroutput>.vbox-<username>-ipc</computeroutput>. In 1098 case of communication problems or server startup problems, you 1099 may try to remove this directory. 1141 <command>vboxdrv</command> kernel module and inserting it into 1142 the Linux kernel. &product-name; consists of a service daemon, 1143 <command>VBoxSVC</command>, and several application programs. 1144 The daemon is automatically started if necessary. All 1145 &product-name; applications will communicate with the daemon 1146 through UNIX local domain sockets. There can be multiple daemon 1147 instances under different user accounts and applications can 1148 only communicate with the daemon running under the user account 1149 as the application. The local domain socket resides in a 1150 subdirectory of your system's directory for temporary files 1151 called <filename>.vbox-<username>-ipc</filename>. In case 1152 of communication problems or server startup problems, you may 1153 try to remove this directory. 1100 1154 </para> 1101 1155 … … 1119 1173 <para> 1120 1174 For the specific versions of Oracle Solaris that are supported as 1121 host operating systems, see <xref 1122 linkend="hostossupport" />. 1175 host operating systems, see <xref linkend="hostossupport" />. 1123 1176 </para> 1124 1177 … … 1137 1190 <para> 1138 1191 &product-name; is available as a standard Oracle Solaris 1139 package. Download the &product-name; SunOS package which1140 includes the 64-bit version sof &product-name;. <emphasis>The1192 package. Download the &product-name; SunOS package, which 1193 includes the 64-bit version of &product-name;. <emphasis>The 1141 1194 installation must be performed as root and from the global 1142 zone</emphasis> as the &product-name; installer loads kernel 1143 drivers which cannot be done from non-global zones. To verify 1144 which zone you are currently in, execute the 1145 <command>zonename</command> command. Execute the following 1146 commands: 1195 zone</emphasis>. This is because the &product-name; installer 1196 loads kernel drivers, which cannot be done from non-global 1197 zones. To verify which zone you are currently in, execute the 1198 <command>zonename</command> command. 1199 </para> 1200 1201 <para> 1202 To start installation, run the following commands: 1147 1203 </para> 1148 1204 … … 1150 1206 1151 1207 <para> 1152 The &product-name; kernel package is no longer a separate 1153 package and has been integrated into the main package. Install 1154 the &product-name; package as follows: 1208 The &product-name; kernel package is integrated into the main 1209 package. Install the &product-name; package as follows: 1155 1210 </para> 1156 1211 … … 1172 1227 Once the postinstall script has been executed your installation 1173 1228 is now complete. You may now safely delete the uncompressed 1174 package and < computeroutput>autoresponse</computeroutput> files1175 from yoursystem. &product-name; is installed in1176 < computeroutput>/opt/VirtualBox</computeroutput>.1229 package and <filename>autoresponse</filename> files from your 1230 system. &product-name; is installed in 1231 <filename>/opt/VirtualBox</filename>. 1177 1232 </para> 1178 1233 … … 1192 1247 <para> 1193 1248 The installer creates the system user group 1194 < computeroutput>vboxuser</computeroutput> during installation1195 for Oracle Solaris hosts that support the USB features required1196 by &product-name;. Any system user who is going to use USB1197 devices from &product-name; guests must be a member of this1198 group. A user can be made a member of this group through the GUI1199 user/group management or at the command line by executing as1200 root:1249 <literal>vboxuser</literal> during installation for Oracle 1250 Solaris hosts that support the USB features required by 1251 &product-name;. Any system user who is going to use USB devices 1252 from &product-name; guests must be a member of this group. A 1253 user can be made a member of this group either by using the 1254 desktop user and group tools or by running the following command 1255 as root: 1201 1256 </para> 1202 1257 … … 1204 1259 1205 1260 <para> 1206 Note that adding an active user to that group will require that 1207 user to log out and back in again. This should be done manually 1208 after successful installation of the package. 1261 Note that adding an active user to the 1262 <literal>vboxuser</literal> group will require the user to log 1263 out and then log in again. This should be done manually after 1264 successful installation of the package. 1209 1265 </para> 1210 1266 … … 1216 1272 1217 1273 <para> 1218 The easiest way to start a &product-name; program is by running1274 The easiest way to start an &product-name; program is by running 1219 1275 the program of your choice (<command>VirtualBox</command>, 1220 1276 <command>VBoxManage</command>, or … … 1226 1282 <para> 1227 1283 Alternatively, you can directly invoke the required programs 1228 from <computeroutput>/opt/VirtualBox</computeroutput>. Using the 1229 links provided is easier as you do not have to enter the full 1230 path. 1284 from <filename>/opt/VirtualBox</filename>. Using the links 1285 provided is easier as you do not have to enter the full path. 1231 1286 </para> 1232 1287 … … 1256 1311 </para> 1257 1312 1258 <para>1259 If you are uninstalling &product-name; version 3.0 or lower, you1260 need to remove the &product-name; kernel interface package, as1261 follows:1262 </para>1263 1264 <screen>pkgrm SUNWvboxkern</screen>1265 1266 1313 </sect2> 1267 1314 … … 1273 1320 To perform a non-interactive installation of &product-name; 1274 1321 there is a response file named 1275 <computeroutput>autoresponse</computeroutput>, that the 1276 installer will use for responses to inputs rather than ask them 1277 from you. 1278 </para> 1279 1280 <para> 1281 Extract the tar.gz package as described in the normal 1282 installation instructions. Then open a root terminal session and 1283 run the following command: 1322 <filename>autoresponse</filename>. The installer uses this for 1323 responses to inputs, rather than prompting the user. 1324 </para> 1325 1326 <para> 1327 Extract the tar.gz package as described in 1328 <xref linkend="install-solaris-performing"/>. Then open a root 1329 terminal session and run the following command: 1284 1330 </para> 1285 1331 … … 1306 1352 </para> 1307 1353 1308 <screen>zonecfg -z vboxzone</screen> 1309 1310 <para> 1311 Replace "vboxzone" with the name of the zone where you intend to 1312 run &product-name;. 1313 </para> 1314 1315 <para> 1316 Use<computeroutput>zonecfg</computeroutput> to add the 1317 <computeroutput>device</computeroutput> resource and 1318 <computeroutput>match</computeroutput> properties to the zone, 1319 as follows: 1354 <screen>zonecfg -z <replaceable>vboxzone</replaceable></screen> 1355 1356 <para> 1357 Replace <replaceable>vboxzone</replaceable> with the name of the 1358 zone where you intend to run &product-name;. 1359 </para> 1360 1361 <para> 1362 Use <command>zonecfg</command> to add the 1363 <literal>device</literal> resource and <literal>match</literal> 1364 properties to the zone, as follows: 1320 1365 </para> 1321 1366 … … 1329 1374 1330 1375 <para> 1331 If you are running &product-name; 2.2.0 or above on Oracle 1332 Solaris 11 or above, you may also add a device for 1333 <computeroutput>/dev/vboxusbmon</computeroutput>, similar to 1334 that shown above. This does not apply to Oracle Solaris 10 1335 hosts, due to lack of USB support. 1376 On Oracle Solaris 11 or later, you may also add a device for 1377 <filename>/dev/vboxusbmon</filename>, similar to that shown 1378 above. 1336 1379 </para> 1337 1380 1338 1381 <para> 1339 1382 If you are not using sparse root zones, you will need to 1340 loopback mount <computeroutput>/opt/VirtualBox</computeroutput> 1341 from the global zone into the non-global zone at the same path. 1342 This is specified below using the 1343 <computeroutput>dir</computeroutput> attribute and the 1344 <computeroutput>special</computeroutput> attribute. For example: 1383 loopback mount <filename>/opt/VirtualBox</filename> from the 1384 global zone into the non-global zone at the same path. This is 1385 specified below using the <literal>dir</literal> attribute and 1386 the <literal>special</literal> attribute. For example: 1345 1387 </para> 1346 1388 … … 1353 1395 1354 1396 <para> 1355 Reboot the zone using <computeroutput>zoneadm</computeroutput> 1356 and you should be able to run &product-name; from within the 1357 configured zone. 1397 Reboot the zone using <command>zoneadm</command> and you should 1398 be able to run &product-name; from within the configured zone. 1358 1399 </para> 1359 1400 -
trunk/doc/manual/en_US/user_Introduction.xml
r81940 r82350 184 184 OS).</emphasis> This is the OS that is running inside the 185 185 virtual machine. Theoretically, &product-name; can run any x86 186 OS .such as DOS, Windows, OS/2, FreeBSD, and OpenBSD. But to186 OS such as DOS, Windows, OS/2, FreeBSD, and OpenBSD. But to 187 187 achieve near-native performance of the guest code on your 188 188 machine, we had to go through a lot of optimizations that are … … 203 203 is the special environment that &product-name; creates for 204 204 your guest OS while it is running. In other words, you run 205 your guest OS <emphasis>in</emphasis> a VM. Normally, a VM 206 will be shown as a window on your computer's desktop, but207 depending on which of the various frontends of &product-name;208 you use, it can be displayed in full screen mode or remotely209 on anothercomputer.210 </para> 211 212 <para> 213 In a more abstract way, internally, &product-name; thinks of a214 VM as a set of parameters that determine its behavior. They215 include hardware settings, such as: how much memory the VM216 should have, what hard disks &product-name; should virtualize217 through which container files, what CDs are mounted. They also218 include state information, such as: whether the VM is219 currently running, saved, if the VM has snapshots. These 220 settings are mirrored in the VirtualBox Manager window, as221 well as the <command>VBoxManage</command> command. See222 <xref linkend="vboxmanage" />. In other words, a VM is also223 what you can see in its224 < emphasis role="bold">Settings</emphasis> dialog.205 your guest OS <emphasis>in</emphasis> a VM. Normally, a VM is 206 shown as a window on your computer's desktop. Depending on 207 which of the various frontends of &product-name; you use, the 208 VM might be shown in full screen mode or remotely on another 209 computer. 210 </para> 211 212 <para> 213 Internally, &product-name; treats a VM as a set of parameters 214 that specify its behavior. Some parameters describe hardware 215 settings, such as the amount of memory and number of CPUs 216 assigned. Other parameters describe the state information, 217 such as whether the VM is running or saved. 218 </para> 219 220 <para> 221 You can view these VM settings in the VirtualBox Manager 222 window, the <emphasis role="bold">Settings</emphasis> dialog, 223 and by running the <command>VBoxManage</command> command. See 224 <xref linkend="vboxmanage" />. 225 225 </para> 226 226 </listitem> … … 287 287 288 288 <para> 289 For users of &oci; the functionality extends to exporting 290 and importing virtial machines to and from the cloud. This291 simplifies development of applications and deployment to 292 theproduction environment. See289 For users of &oci; the functionality extends to exporting and 290 importing virtual machines to and from the cloud. This 291 simplifies development of applications and deployment to the 292 production environment. See 293 293 <xref linkend="cloud-export-oci"/>. 294 294 </para> … … 310 310 311 311 <para> 312 In particular, Guest Additions provide for "shared folders", 313 which let you access files from the host system from within a 314 guest machine. See <xref linkend="sharedfolders" />. 312 In particular, Guest Additions provide for <emphasis>shared 313 folders</emphasis>, which let you access files on the host 314 system from within a guest machine. See 315 <xref linkend="sharedfolders" />. 315 316 </para> 316 317 </listitem> … … 319 320 <para> 320 321 <emphasis role="bold">Great hardware support.</emphasis> Among 321 other s, &product-name; supports the following:322 other features, &product-name; supports the following: 322 323 </para> 323 324 … … 350 351 devices, among them many devices that are typically 351 352 provided by other virtualization platforms. That includes 352 IDE, SCSI and SATA hard disk controllers, several virtual353 IDE, SCSI, and SATA hard disk controllers, several virtual 353 354 network cards and sound cards, virtual serial and parallel 354 355 ports and an Input/Output Advanced Programmable Interrupt 355 Controller (I/O APIC), which is found in many modern PC356 systems. This e ases cloning of PC images from real357 machines and importing of third-party virtual machines358 into &product-name;.356 Controller (I/O APIC), which is found in many computer 357 systems. This enables easy cloning of disk images from 358 real machines and importing of third-party virtual 359 machines into &product-name;. 359 360 </para> 360 361 </listitem> … … 364 365 <emphasis role="bold">Full ACPI support.</emphasis> The 365 366 Advanced Configuration and Power Interface (ACPI) is fully 366 supported by &product-name;. This eases cloning of PC 367 images from real machines or third-party virtual machines 368 into &product-name;. With its unique <emphasis>ACPI power 369 status support</emphasis>, &product-name; can even report 370 to ACPI-aware guest OSes the power status of the host. For 371 mobile systems running on battery, the guest can thus 372 enable energy saving and notify the user of the remaining 373 power, for example in full screen modes. 367 supported by &product-name;. This enables easy cloning of 368 disk images from real machines or third-party virtual 369 machines into &product-name;. With its unique 370 <emphasis>ACPI power status support</emphasis>, 371 &product-name; can even report to ACPI-aware guest OSes 372 the power status of the host. For mobile systems running 373 on battery, the guest can thus enable energy saving and 374 notify the user of the remaining power, for example in 375 full screen modes. 374 376 </para> 375 377 </listitem> … … 503 505 virtual channel support, &product-name; also enables you 504 506 to connect arbitrary USB devices locally to a virtual 505 machine which is running remotely on a &product-name; RDP507 machine which is running remotely on an &product-name; RDP 506 508 server. See <xref linkend="usb-over-rdp" />. 507 509 </para> … … 546 548 <listitem> 547 549 <para> 548 Windows 10 Anniversary Update (1607 / 2016 LTSB) build 14393 550 Windows 10 Anniversary Update (1607 / 2016 LTSB) build 551 14393 549 552 </para> 550 553 </listitem> … … 564 567 <listitem> 565 568 <para> 566 Windows 10 October 2018 Update (1809 / 2019 LTSC) build 17763 569 Windows 10 October 2018 Update (1809 / 2019 LTSC) build 570 17763 567 571 </para> 568 572 </listitem> … … 668 672 <listitem> 669 673 <para> 670 Red hat Enterprise Linux 6, 7 and 8674 Red Hat Enterprise Linux 6, 7 and 8 671 675 </para> 672 676 </listitem> … … 740 744 </para> 741 745 742 </sect1>743 744 <sect1 id="hostcpurequirements">745 746 <title>Host CPU Requirements</title>747 748 <para>749 SSE2 is required, starting with &product-name; version 5.2.10 and750 version 5.1.24. 751 </ para>746 <sect2 id="hostcpurequirements"> 747 748 <title>Host CPU Requirements</title> 749 750 <para> 751 SSE2 (Streaming SIMD Extensions 2) support is required for host 752 CPUs. 753 </para> 754 755 </sect2> 752 756 753 757 </sect1> … … 788 792 Oracle provides a single extension pack, available from: 789 793 <ulink 790 url="http://www.virtualbox.org" >http://www.virtualbox.org</ulink>.791 Theextension pack provides the following added functionality:794 url="http://www.virtualbox.org" />. The 795 extension pack provides the following added functionality: 792 796 </para> 793 797 … … 829 833 </listitem> 830 834 831 835 <!-- <listitem> 832 836 <para> 833 837 Experimental support for PCI passthrough on Linux hosts. 834 838 See <xref linkend="pcipassthrough" />. 835 839 </para> 836 </listitem> 840 </listitem>--> 837 841 838 842 <listitem> … … 847 851 <para> 848 852 &product-name; extension packages have a 849 < computeroutput>.vbox-extpack</computeroutput> file name850 extension. To install an extension, simply double-click on the851 package fileand a <emphasis role="bold">Network Operations853 <filename>.vbox-extpack</filename> file name extension. To 854 install an extension, simply double-click on the package file 855 and a <emphasis role="bold">Network Operations 852 856 Manager</emphasis> window is shown to guide you through the 853 857 required steps. … … 891 895 <emphasis role="bold">Programs</emphasis> menu, click on the 892 896 item in the <emphasis role="bold">VirtualBox</emphasis> group. 893 On Vista or Windows 7, you can also enter894 <com puteroutput>VirtualBox</computeroutput> in the search box895 of the<emphasis role="bold">Start</emphasis> menu.897 On some Windows platforms, you can also enter 898 <command>VirtualBox</command> in the search box of the 899 <emphasis role="bold">Start</emphasis> menu. 896 900 </para> 897 901 </listitem> … … 912 916 either the System or System Tools group of your 913 917 <emphasis role="bold">Applications</emphasis> menu. 914 Alternatively, you can enter 915 <computeroutput>VirtualBox</computeroutput> in a terminal 916 window. 918 Alternatively, you can enter <command>VirtualBox</command> in 919 a terminal window. 917 920 </para> 918 921 </listitem> … … 1002 1005 <listitem> 1003 1006 <para> 1004 The <emphasis role="bold">Name</emphasis> of the VM will later 1005 be shown in the machine list of the VirtualBox Manager window, 1006 and it will be used for the VM's files on disk. Even though 1007 any name can be used, bear in mind that if you create a few 1008 VMs, you will appreciate if you have given your VMs rather 1009 informative names."My VM" would thus be less useful than 1010 "Windows XP SP2 with OpenOffice", for example. 1007 The <emphasis role="bold">Name</emphasis> of the VM you choose 1008 is shown in the machine list of the VirtualBox Manager window 1009 and is also used for the VM's files on disk. 1010 </para> 1011 1012 <para> 1013 Be sure to assign each VM an informative name that describes 1014 the OS and software running on the VM. For example, 1015 <literal>Windows 10 with Visio</literal>. 1011 1016 </para> 1012 1017 </listitem> … … 1022 1027 <listitem> 1023 1028 <para> 1024 For <emphasis role="bold">Operating System Type</emphasis> 1025 select the OS that you want to install later. The supported 1026 OSes are grouped. If you want to install something very 1027 unusual that is not listed, select 1028 <emphasis role="bold">Other</emphasis>. Depending on your 1029 selection, &product-name; will enable or disable certain VM 1030 settings that your guest OS may require. This is particularly 1031 important for 64-bit guests. See 1029 For <emphasis role="bold">Operating System Type</emphasis>, 1030 select the OS that you want to install. The supported OSes are 1031 grouped. If you want to install something very unusual that is 1032 not listed, select <emphasis role="bold">Other</emphasis>. 1033 Depending on your selection, &product-name; will enable or 1034 disable certain VM settings that your guest OS may require. 1035 This is particularly important for 64-bit guests. See 1032 1036 <xref linkend="intro-64bitguests" />. It is therefore 1033 1037 recommended to always set it to the correct value. … … 1049 1053 Choose this setting carefully. The memory you give to the VM 1050 1054 will not be available to your host OS while the VM is 1051 running, so do not specify more than you can spare. For 1052 example, if your host machine has 1 GB of RAM and you enter 1053 512 MB as the amount of RAM for a particular virtual 1054 machine, while that VM is running, you will only have 512 MB 1055 left for all the other software on your host. If you run two 1056 VMs at the same time, even more memory will be allocated for 1057 the second VM, which may not even be able to start if that 1058 memory is not available. On the other hand, you should 1059 specify as much as your guest OS and your applications will 1060 require to run properly. 1055 running, so do not specify more than you can spare. 1056 </para> 1057 1058 <para> 1059 For example, if your host machine has 4 GB of RAM and you 1060 enter 2048 MB as the amount of RAM for a particular virtual 1061 machine, you will only have 2 GB left for all the other 1062 software on your host while the VM is running. If you run 1063 two VMs at the same time, even more memory will be allocated 1064 for the second VM, which may not even be able to start if 1065 that memory is not available. 1066 </para> 1067 1068 <para> 1069 On the other hand, you should specify as much as your guest 1070 OS and your applications will require to run properly. A 1071 guest OS may require at least 1 or 2 GB of memory to install 1072 and boot up. For best performance, more memory than that may 1073 be required. 1061 1074 </para> 1062 1075 </caution> 1063 1076 1064 1077 <para> 1065 A Windows XP guest will require at least a few hundred MB of 1066 RAM to run properly, and Windows Vista will not install with 1067 less than 512 MB. If you want to run graphics-intensive 1068 applications in your VM, you may require even more RAM. 1069 </para> 1070 1071 <para> 1072 As a rule of thumb, if you have 1 GB of RAM or more in your 1073 host computer, it is usually safe to allocate 512 MB to each 1074 VM. In any case, make sure you always have at least 256 to 512 1075 MB of RAM left on your host OS. Otherwise you may cause your 1076 host OS to excessively swap out memory to your hard disk, 1077 effectively bringing your host system to a standstill. 1078 Always ensure that the host OS has enough RAM remaining. If 1079 insufficient RAM remains, the system might excessively swap 1080 memory to the hard disk, which effectively brings the host 1081 system to a standstill. 1078 1082 </para> 1079 1083 … … 1094 1098 &product-name; can provide hard disk space to a VM, see 1095 1099 <xref linkend="storage" />, but the most common way is to use 1096 a large image file on your "real"hard disk, whose contents1100 a large image file on your physical hard disk, whose contents 1097 1101 &product-name; presents to your VM as if it were a complete 1098 hard disk. This file represents an entire hard disk then, so1102 hard disk. This file then represents an entire hard disk, so 1099 1103 you can even copy it to another host and use it with another 1100 1104 &product-name; installation. … … 1107 1111 <figure id="fig-new-vm-hard-disk"> 1108 1112 <title>Creating a New Virtual Machine: Hard Disk</title> 1109 1113 <mediaobject> 1110 1114 <imageobject> 1111 1115 <imagedata align="center" fileref="images/create-vm-2.png" … … 1174 1178 <para> 1175 1179 A <emphasis role="bold">dynamically allocated 1176 file</emphasis> will only grow in size when the guest 1177 actually stores data on its virtual hard disk. It will 1178 therefore initially be small on the host hard drive and 1179 only later grow to the size specified as it is filled with 1180 data. 1181 </para> 1182 </listitem> 1183 1184 <listitem> 1185 <para> 1186 A <emphasis role="bold">fixed-size file</emphasis> will 1187 immediately occupy the file specified, even if only a 1188 fraction of the virtual hard disk space is actually in 1180 file</emphasis> only grows in size when the guest actually 1181 stores data on its virtual hard disk. Therefore, this file 1182 is small initially. As the drive is filled with data, the 1183 file grows to the specified size. 1184 </para> 1185 </listitem> 1186 1187 <listitem> 1188 <para> 1189 A <emphasis role="bold">fixed-size file</emphasis> 1190 immediately occupies the file specified, even if only a 1191 fraction of that virtual hard disk space is actually in 1189 1192 use. While occupying much more space, a fixed-size file 1190 1193 incurs less overhead and is therefore slightly faster than … … 1201 1204 1202 1205 <para> 1203 To prevent your physical hard disk from running full, 1204 &product-name; limits the size of the image file. Still, it 1205 needs to be large enough to hold the contents of your OS and 1206 the applications you want to install. For a modern Windows or 1207 Linux guest, you will probably need several gigabytes for any 1208 serious use. The limit of the image file size can be changed 1209 later, see <xref linkend="vboxmanage-modifyvdi"/>. 1206 To prevent your physical hard disk (host OS) from filling up, 1207 &product-name; limits the size of the image file. But the 1208 image file must be large enough to hold the contents of the 1209 guest OS and the applications you want to install. For a 1210 Windows or Linux guest, you will probably need several 1211 gigabytes for any serious use. The limit of the image file 1212 size can be changed later, see 1213 <xref linkend="vboxmanage-modifymedium"/>. 1210 1214 </para> 1211 1215 … … 1275 1279 <listitem> 1276 1280 <para> 1277 Go to the < computeroutput>VirtualBox VMs</computeroutput>1278 folder in your system user's home directory. Findthe1279 subdirectory of the machine you want to start and double-click1280 on the machine settings file. This file has a1281 <computeroutput>.vbox</computeroutput> fileextension.1281 Go to the <filename>VirtualBox VMs</filename> folder in your 1282 system user's home directory. Find the subdirectory of the 1283 machine you want to start and double-click on the machine 1284 settings file. This file has a <filename>.vbox</filename> file 1285 extension. 1282 1286 </para> 1283 1287 </listitem> … … 1386 1390 1387 1391 <para> 1388 Otherwise, if the virtual machine only sees standard PS/2 mouse1389 and keyboard devices, since the OS in the virtual machine does1390 not know that it is not running on a real computer, it expects1391 to have exclusive control over your keyboard and mouse. But1392 unless you are running the VM in full screen mode, your VM needs1393 to share keyboard and mouse with other applications and possibly1394 other VMs on your host.1392 Otherwise, if the virtual machine detects only standard PS/2 1393 mouse and keyboard devices, since the OS in the virtual machine 1394 does not know that it is not running on a real computer, it 1395 expects to have exclusive control over your keyboard and mouse. 1396 But unless you are running the VM in full screen mode, your VM 1397 needs to share keyboard and mouse with other applications and 1398 possibly other VMs on your host. 1395 1399 </para> 1396 1400 … … 1450 1454 <para> 1451 1455 Note that while the VM owns the keyboard, some key 1452 sequences, such as Alt -Tab, will no longer be seen by the1456 sequences, such as Alt+Tab, will no longer be seen by the 1453 1457 host, but will go to the guest instead. After you press the 1454 1458 Host key to reenable the host keyboard, all key presses will 1455 go through the host again, so that sequences such as Alt -Tab1459 go through the host again, so that sequences such as Alt+Tab 1456 1460 will no longer reach the guest. For technical reasons it may 1457 1461 not be possible for the VM to get all keyboard input even 1458 1462 when it does own the keyboard. Examples of this are the 1459 Ctrl-Alt-Del sequence on Windows hosts or single keys 1460 grabbed by other applications on X11 hosts like the GNOME 1461 desktop's "Control key highlights mouse pointer" 1462 functionality. 1463 Ctrl+Alt+Del sequence on Windows hosts or single keys 1464 grabbed by other applications on X11 hosts such as the GNOME 1465 desktop Locate Pointer feature. 1463 1466 </para> 1464 1467 </listitem> … … 1488 1491 1489 1492 <para> 1490 As this behavior can be inconvenient, &product-name; provides a1491 setof tools and device drivers for guest systems called the1492 &product-name; Guest Additions which make VM keyboard and mouse1493 operation a lot more seamless. Most importantly, the Additions1494 will get rid of the second "guest" mouse pointer and make your1495 host mouse pointer work directly in the guest. See1493 As this behavior is inconvenient, &product-name; provides a set 1494 of tools and device drivers for guest systems called the 1495 &product-name; Guest Additions. These tools make VM keyboard and 1496 mouse operations much more seamless. Most importantly, the Guest 1497 Additions suppress the second "guest" mouse pointer and make 1498 your host mouse pointer work directly in the guest. See 1496 1499 <xref linkend="guestadditions" />. 1497 1500 </para> … … 1504 1507 1505 1508 <para> 1506 OSes expect certain key combinations to initiate certain 1507 procedures. Some of these key combinations may be difficult to 1508 enter into a virtual machine, as there are three candidates as 1509 to who receives keyboard input: the host OS, &product-name;, or 1510 the guest OS. Which of these three receives keypresses depends 1511 on a number of factors, including the key itself. 1509 Some OSes expect certain key combinations to initiate certain 1510 procedures. The key combinations that you type into a VM might 1511 target the host OS, the &product-name; software, or the guest 1512 OS. The recipient of these keypresses depends on a number of 1513 factors, including the key combination itself. 1512 1514 </para> 1513 1515 … … 1517 1519 <para> 1518 1520 Host OSes reserve certain key combinations for themselves. 1519 For example, it is impossible to enterthe1521 For example, you cannot use the 1520 1522 <emphasis role="bold">Ctrl+Alt+Delete</emphasis> combination 1521 if you want to reboot the guest OS in your virtual machine, 1522 because this key combination is usually hard-wired into the 1523 host OS, both Windows and Linux intercept this, and pressing 1524 this key combination will therefore reboot your 1525 <emphasis>host</emphasis>. 1523 to reboot the guest OS in your VM because this key 1524 combination is usually hard-wired into the host OS. So, even 1525 though both the Windows and Linux OSes intercept this key 1526 combination, only the host OS would be rebooted. 1526 1527 </para> 1527 1528 … … 1543 1544 where Fx is one of the function keys from F1 to F12, 1544 1545 normally enables you to switch between virtual terminals. As 1545 with Ctrl+Alt+Delete, these combinations are intercepted by1546 the host OS and therefore always switch terminals on the1547 <emphasis>host</emphasis>.1546 with <emphasis role="bold">Ctrl+Alt+Delete</emphasis>, these 1547 combinations are intercepted by the host OS and therefore 1548 always switch terminals on the <emphasis>host</emphasis>. 1548 1549 </para> 1549 1550 … … 1563 1564 virtual machine window. This menu includes the settings 1564 1565 <emphasis role="bold">Insert Ctrl+Alt+Delete</emphasis> 1565 and <emphasis role="bold">Ctrl+Alt+Backspace</emphasis>. 1566 The latter will only have an effect with Linux or Oracle 1567 Solaris guests, however. 1566 and <emphasis role="bold">Insert 1567 Ctrl+Alt+Backspace</emphasis>. However, the latter 1568 setting affects only Linux guests or Oracle Solaris 1569 guests. 1568 1570 </para> 1569 1571 … … 1576 1578 <listitem> 1577 1579 <para> 1578 Use special key combinations with the Host key, normally 1579 the right Control key. &product-name; will then 1580 translate these key combinations for the virtual 1581 machine: 1580 Use special key combinations with the Host key, which is 1581 normally the right Control key. &product-name; then 1582 translates the following key combinations for the VM: 1582 1583 </para> 1583 1584 … … 1586 1587 <listitem> 1587 1588 <para> 1588 <emphasis role="bold">Host key + Del</emphasis> to 1589 send Ctrl+Alt+Del to reboot the guest. 1589 <emphasis role="bold">Host key + Del</emphasis> 1590 sends <emphasis role="bold">Ctrl+Alt+Del</emphasis> 1591 to reboot the guest OS. 1590 1592 </para> 1591 1593 </listitem> … … 1594 1596 <para> 1595 1597 <emphasis role="bold">Host key + 1596 Backspace</emphasis> to send Ctrl+Alt+Backspace to 1597 restart the graphical user interface of a Linux or 1598 Oracle Solaris guest. 1598 Backspace</emphasis> sends 1599 <emphasis role="bold">Ctrl+Alt+Backspace</emphasis> 1600 to restart the graphical user interface of a Linux 1601 or Oracle Solaris guest. 1599 1602 </para> 1600 1603 </listitem> … … 1603 1606 <para> 1604 1607 <emphasis role="bold">Host key + Function 1605 key</emphasis>. For example, to simulate Ctrl+Alt+Fx 1606 to switch between virtual terminals in a Linux 1607 guest. 1608 key</emphasis>. For example, use this key 1609 combination to simulate 1610 <emphasis role="bold">Ctrl+Alt+Fx</emphasis> to 1611 switch between virtual terminals in a Linux guest. 1608 1612 </para> 1609 1613 </listitem> … … 1618 1622 <para> 1619 1623 For some other keyboard combinations such as 1620 <emphasis role="bold">Alt -Tab</emphasis> to switch between1624 <emphasis role="bold">Alt+Tab</emphasis> to switch between 1621 1625 open windows, &product-name; enables you to configure 1622 1626 whether these combinations will affect the host or the … … 1626 1630 <emphasis role="bold">Preferences</emphasis>, 1627 1631 <emphasis role="bold">Input</emphasis>. 1632 </para> 1633 </listitem> 1634 1635 <listitem> 1636 <para> 1637 A soft keyboard can be used to input key combinations in the 1638 guest. See <xref linkend="soft-keyb"/>. 1628 1639 </para> 1629 1640 </listitem> … … 1675 1686 1676 1687 <para> 1677 You can resize the virtual machine's window when it is running.1678 In that case, one of the following things will happen:1688 You can resize the VM's window while that VM is running. When 1689 you do, the window is scaled as follows: 1679 1690 </para> 1680 1691 … … 1795 1806 This will send an ACPI shutdown signal to the virtual 1796 1807 machine, which has the same effect as if you had pressed the 1797 power button on a real computer. So long as the VM is 1798 running a fairly modern OS, this should trigger a proper 1799 shutdown mechanism from within the VM. 1808 power button on a real computer. This should trigger a 1809 proper shutdown mechanism from within the VM. 1800 1810 </para> 1801 1811 </listitem> … … 2085 2095 <figure id="fig-snapshots-list"> 2086 2096 <title>Snapshots List For a Virtual Machine</title> 2087 2097 <mediaobject> 2088 2098 <imageobject> 2089 2099 <imagedata align="center" fileref="images/snapshots-1.png" … … 2258 2268 <para> 2259 2269 The memory state file can be as large as the memory size of 2260 the virtual machine and will therefore occupy quite some 2261 disk space as well. 2270 the VM and will therefore occupy considerable disk space. 2262 2271 </para> 2263 2272 </listitem> … … 2557 2566 <para> 2558 2567 <emphasis role="bold">Cloud service formats.</emphasis> Export 2559 to cloud services such as &oci; is supported. Import is not 2560 supported. See <xref linkend="cloud-export-oci"/>. 2568 to and import from cloud services such as &oci; is supported. 2569 See the following topics: 2570 </para> 2571 2572 <itemizedlist> 2573 2574 <listitem> 2575 <para> 2576 <xref linkend="cloud-export-oci"/> 2577 </para> 2578 </listitem> 2579 2580 <listitem> 2581 <para> 2582 <xref linkend="cloud-import-oci"/> 2583 </para> 2584 </listitem> 2585 2586 </itemizedlist> 2587 2588 <para> 2589 Before using &product-name; with &oci; there are some initial 2590 configuration steps you need to consider. See 2591 <xref linkend="cloud-integration-steps"/>. 2592 </para> 2593 2594 <para> 2595 &product-name; can also be used to create new instances from a 2596 custom image stored on &oci;. See 2597 <xref linkend="cloud-new-vm"/> 2561 2598 </para> 2562 2599 </listitem> … … 2592 2629 &product-name; supports all appliances created by other 2593 2630 virtualization software. For a list of known limitations, see 2594 <xref 2595 linkend="KnownIssues" />. 2631 <xref linkend="KnownIssues" />. 2596 2632 </para> 2597 2633 </note> … … 2609 2645 <xref linkend="vdidetails" />. They also include a textual 2610 2646 description file in an XML dialect with an 2611 < computeroutput>.ovf</computeroutput> extension. These files2612 must then reside in the same directory for &product-name; to2613 be ableto import them.2647 <filename>.ovf</filename> extension. These files must then 2648 reside in the same directory for &product-name; to be able 2649 to import them. 2614 2650 </para> 2615 2651 </listitem> … … 2619 2655 Alternatively, the above files can be packed together into a 2620 2656 single archive file, typically with an 2621 < computeroutput>.ova</computeroutput> extension. Such2622 a rchive files use a variant of the TAR archive format and2623 can therefore be unpacked outside of &product-name; with any2624 u tility that can unpack standard TAR files.2657 <filename>.ova</filename> extension. Such archive files use 2658 a variant of the TAR archive format and can therefore be 2659 unpacked outside of &product-name; with any utility that can 2660 unpack standard TAR files. 2625 2661 </para> 2626 2662 </listitem> … … 2666 2702 <para> 2667 2703 Select <emphasis role="bold">File</emphasis>, 2668 <emphasis 2669 role="bold">Import 2670 Appliance</emphasis> from the VirtualBox Manager window. 2704 <emphasis role="bold">Import Appliance</emphasis> from the 2705 VirtualBox Manager window. 2671 2706 </para> 2672 2707 2673 2708 <para> 2674 2709 From the file dialog, go to the file with either the 2675 < computeroutput>.ovf</computeroutput> or the2676 <computeroutput>.ova</computeroutput>file extension.2710 <filename>.ovf</filename> or the <filename>.ova</filename> 2711 file extension. 2677 2712 </para> 2678 2713 … … 2742 2777 <emphasis role="bold">Import Hard Drives as 2743 2778 VDI:</emphasis> Imports hard drives in the VDI format 2744 rather tha t in the defalut VMDK format.2779 rather than in the default VMDK format. 2745 2780 </para> 2746 2781 </listitem> … … 2828 2863 <para> 2829 2864 The <emphasis role="bold">&oci;</emphasis> value exports 2830 export to &oci;. See <xref linkend="cloud-export-oci"/>. 2865 the appliance to &oci;. See 2866 <xref linkend="cloud-export-oci"/>. 2831 2867 </para> 2832 2868 </listitem> … … 2902 2938 </sect2> 2903 2939 2904 <sect2 id="cloud-export-oci"> 2905 2906 <title>Exporting an Appliance to &oci;</title> 2907 2908 <para> 2909 &product-name; supports the export of VMs to an &oci; service. 2910 </para> 2911 2912 <para> 2913 Before you can export a VM to &oci;, ensure that you perform the 2914 following configuration steps: 2940 <sect2 id="cloud-integration-steps"> 2941 2942 <title>Preparing for &oci; Integration</title> 2943 2944 <para> 2945 There are some common configuration steps you need to take 2946 before using &product-name; to integrate with your &oci; 2947 account. 2915 2948 </para> 2916 2949 … … 2919 2952 <listitem> 2920 2953 <para> 2921 Generate an API signing key pair that is used for API 2922 requests to &oci;. 2954 <emphasis role="bold">Create a key pair.</emphasis> Generate 2955 an API signing key pair that is used for API requests to 2956 &oci;. 2923 2957 </para> 2924 2958 … … 2928 2962 <para> 2929 2963 The key pair is usually installed in the 2930 <computeroutput>.oci</computeroutput> folder in your 2931 home directory. For example, 2932 <computeroutput>~/.oci</computeroutput> on a Linux 2964 <filename>.oci</filename> folder in your home directory. 2965 For example, <filename>~/.oci</filename> on a Linux 2933 2966 system. 2934 2967 </para> … … 2950 2983 2951 2984 <para> 2952 <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> 2953 </para> 2954 </listitem> 2955 2956 <listitem> 2957 <para> 2958 Create a profile for your cloud account. 2959 </para> 2960 2961 <para> 2962 The cloud profile contains resource identifiers for your 2963 cloud account, such as your user OCID, and the fingerprint 2964 for your public key. You can create a cloud profile in the 2985 <ulink url="https://docs.cloud.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#How" /> 2986 </para> 2987 </listitem> 2988 2989 <listitem> 2990 <para> 2991 <emphasis role="bold">Create a cloud profile.</emphasis> The 2992 cloud profile contains resource identifiers for your cloud 2993 account, such as your user OCID, and the fingerprint for 2994 your public key. You can create a cloud profile in the 2965 2995 following ways: 2966 2996 </para> … … 2970 3000 <listitem> 2971 3001 <para> 2972 Automatically by using the <emphasis role="bold">Cloud3002 Automatically, by using the <emphasis role="bold">Cloud 2973 3003 Profile Manager</emphasis>. See 2974 3004 <xref linkend="ovf-cloud-profile-manager"/>. … … 2978 3008 <listitem> 2979 3009 <para> 2980 Manually by creating an 2981 <computeroutput>oci_config</computeroutput> file in your 2982 &product-name; global configuration directory. For 2983 example, this is 2984 <computeroutput>$HOME/.config/VirtualBox/oci_config</computeroutput> 3010 Automatically, by using the <command>VBoxManage 3011 cloudprofile</command> command. See 3012 <xref linkend="vboxmanage-cloudprofile"/>. 3013 </para> 3014 </listitem> 3015 3016 <listitem> 3017 <para> 3018 Manually, by creating an <filename>oci_config</filename> 3019 file in your &product-name; global configuration 3020 directory. For example, this is 3021 <filename>$HOME/.config/VirtualBox/oci_config</filename> 2985 3022 on a Linux host. 2986 3023 </para> … … 2989 3026 <listitem> 2990 3027 <para> 2991 Manually by creating a 2992 <computeroutput>config</computeroutput> file in your 2993 &oci; configuration directory. For example, this is 2994 <computeroutput>$HOME/.oci/config</computeroutput> on a 2995 Linux host. 3028 Manually, by creating a <filename>config</filename> file 3029 in your &oci; configuration directory. For example, this 3030 is <filename>$HOME/.oci/config</filename> on a Linux 3031 host. 2996 3032 </para> 2997 3033 … … 3003 3039 <para> 3004 3040 &product-name; automatically uses the 3005 < computeroutput>config</computeroutput> file if no cloud3006 profile file is present in your global configuration3007 directory. Alternatively, you can import this file3008 manually intothe Cloud Profile Manager.3041 <filename>config</filename> file if no cloud profile 3042 file is present in your global configuration directory. 3043 Alternatively, you can import this file manually into 3044 the Cloud Profile Manager. 3009 3045 </para> 3010 3046 </listitem> … … 3018 3054 3019 3055 <para> 3020 <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> 3021 </para> 3022 </listitem> 3023 3024 <listitem> 3025 <para> 3026 Ensure that the subnets that are used by source VMs are 3027 available in the target compartment on the cloud service. 3056 <ulink url="https://docs.cloud.oracle.com/iaas/Content/API/Concepts/sdkconfig.htm" /> 3057 </para> 3058 </listitem> 3059 3060 <listitem> 3061 <para> 3062 <emphasis role="bold">Custom Linux images.</emphasis> To 3063 export a custom Linux image, prepare the VM as described 3064 here: 3065 </para> 3066 3067 <para> 3068 <ulink url="https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/importingcustomimagelinux.htm" /> 3069 </para> 3070 </listitem> 3071 3072 <listitem> 3073 <para> 3074 <emphasis role="bold">Subnets.</emphasis> When exporting a 3075 VM to cloud, ensure that the subnets that are used by source 3076 VMs are available in the target compartment on the cloud 3077 service. 3028 3078 </para> 3029 3079 </listitem> 3030 3080 3031 3081 </itemizedlist> 3082 3083 </sect2> 3084 3085 <sect2 id="cloud-export-oci"> 3086 3087 <title>Exporting an Appliance to &oci;</title> 3088 3089 <para> 3090 &product-name; supports the export of VMs to an &oci; service. 3091 The exported VM is stored on &oci; as a custom image. You can 3092 configure whether a cloud instance is created and started after 3093 the export process has completed. 3094 </para> 3095 3096 <para> 3097 Before you can export a VM to &oci; ensure that you have done 3098 the required preconfiguration tasks, as described in 3099 <xref linkend="cloud-integration-steps"/>. 3100 </para> 3032 3101 3033 3102 <para> … … 3074 3143 3075 3144 <figure id="fig-export-appliance-oci"> 3076 <title>Appliance Settings Screen, Showing Cloud Profile Settings</title> 3145 <title>Appliance Settings Screen, Showing Cloud Profile and Machine Creation 3146 Settings</title> 3077 3147 <mediaobject> 3078 3148 <imageobject> … … 3081 3151 </imageobject> 3082 3152 </mediaobject> 3153 3083 3154 </figure> 3155 3156 <para> 3157 In the <emphasis role="bold">Machine Creation</emphasis> 3158 field, select an option to configure settings for a cloud 3159 instance created when you export to &oci;. The options 3160 enable you to do one of the following: 3161 </para> 3162 3163 <itemizedlist> 3164 3165 <listitem> 3166 <para> 3167 Configure settings for the cloud instance 3168 <emphasis>after</emphasis> you have finished exporting 3169 the VM. 3170 </para> 3171 </listitem> 3172 3173 <listitem> 3174 <para> 3175 Configure settings for the cloud instance 3176 <emphasis>before</emphasis> you start to export the VM. 3177 </para> 3178 </listitem> 3179 3180 <listitem> 3181 <para> 3182 Do not create a cloud instance when you export the VM. 3183 </para> 3184 </listitem> 3185 3186 </itemizedlist> 3084 3187 3085 3188 <para> 3086 3189 Click <emphasis role="bold">Next</emphasis> to make an API 3087 3190 request to the &oci; service and open the 3088 <emphasis 3089 role="bold">Virtual System 3090 Settings</emphasis> screen. 3091 </para> 3092 </listitem> 3093 3094 <listitem> 3095 <para> 3096 Optionally edit settings used for the virtual machine on 3097 &oci;. 3098 </para> 3099 3100 <para> 3101 For example, you can edit the Disk Size and Shape used for 3102 the VM instance. 3103 </para> 3191 <emphasis role="bold">Virtual System Settings</emphasis> 3192 screen. 3193 </para> 3194 </listitem> 3195 3196 <listitem> 3197 <para> 3198 Optionally edit storage settings used for the exported 3199 virtual machine in &oci;. You can change the following 3200 settings: 3201 </para> 3202 3203 <itemizedlist> 3204 3205 <listitem> 3206 <para> 3207 The name of the bucket used to store the exported files. 3208 </para> 3209 </listitem> 3210 3211 <listitem> 3212 <para> 3213 Whether to store the custom image in &oci;. 3214 </para> 3215 </listitem> 3216 3217 <listitem> 3218 <para> 3219 The name for the custom image in &oci;. 3220 </para> 3221 </listitem> 3222 3223 <listitem> 3224 <para> 3225 The launch mode for the custom image. 3226 </para> 3227 3228 <para> 3229 <emphasis role="bold">Paravirtualized</emphasis> mode 3230 gives improved performance and should be suitable for 3231 most &product-name; VMs. 3232 </para> 3233 3234 <para> 3235 <emphasis role="bold">Emulated</emphasis> mode is 3236 suitable for legacy OS images. 3237 </para> 3238 </listitem> 3239 3240 </itemizedlist> 3104 3241 3105 3242 <para> 3106 3243 Click <emphasis role="bold">Export</emphasis> to export the 3107 VMs to the cloud service. 3108 </para> 3109 3110 <para> 3111 The VMs are uploaded to &oci;. 3112 </para> 3113 3114 <para> 3115 Instances are created for the uploaded VMs. 3116 </para> 3117 3118 <para> 3119 By default, the VM instance is started after upload to 3120 &oci;. 3244 VM to &oci;. 3245 </para> 3246 3247 <para> 3248 Depending on the selection in the 3249 <emphasis role="bold">Machine Creation</emphasis> field, the 3250 <emphasis role="bold">Cloud Virtual Machine 3251 Settings</emphasis> screen may be displayed before or after 3252 export. This screen enables you to configure settings for 3253 the cloud instance, such as Shape and Disk Size. 3254 </para> 3255 3256 <para> 3257 Click <emphasis role="bold">Create</emphasis>. The VM is 3258 exported to &oci;. 3259 </para> 3260 3261 <para> 3262 Depending on the <emphasis role="bold">Machine 3263 Creation</emphasis> setting, a cloud instance may be started 3264 after upload to &oci; is completed. 3121 3265 </para> 3122 3266 </listitem> … … 3140 3284 <sect2 id="cloud-import-oci"> 3141 3285 3142 <title>Importing an instance from &oci;</title> 3143 3144 <para> 3145 &product-name; supports the import of cloud instance from an &oci; service. 3146 </para> 3147 3148 <para> 3149 Before you can import an instance from &oci;, ensure that you perform the 3150 following configuration steps: 3151 </para> 3152 3153 <itemizedlist> 3154 3155 <listitem> 3156 <para> 3157 Generate an API signing key pair that is used for API 3158 requests to &oci;. 3159 </para> 3160 3161 <itemizedlist> 3162 3163 <listitem> 3164 <para> 3165 The key pair is usually installed in the 3166 <computeroutput>.oci</computeroutput> folder in your 3167 home directory. For example, 3168 <computeroutput>~/.oci</computeroutput> on a Linux 3169 system. 3170 </para> 3171 </listitem> 3172 3173 <listitem> 3174 <para> 3175 Upload the public key of the key pair to the cloud 3176 service. 3177 </para> 3178 </listitem> 3179 3180 </itemizedlist> 3181 3182 <para> 3183 For step-by-step instructions for creating and uploading an 3184 API signing key for &oci;, see: 3185 </para> 3186 3187 <para> 3188 <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> 3189 </para> 3190 </listitem> 3191 3192 <listitem> 3193 <para> 3194 Create a profile for your cloud account. 3195 </para> 3196 3197 <para> 3198 The cloud profile contains resource identifiers for your 3199 cloud account, such as your user OCID, and the fingerprint 3200 for your public key. You can create a cloud profile in the 3201 following ways: 3202 </para> 3203 3204 <itemizedlist> 3205 3206 <listitem> 3207 <para> 3208 Automatically by using the <emphasis role="bold">Cloud 3209 Profile Manager</emphasis>. See 3210 <xref linkend="ovf-cloud-profile-manager"/>. 3211 </para> 3212 </listitem> 3213 3214 <listitem> 3215 <para> 3216 Manually by creating an 3217 <computeroutput>oci_config</computeroutput> file in your 3218 &product-name; global configuration directory. For 3219 example, this is 3220 <computeroutput>$HOME/.config/VirtualBox/oci_config</computeroutput> 3221 on a Linux host. 3222 </para> 3223 </listitem> 3224 3225 <listitem> 3226 <para> 3227 Manually by creating a 3228 <computeroutput>config</computeroutput> file in your 3229 &oci; configuration directory. For example, this is 3230 <computeroutput>$HOME/.oci/config</computeroutput> on a 3231 Linux host. 3232 </para> 3233 3234 <para> 3235 This is the same file that is used by the &oci; command 3236 line interface. 3237 </para> 3238 3239 <para> 3240 &product-name; automatically uses the 3241 <computeroutput>config</computeroutput> file if no cloud 3242 profile file is present in your global configuration 3243 directory. Alternatively, you can import this file 3244 manually into the Cloud Profile Manager. 3245 </para> 3246 </listitem> 3247 3248 </itemizedlist> 3249 3250 <para> 3251 For more information about the cloud profile settings used 3252 by &oci; see: 3253 </para> 3254 3255 <para> 3256 <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> 3257 </para> 3258 </listitem> 3259 3260 </itemizedlist> 3286 <title>Importing an Instance from &oci;</title> 3287 3288 <para> 3289 &product-name; supports the import of cloud instances from an 3290 &oci; service. 3291 </para> 3292 3293 <para> 3294 Before you can import an instance from &oci; ensure that you 3295 have done the required preconfiguration tasks, as described in 3296 <xref linkend="cloud-integration-steps"/>. 3297 </para> 3261 3298 3262 3299 <para> … … 3270 3307 Select <emphasis role="bold">File</emphasis>, 3271 3308 <emphasis role="bold">Import Appliance</emphasis> to open 3272 the <emphasis role="bold">Import Virtual Appliance</emphasis> wizard. 3309 the <emphasis role="bold">Import Virtual 3310 Appliance</emphasis> wizard. 3311 </para> 3312 3313 <para> 3314 In the <emphasis role="bold">Source</emphasis> drop-down 3315 list, select <emphasis role="bold">&oci;</emphasis>. 3273 3316 </para> 3274 3317 … … 3289 3332 3290 3333 <para> 3291 Choose the interesting cloud instance from the list <emphasis role="bold">Machines</emphasis>. 3292 </para> 3293 3294 <para> 3295 Click <emphasis role="bold">Next</emphasis> 3296 to make an API request to the &oci; service and open the <emphasis role="bold">Appliance Settings</emphasis> screen. 3297 </para> 3298 </listitem> 3299 3300 <listitem> 3301 <para> 3302 Optionally edit settings used for new local virtual machine. 3303 </para> 3304 3305 <para> 3306 For example, you can edit the VM name, CPUs, RAM memory, OS type, OS version. 3307 </para> 3308 3309 <para> 3310 Click <emphasis role="bold">Import</emphasis> to import the instance from the cloud service. 3334 Choose the required cloud instance from the list in the 3335 <emphasis role="bold">Machines</emphasis> field. 3336 </para> 3337 3338 <para> 3339 Click <emphasis role="bold">Next</emphasis> to make an API 3340 request to the &oci; service and open the 3341 <emphasis role="bold">Appliance Settings</emphasis> screen. 3342 </para> 3343 </listitem> 3344 3345 <listitem> 3346 <para> 3347 Optionally edit settings for the new local virtual machine. 3348 </para> 3349 3350 <para> 3351 For example, you can edit the VM name and description. 3352 </para> 3353 3354 <figure id="fig-import-instance-oci"> 3355 <title>Import Cloud Instance Screen, Showing Profile Settings and VM Settings</title> 3356 <mediaobject> 3357 <imageobject> 3358 <imagedata align="center" fileref="images/import-instance.png" 3359 width="12cm" /> 3360 </imageobject> 3361 </mediaobject> 3362 </figure> 3363 3364 <para> 3365 Click <emphasis role="bold">Import</emphasis> to import the 3366 instance from the cloud service. 3311 3367 </para> 3312 3368 </listitem> … … 3319 3375 3320 3376 </orderedlist> 3321 3322 <para>3323 General OCI import logic:3324 </para>3325 <orderedlist>3326 <listitem>3327 <para>3328 A custom image created from the boot volume of the instance.3329 </para>3330 </listitem>3331 <listitem>3332 <para>3333 The custom image exported into OCI object and stored in the OCI Object Storage in the bucket pointed by user.3334 </para>3335 </listitem>3336 <listitem>3337 <para>3338 The OCI object is downloaded to the local host. OCI object is a TAR archive which contains a boot volume of instance3339 in QCOW2 format and JSON file with some meta-data related to the instance.3340 </para>3341 </listitem>3342 <listitem>3343 <para>3344 The boot volume of instance is extracted from the archive and new VMDK image is created by conversion the boot volume3345 into the VMDK format. The VMDK image is registered in the VirtualBox.3346 </para>3347 </listitem>3348 <listitem>3349 <para>3350 New VM is created with the VMDK image created on the previous step.3351 </para>3352 </listitem>3353 <listitem>3354 <para>3355 The downloaded OCI object (TAR archive) is deleted after successful import.3356 </para>3357 </listitem>3358 </orderedlist>3359 <para>3360 By default, the VM isn't launched after import from &oci;.3361 </para>3362 3377 3363 3378 <para> … … 3366 3381 <xref linkend="vboxmanage-import-cloud"/>. 3367 3382 </para> 3383 3384 <simplesect id="import-instance-sequence"> 3385 3386 <title>Importing an Instance: Overview of Events</title> 3387 3388 <para> 3389 The following describes the sequence of events when you import 3390 an instance from &oci;. 3391 </para> 3392 3393 <itemizedlist> 3394 3395 <listitem> 3396 <para> 3397 A custom image is created from the boot volume of the 3398 instance. 3399 </para> 3400 </listitem> 3401 3402 <listitem> 3403 <para> 3404 The custom image is exported to an &oci; object and is 3405 stored using Object Storage in the bucket specified by the 3406 user. 3407 </para> 3408 </listitem> 3409 3410 <listitem> 3411 <para> 3412 The &oci; object is downloaded to the local host. The 3413 object is a TAR archive which contains a boot volume of 3414 the instance in QCOW2 format and a JSON file containing 3415 metadata related to the instance. 3416 </para> 3417 </listitem> 3418 3419 <listitem> 3420 <para> 3421 The boot volume of the instance is extracted from the 3422 archive and a new VMDK image is created by converting the 3423 boot volume into the VMDK format. The VMDK image is 3424 registered with &product-name;. 3425 </para> 3426 </listitem> 3427 3428 <listitem> 3429 <para> 3430 A new VM is created using the VMDK image for the cloud 3431 instance. 3432 </para> 3433 3434 <para> 3435 By default, the new VM is not started after import from 3436 &oci;. 3437 </para> 3438 </listitem> 3439 3440 <listitem> 3441 <para> 3442 The downloaded TAR archive is deleted after a successful 3443 import. 3444 </para> 3445 </listitem> 3446 3447 </itemizedlist> 3448 3449 </simplesect> 3368 3450 3369 3451 </sect2> … … 3397 3479 3398 3480 <para> 3399 Use the Cloud Profile Manager to create a new cloud profile3400 automatically. Or, create a cloud profile by importing settings3401 from your &oci; configuration file into the Cloud Profile3402 Manager.3403 </para> 3404 3405 <para>3406 Perform the following steps to create a new cloud profile:3481 You can use the Cloud Profile Manager to create a new cloud 3482 profile automatically or to create a cloud profile by importing 3483 settings from your &oci; configuration file. 3484 </para> 3485 3486 <para> 3487 Perform the following steps to create a new cloud profile 3488 automatically: 3407 3489 </para> 3408 3490 … … 3484 3566 <para> 3485 3567 The cloud profile settings are saved in the 3486 < computeroutput>oci_config</computeroutput> file in your3487 &product-name;global settings directory.3568 <filename>oci_config</filename> file in your &product-name; 3569 global settings directory. 3488 3570 </para> 3489 3571 </listitem> … … 3500 3582 <listitem> 3501 3583 <para> 3502 Ensure that a <computeroutput>config</computeroutput> file 3503 is present in your &oci; configuration directory. For 3504 example, this is 3505 <computeroutput>$HOME/.oci/config</computeroutput> on a 3506 Linux host. 3584 Ensure that a <filename>config</filename> file is present in 3585 your &oci; configuration directory. For example, this is 3586 <filename>$HOME/.oci/config</filename> on a Linux host. 3507 3587 </para> 3508 3588 </listitem> … … 3530 3610 <para> 3531 3611 Your cloud profile settings are saved to the 3532 < computeroutput>oci_config</computeroutput> file in your3533 &product-name;global settings directory.3612 <filename>oci_config</filename> file in your &product-name; 3613 global settings directory. 3534 3614 </para> 3535 3615 </listitem> … … 3554 3634 3555 3635 </orderedlist> 3636 3637 </sect2> 3638 3639 <sect2 id="cloud-new-vm"> 3640 3641 <title>Creating New Cloud Instances from a Custom Image</title> 3642 3643 <para> 3644 You can use &product-name; to create new instances from a custom 3645 image on your cloud service. 3646 </para> 3647 3648 <para> 3649 <xref linkend="cloud-export-oci"/> describes how to create a 3650 custom image when you are exporting a VM to &oci;. Using a 3651 custom image means that you can quickly create cloud instances 3652 without having to upload your image to the cloud service every 3653 time. 3654 </para> 3655 3656 <para> 3657 Before you can create a new cloud instance in &oci; ensure that 3658 you have done the required preconfiguration tasks, as described 3659 in <xref linkend="cloud-integration-steps"/>. 3660 </para> 3661 3662 <para> 3663 Perform the following steps to create a new cloud instance on 3664 &oci;: 3665 </para> 3666 3667 <orderedlist> 3668 3669 <listitem> 3670 <para> 3671 Select <emphasis role="bold">File</emphasis>, 3672 <emphasis role="bold">New Cloud VM</emphasis> to open the 3673 <emphasis role="bold">Create Cloud Virtual 3674 Machine</emphasis> wizard. 3675 </para> 3676 </listitem> 3677 3678 <listitem> 3679 <para> 3680 From the <emphasis role="bold">Destination</emphasis> 3681 drop-down list, select 3682 <emphasis role="bold">&oci;</emphasis>. 3683 </para> 3684 3685 <para> 3686 In the <emphasis role="bold">Account</emphasis> drop-down 3687 list, select your &oci; account. 3688 </para> 3689 3690 <para> 3691 You can set up &oci; accounts by using the Cloud Profile 3692 Manager. 3693 </para> 3694 3695 <para> 3696 The list after the <emphasis role="bold">Account</emphasis> 3697 field shows the profile settings for your cloud account. 3698 </para> 3699 3700 <para> 3701 In the <emphasis role="bold">Images</emphasis> list, select 3702 from the custom images available on &oci;. 3703 </para> 3704 3705 <figure id="fig-newcloudvm"> 3706 <title>New Cloud VM Wizard, Showing List of Custom Images</title> 3707 <mediaobject> 3708 <imageobject> 3709 <imagedata align="center" fileref="images/newcloudvm.png" 3710 width="12cm" /> 3711 </imageobject> 3712 </mediaobject> 3713 </figure> 3714 3715 <para> 3716 Click <emphasis role="bold">Next</emphasis> to make an API 3717 request to the &oci; service and open the 3718 <emphasis role="bold">Cloud Virtual Machine 3719 Settings</emphasis> screen. 3720 </para> 3721 </listitem> 3722 3723 <listitem> 3724 <para> 3725 Optionally edit settings used for the instance on &oci;. 3726 </para> 3727 3728 <para> 3729 For example, you can edit the Disk Size and Shape used for 3730 the VM instance and the networking configuration. 3731 </para> 3732 3733 <para> 3734 Click <emphasis role="bold">Create</emphasis> to create the 3735 new cloud instance. 3736 </para> 3737 </listitem> 3738 3739 <listitem> 3740 <para> 3741 Monitor the instance creation process by using the &oci; 3742 Console. 3743 </para> 3744 </listitem> 3745 3746 </orderedlist> 3747 3748 <para> 3749 You can also use the <command>VBoxManage cloud 3750 instance</command> command to create and manage instances on a 3751 cloud service. See <xref linkend="vboxmanage-cloudinstance"/>. 3752 </para> 3556 3753 3557 3754 </sect2> … … 3582 3779 <para> 3583 3780 <emphasis role="bold">General.</emphasis> Enables the user to 3584 specify the default folder /directory for VM files, and the3781 specify the default folder or directory for VM files, and the 3585 3782 VRDP Authentication Library. 3586 3783 </para> … … 3590 3787 <para> 3591 3788 <emphasis role="bold">Input.</emphasis> Enables the user to 3592 specify the Host key. It identifies the key that toggles3593 whether the cursor is in the focus of the VM or the Host OS3594 windows, see <xref linkend="keyb_mouse_normal"/>, and which is3595 also usedto trigger certain VM actions, see3789 specify the Host key. This is the key that toggles whether the 3790 cursor is in the focus of the VM or the Host OS windows, see 3791 <xref linkend="keyb_mouse_normal"/>. The Host key is also used 3792 to trigger certain VM actions, see 3596 3793 <xref linkend="specialcharacters"/>. 3597 3794 </para> … … 3715 3912 </sect1> 3716 3913 3914 <sect1 id="soft-keyb"> 3915 3916 <title>Soft Keyboard</title> 3917 3918 <para> 3919 &product-name; provides a <emphasis>soft keyboard</emphasis> that 3920 enables you to input keyboard characters on the guest. A soft 3921 keyboard is an on-screen keyboard that can be used as an 3922 alternative to a physical keyboard. See 3923 <xref linkend="soft-keyb-using"/> for details of how to use the 3924 soft keyboard. 3925 </para> 3926 3927 <caution> 3928 <para> 3929 For best results, ensure that the keyboard layout configured on 3930 the guest OS matches the keyboard layout used by the soft 3931 keyboard. &product-name; does not do this automatically. 3932 </para> 3933 </caution> 3934 3935 <figure id="fig-soft-keyb"> 3936 <title>Soft Keyboard in a Guest Virtual Machine</title> 3937 <mediaobject> 3938 <imageobject> 3939 <imagedata align="center" fileref="images/softkeybd.png" 3940 width="14cm" /> 3941 </imageobject> 3942 </mediaobject> 3943 </figure> 3944 3945 <para> 3946 The soft keyboard can be used in the following scenarios: 3947 </para> 3948 3949 <itemizedlist> 3950 3951 <listitem> 3952 <para> 3953 When the physical keyboard on the host is not the same as the 3954 keyboard layout configured on the guest. For example, if the 3955 guest is configured to use an international keyboard, but the 3956 host keyboard is US English. 3957 </para> 3958 </listitem> 3959 3960 <listitem> 3961 <para> 3962 To send special key combinations to the guest. Note that some 3963 common key combinations are also available in the 3964 <emphasis role="bold">Input</emphasis>, 3965 <emphasis role="bold">Keyboard</emphasis> menu of the guest VM 3966 window. See <xref linkend="specialcharacters"/>. 3967 </para> 3968 </listitem> 3969 3970 <listitem> 3971 <para> 3972 For guests in kiosk mode, where a physical keyboard is not 3973 present. 3974 </para> 3975 </listitem> 3976 3977 <listitem> 3978 <para> 3979 When using nested virtualization, the soft keyboard provides a 3980 method of sending key presses to a guest. 3981 </para> 3982 </listitem> 3983 3984 </itemizedlist> 3985 3986 <para> 3987 By default, the soft keyboard includes some common international 3988 keyboard layouts. You can copy and modify these to meet your own 3989 requirements. See <xref linkend="soft-keyb-custom"/>. 3990 </para> 3991 3992 <sect2 id="soft-keyb-using"> 3993 3994 <title>Using the Soft Keyboard</title> 3995 3996 <orderedlist> 3997 3998 <listitem> 3999 <para> 4000 Display the soft keyboard. 4001 </para> 4002 4003 <para> 4004 In the guest VM window, select 4005 <emphasis role="bold">Input</emphasis>, 4006 <emphasis role="bold">Keyboard</emphasis>, 4007 <emphasis role="bold">Soft Keyboard</emphasis>. 4008 </para> 4009 </listitem> 4010 4011 <listitem> 4012 <para> 4013 Select the required keyboard layout. 4014 </para> 4015 4016 <para> 4017 The name of the current keyboard layout is displayed in the 4018 task bar of the soft keyboard window. This is the previous 4019 keyboard layout that was used. 4020 </para> 4021 4022 <para> 4023 Click the <emphasis role="bold">Layout List</emphasis> icon 4024 in the task bar of the soft keyboard window. The 4025 <emphasis role="bold">Layout List</emphasis> window is 4026 displayed. 4027 </para> 4028 4029 <para> 4030 Select the required keyboard layout from the entries in the 4031 <emphasis role="bold">Layout List</emphasis> window. 4032 </para> 4033 4034 <para> 4035 The keyboard display graphic is updated to show the 4036 available input keys. 4037 </para> 4038 </listitem> 4039 4040 <listitem> 4041 <para> 4042 Use the soft keyboard to enter keyboard characters on the 4043 guest. 4044 </para> 4045 4046 <itemizedlist> 4047 4048 <listitem> 4049 <para> 4050 Modifier keys such as Shift, Ctrl, and Alt are available 4051 on the soft keyboard. Click once to select the modifier 4052 key, click twice to lock the modifier key. 4053 </para> 4054 4055 <para> 4056 The <emphasis role="bold">Reset the Keyboard and Release 4057 All Keys</emphasis> icon can be used to release all 4058 pressed modifier keys, both on the host and the guest. 4059 </para> 4060 </listitem> 4061 4062 <listitem> 4063 <para> 4064 To change the look of the soft keyboard, click the 4065 <emphasis role="bold">Settings</emphasis> icon in the 4066 task bar. You can change colors used in the keyboard 4067 graphic, and can hide or show sections of the keyboard, 4068 such as the NumPad or multimedia keys. 4069 </para> 4070 </listitem> 4071 4072 </itemizedlist> 4073 </listitem> 4074 4075 </orderedlist> 4076 4077 </sect2> 4078 4079 <sect2 id="soft-keyb-custom"> 4080 4081 <title>Creating a Custom Keyboard Layout</title> 4082 4083 <para> 4084 You can use one of the supplied default keyboard layouts as the 4085 starting point to create a custom keyboard layout. 4086 </para> 4087 4088 <note> 4089 <para> 4090 To permananently save a custom keyboard layout, you must save 4091 it to file. Otherwise, any changes you make are discarded when 4092 you close down the <emphasis role="bold">Soft 4093 Keyboard</emphasis> window. 4094 </para> 4095 4096 <para> 4097 Custom keyboard layouts that you save are stored as an XML 4098 file on the host, in the <filename>keyboardLayouts</filename> 4099 folder in the global configuration data directory. For 4100 example, in 4101 <filename>$HOME/.config/VirtualBox/keyboardLayouts</filename> 4102 on a Linux host. 4103 </para> 4104 </note> 4105 4106 <orderedlist> 4107 4108 <listitem> 4109 <para> 4110 Display the <emphasis role="bold">Layout List</emphasis>. 4111 </para> 4112 4113 <para> 4114 Click the <emphasis role="bold">Layout List</emphasis> icon 4115 in the task bar of the soft keyboard window. 4116 </para> 4117 </listitem> 4118 4119 <listitem> 4120 <para> 4121 Make a copy of an existing keyboard layout. 4122 </para> 4123 4124 <para> 4125 Highlight the required layout and click the 4126 <emphasis role="bold">Copy the Selected Layout</emphasis> 4127 icon. 4128 </para> 4129 4130 <para> 4131 A new layout entry with a name suffix of 4132 <literal>-Copy</literal> is created. 4133 </para> 4134 </listitem> 4135 4136 <listitem> 4137 <para> 4138 Edit the new keyboard layout. 4139 </para> 4140 4141 <para> 4142 Highlight the new layout in the <emphasis role="bold">Layout 4143 List</emphasis> and click the <emphasis role="bold">Edit the 4144 Selected Layout</emphasis> icon. 4145 </para> 4146 4147 <para> 4148 Enter a new name for the layout. 4149 </para> 4150 4151 <para> 4152 Edit keys in the new layout. Click on the key that you want 4153 to edit and enter new key captions in the 4154 <emphasis role="bold">Captions</emphasis> fields. 4155 </para> 4156 4157 <para> 4158 The keyboard graphic is updated with the new captions. 4159 </para> 4160 </listitem> 4161 4162 <listitem> 4163 <para> 4164 (Optional) Save the layout to file. This means that your 4165 custom keyboard layout will be available for future use. 4166 </para> 4167 4168 <para> 4169 Highlight the new layout in the <emphasis role="bold">Layout 4170 List</emphasis> and click the <emphasis role="bold">Save the 4171 Selected Layout into File</emphasis> icon. 4172 </para> 4173 4174 <para> 4175 Any custom layouts that you create can later be removed from 4176 the Layout List, by highlighting and clicking the 4177 <emphasis role="bold">Delete the Selected Layout</emphasis> 4178 icon. 4179 </para> 4180 </listitem> 4181 4182 </orderedlist> 4183 4184 </sect2> 4185 4186 </sect1> 4187 3717 4188 </chapter> -
trunk/doc/manual/en_US/user_KnownIssues.xml
r76078 r82350 37 37 </listitem> 38 38 39 40 <para> 41 PCI pass -through (Linux hosts only)42 </para> 43 </listitem> 39 <!-- <listitem> 40 <para> 41 PCI passthrough (Linux hosts only) 42 </para> 43 </listitem>--> 44 44 45 45 <listitem> … … 63 63 <listitem> 64 64 <para> 65 Host CD/DVD drive pass -through65 Host CD/DVD drive passthrough 66 66 </para> 67 67 </listitem> … … 108 108 32-bit guests on AMD CPUs. This affects mainly Windows and 109 109 Oracle Solaris guests, but possibly also some Linux kernel 110 revisions. Partially solved in 3.0.6 for 32-bit Windows111 NT, 2000, XP, and 2003 guests. Requires Guest Additions112 3.0.6 or later to beinstalled.110 revisions. Partially solved for 32-bit Windows NT, 2000, 111 XP, and 2003 guests. Requires the Guest Additions to be 112 installed. 113 113 </para> 114 114 </listitem> … … 121 121 affects mainly Windows and Oracle Solaris guests, but 122 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. 123 solved for 32-bit Windows NT, 2000, XP, and 2003 guests. 124 Requires the Guest Additions to be installed. 126 125 </para> 127 126 </listitem> … … 134 133 <emphasis role="bold">NX (no execute, data execution 135 134 prevention)</emphasis> only works for guests running on 64-bit 136 hosts or guests running on 32-bit hosts with PAE enabled and 137 requires that hardware virtualization be enabled. 138 </para> 139 </listitem> 140 141 <listitem> 142 <para> 143 For <emphasis role="bold">basic Direct3D support in Windows 144 guests</emphasis> to work, the Guest Additions must be 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> 135 hosts and requires that hardware virtualization be enabled. 136 </para> 160 137 </listitem> 161 138 … … 173 150 guest's group policy must be changed. To do so, open the group 174 151 policy editor on the command line by typing 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. 152 <command>gpedit.msc</command>, open the key <literal>Computer 153 Configuration\Windows Settings\Security Settings\Local 154 Policies\Security Options</literal> and change the value of 155 <literal>Accounts: Limit local account use of blank passwords 156 to console logon only</literal> to Disabled. 181 157 </para> 182 158 </listitem> … … 186 162 <emphasis role="bold">Compacting virtual disk images is 187 163 limited to VDI files.</emphasis> The <command>VBoxManage 188 modify hd--compact</command> command is currently only164 modifymedium --compact</command> command is currently only 189 165 implemented for VDI files. At the moment the only way to 190 166 optimize the size of a virtual disk images in other formats, … … 236 212 <para> 237 213 Neither <emphasis role="bold">scale mode</emphasis> nor 238 <emphasis 239 role="bold">seamless mode</emphasis> work 240 correctly with guests using OpenGL 3D features, such as with 241 compiz-enabled window managers. 214 <emphasis role="bold">seamless mode</emphasis> work correctly 215 with guests using OpenGL 3D features, such as with 216 Compiz-enabled window managers. 242 217 </para> 243 218 </listitem> … … 246 221 <para> 247 222 The RDP server in the &product-name; extension pack supports 248 only audio streams in format 22.05kHz stereo 16 223 only audio streams in format 22.05kHz stereo 16-bit. If the 249 224 RDP client requests any other audio format there will be no 250 225 audio. … … 331 306 Depending on your system and version of Mac OS X, you 332 307 might experience guest hangs after some time. This can be 333 fixed by turning off energy saving. Set t imeout to "Never"334 in the system preferences.308 fixed by turning off energy saving. Set the timeout to 309 "Never" in the system preferences. 335 310 </para> 336 311 </listitem> … … 346 321 </para> 347 322 348 <screen> VBoxManage setextradata "VM name""VBoxInternal2/EfiBootArgs" " "</screen>323 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxInternal2/EfiBootArgs" " "</screen> 349 324 350 325 <para> … … 353 328 </para> 354 329 355 <screen> VBoxManage setextradata "VM name""VBoxInternal2/EfiBootArgs" ""</screen>330 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxInternal2/EfiBootArgs" ""</screen> 356 331 </listitem> 357 332 … … 359 334 <para> 360 335 It is currently not possible to start a Mac OS X guest in 361 safe mode by specifying "-x"option in362 "VBoxInternal2/EfiBootArgs"extradata.336 safe mode by specifying the <option>-x</option> option in 337 <literal>VBoxInternal2/EfiBootArgs</literal> extradata. 363 338 </para> 364 339 </listitem> … … 373 348 374 349 <itemizedlist> 375 376 <listitem>377 <para>378 There is no support for USB devices connected to Oracle379 Solaris 10 hosts.380 </para>381 </listitem>382 350 383 351 <listitem> … … 416 384 Crossbow-based bridged networking on Oracle Solaris 11 417 385 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. 386 However, you can use <command>dladm</command> to manually 387 create a VNIC over the aggregate link and use that with a 388 VM. This limitation does not exist in Oracle Solaris 11u1 389 build 17 and later. 423 390 </para> 424 391 </listitem> … … 429 396 <listitem> 430 397 <para> 431 <emphasis role="bold">Guest Additions of version 4.1, 4.1.2 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. 436 </para> 437 438 <note> 439 <para> 440 This does <emphasis>not</emphasis> apply to a Guest 441 Additions update. Installing one version of Guest Additions 442 on top of another works correctly. 443 </para> 444 </note> 445 446 <para> 447 To solve this problem, uninstall the &product-name; WDDM Video 448 driver manually. Open Device Manager, and check whether the 449 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 452 <emphasis role="bold">Uninstall</emphasis>, check 453 <emphasis role="bold">Delete the Driver Software for this 454 Device</emphasis> and click 455 <emphasis role="bold">OK</emphasis>. Once uninstallation is 456 done, start Device Manager, go to the 457 <emphasis role="bold">Action</emphasis> menu and select 458 <emphasis role="bold">Scan for Hardware Change</emphasis>s to 459 ensure that the correct Windows default driver be picked up 460 for the Graphics adapter. 461 </para> 462 </listitem> 463 464 <listitem> 465 <para> 466 Neither <emphasis>virtio</emphasis> nor <emphasis>Intel 467 PRO/1000 </emphasis> drivers for <emphasis role="bold">Windows 468 XP guests</emphasis> support segmentation offloading. 469 Therefore Windows XP guests have slower transmission rates 470 comparing to other guest types. Refer to MS Knowledge base 471 article 842264 for additional information. 398 Neither virtio nor Intel PRO/1000 drivers for 399 <emphasis role="bold">Windows XP guests</emphasis> support 400 segmentation offloading. Therefore Windows XP guests have 401 slower transmission rates comparing to other guest types. 402 Refer to MS Knowledge base article 842264 for additional 403 information. 472 404 </para> 473 405 </listitem> -
trunk/doc/manual/en_US/user_Networking.xml
r76786 r82350 150 150 <para> 151 151 <ulink 152 url="http://www.linux-kvm.org/page/WindowsGuestDrivers" >http://www.linux-kvm.org/page/WindowsGuestDrivers</ulink>.152 url="http://www.linux-kvm.org/page/WindowsGuestDrivers" />. 153 153 </para> 154 154 </listitem> … … 189 189 present, but that there is no connection. This is as if no 190 190 Ethernet cable was plugged into the card. Using this mode, it 191 is possible to "pull" the virtual Ethernet cable and disrupt192 the connection, which can be useful to inform a guest193 operating system that no network connection is available and194 enforce a reconfiguration.191 is possible to <emphasis>pull</emphasis> the virtual Ethernet 192 cable and disrupt the connection, which can be useful to 193 inform a guest operating system that no network connection is 194 available and enforce a reconfiguration. 195 195 </para> 196 196 </listitem> … … 534 534 ports on the host which are not already in use by a service. For 535 535 example, to set up incoming NAT connections to an 536 <com puteroutput>ssh</computeroutput> server in the guest, use537 the followingcommand:536 <command>ssh</command> server in the guest, use the following 537 command: 538 538 </para> 539 539 … … 543 543 In the above example, all TCP traffic arriving on port 2222 on 544 544 any host interface will be forwarded to port 22 in the guest. 545 The protocol name < computeroutput>tcp</computeroutput> is a546 mandatory attribute defining which protocol should be used for547 forwarding, <computeroutput>udp</computeroutput> could also be548 used. The name <computeroutput>guestssh</computeroutput> is549 purely descriptive and will be auto-generated if omitted. The550 number after <option>--natpf</option> denotes the network card,551 as with other<command>VBoxManage</command> commands.545 The protocol name <literal>tcp</literal> is a mandatory 546 attribute defining which protocol should be used for forwarding, 547 <literal>udp</literal> could also be used. The name 548 <literal>guestssh</literal> is purely descriptive and will be 549 auto-generated if omitted. The number after 550 <option>--natpf</option> denotes the network card, as with other 551 <command>VBoxManage</command> commands. 552 552 </para> 553 553 … … 601 601 PXE booting is now supported in NAT mode. The NAT DHCP server 602 602 provides a boot file name of the form 603 < computeroutput>vmname.pxe</computeroutput> if the directory604 <computeroutput>TFTP</computeroutput> exists in the directory605 where the user's < computeroutput>VirtualBox.xml</computeroutput>606 file iskept. It is the responsibility of the user to provide607 < computeroutput>vmname.pxe</computeroutput>.603 <filename><replaceable>vmname</replaceable>.pxe</filename> if 604 the directory <literal>TFTP</literal> exists in the directory 605 where the user's <filename>VirtualBox.xml</filename> file is 606 kept. It is the responsibility of the user to provide 607 <filename><replaceable>vmname</replaceable>.pxe</filename>. 608 608 </para> 609 609 … … 625 625 <emphasis role="bold">ICMP protocol limitations.</emphasis> 626 626 Some frequently used network debugging tools, such as 627 <com puteroutput>ping</computeroutput> or tracerouting, rely628 on the ICMP protocol for sending and receiving messages.629 While ICMP support has been improved with &product-name;630 2.1, meaning <computeroutput>ping</computeroutput> should631 now work, some othertools may not work reliably.627 <command>ping</command> or <command>traceroute</command>, 628 rely on the ICMP protocol for sending and receiving 629 messages. &product-name; ICMP support has some limitations, 630 meaning <command>ping</command> should work but some other 631 tools may not work reliably. 632 632 </para> 633 633 </listitem> … … 643 643 WINS always works. As a workaround, you can use the numeric 644 644 IP of the desired server in the 645 <computeroutput>\\server\share</computeroutput> notation. 645 <filename>\\<replaceable>server</replaceable>\<replaceable>share</replaceable></filename> 646 notation. 646 647 </para> 647 648 </listitem> … … 663 664 Solaris, and Mac OS X, it is not possible to bind to ports 664 665 below 1024 from applications that are not run by 665 < computeroutput>root</computeroutput>. As a result, if you666 try to configure such a port forwarding, the VM will refuse667 tostart.666 <literal>root</literal>. As a result, if you try to 667 configure such a port forwarding, the VM will refuse to 668 start. 668 669 </para> 669 670 </listitem> … … 768 769 <para> 769 770 Port-forwarding is supported, using the 770 <computeroutput>--port-forward-4</computeroutput> switch for IPv4 771 and <computeroutput>--port-forward-6</computeroutput> for IPv6. 772 For example: 771 <option>--port-forward-4</option> switch for IPv4 and 772 <option>--port-forward-6</option> for IPv6. For example: 773 773 </para> 774 774 … … 1002 1002 <para> 1003 1003 If you do not specify a network name, the network card will be 1004 attached to the network 1005 <computeroutput>intnet</computeroutput> by default. 1004 attached to the network <literal>intnet</literal> by default. 1006 1005 </para> 1007 1006 </listitem> … … 1032 1031 1033 1032 <para> 1034 Host-only networking is another networking mode that was added 1035 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. 1033 Host-only networking can be thought of as a hybrid between the 1034 bridged and internal networking modes. As with bridged networking, 1035 the virtual machines can talk to each other and the host as if 1036 they were connected through a physical Ethernet switch. As with 1037 internal networking, a physical networking interface need not be 1038 present, and the virtual machines cannot talk to the world outside 1039 the host since they are not connected to a physical networking 1040 interface. 1043 1041 </para> 1044 1042 … … 1085 1083 <listitem> 1086 1084 <para> 1087 On the command line, enter <computeroutput>VBoxManage modifyvm 1088 "VM name" --nic<x> hostonly</computeroutput>. See 1085 On the command line, enter <command>VBoxManage modifyvm 1086 <replaceable>"vmname</replaceable> 1087 --nic<replaceable>x</replaceable> hostonly</command>. See 1089 1088 <xref 1090 1089 linkend="vboxmanage-modifyvm" />. … … 1096 1095 <para> 1097 1096 Before you can attach a VM to a host-only network you have to 1098 create at least one host-only interface. You can use the GUI for 1099 this. Choose <emphasis role="bold">File</emphasis>, 1097 create at least one host-only interface. You can use the 1098 VirtualBox Manager for this. Choose 1099 <emphasis role="bold">File</emphasis>, 1100 1100 <emphasis role="bold">Preferences</emphasis>, 1101 1101 <emphasis role="bold">Network</emphasis>, … … 1241 1241 On UNIX-based hosts, such as Linux, Oracle Solaris, and Mac OS 1242 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. 1243 applications that are not run by <literal>root</literal>. As a 1244 result, if you try to configure such a source UDP port, the VM 1245 will refuse to start. 1247 1246 </para> 1248 1247 </note> … … 1353 1352 documentation accompanying the software. See also 1354 1353 <ulink 1355 url="http://wiki.virtualsquare.org/wiki/index.php/VDE_Basic_Networking" >http://wiki.virtualsquare.org/wiki/index.php/VDE_Basic_Networking</ulink>.1354 url="http://wiki.virtualsquare.org/wiki/index.php/VDE_Basic_Networking" />. 1356 1355 </para> 1357 1356 … … 1520 1519 <listitem> 1521 1520 <para> 1522 < computeroutput>deny</computeroutput>, which hides any1523 traffic not intended for the VM's network adaptor. This is1524 the defaultsetting.1521 <literal>deny</literal>, which hides any traffic not 1522 intended for the VM's network adaptor. This is the default 1523 setting. 1525 1524 </para> 1526 1525 </listitem> … … 1528 1527 <listitem> 1529 1528 <para> 1530 < computeroutput>allow-vms</computeroutput>, which hides1531 all host traffic from the VM's network adaptor, but allows1532 it to seetraffic from and to other VMs.1529 <literal>allow-vms</literal>, which hides all host traffic 1530 from the VM's network adaptor, but allows it to see 1531 traffic from and to other VMs. 1533 1532 </para> 1534 1533 </listitem> … … 1536 1535 <listitem> 1537 1536 <para> 1538 <computeroutput>allow-all</computeroutput>, which removes 1539 all restrictions. The VM's network adaptor sees all 1540 traffic. 1537 <literal>allow-all</literal>, which removes all 1538 restrictions. The VM's network adaptor sees all traffic. 1541 1539 </para> 1542 1540 </listitem> -
trunk/doc/manual/en_US/user_Preface.xml
r78515 r82350 11 11 12 12 <para> 13 The < emphasis>&product-name; User Manual</emphasis> provides an13 The <citetitle>&product-name; User Manual</citetitle> provides an 14 14 introduction to using &product-name;. The manual provides 15 15 information on how to install &product-name; and use it to create … … 39 39 40 40 <para> 41 <ulink url="&o tn-doc-tab;" />41 <ulink url="&ohc-doc-page;" /> 42 42 </para> 43 43 … … 72 72 <listitem> 73 73 <para> 74 < computeroutput>monospace</computeroutput>: Monospace type75 indicates commands within a paragraph, URLs, code in examples,76 text thatappears on the screen, or text that you enter.74 <literal>monospace</literal>: Monospace type indicates 75 commands within a paragraph, URLs, code in examples, text that 76 appears on the screen, or text that you enter. 77 77 </para> 78 78 </listitem> … … 82 82 </simplesect> 83 83 84 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../common/oracle-accessibility-en.xml"/> 85 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../common/oracle-support-en.xml"/> 84 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" 85 href="../common/oracle-accessibility-en.xml" /> 86 87 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" 88 href="../common/oracle-support-en.xml" /> 86 89 87 90 </preface> -
trunk/doc/manual/en_US/user_PrivacyPolicy.xml
r77320 r82350 15 15 <para> 16 16 The Oracle Privacy Policies posted on 17 <ulink url="https://www.oracle.com/legal/privacy/privacy-policy.html" >https://www.oracle.com/legal/privacy/privacy-policy.html</ulink>17 <ulink url="https://www.oracle.com/legal/privacy/privacy-policy.html" /> 18 18 apply to your personal data collected and used by Oracle. The 19 19 following privacy information describes in more detail which … … 84 84 <emphasis role="bold">§ 6 Updates.</emphasis> Oracle may update the 85 85 privacy policy at any time by posting a new version at 86 <ulink url="https://www.oracle.com/legal/privacy/privacy-policy.html" >https://www.oracle.com/legal/privacy/privacy-policy.html</ulink>86 <ulink url="https://www.oracle.com/legal/privacy/privacy-policy.html" /> 87 87 and the privacy information will be kept up to date in the 88 88 documentation which comes with the &product-name; application. You -
trunk/doc/manual/en_US/user_Security.xml
r81183 r82350 97 97 The &product-name; base package should be downloaded only from a 98 98 trusted source, for instance the official website 99 <ulink url="http://www.virtualbox.org" >http://www.virtualbox.org</ulink>.99 <ulink url="http://www.virtualbox.org" />. 100 100 The integrity of the package should be verified with the 101 101 provided SHA256 checksum which can be found on the official … … 558 558 559 559 <para> 560 Mitigation options:560 The following mitigation options are available. 561 561 </para> 562 562 563 563 <sect3> 564 564 565 <title>Disable nested paging</title>565 <title>Disable Nested Paging</title> 566 566 567 567 <para> … … 578 578 guests may be able to cope with dropping these features after 579 579 installation. Also, for some guests, especially in SMP 580 configurations, there could be stability issues ar rising from580 configurations, there could be stability issues arising from 581 581 disabling nested paging. Finally, some workloads may 582 582 experience a performance degradation. … … 587 587 <sect3> 588 588 589 <title>Flushing the level 1 data cache</title>589 <title>Flushing the Level 1 Data Cache</title> 590 590 591 591 <para> … … 627 627 <para> 628 628 A more aggressive flushing option is provided via the 629 VBoxManage modifyvm option630 < computeroutput>--l1d-flush-on-vm-entry</computeroutput>. When629 <command>VBoxManage modifyvm</command> 630 <option>--l1d-flush-on-vm-entry</option> option. When 631 631 enabled the level 1 data cache will be flushed on every VM 632 632 entry. The performance impact is greater than with the default … … 638 638 <para> 639 639 For users not concerned by this security issue, the default 640 mitigation can be disabled using 641 </para> 642 643 <para> 644 <computeroutput>VBoxManage modifyvm name --l1d-flush-on-sched 645 off</computeroutput> 640 mitigation can be disabled using the <command>VBoxManage modifyvm 641 name --l1d-flush-on-sched off</command> command. 646 642 </para> 647 643 … … 656 652 <para> 657 653 These security issues affect a range of Intel CPUs starting with 658 Nehalem. The CVE-2018-12130 also affects some Atom Silvermont, 659 Atom Airmont, and Knights family CPUs, however the scope is so limited 660 that the host OS should deal with it for us and VBox therefore not 661 be affected (leaks only happens when entering and leaving C states). 662 </para> 663 664 <para> 665 Mitigation option: 654 Nehalem. The CVE-2018-12130 also affects some Atom Silvermont, 655 Atom Airmont, and Knights family CPUs, however the scope is so 656 limited that the host OS should deal with it and &product-name; 657 is therefore not affected. Leaks only happens when entering and 658 leaving C states. 659 </para> 660 661 <para> 662 The following mitigation option is available. 666 663 </para> 667 664 668 665 <sect3> 669 666 670 <title>Buffer overwriting and disabling HT</title> 671 672 <para> 673 First, up to date CPU microcode is a prerequisite for the buffer 674 overwriting (clearing) mitigations. Some host OSes may install 675 these automatically, though it has traditionally been a task best 676 performed by the system firmware. So, please check with your 677 system / mainboard manufacturer for the latest firmware update. 678 </para> 679 680 <para> 681 This mitigation aims at removing potentially sensitive data from 682 the affected buffers before running guest code. Since this means 683 additional work each time the guest is scheduled, there might be 684 some performance side effects. 685 </para> 686 687 <para> 688 We recommend disabling hyper threading on host affected by 689 CVE-2018-12126 and CVE-2018-12127 because the affected sets of 690 buffers are normally shared between thread pairs and therefore 691 cause leaks between the threads. This is traditionally done from 692 the firmware setup, but some OSes also offers ways disable HT. In 693 some cases it may be disabled by default, but please verify as the 694 effectiveness of the mitigation depends on it. 695 </para> 696 697 <para> 698 The default action taken by VirtualBox is to clear the affected 699 buffers when a thread is scheduled to execute guest code, rather 700 than on each VM entry. This reduces the performance impact, while 701 making the assumption that the host OS will not handle security 702 sensitive data from interrupt handlers and similar without taking 703 precautions. 704 </para> 705 706 <para> 707 A more aggressive flushing option is provided via the 708 VBoxManage modifyvm option 709 <computeroutput>--mds-clear-on-vm-entry</computeroutput>. When 710 enabled the affected buffers will be cleared on every VM entry. 711 The performance impact is greater than with the default option, 712 though this of course depends on the workload. Workloads producing 713 a lot of VM exits (like networking, VGA access, and similiar) will 714 probably be most impacted. 667 <title>Buffer Overwriting and Disabling Hyper-Threading</title> 668 669 <para> 670 First, up to date CPU microcode is a prerequisite for the 671 buffer overwriting (clearing) mitigations. Some host OSes may 672 install these automatically, though it has traditionally been 673 a task best performed by the system firmware. Please check 674 with your system or mainboard manufacturer for the latest 675 firmware update. 676 </para> 677 678 <para> 679 This mitigation aims at removing potentially sensitive data 680 from the affected buffers before running guest code. Since 681 this means additional work each time the guest is scheduled, 682 there might be some performance side effects. 683 </para> 684 685 <para> 686 We recommend disabling hyper-threading (HT) on hosts affected 687 by CVE-2018-12126 and CVE-2018-12127, because the affected 688 sets of buffers are normally shared between thread pairs and 689 therefore cause leaks between the threads. This is 690 traditionally done from the firmware setup, but some OSes also 691 offers ways disable HT. In some cases it may be disabled by 692 default, but please verify as the effectiveness of the 693 mitigation depends on it. 694 </para> 695 696 <para> 697 The default action taken by &product-name; is to clear the 698 affected buffers when a thread is scheduled to execute guest 699 code, rather than on each VM entry. This reduces the 700 performance impact, while making the assumption that the host 701 OS will not handle security sensitive data from interrupt 702 handlers and similar without taking precautions. 703 </para> 704 705 <para> 706 The <command>VBoxManage modifyvm</command> command provides a more 707 aggressive flushing option is provided by means of the 708 <option>--mds-clear-on-vm-entry</option> option. When 709 enabled the affected buffers will be cleared on every VM 710 entry. The performance impact is greater than with the default 711 option, though this of course depends on the workload. 712 Workloads producing a lot of VM exits (like networking, VGA 713 access, and similiar) will probably be most impacted. 715 714 </para> 716 715 717 716 <para> 718 717 For users not concerned by this security issue, the default 719 mitigation can be disabled using 720 </para> 721 722 <para> 723 <computeroutput>VBoxManage modifyvm name --mds-clear-on-sched 724 off</computeroutput> 718 mitigation can be disabled using the <command>VBoxManage modifyvm 719 name --mds-clear-on-sched off</command> command. 725 720 </para> 726 721 -
trunk/doc/manual/en_US/user_Storage.xml
r82044 r82350 52 52 <sect1 id="harddiskcontrollers"> 53 53 54 <title>Hard Disk Controllers : IDE, SATA (AHCI), SCSI, SAS, USB MSD, NVMe</title>55 56 <para> 57 In a real PC, hard disks and CD/DVD drives are connected to a58 device called hard disk controller which drives hard disk59 operation and data transfers. &product-name; can emulate the five60 most common types of hard disk controllers typically found in61 today's PCs: IDE, SATA (AHCI), SCSI, SAS, USB-based, and NVMe mass54 <title>Hard Disk Controllers</title> 55 56 <para> 57 In a computing device, hard disks and CD/DVD drives are connected 58 to a device called hard disk controller which drives hard disk 59 operation and data transfers. &product-name; can emulate the most 60 common types of hard disk controllers typically found in computing 61 devices: IDE, SATA (AHCI), SCSI, SAS, USB-based, and NVMe mass 62 62 storage devices. 63 63 </para> … … 68 68 <para> 69 69 <emphasis role="bold">IDE (ATA)</emphasis> controllers are a 70 backwards 70 backwards-compatible yet very advanced extension of the disk 71 71 controller in the IBM PC/AT (1984). Initially, this interface 72 72 worked only with hard disks, but was later extended to also … … 116 116 <listitem> 117 117 <para> 118 <emphasis role="bold">Serial ATA (SATA)</emphasis> is a newer119 standard introduced in 2003. Compared to IDE, it supports both118 <emphasis role="bold">Serial ATA (SATA)</emphasis> is a more 119 recent standard than IDE. Compared to IDE, it supports both 120 120 much higher speeds and more devices per controller. Also, with 121 121 physical hardware, devices can be added and removed while the … … 147 147 seen by OSes that do not have device support for AHCI. In 148 148 particular, <emphasis>there is no support for AHCI in 149 Windows before Windows Vista</emphasis>. So Windows XP, even 150 SP3, will not see such disks unless you install additional 151 drivers. It is possible to switch from IDE to SATA after 152 installation by installing the SATA drivers and changing the 153 controller type in the VM 149 Windows versions before Windows Vista</emphasis>. Legacy 150 Windows versions such as Windows XP, even with SP3 151 installed, will not see such disks unless you install 152 additional drivers. It is possible to switch from IDE to 153 SATA after installation by installing the SATA drivers and 154 changing the controller type in the VM 154 155 <emphasis role="bold">Settings</emphasis> dialog. 155 156 </para> … … 158 159 &product-name; recommends the Intel Matrix Storage drivers, 159 160 which can be downloaded from 160 <ulink 161 url="http://downloadcenter.intel.com/Product_Filter.aspx?ProductID=2101">http://downloadcenter.intel.com/Product_Filter.aspx?ProductID=2101</ulink>. 161 <ulink url="http://downloadcenter.intel.com/Product_Filter.aspx?ProductID=2101" />. 162 162 </para> 163 163 </warning> … … 188 188 <emphasis role="bold">SCSI</emphasis> is another established 189 189 industry standard, standing for Small Computer System 190 Interface. SCSI was standardized as early as 1986 as a generic191 interface for data transfer between all kinds of devices,192 i ncluding storage devices. Today SCSI is still used for193 connecting hard disks and tape devices, but it has mostly been194 displaced in commodity hardware. It is still in common use in195 high-performance workstations andservers.190 Interface. SCSI is as a generic interface for data transfer 191 between all kinds of devices, including storage devices. SCSI 192 is still used for connecting some hard disks and tape devices, 193 but it has mostly been displaced in commodity hardware. It is 194 still in common use in high-performance workstations and 195 servers. 196 196 </para> 197 197 … … 199 199 Primarily for compatibility with other virtualization 200 200 software, &product-name; optionally supports LSI Logic and 201 BusLogic SCSI controllers, to each of which up to 15 virtual202 hard disks can be attached.201 BusLogic SCSI controllers, to each of which up to fifteen 202 virtual hard disks can be attached. 203 203 </para> 204 204 … … 229 229 <emphasis role="bold">Serial Attached SCSI (SAS)</emphasis> is 230 230 another bus standard which uses the SCSI command set. As 231 opposed to SCSI, however, with physical devices, serial cables 232 are used instead of parallel ones, which simplifies physical 233 device connections. In some ways, therefore, SAS is to SCSI 234 what SATA is to IDE: it enables more reliable and faster 235 connections. 231 opposed to SCSI physical devices, serial cables are used 232 instead of parallel cables. This simplifies physical device 233 connections. In some ways, therefore, SAS is to SCSI what SATA 234 is to IDE: it enables more reliable and faster connections. 236 235 </para> 237 236 … … 260 259 class</emphasis> is a standard to connect external storage 261 260 devices like hard disks or flash drives to a host through USB. 262 All major OSes support these devices for a long time and ship263 generic drivers making third-party drivers superfluous. In264 particular, legacy OSes without support for SATA controllers265 ma y benefit from USB mass storage devices.261 All major OSes support these devices and ship generic drivers 262 making third-party drivers superfluous. In particular, legacy 263 OSes without support for SATA controllers may benefit from USB 264 mass storage devices. 266 265 </para> 267 266 … … 287 286 <para> 288 287 <emphasis role="bold">Non volatile memory express 289 (NVMe)</emphasis> is a standard which emerged in 2011 for290 connecting non volatile memory (NVM) directly over PCI express291 to lift the bandwidth limitation of the previously used SATA292 protocol for SSDs. Unlike other standards the command set is293 very simple to achieve maximum throughput and is not288 (NVMe)</emphasis> is a standard for connecting non volatile 289 memory (NVM) directly over PCI Express to lift the bandwidth 290 limitation of the previously used SATA protocol for 291 solid-state devices. Unlike other standards the command set is 292 very simple in order to achieve maximum throughput and is not 294 293 compatible with ATA or SCSI. OSes need to support NVMe devices 295 294 to make use of them. For example, Windows 8.1 added native … … 391 390 to a physical disk however, &product-name; enables you to expand 392 391 an image file after creation, even if it has data already. See 393 <xref linkend="vboxmanage-modify vdi" />.392 <xref linkend="vboxmanage-modifymedium" />. 394 393 </para> 395 394 … … 503 502 <listitem> 504 503 <para> 505 Registered media, for compatibility with &product-name; 506 versions older than version 4.0. For details about how media 507 registration has changed with version 4.0, see 508 <xref linkend="vboxconfigdata" />. 504 Registered media, for compatibility with legacy &product-name; 505 versions. 509 506 </para> 510 507 </listitem> … … 572 569 <listitem> 573 570 <para> 574 <emphasis role="bold">Add</emphasis> an image to the registry. 575 </para> 576 </listitem> 577 578 <listitem> 579 <para> 580 <emphasis role="bold">Copy</emphasis> a virtual hard disk to 581 create another one. 582 </para> 583 584 <para> 585 You can specify one of the following target types: VDI, VHD, 586 or VMDK. 587 </para> 588 </listitem> 589 590 <listitem> 591 <para> 592 <emphasis role="bold">Move</emphasis> an image that is 593 currently in the registry to another location. 571 <emphasis role="bold">Add</emphasis> an image to the known 572 media. 573 </para> 574 </listitem> 575 576 <listitem> 577 <para> 578 <emphasis role="bold">Create</emphasis> a new disk image. 579 </para> 580 581 <itemizedlist> 582 583 <listitem> 584 <para> 585 For virtual hard disks, the <emphasis role="bold">Create 586 Virtual Hard Disk</emphasis> wizard is shown. 587 </para> 588 </listitem> 589 590 <listitem> 591 <para> 592 For optical disks, the <emphasis role="bold">VISO 593 Creator</emphasis> screen is shown. This enables you to 594 create a virtual ISO from selected files on the host. 595 </para> 596 </listitem> 597 598 <listitem> 599 <para> 600 For floppy disks, the <emphasis role="bold">Floppy Disk 601 Creator</emphasis> screen is shown. 602 </para> 603 </listitem> 604 605 </itemizedlist> 606 </listitem> 607 608 <listitem> 609 <para> 610 <emphasis role="bold">Copy</emphasis> an image to create 611 another one. 612 </para> 613 614 <para> 615 For virtual hard disks, you can specify one of the following 616 target types: VDI, VHD, or VMDK. 617 </para> 618 </listitem> 619 620 <listitem> 621 <para> 622 <emphasis role="bold">Move</emphasis> an image to another 623 location. 594 624 </para> 595 625 … … 625 655 <para> 626 656 <emphasis role="bold">Remove</emphasis> an image from the 627 registry. You can optionally delete the image file when657 known media. You can optionally delete the image file when 628 658 removing the image. 629 659 </para> … … 635 665 from a VM. This action only applies if the image is currently 636 666 attached to a VM as a virtual hard disk. 667 </para> 668 </listitem> 669 670 <listitem> 671 <para> 672 <emphasis role="bold">Search</emphasis> for an image by name 673 or UUID. 637 674 </para> 638 675 </listitem> … … 729 766 730 767 <para> 731 You can copy hard disk image files to other host systems and 732 import them in to VMs from the host system. However, certain guest733 OSes, such as Windows 2000 and Windows XP, require that you734 configure the new VM in a similarway to the old one.768 You can copy hard disk image files to other host systems and then 769 import them in to VMs from the host system. However, some Windows 770 guest OSes may require that you configure the new VM in a similar 771 way to the old one. 735 772 </para> 736 773 … … 765 802 By default, images are in <emphasis>normal</emphasis> mode. To 766 803 mark an existing image with one of the non-standard modes listed 767 below, use <command>VBoxManage modify hd</command>. See768 <xref linkend="vboxmanage-modify vdi" />. Alternatively, use769 <command>VBoxManage </command> to attach the image to a VM and use770 the <option>--mtype</option> argument. See804 below, use <command>VBoxManage modifymedium</command>. See 805 <xref linkend="vboxmanage-modifymedium" />. Alternatively, use 806 <command>VBoxManage storageattach</command> to attach the image to 807 a VM and specify the <option>--mtype</option> argument. See 771 808 <xref linkend="vboxmanage-storageattach" />. 772 809 </para> … … 794 831 <para> 795 832 The image file itself is not reset. Instead, when a snapshot 796 is taken, &product-name; "freezes" the image file and no 797 longer writes to it. For the write operations from the VM, a 798 second, <emphasis>differencing</emphasis> image file is 799 created which receives only the changes to the original image. 800 See <xref linkend="diffimages"/>. 833 is taken, &product-name; <emphasis>freezes</emphasis> the 834 image file and no longer writes to it. For the write 835 operations from the VM, a second, 836 <emphasis>differencing</emphasis> image file is created which 837 receives only the changes to the original image. See 838 <xref linkend="diffimages"/>. 801 839 </para> 802 840 … … 903 941 startup does not fit your needs, you can turn it off using the 904 942 <option>autoreset</option> parameter of <command>VBoxManage 905 modify hd</command>. See906 <xref linkend="vboxmanage-modify vdi"/>.943 modifymedium</command>. See 944 <xref linkend="vboxmanage-modifymedium"/>. 907 945 </para> 908 946 </listitem> … … 1062 1100 <emphasis role="bold">Snapshots.</emphasis> When you create a 1063 1101 snapshot, as explained in the previous section, &product-name; 1064 "freezes" the images attached to the virtual machine and1065 creates differencing images for each image that is not in1066 "write-through" mode. From the point of view of the virtual1067 machine, the virtual disks continue to operate before, but all1068 write operations go into the differencing images. Each time1069 you create another snapshot, for each hard disk attachment,1070 another differencing image is created and attached, forming a1071 chain or tree.1102 <emphasis>freezes</emphasis> the images attached to the 1103 virtual machine and creates differencing images for each image 1104 that is not in <emphasis>write-through</emphasis> mode. From 1105 the point of view of the virtual machine, the virtual disks 1106 continue to operate before, but all write operations go into 1107 the differencing images. Each time you create another 1108 snapshot, for each hard disk attachment, another differencing 1109 image is created and attached, forming a chain or tree. 1072 1110 </para> 1073 1111 … … 1164 1202 However, you should <emphasis>only</emphasis> make copies of 1165 1203 virtual disk images using the utility supplied with 1166 &product-name;. See <xref linkend="vboxmanage-clone vdi" />. This1167 is because &product-name; assigns a UUID to each disk image, which1168 is also stored inside the image, and &product-name; will refuse to1169 work with two images that use the same number. If you do1204 &product-name;. See <xref linkend="vboxmanage-clonemedium" />. 1205 This is because &product-name; assigns a UUID to each disk image, 1206 which is also stored inside the image, and &product-name; will 1207 refuse to work with two images that use the same number. If you do 1170 1208 accidentally try to reimport a disk image which you copied 1171 1209 normally, you can make a second copy using the <command>VBoxManage … … 1174 1212 1175 1213 <para> 1176 Note that newer Linux distributions identify the boot hard disk1177 from the ID of the drive. The ID &product-name; reports for a1178 d rive is determined from the UUID of the virtual disk image. So if1179 youclone a disk image and try to boot the copied image the guest1214 Note that Linux distributions identify the boot hard disk from the 1215 ID of the drive. The ID &product-name; reports for a drive is 1216 determined from the UUID of the virtual disk image. So if you 1217 clone a disk image and try to boot the copied image the guest 1180 1218 might not be able to determine its own boot disk as the UUID 1181 1219 changed. In this case you have to adapt the disk ID in your boot 1182 1220 loader script, for example 1183 < computeroutput>/boot/grub/menu.lst</computeroutput>. The disk ID1184 looks likethe following:1221 <filename>/boot/grub/menu.lst</filename>. The disk ID looks like 1222 the following: 1185 1223 </para> 1186 1224 … … 1300 1338 1301 1339 <para> 1302 For the above reasons, &product-name; nowuses SATA controllers by1340 For the above reasons, &product-name; uses SATA controllers by 1303 1341 default for new virtual machines. 1304 1342 </para> … … 1395 1433 Medium changes can be prevented by the guest, and &product-name; 1396 1434 reflects that by locking the host drive if appropriate. You can 1397 force a medium removal in such situations by using the 1398 &product-name; GUI or the <command>VBoxManage</command> command 1399 line tool. Effectively this is the equivalent of the emergency 1400 eject which many CD/DVD drives provide, with all associated side 1401 effects. The guest OS can issue error messages, just like on real 1402 hardware, and guest applications may misbehave. Use this with 1403 caution. 1435 force a medium removal in such situations by using the VirtualBox 1436 Manager or the <command>VBoxManage</command> command line tool. 1437 Effectively this is the equivalent of the emergency eject which 1438 many CD/DVD drives provide, with all associated side effects. The 1439 guest OS can issue error messages, just like on real hardware, and 1440 guest applications may misbehave. Use this with caution. 1404 1441 </para> 1405 1442 … … 1448 1485 1449 1486 <para> 1450 There is a <emphasis role="bold">Passthrough</emphasis> check box 1451 in the GUI dialog for configuring the media attached to a storage 1452 controller, or you can use the <option>--passthrough</option> 1453 option with <command>VBoxManage storageattach</command>. See 1487 To enable host drive passthrough you can use the 1488 <option>--passthrough</option> option of the <command>VBoxManage 1489 storageattach</command> command. See 1454 1490 <xref linkend="vboxmanage-storageattach" />. 1455 1491 </para> … … 1475 1511 1476 1512 <para> 1477 iSCSI stands for "Internet SCSI" and is a standard that supports1478 use of the SCSI protocol over Internet (TCP/IP) connections.1479 Especially with the advent of Gigabit Ethernet, it has become1480 affordable to attach iSCSI storage servers simply as remote hard1481 disks to a computer network. In iSCSI terminology, the server1482 providing storage resources is called an <emphasis>iSCSI1483 target</emphasis>, while the client connecting to the server and1484 accessing its resources is called an <emphasis>iSCSI1485 initiator</emphasis>.1513 iSCSI stands for <emphasis>Internet SCSI</emphasis> and is a 1514 standard that supports use of the SCSI protocol over Internet 1515 (TCP/IP) connections. Especially with the advent of Gigabit 1516 Ethernet, it has become affordable to attach iSCSI storage servers 1517 simply as remote hard disks to a computer network. In iSCSI 1518 terminology, the server providing storage resources is called an 1519 <emphasis>iSCSI target</emphasis>, while the client connecting to 1520 the server and accessing its resources is called an 1521 <emphasis>iSCSI initiator</emphasis>. 1486 1522 </para> 1487 1523 … … 1509 1545 <para> 1510 1546 <command>vboximg-mount</command> is a command line utility for Mac 1511 OS X hosts that provides raw access to an &product-name; virtual1512 disk image on the host system. Use this utility to mount, view,1513 and optionally modify the disk image contents.1547 OS and Linux hosts that provides raw access to an &product-name; 1548 virtual disk image on the host system. Use this utility to mount, 1549 view, and optionally modify the disk image contents. 1514 1550 </para> 1515 1551 … … 1560 1596 1561 1597 <para> 1598 The <command>vboximg-mount </command>command includes experimental 1599 read-only access to file systems inside a VM disk image. This 1600 feature enables you to extract some files from the disk image 1601 without starting the VM and without requiring third-party file 1602 system drivers on the host system. FAT, NTFS, ext2, ext3, and ext4 1603 file systems are supported. 1604 </para> 1605 1606 <para> 1562 1607 Use the <option>--help</option> option to view information about 1563 1608 the <command>vboximg-mount</command> command usage. The complete 1564 command reference is described in <xref linkend="man_vboximg-mount" />. 1609 command reference is described in 1610 <xref linkend="man_vboximg-mount" />. 1565 1611 </para> 1566 1612 … … 1703 1749 <para> 1704 1750 In this example, partition 2 is mounted on the 1705 < computeroutput>macos_sysdisk</computeroutput> mount point.1706 The mountincludes all snapshots for the disk image.1751 <filename>macos_sysdisk</filename> mount point. The mount 1752 includes all snapshots for the disk image. 1707 1753 </para> 1708 1754 </listitem> … … 1710 1756 <listitem> 1711 1757 <para> 1712 Use the host OS to mount the 1713 <computeroutput>vhdd</computeroutput> device node. The1714 FUSE-mounted device node represents the virtualdisk image.1758 Use the host OS to mount the <literal>vhdd</literal> device 1759 node. The FUSE-mounted device node represents the virtual 1760 disk image. 1715 1761 </para> 1716 1762 -
trunk/doc/manual/en_US/user_Technical.xml
r81523 r82350 24 24 In &product-name;, a virtual machine and its settings are 25 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 26 addition, most virtual machines have one or more virtual hard 27 disks. These are typically represented by disk images, such as 28 those in VDI format. The location of these files may vary, 29 depending on the host operating system. See 30 <xref linkend="vboxconfigdata-machine-folder"/>. 31 </para> 32 33 <para> 34 Global configuration data for &product-name; is maintained in 35 another location on the host. See 36 <xref linkend="vboxconfigdata-global"/>. 37 </para> 38 39 <sect2 id="vboxconfigdata-machine-folder"> 40 41 <title>The Machine Folder</title> 42 43 <para> 44 By default, each virtual machine has a directory on your host 38 45 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 placed45 in a common folder called <computeroutput>VirtualBox46 VMs</computeroutput>, which &product-name; creates in the47 c urrent system user's home directory. The location of this home48 directory depends on the conventions of the host operating49 system, as follows:46 settings file, with a <filename>.vbox</filename> file extension, 47 and its disk images. This is called the <emphasis>machine 48 folder</emphasis>. 49 </para> 50 51 <para> 52 By default, this machine folder is located in a common folder 53 called <filename>VirtualBox VMs</filename>, which &product-name; 54 creates in the current system user's home directory. The 55 location of this home directory depends on the conventions of 56 the host operating system, as follows: 50 57 </para> 51 58 … … 55 62 <para> 56 63 On Windows, this is the location returned by the 57 <computeroutput>SHGetFolderPath</computeroutput> function of 58 the Windows system library Shell32.dll, asking for the user 59 profile. On very old Windows versions which do not have this 60 function or where it unexpectedly returns an error, there is 61 a fallback based on environment variables. First, 62 <computeroutput>%USERPROFILE%</computeroutput> is checked. 63 If it does not exist then an attempt with 64 <computeroutput>%HOMEDRIVE%%HOMEPATH%</computeroutput> is 65 made. A typical location is 66 <computeroutput>C:\Users\username</computeroutput>. 64 <literal>SHGetFolderPath</literal> function of the Windows 65 system library Shell32.dll, asking for the user profile. A 66 typical location is 67 <filename>C:\Users\<replaceable>username</replaceable></filename>. 67 68 </para> 68 69 </listitem> … … 72 73 On Linux, Mac OS X, and Oracle Solaris, this is generally 73 74 taken from the environment variable 74 <computeroutput>$HOME</computeroutput>, except for the user 75 <computeroutput>root</computeroutput> where it is taken from 76 the account database. This is a workaround for the frequent 77 trouble caused by users using &product-name; in combination 78 with the tool <computeroutput>sudo</computeroutput> which by 79 default does not reset the environment variable 80 <computeroutput>$HOME</computeroutput>. A typical location 81 on Linux and Oracle Solaris is 82 <computeroutput>/home/username</computeroutput> and on Mac 83 OS X <computeroutput>/Users/username</computeroutput>. 75 <filename>$HOME</filename>, except for the user 76 <literal>root</literal> where it is taken from the account 77 database. This is a workaround for the frequent trouble 78 caused by users using &product-name; in combination with the 79 tool <command>sudo</command>, which by default does not 80 reset the environment variable <filename>$HOME</filename>. 81 </para> 82 83 <para> 84 A typical location on Linux and Oracle Solaris is 85 <filename>/home/<replaceable>username</replaceable></filename> 86 and on Mac OS X is 87 <filename>/Users/<replaceable>username</replaceable></filename>. 84 88 </para> 85 89 </listitem> … … 88 92 89 93 <para> 90 For simplicity, we will abbreviate the location of the home91 directory as <computeroutput>$HOME</computeroutput>. Using that92 convention, the common folder for all virtual machines is93 <computeroutput>$HOME/VirtualBox VMs</computeroutput>.94 For simplicity, we abbreviate the location of the home directory 95 as <filename>$HOME</filename>. Using that convention, the common 96 folder for all virtual machines is <filename>$HOME/VirtualBox 97 VMs</filename>. 94 98 </para> 95 99 … … 103 107 <listitem> 104 108 <para> 105 A machine folder <computeroutput>$HOME/VirtualBox106 VM s/Example VM/</computeroutput>109 A machine folder: <filename>$HOME/VirtualBox VMs/Example 110 VM/</filename> 107 111 </para> 108 112 </listitem> … … 110 114 <listitem> 111 115 <para> 112 In the machine folder, a settings file: 113 <computeroutput>Example VM.vbox</computeroutput>116 In the machine folder, a settings file: <filename>Example 117 VM.vbox</filename> 114 118 </para> 115 119 </listitem> … … 118 122 <para> 119 123 In the machine folder, a virtual disk image: 120 < computeroutput>Example VM.vdi</computeroutput>.124 <filename>Example VM.vdi</filename>. 121 125 </para> 122 126 </listitem> … … 129 133 wizard described in <xref linkend="gui-createvm" />. Once you 130 134 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 133 <computeroutput>Snapshots</computeroutput> subfolder. For each 134 VM, you can change the location of its snapshots folder in the 135 VM settings. 135 are in a subfolder called <filename>Logs</filename>, and if you 136 have taken snapshots, they are in a 137 <filename>Snapshots</filename> subfolder. For each VM, you can 138 change the location of its snapshots folder in the VM settings. 136 139 </para> 137 140 … … 142 145 main window. Then, in the displayed window, click on the 143 146 <emphasis role="bold">General</emphasis> tab. Alternatively, use 144 <command>VBoxManage setproperty machinefolder</command>. See145 <xref linkend="vboxmanage-setproperty" />.147 the <command>VBoxManage setproperty machinefolder</command> 148 command. See <xref linkend="vboxmanage-setproperty" />. 146 149 </para> 147 150 148 151 </sect2> 149 152 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 earlier156 version of &product-name;, you probably have settings files and157 disks in the earlier file system layout.158 </para>159 160 <para>161 Before version 4.0, &product-name; separated the machine162 settings files from virtual disk images. The machine settings163 files had an <computeroutput>.xml</computeroutput> file164 extension and resided in a folder called165 <computeroutput>Machines</computeroutput> under the global166 &product-name; configuration directory. See167 <xref linkend="vboxconfigdata-global"/>. On Linux, for example,168 this was the hidden directory169 <computeroutput>$HOME/.VirtualBox/Machines</computeroutput>. The170 default hard disks folder was called171 <computeroutput>HardDisks</computeroutput> and was also located172 in the <computeroutput>.VirtualBox</computeroutput> folder. Both173 locations could be changed by the user in the global174 preferences. The concept of a default hard disk folder was175 abandoned with &product-name; 4.0, since disk images now reside176 in each machine's folder by default.177 </para>178 179 <para>180 The old layout had the following severe disadvantages:181 </para>182 183 <itemizedlist>184 185 <listitem>186 <para>187 It was very difficult to move a virtual machine from one188 host to another because the files involved did not reside in189 the same folder. In addition, the virtual media of all190 machines were registered with a global registry in the191 central &product-name; settings file,192 <computeroutput>$HOME/.VirtualBox/VirtualBox.xml</computeroutput>.193 </para>194 195 <para>196 To move a machine to another host, it was therefore not197 enough to move the XML settings file and the disk images,198 which were in different locations, but the hard disk entries199 from the global media registry XML had to be meticulously200 copied as well. This was close to impossible if the machine201 had snapshots and therefore differencing images.202 </para>203 </listitem>204 205 <listitem>206 <para>207 Storing virtual disk images, which can grow very large,208 under the hidden209 <computeroutput>.VirtualBox</computeroutput> directory, at210 least on Linux and Oracle Solaris hosts, made many users211 wonder where their disk space had gone.212 </para>213 </listitem>214 215 </itemizedlist>216 217 <para>218 Whereas new VMs created with &product-name; 4.0 or later will219 conform to the new layout, for maximum compatibility, old VMs220 are <emphasis>not</emphasis> converted to the new layout.221 Otherwise machine settings would be irrevocably broken if a user222 downgraded from 4.0 back to an older version of &product-name;.223 </para>224 225 </sect2>226 227 153 <sect2 id="vboxconfigdata-global"> 228 154 229 <title>Global Configuration Data</title> 230 231 <para> 232 In addition to the files of the virtual machines, &product-name; 233 maintains global configuration data in the following directory: 155 <title>Global Settings</title> 156 157 <para> 158 In addition to the files for the virtual machines, 159 &product-name; maintains global configuration data in the 160 following directory: 234 161 </para> 235 162 … … 239 166 <para> 240 167 <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. 168 <filename>$HOME/.config/VirtualBox</filename>. 248 169 </para> 249 170 </listitem> … … 252 173 <para> 253 174 <emphasis role="bold">Windows:</emphasis> 254 < computeroutput>$HOME/.VirtualBox</computeroutput>.175 <filename>$HOME/.VirtualBox</filename>. 255 176 </para> 256 177 </listitem> … … 259 180 <para> 260 181 <emphasis role="bold">Mac OS X:</emphasis> 261 < computeroutput>$HOME/Library/VirtualBox</computeroutput>.182 <filename>$HOME/Library/VirtualBox</filename>. 262 183 </para> 263 184 </listitem> … … 267 188 <para> 268 189 &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> 274 variable. Since the global 275 <computeroutput>VirtualBox.xml</computeroutput> settings file 276 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 282 global settings file, another XML file called 283 <computeroutput>VirtualBox.xml</computeroutput>. This includes 284 global configuration options and the list of registered virtual 285 machines with pointers to their XML settings files. Neither the 286 location of this file nor its directory has changed with 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 306 <computeroutput>$HOME/.VirtualBox/Machines</computeroutput> on 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. 190 automatically, if necessary. You can specify an alternate 191 configuration directory by either setting the 192 <literal>VBOX_USER_HOME</literal> environment variable, or on 193 Linux or Oracle Solaris by using the standard 194 <literal>XDG_CONFIG_HOME</literal> variable. Since the global 195 <filename>VirtualBox.xml</filename> settings file points to all 196 other configuration files, this enables switching between 197 several &product-name; configurations. 198 </para> 199 200 <para> 201 In this configuration directory, &product-name; stores its 202 global settings file, an XML file called 203 <filename>VirtualBox.xml</filename>. This file includes global 204 configuration options and a list of registered virtual machines 205 with pointers to their XML settings files. 310 206 </para> 311 207 312 208 </sect2> 313 209 314 <sect2 id="vboxconfigdata-summary- version-four">315 316 <title>Summary of 4.0 Configuration Changes</title>210 <sect2 id="vboxconfigdata-summary-locations"> 211 212 <title>Summary of Configuration Data Locations</title> 317 213 318 214 <para> 319 215 The following table gives a brief overview of the configuration 320 changes between legacy versions and version 4.0 or later.321 </para> 322 323 <table id="table- version4-config-changes" tabstyle="oracle-all">324 <title>Configuration Changes in Version 4.0 or Above</title>325 <tgroup cols=" 3">216 data locations on an &product-name; host. 217 </para> 218 219 <table id="table-config-summary" tabstyle="oracle-all"> 220 <title>Configuration File Locations</title> 221 <tgroup cols="2"> 326 222 <thead> 327 223 <row> … … 330 226 </para></entry> 331 227 <entry><para> 332 <emphasis role="bold">Before 4.0</emphasis> 333 </para></entry> 334 <entry><para> 335 <emphasis role="bold">4.0 or above</emphasis> 228 <emphasis role="bold">Location</emphasis> 336 229 </para></entry> 337 230 </row> … … 343 236 </para></entry> 344 237 <entry><para> 345 <computeroutput>$HOME/.VirtualBox/Machines</computeroutput> 346 </para></entry> 347 <entry><para> 348 <computeroutput>$HOME/VirtualBox VMs</computeroutput> 238 <filename>$HOME/VirtualBox VMs</filename> 349 239 </para></entry> 350 240 </row> … … 352 242 <entry><para> 353 243 Default disk image location 354 </para></entry>355 <entry><para>356 <computeroutput>$HOME/.VirtualBox/HardDisks</computeroutput>357 244 </para></entry> 358 245 <entry><para> … … 365 252 </para></entry> 366 253 <entry><para> 367 <computeroutput>.xml</computeroutput> 368 </para></entry> 369 <entry><para> 370 <computeroutput>.vbox</computeroutput> 254 <filename>.vbox</filename> 371 255 </para></entry> 372 256 </row> … … 376 260 </para></entry> 377 261 <entry><para> 378 Global <computeroutput>VirtualBox.xml</computeroutput>379 file380 </para></entry>381 <entry><para>382 262 Each machine settings file 383 </para></entry> 384 </row> 385 <row> 386 <entry><para> 387 Media registration 388 </para></entry> 389 <entry><para> 390 Explicit open/close required 391 </para></entry> 392 <entry><para> 393 Automatic on attach 263 </para> 264 265 266 267 <para> 268 Media registration is done automatically when a 269 storage medium is attached to a VM 394 270 </para></entry> 395 271 </row> … … 407 283 &product-name; uses XML for both the machine settings files and 408 284 the global configuration file, 409 < computeroutput>VirtualBox.xml</computeroutput>.285 <filename>VirtualBox.xml</filename>. 410 286 </para> 411 287 … … 426 302 427 303 <para> 428 As an example, before &product-name; 3.1, it was only possible429 to enable or disable a single DVD drive in a virtual machine. If430 it was enabled, then it would always be visible as the secondary431 master of the IDE controller. With &product-name; 3.1, DVD432 drives can be attached to arbitrary slots of arbitrary433 controllers, so they could be the secondary slave of an IDE434 controller or in a SATA slot. If you have a machine settings435 file from an earlier version and upgrade &product-name; to 3.1436 and then move the DVD drive from its default position, this437 cannot be expressed in the old settings format; the XML machine438 file would get written in the new format, and a backup file of439 the old format would be kept.440 </para>441 442 <para>443 304 In such cases, &product-name; backs up the old settings file in 444 305 the virtual machine's configuration directory. If you need to go … … 476 337 <listitem> 477 338 <para> 478 <com puteroutput>VBoxSVC</computeroutput>, the &product-name;479 service process which always runs in the background. This480 process is started automatically by the first &product-name;481 client process and exits a short time after the last client482 exits. The first&product-name; service can be the GUI,483 <com puteroutput>VBoxManage</computeroutput>,484 <com puteroutput>VBoxHeadless</computeroutput>, the web service485 amongstothers. The service is responsible for bookkeeping,339 <command>VBoxSVC</command>, the &product-name; service process 340 which always runs in the background. This process is started 341 automatically by the first &product-name; client process and 342 exits a short time after the last client exits. The first 343 &product-name; service can be the GUI, 344 <command>VBoxManage</command>, 345 <command>VBoxHeadless</command>, the web service amongst 346 others. The service is responsible for bookkeeping, 486 347 maintaining the state of all VMs, and for providing 487 348 communication between &product-name; components. This … … 492 353 <para> 493 354 When we refer to <emphasis>clients</emphasis> here, we mean 494 the local clients of a particular 495 <computeroutput>VBoxSVC</computeroutput> server process, not 496 clients in a network. &product-name; employs its own 497 client/server design to allow its processes to cooperate, 498 but all these processes run under the same user account on 499 the host operating system, and this is totally transparent 500 to the user. 355 the local clients of a particular <command>VBoxSVC</command> 356 server process, not clients in a network. &product-name; 357 employs its own client/server design to allow its processes 358 to cooperate, but all these processes run under the same 359 user account on the host operating system, and this is 360 totally transparent to the user. 501 361 </para> 502 362 </note> … … 505 365 <listitem> 506 366 <para> 507 The GUI process, 508 <computeroutput>VirtualBoxVM</computeroutput>, a client 367 The GUI process, <command>VirtualBoxVM</command>, a client 509 368 application based on the cross-platform Qt library. When 510 started without the <computeroutput>--startvm</computeroutput> 511 option, this application acts as the VirtualBox Manager, 512 displaying the VMs and their settings. It then communicates 513 settings and state changes to 514 <computeroutput>VBoxSVC</computeroutput> and also reflects 369 started without the <option>--startvm</option> option, this 370 application acts as the VirtualBox Manager, displaying the VMs 371 and their settings. It then communicates settings and state 372 changes to <command>VBoxSVC</command> and also reflects 515 373 changes effected through other means, such as the 516 374 <command>VBoxManage</command> command. … … 520 378 <listitem> 521 379 <para> 522 If the <computeroutput>VirtualBoxVM</computeroutput> client 523 application is started with the 524 <computeroutput>--startvm</computeroutput> argument, it loads 380 If the <command>VirtualBoxVM</command> client application is 381 started with the <option>--startvm</option> argument, it loads 525 382 the VMM library which includes the actual hypervisor and then 526 383 runs a virtual machine and provides the input and output for … … 549 406 <listitem> 550 407 <para> 551 <computeroutput>VirtualBoxVM</computeroutput>: The Qt front 552 end implementing the VirtualBox Manager and running VMs. 553 </para> 554 </listitem> 555 556 <listitem> 557 <para> 558 <computeroutput>VBoxManage</computeroutput>: A less 559 user-friendly but more powerful alternative. See 560 <xref linkend="vboxmanage" />. 561 </para> 562 </listitem> 563 564 <listitem> 565 <para> 566 <computeroutput>VBoxHeadless</computeroutput>: A VM front end 567 which does not directly provide any video output and keyboard 568 or mouse input, but enables redirection through the VirtualBox 569 Remote Desktop Extension. See <xref linkend="vboxheadless" />. 570 </para> 571 </listitem> 572 573 <listitem> 574 <para> 575 <computeroutput>vboxwebsrv</computeroutput>: The 576 &product-name; web service process which enables control of an 577 &product-name; host remotely. This is described in detail in 578 the &product-name; Software Development Kit (SDK) reference. 579 See <xref linkend="VirtualBoxAPI" />. 408 <command>VirtualBoxVM</command>: The Qt front end implementing 409 the VirtualBox Manager and running VMs. 410 </para> 411 </listitem> 412 413 <listitem> 414 <para> 415 <command>VBoxManage</command>: A less user-friendly but more 416 powerful alternative. See <xref linkend="vboxmanage" />. 417 </para> 418 </listitem> 419 420 <listitem> 421 <para> 422 <command>VBoxHeadless</command>: A VM front end which does not 423 directly provide any video output and keyboard or mouse input, 424 but enables redirection through the VirtualBox Remote Desktop 425 Extension. See <xref linkend="vboxheadless" />. 426 </para> 427 </listitem> 428 429 <listitem> 430 <para> 431 <command>vboxwebsrv</command>: The &product-name; web service 432 process which enables control of an &product-name; host 433 remotely. This is described in detail in the &product-name; 434 Software Development Kit (SDK) reference. See 435 <xref linkend="VirtualBoxAPI" />. 580 436 </para> 581 437 </listitem> … … 584 440 <para> 585 441 The &product-name; Python shell: A Python alternative to 586 <com puteroutput>VBoxManage</computeroutput>. This is also587 described in theSDK reference.442 <command>VBoxManage</command>. This is also described in the 443 SDK reference. 588 444 </para> 589 445 </listitem> … … 617 473 <para> 618 474 EM (Execution Manager): Controls execution of guest code. 619 </para>620 </listitem>621 622 <listitem>623 <para>624 REM (Recompiled Execution Monitor): Provides software625 emulation of CPU instructions.626 475 </para> 627 476 </listitem> … … 662 511 <para> 663 512 PGM (Page Manager): A component that controls guest paging. 664 </para>665 </listitem>666 667 <listitem>668 <para>669 PATM (Patch Manager): Patches guest code to improve and speed670 up software virtualization.671 513 </para> 672 514 </listitem> … … 747 589 <sect1 id="hwvirt"> 748 590 749 <title>Hardware vs. SoftwareVirtualization</title>591 <title>Hardware Virtualization</title> 750 592 751 593 <para> … … 757 599 &product-name; steps in and takes action. In particular, for lots 758 600 of hardware that the guest believes to be accessing, 759 &product-name; simulates a certain "virtual" environment according760 to how you have configured a virtual machine. For example, when761 the guest attempts to access a hard disk, &product-name; redirects762 these requests to whatever you have configured to be the virtual763 machine's virtual hard disk. This is normally an image file on764 your host.601 &product-name; simulates a certain <emphasis>virtual</emphasis> 602 environment according to how you have configured a virtual 603 machine. For example, when the guest attempts to access a hard 604 disk, &product-name; redirects these requests to whatever you have 605 configured to be the virtual machine's virtual hard disk. This is 606 normally an image file on your host. 765 607 </para> 766 608 … … 769 611 virtualized. Detecting situations in which &product-name; needs to 770 612 take control over the guest code that is executing, as described 771 above, is difficult. There are two ways in which to achieve this: 613 above, is difficult. To achieve this, &product-name; uses 614 <emphasis>hardware virtualization</emphasis>. 615 </para> 616 617 <para> 618 Intel and AMD processors have support for hardware virtualization. 619 This means that these processors can help &product-name; to 620 intercept potentially dangerous operations that a guest operating 621 system may be attempting and also makes it easier to present 622 virtual hardware to a virtual machine. 623 </para> 624 625 <para> 626 These hardware features differ between Intel and AMD processors. 627 Intel named its technology VT-x, AMD calls theirs AMD-V. The Intel 628 and AMD support for virtualization is very different in detail, 629 but not very different in principle. 630 </para> 631 632 <note> 633 <para> 634 On many systems, the hardware virtualization features first need 635 to be enabled in the BIOS before &product-name; can use them. 636 </para> 637 </note> 638 639 <para> 640 Enabling hardware virtualization is <emphasis>required</emphasis> 641 in the following scenarios: 772 642 </para> 773 643 … … 776 646 <listitem> 777 647 <para> 778 Since 2006, Intel and AMD processors have had support for779 so-called <emphasis>hardware virtualization</emphasis>. This780 means that these processors can help &product-name; to781 intercept potentially dangerous operations that a guest782 operating system may be attempting and also makes it easier to783 present virtual hardware to a virtual machine.784 </para>785 786 <para>787 These hardware features differ between Intel and AMD788 processors. Intel named its technology VT-x. AMD calls theirs789 AMD-V. The Intel and AMD support for virtualization is very790 different in detail, but not very different in principle.791 </para>792 793 <note>794 <para>795 On many systems, the hardware virtualization features first796 need to be enabled in the BIOS before &product-name; can use797 them.798 </para>799 </note>800 </listitem>801 802 <listitem>803 <para>804 As opposed to other virtualization software, for many usage805 scenarios, &product-name; does not806 <emphasis>require</emphasis> hardware virtualization features807 to be present. Through sophisticated techniques,808 &product-name; virtualizes many guest operating systems809 entirely in <emphasis>software</emphasis>. This means that you810 can run virtual machines even on older processors which do not811 support hardware virtualization.812 </para>813 </listitem>814 815 </itemizedlist>816 817 <para>818 Even though &product-name; does not always require hardware819 virtualization, enabling it is <emphasis>required</emphasis> in820 the following scenarios:821 </para>822 823 <itemizedlist>824 825 <listitem>826 <para>827 648 Certain rare guest operating systems like OS/2 make use of 828 very esoteric processor instructions that are not supported 829 with our software virtualization. For virtual machines that 830 are configured to contain such an operating system, hardware 649 very esoteric processor instructions. For virtual machines 650 that are configured to use such an operating system, hardware 831 651 virtualization is enabled automatically. 832 652 </para> … … 835 655 <listitem> 836 656 <para> 837 &product-name;'s 64-bit guest support, added with version 2.0, 838 and multiprocessing (SMP), added with version 3.0, both 839 require hardware virtualization to be enabled. This is not 840 much of a limitation since the vast majority of today's 64-bit 841 and multicore CPUs ship with hardware virtualization anyway. 842 The exceptions to this rule are older Intel Celeron and AMD 843 Opteron CPUs, for example. 657 &product-name;'s 64-bit guest and multiprocessing (SMP) 658 support both require hardware virtualization to be enabled. 659 This is not much of a limitation since the vast majority of 660 64-bit and multicore CPUs ship with hardware virtualization. 661 The exceptions to this rule are some legacy Intel and AMD 662 CPUs. 844 663 </para> 845 664 </listitem> … … 858 677 host, and especially if several products attempt to use hardware 859 678 virtualization features such as VT-x, this can crash the entire 860 host. Also, within &product-name;, you can mix software and 861 hardware virtualization when running multiple VMs. In certain 862 cases a small performance penalty will be unavoidable when 863 mixing VT-x and software virtualization VMs. We recommend not 864 mixing virtualization modes if maximum performance and low 865 overhead are essential. This does <emphasis>not</emphasis> apply 866 to AMD-V. 679 host. 867 680 </para> 868 681 </warning> 869 682 870 </sect1> 871 872 <sect1 id="gimproviders"> 873 874 <title>Paravirtualization Providers</title> 875 876 <para> 877 &product-name; enables the exposure of a paravirtualization 878 interface, to facilitate accurate and efficient execution of 879 software within a virtual machine. These interfaces require the 880 guest operating system to recognize their presence and make use of 881 them in order to leverage the benefits of communicating with the 882 &product-name; hypervisor. 883 </para> 884 885 <para> 886 Most modern, mainstream guest operating systems, including Windows 887 and Linux, ship with support for one or more paravirtualization 888 interfaces. Hence, there is typically no need to install 889 additional software in the guest to take advantage of this 890 feature. 891 </para> 892 893 <para> 894 Exposing a paravirtualization provider to the guest operating 895 system does not rely on the choice of host platforms. For example, 896 the <emphasis>Hyper-V</emphasis> paravirtualization provider can 897 be used for VMs to run on any host platform supported by 898 &product-name; and not just Windows. 899 </para> 900 901 <para> 902 &product-name; provides the following interfaces: 903 </para> 904 905 <itemizedlist> 906 907 <listitem> 908 <para> 909 <emphasis role="bold">Minimal</emphasis>: Announces the 910 presence of a virtualized environment. Additionally, reports 911 the TSC and APIC frequency to the guest operating system. This 912 provider is mandatory for running any Mac OS X guests. 913 </para> 914 </listitem> 915 916 <listitem> 917 <para> 918 <emphasis role="bold">KVM</emphasis>: Presents a Linux KVM 919 hypervisor interface which is recognized by Linux kernels 920 version 2.6.25 or later. &product-name;'s implementation 921 currently supports paravirtualized clocks and SMP spinlocks. 922 This provider is recommended for Linux guests. 923 </para> 924 </listitem> 925 926 <listitem> 927 <para> 928 <emphasis role="bold">Hyper-V</emphasis>: Presents a Microsoft 929 Hyper-V hypervisor interface which is recognized by Windows 7 930 and newer operating systems. &product-name;'s implementation 931 currently supports paravirtualized clocks, APIC frequency 932 reporting, guest debugging, guest crash reporting and relaxed 933 timer checks. This provider is recommended for Windows guests. 934 </para> 935 </listitem> 936 937 </itemizedlist> 938 939 </sect1> 940 941 <sect1 id="swvirt-details"> 942 943 <title>Details About Software Virtualization</title> 944 945 <para> 946 Implementing virtualization on x86 CPUs with no hardware 947 virtualization support is an extraordinarily complex task because 948 the CPU architecture was not designed to be virtualized. The 949 problems can usually be solved, but at the cost of reduced 950 performance. Thus, there is a constant clash between 951 virtualization performance and accuracy. 952 </para> 953 954 <para> 955 The x86 instruction set was originally designed in the 1970s and 956 underwent significant changes with the addition of protected mode 957 in the 1980s with the 286 CPU architecture and then again with the 958 Intel 386 and its 32-bit architecture. Whereas the 386 did have 959 limited virtualization support for real mode operation with V86 960 mode, as used by the "DOS Box" of Windows 3.x and OS/2 2.x, no 961 support was provided for virtualizing the entire architecture. 962 </para> 963 964 <para> 965 In theory, software virtualization is not overly complex. There 966 are four privilege levels, called <emphasis>rings</emphasis>, 967 provided by the hardware. Typically only two rings are used: ring 968 0 for kernel mode and ring 3 for user mode. Additionally, one 969 needs to differentiate between <emphasis>host context</emphasis> 970 and <emphasis>guest context</emphasis>. 971 </para> 972 973 <para> 974 In host context, everything is as if no hypervisor was active. 975 This might be the active mode if another application on your host 976 has been scheduled CPU time. In that case, there is a host ring 3 977 mode and a host ring 0 mode. The hypervisor is not involved. 978 </para> 979 980 <para> 981 In guest context, however, a virtual machine is active. So long as 982 the guest code is running in ring 3, this is not much of a problem 983 since a hypervisor can set up the page tables properly and run 984 that code natively on the processor. The problems mostly lie in 985 how to intercept what the guest's kernel does. 986 </para> 987 988 <para> 989 There are several possible solutions to these problems. One 990 approach is full software emulation, usually involving 991 recompilation. That is, all code to be run by the guest is 992 analyzed, transformed into a form which will not allow the guest 993 to either modify or see the true state of the CPU, and only then 994 executed. This process is obviously highly complex and costly in 995 terms of performance. &product-name; contains a recompiler based 996 on QEMU which can be used for pure software emulation, but the 997 recompiler is only activated in special situations, described 998 below. 999 </para> 1000 1001 <para> 1002 Another possible solution is paravirtualization, in which only 1003 specially modified guest OSes are allowed to run. This way, most 1004 of the hardware access is abstracted and any functions which would 1005 normally access the hardware or privileged CPU state are passed on 1006 to the hypervisor instead. Paravirtualization can achieve good 1007 functionality and performance on standard x86 CPUs, but it can 1008 only work if the guest OS can actually be modified, which is 1009 obviously not always the case. 1010 </para> 1011 1012 <para> 1013 &product-name; chooses a different approach. When starting a 1014 virtual machine, through its ring-0 support kernel driver, 1015 &product-name; has set up the host system so that it can run most 1016 of the guest code natively, but it has inserted itself at the 1017 "bottom" of the picture. It can then assume control when needed. 1018 If a privileged instruction is executed, the guest traps, in 1019 particular because an I/O register was accessed and a device needs 1020 to be virtualized, or external interrupts occur. &product-name; 1021 may then handle this and either route a request to a virtual 1022 device or possibly delegate handling such things to the guest or 1023 host OS. In guest context, &product-name; can therefore be in one 1024 of three states: 1025 </para> 1026 1027 <itemizedlist> 1028 1029 <listitem> 1030 <para> 1031 Guest ring 3 code is run unmodified, at full speed, as much as 1032 possible. The number of faults will generally be low, unless 1033 the guest allows port I/O from ring 3. This is something we 1034 cannot do as we do not want the guest to be able to access 1035 real ports. This is also referred to as <emphasis>raw 1036 mode</emphasis>, as the guest ring-3 code runs unmodified. 1037 </para> 1038 </listitem> 1039 1040 <listitem> 1041 <para> 1042 For guest code in ring 0, &product-name; employs a clever 1043 trick. It actually reconfigures the guest so that its ring-0 1044 code is run in ring 1 instead, which is normally not used in 1045 x86 operating systems). As a result, when guest ring-0 code, 1046 actually running n ring 1, such as a guest device driver 1047 attempts to write to an I/O register or execute a privileged 1048 instruction, the &product-name; hypervisor in the "real" ring 1049 0 can take over. 1050 </para> 1051 </listitem> 1052 1053 <listitem> 1054 <para> 1055 The hypervisor (VMM) can be active. Every time a fault occurs, 1056 &product-name; looks at the offending instruction and can 1057 relegate it to a virtual device or the host OS or the guest OS 1058 or run it in the recompiler. 1059 </para> 1060 1061 <para> 1062 In particular, the recompiler is used when guest code disables 1063 interrupts and &product-name; cannot figure out when they will 1064 be switched back on. In these situations, &product-name; 1065 actually analyzes the guest code using its own disassembler. 1066 Also, certain privileged instructions such as LIDT need to be 1067 handled specially. Finally, any real-mode or protected-mode 1068 code, such as BIOS code, a DOS guest, or any operating system 1069 startup, is run in the recompiler entirely. 1070 </para> 1071 </listitem> 1072 1073 </itemizedlist> 1074 1075 <para> 1076 Unfortunately this only works to a degree. Among others, the 1077 following situations require special handling: 1078 </para> 1079 1080 <itemizedlist> 1081 1082 <listitem> 1083 <para> 1084 Running ring 0 code in ring 1 causes a lot of additional 1085 instruction faults, as ring 1 is not allowed to execute any 1086 privileged instructions, of which guest's ring-0 contains 1087 plenty. With each of these faults, the VMM must step in and 1088 emulate the code to achieve the desired behavior. While this 1089 works, emulating thousands of these faults is very expensive 1090 and severely hurts the performance of the virtualized guest. 1091 </para> 1092 </listitem> 1093 1094 <listitem> 1095 <para> 1096 There are certain flaws in the implementation of ring 1 in the 1097 x86 architecture that were never fixed. Certain instructions 1098 that <emphasis>should</emphasis> trap in ring 1 do not. This 1099 affects, for example, the LGDT/SGDT, LIDT/SIDT, or POPF/PUSHF 1100 instruction pairs. Whereas the "load" operation is privileged 1101 and can therefore be trapped, the "store" instruction always 1102 succeed. If the guest is allowed to execute these, it will see 1103 the true state of the CPU, not the virtualized state. The 1104 CPUID instruction also has the same problem. 1105 </para> 1106 </listitem> 1107 1108 <listitem> 1109 <para> 1110 A hypervisor typically needs to reserve some portion of the 1111 guest's address space, both linear address space and 1112 selectors, for its own use. This is not entirely transparent 1113 to the guest OS and may cause clashes. 1114 </para> 1115 </listitem> 1116 1117 <listitem> 1118 <para> 1119 The SYSENTER instruction, used for system calls, executed by 1120 an application running in a guest OS always transitions to 1121 ring 0. But that is where the hypervisor runs, not the guest 1122 OS. In this case, the hypervisor must trap and emulate the 1123 instruction even when it is not desirable. 1124 </para> 1125 </listitem> 1126 1127 <listitem> 1128 <para> 1129 The CPU segment registers contain a "hidden" descriptor cache 1130 which is not software-accessible. The hypervisor cannot read, 1131 save, or restore this state, but the guest OS may use it. 1132 </para> 1133 </listitem> 1134 1135 <listitem> 1136 <para> 1137 Some resources must, and can, be trapped by the hypervisor, 1138 but the access is so frequent that this creates a significant 1139 performance overhead. An example is the TPR (Task Priority) 1140 register in 32-bit mode. Accesses to this register must be 1141 trapped by the hypervisor. But certain guest operating 1142 systems, notably Windows and Oracle Solaris, write this 1143 register very often, which adversely affects virtualization 1144 performance. 1145 </para> 1146 </listitem> 1147 1148 </itemizedlist> 1149 1150 <para> 1151 To fix these performance and security issues, &product-name; 1152 contains a Code Scanning and Analysis Manager (CSAM), which 1153 disassembles guest code, and the Patch Manager (PATM), which can 1154 replace it at runtime. 1155 </para> 1156 1157 <para> 1158 Before executing ring 0 code, CSAM scans it recursively to 1159 discover problematic instructions. PATM then performs 1160 <emphasis>in-situ </emphasis>patching. It replaces the instruction 1161 with a jump to hypervisor memory where an integrated code 1162 generator has placed a more suitable implementation. In reality, 1163 this is a very complex task as there are lots of odd situations to 1164 be discovered and handled correctly. So, with its current 1165 complexity, one could argue that PATM is an advanced 1166 <emphasis>in-situ</emphasis> recompiler. 1167 </para> 1168 1169 <para> 1170 In addition, every time a fault occurs, &product-name; analyzes 1171 the offending code to determine if it is possible to patch it in 1172 order to prevent it from causing more faults in the future. This 1173 approach works well in practice and dramatically improves software 1174 virtualization performance. 683 <para> 684 See <xref linkend="hwvirt-details"/> for a technical discussion of 685 hardware virtualization. 1175 686 </para> 1176 687 … … 1270 781 software virtualization, the overhead of VM exits is relatively 1271 782 high. This causes problems for devices whose emulation requires 1272 high number of traps. One example is theVGA device in 16-color1273 mode s, where not only every I/O port access but also every access783 high number of traps. One example is a VGA device in 16-color 784 mode, where not only every I/O port access but also every access 1274 785 to the framebuffer memory must be trapped. 1275 786 </para> 787 788 </sect1> 789 790 <sect1 id="gimproviders"> 791 792 <title>Paravirtualization Providers</title> 793 794 <para> 795 &product-name; enables the exposure of a paravirtualization 796 interface, to facilitate accurate and efficient execution of 797 software within a virtual machine. These interfaces require the 798 guest operating system to recognize their presence and make use of 799 them in order to leverage the benefits of communicating with the 800 &product-name; hypervisor. 801 </para> 802 803 <para> 804 Most modern, mainstream guest operating systems, including Windows 805 and Linux, ship with support for one or more paravirtualization 806 interfaces. Hence, there is typically no need to install 807 additional software in the guest to take advantage of this 808 feature. 809 </para> 810 811 <para> 812 Exposing a paravirtualization provider to the guest operating 813 system does not rely on the choice of host platforms. For example, 814 the <emphasis>Hyper-V</emphasis> paravirtualization provider can 815 be used for VMs to run on any host platform supported by 816 &product-name; and not just Windows. 817 </para> 818 819 <para> 820 &product-name; provides the following interfaces: 821 </para> 822 823 <itemizedlist> 824 825 <listitem> 826 <para> 827 <emphasis role="bold">Minimal</emphasis>: Announces the 828 presence of a virtualized environment. Additionally, reports 829 the TSC and APIC frequency to the guest operating system. This 830 provider is mandatory for running any Mac OS X guests. 831 </para> 832 </listitem> 833 834 <listitem> 835 <para> 836 <emphasis role="bold">KVM</emphasis>: Presents a Linux KVM 837 hypervisor interface which is recognized by Linux kernels 838 version 2.6.25 or later. &product-name;'s implementation 839 currently supports paravirtualized clocks and SMP spinlocks. 840 This provider is recommended for Linux guests. 841 </para> 842 </listitem> 843 844 <listitem> 845 <para> 846 <emphasis role="bold">Hyper-V</emphasis>: Presents a Microsoft 847 Hyper-V hypervisor interface which is recognized by Windows 7 848 and newer operating systems. &product-name;'s implementation 849 currently supports paravirtualized clocks, APIC frequency 850 reporting, guest debugging, guest crash reporting and relaxed 851 timer checks. This provider is recommended for Windows guests. 852 </para> 853 </listitem> 854 855 </itemizedlist> 1276 856 1277 857 </sect1> … … 1328 908 and overhead. This can yield a performance improvement of up 1329 909 to 5%. To enable this feature for a VM, you use the 1330 <computeroutput>VBoxManage modifyvm 1331 --largepages</computeroutput> command. See 1332 <xref linkend="vboxmanage-modifyvm" />. 910 <command>VBoxManage modifyvm --largepages</command> command. 911 See <xref linkend="vboxmanage-modifyvm" />. 1333 912 </para> 1334 913 … … 1350 929 <para> 1351 930 To enable these features for a VM, you use the 1352 <com puteroutput>VBoxManage modifyvm --vtxvpid</computeroutput>1353 and <computeroutput>--largepages</computeroutput> commands.931 <command>VBoxManage modifyvm --vtxvpid</command> and 932 <command>VBoxManage modifyvm --largepages</command> commands. 1354 933 See <xref linkend="vboxmanage-modifyvm" />. 1355 934 </para> -
trunk/doc/manual/en_US/user_ThirdParty.xml
r76786 r82350 24 24 of the &product-name; code which is released as open source are 25 25 available at 26 <ulink 27 url="http://www.virtualbox.org">http://www.virtualbox.org</ulink>, 26 <ulink url="http://www.virtualbox.org" />, 28 27 both as tarballs for particular releases and as a live SVN 29 28 repository. … … 182 181 work does not require the other work to be released under the 183 182 same license (see 184 <ulink 185 url="http://etherboot.sourceforge.net/clinks.html">http://etherboot.sourceforge.net/clinks.html</ulink>). 183 <ulink url="http://etherboot.sourceforge.net/clinks.html" />). 186 184 Etherboot is 187 185 </para> … … 3291 3289 except in compliance with the License. You may obtain a copy of 3292 3290 the License at 3293 <ulink 3294 url="http://www.cs.fsu.edu/~engelen/soaplicense.html">http://www.cs.fsu.edu/~engelen/soaplicense.html</ulink>. 3291 <ulink url="http://www.cs.fsu.edu/~engelen/soaplicense.html" />. 3295 3292 Software distributed under the License is distributed on an "AS 3296 3293 IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or -
trunk/doc/manual/en_US/user_Troubleshooting.xml
r79368 r82350 66 66 Because of significant differences between VT-x and AMD-V, 67 67 problems may be specific to one or the other technology. The 68 exact CPU model may also make a difference, even for 69 software virtualization, because different CPUs support 70 different features, which may affect certain aspects of 71 guest CPU operation. 72 </para> 73 </listitem> 74 75 <listitem> 76 <para> 77 Is the problem specific to a certain virtualization mode? 78 Some problems may only occur in software virtualization 79 mode, others may be specific to hardware virtualization. 68 exact CPU model may also make a difference because different 69 CPUs support different features, which may affect certain 70 aspects of guest CPU operation. 80 71 </para> 81 72 </listitem> … … 139 130 <emphasis>release log file</emphasis> is created, containing 140 131 lots of information about the VM configuration and runtime 141 events. The log file is called 142 <computeroutput>VBox.log</computeroutput> and resides in the VM143 log file folder. Typically this will be a directory as follows:144 </para>145 146 <screen>$HOME/VirtualBox VMs/{machinename}/Logs</screen>132 events. The log file is called <filename>VBox.log</filename> and 133 resides in the VM log file folder, which is 134 <filename>$HOME/VirtualBox 135 VMs/<replaceable>VM-name</replaceable>/Logs</filename> by 136 default. 137 </para> 147 138 148 139 <para> 149 140 When starting a VM, the configuration file of the last run will 150 be renamed to < computeroutput>.1</computeroutput>, up to151 < computeroutput>.3</computeroutput>. Sometimes when there is a152 problem, it is useful to have a look at the logs. Also when153 requesting support for &product-name;, supplying the154 corresponding log fileis mandatory.141 be renamed to <filename>.1</filename>, up to 142 <filename>.3</filename>. Sometimes when there is a problem, it 143 is useful to have a look at the logs. Also when requesting 144 support for &product-name;, supplying the corresponding log file 145 is mandatory. 155 146 </para> 156 147 … … 164 155 165 156 <para> 166 The release log file, VBox.log, contains a wealth of diagnostic167 information, such as Host OS type and version, &product-name;168 version and build (32-bit or 64-bit). It also includes a157 The release log file, <filename>VBox.log</filename>, contains a 158 wealth of diagnostic information, such as Host OS type and 159 version, &product-name; version and build. It also includes a 169 160 complete dump of the guest's configuration (CFGM), detailed 170 161 information about the host CPU type and supported features, … … 180 171 <emphasis>crash dumps</emphasis>. This is true for both host and 181 172 guest crashes. For information about enabling core dumps on 182 Linux, Oracle Solaris, and OS X systems, refer to the following 183 core dump article on the &product-name; website: 184 </para> 185 186 <para> 187 <ulink 188 url="http://www.virtualbox.org/wiki/Core_dump">http://www.virtualbox.org/wiki/Core_dump</ulink>. 173 Linux, Oracle Solaris, and Mac OS X systems, refer to the 174 following core dump article on the &product-name; website: 175 </para> 176 177 <para> 178 <ulink url="http://www.virtualbox.org/wiki/Core_dump" />. 189 179 </para> 190 180 … … 211 201 212 202 <para> 213 <ulink 214 url="http://www.virtualbox.org/wiki/Network_tips">http://www.virtualbox.org/wiki/Network_tips</ulink>. 203 <ulink url="http://www.virtualbox.org/wiki/Network_tips" />. 215 204 </para> 216 205 217 206 <para> 218 207 The trace files created by &product-name; are in 219 <computeroutput>.pcap</computeroutput> format and can be easily 220 analyzed with Wireshark. 208 <filename>.pcap</filename> format and can be easily analyzed 209 with Wireshark. 210 </para> 211 212 </sect2> 213 214 <sect2 id="ts_vboxbugreport"> 215 216 <title>Using the VBoxBugReport Command to Collect Debug Information 217 Automatically</title> 218 219 <para> 220 The <command>VBoxBugReport</command> command is used to collect 221 debug information automatically for an &product-name; 222 installation. This command can be useful when you need to gather 223 information to send to Oracle Support. 224 </para> 225 226 <para> 227 The following examples show how to use 228 <command>VBoxBugReport</command>. 229 </para> 230 231 <para> 232 By default, the command collects <command>VBoxSVC</command> 233 process logs, device settings, and global configuration data for 234 an &product-name; host. 235 </para> 236 237 <screen>$ VBoxBugReport 238 ... 239 0% - collecting VBoxSVC.log.10... 240 7% - collecting VBoxSVC.log.9... 241 ... 242 64% - collecting VBoxSVC.log.1... 243 71% - collecting VBoxSVC.log... 244 78% - collecting VirtualBox.xml... 245 85% - collecting HostUsbDevices... 246 92% - collecting HostUsbFilters... 247 100% - compressing... 248 249 Report was written to '2019-03-26-13-32-02-bugreport.tgz'</screen> 250 251 <para> 252 The results are saved as a compressed tar file archive in the 253 same directory where the command is run. 254 </para> 255 256 <para> 257 To specify a different output file location: 258 </para> 259 260 <screen>$ VBoxBugReport --output ~/debug/bug004.tgz</screen> 261 262 <para> 263 To output all debug information to a single text file, rather 264 than a <filename>tgz</filename> file: 265 </para> 266 267 <screen>$ VBoxBugReport --text</screen> 268 269 <para> 270 To collect information for a specific VM, called 271 <literal>Windows_10</literal>: 272 </para> 273 274 <screen>$ VBoxBugReport Windows_10</screen> 275 276 <para> 277 This command collects machine settings, guest properties, and 278 log files for the specified VM. Global configuration information 279 for the host is also included. 280 </para> 281 282 <para> 283 To collect information for several VMs, called 284 <literal>Windows_7</literal>, <literal>Windows_8</literal>, and 285 <literal>Windows_10</literal>: 286 </para> 287 288 <screen>$ VBoxBugReport Windows_7 Windows_8 Windows_10</screen> 289 290 <para> 291 To collect information for all VMs: 292 </para> 293 294 <screen>$ VBoxBugReport --all</screen> 295 296 <para> 297 To show a full list of the available command options, run 298 <command>VBoxBugReport --help</command>. 221 299 </para> 222 300 … … 262 340 <listitem> 263 341 <para> 264 Using the <computeroutput>telnet</computeroutput> protocol 265 on port 5000 342 Using the <command>telnet</command> protocol on port 5000 266 343 </para> 267 344 </listitem> … … 277 354 <listitem> 278 355 <para> 279 Start the VM directly using <command>VirtualBox 356 Start the VM directly using <command>VirtualBoxVM 280 357 --startvm</command>, with an additional 281 <computeroutput>--dbg</computeroutput>, 282 <computeroutput>--debug</computeroutput>, or 283 <computeroutput>--debug-command-line</computeroutput> 284 argument. See the <command>VirtualBox</command> command 285 usage help for details. 286 </para> 287 </listitem> 288 289 <listitem> 290 <para> 291 Set the 292 <computeroutput>VBOX_GUI_DBG_ENABLED</computeroutput> or 293 <computeroutput>VBOX_GUI_DBG_AUTO_SHOW</computeroutput> 294 environment variable to 295 <computeroutput>true</computeroutput> before launching the 358 <option>--dbg</option>, <option>--debug</option>, or 359 <option>--debug-command-line</option> argument. See the 360 <command>VirtualBoxVM --help</command> command usage help 361 for details. 362 </para> 363 </listitem> 364 365 <listitem> 366 <para> 367 Set the <literal>VBOX_GUI_DBG_ENABLED</literal> or 368 <literal>VBOX_GUI_DBG_AUTO_SHOW</literal> environment 369 variable to <literal>true</literal> before launching the 296 370 &product-name; process. Setting these variables, only their 297 371 presence is checked, is effective even when the first … … 304 378 <listitem> 305 379 <para> 306 Set the <computeroutput>GUI/Dbg/Enabled</computeroutput> 307 extra data item to <computeroutput>true</computeroutput> 308 before launching the VM. This can be set globally or on a 309 per VM basis. 380 Set the <literal>GUI/Dbg/Enabled</literal> extra data item 381 to <literal>true</literal> before launching the VM. This can 382 be set globally or on a per VM basis. 310 383 </para> 311 384 </listitem> … … 341 414 <listitem> 342 415 <para> 343 <computeroutput>stop</computeroutput>: Stops the VM 344 execution and enables single stepping 345 </para> 346 </listitem> 347 348 <listitem> 349 <para> 350 <computeroutput>g</computeroutput>: Continue VM execution 351 </para> 352 </listitem> 353 354 <listitem> 355 <para> 356 <computeroutput>t</computeroutput>: Single step an 357 instruction 358 </para> 359 </listitem> 360 361 <listitem> 362 <para> 363 <computeroutput>rg/rh/r</computeroutput>: Print the 364 guest/hypervisor/current registers 365 </para> 366 </listitem> 367 368 <listitem> 369 <para> 370 <computeroutput>kg/kh/k</computeroutput>: Print the 371 guest/hypervisor/current call stack 372 </para> 373 </listitem> 374 375 <listitem> 376 <para> 377 <computeroutput>da/db/dw/dd/dq</computeroutput>: Print 378 memory contents as ASCII/bytes/words/dwords/qwords 379 </para> 380 </listitem> 381 382 <listitem> 383 <para> 384 <computeroutput>u</computeroutput>: Unassemble memory 385 </para> 386 </listitem> 387 388 <listitem> 389 <para> 390 <computeroutput>dg</computeroutput>: Print the guest's GDT 391 </para> 392 </listitem> 393 394 <listitem> 395 <para> 396 <computeroutput>di</computeroutput>: Print the guest's IDT 397 </para> 398 </listitem> 399 400 <listitem> 401 <para> 402 <computeroutput>dl</computeroutput>: Print the guest's LDT 403 </para> 404 </listitem> 405 406 <listitem> 407 <para> 408 <computeroutput>dt</computeroutput>: Print the guest's TSS 409 </para> 410 </listitem> 411 412 <listitem> 413 <para> 414 <computeroutput>dp*</computeroutput>: Print the guest's page 415 table structures 416 </para> 417 </listitem> 418 419 <listitem> 420 <para> 421 <computeroutput>bp/br</computeroutput>: Set a 422 normal/recompiler breakpoint 423 </para> 424 </listitem> 425 426 <listitem> 427 <para> 428 <computeroutput>bl</computeroutput>: List breakpoints 429 </para> 430 </listitem> 431 432 <listitem> 433 <para> 434 <computeroutput>bc</computeroutput>: Clear a breakpoint 435 </para> 436 </listitem> 437 438 <listitem> 439 <para> 440 <computeroutput>writecore</computeroutput>: Write a VM core 441 file to disk. See <xref linkend="ts_guest-core-format" /> 416 <command>stop</command>: Stops the VM execution and enables 417 single stepping 418 </para> 419 </listitem> 420 421 <listitem> 422 <para> 423 <command>g</command>: Continue VM execution 424 </para> 425 </listitem> 426 427 <listitem> 428 <para> 429 <command>t</command>: Single step an instruction 430 </para> 431 </listitem> 432 433 <listitem> 434 <para> 435 <command>rg</command>, <command>rh</command>, and 436 <command>r</command>: Print the guest, hypervisor, and 437 current registers 438 </para> 439 </listitem> 440 441 <listitem> 442 <para> 443 <command>kg</command>, <command>kh</command>, and 444 <command>k</command>: Print the guest, hypervisor, and 445 current call stack 446 </para> 447 </listitem> 448 449 <listitem> 450 <para> 451 <command>da</command>, <command>db</command>, 452 <command>dw</command>, <command>dd</command>, 453 <command>dq</command>: Print memory contents as ASCII, 454 bytes, words, dwords, and qwords 455 </para> 456 </listitem> 457 458 <listitem> 459 <para> 460 <command>u</command>: Unassemble memory 461 </para> 462 </listitem> 463 464 <listitem> 465 <para> 466 <command>dg</command>: Print the guest's GDT 467 </para> 468 </listitem> 469 470 <listitem> 471 <para> 472 <command>di</command>: Print the guest's IDT 473 </para> 474 </listitem> 475 476 <listitem> 477 <para> 478 <command>dl</command>: Print the guest's LDT 479 </para> 480 </listitem> 481 482 <listitem> 483 <para> 484 <command>dt</command>: Print the guest's TSS 485 </para> 486 </listitem> 487 488 <listitem> 489 <para> 490 <command>dp*</command>: Print the guest's page table 491 structures 492 </para> 493 </listitem> 494 495 <listitem> 496 <para> 497 <command>bp</command> and <command>br</command>: Set a 498 normal and recompiler breakpoint 499 </para> 500 </listitem> 501 502 <listitem> 503 <para> 504 <command>bl</command>: List breakpoints 505 </para> 506 </listitem> 507 508 <listitem> 509 <para> 510 <command>bc</command>: Clear a breakpoint 511 </para> 512 </listitem> 513 514 <listitem> 515 <para> 516 <command>writecore</command>: Write a VM core file to disk. 517 See <xref linkend="ts_guest-core-format" /> 442 518 </para> 443 519 </listitem> … … 446 522 447 523 <para> 448 See the built-in <com puteroutput>help</computeroutput> for other449 availablecommands.524 See the built-in <command>help</command> for other available 525 commands. 450 526 </para> 451 527 … … 459 535 the guest OS version, but there are no symbols in the guest's 460 536 memory. Kernel symbols are available in the file 461 < computeroutput>/proc/kallsyms</computeroutput> on Linux guests.462 This filemust be copied to the host, for example using537 <filename>/proc/kallsyms</filename> on Linux guests. This file 538 must be copied to the host, for example using 463 539 <command>scp</command>. The <command>loadmap</command> debugger 464 540 command can be used to make the symbol information available to 465 the VM debugger. Note that the 466 <computeroutput>kallsyms</computeroutput> file contains the 467 symbols for the currently loaded modules. If the guest's 468 configuration changes, the symbols will change as well and must 469 be updated. 541 the VM debugger. Note that the <filename>kallsyms</filename> 542 file contains the symbols for the currently loaded modules. If 543 the guest's configuration changes, the symbols will change as 544 well and must be updated. 470 545 </para> 471 546 … … 494 569 <listitem> 495 570 <para> 496 <computeroutput>cfgm</computeroutput>: Print a branch of the 497 configuration tree 498 </para> 499 </listitem> 500 501 <listitem> 502 <para> 503 <computeroutput>cpuid</computeroutput>: Display the guest 504 CPUID leaves 505 </para> 506 </listitem> 507 508 <listitem> 509 <para> 510 <computeroutput>ioport</computeroutput>: Print registered 511 I/O port ranges 512 </para> 513 </listitem> 514 515 <listitem> 516 <para> 517 <computeroutput>mmio</computeroutput>: Print registered MMIO 518 ranges 519 </para> 520 </listitem> 521 522 <listitem> 523 <para> 524 <computeroutput>mode</computeroutput> -- print the current 525 paging mode 526 </para> 527 </listitem> 528 529 <listitem> 530 <para> 531 <computeroutput>pit</computeroutput>: Print the i8254 PIT 532 state 533 </para> 534 </listitem> 535 536 <listitem> 537 <para> 538 <computeroutput>pic</computeroutput>: Print the i8259A PIC 539 state 540 </para> 541 </listitem> 542 543 <listitem> 544 <para> 545 <computeroutput>ohci/ehci/xhci</computeroutput>: Print a 546 subset of the OHCI/EHCI/xHCI USB controller state 547 </para> 548 </listitem> 549 550 <listitem> 551 <para> 552 <computeroutput>pcnet0</computeroutput>: Print the PCnet 553 state 554 </para> 555 </listitem> 556 557 <listitem> 558 <para> 559 <computeroutput>vgatext</computeroutput>: Print the contents 560 of the VGA framebuffer formatted as standard text mode 561 </para> 562 </listitem> 563 564 <listitem> 565 <para> 566 <computeroutput>timers</computeroutput>: Print all VM timers 571 <command>cfgm</command>: Print a branch of the configuration 572 tree 573 </para> 574 </listitem> 575 576 <listitem> 577 <para> 578 <command>cpuid</command>: Display the guest CPUID leaves 579 </para> 580 </listitem> 581 582 <listitem> 583 <para> 584 <command>ioport</command>: Print registered I/O port ranges 585 </para> 586 </listitem> 587 588 <listitem> 589 <para> 590 <command>mmio</command>: Print registered MMIO ranges 591 </para> 592 </listitem> 593 594 <listitem> 595 <para> 596 <command>mode</command>: Print the current paging mode 597 </para> 598 </listitem> 599 600 <listitem> 601 <para> 602 <command>pit</command>: Print the i8254 PIT state 603 </para> 604 </listitem> 605 606 <listitem> 607 <para> 608 <command>pic</command>: Print the i8259A PIC state 609 </para> 610 </listitem> 611 612 <listitem> 613 <para> 614 <command>ohci</command>, <command>ehci</command>, 615 <command>xhci</command>: Print a subset of the OHCI, EHCI, 616 and xHCI USB controller state 617 </para> 618 </listitem> 619 620 <listitem> 621 <para> 622 <command>pcnet0</command>: Print the PCnet state 623 </para> 624 </listitem> 625 626 <listitem> 627 <para> 628 <command>vgatext</command>: Print the contents of the VGA 629 framebuffer formatted as standard text mode 630 </para> 631 </listitem> 632 633 <listitem> 634 <para> 635 <command>timers</command>: Print all VM timers 567 636 </para> 568 637 </listitem> … … 593 662 594 663 <para> 595 <ulink 596 url="http://downloads.openwatcom.org/ftp/devel/docs/elf-64-gen.pdf">http://downloads.openwatcom.org/ftp/devel/docs/elf-64-gen.pdf</ulink>. 664 <ulink url="http://downloads.openwatcom.org/ftp/devel/docs/elf-64-gen.pdf" />. 597 665 </para> 598 666 … … 628 696 The relevant data structures and definitions can be found in the 629 697 &product-name; sources under the following header files: 630 < computeroutput>include/VBox/dbgfcorefmt.h</computeroutput>,631 < computeroutput>include/iprt/x86.h</computeroutput> and632 < computeroutput>src/VBox/Runtime/include/internal/ldrELFCommon.h</computeroutput>.698 <filename>include/VBox/dbgfcorefmt.h</filename>, 699 <filename>include/iprt/x86.h</filename> and 700 <filename>src/VBox/Runtime/include/internal/ldrELFCommon.h</filename>. 633 701 </para> 634 702 635 703 <para> 636 704 The VM core file can be inspected using 637 <computeroutput>elfdump</computeroutput> and GNU 638 <computeroutput>readelf</computeroutput> or other similar 639 utilities. 705 <command>elfdump</command> and GNU <command>readelf</command> or 706 other similar utilities. 640 707 </para> 641 708 … … 684 751 </para> 685 752 686 <screen>VBoxManage setextradata "VM name"687 "VBoxInternal/Devices/piix3ide/0/LUN#[ x]/Config/FlushInterval" [b]</screen>753 <screen>VBoxManage setextradata <replaceable>VM-name</replaceable> 754 "VBoxInternal/Devices/piix3ide/0/LUN#[<replaceable>x</replaceable>]/Config/FlushInterval" [<replaceable>b</replaceable>]</screen> 688 755 689 756 <para> … … 691 758 </para> 692 759 693 <screen>VBoxManage setextradata "VM name" 694 "VBoxInternal/Devices/ahci/0/LUN#[x]/Config/FlushInterval" [b]</screen> 695 696 <para> 697 The value [x] that selects the disk for IDE is 0 for the master 698 device on the first channel, 1 for the slave device on the first 699 channel, 2 for the master device on the second channel or 3 for 700 the slave device on the second channel. For SATA use values 701 between 0 and 29. Only disks support this configuration option; 702 it must not be set for CD/DVD drives. 703 </para> 704 705 <para> 706 The unit of the interval [b] is the number of bytes written 707 since the last flush. The value for it must be selected so that 708 the occasional long write delays do not occur. Since the proper 709 flush interval depends on the performance of the host and the 710 host filesystem, finding the optimal value that makes the 711 problem disappear requires some experimentation. Values between 712 1000000 and 10000000 (1 to 10 megabytes) are a good starting 713 point. Decreasing the interval both decreases the probability of 714 the problem and the write performance of the guest. Setting the 715 value unnecessarily low will cost performance without providing 716 any benefits. An interval of 1 will cause a flush for each write 717 operation and should solve the problem in any case, but has a 718 severe write performance penalty. 719 </para> 720 721 <para> 722 Providing a value of 0 for [b] is treated as an infinite flush 723 interval, effectively disabling this workaround. Removing the 724 extra data key by specifying no value for [b] has the same 725 effect. 760 <screen>VBoxManage setextradata <replaceable>VM-name</replaceable> 761 "VBoxInternal/Devices/ahci/0/LUN#[<replaceable>x</replaceable>]/Config/FlushInterval" [<replaceable>b</replaceable>]</screen> 762 763 <para> 764 <literal>[<replaceable>x</replaceable>]</literal> specifies the 765 disk for IDE. <literal>0</literal> represents the master device 766 on the first channel, <literal>1</literal> represents the slave 767 device on the first channel, <literal>2</literal> represents the 768 master device on the second channel, and <literal>3</literal> 769 represents the slave device on the second channel. For SATA, use 770 values between <literal>0</literal> and <literal>29</literal>. 771 This configuration option applies to disks only. Do not use this 772 option for CD or DVD drives. 773 </para> 774 775 <para> 776 The unit of the interval 777 (<literal>[<replaceable>b</replaceable>]</literal>) is the 778 number of bytes written since the last flush. The value for it 779 must be selected so that the occasional long write delays do not 780 occur. Since the proper flush interval depends on the 781 performance of the host and the host filesystem, finding the 782 optimal value that makes the problem disappear requires some 783 experimentation. Values between 1000000 and 10000000 (1 to 10 784 megabytes) are a good starting point. Decreasing the interval 785 both decreases the probability of the problem and the write 786 performance of the guest. Setting the value unnecessarily low 787 will cost performance without providing any benefits. An 788 interval of 1 will cause a flush for each write operation and 789 should solve the problem in any case, but has a severe write 790 performance penalty. 791 </para> 792 793 <para> 794 Providing a value of <literal>0</literal> for 795 <literal>[<replaceable>b</replaceable>]</literal> is treated as 796 an infinite flush interval, effectively disabling this 797 workaround. Removing the extra data key by specifying no value 798 for <literal>[<replaceable>b</replaceable>]</literal> has the 799 same effect. 726 800 </para> 727 801 … … 744 818 </para> 745 819 746 <screen>VBoxManage setextradata "VM name" "VBoxInternal/Devices/piix3ide/0/LUN#[x]/Config/IgnoreFlush" 0</screen> 747 748 <para> 749 The value [x] that selects the disk is 0 for the master device 750 on the first channel, 1 for the slave device on the first 751 channel, 2 for the master device on the second channel or 3 for 752 the master device on the second channel. 820 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxInternal/Devices/piix3ide/0/LUN#[<replaceable>x</replaceable>]/Config/IgnoreFlush" 0</screen> 821 822 <para> 823 <literal>[<replaceable>x</replaceable>]</literal> specifies the 824 disk. is 0 for the master device on the first channel, 1 for the 825 slave device on the first channel, 2 for the master device on 826 the second channel or 3 for the master device on the second 827 channel. 753 828 </para> 754 829 … … 757 832 </para> 758 833 759 <screen> VBoxManage setextradata "VM name""VBoxInternal/Devices/ahci/0/LUN#[x]/Config/IgnoreFlush" 0</screen>834 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxInternal/Devices/ahci/0/LUN#[x]/Config/IgnoreFlush" 0</screen> 760 835 761 836 <para> … … 767 842 Note that this does not affect the flushes performed according 768 843 to the configuration described in 769 <xref linkend="ts_config-periodic-flush" 770 xrefstyle="template: %n" />. 771 Restoring the default of ignoring flush commands is possible by 772 setting the value to 1 or by removing the key. 844 <xref linkend="ts_config-periodic-flush"/>. Restoring the 845 default of ignoring flush commands is possible by setting the 846 value to 1 or by removing the key. 773 847 </para> 774 848 … … 780 854 781 855 <para> 782 Many newer multi-core processors support some form of frequency856 Many multicore processors support some form of frequency 783 857 boosting, which means that if only one core is utilized, it can 784 858 run possibly 50% faster or even more than the rated CPU … … 807 881 scaling may cause CPU usage reporting to be highly misleading. 808 882 This happens in situations when the host CPU load is significant 809 but not heavy, such as 15-30% of the maximum.883 but not heavy, such as between 15% to 30% of the maximum. 810 884 </para> 811 885 … … 814 888 spent, measuring for example how many nanoseconds the systems or 815 889 a process was active within one second. However, in order to 816 save energy, modern systems can significantly scale down CPU817 speed when the system is not fully loaded. Naturally, when the818 CPU is running at for example one half of its maximum speed, the819 same number of instructions will take roughly twice as long to820 execute comparedto running at full speed.890 save energy, systems can significantly scale down CPU speed when 891 the system is not fully loaded. When the CPU is running at for 892 example one half of its maximum speed, the same number of 893 instructions will take roughly twice as long to execute compared 894 to running at full speed. 821 895 </para> 822 896 … … 872 946 support in the system's BIOS should be disabled, if such a 873 947 setting is available. Not all systems support the C1E power 874 state. On Intel systems, the < computeroutput>Intel C875 State</computeroutput> setting should be disabled. Disabling876 other power management settings may also improve performance.877 However, a balance between performance and power consumption878 must always beconsidered.948 state. On Intel systems, the <literal>Intel C State</literal> 949 setting should be disabled. Disabling other power management 950 settings may also improve performance. However, a balance 951 between performance and power consumption must always be 952 considered. 879 953 </para> 880 954 … … 897 971 </para> 898 972 899 <screen> VBoxTestOGL --log "log_file_name" --test 2D</screen>973 <screen>$ VBoxTestOGL --log "log_file_name" --test 2D</screen> 900 974 901 975 <para> … … 979 1053 Changing the storage controller hardware will cause bootup 980 1054 failures as well. This might also apply to you if you copy a 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. 1055 disk image from an older version of &product-name; to a new 1056 virtual machine. The default subtype of IDE controller 1057 hardware used by &product-name; is PIIX4. Make sure that the 1058 storage controller settings are identical. 986 1059 </para> 987 1060 </listitem> … … 1005 1078 <para> 1006 1079 According to Microsoft, this is due to a race condition in 1007 Windows. A hotfix is available. See 1008 <ulink 1009 url="http://support.microsoft.com/kb/955076">http://support.microsoft.com/kb/955076</ulink>. 1080 Windows. A hotfix is available from Microsoft. 1010 1081 </para> 1011 1082 … … 1043 1114 <para> 1044 1115 Installation complains about a failure installing 1045 < computeroutput>msgina.dll</computeroutput>.1116 <filename>msgina.dll</filename>. 1046 1117 </para> 1047 1118 </listitem> … … 1066 1137 </para> 1067 1138 1068 <screen> VBoxManage setextradata "VM name""VBoxInternal/Devices/piix3ide/0/Config/IRQDelay" 1</screen>1139 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxInternal/Devices/piix3ide/0/Config/IRQDelay" 1</screen> 1069 1140 1070 1141 <para> … … 1083 1154 1084 1155 <para> 1085 When Windows guests run into a kernel crash, they display the1086 infamous bluescreen. Depending on how Windows is configured, the1156 When Windows guests run into a kernel crash, they display a 1157 bluescreen error. Depending on how Windows is configured, the 1087 1158 information will remain on the screen until the machine is 1088 1159 restarted or it will reboot automatically. During installation, … … 1098 1169 </para> 1099 1170 1100 <screen>VBoxManage setextradata "VM name" "VBoxInternal/PDM/HaltOnReset" 1</screen> 1101 1102 </sect2> 1103 1104 <sect2 id="ts_pcnet-driver-win-2003-server-guest"> 1105 1106 <title>PCnet Driver Failure in 32-bit Windows Server 2003 Guests</title> 1107 1108 <para> 1109 Certain editions of Windows 2000 and 2003 servers support more 1110 than 4 GB RAM on 32-bit systems. The AMD PCnet network driver 1111 shipped with Windows Server 2003 fails to load if the 32-bit 1112 guest OS uses paging extensions, which will occur with more than 1113 approximately 3.5 GB RAM assigned to the VM. 1114 </para> 1115 1116 <para> 1117 This problem is known to occur with version 4.38.0.0 of the 1118 PCnet driver. The issue was fixed in version 4.51.0.0 of the 1119 driver, which is available as a separate download. An 1120 alternative solution may be changing the emulated NIC type to 1121 Intel PRO/1000 MT Desktop (82540EM), or reducing the RAM 1122 assigned to the VM to approximately 3.5 GB or less. 1123 </para> 1171 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxInternal/PDM/HaltOnReset" 1</screen> 1124 1172 1125 1173 </sect2> … … 1131 1179 <para> 1132 1180 With Windows Vista, Microsoft dropped support for the AMD PCNet 1133 card that &product-name; used to provide as the default virtual1134 network card before version 1.6.0. For Windows Vista guests,1181 card that legacy versions of &product-name; used to provide as 1182 the default virtual network card. For Windows Vista guests, 1135 1183 &product-name; now uses an Intel E1000 card by default. 1136 1184 </para> … … 1152 1200 <para> 1153 1201 Several background applications of Windows guests, especially 1154 virus scanners, are known to increase sthe CPU load notably even1202 virus scanners, are known to increase the CPU load notably even 1155 1203 if the guest appears to be idle. We recommend to deactivate 1156 1204 virus scanners within virtualized guests if possible. … … 1168 1216 the &product-name; shared folders name service. To fix these 1169 1217 delays, add the following entries to the file 1170 < computeroutput>\windows\system32\drivers\etc\lmhosts</computeroutput>1171 ofthe Windows guest:1218 <filename>\windows\system32\drivers\etc\lmhosts</filename> of 1219 the Windows guest: 1172 1220 </para> 1173 1221 … … 1194 1242 <para> 1195 1243 The USB HID (Human Interface Device) drivers in Windows 98 are 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 1244 very old and do not handle tablets in the same way as modern 1245 operating systems do. To work around the problem, use the 1199 1246 following command: 1200 1247 </para> 1201 1248 1202 <screen> VBoxManage setextradata "VM name""VBoxInternal/USB/HidMouse/0/Config/CoordShift" 0</screen>1249 <screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxInternal/USB/HidMouse/0/Config/CoordShift" 0</screen> 1203 1250 1204 1251 <para> … … 1216 1263 <para> 1217 1264 If a Windows guest is a member of an Active Directory domain and 1218 the snapshot feature of &product-name; is used, it could happen 1219 it loses this status after you restore an older snapshot. 1220 </para> 1221 1222 <para> 1223 The reason is the automatic machine password changing performed 1265 the snapshot feature of &product-name; is used, it could be 1266 removed from the Active Direcory domain after you restore an 1267 older snapshot. 1268 </para> 1269 1270 <para> 1271 This is caused by automatic machine password changes performed 1224 1272 by Windows at regular intervals for security purposes. You can 1225 disable this feature by following the instruction of the 1226 following article from Microsoft: 1227 <ulink 1228 url="http://support.microsoft.com/kb/154501">http://support.microsoft.com/kb/154501</ulink> 1229 </para> 1230 1231 </sect2> 1232 1233 <sect2 id="ts_d3d8-d3d9-restore"> 1234 1235 <title>Restoring d3d8.dll and d3d9.dll</title> 1236 1237 <para> 1238 &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 1255 expected. 1256 </para> 1257 1258 <para> 1259 For WDDM Direct3D support however, the originally shipped 1260 d3d8.dll and d3d9.dll files are required in order to run 1261 Direct3D 8.0 and Direct3D 9.0 applications. As a result of the 1262 above mentioned system files corruption these applications will 1263 not work anymore. See below for a step-by-step guide for 1264 restoring the original d3d8.dll and d3d9.dll system files in 1265 case the &product-name; Guest Additions installer warned about 1266 those incorrect files or when having trouble running Direct3D 1267 applications. 1268 </para> 1269 1270 <note> 1271 <para> 1272 Starting at Windows 7 the 3D desktop, called Aero, uses 1273 DirectX 10 for rendering so that corrupted d3d8.dll and 1274 d3d9.dll system files will have no effect on the actual 1275 rendering. 1276 </para> 1277 </note> 1278 1279 <para> 1280 This is why such a detected file corruption is not considered as 1281 fatal for the basic Direct3D installation on all supported 1282 Windows guests, and for WDDM Direct3D installation on Windows 7 1283 and later guests. 1284 </para> 1285 1286 <para> 1287 <emphasis role="bold">Extracting d3d8 and d3d9.dll from a 1288 Windows XP installation CD:</emphasis> 1289 </para> 1290 1291 <orderedlist> 1292 1293 <listitem> 1294 <para> 1295 Download and install the latest version of 7-Zip File 1296 Manager. 1297 </para> 1298 </listitem> 1299 1300 <listitem> 1301 <para> 1302 Browse into the installation CD. For example E:\i386, or 1303 E:\amd64 for the 64-bit version. 1304 </para> 1305 </listitem> 1306 1307 <listitem> 1308 <para> 1309 Locate the entries d3d8.dl_ and d3d9.dl_. Double-click on 1310 the file names and extract d3d8.dll and d3d9.dll. 1311 </para> 1312 </listitem> 1313 1314 <listitem> 1315 <para> 1316 Reboot Windows in Safe mode. 1317 </para> 1318 </listitem> 1319 1320 <listitem> 1321 <para> 1322 Copy the extracted d3d8.dll and d3d9.dll files to 1323 C:\Windows\system32 and C:\Windows\system32\dllcache. 1324 </para> 1325 </listitem> 1326 1327 <listitem> 1328 <para> 1329 Reboot Windows. 1330 </para> 1331 </listitem> 1332 1333 </orderedlist> 1334 1335 <para> 1336 <emphasis role="bold">Extracting d3d8 and d3d9.dll from a 1337 Windows XP Service pack:</emphasis> 1338 </para> 1339 1340 <orderedlist> 1341 1342 <listitem> 1343 <para> 1344 Download and install the latest version of 7-Zip File 1345 Manager. 1346 </para> 1347 </listitem> 1348 1349 <listitem> 1350 <para> 1351 Choose Open Inside, to open WindowsXP-KB936929-SP3-x86.exe 1352 as an archive and browse the i386 directory. 1353 </para> 1354 </listitem> 1355 1356 <listitem> 1357 <para> 1358 Locate the entries d3d8.dl_ and d3d9.dl_. Double-click on 1359 the file names and extract d3d8.dll and d3d9.dll. 1360 </para> 1361 </listitem> 1362 1363 <listitem> 1364 <para> 1365 Reboot Windows in Safe mode. 1366 </para> 1367 </listitem> 1368 1369 <listitem> 1370 <para> 1371 Copy the extracted d3d8.dll and d3d9.dll files to 1372 C:\Windows\system32 and C:\Windows\system32\dllcache. 1373 </para> 1374 </listitem> 1375 1376 <listitem> 1377 <para> 1378 Reboot Windows. 1379 </para> 1380 </listitem> 1381 1382 </orderedlist> 1383 1384 <para> 1385 <emphasis role="bold">Extracting d3d8 and d3d9.dll from a 1386 Vista/Windows7 installation CD or Service Pack ISO:</emphasis> 1387 </para> 1388 1389 <orderedlist> 1390 1391 <listitem> 1392 <para> 1393 Download and install the latest version of 7-Zip File 1394 Manager. 1395 </para> 1396 </listitem> 1397 1398 <listitem> 1399 <para> 1400 Browse into the installation CD. For example E:\sources. 1401 </para> 1402 </listitem> 1403 1404 <listitem> 1405 <para> 1406 Locate file install.wim and double-click the file. After the 1407 7-Zip utility unzips the file, you will see a few numbered 1408 folders. Each numeric subfolder represents a different 1409 version of Windows such as Starter or Home Basic. 1410 </para> 1411 </listitem> 1412 1413 <listitem> 1414 <para> 1415 Open one of the numeric folders and browse to the 1416 Windows\System32 directory, or C:\Windows\SysWOW64 for the 1417 64-bit version. Locate and extract the d3d8.dll and d3d9.dll 1418 files. 1419 </para> 1420 </listitem> 1421 1422 <listitem> 1423 <para> 1424 Copy extracted the d3d8.dll and d3d9.dll files to 1425 C:\Windows\system32 or C:\Windows\SysWOW64. Files from 1426 system32 should go to system32, from SysWOW64 to SysWOW64. 1427 </para> 1428 </listitem> 1429 1430 <listitem> 1431 <para> 1432 Reboot Windows. 1433 </para> 1434 </listitem> 1435 1436 </orderedlist> 1273 disable this feature as shown in the following article from 1274 Microsoft: 1275 <ulink url="http://support.microsoft.com/kb/154501" />. 1276 </para> 1437 1277 1438 1278 </sect2> … … 1452 1292 1453 1293 <para> 1454 This is a HIMEM.SYS limitation documented by Microsoft in 1455 Knowledge base article KB 116256. Windows 3.1 memory limits are 1456 described in detail in Microsoft Knowledge base article KB 1294 This is a known HIMEM.SYS limitation. Windows 3.1 memory limits 1295 are described in detail in Microsoft Knowledge base article KB 1457 1296 84388. 1458 1297 </para> … … 1487 1326 1488 1327 <para> 1489 Linux kernels shipped with Red Hat Enterprise Linux (RHEL) as of 1490 release 4.7 and 5.1 as well as kernels of related Linux 1491 distributions, such as CentOS and Oracle Linux, support a kernel 1492 parameter <emphasis>divider=N</emphasis>. Hence, such kernels 1493 support a lower timer frequency without recompilation. We 1494 suggest you add the kernel parameter 1495 <emphasis>divider=10</emphasis> to select a guest kernel timer 1496 frequency of 100Hz. 1497 </para> 1498 1499 </sect2> 1500 1501 <sect2 id="ts_linux-guest-amd-barcelona"> 1502 1503 <title>AMD Barcelona CPUs</title> 1504 1505 <para> 1506 Most Linux-based guests will fail with AMD Phenoms or 1507 Barcelona-level Opterons due to a bug in the Linux kernel. 1508 Enable the I/O-APIC to work around the problem. See 1509 <xref 1510 linkend="settings-system" />. 1328 Linux kernels shipped with Red Hat Enterprise Linux, as well as 1329 kernels of related Linux distributions, such as CentOS and 1330 Oracle Linux, support a kernel parameter 1331 <emphasis>divider=N</emphasis>. Hence, such kernels support a 1332 lower timer frequency without recompilation. We suggest you add 1333 the kernel parameter <emphasis>divider=10</emphasis> to select a 1334 guest kernel timer frequency of 100Hz. 1511 1335 </para> 1512 1336 … … 1545 1369 If you see this message, either disable hardware 1546 1370 virtualization or the I/O APIC as described in 1547 <xref 1548 linkend="settings-system" />, or upgrade 1549 the guest to a newer kernel. 1371 <xref linkend="settings-system" />, or upgrade the guest to 1372 a newer kernel. 1550 1373 </para> 1551 1374 1552 1375 <para> 1553 1376 See 1554 <ulink 1555 url="http://www.mail-archive.com/[email protected]/msg30813.html">http://www.mail-archive.com/[email protected]/msg30813.html</ulink> 1377 <ulink url="http://www.mail-archive.com/[email protected]/msg30813.html" /> 1556 1378 for details about the kernel fix. 1557 1379 </para> … … 1569 1391 Guest desktop services in guests running the X11 window system 1570 1392 such as Oracle Solaris and Linux, are provided by a guest 1571 service called <com puteroutput>VBoxClient</computeroutput>,1572 which runs under the ID of the user who started the desktop1573 session and is automatically started using the following command1574 lines when your X11 user session is started if you are using a1575 commondesktop environment such as Gnome or KDE.1576 </para> 1577 1578 <screen> VBoxClient --clipboard1579 VBoxClient --display1580 VBoxClient --seamless</screen>1393 service called <command>VBoxClient</command>, which runs under 1394 the ID of the user who started the desktop session and is 1395 automatically started using the following command lines when 1396 your X11 user session is started if you are using a common 1397 desktop environment such as Gnome or KDE. 1398 </para> 1399 1400 <screen>$ VBoxClient --clipboard 1401 $ VBoxClient --display 1402 $ VBoxClient --seamless</screen> 1581 1403 1582 1404 <para> … … 1587 1409 1588 1410 <para> 1589 The <com puteroutput>VBoxClient</computeroutput> processes create1590 files in theuser's home directory with names of the form1591 < computeroutput>.vboxclient-*.pid</computeroutput> when they are1592 running in order to prevent a given service from being started1593 twice. It can happen due to misconfiguration that these files1594 are created owned by root and not deleted when the services are1595 stopped, which will prevent them from being started in future1596 sessions. If the services cannot be started, you may wish to1597 check whetherthese files still exist.1411 The <command>VBoxClient</command> processes create files in the 1412 user's home directory with names of the form 1413 <filename>.vboxclient-*.pid</filename> when they are running in 1414 order to prevent a given service from being started twice. It 1415 can happen due to misconfiguration that these files are created 1416 owned by root and not deleted when the services are stopped, 1417 which will prevent them from being started in future sessions. 1418 If the services cannot be started, you may wish to check whether 1419 these files still exist. 1598 1420 </para> 1599 1421 … … 1606 1428 <title>Oracle Solaris Guests</title> 1607 1429 1608 <sect2 id="ts_solaris-10-guest-crash">1609 1610 <title>Older Oracle Solaris 10 Releases Crash in 64-bit Mode</title>1611 1612 <para>1613 Oracle Solaris 10 releases up to and including Oracle Solaris 101614 8/07 incorrectly detect newer Intel processors produced since1615 2007. This problem leads to the 64-bit Oracle Solaris kernel1616 crashing, and usually causing a triple fault, almost immediately1617 during startup, in both virtualized and physical environments.1618 </para>1619 1620 <para>1621 The recommended solution is upgrading to at least Oracle Solaris1622 10 5/08. Alternative solutions include forcing Oracle Solaris to1623 always boot the 32-bit kernel or applying a patch for bug1624 6574102 while Oracle Solaris is using the 32-bit kernel.1625 </para>1626 1627 </sect2>1628 1629 1430 <sect2 id="ts_solaris-10-guest-slow-boot-smp"> 1630 1431 … … 1632 1433 1633 1434 <para> 1634 When using more than one CPU, Oracle Solaris 10 5/08, Oracle 1635 Solaris 10 10/08, and Oracle Solaris 10 5/09 may take a long 1636 time to boot and may print warnings on the system console 1637 regarding failures to read from disk. This is a bug in Oracle 1638 Solaris 10 which affects specific physical and virtual 1639 configurations. It is caused by trying to read microcode updates 1640 from the boot disk when the disk interrupt is reassigned to a 1641 not yet fully initialized secondary CPU. Disk reads will time 1642 out and fail, triggering delays of about 45 seconds and 1643 warnings. 1435 When using more than one CPU, Oracle Solaris 10 10/08, and 1436 Oracle Solaris 10 5/09 may take a long time to boot and may 1437 print warnings on the system console regarding failures to read 1438 from disk. This is a bug in Oracle Solaris 10 which affects 1439 specific physical and virtual configurations. It is caused by 1440 trying to read microcode updates from the boot disk when the 1441 disk interrupt is reassigned to a not yet fully initialized 1442 secondary CPU. Disk reads will time out and fail, triggering 1443 delays of about 45 seconds and warnings. 1644 1444 </para> 1645 1445 … … 1649 1449 solutions include restricting the number of virtual CPUs to one 1650 1450 or possibly using a different storage controller. 1651 </para>1652 1653 </sect2>1654 1655 <sect2 id="ts_solaris-8-guest-crash">1656 1657 <title>Solaris 8 5/01 and Earlier May Crash on Startup</title>1658 1659 <para>1660 Solaris 2.6, 7 and 8 releases up to and including Solaris 8 4/011661 ("S8U4") incorrectly set up Machine Check Exception (MCE) MSRs1662 on Pentium 4 and some later Intel CPUs. The problem leads to the1663 Solaris kernel crashing, and usually causing a triple fault,1664 almost immediately during startup, in both virtualized and1665 physical environments. Solaris 9 and later releases are not1666 affected by this problem, and neither is Solaris 2.5.1 and1667 earlier.1668 </para>1669 1670 <para>1671 The recommended solution is upgrading to at least Solaris 8 7/011672 ("S8U5"). Alternative solutions include applying a patch for1673 bugs 4408508 and 4414557 on an unaffected system.1674 </para>1675 1676 </sect2>1677 1678 </sect1>1679 1680 <sect1 id="ts_fbsd-guests">1681 1682 <title>FreeBSD Guests</title>1683 1684 <sect2 id="ts_fbsd-guest-xhci">1685 1686 <title>FreeBSD 10.0 May Hang with xHCI</title>1687 1688 <para>1689 If xHCI (USB 3.0) emulation is enabled for FreeBSD 10.0 guests,1690 the guest OS will hang. This is caused by the guest OS1691 incorrectly handling systems where Message Signaled Interrupts1692 (MSIs) are not used with the xHCI device.1693 </para>1694 1695 <para>1696 The problem does not exist in earlier FreeBSD releases and was1697 fixed in FreeBSD 10.1.1698 1451 </para> 1699 1452 … … 1717 1470 interface options based on a common architecture. All global 1718 1471 status information and configuration is maintained by the 1719 process < computeroutput>VBoxSVC.exe</computeroutput>, which is1720 an out-of-process COM server. Whenever an &product-name; process1721 isstarted, it requests access to the COM server and Windows1472 process <filename>VBoxSVC.exe</filename>, which is an 1473 out-of-process COM server. Whenever an &product-name; process is 1474 started, it requests access to the COM server and Windows 1722 1475 automatically starts the process. Note that it should never be 1723 1476 started by the end user. … … 1727 1480 When the last process disconnects from the COM server, it will 1728 1481 terminate itself after some seconds. The &product-name; 1729 configuration (XML files) ismaintained and owned by the COM1482 configuration XML files are maintained and owned by the COM 1730 1483 server and the files are locked whenever the server runs. 1731 1484 </para> … … 1739 1492 subsequently other processes fail to initialize it. In these 1740 1493 situations, it is recommended to use the Windows task manager to 1741 kill the process < computeroutput>VBoxSVC.exe</computeroutput>.1494 kill the process <filename>VBoxSVC.exe</filename>. 1742 1495 </para> 1743 1496 … … 1746 1499 <sect2 id="ts_win-host-cd-dvd-changes"> 1747 1500 1748 <title>CD /DVD Changes Not Recognized</title>1749 1750 <para> 1751 In case you have assigned a physical CD /DVD drive to a guest and1752 the guest does not notice when the medium changes, make sure1501 <title>CD and DVD Changes Not Recognized</title> 1502 1503 <para> 1504 In case you have assigned a physical CD or DVD drive to a guest 1505 and the guest does not notice when the medium changes, make sure 1753 1506 that the Windows media change notification (MCN) feature is not 1754 1507 turned off. This is represented by the following key in the … … 1819 1572 1820 1573 <para> 1821 Setting the environment variable1822 <computeroutput>VBOX_DISABLE_HOST_DISK_CACHE</computeroutput> to1823 1 will enable a workaround for this problem until Microsoft1824 addresses the issue. For example, open a command prompt window1825 and start&product-name; like this:1574 Setting the <literal>VBOX_DISABLE_HOST_DISK_CACHE</literal> 1575 environment variable to <literal>1</literal> enables a 1576 workaround for this problem until Microsoft addresses the issue. 1577 For example, open a command prompt window and start 1578 &product-name; like this: 1826 1579 </para> 1827 1580 … … 1855 1608 The maximum allowed filter count was reached on the host. In 1856 1609 this case, the MSI log would mention the 1857 < computeroutput>0x8004a029</computeroutput> error code1858 returned on NetFltnetwork component install, as follows:1610 <literal>0x8004a029</literal> error code returned on NetFlt 1611 network component install, as follows: 1859 1612 </para> 1860 1613 … … 1876 1629 <listitem> 1877 1630 <para> 1878 The INF cache is corrupt. In this case, the install log 1879 (<computeroutput>%windir%\inf\setupapi.log</computeroutput> 1880 on XP or 1881 <computeroutput>%windir%\inf\setupapi.dev.log</computeroutput> 1882 on Vista or later) would typically mention the failure to 1883 find a suitable driver package for either the 1884 <computeroutput>sun_VBoxNetFlt</computeroutput> or 1885 <computeroutput>sun_VBoxNetFltmp</computeroutput> 1886 components. The solution then is to uninstall 1887 &product-name;, remove the INF cache 1888 (<computeroutput>%windir%\inf\INFCACHE.1</computeroutput>), 1889 reboot and try to reinstall &product-name;. 1631 The INF cache is corrupt. In this case, the install log at 1632 <filename>%windir%\inf\setupapi.dev.log</filename> would 1633 typically mention the failure to find a suitable driver 1634 package for either the <command>sun_VBoxNetFlt</command> or 1635 <command>sun_VBoxNetFltmp</command> components. The solution 1636 then is to uninstall &product-name;, remove the INF cache 1637 (<filename>%windir%\inf\INFCACHE.1</filename>), reboot and 1638 try to reinstall &product-name;. 1890 1639 </para> 1891 1640 </listitem> … … 1903 1652 VirtualBox Manager or the <command>VBoxManage</command> command, 1904 1653 then the INF cache is probably corrupt. In this case, the 1905 install log 1906 (<computeroutput>%windir%\inf\setupapi.log</computeroutput> on 1907 Windows XP or 1908 <computeroutput>%windir%\inf\setupapi.dev.log</computeroutput> 1909 on Windows Vista or later) would typically mention the failure 1910 to find a suitable driver package for the 1911 <computeroutput>sun_VBoxNetAdp</computeroutput> component. 1912 Again, as with the bridged networking problem described above, 1913 the solution is to uninstall &product-name;, remove the INF 1914 cache 1915 (<computeroutput>%windir%\inf\INFCACHE.1</computeroutput>), 1916 reboot and try to reinstall &product-name;. 1654 install log at 1655 <filename>%windir%\inf\setupapi.dev.log</filename> would 1656 typically mention the failure to find a suitable driver package 1657 for the <filename>sun_VBoxNetAdp</filename> component. Again, as 1658 with the bridged networking problem described above, the 1659 solution is to uninstall &product-name;, remove the INF cache 1660 (<filename>%windir%\inf\INFCACHE.1</filename>), reboot and try 1661 to reinstall &product-name;. 1917 1662 </para> 1918 1663 … … 1930 1675 1931 1676 <para> 1932 If the &product-name; kernel module, 1933 <computeroutput>vboxdrv</computeroutput>, refuses to load you1934 may see an "Error inserting vboxdrv: Invalid argument" message.1935 As root, check the output of the <command>dmesg</command>1936 command to find out why the load failed. Most probably the1937 kernel disagrees with the version of <command>gcc</command> used1938 t o compile the module. Make sure that you use the same compiler1939 as used to build thekernel.1677 If the &product-name; kernel module, <command>vboxdrv</command>, 1678 refuses to load you may see an <literal>Error inserting vboxdrv: 1679 Invalid argument</literal> message. As root, check the output of 1680 the <command>dmesg</command> command to find out why the load 1681 failed. Most probably the kernel disagrees with the version of 1682 <command>gcc</command> used to compile the module. Make sure 1683 that you use the same compiler that was used to build the 1684 kernel. 1940 1685 </para> 1941 1686 … … 1944 1689 <sect2 id="ts_linux-host-cd-dvd-not-found"> 1945 1690 1946 <title>Linux Host CD/DVD Drive Not Found</title> 1947 1948 <para> 1949 If you have configured a virtual machine to use the host's 1950 CD/DVD drive, but this does not appear to work, make sure that 1951 the current user has permission to access the corresponding 1952 Linux device file. This is 1953 <computeroutput>/dev/hdc</computeroutput>, 1954 <computeroutput>/dev/scd0</computeroutput>, 1955 <computeroutput>/dev/cdrom</computeroutput> or similar. On most 1956 distributions, the user must be added to a corresponding group, 1957 usually called <computeroutput>cdrom</computeroutput> or 1958 <computeroutput>cdrw</computeroutput>. 1959 </para> 1960 1961 </sect2> 1962 1963 <sect2 id="ts_linux-host-cd-dvd-not-found-legacy"> 1964 1965 <title>Linux Host CD/DVD Drive Not Found (Older Distributions)</title> 1966 1967 <para> 1968 On older Linux distributions, if your CD/DVD device has a 1969 different name, &product-name; may be unable to find it. On 1970 older Linux hosts, &product-name; performs the following steps 1971 to locate your CD/DVD drives: 1972 </para> 1973 1974 <orderedlist> 1975 1976 <listitem> 1977 <para> 1978 &product-name; checks if the environment variable 1979 <computeroutput>VBOX_CDROM</computeroutput> is defined. If 1980 so, &product-name; omits all the following checks. 1981 </para> 1982 </listitem> 1983 1984 <listitem> 1985 <para> 1986 &product-name; tests if 1987 <computeroutput>/dev/cdrom</computeroutput> works. 1988 </para> 1989 </listitem> 1990 1991 <listitem> 1992 <para> 1993 &product-name; checks if any CD/DVD drives are currently 1994 mounted by checking 1995 <computeroutput>/etc/mtab</computeroutput>. 1996 </para> 1997 </listitem> 1998 1999 <listitem> 2000 <para> 2001 &product-name; checks if any of the entries in 2002 <computeroutput>/etc/fstab</computeroutput> point to CD/DVD 2003 devices. 2004 </para> 2005 </listitem> 2006 2007 </orderedlist> 2008 2009 <para> 2010 You can set the VBOX_CDROM environment variable to contain a 2011 list of your CD/DVD devices, separated by colons. For example: 2012 </para> 2013 2014 <screen>export VBOX_CDROM='/dev/cdrom0:/dev/cdrom1'</screen> 2015 2016 <para> 2017 On modern Linux distributions, &product-name; uses the hardware 2018 abstraction layer (HAL) to locate CD and DVD hardware. 2019 </para> 2020 2021 </sect2> 2022 2023 <sect2 id="ts_linux-host-floppy-not-found"> 2024 2025 <title>Linux Host Floppy Not Found</title> 2026 2027 <para> 2028 <xref linkend="ts_linux-host-cd-dvd-not-found-legacy"/> appplies 2029 also to floppy disks, except that on older distributions 2030 &product-name; tests for 2031 <computeroutput>/dev/fd*</computeroutput> devices by default. 2032 This can be overridden with the 2033 <computeroutput>VBOX_FLOPPY</computeroutput> environment 2034 variable. 1691 <title>Linux Host CD/DVD or Floppy Disk Drive Not Found</title> 1692 1693 <para> 1694 If you have configured a virtual machine to use the host's CD or 1695 DVD drive or floppy disk drive, but this does not appear to 1696 work, make sure that the current user has permission to access 1697 the corresponding Linux device file. For example, for a CD or 1698 DVD drive this may be <filename>/dev/hdc</filename>, 1699 <filename>/dev/scd0</filename>, <filename>/dev/cdrom</filename> 1700 or similar. On most distributions, the user must be added to a 1701 corresponding group, usually called <command>cdrom</command> or 1702 <command>cdrw</command> or <command>floppy</command>. 1703 </para> 1704 1705 <para> 1706 On supported Linux distributions, &product-name; uses 1707 <command>udev</command> to locate hardware such as CD/DVD drives 1708 and floppy disk drives. 2035 1709 </para> 2036 1710 … … 2039 1713 <sect2 id="ts_linux-host-ide-messages"> 2040 1714 2041 <title>Strange Guest IDE Error Messages When Writing to CD /DVD</title>2042 2043 <para> 2044 If the experimental CD /DVD writer support is enabled with an2045 incorrect &product-name;, host or guest configuration, it is2046 possible that any attempt to access the CD/DVD writer fails and2047 simply results in guest kernel error messages for Linux guests2048 or application error messages for Windows guests. &product-name;2049 performs the usual consistency checks when a VM is powered up.2050 In particular, it aborts with an error message if the device for2051 the CD/DVD writer is not writable by the user starting the VM.2052 But&product-name; cannot detect all misconfigurations. The1715 <title>Strange Guest IDE Error Messages When Writing to CD or DVD</title> 1716 1717 <para> 1718 If the experimental CD or DVD writer support is enabled with an 1719 incorrect host or guest configuration, it is possible that any 1720 attempt to access the CD or DVD writer fails and simply results 1721 in guest kernel error messages for Linux guests or application 1722 error messages for Windows guests. &product-name; performs the 1723 usual consistency checks when a VM is powered up. In particular, 1724 it aborts with an error message if the device for the CD or DVD 1725 writer is not writable by the user starting the VM. But 1726 &product-name; cannot detect all misconfigurations. The 2053 1727 necessary host and guest OS configuration is not specific for 2054 1728 &product-name;, but a few frequent problems are listed here … … 2058 1732 <para> 2059 1733 Special care must be taken to use the correct device. The 2060 configured host CD /DVD device file name, in most cases2061 < computeroutput>/dev/cdrom</computeroutput>, must point to the2062 device that allows writing to the CD/DVD unit. For CD/DVD writer2063 unitsconnected to a SCSI controller or to a IDE controller that1734 configured host CD or DVD device file name, in most cases 1735 <filename>/dev/cdrom</filename>, must point to the device that 1736 allows writing to the CD or DVD unit. For CD or DVD writer units 1737 connected to a SCSI controller or to a IDE controller that 2064 1738 interfaces to the Linux SCSI subsystem, common for some SATA 2065 1739 controllers, this must refer to the SCSI device node, such as 2066 <computeroutput>/dev/scd0</computeroutput>. Even for IDE CD/DVD 2067 writer units this must refer to the appropriate SCSI CD-ROM 2068 device node, such as <computeroutput>/dev/scd0</computeroutput>, 2069 if the <computeroutput>ide-scsi</computeroutput> kernel module 2070 is loaded. This module is required for CD/DVD writer support 2071 with all Linux 2.4 kernels and some early 2.6 kernels. Many 2072 Linux distributions load this module whenever a CD/DVD writer is 2073 detected in the system, even if the kernel would support CD/DVD 2074 writers without the module. &product-name; supports the use of 2075 IDE device files, such as 2076 <computeroutput>/dev/hdc</computeroutput>, provided the kernel 2077 supports this and the <computeroutput>ide-scsi</computeroutput> 2078 module is not loaded. 2079 </para> 2080 2081 <para> 2082 Similar rules, except that within the guest the CD/DVD writer is 2083 always an IDE device, apply to the guest configuration. Since 1740 <filename>/dev/scd0</filename>. Even for IDE CD or DVD writer 1741 units this must refer to the appropriate SCSI CD-ROM device 1742 node, such as <filename>/dev/scd0</filename>, if the 1743 <command>ide-scsi</command> kernel module is loaded. This module 1744 is required for CD or DVD writer support with some early 2.6 1745 kernels. Many Linux distributions load this module whenever a CD 1746 or DVD writer is detected in the system, even if the kernel 1747 would support CD or DVD writers without the module. 1748 &product-name; supports the use of IDE device files, such as 1749 <filename>/dev/hdc</filename>, provided the kernel supports this 1750 and the <command>ide-scsi</command> module is not loaded. 1751 </para> 1752 1753 <para> 1754 Similar rules, except that within the guest the CD or DVD writer 1755 is always an IDE device, apply to the guest configuration. Since 2084 1756 this setup is very common, it is likely that the default 2085 1757 configuration of the guest works as expected. … … 2096 1768 Mozilla XPCOM (cross platform component object model) for 2097 1769 interprocess and intraprocess communication (IPC). The process 2098 <computeroutput>VBoxSVC</computeroutput> serves as a 2099 communication hub between different &product-name; processes and 2100 maintains the global configuration, such as the XML database. 2101 When starting an &product-name; component, the processes 2102 <computeroutput>VBoxSVC</computeroutput> and 2103 <computeroutput>VBoxXPCOMIPCD</computeroutput> are started 2104 automatically. They are only accessible from the user account 2105 they are running under. <computeroutput>VBoxSVC</computeroutput> 1770 <command>VBoxSVC</command> serves as a communication hub between 1771 different &product-name; processes and maintains the global 1772 configuration, such as the XML database. When starting an 1773 &product-name; component, the processes 1774 <command>VBoxSVC</command> and <command>VBoxXPCOMIPCD</command> 1775 are started automatically. They are only accessible from the 1776 user account they are running under. <command>VBoxSVC</command> 2106 1777 owns the &product-name; configuration database which normally 2107 resides in 2108 <computeroutput>~/.config/VirtualBox</computeroutput>, or the 1778 resides in <filename>~/.config/VirtualBox</filename>, or the 2109 1779 appropriate configuration directory for your operating system. 2110 1780 While it is running, the configuration files are locked. 2111 1781 Communication between the various &product-name; components and 2112 <com puteroutput>VBoxSVC</computeroutput> is performed through a2113 local domainsocket residing in2114 < computeroutput>/tmp/.vbox-<username>-ipc</computeroutput>.1782 <command>VBoxSVC</command> is performed through a local domain 1783 socket residing in 1784 <filename>/tmp/.vbox-<replaceable>username</replaceable>-ipc</filename>. 2115 1785 In case there are communication problems, such as an 2116 1786 &product-name; application cannot communicate with 2117 <com puteroutput>VBoxSVC</computeroutput>, terminate the daemons2118 and remove thelocal domain socket directory.1787 <command>VBoxSVC</command>, terminate the daemons and remove the 1788 local domain socket directory. 2119 1789 </para> 2120 1790 … … 2127 1797 <para> 2128 1798 If USB is not working on your Linux host, make sure that the 2129 current user is a member of the 2130 <computeroutput>vboxusers</computeroutput> group. Please keep in 2131 mind that group membership does not take effect immediately but 2132 rather at the next login. If available, the 2133 <command>newgrp</command> command may avoid the need for a 1799 current user is a member of the <literal>vboxusers</literal> 1800 group. Please keep in mind that group membership does not take 1801 effect immediately but rather at the next login. If available, 1802 the <command>newgrp</command> command may avoid the need for a 2134 1803 logout and login. 2135 1804 </para> … … 2143 1812 <para> 2144 1813 Linux kernels including the grsec patch, see 2145 <ulink 2146 url="http://www.grsecurity.net/">http://www.grsecurity.net/</ulink>, 2147 and derivates have to disable PAX_MPROTECT for the VBox binaries 2148 to be able to start a VM. The reason is that VBox has to create 2149 executable code on anonymous memory. 1814 <ulink url="http://www.grsecurity.net/" />, and derivates have 1815 to disable PAX_MPROTECT for the <command>VBox</command> binaries 1816 to be able to start a VM. The reason is that &product-name; has 1817 to create executable code on anonymous memory. 2150 1818 </para> 2151 1819 … … 2161 1829 fail to start with a kernel error saying that the vmalloc pool 2162 1830 is exhausted and should be extended. The error message also 2163 tells you to specify 2164 <computeroutput>vmalloc=256MB</computeroutput> in your kernel 2165 parameter list. If adding this parameter to your GRUB or LILO 2166 configuration makes the kernel fail to boot, with an error 2167 message such as "failed to mount the root partition", then you 2168 have probably run into a memory conflict of your kernel and 2169 initial RAM disk. This can be solved by adding the following 2170 parameter to your GRUB configuration: 1831 tells you to specify <literal>vmalloc=256MB</literal> in your 1832 kernel parameter list. If adding this parameter to your GRUB or 1833 LILO configuration makes the kernel fail to boot, with an error 1834 message such as <literal>failed to mount the root 1835 partition</literal>, then you have probably run into a memory 1836 conflict of your kernel and initial RAM disk. This can be solved 1837 by adding the following parameter to your GRUB configuration: 2171 1838 </para> 2172 1839 … … 2190 1857 lead to a heavy fragmentation of the host memory preventing 2191 1858 &product-name; VMs from being started. We recommend to limit the 2192 ZFS cache by adding the following line to /etc/system, where 2193 <computeroutput>xxxx</computeroutput> bytes is the amount of 2194 memory usable for the ZFS cache. 1859 ZFS cache by adding the following line to 1860 <filename>/etc/system</filename>, where 1861 <replaceable>xxxx</replaceable> bytes is the amount of memory 1862 usable for the ZFS cache. 2195 1863 </para> 2196 1864 … … 2199 1867 </sect2> 2200 1868 2201 <sect2 id="ts_sol-host-swap-space">2202 2203 <title>VM Aborts With Out of Memory Errors on Oracle Solaris 10 Hosts</title>2204 2205 <para>2206 32-bit Oracle Solaris 10 hosts (bug 1225025) require swap space2207 equal to, or greater than the host's physical memory size. For2208 example, 8 GB physical memory would require at least 8 GB swap.2209 This can be configured during an Oracle Solaris 10 install by2210 choosing a Custom Install and changing the default partitions.2211 </para>2212 2213 <note>2214 <para>2215 This restriction applies only to 32-bit Oracle Solaris hosts,2216 64-bit hosts are not affected.2217 </para>2218 </note>2219 2220 <para>2221 For existing Oracle Solaris 10 installs, an additional swap2222 image needs to be mounted and used as swap. Hence if you have 12223 GB swap and 8 GB of physical memory, you require to add 7 GB2224 more swap. This can be done as follows:2225 </para>2226 2227 <para>2228 For ZFS, run the following as root user:2229 </para>2230 2231 <screen>zfs create -V 8gb /_<ZFS volume>_/swap2232 swap -a /dev/zvol/dsk/_<ZFS volume>_/swap</screen>2233 2234 <para>2235 To mount if after reboot, add the following line to /etc/vfstab:2236 </para>2237 2238 <screen>/dev/zvol/dsk/_<ZFS volume>_/swap - - swap - no -</screen>2239 2240 <para>2241 Alternatively, you could grow the existing swap using:2242 </para>2243 2244 <screen>zfs set volsize=8G rpool/swap</screen>2245 2246 <para>2247 And reboot the system for the changes to take effect.2248 </para>2249 2250 <para>2251 For UFS (as root user):2252 </para>2253 2254 <screen>mkfile 7g /path/to/swapfile.img2255 swap -a /path/to/swapfile.img</screen>2256 2257 <para>2258 To mount it after reboot, add the following line to /etc/vfstab:2259 </para>2260 2261 <screen>/path/to/swap.img - - swap - no -</screen>2262 2263 </sect2>2264 2265 1869 </sect1> 2266 1870 -
trunk/doc/manual/en_US/user_VBoxManage.xml
r82044 r82350 254 254 <listitem> 255 255 <para> 256 <computeroutput>-v|--version</computeroutput>: Show the 257 version of this tool and exit. 258 </para> 259 </listitem> 260 261 <listitem> 262 <para> 263 <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 278 file containing the settings password. 256 <option>-v|--version</option>: Show the version of this tool 257 and exit. 258 </para> 259 </listitem> 260 261 <listitem> 262 <para> 263 <option>--nologo</option>: Suppress the output of the logo 264 information. This option is useful for scripts. 265 </para> 266 </listitem> 267 268 <listitem> 269 <para> 270 <option>--settingspw</option>: Specifiy a settings password. 271 </para> 272 </listitem> 273 274 <listitem> 275 <para> 276 <option>--settingspwfile</option>: Specify a file containing 277 the settings password. 279 278 </para> 280 279 </listitem> … … 289 288 settings password is specified, this information is stored in 290 289 <emphasis>plain text</emphasis>. After using the 291 < computeroutput>--settingspw|--settingspwfile</computeroutput>292 option once, it must be always used. Otherwise, the encrypted293 setting cannot beunencrypted.290 <option>--settingspw|--settingspwfile</option> option once, it 291 must be always used. Otherwise, the encrypted setting cannot be 292 unencrypted. 294 293 </para> 295 294 … … 318 317 registered with &product-name;. By default this displays a 319 318 compact list with each VM's name and UUID. If you also specify 320 <computeroutput>--long</computeroutput> or 321 <computeroutput>-l</computeroutput>, this will be a detailed 322 list as with the <command>showvminfo</command> command, see 323 <xref linkend="vboxmanage-showvminfo"/>. 319 <option>--long</option> or <option>-l</option>, this will be a 320 detailed list as with the <command>showvminfo</command> 321 command, see <xref linkend="vboxmanage-showvminfo"/>. 324 322 </para> 325 323 </listitem> … … 527 525 528 526 <para> 529 Use the < computeroutput>--machinereadable</computeroutput> option530 to produce the same output, but in machine readable format with a531 property=valuestring on each line. For example:527 Use the <option>--machinereadable</option> option to produce the 528 same output, but in machine readable format with a property=value 529 string on each line. For example: 532 530 </para> 533 531 … … 623 621 <replaceable>name</replaceable></option>. This name is used by 624 622 default as the file name of the settings file that has the 625 < computeroutput>.xml</computeroutput> extension and the machine626 folder, whichis a subfolder of the627 < computeroutput>.config/VirtualBox/Machines</computeroutput>628 folder. Note that the machine folder path name varies based onthe629 OS type and the&product-name; version.623 <filename>.xml</filename> extension and the machine folder, which 624 is a subfolder of the 625 <filename>.config/VirtualBox/Machines</filename> folder. Note that 626 the machine folder path name varies based on the OS type and the 627 &product-name; version. 630 628 </para> 631 629 … … 808 806 PCI bus address]></computeroutput>: Attaches a specified 809 807 PCI network controller on the host to a specified PCI bus on 810 the guest. See <xref linkend="pcipassthrough" />. 808 the guest. 809 810 <!--See <xref linkend="pcipassthrough" />.--> 811 811 </para> 812 812 </listitem> … … 817 817 address></computeroutput>: Detaches a specified PCI 818 818 network controller on the host from the attached PCI bus on 819 the guest. See <xref linkend="pcipassthrough" />. 819 the guest. 820 821 <!--See <xref linkend="pcipassthrough" />.--> 820 822 </para> 821 823 </listitem> … … 1147 1149 <para> 1148 1150 <computeroutput>--biospxedebug on|off</computeroutput>: 1149 Enables additional debugging output when using the Intel PXE 1150 boot ROM. The output is written to the release log file. See 1151 <xref linkend="collect-debug-info" />. 1151 Enables or disables additional debugging output when using 1152 the Intel PXE boot ROM. The output is written to the release 1153 log file. See <xref linkend="collect-debug-info" />. 1154 </para> 1155 </listitem> 1156 1157 <listitem> 1158 <para> 1159 <computeroutput>--system-uuid-le on|off</computeroutput>: 1160 Enables or disables representing the system UUID in little 1161 endian form. The default value is <literal>on</literal> for 1162 new VMs. For old VMs the setting is <literal>off</literal> 1163 to keep the content of the DMI/SMBIOS table unchanged, which 1164 can be important for Windows license activation. 1152 1165 </para> 1153 1166 </listitem> … … 1224 1237 <listitem> 1225 1238 <para> 1226 <computeroutput>--vm-process-priority default|flat|low|normal|high 1227 </computeroutput>: Specifies the priority scheme of the VM process 1228 to be used when starting this VM and during VM execution. See 1239 <computeroutput>--vm-process-priority 1240 default|flat|low|normal|high</computeroutput>: Specifies the 1241 priority scheme of the VM process to be used when starting 1242 this VM and during VM execution. See 1229 1243 <xref linkend="vboxmanage-startvm" />. 1230 1244 </para> … … 1268 1282 (<computeroutput>generic</computeroutput>). These options 1269 1283 correspond to the modes described in 1270 <xref 1271 linkend="networkingmodes" />. 1284 <xref linkend="networkingmodes" />. 1272 1285 </para> 1273 1286 </listitem> … … 1276 1289 <para> 1277 1290 <computeroutput>--nictype<1-N> 1278 Am79C970A|Am79C973| 82540EM|82543GC|82545EM|virtio</computeroutput>:1291 Am79C970A|Am79C973|Am79C970|82540EM|82543GC|82545EM|virtio</computeroutput>: 1279 1292 Enables you to specify the networking hardware that 1280 1293 &product-name; presents to the guest for a specified VM … … 1670 1683 connect the virtual serial device to it. Note that 1671 1684 Windows requires that the name of a named pipe begins 1672 with < computeroutput>\\.\pipe\</computeroutput>.1685 with <filename>\\.\pipe\</filename>. 1673 1686 </para> 1674 1687 … … 1729 1742 port such as <computeroutput>COM1</computeroutput>. On a 1730 1743 Linux host, the device name will be 1731 <computeroutput>/dev/ttyS0</computeroutput> or similar. 1732 This enables you to wire up a real serial port to a 1733 virtual machine. 1744 <filename>/dev/ttyS0</filename> or similar. This enables 1745 you to wire up a real serial port to a virtual machine. 1734 1746 </para> 1735 1747 </listitem> … … 1741 1753 <para> 1742 1754 <computeroutput>uarttype <1-N> 1743 16450|16550A|16750</computeroutput>: Conf gures the UART1755 16450|16550A|16750</computeroutput>: Configures the UART 1744 1756 type for a virtual serial port. The default UART type is 1745 1757 16550A. … … 1831 1843 <para> 1832 1844 <computeroutput>--clipboard-file-transfers 1833 enabled|disabled</computeroutput>: 1834 Specifies if clipboard file transfers are allowed between host and1835 guest OSEs ornot.1845 enabled|disabled</computeroutput>: Specifies if clipboard 1846 file transfers are allowed between host and guest OSes or 1847 not. 1836 1848 </para> 1837 1849 </listitem> … … 2652 2664 2653 2665 <para> 2654 This command import one or more virtual machinesto2666 This command imports one or more virtual machines into 2655 2667 &product-name;. You can import from either of the following: 2656 2668 </para> … … 2666 2678 <listitem> 2667 2679 <para> 2668 A cloud service, such as &oci;. Only a single cloud instance can be imported. 2680 A cloud service, such as &oci;. Only a single cloud instance 2681 can be imported. 2669 2682 </para> 2670 2683 </listitem> … … 2673 2686 2674 2687 <para> 2675 See <xref linkend="ovf" /> for more details on importing VMs from2688 See <xref linkend="ovf" /> for more details on importing VMs into 2676 2689 &product-name;. 2677 2690 </para> … … 2684 2697 The <command>import</command> subcommand takes at least the path 2685 2698 name of an OVF file as input and expects the disk images, if 2686 needed, in the same directory as the OVF file. A lot of additional2687 command-line options are supported to control in detail what is2688 being imported and modify the import parameters, but the details2689 dependon the content of the OVF file.2699 needed, to be in the same directory as the OVF file. Many 2700 additional command-line options are supported. These enable you 2701 to control in detail what is being imported and to modify the 2702 import parameters, depending on the content of the OVF file. 2690 2703 </para> 2691 2704 … … 2694 2707 <command>import</command> subcommand with the 2695 2708 <computeroutput>--dry-run</computeroutput> or 2696 <computeroutput>-n</computeroutput> option. This will then print a2697 description of the appliance's contents to the screen how it would2698 be imported into &product-name;, together with the optional2699 command-line options to influence the import behavior.2709 <computeroutput>-n</computeroutput> option. This will then print 2710 a description of the appliance's contents to the screen how it 2711 would be imported into &product-name;, together with the 2712 optional command-line options to influence the import behavior. 2700 2713 </para> 2701 2714 … … 2703 2716 Use of the <computeroutput>--options 2704 2717 keepallmacs|keepnatmacs|keepdisknames</computeroutput> option 2705 enables additional fine tuning of the clone operation. The first2706 two options enable specification of how the MAC addresses of every2707 virtual network card should be handled. They can either be2718 enables additional fine tuning of the import operation. The 2719 first two options enable you to specify how the MAC addresses of 2720 every virtual network card should be handled. They can either be 2708 2721 reinitialized, which is the default setting, left unchanged 2709 2722 (<computeroutput>keepallmacs</computeroutput>) or left unchanged 2710 2723 when the network type is NAT 2711 2724 (<computeroutput>keepnatmacs</computeroutput>). If you add 2712 <computeroutput>keepdisknames</computeroutput> all new disk images2713 are assigned the same names as the originals, otherwise they are2714 renamed.2725 <computeroutput>keepdisknames</computeroutput> all new disk 2726 images are assigned the same names as the originals, otherwise 2727 they are renamed. 2715 2728 </para> 2716 2729 … … 2720 2733 </para> 2721 2734 2722 2735 <screen>VBoxManage import WindowsXp.ovf --dry-run 2723 2736 Interpreting WindowsXp.ovf... 2724 2737 OK. … … 2758 2771 2759 2772 <para> 2760 The individual configuration items are numbered, and depending on2761 their type support different command-line options. The import2773 The individual configuration items are numbered, and depending 2774 on their type support different command-line options. The import 2762 2775 subcommand can be directed to ignore many such items with a 2763 2776 <computeroutput>--vsys X --unit Y --ignore</computeroutput> 2764 option, where X is the number of the virtual system and Y the item2765 number, as printed on the screen. X is zero, unless there are2766 several virtual system descriptions in the appliance.2777 option, where X is the number of the virtual system and Y the 2778 item number, as printed on the screen. X is zero, unless there 2779 are several virtual system descriptions in the appliance. 2767 2780 </para> 2768 2781 2769 2782 <para> 2770 2783 In the above example, Item #1 specifies the name of the target 2771 machine in &product-name;. Items # 9 and #10specify hard disk2772 controllers, respectively. Item #1 1describes a hard disk image.2784 machine in &product-name;. Items #12 and #13 specify hard disk 2785 controllers, respectively. Item #14 describes a hard disk image. 2773 2786 In this case, the additional 2774 2787 <computeroutput>--controller</computeroutput> option indicates 2775 which item the disk image should be connected to, with the default2776 coming from the OVF file.2788 which item the disk image should be connected to, with the 2789 default coming from the OVF file. 2777 2790 </para> 2778 2791 2779 2792 <para> 2780 You can combine several items for the same virtual system behind2781 the same <computeroutput>--vsys</computeroutput> option. For2782 example, to import a machine as described in the OVF, but without2783 thesound card and without the USB controller, and with the disk2793 You can combine several items for the same virtual system using 2794 the <computeroutput>--vsys</computeroutput> option. For example, 2795 to import a machine as described in the OVF, but without the 2796 sound card and without the USB controller, and with the disk 2784 2797 image connected to the IDE controller instead of the SCSI 2785 2798 controller, use the following command: 2786 2799 </para> 2787 2800 2788 <screen>VBoxManage import WindowsXp.ovf 2789 --vsys 0 --unit 5 --ignore --unit 6 --ignore --unit 11 --controller 10</screen> 2801 <screen>VBoxManage import WindowsXp.ovf 2802 --vsys 0 --unit 8 --ignore --unit 9 --ignore --unit 14 --controller 13</screen> 2803 2790 2804 </sect2> 2791 2805 2792 2806 <sect2 id="vboxmanage-import-cloud"> 2807 2793 2808 <title>Import from &oci;</title> 2809 2794 2810 <para> 2795 As the result of operation a file with the suffix “.oci” will be downloaded on the local host. 2796 This file is a TAR archive which contains a bootable instance image in QCOW2 format and a JSON file with some metadata 2797 related to the imported instance. The downloaded file is deleted after successful import. If import fails the VBoxSVC log file 2798 may hint a name and place where the downloaded file was stored (in case of failure the file may not be deleted). 2799 During import the bootable image is extracted from the archive and converted into VMDK format. The JSON file is also extracted 2800 and stored in the VM folder. 2811 As the result of this operation, a file with the suffix 2812 <filename>.oci</filename> is downloaded to the local host. This 2813 file is a TAR archive which contains a bootable instance image 2814 in QCOW2 format and a JSON file with some metadata related to 2815 the imported instance. 2801 2816 </para> 2817 2802 2818 <para> 2803 The command syntax begins from the "VBoxManage import OCI:// --cloud". 2819 The downloaded file is deleted after a successful import. If 2820 import fails, the downloaded file may not be deleted and the 2821 VBoxSVC log file may indicate the location where the file was 2822 stored. 2804 2823 </para> 2824 2805 2825 <para> 2806 List the machines and their ids from Oracle Cloud Infrastructure using the command "VBoxManage cloud --provider=OCI 2807 --profile="your profile name" list instances". 2826 During import the bootable image is extracted from the archive 2827 and converted into VMDK format. The JSON file is also extracted 2828 and stored in the VM machine folder. 2808 2829 </para> 2830 2809 2831 <para> 2810 To import a VM from a cloud service such as Oracle Cloud Infrastructure, use the <option>--cloud</option> option to specify the 2811 import from the Cloud. Some of the following options are settings for the VM. Somewhere you must enter an Oracle Cloud Identifier (OCID) 2812 for a resource. Use the Oracle Cloud Infrastructure Console to view OCIDs. 2832 The command syntax for importing an &oci; instance begins with 2833 <command>VBoxManage import OCI:// --cloud</command>. 2813 2834 </para> 2835 2814 2836 <para> 2815 Next parameters must be followed: 2816 <itemizedlist> 2817 <listitem> 2818 <para> 2819 <option>--vmname</option>: Specifies new name for imported VM. This name is used as the VM name in VirtualBox. 2820 </para> 2821 </listitem> 2822 <listitem> 2823 <para> 2824 <option>--cloudinstanceid</option>: Id of existing instance in the Cloud. 2825 </para> 2826 </listitem> 2827 <listitem> 2828 <para> 2829 <option>--cloudprofile</option>: Specifies the cloud profile that is used to connect to the cloud service provider. 2830 The cloud profile contains your Oracle Cloud Infrastructure account details, such as your user OCID and the fingerprint for your public key. 2831 To use a cloud profile, you must have the required permissions on Oracle Cloud Infrastructure. 2832 </para> 2833 </listitem> 2834 <listitem> 2835 <para> 2836 <option>--cloudbucket</option>: Specifies the bucket name in which to store the object created from an instance bootable volume. 2837 In Oracle Cloud Infrastructure, a bucket is a logical container for storing objects. 2838 </para> 2839 </listitem> 2840 </itemizedlist> 2837 You can list the available &oci; VM instances and their IDs by 2838 using the following command: 2841 2839 </para> 2840 2841 <screen>VBoxManage cloud --provider=OCI --profile=<replaceable>cloud-profile-name</replaceable> list instances</screen> 2842 2842 2843 <para> 2843 Some other import options have the same meaning as for OVF import: 2844 <itemizedlist> 2845 <listitem> 2846 <para> 2847 <option>--ostype</option>: OS type supported by VirtualBox. Use "VBoxManage list ostypes" to see the whole list of supported OSes. 2848 If the type wasn't set the "Unknown" type will be used. 2849 </para> 2850 </listitem> 2851 <listitem> 2852 <para> 2853 <option>--basefolder</option>: folder where new VM will be placed. 2854 </para> 2855 </listitem> 2856 <listitem> 2857 <para> 2858 <option>--description</option>: VM description string. 2859 </para> 2860 </listitem> 2861 <listitem> 2862 <para> 2863 <option>--memory</option>: RAM memory assigned for VM in MB. 2864 If memory wasn't set the possible memory size will be deduced from the default memory size for this OS type or will be taken from the cloud instance. 2865 </para> 2866 </listitem> 2867 <listitem> 2868 <para> 2869 <option>--cpus</option>: Number of virtual CPUs assigned for VM. 2870 If cpus wasn't set the possible number of CPUs will be deduced from the default settings for this OS type or will be taken from the cloud instance. 2871 </para> 2872 </listitem> 2873 </itemizedlist> 2844 To import a VM from a cloud service such as &oci;, use the 2845 <option>--cloud</option> option to specify the import from the 2846 Cloud. Some of the following options are settings for the VM, 2847 for others you must enter an Oracle Cloud Identifier (OCID) for 2848 a resource. Use the Oracle Cloud Infrastructure Console to view 2849 OCIDs. 2874 2850 </para> 2851 2875 2852 <para> 2876 The import options <option>--disk</option>, <option>--controller</option>, <option>--scsitype</option>, <option>--unit</option>, 2877 <option>--settingsfile</option> are invalid for cloud import. 2853 The following parameters can be specified: 2878 2854 </para> 2855 2856 <itemizedlist> 2857 2858 <listitem> 2859 <para> 2860 <option>--vmname</option>: Specifies a new name for the 2861 imported VM. This name is used as the VM name by 2862 &product-name;. 2863 </para> 2864 </listitem> 2865 2866 <listitem> 2867 <para> 2868 <option>--cloudinstanceid</option>: The ID of an existing 2869 instance in the Cloud. 2870 </para> 2871 </listitem> 2872 2873 <listitem> 2874 <para> 2875 <option>--cloudprofile</option>: Specifies the cloud profile 2876 that is used to connect to the cloud service provider. The 2877 cloud profile contains your &oci; account details, such as 2878 your user OCID and the fingerprint for your public key. To 2879 use a cloud profile, you must have the required permissions 2880 on &oci;. 2881 </para> 2882 </listitem> 2883 2884 <listitem> 2885 <para> 2886 <option>--cloudbucket</option>: Specifies the bucket name in 2887 which to store the object created from an instance bootable 2888 volume. In &oci;, a bucket is a logical container for 2889 storing objects. 2890 </para> 2891 </listitem> 2892 2893 </itemizedlist> 2894 2879 2895 <para> 2880 The following example shows a typical command line for import an instance from Oracle Cloud Infrastructure: 2896 The following import options have the same meaning as for OVF 2897 import: 2881 2898 </para> 2882 <screen> 2883 # VBoxManage import OCI:// --cloud --vmname import_from_oci --memory 4000 2884 --cpus 3 --ostype FreeBSD_64 --cloudprofile "standard user" --cloudinstanceid 2885 ocid1.instance.oc1.iad.abuwc... --cloudbucket myBucket 2886 </screen> 2899 2900 <itemizedlist> 2901 2902 <listitem> 2903 <para> 2904 <option>--ostype</option>: An OS type supported by 2905 &product-name;. Use the <command>VBoxManage list 2906 ostypes</command> command to see the whole list of supported 2907 OSes. If the type was not set, the 2908 <literal>Unknown</literal> type is used. 2909 </para> 2910 </listitem> 2911 2912 <listitem> 2913 <para> 2914 <option>--basefolder</option>: The folder where the new VM 2915 is stored. 2916 </para> 2917 </listitem> 2918 2919 <listitem> 2920 <para> 2921 <option>--description</option>: A string describing the VM. 2922 </para> 2923 </listitem> 2924 2925 <listitem> 2926 <para> 2927 <option>--memory</option>: The amount of RAM memory assigned 2928 for the VM, in MB. If this option is not set either the 2929 default memory size for the OS type is used, or the value is 2930 taken from the &oci; instance. 2931 </para> 2932 </listitem> 2933 2934 <listitem> 2935 <para> 2936 <option>--cpus</option>: the number of virtual CPUs assigned 2937 for the VM. If this option is not set, either the default 2938 virtual CPUs setting for the OS type is used, or the value 2939 is taken from the &oci; instance. 2940 </para> 2941 </listitem> 2942 2943 </itemizedlist> 2944 2945 <para> 2946 The import options <option>--disk</option>, 2947 <option>--controller</option>, <option>--scsitype</option>, 2948 <option>--unit</option>, <option>--settingsfile</option> are not 2949 valid for cloud import. 2950 </para> 2951 2952 <para> 2953 The following example shows a typical command line for importing 2954 an instance from &oci;: 2955 </para> 2956 2957 <screen># VBoxManage import OCI:// --cloud --vmname import_from_oci --memory 4000 2958 --cpus 3 --ostype FreeBSD_64 --cloudprofile "standard user" 2959 --cloudinstanceid ocid1.instance.oc1.iad.abuwc... --cloudbucket myBucket</screen> 2887 2960 2888 2961 </sect2> … … 3051 3124 permissions on &oci;. 3052 3125 </para> 3053 3054 <remark>3055 Add xref to information about the required permissions.3056 </remark>3057 3126 </listitem> 3058 3127 … … 3072 3141 <replaceable>domain</replaceable>: Specifies the 3073 3142 availability domain to use for the VM instance. Enter the 3074 OCID forthe availability domain.3143 full name of the availability domain. 3075 3144 </para> 3076 3145 </listitem> … … 3142 3211 </para> 3143 3212 3144 <remark> 3145 For the next release, describe exactly what this command does in 3146 terms of the command line options. 3147 </remark> 3148 3149 <screen># VBoxManage export myVM --output OCI:// --cloud 0 --vmname myVM_Cloud 3150 --cloudprofile "standard user" --cloudbucket myBucket 3151 --cloudshape VM.Standard2.1 --clouddomain aaaa:US-ASHBURN-AD-1 --clouddisksize 50 3152 --cloudocivcn ocid1.vcn.oc1.iad.aaaa... --cloudocisubnet ocid1.subnet.oc1.iad.aaaa... 3213 <screen># VBoxManage export myVM --output OCI:// --cloud 0 --vmname myVM_Cloud \ 3214 --cloudprofile "standard user" --cloudbucket myBucket \ 3215 --cloudshape VM.Standard2.1 --clouddomain US-ASHBURN-AD-1 --clouddisksize 50 \ 3216 --cloudocivcn ocid1.vcn.oc1.iad.aaaa... --cloudocisubnet ocid1.subnet.oc1.iad.aaaa... \ 3153 3217 --cloudkeepobject true --cloudlaunchinstance true --cloudpublicip true</screen> 3154 3218 … … 3375 3439 <listitem> 3376 3440 <para> 3377 <computeroutput>setlinkstate<1-N> on|off</computeroutput>:3378 Connects or disconnects virtual network cables from their3379 network interfaces.3441 <computeroutput>setlinkstate<1-N> 3442 on|off</computeroutput>: Connects or disconnects virtual 3443 network cables from their network interfaces. 3380 3444 </para> 3381 3445 </listitem> … … 3399 3463 (<computeroutput>generic</computeroutput>). These options 3400 3464 correspond to the modes which are described in detail in 3401 <xref 3402 linkend="networkingmodes" />. 3465 <xref linkend="networkingmodes" />. 3403 3466 </para> 3404 3467 </listitem> … … 3420 3483 trace should be logged. This can be done with the 3421 3484 <computeroutput>nictracefile<1-N> 3422 <filename></computeroutput> option to <command>VBoxManage 3423 controlvm</command> at runtime or with the 3424 <computeroutput>--nictracefile<1-N> 3425 <filename></computeroutput> option to <command>VBoxManage 3426 modifyvm</command> otherwise. 3485 <filename></computeroutput> option to 3486 <command>VBoxManage controlvm</command> at runtime or with the 3487 <computeroutput><filename></computeroutput> option to 3488 <command>VBoxManage modifyvm</command> otherwise. 3427 3489 </para> 3428 3490 </listitem> … … 3541 3603 <para> 3542 3604 <computeroutput>clipboard filetransfers 3543 enabled|disabled</computeroutput>: 3544 Specifies if clipboard file transfers are allowed between host and 3545 guest OSEs or not. 3605 enabled|disabled</computeroutput>: Specifies if clipboard file 3606 transfers are allowed between host and guest OSes or not. 3546 3607 </para> 3547 3608 </listitem> … … 4053 4114 <listitem> 4054 4115 <para> 4055 <computeroutput>vm-process-priority default|flat|low|normal|high 4056 </computeroutput>: Changes the priority scheme of the VM process. 4057 See <xref linkend="vboxmanage-startvm" />. 4116 <computeroutput>vm-process-priority 4117 default|flat|low|normal|high</computeroutput>: Changes the 4118 priority scheme of the VM process. See 4119 <xref linkend="vboxmanage-startvm" />. 4058 4120 </para> 4059 4121 </listitem> … … 4277 4339 4278 4340 <para> 4279 If you have a Saved state file 4280 (<computeroutput>.sav</computeroutput>) that is separate from the 4281 VM configuration, you can use this command to 4341 If you have a Saved state file (<filename>.sav</filename>) that is 4342 separate from the VM configuration, you can use this command to 4282 4343 <emphasis>adopt</emphasis> the file. This will change the VM to 4283 4344 saved state and when you start it, &product-name; will attempt to … … 5313 5374 </sect1> 5314 5375 5315 <sect1 id="vboxmanage-modify vdi">5376 <sect1 id="vboxmanage-modifymedium"> 5316 5377 5317 5378 <title>VBoxManage modifymedium</title> … … 5469 5530 </sect1> 5470 5531 5471 <sect1 id="vboxmanage-clone vdi">5532 <sect1 id="vboxmanage-clonemedium"> 5472 5533 5473 5534 <title>VBoxManage clonemedium</title> … … 5556 5617 <command>clonevdi</command> and <command>clonehd</command> 5557 5618 commands are still supported and mapped internally to the 5558 <command>clone hd disk</command> command.5619 <command>clonemedium</command> command. 5559 5620 </para> 5560 5621 </note> … … 5811 5872 5812 5873 <para> 5813 This command converts a raw disk image to a &product-name; Disk5874 This command converts a raw disk image to an &product-name; Disk 5814 5875 Image (VDI) file. The syntax is as follows: 5815 5876 </para> … … 5909 5970 <para> 5910 5971 These commands enable you to attach and retrieve string data for a 5911 virtual machine or for a &product-name; configuration, by5972 virtual machine or for an &product-name; configuration, by 5912 5973 specifying <computeroutput>global</computeroutput> instead of a 5913 5974 virtual machine name. You must specify a keyword as a text string … … 6088 6149 <para> 6089 6150 Configures the VBoxSVC release logging details. See 6090 <ulink url="http://www.virtualbox.org/wiki/VBoxLogging" >http://www.virtualbox.org/wiki/VBoxLogging</ulink>.6151 <ulink url="http://www.virtualbox.org/wiki/VBoxLogging" />. 6091 6152 </para> 6092 6153 </listitem> … … 6395 6456 the share will be automatically mounted. On Linux 6396 6457 distributions, this will be to either 6397 <computeroutput>/media/USER/sf_<name></computeroutput> 6398 or <computeroutput>/media/sf_<name></computeroutput>, 6399 where <name> is the share named. The actual location 6400 depends on the guest OS. Optional. 6458 <filename>/media/USER/sf_<replaceable>share-name</replaceable></filename> 6459 or 6460 <filename>/media/sf_<replaceable>share-name</replaceable></filename>, 6461 where <replaceable>share-name</replaceable> is the share 6462 named. The actual location depends on the guest OS. Optional. 6401 6463 </para> 6402 6464 </listitem> … … 6793 6855 Specifies the absolute path of the executable on the 6794 6856 guest OS file system. Mandatory. For example: 6795 < computeroutput>C:\Windows\System32\calc.exe</computeroutput>.6857 <filename>C:\Windows\System32\calc.exe</filename>. 6796 6858 </para> 6797 6859 </listitem> … … 7073 7135 Specifies the absolute path of the executable on the 7074 7136 guest OS file system. Mandatory. For example: 7075 < computeroutput>C:\Windows\System32\calc.exe</computeroutput>7137 <filename>C:\Windows\System32\calc.exe</filename> 7076 7138 </para> 7077 7139 </listitem> … … 7315 7377 Specifies the absolute path of the host file system 7316 7378 destination directory. Mandatory. For example: 7317 < computeroutput>C:\Temp</computeroutput>.7379 <filename>C:\Temp</filename>. 7318 7380 </para> 7319 7381 </listitem> … … 7330 7392 Specifies the absolute paths of guest file system files 7331 7393 to be copied. Mandatory. For example: 7332 < computeroutput>C:\Windows\System32\calc.exe</computeroutput>.7394 <filename>C:\Windows\System32\calc.exe</filename>. 7333 7395 Wildcards can be used in the expressions. For example: 7334 < computeroutput>C:\Windows\System*\*.dll</computeroutput>.7396 <filename>C:\Windows\System*\*.dll</filename>. 7335 7397 </para> 7336 7398 </listitem> … … 7406 7468 Specifies the absolute path of the guest file system 7407 7469 destination directory. Mandatory. For example: 7408 < computeroutput>C:\Temp</computeroutput>.7470 <filename>C:\Temp</filename>. 7409 7471 </para> 7410 7472 </listitem> … … 7421 7483 Specifies the absolute paths of host file system files 7422 7484 to be copied. Mandatory. For example: 7423 < computeroutput>C:\Windows\System32\calc.exe</computeroutput>.7485 <filename>C:\Windows\System32\calc.exe</filename>. 7424 7486 Wildcards can be used in the expressions. For example: 7425 < computeroutput>C:\Windows\System*\*.dll</computeroutput>.7487 <filename>C:\Windows\System*\*.dll</filename>. 7426 7488 </para> 7427 7489 </listitem> … … 7473 7535 <para> 7474 7536 For example: If specified directory is 7475 < computeroutput>D:\Foo\Bar</computeroutput> and7476 < computeroutput>D:\Foo</computeroutput> is absent, it7477 will becreated. In such a case, had the7537 <filename>D:\Foo\Bar</filename> and 7538 <filename>D:\Foo</filename> is absent, it will be 7539 created. In such a case, had the 7478 7540 <computeroutput>--parents</computeroutput> option not 7479 7541 been used, this command would have failed. … … 7508 7570 Specifies a list of absolute paths of directories to be 7509 7571 created on guest file system. Mandatory. For example: 7510 < computeroutput>D:\Foo\Bar</computeroutput>.7572 <filename>D:\Foo\Bar</filename>. 7511 7573 </para> 7512 7574 … … 7515 7577 switch <computeroutput>--parents</computeroutput> is 7516 7578 used. For example, in the above example 7517 < computeroutput>D:\Foo</computeroutput>. The specified7518 user musthave sufficient rights to create the specified7579 <filename>D:\Foo</filename>. The specified user must 7580 have sufficient rights to create the specified 7519 7581 directories, and any parents that need to be created. 7520 7582 </para> … … 7578 7640 be deleted on guest file system. Mandatory. Wildcards 7579 7641 are allowed. For example: 7580 < computeroutput>D:\Foo\*Bar</computeroutput>. The7581 specified user must have sufficient rights to delete the7582 specifieddirectories.7642 <filename>D:\Foo\*Bar</filename>. The specified user 7643 must have sufficient rights to delete the specified 7644 directories. 7583 7645 </para> 7584 7646 </listitem> … … 7641 7703 deleted on guest file system. Mandatory. Wildcards are 7642 7704 allowed. For example: 7643 < computeroutput>D:\Foo\Bar\text*.txt</computeroutput>.7644 The specified user should have sufficient rights to7645 delete thespecified files.7705 <filename>D:\Foo\Bar\text*.txt</filename>. The specified 7706 user should have sufficient rights to delete the 7707 specified files. 7646 7708 </para> 7647 7709 </listitem> … … 7862 7924 Specifies absolute paths of files or file systems on the 7863 7925 guest file system. Mandatory. For example: 7864 < computeroutput>/home/foo/a.out</computeroutput>. The7865 s pecified user should have sufficient rights to access7866 the specifiedfiles or file systems.7926 <filename>/home/foo/a.out</filename>. The specified user 7927 should have sufficient rights to access the specified 7928 files or file systems. 7867 7929 </para> 7868 7930 </listitem> … … 9016 9078 </sect1> 9017 9079 9018 9080 <!-- TODO: Figure out how we can generate a file with the includes... The trouble is 9019 9081 that xpointer doesn't seem to allow including multiple elements. 9020 9082 … … 9022 9084 don't forget to add it here too. 9023 9085 --> 9024 <xi:include href="user_man_VBoxManage-unattended.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" /> 9025 <xi:include href="user_man_VBoxManage-snapshot.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" /> 9086 9087 <xi:include href="user_man_VBoxManage-unattended.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" /> 9088 9089 <xi:include href="user_man_VBoxManage-snapshot.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" /> 9090 9026 9091 <xi:include href="user_man_VBoxManage-clonevm.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" /> 9092 9027 9093 <xi:include href="user_man_VBoxManage-extpack.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" /> 9028 <xi:include href="user_man_VBoxManage-dhcpserver.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" /> 9094 9095 <xi:include href="user_man_VBoxManage-dhcpserver.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" /> 9096 9029 9097 <xi:include href="user_man_VBoxManage-debugvm.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" /> 9030 <xi:include href="user_man_VBoxManage-cloudprofile.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" /> 9031 <xi:include href="user_man_VBoxManage-cloudlist.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" /> 9098 9099 <xi:include href="user_man_VBoxManage-cloudprofile.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" /> 9100 9101 <xi:include href="user_man_VBoxManage-cloudlist.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" /> 9102 9032 9103 <xi:include href="user_man_VBoxManage-cloudinstance.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" /> 9104 9033 9105 <xi:include href="user_man_VBoxManage-cloudimage.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" /> 9034 9106 9035 9107 <!-- TODO: Figure out how we can handle other manpages. The xml is bolted to 9036 9108 sect1, so it's not possible to have them "in place" --> 9109 9037 9110 <xi:include href="user_man_vboximg-mount.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" /> 9111 9038 9112 </chapter> -
trunk/doc/manual/en_US/user_VirtualBoxAPI.xml
r76786 r82350 29 29 Development Kit (SDK)</emphasis>. The SDK is available for download 30 30 from 31 <ulink url="http://www.virtualbox.org" >http://www.virtualbox.org</ulink>.31 <ulink url="http://www.virtualbox.org" />. 32 32 In particular, the SDK comes with a Programming Guide and Reference 33 33 manual in PDF format. This manual contains, among other things, the
Note:
See TracChangeset
for help on using the changeset viewer.