- Timestamp:
- Jul 4, 2024 8:57:55 AM (5 months ago)
- Location:
- trunk/doc/manual/en_US/dita/topics
- Files:
-
- 5 deleted
- 96 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/doc/manual/en_US/dita/topics/TechnicalBackground.dita
r99797 r105134 5 5 6 6 <body> 7 <p> 8 This chapter provides additional information for readers who are 9 familiar with computer architecture and technology and wish to find 10 out more about how <ph conkeyref="vbox-conkeyref-phrases/product-name"/> works <i>under the 11 hood</i>. The contents of this chapter are not required 12 reading in order to use <ph conkeyref="vbox-conkeyref-phrases/product-name"/> successfully. 13 </p> 7 <p> This chapter provides additional information for readers who are familiar with computer 8 architecture and technology and want to find out more about how <ph 9 conkeyref="vbox-conkeyref-phrases/product-name"/> works <i>under the hood</i>. The contents 10 of this chapter are not required reading in order to use <ph 11 conkeyref="vbox-conkeyref-phrases/product-name"/> successfully. </p> 14 12 </body> 15 13 </topic> -
trunk/doc/manual/en_US/dita/topics/VirtualBoxAPI.dita
r99797 r105134 6 6 <body> 7 7 <p> 8 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> comes with comprehensive support for third-party 9 developers. The so-called <i>Main API</i> of 10 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> exposes the entire feature set of the virtualization 11 engine. It is completely documented and available to anyone who 12 wishes to control <ph conkeyref="vbox-conkeyref-phrases/product-name"/> programmatically. 13 </p> 8 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> comes with comprehensive support for 9 third-party developers. The so-called <i>Main API</i> of <ph 10 conkeyref="vbox-conkeyref-phrases/product-name"/> exposes the entire feature set of the 11 virtualization engine. It is completely documented and available to anyone who wants to 12 control <ph conkeyref="vbox-conkeyref-phrases/product-name"/> programmatically. </p> 14 13 <p> 15 14 The Main API is made available to C++ clients through COM on Windows -
trunk/doc/manual/en_US/dita/topics/additions-linux-graphics-mouse.dita
r99797 r105134 31 31 which come with the guest operating system. 32 32 </p> 33 <p> 34 If you want to understand more about the details of how the 35 X.Org drivers are set up, in particular if you wish to use 36 them in a setting which our installer does not handle 37 correctly, see <xref href="guestxorgsetup.dita">Guest Graphics and Mouse Driver Setup in Depth</xref>. 38 </p> 33 <p> If you want to understand more about the details of how the X.Org drivers are set up, in 34 particular if you want to use them in a setting which our installer does not handle correctly, 35 see <xref href="guestxorgsetup.dita">Guest Graphics and Mouse Driver Setup in Depth</xref>. </p> 39 36 <p> 40 37 Starting from <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 7, Linux guest screen resize -
trunk/doc/manual/en_US/dita/topics/additions-linux-uninstall.dita
r98549 r105134 5 5 6 6 <body> 7 <p> 8 If you have a version of the Guest Additions installed on your 9 virtual machine and wish to remove it without installing new 10 ones, you can do so by inserting the Guest Additions CD image 11 into the virtual CD-ROM drive as described above. Then run the 12 installer for the current Guest Additions with the 13 <codeph>uninstall</codeph> parameter from the path that the 14 CD image is mounted on in the guest, as follows: 15 </p> 7 <p> If you have a version of the Guest Additions installed on your virtual machine and want to 8 remove it without installing new ones, you can do so by inserting the Guest Additions CD image 9 into the virtual CD-ROM drive as described above. Then run the installer for the current Guest 10 Additions with the <codeph>uninstall</codeph> parameter from the path that the CD image is 11 mounted on in the guest, as follows: </p> 16 12 <pre xml:space="preserve">sh ./VBoxLinuxAdditions.run uninstall</pre> 17 13 <p> -
trunk/doc/manual/en_US/dita/topics/additions-linux.dita
r99797 r105134 52 52 Additions work in those distributions. 53 53 </p> 54 <p> 55 Note that some Linux distributions already come with all or part 56 of the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions. You may choose to keep 57 the distribution's version of the Guest Additions but these are 58 often not up to date and limited in functionality, so we 59 recommend replacing them with the Guest Additions that come with 60 <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Linux Guest Additions 61 installer tries to detect an existing installation and replace 62 them but depending on how the distribution integrates the Guest 63 Additions, this may require some manual interaction. It is 64 highly recommended to take a snapshot of the virtual machine 65 before replacing preinstalled Guest Additions. 66 </p> 54 <p> Note that some Linux distributions already come with all or part of the <ph 55 conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions. You may choose to keep 56 the distribution's version of the Guest Additions but these are often out of date and limited 57 in functionality, so we recommend replacing them with the Guest Additions that come with <ph 58 conkeyref="vbox-conkeyref-phrases/product-name"/>. The <ph 59 conkeyref="vbox-conkeyref-phrases/product-name"/> Linux Guest Additions installer tries to 60 detect an existing installation and replace them but depending on how the distribution 61 integrates the Guest Additions, this may require some manual interaction. It is highly 62 recommended to take a snapshot of the virtual machine before replacing preinstalled Guest 63 Additions. </p> 67 64 </body> 68 65 </topic> -
trunk/doc/manual/en_US/dita/topics/additions-windows.dita
r99797 r105134 23 23 <li> 24 24 <p> 25 Microsoft Windows 10 (all feature updates)25 Microsoft Windows 10 (all builds) 26 26 </p> 27 27 </li> -
trunk/doc/manual/en_US/dita/topics/autologon.dita
r99797 r105134 9 9 and Oracle Solaris to enable automated logins on the guest. 10 10 </p> 11 <p> 12 When a guest operating system is running in a virtual machine, it 13 might be desirable to perform coordinated and automated logins 14 using credentials passed from the host. Credentials are user name, 15 password, and domain name, where each value might be empty. 16 </p> 11 <p> When a guest operating system is running in a virtual machine, it might be required to 12 perform coordinated and automated logins using credentials passed from the host. Credentials 13 are user name, password, and domain name, where each value might be empty. </p> 17 14 </body> 18 15 </topic> -
trunk/doc/manual/en_US/dita/topics/autologon_unix.dita
r99797 r105134 35 35 </p> 36 36 </note> 37 <p> 38 The <filepath>pam_vbox.so</filepath> module is shipped as part 39 of the Guest Additions but it is not installed and/or activated 40 on the guest OS by default. In order to install it, it has to be 41 copied from 42 <filepath>/opt/VBoxGuestAdditions-<varname>version</varname>/other/</filepath> 43 to the security modules directory. This is usually 44 <filepath>/lib/security/</filepath> on 32-bit Linux guests or 45 <filepath>/lib64/security/</filepath> on 64-bit Linux guests. 46 Please refer to your guest OS documentation for the correct PAM 47 module directory. 48 </p> 37 <p> The <filepath>pam_vbox.so</filepath> module is shipped as part of the Guest Additions but it 38 is not installed or activated on the guest OS by default. In order to install it, it has to be 39 copied from <filepath>/opt/VBoxGuestAdditions-<varname>version</varname>/other/</filepath> to 40 the security modules directory. This is usually <filepath>/lib/security/</filepath> on 32-bit 41 Linux guests or <filepath>/lib64/security/</filepath> on 64-bit Linux guests. Please refer to 42 your guest OS documentation for the correct PAM module directory. </p> 49 43 <p> 50 44 For example, to use <filepath>pam_vbox.so</filepath> with a … … 74 68 </li> 75 69 <li> 76 <p> 77 If authentication against the shadow database using 78 <filepath>pam_unix.so</filepath> or 79 <filepath>pam_unix2.so</filepath> is desired, the argument 80 <codeph>try_first_pass</codeph> for 81 <filepath>pam_unix.so</filepath> or 82 <codeph>use_first_pass</codeph> for 83 <filepath>pam_unix2.so</filepath> is needed in order to pass 84 the credentials from the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> module to the shadow 85 database authentication module. For Ubuntu, this needs to be 86 added to <filepath>/etc/pam.d/common-auth</filepath>, to the 87 end of the line referencing 88 <filepath>pam_unix.so</filepath>. This argument tells the 89 PAM module to use credentials already present in the stack, 90 such as the ones provided by the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> PAM module. 91 </p> 70 <p> If authentication against the shadow database using <filepath>pam_unix.so</filepath> or 71 <filepath>pam_unix2.so</filepath> is required, the argument 72 <codeph>try_first_pass</codeph> for <filepath>pam_unix.so</filepath> or 73 <codeph>use_first_pass</codeph> for <filepath>pam_unix2.so</filepath> is needed in order 74 to pass the credentials from the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 75 module to the shadow database authentication module. For Ubuntu, this must be added to 76 <filepath>/etc/pam.d/common-auth</filepath>, to the end of the line referencing 77 <filepath>pam_unix.so</filepath>. This argument tells the PAM module to use credentials 78 already present in the stack, such as the ones provided by the <ph 79 conkeyref="vbox-conkeyref-phrases/product-name"/> PAM module. </p> 92 80 </li> 93 81 </ol> -
trunk/doc/manual/en_US/dita/topics/autostart-windows.dita
r98549 r105134 74 74 installed for users with empty passwords. 75 75 </p> 76 <p> 77 Finally, the user should define which VMs should be started at 78 boot. The user should run the following command for every VM 79 they wish to start at boot: 80 </p> 76 <p> Finally, the user should define which VMs should be started at boot. The user should run the 77 following command for every VM they want to start at boot: </p> 81 78 <pre xml:space="preserve">VBoxManage modifyvm <varname>VM name or UUID</varname> --autostart-enabled on</pre> 82 79 <p> … … 86 83 <pre xml:space="preserve">VBoxManage modifyvm <varname>VM name or UUID</varname> --autostart-enabled off</pre> 87 84 <note> 88 <p> 89 On Windows hosts, starting VMs via the autostart service might 90 cause some issues, as the virtual machines are starting within 91 the same session as VBoxSVC. For more information see 92 <xref href="vboxsvc-session-0.dita#vboxsvc-session-0"/>. 93 </p> 85 <p> On Windows hosts, starting VMs by using the autostart service might cause some issues, as 86 the virtual machines are starting within the same session as VBoxSVC. For more information 87 see <xref href="vboxsvc-session-0.dita#vboxsvc-session-0"/>. </p> 94 88 </note> 95 89 </body> -
trunk/doc/manual/en_US/dita/topics/buffer-overwriting-mitigation.dita
r99797 r105134 5 5 6 6 <body> 7 <p> 8 First, up to date CPU microcode is a prerequisite for the 9 buffer overwriting (clearing) mitigations. Some host OSes may 10 install these automatically, though it has traditionally been 11 a task best performed by the system firmware. Please check 12 with your system or mainboard manufacturer for the latest 13 firmware update. 14 </p> 7 <p> First, up-to-date CPU microcode is a prerequisite for the buffer overwriting (clearing) 8 mitigations. Some host OSes may install these automatically, though it has traditionally been 9 a task best performed by the system firmware. Please check with your system or mainboard 10 manufacturer for the latest firmware update. </p> 15 11 <p> 16 12 This mitigation aims at removing potentially sensitive data -
trunk/doc/manual/en_US/dita/topics/changevpd.dita
r99797 r105134 17 17 $ VBoxManage setextradata <varname>VM-name</varname> \ 18 18 "VBoxInternal/Devices/ahci/0/Config/Port0/ModelNumber" "model"</pre> 19 <p> 20 The serial number is a 20 byte alphanumeric string, the firmware 21 revision an 8 byte alphanumeric string and the model number a 40 22 byte alphanumeric string. Instead of Port0, referring to the 23 first port, specify the desired SATA hard disk port. 24 </p> 19 <p> The serial number is a 20 byte alphanumeric string, the firmware revision an 8 byte 20 alphanumeric string and the model number a 40 byte alphanumeric string. Instead of 21 Port0, referring to the first port, specify the required SATA hard disk port. </p> 25 22 <p> 26 23 The above commands apply to virtual machines with an AHCI (SATA) … … 34 31 $ VBoxManage setextradata <varname>VM-name</varname> \ 35 32 "VBoxInternal/Devices/piix3ide/0/Config/PrimaryMaster/ModelNumber" "model"</pre> 36 <p> 37 For hard disks, you can mark the drive as having a 38 non-rotational medium by using the following command: 39 </p> 33 <p> For hard disks, you can mark the drive as having a nonrotational medium by using the 34 following command: </p> 40 35 <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> \ 41 36 "VBoxInternal/Devices/ahci/0/Config/Port0/NonRotational" "1"</pre> … … 50 45 VBoxManage setextradata <varname>VM-name</varname> \ 51 46 "VBoxInternal/Devices/ahci/0/Config/Port0/ATAPIRevision" "revision"</pre> 52 <p> 53 The vendor id is an 8 byte alphanumeric string, the product id 54 an 16 byte alphanumeric string and the revision a 4 byte 55 alphanumeric string. Instead of Port0, referring to the first 56 port, specify the desired SATA hard disk port. 57 </p> 47 <p> The vendor id is an 8 byte alphanumeric string, the product id an 16 byte alphanumeric 48 string and the revision a 4 byte alphanumeric string. Instead of Port0, referring to the 49 first port, specify the required SATA hard disk port. </p> 58 50 </body> 59 51 -
trunk/doc/manual/en_US/dita/topics/cloud-using-cli.dita
r99797 r105134 3 3 <topic xml:lang="en-us" id="cloud-using-cli"> 4 4 <title>Using VBoxManage Commands With <ph conkeyref="vbox-conkeyref-phrases/oci"/></title> 5 5 6 6 <body> 7 7 <p> … … 79 79 <pre xml:space="preserve">VBoxManage cloud --provider="OCI" --profile="vbox-oci" instance terminate \ 80 80 --id="ocid1.instance.oc1..." </pre> 81 82 <p><b outputclass="bold">Showing Cloud Instance Performance Metrics</b></p> 81 83 <p> 82 For more details about the available commands for cloud operations, see <xref 83 href="vboxmanage-cloud.dita"/>. 84 To show CPU usage metrics for a cloud instance: 84 85 </p> 86 <pre xml:space="preserve">VBoxManage cloud --provider="OCI" --profile="vbox-oci" instance metricdata \ 87 --id="ocid1.instance.oc1..." --metric-name="CpuUtilization"</pre> 88 <p> For more details about the available commands for cloud operations, see <xref 89 href="vboxmanage-cloud.dita"/>. </p> 85 90 </body> 86 91 87 92 </topic> -
trunk/doc/manual/en_US/dita/topics/cloud-using-cloud-networks.dita
r99797 r105134 3 3 <topic xml:lang="en-us" id="cloud-using-cloud-networks"> 4 4 <title>Using a Cloud Network</title> 5 6 5 <body> 7 6 <p> -
trunk/doc/manual/en_US/dita/topics/cloud-vm-control.dita
r99797 r105134 3 3 <topic xml:lang="en-us" id="cloud-vm-control"> 4 4 <title>Controlling a Cloud VM</title> 5 5 <!-- 7.1: OCI instance reset feature--> 6 6 <body> 7 7 <p> … … 16 16 </li> 17 17 <li> 18 <p><b outputclass="bold">Stop.</b> Right-click on the 19 cloud VM name, to display the 20 <b outputclass="bold">Close</b> menu. Options to 18 <p><b outputclass="bold">Stop.</b> Click on the 19 cloud VM name and select <b>Machine</b>, <b>Stop</b>. Menu options to 21 20 shut down and power off the cloud VM are available. 22 21 </p> 22 </li> 23 <li> 24 <p><b outputclass="bold">Reset.</b> Click on the 25 cloud VM name and select <b>Machine</b>, <b>Reset</b>. The cloud VM is stopped, then restarted automatically. 26 </p> 23 27 </li> 24 28 <li> … … 37 41 When you control a cloud VM in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> the machine list is 38 42 updated automatically with the current instance state, such as 39 <b outputclass="bold">Stopped</b> or 40 <b outputclass="bold">Running</b>. 43 <b outputclass="bold">Stopped</b> or <b outputclass="bold">Running</b>. 41 44 </p> 42 45 <p> -
trunk/doc/manual/en_US/dita/topics/cloud-vm.dita
r99797 r105134 3 3 <topic xml:lang="en-us" id="cloud-vm"> 4 4 <title>Using Cloud Virtual Machines</title> 5 6 5 <body> 7 6 <p> … … 23 22 </note> 24 23 <fig id="fig-cloud-vm-overview"> 25 <title>Cloud VMs, Shown in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/></title>26 <xref href="images/cloudvm-overview .png" format="png" platform="htmlhelp">27 <image href="images/cloudvm-overview .png" width="12cm" placement="break">28 <alt>Cloud VMs, Shown in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/></alt>24 <title>Cloud VMs, Shown With Local VMs in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/></title> 25 <xref href="images/cloudvm-overview-mixed.png" format="png" platform="htmlhelp"> 26 <image href="images/cloudvm-overview-mixed.png" width="12cm" placement="break"> 27 <alt>Cloud VMs, Shown With Local VMs in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/></alt> 29 28 </image> 30 29 </xref> 31 <image platform="ohc" href="images/cloudvm-overview .png" width="12cm" placement="break">32 <alt>Cloud VMs, Shown in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/></alt>30 <image platform="ohc" href="images/cloudvm-overview-mixed.png" width="12cm" placement="break"> 31 <alt>Cloud VMs, Shown With Local VMs in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/></alt> 33 32 </image> 34 33 </fig> … … 46 45 instance.</b> See <xref href="cloud-vm-add.dita#cloud-vm-add"/>. 47 46 </p> 47 </li> 48 <li> 49 <p><b outputclass="bold">Copy an existing <ph conkeyref="vbox-conkeyref-phrases/oci"/> 50 instance.</b> See <xref href="cloud-vm-clone.dita#cloud-vm-clone"/>. 51 </p> 48 52 </li> 49 53 <li> -
trunk/doc/manual/en_US/dita/topics/create-optical-disk-image.dita
r98549 r105134 3 3 <topic xml:lang="en-us" id="create-optical-disk-image"> 4 4 <title>Creating a Virtual Optical Disk Image</title> 5 5 <!-- 7.1: Can now import VISO files--> 6 6 <body> 7 7 <p> … … 32 32 </p> 33 33 <p> 34 Click <b outputclass="bold"> Configuration</b> and35 enter aname in the <b outputclass="bold">Viso34 Click <b outputclass="bold">Settings</b> and select the <b>VISO Options</b> tab. 35 Enter the name in the <b outputclass="bold">Viso 36 36 Name</b> field. 37 37 </p> … … 77 77 </p> 78 78 </li> 79 <li> 80 <p> To import <i>all</i> file content from an existing ISO into the virtual ISO, 81 highlight the ISO file name and click <b>Import Selected ISO into the VISO 82 Content</b>. The imported ISO is opened and content is listed in the <b 83 outputclass="bold">VISO Content</b> pane.</p> 84 <p>To remove files from the imported ISO, select the files in the <b>Viso 85 Content</b> pane and click <b>Remove Selected Item(s) from VISO</b>.</p> 86 </li> 79 87 </ul> 80 88 </li> … … 86 94 </p> 87 95 <p> 88 Click <b outputclass="bold"> Create</b>.96 Click <b outputclass="bold">Save and Close</b>. 89 97 </p> 90 98 <p> -
trunk/doc/manual/en_US/dita/topics/create-vm-wizard-hardware.dita
r99797 r105134 2 2 <!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd"> 3 3 <topic xml:lang="en-us" id="create-vm-wizard-hardware"> 4 <title> Create Virtual Machine Wizard:Hardware</title>4 <title>Set Up VM Hardware</title> 5 5 6 6 <body> 7 <p> 8 Use this page to configure hardware settings for the virtual 9 machine. 10 </p> 11 <fig id="fig-create-vm-hardware"> 12 <title>Creating a Virtual Machine: Hardware</title> 13 <xref href="images/create-vm-3.png" format="png" platform="htmlhelp"> 14 <image href="images/create-vm-3.png" width="10cm" placement="break"> 15 <alt>Creating a Virtual Machine: Hardware</alt> 16 </image> 17 </xref> 18 <image platform="ohc" href="images/create-vm-3.png" width="10cm" placement="break"> 19 <alt>Creating a Virtual Machine: Hardware</alt> 20 </image> 21 </fig> 22 <p> 23 The following fields are available on this wizard page: 24 </p> 25 <ul> 26 <li> 27 <p><b outputclass="bold">Base Memory.</b> Select the 28 amount of RAM that <ph conkeyref="vbox-conkeyref-phrases/product-name"/> should allocate every time 29 the virtual machine is started. The amount of memory 30 selected here will be taken away from your host machine and 31 presented to the guest OS, which will report this size as 32 the virtual machines installed RAM. 33 </p> 34 <note type="caution"> 35 <p> 36 Choose this setting carefully. The memory you give to the 37 VM will not be available to your host OS while the VM is 38 running, so do not specify more than you can spare. 39 </p> 40 <p> 41 For example, if your host machine has 4 GB of RAM and you 42 enter 2048 MB as the amount of RAM for a particular 43 virtual machine, you will only have 2 GB left for all the 44 other software on your host while the VM is running. If 45 you run two VMs at the same time, even more memory will be 46 allocated for the second VM, which may not even be able to 47 start if that memory is not available. 48 </p> 49 <p> 50 On the other hand, you should specify as much as your 51 guest OS and your applications will require to run 52 properly. A guest OS may require at least 1 or 2 GB of 53 memory to install and boot up. For best performance, more 54 memory than that may be required. 55 </p> 56 </note> 57 <p> 58 Always ensure that the host OS has enough RAM remaining. If 59 insufficient RAM remains, the system might excessively swap 60 memory to the hard disk, which effectively brings the host 61 system to a standstill. 62 </p> 63 <p> 64 As with other <b outputclass="bold">Create Virtual 65 Machine</b> wizard settings, you can change this 66 setting later, after you have created the VM. 67 </p> 68 </li> 69 <li> 70 <p><b outputclass="bold">Processor(s).</b> Select the 71 number of virtual processors to assign to the VM. 72 </p> 73 <p> 74 It is not advised to assign more than half of the total 75 processor threads from the host machine. 76 </p> 77 </li> 78 <li> 79 <p><b outputclass="bold">Enable EFI.</b> Enables 80 Extensible Firware Interface (EFI) booting for the guest OS. 81 </p> 82 </li> 83 </ul> 84 <p> 85 Click <b outputclass="bold">Next</b> to go to the next 86 wizard page. 87 </p> 7 <ol id="ol_ndb_dbx_4bc"> 8 <li>For <b outputclass="bold">Base Memory</b>, select the amount of RAM that <ph 9 conkeyref="vbox-conkeyref-phrases/product-name"/> should allocate to the virtual machine 10 (VM) every time it is started. The guest OS will report this size as the VM's installed RAM. 11 <note type="caution" id="note_pjs_x1x_4bc"> 12 <p>Choose this setting carefully. The memory you give to the VM will not be available to 13 your host OS while the VM is running. </p> 14 </note><p>Do not specify more than you can spare, whilst ensuring you allocate enough for 15 your guest OS and applications to run properly. For example, if your host machine has 4 GB 16 of RAM and you enter 2048 MB as the base memory for a VM, you will have 2 GB left for all 17 the other software on your host while that VM is running. </p><p>A guest OS may require at 18 least 1 or 2 GB of memory to install and boot up. If you intend to run more than one VM at 19 a time, plan accordingly. A VM will not start if it does not have enough RAM to 20 boot.</p><p>Always ensure that the host OS has enough RAM remaining. If insufficient RAM 21 remains, the system might excessively swap memory to the hard disk, which will effectively 22 bring the host system to a standstill. </p></li> 23 <li>For <b>Processor(s)</b>, select the number of virtual processors to assign to the VM. Do 24 not assign more than half of the total processor threads from the host machine. </li> 25 <li>Select <b outputclass="bold">Enable EFI</b> if you want to enable Extensible Firmware 26 Interface (EFI) booting for the guest OS.</li> 27 <li>Click <b outputclass="bold">Next</b> to <xref 28 href="create-vm-wizard-virtual-hard-disk.dita"/>. </li> 29 </ol> 88 30 </body> 89 31 -
trunk/doc/manual/en_US/dita/topics/create-vm-wizard-name-os.dita
r99797 r105134 2 2 <!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd"> 3 3 <topic xml:lang="en-us" id="create-vm-wizard-name-os"> 4 <title> Create Virtual Machine Wizard:Name and Operating System</title>5 4 <title>Specify Name and Operating System</title> 5 <!--7.1: Subtype field added --> 6 6 <body> 7 <fig id="fig-create-vm-name">8 <title>Creating a Virtual Machine: Name and Operating System</title>9 <xref href="images/create-vm-1.png" format="png" platform="htmlhelp">10 <image href="images/create-vm-1.png" width="10cm" placement="break">11 <alt>Creating a Virtual Machine: Name and Operating System</alt>12 </image>13 </xref>14 <image platform="ohc" href="images/create-vm-1.png" width="10cm" placement="break">15 <alt>Creating a Virtual Machine: Name and Operating System</alt>16 </image>17 </fig>18 7 <p> 19 Use this page to specify a name and operating system (OS) for 20 the virtual machine and to change the storage location used for 21 VMs. 22 </p> 23 <p> 24 You can also choose to disable the unattended guest operating 25 system install feature. See also 26 <xref href="create-vm-wizard-unattended-install.dita#create-vm-wizard-unattended-install"/>. 27 </p> 28 <p> 29 The following fields are available on this wizard page: 30 </p> 31 <ul> 32 <li> 33 <p><b outputclass="bold">Name.</b> A name for the new 34 VM. The name you enter is shown in the machine list of 35 <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> and is also used for the virtual machine's files 36 on disk. 37 </p> 38 <p> 39 Be sure to assign each VM an informative name that describes 40 the OS and software running on the VM. For example, a name 41 such as <codeph>Windows 10 with Visio</codeph>. 42 </p> 43 </li> 44 <li> 45 <p><b outputclass="bold">Folder.</b> The location where 46 VMs are stored on your computer, called the 47 <i>machine folder</i>. The default folder 48 location is shown. 49 </p> 50 <p> 51 Ensure that the folder location has enough free space, 52 especially if you intend to use the snapshots feature. See 53 also <xref href="vboxconfigdata-machine-folder.dita">The Machine Folder</xref>. 54 </p> 55 </li> 56 <li> 57 <p><b outputclass="bold">ISO Image.</b> Select an ISO 58 image file. The image file can be used to install an OS on 59 the new virtual machine or it can be attached to a DVD drive 60 on the new virtual machine. 61 </p> 62 </li> 63 <li> 64 <p><b outputclass="bold">Type and Version.</b> These 65 fields are used to select the OS that you want to install on 66 the new virtual machine. 67 </p> 68 <p> 69 The supported OSes are grouped into types. If you want to 70 install something very unusual that is not listed, select 71 the <b outputclass="bold">Other</b> type. Depending 72 on your selection, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> will enable or disable 73 certain VM settings that your guest OS may require. This is 74 particularly important for 64-bit guests. See 75 <xref href="intro-64bitguests.dita#intro-64bitguests"/>. It is therefore 76 recommended to always set this field to the correct value. 77 </p> 78 <p> 79 If an ISO image is selected and <ph conkeyref="vbox-conkeyref-phrases/product-name"/> detects the 80 operating system for the ISO, the 81 <b outputclass="bold">Type</b> and 82 <b outputclass="bold">Version</b> fields are 83 populated automatically and are disabled. 84 </p> 85 </li> 86 <li> 87 <p><b outputclass="bold">Skip Unattended 88 Installation.</b> Disables unattended guest OS 89 installation, even if an ISO image is selected that supports 90 unattended installation. In that case, the selected ISO 91 image is mounted automatically on the DVD drive of the new 92 virtual machine and user interaction is required to complete 93 the OS installation. 94 </p> 95 <p> 96 The unattended installation step in the wizard is skipped. 97 </p> 98 <note> 99 <p> 100 This option is disabled if you do not select an 101 installation medium in the <b outputclass="bold">ISO 102 Image</b> field. 103 </p> 104 </note> 105 </li> 106 </ul> 107 <p> 108 Click <b outputclass="bold">Next</b> to go to the next 109 wizard page. 8 <ol id="ol_s3f_d13_4bc"> 9 <li>Give the virtual machine (VM) a name. The name you enter is shown in the machine list in 10 <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> and is also used for the virtual 11 machine's files on disk. Be sure to assign each VM an informative name that describes the 12 OS and software running on the VM. For example, <codeph>Windows 10 with 13 Visio</codeph>.</li> 14 <li>Select the location where VMs are stored on your computer, called the machine folder. 15 Ensure that the folder location has enough free space, especially if you intend to use the 16 snapshots feature. See also <xref href="vboxconfigdata-machine-folder.dita">The Machine 17 Folder</xref>.</li> 18 <li>Select the ISO image file for the operating system you intend to install on the new VM. 19 The image file can be used directly to install an OS on the new VM as part of an 20 unattended installation, or it can be attached to a DVD drive on the new VM.</li> 21 <li><ph conkeyref="vbox-conkeyref-phrases/product-name"/> will populate the <b>Type</b>, 22 <b>Subtype</b>, and <b>Version</b> fields if it can detect the operating system in the 23 ISO. If it cannot detect the OS, then set these according to your OS. For example, if the 24 <b>Type</b> is Linux, the <b>Subtype</b> might be Oracle Linux and the <b>Version</b> 25 might be Oracle Linux 8.x (64-bit). <p>The supported OSs are grouped into types. If you 26 want to install something very unusual that is not listed, select the <b>Other</b> type. 27 Depending on your selection, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> will 28 enable or disable certain VM settings that your guest OS may require. This is 29 particularly important for 64-bit guests (see <xref 30 href="intro-64bitguests.dita#intro-64bitguests"/>) but you must always set this field 31 to the correct value.</p></li> 32 <li>By default, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> will install the 33 chosen OS using the ISO image provided, if the image supports unattended installation. See 34 also <xref 35 href="create-vm-wizard-unattended-install.dita#create-vm-wizard-unattended-install" 36 />.<p>If you prefer to install the OS, you can disable the unattended guest operating 37 system install feature by selecting <b outputclass="bold">Skip Unattended 38 Installation</b>. In that case, the selected ISO image is mounted automatically on the 39 DVD drive of the new VM and you must install the OS from there.</p><p>Not all images 40 support unattended installation.</p></li> 41 <li>Click Next to <xref 42 href="create-vm-wizard-unattended-install.dita#create-vm-wizard-unattended-install"/> 43 (if using) or to <xref href="create-vm-wizard-hardware.dita"/>.</li> 44 </ol> 110 45 </p> 111 46 </body> -
trunk/doc/manual/en_US/dita/topics/create-vm-wizard-unattended-install.dita
r99797 r105134 2 2 <!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd"> 3 3 <topic xml:lang="en-us" id="create-vm-wizard-unattended-install"> 4 <title> (Optional) Create Virtual Machine Wizard:Unattended Guest OS Install</title>4 <title>Configure Unattended Guest OS Install</title> 5 5 6 6 <body> 7 <p> 8 Unattended guest OS installation enables you to install the OS 9 on a virtual machine automatically. 10 </p> 7 <p>If you choose Unattended guest OS Installation, <ph 8 conkeyref="vbox-conkeyref-phrases/product-name"/> installs the OS on the new virtual machine 9 (VM) automatically. You must supply certain configuration options to be used in the 10 installation. </p> 11 <p>See also <xref href="unattended-guest-install-example.dita#unattended-guest-install-example" 12 /> for details of how to configure unattended installation from the command line. </p> 11 13 <note> 12 <p> 13 This page is optional. It is not displayed if you have 14 selected the <b outputclass="bold">Skip Unattended 15 Installation</b> option on the initial wizard page. 16 </p> 17 </note> 18 <p> 19 Use this page to set up the required parameters for unattended 20 guest OS installation and to configure automatic installation of 21 the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions. See also 22 <xref href="create-vm-wizard-unattended-examples.dita#create-vm-wizard-unattended-examples"/> for some 23 typical scenarios when using automated installation. 24 </p> 25 <fig id="fig-create-vm-unattended-install"> 26 <title>Creating a Virtual Machine: Unattended Guest OS Installation</title> 27 <xref href="images/create-vm-2.png" format="png" platform="htmlhelp"> 28 <image href="images/create-vm-2.png" width="10cm" placement="break"> 29 <alt>Creating a Virtual Machine: Unattended Guest OS Installation</alt> 30 </image> 31 </xref> 32 <image platform="ohc" href="images/create-vm-2.png" width="10cm" placement="break"> 33 <alt>Creating a Virtual Machine: Unattended Guest OS Installation</alt> 34 </image> 35 </fig> 36 <p> 37 The following fields are available on this wizard page: 38 </p> 39 <ul> 40 <li> 41 <p><b outputclass="bold">Username and Password.</b> 42 Enter the credentials for a default user on the guest OS. 43 </p> 14 <p>You will not see these options if you selected the <b outputclass="bold">Skip Unattended 15 Installation</b> option. </p></note><ol id="ol_ox5_xtw_4bc"> 16 <li>Enter the <b outputclass="bold">Username and Password</b> for a default user on the 17 guest OS. </li> 18 <li> 19 <p>For Windows guests, enter the <b outputclass="bold">Product Key.</b> supplied with 20 Windows. </p> 44 21 </li> 45 22 <li> 46 <p><b outputclass="bold">Guest Additions.</b> Enables 47 automatic installation of the Guest Additions, following 48 installation of the guest OS. Use the drop-down list to 49 select the location of the ISO image file for the Guest 50 Additions. 51 </p> 23 <p>Enter the <b outputclass="bold">Hostname</b> for the VM. By default, this is the same 24 as the VM name.</p> 52 25 </li> 53 26 <li> 54 <p><b outputclass="bold">Additional Options.</b> The 55 following options enable you to perform extra configuration 56 of the guest OS: 57 </p> 58 <ul> 59 <li> 60 <p><b outputclass="bold">Product Key.</b> For 61 Windows guests only. Enter the product key required for 62 Windows installation. 63 </p> 27 <p>Enter the <b outputclass="bold">Domain Name</b> for the VM. </p> 64 28 </li> 65 <li> 66 <p><b outputclass="bold">Hostname.</b> Host name for 67 the guest. By default, this is the same as the VM name. 68 </p> 29 <li>Select <b outputclass="bold">Install in Background</b> if you want to enable headless 30 mode for the VM rather than using a graphical user interface. </li> 31 <li>Select <b outputclass="bold">Guest Additions</b> if you would like <ph 32 conkeyref="vbox-conkeyref-phrases/product-name"/> to install the Guest Additions after 33 the OS. Download the Guest Additions installation ISO to the host, and select the file 34 location.</li> 35 <li>Click <b outputclass="bold">Next</b> to <xref href="create-vm-wizard-hardware.dita"/>. 69 36 </li> 70 <li> 71 <p><b outputclass="bold">Domain Name.</b> Domain 72 name for the guest. 73 </p> 74 </li> 75 <li> 76 <p><b outputclass="bold">Install in Background.</b> 77 Enable headless mode for the VM, where a graphical user 78 interface is not shown. 79 </p> 80 </li> 81 </ul> 82 </li> 83 </ul> 84 <p> 85 Click <b outputclass="bold">Next</b> to go to the next 86 wizard page. 87 </p> 37 </ol> 88 38 </body> 89 39 -
trunk/doc/manual/en_US/dita/topics/create-vm-wizard-virtual-hard-disk.dita
r99797 r105134 2 2 <!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd"> 3 3 <topic xml:lang="en-us" id="create-vm-wizard-virtual-hard-disk"> 4 <title> Create Virtual Machine Wizard:Virtual Hard Disk</title>4 <title>Specify a Virtual Hard Disk</title> 5 5 6 6 <body> 7 <p>There are many ways in which <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can 8 provide hard disk space to a VM, see <xref href="storage.dita#storage"/>. </p> 9 <p>The most common way is to use a virtual hard disk. This is a large image file on your 10 physical hard disk, whose contents <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 11 presents to your VM as if it were a complete hard disk. You can copy this file to another 12 host, and use it with another <ph conkeyref="vbox-conkeyref-phrases/product-name"/> VM. </p> 13 <p>To prevent your physical hard disk on the host OS from filling up, <ph 14 conkeyref="vbox-conkeyref-phrases/product-name"/> limits the size of the image file. But the 15 image file must be large enough to hold the contents of the guest OS and the applications you 16 want to install. For a Windows or Linux guest, you will probably need several gigabytes for 17 any serious use. The size limit of the image file can be changed later, see <xref 18 href="vboxmanage-modifymedium.dita"/>. </p> 7 19 <p> 8 Use this page to specify a virtual hard disk for the virtual 9 machine. 10 </p> 11 <p> 12 There are many ways in which <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can provide hard 13 disk space to a VM, see <xref href="storage.dita#storage"/>. The most 14 common way is to use a large image file on your physical hard 15 disk, whose contents <ph conkeyref="vbox-conkeyref-phrases/product-name"/> presents to your VM as if it 16 were a complete hard disk. This file then represents an entire 17 hard disk, so you can even copy it to another host and use it 18 with another <ph conkeyref="vbox-conkeyref-phrases/product-name"/> installation. 19 </p> 20 <fig id="fig-create-vm-hard-disk"> 21 <title>Creating a New Virtual Machine: Virtual Hard Disk</title> 22 <xref href="images/create-vm-4.png" format="png" platform="htmlhelp"> 23 <image href="images/create-vm-4.png" width="10cm" placement="break"> 24 <alt>Creating a New Virtual Machine: Virtual Hard Disk</alt> 25 </image> 26 </xref> 27 <image platform="ohc" href="images/create-vm-4.png" width="10cm" placement="break"> 28 <alt>Creating a New Virtual Machine: Virtual Hard Disk</alt> 29 </image> 30 </fig> 31 <p> 32 The following fields are available on this wizard page: 33 </p> 34 <ul> 35 <li> 36 <p><b outputclass="bold">Create a Virtual Hard Disk 37 Now</b>. Creates a new empty virtual hard disk image, 38 located in the VM's machine folder. 20 <note id="note_vc4_gjs_pbc"> 21 <p>If you choose <b outputclass="bold">Do Not Add a Virtual Hard Disk</b> at this stage you 22 will need to attach a hard disk using VirtualBox Manager or VBoxManage commands before you 23 can install a guest operating system. </p> 24 </note> 25 </p> 26 <section id="section_wql_21r_pbc"> 27 <title>Create a Virtual Hard Disk</title> 28 </section> 29 <p>Follow these steps to create a virtual hard disk to use with this VM. To prevent your 30 physical hard disk on the host OS from filling up, <ph 31 conkeyref="vbox-conkeyref-phrases/product-name"/> limits the size of the image file. But the 32 image file must be large enough to hold the contents of the guest OS and the applications you 33 want to install. For a Windows or Linux guest, you will probably need several gigabytes for 34 any serious use. The limit of the image file size can be changed later, see <xref 35 href="vboxmanage-modifymedium.dita"/>. <ol id="ol_z2h_q5q_pbc"> 36 <li> 37 <p>Select <b outputclass="bold">Create a Virtual Hard Disk Now</b>. This creates a new 38 empty virtual hard disk image, located in the VM's machine folder. </p> 39 </li> 40 <li> 41 <p> Enter the following settings: </p> 42 <ul id="ul_i3n_y1r_pbc"> 43 <li> 44 <p><b outputclass="bold">Disk Size</b>. Use the slider to select a maximum size for 45 the hard disk in the new VM. </p> 46 </li> 47 <li> 48 <p><b outputclass="bold">Pre-Allocate Full Size.</b> This setting determines the type 49 of image file used for the disk image. Select this setting to use a <i>fixed-size 50 file</i> for the disk image. Otherwise, <ph 51 conkeyref="vbox-conkeyref-phrases/product-name"/> will use a <i>dynamically 52 allocated file</i> for the disk image. </p> 53 <p>The different types of image file behave as follows: </p> 54 <ul id="ul_j3n_y1r_pbc"> 55 <li> 56 <p><b outputclass="bold">Dynamically allocated file.</b> This type of image file 57 only grows in size when the guest actually stores data on its virtual hard disk. 58 Therefore, this file is small initially. As the drive is filled with data, the 59 file grows to the specified size. </p> 60 </li> 61 <li> 62 <p><b outputclass="bold">Fixed-size file.</b> This type of image file immediately 63 occupies the file specified, even if only a fraction of that virtual hard disk 64 space is actually in use. While occupying much more space, a fixed-size file 65 incurs less overhead and is therefore slightly faster than a dynamically 66 allocated file. </p> 67 </li> 68 </ul> 69 <p> For more details about the differences, see <xref 70 href="vdidetails.dita#vdidetails"/>. </p> 71 </li> 72 </ul> 73 </li> 74 </ol></p> 75 <section id="section_bdq_h1r_pbc"> 76 <title>Use an Existing Virtual Hard Disk</title> 77 </section> 78 <p>Follow these steps to use a virtual hard disk that already exists on the host. Ensure the 79 image file is in a suitable location (usually the machine folder) and not in use by other 80 VMs.<ol id="ol_txk_str_pbc"> 81 <li> 82 <p>Select <b outputclass="bold">Use an Existing Virtual Hard Disk File</b> 39 83 </p> 40 <p> 41 Enter the following settings: 42 </p> 43 <ul> 44 <li> 45 <p><b outputclass="bold">Disk Size</b>. Use the 46 slider to select a maximum size for the hard disk in the 47 new VM. 48 </p> 49 </li> 50 <li> 51 <p><b outputclass="bold">Pre-Allocate Full Size.</b> 52 This setting determines the type of image file used for 53 the disk image. Select this setting to use a 54 <i>fixed-size file</i> for the disk image. 55 Deselect this setting to use a <i>dynamically 56 allocated file</i> for the disk image. 57 </p> 58 <p> 59 The different types of image file behave as follows: 60 </p> 61 <ul> 62 <li> 63 <p><b outputclass="bold">Dynamically allocated 64 file.</b> This type of image file only grows 65 in size when the guest actually stores data on its 66 virtual hard disk. Therefore, this file is small 67 initially. As the drive is filled with data, the 68 file grows to the specified size. 69 </p> 70 </li> 71 <li> 72 <p><b outputclass="bold">Fixed-size file.</b> 73 This type of image file immediately occupies the 74 file specified, even if only a fraction of that 75 virtual hard disk space is actually in use. While 76 occupying much more space, a fixed-size file incurs 77 less overhead and is therefore slightly faster than 78 a dynamically allocated file. 79 </p> 80 </li> 81 </ul> 82 <p> 83 For more details about the differences, see 84 <xref href="vdidetails.dita#vdidetails"/>. 85 </p> 86 </li> 87 </ul> 88 </li> 89 <li> 90 <p><b outputclass="bold">Use an Existing Hard Disk 91 File.</b> Enables you to select an 92 <i>existing</i> disk image file to use with 93 the new VM. 94 </p> 95 <p> 96 The drop-down list presented in the window lists all disk 97 images which are known by <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. These disk images 98 are currently attached to a virtual machine, or have been 99 attached to a virtual machine. 100 </p> 101 <p> 102 Alternatively, click on the small folder icon next to the 103 drop-down list. In the <b outputclass="bold">Hard Disk 104 Selector</b> window that is displayed, click 105 <b outputclass="bold">Add</b> to select a disk image 106 file on your host disk. 107 </p> 108 </li> 109 <li> 110 <p><b outputclass="bold">Do Not Add a Virtual Hard 111 Disk.</b> The new VM is created without a hard disk. 112 </p> 113 </li> 114 </ul> 115 <p> 116 To prevent your physical hard disk on the host OS from filling 117 up, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> limits the size of the image file. But the 118 image file must be large enough to hold the contents of the 119 guest OS and the applications you want to install. For a Windows 120 or Linux guest, you will probably need several gigabytes for any 121 serious use. The limit of the image file size can be changed 122 later, see <xref href="vboxmanage-modifymedium.dita"/>. 123 </p> 124 <note> 125 <p> 126 You can skip attaching a virtual hard disk file to the new 127 virtual machine you are creating. But you will then need to 128 attach an hard disk later on, in order to install a guest 129 operating system. 130 </p> 131 </note> 132 <p> 133 After having selected or created your image file, click 134 <b outputclass="bold">Next</b> to go to the next wizard 135 page. 136 </p> 84 </li> 85 <li> 86 <p>Select the image file to use with the new VM, and then click <b outputclass="bold" 87 >Add</b>. </p> 88 </li> 89 </ol></p> 90 <p> </p> 137 91 </body> 138 92 -
trunk/doc/manual/en_US/dita/topics/create-vm-wizard.dita
r98549 r105134 5 5 6 6 <body> 7 <p> 8 Click <b outputclass="bold">New</b> in the VirtualBox 9 Manager window. The <b outputclass="bold">Create Virtual 10 Machine</b> wizard is shown, to guide you through the 11 required steps for setting up a new virtual machine (VM). 12 </p> 13 <p> 14 The <b outputclass="bold">Create Virtual Machine</b> wizard 15 pages are described in the following sections. 16 </p> 7 <p>In the VirtualBox Manager window, click <b outputclass="bold">New</b>. The <b 8 outputclass="bold">Create Virtual Machine</b> wizard is shown, to guide you through the 9 required steps for setting up a new virtual machine (VM). </p> 10 <p>The steps are:<ul id="ul_yt4_cjt_pbc"> 11 <li><xref href="create-vm-wizard-name-os.dita"/></li> 12 <li><xref href="create-vm-wizard-unattended-install.dita"/></li> 13 <li><xref href="create-vm-wizard-hardware.dita"/></li> 14 <li><xref href="create-vm-wizard-virtual-hard-disk.dita"/></li> 15 </ul></p> 16 <p>Once created, the virtual machine is displayed in the machine list on the left side of the 17 <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> window, with the name that you entered on 18 the first page of the wizard.</p> 19 <p>You can change the settings later, after you have created the VM, using the Machine 20 Settings.</p> 21 <p>Before you start you must have an operating system image, in ISO format, for the operating 22 system you intend to install on the VM. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 23 does not supply the OS or any license required to use it. </p> 24 <p><!--7.1: Note added re platforms and paragraph re ISO requirement. Reworded when removing screenshots. Subpages also updated.--></p> 25 <note> 26 <p>The settings on the wizard pages may vary depending on the architecture of the host 27 platform, as follows:</p> 28 <ul> 29 <li> 30 <p><b>x86 host platforms.</b> This includes Windows, macOS, and Linux platforms.</p> 31 </li> 32 <li> 33 <p><b>Arm host platforms.</b> This includes Apple silicon hosts and some Linux OSes.</p> 34 </li> 35 </ul> 36 </note> 37 <p> </p> 17 38 </body> 18 39 </topic> -
trunk/doc/manual/en_US/dita/topics/diffimages.dita
r99797 r105134 64 64 </image> 65 65 </fig> 66 <p> 67 In all of these situations, from the point of view of the virtual 68 machine, the virtual hard disk behaves like any other disk. While 69 the virtual machine is running, there is a slight run-time I/O 70 overhead because <ph conkeyref="vbox-conkeyref-phrases/product-name"/> might need to look up sectors 71 several times. This is not noticeable however since the tables 72 with sector information are always kept in memory and can be 73 looked up quickly. 74 </p> 66 <p> In all of these situations, from the point of view of the virtual machine, the virtual hard 67 disk behaves like any other disk. While the virtual machine is running, there is a slight 68 runtime I/O overhead because <ph conkeyref="vbox-conkeyref-phrases/product-name"/> might need 69 to look up sectors several times. This is not noticeable however since the tables with sector 70 information are always kept in memory and can be looked up quickly. </p> 75 71 <p> 76 72 Differencing images are used in the following situations: -
trunk/doc/manual/en_US/dita/topics/diskencryption.dita
r99797 r105134 19 19 encrypted. 20 20 </p> 21 <p> 22 Since the DEK is stored as part of the VM configuration file, it 23 is important that it is kept safe. Losing the DEK means that the 24 data stored in the disk images is lost irrecoverably. Having 25 complete and up to date backups of all data related to the VM is 26 the responsibility of the user. 27 </p> 21 <p> Since the DEK is stored as part of the VM configuration file, it is important that it is 22 kept safe. Losing the DEK means that the data stored in the disk images is lost irrecoverably. 23 Having complete and up-to-date backups of all data related to the VM is the responsibility of 24 the user. </p> 28 25 </body> 29 26 </topic> -
trunk/doc/manual/en_US/dita/topics/emul-hardware.dita
r99797 r105134 5 5 6 6 <body> 7 <p> 8 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> virtualizes nearly all hardware of the host. 9 Depending on a VM's configuration, the guest will see the 10 following virtual hardware: 11 </p> 7 <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> virtualizes nearly all of the host's 8 hardware. Depending on a VM's configuration, the guest will see the following virtual 9 hardware: </p> 12 10 <ul> 13 11 <li> … … 52 50 </li> 53 51 <li> 54 <p><b outputclass="bold">USB.</b> <ph conkeyref="vbox-conkeyref-phrases/product-name"/> emulates 55 these types of USB host controllers: xHCI, EHCI, and OHCI. 56 While xHCI handles all USB transfer speeds, some legacy guest 57 OSes may not support xHCI. Note that for some legacy Windows 58 guests, third party drivers must be installed for xHCI 59 support. 60 </p> 61 <p> 62 Legacy guest OSes typically support OHCI and EHCI. These two 63 controllers are needed because OHCI only handles USB low-speed 64 and full-speed devices (both USB 1.x and 2.0), while EHCI only 65 handles high-speed devices (USB 2.0 only). 66 </p> 67 <p> 68 The emulated USB controllers do not communicate directly with 69 devices on the host. Instead they communicate with a virtual 70 USB layer which abstracts the USB protocol and enables the use 71 of remote USB devices. 72 </p> 52 <p><b outputclass="bold">USB.</b> 53 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> emulates the most common USB host 54 controllers. See <xref href="usb-support.dita"/>.</p> 55 <p>The emulated USB controllers do not communicate directly with devices on the host. 56 Instead they communicate with a virtual USB layer that abstracts the USB protocol and 57 enables the use of remote USB devices. </p> 73 58 </li> 74 59 <li> -
trunk/doc/manual/en_US/dita/topics/features-overview.dita
r99797 r105134 90 90 <li> 91 91 <p><b outputclass="bold">Hardware compatibility.</b> 92 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> virtualizes a vast array of virtual 93 devices, among them many devices that are typically 94 provided by other virtualization platforms. That includes 95 IDE, SCSI, and SATA hard disk controllers, several virtual 96 network cards and sound cards, virtual serial and parallel 97 ports and an Input/Output Advanced Programmable Interrupt 98 Controller (I/O APIC), which is found in many computer 99 systems. This enables easy cloning of disk images from 100 real machines and importing of third-party virtual 101 machines into <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. 102 </p> 92 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> virtualizes a vast array of 93 virtual devices, among them many devices that are typically provided by other 94 virtualization platforms. That includes IDE, SCSI, and SATA hard disk controllers, 95 several virtual network cards and sound cards, virtual serial ports and an 96 Input/Output Advanced Programmable Interrupt Controller (I/O APIC), which is found in 97 many computer systems. This enables easy cloning of disk images from real machines and 98 importing of third-party virtual machines into <ph 99 conkeyref="vbox-conkeyref-phrases/product-name"/>. </p> 103 100 </li> 104 101 <li> -
trunk/doc/manual/en_US/dita/topics/flush-level1-data-cache-mitigation.dita
r98549 r105134 14 14 usually not without performance side effects. 15 15 </p> 16 <p> 17 Up to date CPU microcode is a prerequisite for the cache 18 flushing mitigations. Some host OSes may install these 19 automatically, though it has traditionally been a task best 20 performed by the system firmware. So, please check with your 21 system / mainboard manufacturer for the latest firmware 22 update. 23 </p> 16 <p> Up-to-date CPU microcode is a prerequisite for the cache flushing mitigations. Some host 17 OSes may install these automatically, though it has traditionally been a task best performed 18 by the system firmware. So, please check with your system / mainboard manufacturer for the 19 latest firmware update. </p> 24 20 <p> 25 21 We recommend disabling hyper threading on the host. This is … … 37 33 similar without taking precautions. 38 34 </p> 39 <p> 40 A more aggressive flushing option is provided via the 41 <userinput>VBoxManage modifyvm</userinput> 42 <codeph>--l1d-flush-on-vm-entry</codeph> option. When enabled 43 the level 1 data cache will be flushed on every VM entry. The 44 performance impact is greater than with the default option, 45 though this of course depends on the workload. Workloads 46 producing a lot of VM exits (like networking, VGA access, and 47 similiar) will probably be most impacted. 48 </p> 35 <p> A more aggressive flushing option is provided using the <userinput>VBoxManage 36 modifyvm</userinput> 37 <codeph>--l1d-flush-on-vm-entry</codeph> option. When enabled the level 1 data cache will be 38 flushed on every VM entry. The performance impact is greater than with the default option, 39 though this of course depends on the workload. Workloads producing a lot of VM exits (like 40 networking, VGA access, and similiar) will probably be most impacted. </p> 49 41 <p> 50 42 For users not concerned by this security issue, the default -
trunk/doc/manual/en_US/dita/topics/frontends.dita
r99797 r105134 2 2 <!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd"> 3 3 <topic xml:lang="en-us" id="frontends"> 4 <title>Alternative Front-Ends</title> 5 4 <title>Alternative Front Ends</title> 6 5 <body> 7 6 <p> … … 15 14 and have all the graphical output redirected over the network. 16 15 </p> 17 <p> 18 The following front-ends are shipped in the standard 19 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> package: 20 </p> 16 <p> The following front ends are shipped in the standard <ph 17 conkeyref="vbox-conkeyref-phrases/product-name"/> package: </p> 21 18 <ul> 22 19 <li> 23 <p><b outputclass="bold">VirtualBox.</b> This is the 24 <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>, a graphical user interface that uses the Qt 25 toolkit. This interface is described throughout this manual. 26 While this is the simplest and easiest front-end to use, some 27 of the more advanced <ph conkeyref="vbox-conkeyref-phrases/product-name"/> features are not included. 28 </p> 20 <p><b outputclass="bold">VirtualBox.</b> This is the <ph 21 conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>, a graphical user interface that uses the 22 Qt toolkit. This interface is described throughout this manual. While this is the simplest 23 and easiest front end to use, some of the more advanced <ph 24 conkeyref="vbox-conkeyref-phrases/product-name"/> features are not included. </p> 29 25 </li> 30 26 <li> … … 36 32 </li> 37 33 <li> 38 <p><b outputclass="bold">VBoxHeadless.</b> A front-end 39 that produces no visible output on the host at all, but can 40 act as a RDP server if the VirtualBox Remote Desktop Extension 41 (VRDE) is installed and enabled for the VM. As opposed to the 42 other graphical interfaces, the headless front-end requires no 43 graphics support. This is useful, for example, if you want to 44 host your virtual machines on a headless Linux server that has 45 no X Window system installed. See 46 <xref href="vboxheadless.dita">VBoxHeadless, the Remote Desktop Server</xref>. 47 </p> 34 <p><b outputclass="bold">VBoxHeadless.</b> A front end that produces no visible output on 35 the host at all, but can act as a RDP server if the VirtualBox Remote Desktop Extension 36 (VRDE) is installed and enabled for the VM. As opposed to the other graphical interfaces, 37 the headless front end requires no graphics support. This is useful, for example, if you 38 want to host your virtual machines on a headless Linux server that has no X Window system 39 installed. See <xref href="vboxheadless.dita">VBoxHeadless, the Remote Desktop 40 Server</xref>. </p> 41 </li> 42 <li> 43 <!-- Separate mode: check with Klaus whether this needs to be covered in 7.1--> 44 <p><b>Separate mode.</b> A front end that is based on <userinput>VBoxHeadless</userinput>, 45 but does not require VRDE or an RDP viewer. See <xref href="vboxheadless-separate-mode.dita">Separate Mode</xref>.</p> 48 46 </li> 49 47 </ul> 50 <p> 51 If the above front-ends still do not satisfy your particular 52 needs, it is possible to create yet another front-end to the 53 complex virtualization engine that is the core of <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, 54 as the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> core neatly exposes all of its features in a 55 clean API. See <xref href="VirtualBoxAPI.dita"><ph conkeyref="vbox-conkeyref-phrases/product-name"/> Programming Interfaces</xref>. 56 </p> 48 <p> If the above front ends still do not satisfy your particular needs, it is possible to create 49 yet another front end to the complex virtualization engine that is the core of <ph 50 conkeyref="vbox-conkeyref-phrases/product-name"/>, as the <ph 51 conkeyref="vbox-conkeyref-phrases/product-name"/> core neatly exposes all of its features in 52 a clean API. See <xref href="VirtualBoxAPI.dita"><ph 53 conkeyref="vbox-conkeyref-phrases/product-name"/> Programming Interfaces</xref>. </p> 57 54 </body> 58 55 -
trunk/doc/manual/en_US/dita/topics/guestadd-clipboard.dita
r100417 r105134 5 5 6 6 <body> 7 <!-- 7.1: Shared clipboard check box; clarify operation with dev --> 7 8 <p> 8 9 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> enables you to copy clipboard content from the host -
trunk/doc/manual/en_US/dita/topics/guestadd-gc-file-manager.dita
r99182 r105134 3 3 <topic xml:lang="en-us" id="guestadd-gc-file-manager"> 4 4 <title>Guest Control File Manager</title> 5 5 <!-- 7.1: new icons added, new pic needed --> 6 6 <body> 7 7 <p> -
trunk/doc/manual/en_US/dita/topics/guestadd-intro.dita
r99797 r105134 52 52 </li> 53 53 <li> 54 <p><b outputclass="bold">Better video support.</b> While 55 the virtual graphics card which <ph conkeyref="vbox-conkeyref-phrases/product-name"/> emulates for 56 any guest operating system provides all the basic features, 57 the custom video drivers that are installed with the Guest 58 Additions provide you with extra high and non-standard video 59 modes, as well as accelerated video performance. 60 </p> 54 <p><b outputclass="bold">Better video support.</b> While the virtual graphics card which <ph 55 conkeyref="vbox-conkeyref-phrases/product-name"/> emulates for any guest operating 56 system provides all the basic features, the custom video drivers that are installed with 57 the Guest Additions provide you with extra high and nonstandard video modes, as well as 58 accelerated video performance. </p> 61 59 <p> 62 60 In addition, with Windows, Linux, and Oracle Solaris guests, -
trunk/doc/manual/en_US/dita/topics/guestossupport.dita
r104960 r105134 10 10 operating systems (OSes) of any kind. 11 11 </p> 12 <!-- 7.1: Require info on supported aarch64 guest OSes --> 12 13 <p> 13 14 The following guest OS platforms are supported: … … 25 26 for limited support because of the vintage of the technology involved. Therefore, 26 27 resolution of customer issues for such legacy guest OS platforms cannot be assured. See 27 <xref href="#guestossupport/table-limited-support"/>. 28 </p> 28 <xref href="#guestossupport/table-limited-support"/>. </p> 29 29 </li> 30 30 </ul> -
trunk/doc/manual/en_US/dita/topics/gui-details-settings.dita
r99797 r105134 8 8 A summary of settings is shown for the virtual machine. 9 9 </p> 10 <note> 11 <p>Settings shown may vary, depending on the selected experience level for the <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> user interface.</p> 12 <p>See <xref href="ui-experience-level.dita#gui-experience-level"/>.</p> 13 </note> 10 14 <p> 11 15 You can change some virtual machine settings, by clicking on -
trunk/doc/manual/en_US/dita/topics/gui-tools-global.dita
r99797 r105134 3 3 <topic xml:lang="en-us" id="gui-tools-global"> 4 4 <title>Global Tools</title> 5 5 <!-- 7.1: May be best to remove screen shots of menus. Too much of a maintenance headache. --> 6 6 <body> 7 7 <p> … … 12 12 Tools</b> menu is displayed. 13 13 </p> 14 <fig id="fig-global-tools-menu">15 <title>Global Tools Menu</title>16 <xref href="images/global-tools-menu.png" format="png" platform="htmlhelp">17 <image href="images/global-tools-menu.png" width="10cm" placement="break">18 <alt>Global Tools Menu</alt>19 </image>20 </xref>21 <image platform="ohc" href="images/global-tools-menu.png" width="10cm" placement="break">22 <alt>Global Tools Menu</alt>23 </image>24 </fig>25 14 <p> 26 15 A drop-down list enables you to select from the following … … 82 71 you scroll down the entries in the machine list. 83 72 </p> 73 <note> 74 <p>The available tools may vary, depending on the selected experience level for the <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> user interface.</p> 75 <p>See <xref href="ui-experience-level.dita#gui-experience-level"/>.</p> 76 </note> 84 77 </body> 85 78 -
trunk/doc/manual/en_US/dita/topics/gui-tools-machine.dita
r99797 r105134 15 15 displayed. 16 16 </p> 17 <fig id="fig-machine-tools-menu">18 <title>Machine Tools Menu</title>19 <xref href="images/machine-tools-menu.png" format="png" platform="htmlhelp">20 <image href="images/machine-tools-menu.png" width="10cm" placement="break">21 <alt>Machine Tools Menu</alt>22 </image>23 </xref>24 <image platform="ohc" href="images/machine-tools-menu.png" width="10cm" placement="break">25 <alt>Machine Tools Menu</alt>26 </image>27 </fig>28 17 <p> 29 18 A drop-down list enables you to select from the following … … 69 58 </li> 70 59 </ul> 60 <note> 61 <p>The available tools may vary, depending on the selected experience level for the <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> user interface.</p> 62 <p>See <xref href="ui-experience-level.dita#gui-experience-level"/>.</p> 63 </note> 71 64 </body> 72 65 -
trunk/doc/manual/en_US/dita/topics/gui-virtualboxmanager.dita
r99797 r105134 22 22 virtual machines. 23 23 </p> 24 <!-- 7.1: Welcome screen now includes Experience Level selection button: new pics required?--> 24 25 <fig id="fig-vbox-manager-initial"> 25 26 <title><ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>, Showing Welcome Screen After Initial Startup</title> -
trunk/doc/manual/en_US/dita/topics/harddiskcontrollers.dita
r99797 r105134 15 15 <ul> 16 16 <li> 17 <p><b outputclass="bold">IDE (ATA)</b> controllers are a 18 backwards-compatible yet very advanced extension of the disk 19 controller in the IBM PC/AT (1984). Initially, this interface 20 worked only with hard disks, but was later extended to also 21 support CD-ROM drives and other types of removable media. In 22 physical PCs, this standard uses flat ribbon parallel cables 23 with 40 or 80 wires. Each such cable can connect two devices, 24 called device 0 and device 1, to a controller. Typical PCs had 25 two connectors for such cables. As a result, support for up to 26 four IDE devices was most common: primary device 0, primary 27 device 1, secondary device 0, and secondary device 1. 28 </p> 17 <p><b outputclass="bold">IDE (ATA)</b> controllers are a backward-compatible yet very 18 advanced extension of the disk controller in the IBM PC/AT (1984). Initially, this 19 interface worked only with hard disks, but was later extended to also support CD-ROM 20 drives and other types of removable media. In physical PCs, this standard uses flat ribbon 21 parallel cables with 40 or 80 wires. Each such cable can connect two devices, called 22 device 0 and device 1, to a controller. Typical PCs had two connectors for such cables. As 23 a result, support for up to four IDE devices was most common: primary device 0, primary 24 device 1, secondary device 0, and secondary device 1. </p> 29 25 <p> 30 26 In <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, each virtual machine may have one IDE -
trunk/doc/manual/en_US/dita/topics/hdimagewrites.dita
r99797 r105134 3 3 <topic xml:lang="en-us" id="hdimagewrites"> 4 4 <title>Special Image Write Modes</title> 5 5 6 6 <body> 7 7 <p> … … 13 13 allocated. 14 14 </p> 15 <p> 16 By default, images are in <i>normal</i> mode. To mark an existing image with one of the 17 non-standard modes listed below, use <userinput>VBoxManage modifymedium</userinput>. See 18 <xref href="vboxmanage-modifymedium.dita"/>. Alternatively, use <userinput>VBoxManage 19 storageattach</userinput> to attach the image to a VM and specify the 20 <codeph>--mtype</codeph> argument. See <xref href="vboxmanage-storageattach.dita"/>. 21 </p> 15 <p> By default, images are in <i>normal</i> mode. To mark an existing image with one of the 16 nonstandard modes listed below, use <userinput>VBoxManage modifymedium</userinput>. See <xref 17 href="vboxmanage-modifymedium.dita"/>. Alternatively, use <userinput>VBoxManage 18 storageattach</userinput> to attach the image to a VM and specify the 19 <codeph>--mtype</codeph> argument. See <xref href="vboxmanage-storageattach.dita"/>. </p> 22 20 <p> 23 21 The available virtual disk image modes are as follows: … … 72 70 way, and dynamically allocated images are rejected. 73 71 </p> 74 <note type=" attention">72 <note type="caution"> 75 73 <p> 76 74 This is an expert feature, and misuse can lead to data loss, … … 190 188 </p> 191 189 </body> 192 190 193 191 </topic> -
trunk/doc/manual/en_US/dita/topics/headless-vm-steps.dita
r99797 r105134 68 68 </li> 69 69 <li> 70 <p> 71 Make sure the settings for the VM are appropriate for the 72 guest operating system that we will install. For example: 73 </p> 70 <p> Ensure the settings for the VM are appropriate for the guest operating system that we 71 will install. For example: </p> 74 72 <pre xml:space="preserve">VBoxManage modifyvm "Windows XP" --memory 256 --acpi on --boot1 dvd --nic1 nat</pre> 75 73 </li> -
trunk/doc/manual/en_US/dita/topics/hostossupport.dita
r99797 r105134 3 3 <topic xml:lang="en-us" id="hostossupport"> 4 4 <title>Supported Host Operating Systems</title> 5 5 <!-- 7.1: Arm platforms; require statement on host support --> 6 6 <body> 7 <p> 8 Currently, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> runs on the following host OSes: 9 </p> 7 <p>Currently, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> runs on the following host 8 OSes: </p> 10 9 <ul> 11 10 <li> … … 15 14 <ul> 16 15 <li> 17 <p> 18 Windows 8.1 19 </p> 16 <p>Windows 10 </p> 20 17 </li> 21 18 <li> 22 <p> 23 Windows 10 24 </p> 19 <p>Windows 11 </p> 25 20 </li> 26 21 <li> 27 <p> 28 Windows 11 21H2 29 </p> 22 <p>Windows Server 2019 </p> 30 23 </li> 31 24 <li> 32 <p> 33 Windows Server 2012 34 </p> 25 <p>Windows Server 2022 </p> 35 26 </li> 36 <li> 37 <p> 38 Windows Server 2012 R2 39 </p> 40 </li> 41 <li> 42 <p> 43 Windows Server 2016 44 </p> 45 </li> 46 <li> 47 <p> 48 Windows Server 2019 49 </p> 50 </li> 51 <li> 52 <p> 53 Windows Server 2022 54 </p> 55 </li> 27 <li>Windows Server 2025</li> 56 28 </ul> 57 29 </li> … … 62 34 <ul> 63 35 <li> 64 <p> 65 10.15 (Catalina) 66 </p> 36 <p>11 (Big Sur) </p> 67 37 </li> 68 38 <li> 69 <p> 70 11 (Big Sur) 71 </p> 39 <p>12 (Monterey) </p> 72 40 </li> 73 41 <li> 74 <p> 75 12 (Monterey) 76 </p> 42 <p>13 (Ventura) </p> 77 43 </li> 44 <li>14 (Sonoma)</li> 78 45 </ul> 79 <p> 80 Intel hardware is required. See also 81 <xref href="KnownIssues.dita">Known Limitations</xref>. 82 </p> 83 <p> 84 An installer package is available for macOS/Arm64, for systems 85 using an Apple silicon CPU. With this package, you can run 86 some guest operating systems for Intel x86/x64 CPUs in an 87 emulation. 88 </p> 89 <p> 90 The macOS/Arm64 installer package for Apple silicon platform 91 is available as a Developer Preview release. This package 92 represents a work in progress project and the performance is 93 very modest. 94 </p> 46 <p>Intel hardware is required. See also <xref href="KnownIssues.dita">Known 47 Limitations</xref>. </p> 48 <p>An installer package is available for macOS/Arm64, for systems using an Apple silicon 49 CPU. With this package, you can run some guest operating systems for Intel x86/x64 CPUs in 50 an emulation. </p> 51 <p>The macOS/Arm64 installer package for Apple silicon platform is available as a Developer 52 Preview release. This package represents a work in progress project and the performance is 53 very modest. </p> 95 54 <note> 96 55 <p> … … 107 66 <ul> 108 67 <li> 109 <p> 110 Ubuntu 18.04 LTS, 20.04 LTS and 22.04 111 </p> 68 <p>Ubuntu 20.04 LTS, 22.04 and 24.04</p> 112 69 </li> 113 70 <li> 114 <p> 115 Debian GNU/Linux 10 ("Buster") and 11 ("Bullseye") 116 </p> 71 <p>Debian GNU/Linux 11 (Bullseye) and 12 (Bookworm)</p> 117 72 </li> 118 73 <li> 119 <p> 120 Oracle Linux 7, 8 and 9 121 </p> 74 <p>Oracle Linux 7, 8 and 9 </p> 122 75 </li> 123 76 <li> 124 <p> 125 CentOS/Red Hat Enterprise Linux 7, 8 and 9 126 </p> 77 <p>CentOS/Red Hat Enterprise Linux 8 and 9 </p> 127 78 </li> 128 79 <li> 129 <p> 130 Fedora 35 and 36 131 </p> 80 <p>Fedora 39 and 40 </p> 132 81 </li> 133 82 <li> 134 <p> 135 Gentoo Linux 136 </p> 83 <p>SUSE Linux Enterprise server 15 </p> 137 84 </li> 138 85 <li> 139 <p> 140 SUSE Linux Enterprise server 12 and 15 141 </p> 142 </li> 143 <li> 144 <p> 145 openSUSE Leap 15.3 146 </p> 86 <p>openSUSE Leap 15.3, 15.4 and 15.5</p> 147 87 </li> 148 88 </ul> 149 <p> 150 It should be possible to use <ph conkeyref="vbox-conkeyref-phrases/product-name"/> on most systems 151 based on Linux kernel 2.6, 3.x, 4.x or 5.x using either the 152 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> installer or by doing a manual installation. 153 See <xref href="install-linux-host.dita#install-linux-host"/>. However, the 154 formally tested and supported Linux distributions are those 155 for which we offer a dedicated package. 156 </p> 89 <p> It should be possible to use <ph conkeyref="vbox-conkeyref-phrases/product-name"/> on 90 most systems based on Linux kernel 2.6 or later, using either the <ph 91 conkeyref="vbox-conkeyref-phrases/product-name"/> installer or by doing a manual 92 installation. See <xref href="install-linux-host.dita#install-linux-host"/>. However, the 93 formally tested and supported Linux distributions are those for which we offer a dedicated 94 package. </p> 157 95 <p> 158 96 Note that Linux 2.4-based host OSes are no longer supported. -
trunk/doc/manual/en_US/dita/topics/hostpowertweaks.dita
r99797 r105134 11 11 <ul> 12 12 <li> 13 <p><b outputclass="bold">Host Suspends.</b> This event is 14 generated when the host is about to suspend, that is, the host 15 saves the state to some non-volatile storage and powers off. 16 </p> 13 <p><b outputclass="bold">Host Suspends.</b> This event is generated when the host is about 14 to suspend, that is, the host saves the state to some nonvolatile storage and powers off. </p> 17 15 <p> 18 16 This event is currently only handled on Windows hosts and Mac -
trunk/doc/manual/en_US/dita/topics/install-mac-unattended.dita
r99797 r105134 5 5 6 6 <body> 7 <p> 8 To perform a non-interactive installation of <ph conkeyref="vbox-conkeyref-phrases/product-name"/> you 9 can use the command line version of the installer application. 10 </p> 7 <p> To perform a noninteractive installation of <ph 8 conkeyref="vbox-conkeyref-phrases/product-name"/> you can use the command line version of 9 the installer application. </p> 11 10 <p> 12 11 Mount the <filepath>dmg</filepath> disk image file, as described -
trunk/doc/manual/en_US/dita/topics/install-solaris-performing.dita
r99797 r105134 6 6 <body> 7 7 <p> 8 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> is available as a standard Oracle Solaris 9 package. Download the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> SunOS package, which 10 includes the 64-bit version of <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. <i>The 11 installation must be performed as root and from the global 12 zone</i>. This is because the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> installer 13 loads kernel drivers, which cannot be done from non-global 14 zones. To verify which zone you are currently in, execute the 15 <userinput>zonename</userinput> command. 16 </p> 8 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> is available as a standard Oracle 9 Solaris package. Download the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> SunOS 10 package, which includes the 64-bit version of <ph 11 conkeyref="vbox-conkeyref-phrases/product-name"/>. <i>The installation must be performed as 12 root and from the global zone</i>. This is because the <ph 13 conkeyref="vbox-conkeyref-phrases/product-name"/> installer loads kernel drivers, which 14 cannot be done from non-global zones. To verify which zone you are currently in, execute the 15 <userinput>zonename</userinput> command. </p> 17 16 <p> 18 17 To start installation, run the following commands: … … 24 23 </p> 25 24 <pre xml:space="preserve">pkgadd -d VirtualBox-<varname>version-number</varname>-SunOS.pkg</pre> 26 <p> 27 The installer will then prompt you to enter the package you wish 28 to install. Choose <b outputclass="bold">1</b> or 29 <b outputclass="bold">all</b> and proceed. Next the 30 installer will ask you if you want to allow the postinstall 31 script to be executed. Choose <b outputclass="bold">y</b> 32 and proceed, as it is essential to execute this script which 33 installs the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> kernel module. Following this 34 confirmation the installer will install <ph conkeyref="vbox-conkeyref-phrases/product-name"/> and 35 execute the postinstall setup script. 36 </p> 25 <p> The installer will then prompt you to enter the package you want to install. Choose <b 26 outputclass="bold">1</b> or <b outputclass="bold">all</b> and proceed. Next the installer 27 will ask you if you want to allow the postinstall script to be executed. Choose <b 28 outputclass="bold">y</b> and proceed, as it is essential to execute this script which 29 installs the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> kernel module. Following 30 this confirmation the installer will install <ph 31 conkeyref="vbox-conkeyref-phrases/product-name"/> and execute the postinstall setup script. </p> 37 32 <p> 38 33 Once the postinstall script has been executed your installation -
trunk/doc/manual/en_US/dita/topics/install-solaris-unattended.dita
r99797 r105134 5 5 6 6 <body> 7 <p> 8 To perform a non-interactive installation of <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 9 there is a response file named 10 <filepath>autoresponse</filepath>. The installer uses this for 11 responses to inputs, rather than prompting the user. 12 </p> 7 <p> To perform a noninteractive installation of <ph 8 conkeyref="vbox-conkeyref-phrases/product-name"/> there is a response file named 9 <filepath>autoresponse</filepath>. The installer uses this for responses to inputs, rather 10 than prompting the user. </p> 13 11 <p> 14 12 Extract the tar.gz package as described in … … 17 15 </p> 18 16 <pre xml:space="preserve">pkgadd -d VirtualBox-<varname>version-number</varname>-SunOS-x86 -n -a autoresponse SUNWvbox</pre> 19 <p> 20 To perform a non-interactive uninstallation, open a root 21 terminal session and run the following command: 22 </p> 17 <p> To perform a noninteractive uninstallation, open a root terminal session and run the 18 following command: </p> 23 19 <pre xml:space="preserve">pkgrm -n -a /opt/VirtualBox/autoresponse SUNWvbox</pre> 24 20 </body> -
trunk/doc/manual/en_US/dita/topics/install-win-performing.dita
r99797 r105134 63 63 </p> 64 64 <note> 65 <p> 66 Python version at least 2.6 is required. Python 3 is also 67 supported. 68 </p> 65 <p> Python version 3 is required. Python version 2.x is no longer supported. </p> 69 66 </note> 70 67 </li> -
trunk/doc/manual/en_US/dita/topics/intro-save-machine-state.dita
r99797 r105134 3 3 <topic xml:lang="en-us" id="intro-save-machine-state"> 4 4 <title>Saving the State of the Machine</title> 5 6 5 <body> 7 6 <p> -
trunk/doc/manual/en_US/dita/topics/keyb_mouse_normal.dita
r99797 r105134 43 43 </p> 44 44 <fig id="fig-host-key"> 45 <title>Host Key Setting on the Virtual Machine Taskbar</title>45 <title>Host Key Setting on the Virtual Machine Status Bar</title> 46 46 <xref href="images/vm-hostkey.png" format="png" platform="htmlhelp"> 47 47 <image href="images/vm-hostkey.png" width="7cm" placement="break"> 48 <alt>Host Key Setting on the Virtual Machine Taskbar</alt>48 <alt>Host Key Setting on the Virtual Machine Status Bar</alt> 49 49 </image> 50 50 </xref> 51 51 <image platform="ohc" href="images/vm-hostkey.png" width="7cm" placement="break"> 52 <alt>Host Key Setting on the Virtual Machine Taskbar</alt>52 <alt>Host Key Setting on the Virtual Machine Status Bar</alt> 53 53 </image> 54 54 </fig> -
trunk/doc/manual/en_US/dita/topics/log-viewer.dita
r99797 r105134 11 11 that enables you to view and analyze system logs. 12 12 </p> 13 <!-- 7.1: New pic required? Tab operation changed. Log Viewer/Filter pane. bugref:10496 --> 13 14 <fig id="fig-log-viewer-tool"> 14 15 <title>Log Viewer Tool, Showing System Events</title> … … 82 83 </li> 83 84 <li> 84 <p><b outputclass="bold">Options:</b> Configures the text 85 display used in the log message window. 86 </p> 85 <p><b outputclass="bold">Preferences:</b> Configures the text display used in the log 86 message window. </p> 87 87 </li> 88 88 <li> -
trunk/doc/manual/en_US/dita/topics/mouse-capture.dita
r99797 r105134 17 17 released. 18 18 </p> 19 <p> 20 The default behavior is sometimes not desired. Therefore it can 21 be configured as follows: 22 </p> 19 <p> The default behavior is sometimes not appropriate. Therefore it can be configured as 20 follows: </p> 23 21 <pre xml:space="preserve">VBoxManage setextradata <varname>VM-name</varname> GUI/MouseCapturePolicy <varname>mode</varname> 24 22 </pre> -
trunk/doc/manual/en_US/dita/topics/nat-adv-dns.dita
r98549 r105134 5 5 6 6 <body> 7 <p> 8 The NAT engine by default offers the same DNS servers to the 9 guest that are configured on the host. In some scenarios, it can 10 be desirable to hide the DNS server IPs from the guest, for 11 example when this information can change on the host due to 12 expiring DHCP leases. In this case, you can tell the NAT engine 13 to act as DNS proxy using the following command: 14 </p> 7 <p> The NAT engine by default offers the same DNS servers to the guest that are configured on 8 the host. In some scenarios, it can be appropriate to hide the DNS server IPs from the guest, 9 for example when this information can change on the host due to expiring DHCP leases. In this 10 case, you can tell the NAT engine to act as DNS proxy using the following command: </p> 15 11 <pre xml:space="preserve">$ VBoxManage modifyvm <varname>VM-name</varname> --natdnsproxy1 on</pre> 16 12 </body> -
trunk/doc/manual/en_US/dita/topics/nat-limitations.dita
r99797 r105134 21 21 </li> 22 22 <li> 23 <p><b outputclass="bold">Receiving of UDP 24 broadcasts.</b> The guest does not reliably receive 25 UDP broadcasts. In order to save resources, it only listens 26 for a certain amount of time after the guest has sent UDP 27 data on a particular port. As a consequence, NetBios name 28 resolution based on broadcasts does not always work, but 29 WINS always works. As a workaround, you can use the numeric 30 IP of the desired server in the 31 <filepath>\\<varname>server</varname>\<varname>share</varname></filepath> 32 notation. 33 </p> 23 <p><b outputclass="bold">Receiving of UDP broadcasts.</b> The guest does not reliably 24 receive UDP broadcasts. In order to save resources, it only listens for a certain amount 25 of time after the guest has sent UDP data on a particular port. As a consequence, NetBios 26 name resolution based on broadcasts does not always work, but WINS always works. As a 27 workaround, you can use the numeric IP of the required server in the 28 <filepath>\\<varname>server</varname>\<varname>share</varname></filepath> notation. </p> 34 29 </li> 35 30 <li> … … 52 47 </li> 53 48 </ul> 54 <p> 55 These limitations normally do not affect standard network use. 56 But the presence of NAT has also subtle effects that may 57 interfere with protocols that are normally working. One example 58 is NFS, where the server is often configured to refuse 59 connections from non-privileged ports, which are those ports not 60 below 1024. 61 </p> 49 <p> These limitations normally do not affect standard network use. But the presence of NAT has 50 also subtle effects that may interfere with protocols that are normally working. One example 51 is NFS, where the server is often configured to refuse connections from non-privileged ports, 52 which are those ports above 1024. </p> 62 53 </body> 63 54 -
trunk/doc/manual/en_US/dita/topics/network_bridged.dita
r99797 r105134 82 82 certain conditions. 83 83 </p> 84 <p> 85 Some adapters strip VLAN tags in hardware. This does not allow 86 you to use VLAN trunking between VM and the external network 87 with pre-2.6.27 Linux kernels, or with host operating systems 88 other than Linux. 89 </p> 84 <p> Some adapters strip VLAN tags in hardware. This does not allow you to use VLAN trunking 85 between VM and the external network with Linux kernels before 2.6.27, or with host 86 operating systems other than Linux. </p> 90 87 </li> 91 88 <li> -
trunk/doc/manual/en_US/dita/topics/network_hostonly.dita
r99797 r105134 111 111 </p> 112 112 </note> 113 <p> 114 On Linux, macOS and Solaris <ph conkeyref="vbox-conkeyref-phrases/product-name"/> will only allow IP 115 addresses in 192.168.56.0/21 range to be assigned to host-only 116 adapters. For IPv6 only link-local addresses are allowed. If other 117 ranges are desired, they can be enabled by creating 118 <filepath>/etc/vbox/networks.conf</filepath> and specifying 119 allowed ranges there. For example, to allow 10.0.0.0/8 and 120 192.168.0.0/16 IPv4 ranges as well as 2001::/64 range put the 121 following lines into <filepath>/etc/vbox/networks.conf</filepath>: 122 </p> 113 <p> On Linux, macOS and Solaris <ph conkeyref="vbox-conkeyref-phrases/product-name"/> will only 114 allow IP addresses in 192.168.56.0/21 range to be assigned to host-only adapters. For IPv6 115 only link-local addresses are allowed. If other ranges are required, they can be enabled by 116 creating <filepath>/etc/vbox/networks.conf</filepath> and specifying allowed ranges there. For 117 example, to allow 10.0.0.0/8 and 192.168.0.0/16 IPv4 ranges as well as 2001::/64 range put the 118 following lines into <filepath>/etc/vbox/networks.conf</filepath>: </p> 123 119 <pre xml:space="preserve"> * 10.0.0.0/8 192.168.0.0/16 124 120 * 2001::/64 -
trunk/doc/manual/en_US/dita/topics/network_performance.dita
r99797 r105134 27 27 </p> 28 28 </note> 29 <p> 30 Three attachment types: Internal, Bridged, and Host-Only, have 31 nearly identical performance. The Internal type is a little bit 32 faster and uses less CPU cycles as the packets never reach the 33 host's network stack. The NAT attachment type is the slowest and 34 most secure of all attachment types, as it provides network 35 address translation. The generic driver attachment is special and 36 cannot be considered as an alternative to other attachment types. 37 </p> 29 <p> Three attachment types: Internal, Bridged, and Host-Only, have nearly identical 30 performance. The Internal type is slightly faster and uses less CPU cycles as the packets 31 never reach the host's network stack. The NAT attachment type is the slowest and most secure 32 of all attachment types, as it provides network address translation. The generic driver 33 attachment is special and cannot be considered as an alternative to other attachment types. </p> 38 34 <p> 39 35 The number of CPUs assigned to VM does not improve network … … 58 54 </li> 59 55 <li> 60 <p> 61 Make sure segmentation offloading is enabled in the guest OS. 62 Usually it will be enabled by default. You can check and 63 modify offloading settings using the 64 <userinput>ethtool</userinput> command on Linux guests. 65 </p> 56 <p> Ensure segmentation offloading is enabled in the guest OS. Usually it will 57 be enabled by default. You can check and modify offloading settings using the 58 <userinput>ethtool</userinput> command on Linux guests. </p> 66 59 </li> 67 60 <li> -
trunk/doc/manual/en_US/dita/topics/networkingmodes.dita
r99797 r105134 74 74 with <ph conkeyref="vbox-conkeyref-phrases/product-name"/> or be distributed in an extension pack. 75 75 </p> 76 <p> 77 The following sub-modes are available: 78 </p> 76 <p> The following submodes are available: </p> 79 77 <ul> 80 78 <li> -
trunk/doc/manual/en_US/dita/topics/pcspeaker_passthrough.dita
r99797 r105134 212 212 some hints, but in general refer to the Linux documentation. 213 213 </p> 214 <p> 215 If you have trouble getting any beeps even if the device 216 permissions are set up and VBox.log confirms that it uses evdev or 217 console for the PC speaker control, check if your system has a PC 218 speaker. Some systems do not have one. Other complications can 219 arise from Linux rerouting the PC speaker output to a sound card. 220 Check if the beeps are audible if you connect speakers to your 221 sound card. Today almost all systems have one. Finally, check if 222 the audio mixer control has a channel named "beep", which could be 223 hidden in the mixer settings, and that it is not muted. 224 </p> 214 <p> If you have trouble getting any beeps even if the device permissions are set up and VBox.log 215 confirms that it uses evdev or console for the PC speaker control, check if your system has a 216 PC speaker. Some systems do not have one. Other complications can arise from Linux rerouting 217 the PC speaker output to a sound card. Check if the beeps are audible if you connect speakers 218 to your sound card. Today almost all systems have one. Finally, check if the audio mixer 219 control has a channel named <i>beep</i>, which could be hidden in the mixer settings, and that 220 it is not muted. </p> 225 221 </body> 226 222 -
trunk/doc/manual/en_US/dita/topics/preface-accessibility.dita
r99016 r105134 5 5 <body> 6 6 <section id="accessibility-body"> 7 <p> Oracle customers that have purchased support have access to electronic support through My8 Oracle Support. For information, visit <xref href="https://www.oracle.com/corporate/accessibility/learning-support.html#support-tab" format="html" scope="external"/>. </p>7 <p> Oracle customers that have purchased support have access to electronic support through 8 <xref href="https://www.oracle.com/corporate/accessibility/learning-support.html#support-tab" format="html" scope="external">Oracle Accessibility Learning and Support</xref>. </p> 9 9 </section> 10 10 </body> -
trunk/doc/manual/en_US/dita/topics/preface-doc-accessibility.dita
r99016 r105134 5 5 <body> 6 6 <section id="doc-accessibility-body"> 7 <p> For information about Oracle's commitment to accessibility, visit the Oracle Accessibility 8 Program website at <xref href="http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc" format="html" scope="external"/>. </p> 9 <p>For information about the accessibility of the Oracle Help Center, see the Oracle 10 Accessibility Conformance Report at <xref href="https://www.oracle.com/corporate/accessibility/templates/t2-11535.html" format="html" scope="external"/>.</p> 7 <p>For information about Oracle's commitment to accessibility, visit the <xref href="https://www.oracle.com/corporate/accessibility/" format="html" scope="external">Oracle Accessibility Program</xref>. </p> 11 8 </section> 12 9 </body> -
trunk/doc/manual/en_US/dita/topics/preferences.dita
r99797 r105134 9 9 to all virtual machines of the current user. 10 10 </p> 11 <note> 12 <p>The available Preferences settings depend on the selected experience level. To display all 13 Preference settings, ensure the experience level is set to <b>Expert</b>.</p> 14 <p>See <xref href="ui-experience-level.dita#gui-experience-level"/>.</p> 15 </note> 11 16 <p> 12 17 To display the Preferences window, do either of the following: … … 20 25 </li> 21 26 <li> 22 <p> 23 Click <b outputclass="bold">Preferences</b> on the 24 Welcome screen in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. 25 </p> 27 <p> Click <b outputclass="bold">Preferences</b> on the Welcome screen in <ph 28 conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. </p> 26 29 </li> 27 30 </ul> … … 52 55 </li> 53 56 <li> 54 <p><b outputclass="bold">Language.</b> Enables you to 55 specify the language used for menus, labels, and text in 56 <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. 57 </p> 57 <p><b outputclass="bold">Language.</b> Enables you to specify the language used for menus, 58 labels, and text in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. </p> 58 59 </li> 59 60 <li> … … 62 63 default scale factor can be specified for all guest screens. 63 64 </p> 65 <p>A default font scaling factor can be set for all guest screen displays.</p> 66 <p>Other extended features can be selected, to ensure that guest screens work well with the host display.</p> 64 67 </li> 65 68 <li> 66 <p><b outputclass="bold">Proxy.</b> Enables you to 67 configure an HTTP Proxy Server. 69 <p><b outputclass="bold">Proxy.</b> Enables you to configure an HTTP proxy server. 68 70 </p> 69 71 </li> 70 72 <li> 71 <p><b outputclass="bold">Interface.</b> Enables you to 72 select a color theme for the <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> user interface. 73 </p> 73 <p><b outputclass="bold">Interface.</b> Enables you to select a color theme for the <ph 74 conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> user interface. </p> 74 75 <note> 75 76 <p> -
trunk/doc/manual/en_US/dita/topics/rdp-viewers.dita
r99016 r105134 5 5 6 6 <body> 7 <p> 8 Since VRDP is backwards-compatible to RDP, you can use any 9 standard RDP viewer to connect to such a remote virtual machine. 10 For this to work, you must specify the IP address of your 11 <i>host</i> system, not of the virtual machine, as 12 the server address to connect to. You must also specify the port 13 number that the VRDP server is using. 14 </p> 7 <p> Since VRDP is backward-compatible to RDP, you can use any standard RDP viewer to connect to 8 such a remote virtual machine. For this to work, you must specify the IP address of your 9 <i>host</i> system, not of the virtual machine, as the server address to connect to. You 10 must also specify the port number that the VRDP server is using. </p> 15 11 <p> 16 12 The following examples are for the most common RDP viewers: -
trunk/doc/manual/en_US/dita/topics/security-general.dita
r99797 r105134 11 11 <ul> 12 12 <li> 13 <p><b outputclass="bold">Keep software up to date</b>. One 14 of the principles of good security practise is to keep all 15 software versions and patches up to date. Activate the 16 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> update notification to get notified when a new 17 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> release is available. When updating 18 <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, do not forget to update the Guest Additions. 19 Keep the host operating system as well as the guest operating 20 system up to date. 21 </p> 13 <p><b outputclass="bold">Keep software up-to-date</b>. One of the principles of good 14 security practise is to keep all software versions and patches up-to-date. Activate the 15 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> update notification to get 16 notified when a new <ph conkeyref="vbox-conkeyref-phrases/product-name"/> release is 17 available. When updating <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, do not 18 forget to update the Guest Additions. Keep the host operating system as well as the guest 19 operating system up-to-date. </p> 22 20 </li> 23 21 <li> … … 55 53 </li> 56 54 <li> 57 <p><b outputclass="bold">Keep up to date on latest security 58 information.</b> Oracle continually improves its 59 software and documentation. Check this note yearly for 60 revisions. 61 </p> 55 <p><b outputclass="bold">Keep up-to-date on latest security information.</b> Oracle 56 continually improves its software and documentation. Check this note yearly for revisions. </p> 62 57 </li> 63 58 </ul> -
trunk/doc/manual/en_US/dita/topics/security-networking.dita
r99016 r105134 5 5 6 6 <body> 7 <p> 8 The default networking mode for VMs is NAT which means that 9 the VM acts like a computer behind a router, see 10 <xref href="network_nat.dita">Network Address Translation (NAT)</xref>. The guest is part of a private 11 subnet belonging to this VM and the guest IP is not visible 12 from the outside. This networking mode works without any 13 additional setup and is sufficient for many purposes. Keep in 14 mind that NAT allows access to the host operating system's 15 loopback interface. 16 </p> 7 <p> The default networking mode for VMs is NAT which means that the VM acts like a computer 8 behind a router, see <xref href="network_nat.dita">Network Address Translation (NAT)</xref>. 9 The guest is part of a private subnet belonging to this VM and the guest IP is not visible 10 from the outside. This networking mode works without any additional setup and is sufficient 11 for many purposes. Remember that NAT allows access to the host operating system's loopback 12 interface. </p> 17 13 <p> 18 14 If bridged networking is used, the VM acts like a computer -
trunk/doc/manual/en_US/dita/topics/security_clipboard.dita
r99016 r105134 3 3 <topic xml:lang="en-us" id="security_clipboard"> 4 4 <title>Clipboard</title> 5 5 <!-- 7.1: Shared clipboard toggle in guest VM, bugref:10481; input from dev required --> 6 6 <body> 7 7 <p> … … 14 14 from the host which is shared over the clipboard. 15 15 </p> 16 <p> 17 If the guest is able to read from and/or write to the host 18 clipboard then a remote user connecting to the guest over the 19 network will also gain this ability, which may not be 20 desirable. As a consequence, the shared clipboard is disabled 21 for new machines. 22 </p> 16 <p> If the guest is able to read from or write to the host clipboard then a remote user 17 connecting to the guest over the network will also gain this ability, which may not be 18 appropriate. As a consequence, the shared clipboard is disabled for new machines. </p> 23 19 </body> 24 20 -
trunk/doc/manual/en_US/dita/topics/serialports.dita
r99797 r105134 136 136 </li> 137 137 </ul> 138 <p> 139 In this case, you can configure whether <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 140 should create the named pipe, or the local domain socket 141 non-Windows hosts, itself or whether <ph conkeyref="vbox-conkeyref-phrases/product-name"/> should 142 assume that the pipe or socket exists already. With the 143 <userinput>VBoxManage</userinput> command-line options, this 144 is referred to as server mode or client mode, 145 respectively. 146 </p> 138 <p> In this case, you can configure whether <ph 139 conkeyref="vbox-conkeyref-phrases/product-name"/> should create the named pipe, or 140 the local domain socket on non-Windows hosts, itself or whether <ph 141 conkeyref="vbox-conkeyref-phrases/product-name"/> should assume that the pipe or 142 socket exists already. With the <userinput>VBoxManage</userinput> command-line 143 options, this is referred to as server mode or client mode, respectively. </p> 147 144 <p> 148 145 For a direct connection between two virtual machines, -
trunk/doc/manual/en_US/dita/topics/settings-basic.dita
r99797 r105134 17 17 the VM's configuration files. If you change the name, 18 18 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> renames these files as well. As a result, you 19 can only use characters which are allowed for file names on 20 your host OS. 19 can only use characters which are allowed for file names on your host OS. 21 20 </p> 22 21 <p> … … 27 26 </li> 28 27 <li> 29 <p><b outputclass="bold">Type:</b> The type of the guest 30 OS for the VM. This is the same setting that is specified in 28 <p><b outputclass="bold">Type and Subtype:</b> The type and subtype of the guest 29 OS for the VM. For example, if the <b>Type</b> is Linux, the <b>Subtype</b> might be 30 Oracle Linux.</p> 31 <p>These are the same settings that are specified in 31 32 the <b outputclass="bold">New Virtual Machine</b> 32 33 wizard. See <xref href="create-vm-wizard.dita#create-vm-wizard"/>. -
trunk/doc/manual/en_US/dita/topics/settings-capture.dita
r99016 r105134 49 49 </li> 50 50 <li> 51 <p><b outputclass="bold">Video Quality:</b> Use the 52 slider to set the the bit rate of the video in kilobits per 53 second. Increasing this value improves the appearance of the 54 video at the cost of an increased file size. 55 </p> 51 <p><b outputclass="bold">Video Quality:</b> Use the slider to set the bit rate of the video 52 in kilobits per second. Increasing this value improves the appearance of the video at the 53 cost of an increased file size. </p> 56 54 </li> 57 55 <li> -
trunk/doc/manual/en_US/dita/topics/settings-general-advanced.dita
r99797 r105134 42 42 virtual machine. 43 43 </p> 44 <!--7.1: r159813: checkbox added to the Shared Clipboard menu? --> 44 45 </li> 45 46 <li> -
trunk/doc/manual/en_US/dita/topics/settings-motherboard.dita
r99797 r105134 58 58 for guest OSes which do not require it. 59 59 </p> 60 <!-- 7.1: Any chipset options for Arm?--> 60 61 </li> 61 62 <li> -
trunk/doc/manual/en_US/dita/topics/settings-screen.dita
r99797 r105134 7 7 <ul> 8 8 <li> 9 <p><b outputclass="bold">Video Memory:</b> Sets the size 10 of the memory provided by the virtual graphics card 11 available to the guest, in MB. As with the main memory, the 12 specified amount will be allocated from the host's resident 13 memory. Based on the amount of video memory, higher 14 resolutions and color depths may be available. 15 </p> 9 <p><b outputclass="bold">Video Memory:</b> Sets the size of the memory provided by the 10 virtual graphics card available to the guest, in megabytes. As with the main memory, the 11 specified amount will be allocated from the host's resident memory. Based on the amount of 12 video memory, higher resolutions and color depths may be available. </p> 16 13 <p> 17 14 <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> will show a warning if the amount of video memory -
trunk/doc/manual/en_US/dita/topics/settings-storage.dita
r99797 r105134 81 81 format. 82 82 </p> 83 <p> 84 You can modify these media attachments freely. For example, if you 85 wish to copy some files from another virtual disk that you 86 created, you can connect that disk as a second hard disk, as in 87 the above screenshot. You could also add a second virtual CD/DVD 88 drive, or change where these items are attached. The following 89 options are available: 90 </p> 83 <p> You can modify these media attachments freely. For example, if you want to copy some files 84 from another virtual disk that you created, you can connect that disk as a second hard disk, 85 as in the above screenshot. You could also add a second virtual CD/DVD drive, or change where 86 these items are attached. The following options are available: </p> 91 87 <ul> 92 88 <li> -
trunk/doc/manual/en_US/dita/topics/settings-usb.dita
r99797 r105134 6 6 7 7 <body> 8 <p>The <b outputclass="bold">USB</b> section in a virtual machine's <b 9 outputclass="bold">Settings</b> window enables you to configure <ph 10 conkeyref="vbox-conkeyref-phrases/product-name"/>'s sophisticated USB support. </p> 11 <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> can enable virtual 12 machines to access the USB devices on your host directly. To achieve this, <ph 13 conkeyref="vbox-conkeyref-phrases/product-name"/> presents the guest OS with a virtual USB 14 controller. </p> 8 15 <p> 9 The <b outputclass="bold">USB</b> section in a virtual 10 machine's <b outputclass="bold">Settings</b> window 11 enables you to configure <ph conkeyref="vbox-conkeyref-phrases/product-name"/>'s sophisticated USB 12 support. 13 </p> 14 <p> 15 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can enable virtual machines to access the USB 16 devices on your host directly. To achieve this, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 17 presents the guest OS with a virtual USB controller. As soon as 18 the guest system starts using a USB device, it will appear as 19 unavailable on the host. 16 <note id="note_bzl_prv_qbc" type="caution"> 17 <p>As soon as the guest system starts using a USB device, it will be disconnected from the 18 host without a proper shutdown. This may cause data loss.</p> 19 </note> 20 20 </p> 21 21 <note> 22 <ul> 23 <li> 24 <p> 25 Be careful with USB devices that are currently in use on 26 the host. For example, if you allow your guest to connect 27 to your USB hard disk that is currently mounted on the 28 host, when the guest is activated, it will be disconnected 29 from the host without a proper shutdown. This may cause 30 data loss. 31 </p> 32 </li> 33 <li> 34 <p> 35 Oracle Solaris hosts have a few known limitations 36 regarding USB support. See <xref href="KnownIssues.dita">Known Limitations</xref>. 37 </p> 38 </li> 22 <p>Oracle Solaris hosts have a few known limitations regarding USB support. See <xref 23 href="KnownIssues.dita">Known Limitations</xref>. </p> 24 </note> 25 <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> also enables your guests 26 to connect to remote USB devices by use of the VirtualBox Remote Desktop Extension (VRDE). See 27 <xref href="usb-over-rdp.dita">Remote USB</xref>. </p> 28 <section id="section_pfm_vsv_qbc"> 29 <title>Enable USB for a VM</title> 30 </section> 31 32 <ol id="ol_fpr_wsv_qbc"> 33 <li>Ensure the VM is not running.</li> 34 <li>Select the VM in the machine list, and then click <b outputclass="bold" 35 >Settings</b>.</li> 36 <li>On the USB tab, select <b outputclass="bold">Enable USB Controller</b> and choose the 37 USB Controller you need for your guest OS. In most cases this will be xHCI. Only use OHCI or 38 EHCI if your guest OS does not support xHCI. For some legacy Windows guests you'll need to 39 install third party drivers for xHCI support. <p> 40 <ul id="ul_rzz_l5v_qbc"> 41 <li>OHCI supports USB 1.1 </li> 42 <li>EHCI supports USB 2.0. This also enables OHCI.</li> 43 <li>xHCI supports all USB speeds up to USB 3.0</li> 39 44 </ul> 40 </note> 41 <p> 42 In addition to allowing a guest access to your local USB 43 devices, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> even enables your guests to connect to 44 remote USB devices by use of the VirtualBox Remote Desktop 45 Extension (VRDE). See <xref href="usb-over-rdp.dita">Remote USB</xref>. 46 </p> 47 <p> 48 To enable USB for a VM, select the <b outputclass="bold">Enable 49 USB Controller</b> check box. The following settings are 50 available: 51 </p> 52 <ul> 45 </p></li> 46 47 48 49 <li>Specify which devices can be attached to the guest by adding <b 50 outputclass="bold">USB Device Filters</b>. USB devices with a matching filter will be 51 automatically passed to the guest once they are attached to the host. USB devices without a 52 matching filter can be passed manually to the guest, for example by using the <b 53 outputclass="bold">Devices</b>, <b outputclass="bold">USB</b> menu. <ul 54 id="ul_jjz_cxv_qbc"> 55 <li>Click the USB filter button to create a new filter with blank fields, and then 56 complete the fields. </li> 57 <li>Or, click the Add USB filter button to create a filter with the fields completed for 58 the selected USB device. </li> 59 </ul><p>Give the filter a name, for later reference, and specify the filter criteria. The 60 more criteria you specify, the more precisely devices will be selected. For instance, if 61 you specify only a vendor ID of 046d, all devices produced by Logitech will be available 62 to the guest. If you fill in all fields, on the other hand, the filter will only apply to 63 a particular device model from a particular vendor, and not even to other devices of the 64 same type with a different revision and serial number. </p><p>The following criteria are 65 available: </p><ul id="ul_av4_41w_qbc"> 53 66 <li> 54 <p> 55 <b outputclass="bold">USB Controller:</b> Selects a 56 controller with the specified level of USB support, as 57 follows: 58 </p> 59 <ul> 60 <li> 61 <p> 62 OHCI for USB 1.1 63 </p> 67 <p><b outputclass="bold">Vendor and Product ID.</b> With USB, each vendor of USB 68 products carries an identification number that is unique world-wide, called the 69 <i>vendor ID</i>. Similarly, each line of products is assigned a <i>product ID</i> 70 number. Both numbers are commonly written in hexadecimal, and a colon separates the 71 vendor from the product ID. For example, <codeph>046d:c016</codeph> stands for 72 Logitech as a vendor, and the M-UV69a Optical Wheel Mouse product. </p> 73 <p>Alternatively, you can also specify <b outputclass="bold">Manufacturer</b> and <b 74 outputclass="bold">Product</b> by name. </p> 75 <p>To list all the USB devices that are connected to your host machine with their 76 respective vendor IDs and product IDs, use the following command: </p> 77 <pre xml:space="preserve" id="pre_bv4_41w_qbc">VBoxManage list usbhost</pre> 78 <p>On Windows, you can also see all USB devices that are attached to your system in the 79 Device Manager. On Linux, you can use the <userinput>lsusb</userinput> command. </p> 64 80 </li> 65 81 <li> 66 <p> 67 EHCI for USB 2.0. This also enables OHCI. 68 </p> 82 <p><b outputclass="bold">Serial Number.</b> While vendor ID and product ID are quite 83 specific to identify USB devices, if you have two identical devices of the same brand 84 and product line, you will also need their serial numbers to filter them out 85 correctly. </p> 69 86 </li> 70 87 <li> 71 <p> 72 xHCI for USB 3.0. This supports all USB speeds. 73 </p> 88 <p><b outputclass="bold">Remote.</b> This setting specifies whether the device will be 89 local only, remote only, such as over VRDP, or either. </p> 74 90 </li> 75 </ul> 76 </li> 91 </ul><p>As an example, you could create a new USB filter and specify a vendor ID of 046d for 92 Logitech, Inc, a manufacturer index of 1, and <i>not remote</i>. Then any USB devices on 93 the host system produced by Logitech, Inc with a manufacturer index of 1 will be visible 94 to the guest system. </p><p>Several filters can select a single device. For example, a 95 filter which selects all Logitech devices, and one which selects a particular webcam. 96 </p></li> 77 97 <li> 78 <p> 79 <b outputclass="bold">USB Device Filters:</b> When 80 USB support is enabled for a VM, you can determine in detail 81 which devices will be automatically attached to the guest. 82 For this, you can create filters by specifying certain 83 properties of the USB device. USB devices with a matching 84 filter will be automatically passed to the guest once they 85 are attached to the host. USB devices without a matching 86 filter can be passed manually to the guest, for example by 87 using the <b outputclass="bold">Devices</b>, 88 <b outputclass="bold">USB</b> menu. 89 </p> 90 <p> 91 Clicking on the <b outputclass="bold">+</b> button to 92 the right of the <b outputclass="bold">USB Device 93 Filters</b> window creates a new filter. You can give 94 the filter a name, for later reference, and specify the 95 filter criteria. The more criteria you specify, the more 96 precisely devices will be selected. For instance, if you 97 specify only a vendor ID of 046d, all devices produced by 98 Logitech will be available to the guest. If you fill in all 99 fields, on the other hand, the filter will only apply to a 100 particular device model from a particular vendor, and not 101 even to other devices of the same type with a different 102 revision and serial number. 103 </p> 104 <p> 105 In detail, the following criteria are available: 106 </p> 107 <ul> 108 <li> 109 <p> 110 <b outputclass="bold">Vendor and Product ID.</b> 111 With USB, each vendor of USB products carries an 112 identification number that is unique world-wide, called 113 the <i>vendor ID</i>. Similarly, each line 114 of products is assigned a <i>product 115 ID</i> number. Both numbers are commonly written 116 in hexadecimal, and a colon separates the vendor from 117 the product ID. For example, 118 <codeph>046d:c016</codeph> stands for Logitech as a 119 vendor, and the M-UV69a Optical Wheel Mouse product. 120 </p> 121 <p> 122 Alternatively, you can also specify 123 <b outputclass="bold">Manufacturer</b> and 124 <b outputclass="bold">Product</b> by name. 125 </p> 126 <p> 127 To list all the USB devices that are connected to your 128 host machine with their respective vendor IDs and 129 product IDs, use the following command: 130 </p> 131 <pre xml:space="preserve">VBoxManage list usbhost</pre> 132 <p> 133 On Windows, you can also see all USB devices that are 134 attached to your system in the Device Manager. On Linux, 135 you can use the <userinput>lsusb</userinput> command. 136 </p> 98 <p>On a Windows host, you will need to unplug and reconnect a USB device to use it after 99 creating a filter for it. </p> 137 100 </li> 138 101 <li> 139 <p> 140 <b outputclass="bold">Serial Number.</b> While 141 vendor ID and product ID are quite specific to identify 142 USB devices, if you have two identical devices of the 143 same brand and product line, you will also need their 144 serial numbers to filter them out correctly. 145 </p> 146 </li> 147 <li> 148 <p> 149 <b outputclass="bold">Remote.</b> This setting 150 specifies whether the device will be local only, remote 151 only, such as over VRDP, or either. 152 </p> 153 </li> 154 </ul> 155 <p> 156 On a Windows host, you will need to unplug and reconnect a 157 USB device to use it after creating a filter for it. 158 </p> 159 <p> 160 As an example, you could create a new USB filter and specify 161 a vendor ID of 046d for Logitech, Inc, a manufacturer index 162 of 1, and "not remote". Then any USB devices on the host 163 system produced by Logitech, Inc with a manufacturer index 164 of 1 will be visible to the guest system. 165 </p> 166 <p> 167 Several filters can select a single device. For example, a 168 filter which selects all Logitech devices, and one which 169 selects a particular webcam. 170 </p> 171 <p> 172 You can deactivate filters without deleting them by 173 deselecting the check box next to the filter name. 174 </p> 175 </li> 176 </ul> 102 <p>Ensure the filters you need immediately are selected in the list. Selected filters will 103 be attached automatically when the VM starts.</p> 104 </li></ol> 177 105 </body> 178 106 -
trunk/doc/manual/en_US/dita/topics/sf_mount_manual.dita
r99797 r105134 113 113 VBoxControl sharedfolder unuse D: 114 114 VBoxControl sharedfolder list</pre> 115 <p> 116 As with Windows guests, shared folders can also be accessed 117 via UNC using <filepath>\\VBoxSF\</filepath>, 118 <filepath>\\VBoxSvr\</filepath> or 119 <filepath>\\VBoxSrv\</filepath> as the server name and the 120 shared folder name as <varname>sharename</varname>. 121 </p> 115 <p> As with Windows guests, shared folders can also be accessed using UNC , 116 with <filepath>\\VBoxSF\</filepath>, <filepath>\\VBoxSvr\</filepath> or 117 <filepath>\\VBoxSrv\</filepath> as the server name and the shared folder name as 118 <varname>sharename</varname>. </p> 122 119 </li> 123 120 </ul> -
trunk/doc/manual/en_US/dita/topics/sharedfolders.dita
r103992 r105134 37 37 <ul> 38 38 <li> 39 <p> 40 In the window of a running VM, you select 41 <b outputclass="bold">Shared Folders</b> from the 42 <b outputclass="bold">Devices</b> menu, or click on the 43 folder icon on the status bar in the bottom right corner. 44 </p> 39 <p> In the window of a running VM, you select <b outputclass="bold">Shared 40 Folders</b> from the <b outputclass="bold">Devices</b> menu, or click the folder icon on 41 the status bar in the bottom right corner. </p> 45 42 </li> 46 43 <li> … … 110 107 For security reasons the guest OS is not allowed to create 111 108 symlinks by default. If you trust the guest OS to not abuse 112 th efunctionality, you can enable the creation of symlinks for109 this functionality, you can enable the creation of symlinks for 113 110 a shared folder as follows: 114 111 </p> … … 116 113 </li> 117 114 </ul> 118 115 <p> 119 116 If a symbolic link is created inside a shared folder on the host 120 and the installed Guest Additions do n't support symbolic links117 and the installed Guest Additions do not support symbolic links 121 118 then the guest will see the target of the symlink as a file 122 119 inside the shared folder. For example, if a symlink is created … … 127 124 </p> 128 125 <p> 129 And then the shared folder is viewed on a Windows guest there126 When the shared folder is viewed on a Windows guest there 130 127 will be two identical files listed, <userinput>filename</userinput> 131 128 and <userinput>symlink-to-filename</userinput>. -
trunk/doc/manual/en_US/dita/topics/soft-keyb-custom.dita
r99016 r105134 12 12 <note> 13 13 <p> 14 To perman anently save a custom keyboard layout, you must save14 To permanently save a custom keyboard layout, you must save 15 15 it to a file. Otherwise, any changes you make are discarded 16 16 when you close down the <b outputclass="bold">Soft -
trunk/doc/manual/en_US/dita/topics/soft-keyb.dita
r99797 r105134 4 4 5 5 <topic xml:lang="en-us" id="soft-keyb"> 6 <!-- 7.1: Updated pic added --> 6 7 <title>Soft Keyboard</title> 7 8 9 8 <body> 10 9 <p> … … 13 12 keyboard is an on-screen keyboard that can be used as an 14 13 alternative to a physical keyboard. See 15 <xref href="soft-keyb-using.dita#soft-keyb-using"/> 16 for details of how to use the 14 <xref href="soft-keyb-using.dita#soft-keyb-using"/> for details of how to use the 17 15 soft keyboard. 18 16 </p> -
trunk/doc/manual/en_US/dita/topics/solaris-zones.dita
r103593 r105134 4 4 <topic xml:lang="en-us" id="solaris-zones"> 5 5 <title>Configuring a Non-Global Zone for Running <ph conkeyref="vbox-conkeyref-phrases/product-name"/></title> 6 6 7 7 <body> 8 8 <p> … … 21 21 </p> 22 22 <p> 23 Use <userinput>zonecfg(8)</userinput> to add the <codeph>device</codeph> resource 23 Use <userinput>zonecfg(8)</userinput> to add the 24 <codeph>device</codeph> resource 24 25 and the <codeph>match</codeph> property for each 25 26 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> device node in the global … … 38 39 <filepath>/dev/vboxusbmon</filepath> device using the steps above. 39 40 </p> 40 <p> 41 Oracle Solaris 11 doesn't support sparse root zones so you will need to 42 loopback mount <filepath>/opt/VirtualBox</filepath> from the 43 global zone into the non-global zone at the same path. This is 44 done using <userinput>zonecfg(8)</userinput> to set the <codeph>dir</codeph> 45 attribute and the <codeph>special</codeph> attribute for this directory. 46 For example: 47 </p> 41 <p> Oracle Solaris 11 does not support sparse root zones so you will need to 42 loopback mount <filepath>/opt/VirtualBox</filepath> from the global zone into the non-global 43 zone at the same path. This is done using <userinput>zonecfg(8)</userinput> to set the 44 <codeph>dir</codeph> attribute and the <codeph>special</codeph> attribute for this 45 directory. For example: </p> 48 46 <pre xml:space="preserve">zonecfg:vboxzone> add fs 49 47 zonecfg:vboxzone:fs> set dir=/opt/VirtualBox … … 57 55 using <userinput>zoneadm(8)</userinput> as follows: 58 56 </p> 59 57 <pre xml:space="preserve">global$ zoneadm -z <varname>vboxzone</varname> reboot 60 58 </pre> 61 59 <p> … … 65 63 </p> 66 64 </body> 67 65 68 66 </topic> -
trunk/doc/manual/en_US/dita/topics/solariscodedumper.dita
r99797 r105134 21 21 <pre xml:space="preserve">$ VBoxManage setextradata <varname>VM-name</varname> VBoxInternal2/CoreDumpDir <varname>path-to-directory</varname> 22 22 </pre> 23 <p> 24 Make sure the directory you specify is on a volume with sufficient 25 free space and that the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> process has sufficient 26 permissions to write files to this directory. If you skip this 27 command and do not specify any core dump directory, the current 28 directory of the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> executable will be used. This 29 would most likely fail when writing cores as they are protected 30 with root permissions. It is recommended you explicitly set a core 31 dump directory. 32 </p> 23 <p> Ensure the directory you specify is on a volume with sufficient free space and that the <ph 24 conkeyref="vbox-conkeyref-phrases/product-name"/> process has sufficient permissions to 25 write files to this directory. If you skip this command and do not specify any core dump 26 directory, the current directory of the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 27 executable will be used. This would most likely fail when writing cores as they are protected 28 with root permissions. It is recommended you explicitly set a core dump directory. </p> 33 29 <p> 34 30 You must specify when the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> CoreDumper should be -
trunk/doc/manual/en_US/dita/topics/startingvboxonlinux.dita
r99797 r105134 14 14 required program for you. 15 15 </p> 16 <p> 17 The following detailed instructions should only be of interest 18 if you wish to execute <ph conkeyref="vbox-conkeyref-phrases/product-name"/> without installing it 19 first. You should start by compiling the 20 <userinput>vboxdrv</userinput> kernel module and inserting it into 21 the Linux kernel. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> consists of a service daemon, 22 <userinput>VBoxSVC</userinput>, and several application programs. 23 The daemon is automatically started if necessary. All 24 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> applications will communicate with the daemon 25 through UNIX local domain sockets. There can be multiple daemon 26 instances under different user accounts and applications can 27 only communicate with the daemon running under the user account 28 as the application. The local domain socket resides in a 29 subdirectory of your system's directory for temporary files 30 called <filepath>.vbox-<username>-ipc</filepath>. In case 31 of communication problems or server startup problems, you may 32 try to remove this directory. 33 </p> 16 <p> The following detailed instructions should only be of interest if you want to 17 execute <ph conkeyref="vbox-conkeyref-phrases/product-name"/> without installing it first. You 18 should start by compiling the <userinput>vboxdrv</userinput> kernel module and inserting it 19 into the Linux kernel. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> consists of a 20 service daemon, <userinput>VBoxSVC</userinput>, and several application programs. The daemon 21 is automatically started if necessary. All <ph conkeyref="vbox-conkeyref-phrases/product-name" 22 /> applications will communicate with the daemon through UNIX local domain sockets. There can 23 be multiple daemon instances under different user accounts and applications can only 24 communicate with the daemon running under the user account as the application. The local 25 domain socket resides in a subdirectory of your system's directory for temporary files called 26 <filepath>.vbox-<username>-ipc</filepath>. In case of communication problems or server 27 startup problems, you may try to remove this directory. </p> 34 28 <p> 35 29 All <ph conkeyref="vbox-conkeyref-phrases/product-name"/> applications (<userinput>VirtualBox</userinput>, -
trunk/doc/manual/en_US/dita/topics/sysprep.dita
r99016 r105134 5 5 6 6 <body> 7 <p> 8 Microsoft offers a system preparation tool called Sysprep, to 9 prepare a Windows system for deployment or redistribution. Some 10 Windows releases include Sysprep on the installation medium, but 11 the tool is also available for download from the Microsoft web 12 site. In a standard For most Windows versions, Sysprep is 13 included in a default installation. Sysprep mainly consists of 14 an executable called <userinput>sysprep.exe</userinput> which is 15 invoked by the user to put the Windows installation into 16 preparation mode. 17 </p> 7 <p> Microsoft offers a system preparation tool called Sysprep, to prepare a Windows system for 8 deployment or redistribution. Some Windows releases include Sysprep on the installation 9 medium, but the tool is also available for download from the Microsoft website. In a standard 10 For most Windows versions, Sysprep is included in a default installation. Sysprep mainly 11 consists of an executable called <userinput>sysprep.exe</userinput> which is invoked by the 12 user to put the Windows installation into preparation mode. </p> 18 13 <p> 19 14 The Guest Additions offer a way to launch a system preparation -
trunk/doc/manual/en_US/dita/topics/technical-components.dita
r99797 r105134 3 3 <topic xml:lang="en-us" id="technical-components"> 4 4 <title><ph conkeyref="vbox-conkeyref-phrases/product-name"/> Executables and Components</title> 5 6 5 <body> 7 6 <p> … … 58 57 </li> 59 58 </ul> 60 <p> 61 Any <ph conkeyref="vbox-conkeyref-phrases/product-name"/> front-end, or client, will communicate with the 62 service process and can both control and reflect the current 63 state. For example, either the VM selector or the VM window or 64 VBoxManage can be used to pause the running VM, and other 65 components will always reflect the changed state. 66 </p> 59 <p> Any <ph conkeyref="vbox-conkeyref-phrases/product-name"/> front end, or client, will 60 communicate with the service process and can both control and reflect the current state. For 61 example, either the VM selector or the VM window or VBoxManage can be used to pause the 62 running VM, and other components will always reflect the changed state. </p> 67 63 <p> 68 64 The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> GUI application, called <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>, is only one -
trunk/doc/manual/en_US/dita/topics/ts_host-freq-boost.dita
r99016 r105134 13 13 behavior depends strongly on the specific processor model. 14 14 </p> 15 <p> 16 As a consequence, benchmarking on systems which utilize 17 frequency boosting may produce unstable and non-repeatable 18 results. This is especially true if benchmark runs are short, of 19 the order of seconds. To obtain stable results, benchmarks must 20 be run over longer periods of time and with a constant system 21 load apart from the VM being tested. 22 </p> 15 <p> As a consequence, benchmarking on systems which utilize frequency boosting may produce 16 unstable and nonrepeatable results. This is especially true if benchmark runs are short, of 17 the order of seconds. To obtain stable results, benchmarks must be run over longer periods of 18 time and with a constant system load apart from the VM being tested. </p> 23 19 </body> 24 20 -
trunk/doc/manual/en_US/dita/topics/ts_host-powermgmt.dita
r99016 r105134 11 11 clock behavior. 12 12 </p> 13 <p> 14 Some of the problems may be caused by firmware and/or host 15 operating system bugs. Therefore, updating the firmware and 16 applying operating systems fixes is recommended. 17 </p> 13 <p> Some of the problems may be caused by firmware or host operating system bugs. Therefore, 14 updating the firmware and applying operating system fixes is recommended. </p> 18 15 <p> 19 16 For optimal virtualization performance, the C1E power state -
trunk/doc/manual/en_US/dita/topics/ts_ide-sata-flush.dita
r99016 r105134 5 5 6 6 <body> 7 <p> 8 If desired, the virtual disk images can be flushed when the 9 guest issues the IDE FLUSH CACHE command. Normally these 10 requests are ignored for improved performance. The parameters 11 below are only accepted for disk drives. They must not be set 12 for DVD drives. 13 </p> 7 <p> If required, the virtual disk images can be flushed when the guest issues the IDE FLUSH 8 CACHE command. Normally these requests are ignored for improved performance. The parameters 9 below are only accepted for disk drives. They must not be set for DVD drives. </p> 14 10 <p> 15 11 To enable flushing for IDE disks, issue the following command: -
trunk/doc/manual/en_US/dita/topics/ts_linux-guest-x11-services.dita
r99016 r105134 22 22 running. 23 23 </p> 24 <p> 25 The <userinput>VBoxClient</userinput> processes create files in the 26 user's home directory with names of the form 27 <filepath>.vboxclient-*.pid</filepath> when they are running in 28 order to prevent a given service from being started twice. It 29 can happen due to misconfiguration that these files are created 30 owned by root and not deleted when the services are stopped, 31 which will prevent them from being started in future sessions. 32 If the services cannot be started, you may wish to check whether 33 these files still exist. 34 </p> 24 <p> The <userinput>VBoxClient</userinput> processes create files in the user's home directory 25 with names of the form <filepath>.vboxclient-*.pid</filepath> when they are running in order 26 to prevent a given service from being started twice. It can happen due to misconfiguration 27 that these files are created owned by root and not deleted when the services are stopped, 28 which will prevent them from being started in future sessions. If the services cannot be 29 started, you may want to check whether these files still exist. </p> 35 30 </body> 36 31 -
trunk/doc/manual/en_US/dita/topics/ts_usb-linux.dita
r99016 r105134 5 5 6 6 <body> 7 <p> 8 If USB is not working on your Linux host, make sure that the 9 current user is a member of the <codeph>vboxusers</codeph> 10 group. Please keep in mind that group membership does not take 11 effect immediately but rather at the next login. If available, 12 the <userinput>newgrp</userinput> command may avoid the need for a 13 logout and login. 14 </p> 7 <p> If USB is not working on your Linux host, make sure that the current user is a member of the 8 <codeph>vboxusers</codeph> group. Please remember that group membership does not take effect 9 immediately but rather at the next login. If available, the <userinput>newgrp</userinput> 10 command may avoid the need for a logout and login. </p> 15 11 </body> 16 12 -
trunk/doc/manual/en_US/dita/topics/ts_win-dnd-uipi.dita
r99797 r105134 5 5 6 6 <body> 7 <p> 8 Microsoft Windows uses technologies like UAC (User Account Control) and 9 UIPI (User Interface Privilege Isolation) to prevent and/or mitigate 10 security issues. By default, UAC and UIPI are enabled. 11 </p> 12 <p> 13 When an <ph conkeyref="vbox-conkeyref-phrases/product-name"/> VM process is running with a higher so-called 14 privilege level than another process that wants to interact with the 15 VM process via drag'n drop (or system clipboard), Windows prevents this 16 by default due to security reasons. This results in <ph conkeyref="vbox-conkeyref-phrases/product-name"/> not 17 being able to receive any Windows messages for drag'n drop. To make this work, 18 the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> VM process must be running with 19 the same (or lower) privilege level as the process it is interacting with 20 using drag'n drop.</p> 7 <p> Microsoft Windows uses technologies like UAC (User Account Control) and UIPI (User Interface 8 Privilege Isolation) to prevent and mitigate security issues. By default, UAC and UIPI are 9 enabled. </p> 10 <p> When an <ph conkeyref="vbox-conkeyref-phrases/product-name"/> VM process is running with a 11 higher so-called privilege level than another process that wants to interact with the VM 12 process using drag'n drop (or system clipboard), Windows prevents this by default due to 13 security reasons. This results in <ph conkeyref="vbox-conkeyref-phrases/product-name"/> not 14 being able to receive any Windows messages for drag'n drop. To make this work, the <ph 15 conkeyref="vbox-conkeyref-phrases/product-name"/> VM process must be running with the same 16 (or lower) privilege level as the process it is interacting with using drag'n drop.</p> 21 17 22 <p>Disabling UAC and/or UIPI is not recommended. 23 </p> 18 <p>Disabling UAC or UIPI is not recommended. </p> 24 19 </body> 25 20 -
trunk/doc/manual/en_US/dita/topics/unattended-guest-install-example.dita
r102568 r105134 4 4 <topic xml:lang="en-us" id="unattended-guest-install-example"> 5 5 <title>Using VBoxManage Commands for Unattended Guest Installation</title> 6 7 6 <body> 8 7 <p> … … 184 183 </ol> 185 184 </body> 186 187 185 </topic> -
trunk/doc/manual/en_US/dita/topics/vboxbowsolaris11.dita
r99797 r105134 29 29 </p> 30 30 <pre xml:space="preserve">$ modinfo | grep vbox</pre> 31 <p> 32 If the output contains "vboxbow", it indicates <ph conkeyref="vbox-conkeyref-phrases/product-name"/> is 33 using the Crossbow network filter driver, while the name "vboxflt" 34 indicates usage of the older STREAMS network filter. 35 </p> 31 <p> If the output contains <i>vboxbow</i>, it indicates <ph 32 conkeyref="vbox-conkeyref-phrases/product-name"/> is using the Crossbow network filter 33 driver, while the name <i>vboxflt</i> indicates usage of the older STREAMS network filter. </p> 36 34 </body> 37 35 -
trunk/doc/manual/en_US/dita/topics/vboxconfigdata-machine-folder.dita
r99797 r105134 57 57 VMs</filepath>. 58 58 </p> 59 <p> 60 As an example, when you create a virtual machine called "Example 61 VM", <ph conkeyref="vbox-conkeyref-phrases/product-name"/> creates the following: 62 </p> 59 <p> As an example, when you create a virtual machine called <i>Example VM</i>, <ph 60 conkeyref="vbox-conkeyref-phrases/product-name"/> creates the following: </p> 63 61 <ul> 64 62 <li> -
trunk/doc/manual/en_US/dita/topics/vboxwatchdog-ballonctrl.dita
r99016 r105134 5 5 6 6 <body> 7 <p> 8 The memory ballooning control inflates and deflates the memory 9 balloon of VMs based on the VMs free memory and the desired 10 maximum balloon size. 11 </p> 7 <p> The memory ballooning control inflates and deflates the memory balloon of VMs based on the 8 VMs free memory and the requested maximum balloon size. </p> 12 9 <p> 13 10 To set up the memory ballooning control the maximum ballooning -
trunk/doc/manual/en_US/dita/topics/vboxwatchdog-hostisln.dita
r99797 r105134 62 62 </li> 63 63 <li> 64 <p><codeph>save</codeph>. Saves the current machine state and 65 powers off the VM afterwards. If saving the machine state 66 fails the VM will be paused. 67 </p> 64 <p><codeph>save</codeph>. Saves the current machine state and then powers off the VM. If 65 saving the machine state fails the VM will be paused. </p> 68 66 </li> 69 67 <li> -
trunk/doc/manual/en_US/dita/topics/vm-activity-overview.dita
r99183 r105134 3 3 PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd"> 4 4 <topic xml:lang="en-us" id="vm-activity-overview"> 5 <!-- 7.1: Now shows activity info for cloud VMs --> 5 6 <title>VM Activity Overview</title> 6 7 7 <body> 8 8 <p> 9 9 The VM Activity Overview tool displays several performance 10 metrics for all running virtual machines and for the host10 metrics for all running virtual machines and cloud VM instances, and for the host 11 11 system. This provides an overview of system resources used by 12 12 individual virtual machines and the host system. … … 38 38 Virtual Machines</b>. 39 39 </p> 40 <p>To show metrics for cloud VMs, right-click the list of virtual machines and select <b 41 outputclass="bold">Show Cloud Virtual Machines</b>. </p> 40 42 <p> 41 43 To configure the set of metrics to be shown, click -
trunk/doc/manual/en_US/dita/topics/vm-activity-session-information.dita
r99183 r105134 4 4 <topic xml:lang="en-us" id="vm-activity-session-information"> 5 5 <title>Session Information Dialog</title> 6 6 <!-- 7.1: metrics info for OCI instances--> 7 <!-- 7.1: Add pic for cloud VM Activity info? --> 7 8 <body> 8 9 <p> … … 46 47 </li> 47 48 </ul> 48 <p> 49 To display the Session Information dialog, select 50 <b outputclass="bold">Machine</b>, 51 <b outputclass="bold">Session Information</b> in the 52 guest VM. 53 </p> 49 <note><p>For cloud VMs, only the VM Activity tab is shown.</p></note> 50 <p> To display session information for a guest virtual machine or a cloud VM, 51 select the VM name in the machine list and click <b>Activity</b> in the machine tools 52 menu.</p> 54 53 <fig id="fig-vm-session-information"> 55 54 <title>Session Information Dialog, Showing VM Activity Tab</title> -
trunk/doc/manual/en_US/dita/topics/vm-info.dita
r99797 r105134 4 4 <topic xml:lang="en-us" id="vm-info"> 5 5 <title>Monitoring of Virtual Machines</title> 6 6 <!-- 7.1: metrics info now included for OCI instances --> 7 7 <body> 8 8 <p> 9 9 <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> includes the following tools for viewing runtime 10 information and changing the configuration of virtual machines.10 information, configuration details, and performance metrics of virtual machines and cloud VM instances. 11 11 </p> 12 <note><p>To monitor a cloud VM, the Compute Instance Monitoring plugin must be enabled and running on the 13 <ph conkeyref="vbox-conkeyref-phrases/oci"/> instance. See the <ph conkeyref="vbox-conkeyref-phrases/oci"/> 14 documentation for more details.</p></note> 12 15 <ul> 13 16 <li> … … 15 18 <b outputclass="bold"> VM Activity Overview.</b> 16 19 Displays an overview of performance metrics for all running 17 VMs.20 virtual machines and cloud VM instances. 18 21 </p> 19 22 <p> … … 25 28 <b outputclass="bold">Session Information Dialog.</b> 26 29 Displays configuration and runtime information for the 27 selected guest system .30 selected guest system or cloud VM. 28 31 </p> 29 32 <p> 30 See <xref href="vm-activity-session-information.dita#vm-activity-session-information"/> 33 See <xref href="vm-activity-session-information.dita#vm-activity-session-information"/>. 31 34 </p> 32 35 </li> -
trunk/doc/manual/en_US/dita/topics/vmencryption.dita
r99797 r105134 17 17 and is decrypted during VM startup. 18 18 </p> 19 <p> 20 Since the DEK is stored as part of the VM configuration file, it 21 is important that the file is kept safe. Losing the DEK means that 22 the data stored in the VM is lost irrecoverably. Having complete 23 and up to date backups of all data related to the VM is the 24 responsibility of the user. 25 </p> 19 <p> Since the DEK is stored as part of the VM configuration file, it is important that the file 20 is kept safe. Losing the DEK means that the data stored in the VM is lost irrecoverably. 21 Having complete and up-to-date backups of all data related to the VM is the responsibility of 22 the user. </p> 26 23 <p> 27 24 The VM, even if it is encrypted, may contain media encrypted with -
trunk/doc/manual/en_US/dita/topics/vrde-crypt.dita
r99797 r105134 41 41 certificate to the client. 42 42 </p> 43 <p> 44 The <codeph>Security/Method</codeph> VRDE property sets 45 the desired security method, which is used for a connection. 46 Valid values are as follows: 47 </p> 43 <p> The <codeph>Security/Method</codeph> VRDE property sets the required security method, 44 which is used for a connection. Valid values are as follows: </p> 48 45 <ul> 49 46 <li> -
trunk/doc/manual/en_US/dita/topics/vrde.dita
r99797 r105134 26 26 (VRDP) in such an <ph conkeyref="vbox-conkeyref-phrases/product-name"/> extension package. 27 27 </p> 28 <p> 29 VRDP is a backwards-compatible extension to Microsoft's Remote 30 Desktop Protocol (RDP). As a result, you can use any standard RDP 31 client to control the remote VM. 32 </p> 28 <p> VRDP is a backward-compatible extension to Microsoft's Remote Desktop Protocol (RDP). As a 29 result, you can use any standard RDP client to control the remote VM. </p> 33 30 <p> 34 31 Even when the extension is installed, the VRDP server is disabled
Note:
See TracChangeset
for help on using the changeset viewer.