- Timestamp:
- Jul 12, 2024 9:07:43 AM (6 months ago)
- Location:
- trunk/doc/manual/en_US/dita/topics
- Files:
-
- 134 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/doc/manual/en_US/dita/topics/BasicConcepts.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 This chapter provides detailed steps for configuring an 9 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> virtual machine (VM). For an introduction to 10 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> and steps to get your first virtual machine running, 11 see <xref href="Introduction.dita#Introduction"/>. 12 </p> 13 <p> 14 You have considerable latitude when deciding what virtual hardware 15 to provide to the guest. Use virtual hardware to communicate with 16 the host system or with other guests. For example, you can use 17 virtual hardware in the following ways: 18 </p> 7 <p>This chapter provides detailed steps for configuring an <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 8 virtual machine (VM). For an introduction to <ph conkeyref="vbox-conkeyref-phrases/product-name"/> and steps to 9 get your first virtual machine running, see <xref href="Introduction.dita#Introduction"/>. </p> 10 <p>You have considerable latitude when deciding what virtual hardware to provide to the guest. Use virtual hardware 11 to communicate with the host system or with other guests. For example, you can use virtual hardware in the 12 following ways: </p> 19 13 <ul> 20 14 <li> 21 <p> 22 Have <ph conkeyref="vbox-conkeyref-phrases/product-name"/> present an ISO CD-ROM image to a guest 23 system as if it were a physical CD-ROM. 24 </p> 15 <p>Have <ph conkeyref="vbox-conkeyref-phrases/product-name"/> present an ISO CD-ROM image to a guest system as 16 if it were a physical CD-ROM. </p> 25 17 </li> 26 18 <li> 27 <p> 28 Provide a guest system access to the physical network through 29 its virtual network card. 30 </p> 19 <p>Provide a guest system access to the physical network through its virtual network card. </p> 31 20 </li> 32 21 <li> 33 <p> 34 Provide the host system, other guests, and computers on the 35 Internet access to the guest system. 36 </p> 22 <p>Provide the host system, other guests, and computers on the Internet access to the guest system. </p> 37 23 </li> 38 24 </ul> -
trunk/doc/manual/en_US/dita/topics/Introduction.dita
r99797 r105289 43 43 </image> 44 44 </fig> 45 <p> 46 In this User Manual, we will begin simply with a quick introduction 47 to virtualization and how to get your first virtual machine running 48 with the easy-to-use <ph conkeyref="vbox-conkeyref-phrases/product-name"/> graphical user interface. 49 Subsequent chapters will go into much more detail covering more 50 powerful tools and features, but fortunately, it is not necessary to 51 read the entire User Manual before you can use <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. 52 </p> 53 <p> 54 You can find a summary of <ph conkeyref="vbox-conkeyref-phrases/product-name"/>'s capabilities in 55 <xref href="features-overview.dita#features-overview"/>. For existing <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 56 users who just want to find out what is new in this release, see the 57 <xref href="https://docs.oracle.com/en/virtualization/virtualbox/7.0/relnotes/relnotes-ChangeLog.html" format="html" scope="external">Change Log</xref>. 58 </p> 45 <p>In this User Manual, we will begin simply with a quick introduction to virtualization and how to get your first 46 virtual machine running with the easy-to-use <ph conkeyref="vbox-conkeyref-phrases/product-name"/> graphical user 47 interface. Subsequent chapters will go into much more detail covering more powerful tools and features, but 48 fortunately, it is not necessary to read the entire User Manual before you can use <ph 49 conkeyref="vbox-conkeyref-phrases/product-name"/>. </p> 50 <p>You can find a summary of <ph conkeyref="vbox-conkeyref-phrases/product-name"/>'s capabilities in <xref 51 href="features-overview.dita#features-overview"/>. For existing <ph 52 conkeyref="vbox-conkeyref-phrases/product-name"/> users who just want to find out what is new in this release, 53 see the <xref href="https://docs.oracle.com/en/virtualization/virtualbox/7.0/relnotes/relnotes-ChangeLog.html" 54 format="html" scope="external">Change Log</xref>. </p> 59 55 </body> 60 56 </topic> -
trunk/doc/manual/en_US/dita/topics/basic-unattended.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can install a guest OS automatically. You only need 9 to provide the installation medium and a few other parameters, 10 such as the name of the default user. 11 </p> 12 <p> 13 You can perform an unattended guest installation in the following 14 ways: 15 </p> 7 <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> can install a guest OS automatically. You only need to 8 provide the installation medium and a few other parameters, such as the name of the default user. </p> 9 <p>You can perform an unattended guest installation in the following ways: </p> 16 10 <ul> 17 11 <li> … … 23 17 <xref href="create-vm-wizard.dita#create-vm-wizard"/>. 24 18 </p> 25 <p> 26 During this step, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> scans the installation medium 27 and changes certain parameters to ensure a seamless 28 installation as a guest running on <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. 29 </p> 19 <p>During this step, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> scans the installation medium and 20 changes certain parameters to ensure a seamless installation as a guest running on <ph 21 conkeyref="vbox-conkeyref-phrases/product-name"/>. </p> 30 22 </li> 31 23 <li> … … 37 29 </li> 38 30 </ul> 39 <p> 40 When you first start a VM that has been configured for unattended 41 installation, the guest OS installation is performed 42 automatically. 43 </p> 44 <p> 45 The installation operation changes the boot device order to boot 46 the virtual hard disk first and then the virtual DVD drive. If the 47 virtual hard disk is empty prior to the automatic installation, 48 the VM boots from the virtual DVD drive and begins the 49 installation. 50 </p> 51 <p> 52 If the virtual hard disk contains a bootable OS, the installation 53 operation exits. In this case, change the boot device order 54 manually by pressing F12 during the BIOS splash screen. 55 </p> 31 <p>When you first start a VM that has been configured for unattended installation, the guest OS installation is 32 performed automatically. </p> 33 <p>The installation operation changes the boot device order to boot the virtual hard disk first and then the virtual 34 DVD drive. If the virtual hard disk is empty prior to the automatic installation, the VM boots from the virtual 35 DVD drive and begins the installation. </p> 36 <p>If the virtual hard disk contains a bootable OS, the installation operation exits. In this case, change the boot 37 device order manually by pressing F12 during the BIOS splash screen. </p> 56 38 </body> 57 39 </topic> -
trunk/doc/manual/en_US/dita/topics/clone.dita
r99797 r105289 3 3 <topic xml:lang="en-us" id="clone"> 4 4 <title>Cloning Virtual Machines</title> 5 5 6 6 <body> 7 <p> 8 You can create a full copy or a linked copy of an existing VM. 9 This copy is called a <i>clone</i>. You might use a 10 cloned VM to experiment with a VM configuration, to test different 11 guest OS levels, or to back up a VM. 12 </p> 13 <p> 14 The <b outputclass="bold">Clone Virtual Machine</b> wizard 15 guides you through the cloning process. 16 </p> 17 <p> 18 You can start the Clone Virtual Machine wizard in one of the 19 following ways: 20 </p> 7 <p>You can create a full copy or a linked copy of an existing VM. This copy is called a <i>clone</i>. You might use 8 a cloned VM to experiment with a VM configuration, to test different guest OS levels, or to back up a VM. </p> 9 <p>The <b outputclass="bold">Clone Virtual Machine</b> wizard guides you through the cloning process. </p> 10 <p>You can start the Clone Virtual Machine wizard in one of the following ways: </p> 21 11 <ul> 22 12 <li> 23 <p> 24 Click the VM name in the machine list and then select 25 <b outputclass="bold">Clone</b> from the 26 <b outputclass="bold">Machine</b> menu. 27 </p> 13 <p>Click the VM name in the machine list and then select <b outputclass="bold">Clone</b> from the <b 14 outputclass="bold">Machine</b> menu. </p> 28 15 </li> 29 16 <li> 30 <p> 31 Click <b outputclass="bold">Clone</b> in the 32 <b outputclass="bold">Snapshots</b> window for the 33 selected VM. 34 </p> 17 <p>Click <b outputclass="bold">Clone</b> in the <b outputclass="bold">Snapshots</b> window for the selected VM. </p> 35 18 </li> 36 19 </ul> 37 20 <note> 38 <p> 39 The <b outputclass="bold">Clone</b> menu item is disabled 40 while a virtual machine is running. 41 </p> 21 <p>The <b outputclass="bold">Clone</b> menu item is disabled while a virtual machine is running. </p> 42 22 </note> 43 <p> 44 The <b outputclass="bold">New Machine Name and Path</b> 45 page is displayed. 46 </p> 23 <p>The <b outputclass="bold">New Machine Name and Path</b> page is displayed. </p> 47 24 <fig id="fig-clone-wizard-name-path"> 48 25 <title>Clone Virtual Machine Wizard: New Machine Name and Path</title> … … 56 33 </image> 57 34 </fig> 58 <p> 59 The following clone options are available: 60 </p> 35 <p>The following clone options are available: </p> 61 36 <ul> 62 37 <li> … … 98 73 </li> 99 74 </ul> 100 <p> 101 Click <b outputclass="bold">Next</b>. The 102 <b outputclass="bold">Clone Type</b> page is displayed. 103 </p> 75 <p>Click <b outputclass="bold">Next</b>. The <b outputclass="bold">Clone Type</b> page is displayed. </p> 104 76 <fig id="fig-clone-type"> 105 77 <title>Clone Virtual Machine Wizard: Clone Type</title> … … 113 85 </image> 114 86 </fig> 115 <p> 116 The <b outputclass="bold">Clone Type</b> option specifies 117 whether to create a clone that is linked to the source VM or to 118 create a fully independent clone: 119 </p> 87 <p>The <b outputclass="bold">Clone Type</b> option specifies whether to create a clone that is linked to the source 88 VM or to create a fully independent clone: </p> 120 89 <ul> 121 90 <li> … … 138 107 </p> 139 108 <note> 140 <p> 141 The Snapshots page is only displayed for machines that have 142 snapshots and the selected clone type is 143 <b outputclass="bold">Full Clone</b>. 144 </p> 109 <p>The Snapshots page is only displayed for machines that have snapshots and the selected clone type is <b 110 outputclass="bold">Full Clone</b>. </p> 145 111 </note> 146 112 <fig id="fig-clone-wizard-snapshots"> … … 155 121 </image> 156 122 </fig> 157 <p> 158 You use this page to select which parts of the snapshot tree to 159 include in the clone. The available options are as follows: 160 </p> 123 <p>You use this page to select which parts of the snapshot tree to include in the clone. The available options are 124 as follows: </p> 161 125 <ul> 162 126 <li> -
trunk/doc/manual/en_US/dita/topics/cloud-create-api-keypair.dita
r99797 r105289 5 5 6 6 <body> 7 <p/> 8 <p> 9 To use the cloud integration features of <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, you 10 must generate an API signing key pair that is used for API 11 requests to <ph conkeyref="vbox-conkeyref-phrases/oci"/>. 12 </p> 13 <p> 14 Your API requests are signed with your private key, and <ph conkeyref="vbox-conkeyref-phrases/oci"/> 15 uses the public key to verify the authenticity of the request. 16 You must upload the public key to the <ph conkeyref="vbox-conkeyref-phrases/oci"/> Console. 17 </p> 7 <p>To use the cloud integration features of <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, you must generate 8 an API signing key pair that is used for API requests to <ph conkeyref="vbox-conkeyref-phrases/oci"/>. </p> 9 <p>Your API requests are signed with your private key, and <ph conkeyref="vbox-conkeyref-phrases/oci"/> uses the 10 public key to verify the authenticity of the request. You must upload the public key to the <ph 11 conkeyref="vbox-conkeyref-phrases/oci"/> Console. </p> 18 12 <note> 19 13 <p> … … 24 18 <ol> 25 19 <li> 26 <p> 27 (Optional) Create a <filepath>.oci</filepath> directory to 28 store the key pair. 29 </p> 20 <p>(Optional) Create a <filepath>.oci</filepath> directory to store the key pair. </p> 30 21 <pre xml:space="preserve">$ mkdir ~/.oci</pre> 31 <p> 32 The key pair is usually installed in the 33 <filepath>.oci</filepath> folder in your home directory. For 34 example, <filepath>~/.oci</filepath> on a Linux system. 35 </p> 22 <p>The key pair is usually installed in the <filepath>.oci</filepath> folder in your home directory. For 23 example, <filepath>~/.oci</filepath> on a Linux system. </p> 36 24 </li> 37 25 <li> 38 <p> 39 Generate the private key. 40 </p> 41 <p> 42 Use the <codeph>openssl</codeph> command. 43 </p> 26 <p>Generate the private key. </p> 27 <p>Use the <codeph>openssl</codeph> command. </p> 44 28 <ul> 45 29 <li> … … 58 42 </li> 59 43 <li> 60 <p> 61 Change permissions for the private key. 62 </p> 44 <p>Change permissions for the private key. </p> 63 45 <pre xml:space="preserve">$ chmod 600 ~/.oci/oci_api_key.pem</pre> 64 <p> 65 Generate the public key. 66 </p> 46 <p>Generate the public key. </p> 67 47 <pre xml:space="preserve">$ openssl rsa -pubout -in ~/.oci/oci_api_key.pem -out ~/.oci/oci_api_key_public.pem</pre> 68 48 </li> -
trunk/doc/manual/en_US/dita/topics/cloud-create-cloud-profile.dita
r99797 r105289 3 3 <topic xml:lang="en-us" id="cloud-create-cloud-profile"> 4 4 <title>Creating a Cloud Profile</title> 5 5 6 6 <body> 7 <p> 8 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> uses a <i>cloud profile</i> to 9 connect to <ph conkeyref="vbox-conkeyref-phrases/oci"/>. A cloud profile is a text file that contains 10 details of your key files and Oracle Cloud Identifier (OCID) 11 resource identifiers for your cloud account, such as the 12 following: 13 </p> 7 <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> uses a <i>cloud profile</i> to connect to <ph 8 conkeyref="vbox-conkeyref-phrases/oci"/>. A cloud profile is a text file that contains details of your key files 9 and Oracle Cloud Identifier (OCID) resource identifiers for your cloud account, such as the following: </p> 14 10 <ul> 15 11 <li> -
trunk/doc/manual/en_US/dita/topics/cloud-export-oci-prepare-vm.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 <ph conkeyref="vbox-conkeyref-phrases/oci"/> provides the option to import a custom Linux image. 9 Before an <ph conkeyref="vbox-conkeyref-phrases/product-name"/> image can be exported to <ph conkeyref="vbox-conkeyref-phrases/oci"/>, the 10 custom image needs to be prepared to ensure that instances 11 launched from the custom image can boot correctly and that 12 network connections will work. This section provides advice on 13 how to prepare a Linux image for export from <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. 14 </p> 15 <p> 16 The following list shows some tasks to consider when preparing 17 an Oracle Linux VM for export: 18 </p> 7 <p><ph conkeyref="vbox-conkeyref-phrases/oci"/> provides the option to import a custom Linux image. Before an <ph 8 conkeyref="vbox-conkeyref-phrases/product-name"/> image can be exported to <ph 9 conkeyref="vbox-conkeyref-phrases/oci"/>, the custom image needs to be prepared to ensure that instances 10 launched from the custom image can boot correctly and that network connections will work. This section provides 11 advice on how to prepare a Linux image for export from <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. </p> 12 <p>The following list shows some tasks to consider when preparing an Oracle Linux VM for export: </p> 19 13 <ul> 20 14 <li> … … 31 25 for the VM must not specify the MAC address. 32 26 </p> 33 <p> 34 Remove the HWADDR setting from the 35 <filepath>/etc/sysconfig/ifcfg-<varname>devicename</varname></filepath> 36 network script. 37 </p> 27 <p>Remove the HWADDR setting from the <filepath>/etc/sysconfig/ifcfg-<varname>devicename</varname></filepath> 28 network script. </p> 38 29 </li> 39 30 <li> … … 44 35 <ol> 45 36 <li> 46 <p> 47 Change the GRUB kernel parameters. 48 </p> 49 <p> 50 Add <codeph>net.ifnames=0</codeph> and 51 <codeph>biosdevname=0</codeph> as kernel parameter 52 values to the <codeph>GRUB_CMDLINE_LINUX</codeph> 53 variable. 54 </p> 37 <p>Change the GRUB kernel parameters. </p> 38 <p>Add <codeph>net.ifnames=0</codeph> and <codeph>biosdevname=0</codeph> as kernel parameter values to the 39 <codeph>GRUB_CMDLINE_LINUX</codeph> variable. </p> 55 40 </li> 56 41 <li> 57 <p> 58 Update the GRUB configuration. 59 </p> 42 <p>Update the GRUB configuration. </p> 60 43 <pre xml:space="preserve"># grub2-mkconfig -o /boot/grub2/grub.cfg</pre> 61 44 </li> 62 45 <li> 63 <p> 64 Disable any <codeph>udev</codeph> rules for network 65 device naming. 66 </p> 67 <p> 68 For example, if an automated <codeph>udev</codeph> 69 rule exists for <codeph>net-persistence</codeph>: 70 </p> 46 <p>Disable any <codeph>udev</codeph> rules for network device naming. </p> 47 <p>For example, if an automated <codeph>udev</codeph> rule exists for <codeph>net-persistence</codeph>: </p> 71 48 <pre xml:space="preserve"># cd /etc/udev/rules.d 72 49 # rm -f 70-persistent-net.rules … … 82 59 <ol> 83 60 <li> 84 <p> 85 Edit the <filepath>/etc/default/grub</filepath> file, 86 as follows: 87 </p> 61 <p>Edit the <filepath>/etc/default/grub</filepath> file, as follows: </p> 88 62 <ul> 89 63 <li> 90 <p> 91 Remove the <codeph>resume</codeph> setting from 92 the kernel parameters. This setting slows down 93 boot time significantly. 94 </p> 64 <p>Remove the <codeph>resume</codeph> setting from the kernel parameters. This setting slows down boot 65 time significantly. </p> 95 66 </li> 96 67 <li> 97 <p> 98 Replace <codeph>GRUB_TERMINAL="gfxterm"</codeph> 99 with <codeph>GRUB_TERMINAL="console 100 serial"</codeph>. This configures use of the 101 serial console instead of a graphical terminal. 102 </p> 68 <p>Replace <codeph>GRUB_TERMINAL="gfxterm"</codeph> with <codeph>GRUB_TERMINAL="console 69 serial"</codeph>. This configures use of the serial console instead of a graphical terminal. </p> 103 70 </li> 104 71 <li> 105 <p> 106 Add <codeph>GRUB_SERIAL_COMMAND="serial --unit=0 107 --speed=115200"</codeph>. This configures the 108 serial connection. 109 </p> 72 <p>Add <codeph>GRUB_SERIAL_COMMAND="serial --unit=0 --speed=115200"</codeph>. This configures the serial 73 connection. </p> 110 74 </li> 111 75 <li> 112 <p> 113 Add <codeph>console=tty0 114 console=ttyS0,115200</codeph> to the 115 <codeph>GRUB_CMDLINE_LINUX</codeph> variable. 116 This adds the serial console to the Linux kernel 117 boot parameters. 118 </p> 76 <p>Add <codeph>console=tty0 console=ttyS0,115200</codeph> to the <codeph>GRUB_CMDLINE_LINUX</codeph> 77 variable. This adds the serial console to the Linux kernel boot parameters. </p> 119 78 </li> 120 79 </ul> 121 80 </li> 122 81 <li> 123 <p> 124 Regenerate the GRUB configuration. 125 </p> 82 <p>Regenerate the GRUB configuration. </p> 126 83 <pre xml:space="preserve"># grub2-mkconfig -o /boot/grub2/grub.cfg</pre> 127 84 </li> 128 85 <li> 129 <p> 130 To verify the changes, reboot the machine and run the 131 <userinput>dmesg</userinput> command to look for the 132 updated kernel parameters. 133 </p> 86 <p>To verify the changes, reboot the machine and run the <userinput>dmesg</userinput> command to look for 87 the updated kernel parameters. </p> 134 88 <pre xml:space="preserve"># dmesg |grep console=ttyS0</pre> 135 89 </li> … … 144 98 <ol> 145 99 <li> 146 <p> 147 This procedure works only on machines with a Linux 148 kernel of version 3.4 or later. Check that the VM is 149 running a supported kernel: 150 </p> 100 <p>This procedure works only on machines with a Linux kernel of version 3.4 or later. Check that the VM is 101 running a supported kernel: </p> 151 102 <pre xml:space="preserve"># uname -a</pre> 152 103 </li> 153 104 <li> 154 <p> 155 Use the <codeph>dracut</codeph> tool to rebuild 156 <codeph>initrd</codeph>. Add the 157 <codeph>qemu</codeph> module, as follows: 158 </p> 105 <p>Use the <codeph>dracut</codeph> tool to rebuild <codeph>initrd</codeph>. Add the <codeph>qemu</codeph> 106 module, as follows: </p> 159 107 <pre xml:space="preserve"># dracut –-logfile /var/log/Dracut.log --force --add qemu</pre> 160 108 </li> 161 109 <li> 162 <p> 163 Verify that the <codeph>virtio</codeph> drivers are 164 now present in <codeph>initrd</codeph>. 165 </p> 110 <p>Verify that the <codeph>virtio</codeph> drivers are now present in <codeph>initrd</codeph>. </p> 166 111 <pre xml:space="preserve"> # lsinitrd |grep virtio</pre> 167 112 </li> … … 169 114 </li> 170 115 </ul> 171 <p> 172 For more information about importing a custom Linux image into 173 <ph conkeyref="vbox-conkeyref-phrases/oci"/>, see also: 174 </p> 116 <p>For more information about importing a custom Linux image into <ph conkeyref="vbox-conkeyref-phrases/oci"/>, see 117 also: </p> 175 118 <p> 176 119 <ph>https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/importingcustomimagelinux.htm</ph> -
trunk/doc/manual/en_US/dita/topics/cloud-export-oci.dita
r99797 r105289 3 3 <topic xml:lang="en-us" id="cloud-export-oci"> 4 4 <title>Exporting an Appliance to <ph conkeyref="vbox-conkeyref-phrases/oci"/></title> 5 5 6 6 <body> 7 <p> 8 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports the export of VMs to an <ph conkeyref="vbox-conkeyref-phrases/oci"/> service. 9 The exported VM is stored on <ph conkeyref="vbox-conkeyref-phrases/oci"/> as a custom Linux image. You 10 can configure whether a cloud instance is created and started 11 after the export process has completed. 12 </p> 7 <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports the export of VMs to an <ph 8 conkeyref="vbox-conkeyref-phrases/oci"/> service. The exported VM is stored on <ph 9 conkeyref="vbox-conkeyref-phrases/oci"/> as a custom Linux image. You can configure whether a cloud instance is 10 created and started after the export process has completed. </p> 13 11 <note> 14 <p> 15 Before you export a VM to <ph conkeyref="vbox-conkeyref-phrases/oci"/>, you must prepare the VM as 16 described in <xref href="cloud-export-oci-prepare-vm.dita#cloud-export-oci-prepare-vm"/>. 17 </p> 12 <p>Before you export a VM to <ph conkeyref="vbox-conkeyref-phrases/oci"/>, you must prepare the VM as described in 13 <xref href="cloud-export-oci-prepare-vm.dita#cloud-export-oci-prepare-vm"/>. </p> 18 14 </note> 19 <p> 20 Use the following steps to export a VM to <ph conkeyref="vbox-conkeyref-phrases/oci"/>: 21 </p> 15 <p>Use the following steps to export a VM to <ph conkeyref="vbox-conkeyref-phrases/oci"/>: </p> 22 16 <ol> 23 17 <li> 24 <p> 25 Select <b outputclass="bold">File</b>, 26 <b outputclass="bold">Export Appliance</b> to open 27 the <b outputclass="bold">Export Virtual 28 Appliance</b> wizard. 29 </p> 30 <p> 31 Select a VM to export and click 32 <b outputclass="bold">Next</b> to display the 33 <b outputclass="bold">Format Settings</b> page. 34 </p> 18 <p>Select <b outputclass="bold">File</b>, <b outputclass="bold">Export Appliance</b> to open the <b 19 outputclass="bold">Export Virtual Appliance</b> wizard. </p> 20 <p>Select a VM to export and click <b outputclass="bold">Next</b> to display the <b outputclass="bold">Format 21 Settings</b> page. </p> 35 22 </li> 36 23 <li> 37 <p> 38 From the <b outputclass="bold">Format</b> drop-down 39 list, select <b outputclass="bold"><ph conkeyref="vbox-conkeyref-phrases/oci"/></b>. 40 </p> 41 <p> 42 In the <b outputclass="bold">Profile</b> drop-down 43 list, select the cloud profile used for your <ph conkeyref="vbox-conkeyref-phrases/oci"/> account. 44 </p> 24 <p>From the <b outputclass="bold">Format</b> drop-down list, select <b outputclass="bold"><ph 25 conkeyref="vbox-conkeyref-phrases/oci"/></b>. </p> 26 <p>In the <b outputclass="bold">Profile</b> drop-down list, select the cloud profile used for your <ph 27 conkeyref="vbox-conkeyref-phrases/oci"/> account. </p> 45 28 <fig id="fig-export-appliance-oci"> 46 29 <title>Export Virtual Appliance Wizard: Format Settings</title> … … 54 37 </image> 55 38 </fig> 56 <p> 57 In the <b outputclass="bold">Machine Creation</b> 58 field, select an option to configure settings for the cloud 59 instance created when you export to <ph conkeyref="vbox-conkeyref-phrases/oci"/>. The options 60 enable you to do one of the following: 61 </p> 39 <p>In the <b outputclass="bold">Machine Creation</b> field, select an option to configure settings for the cloud 40 instance created when you export to <ph conkeyref="vbox-conkeyref-phrases/oci"/>. The options enable you to do 41 one of the following: </p> 62 42 <ul> 63 43 <li> 64 <p> 65 Configure settings for the cloud instance 66 <i>after</i> you have finished exporting 67 the VM. 68 </p> 44 <p>Configure settings for the cloud instance <i>after</i> you have finished exporting the VM. </p> 69 45 </li> 70 46 <li> 71 <p> 72 Configure settings for the cloud instance 73 <i>before</i> you start to export the VM. 74 </p> 47 <p>Configure settings for the cloud instance <i>before</i> you start to export the VM. </p> 75 48 </li> 76 49 <li> 77 <p> 78 Do not create a cloud instance when you export the VM. 79 </p> 50 <p>Do not create a cloud instance when you export the VM. </p> 80 51 </li> 81 52 </ul> 82 <p> 83 Click <b outputclass="bold">Next</b> to make an API 84 request to the <ph conkeyref="vbox-conkeyref-phrases/oci"/> service and open the 85 <b outputclass="bold">Appliance Settings</b> page. 86 </p> 53 <p>Click <b outputclass="bold">Next</b> to make an API request to the <ph conkeyref="vbox-conkeyref-phrases/oci" 54 /> service and open the <b outputclass="bold">Appliance Settings</b> page. </p> 87 55 </li> 88 56 <li> 89 <p> 90 (Optional) Edit storage settings used for the exported 91 virtual machine in <ph conkeyref="vbox-conkeyref-phrases/oci"/>. You can change the following 92 settings: 93 </p> 57 <p>(Optional) Edit storage settings used for the exported virtual machine in <ph 58 conkeyref="vbox-conkeyref-phrases/oci"/>. You can change the following settings: </p> 94 59 <ul> 95 60 <li> 96 <p> 97 The name of the bucket used to store the exported files. 98 </p> 61 <p>The name of the bucket used to store the exported files. </p> 99 62 </li> 100 63 <li> 101 <p> 102 Whether to store the custom image in <ph conkeyref="vbox-conkeyref-phrases/oci"/>. 103 </p> 64 <p>Whether to store the custom image in <ph conkeyref="vbox-conkeyref-phrases/oci"/>. </p> 104 65 </li> 105 66 <li> 106 <p> 107 The display name for the custom image in <ph conkeyref="vbox-conkeyref-phrases/oci"/>. 108 </p> 67 <p>The display name for the custom image in <ph conkeyref="vbox-conkeyref-phrases/oci"/>. </p> 109 68 </li> 110 69 <li> 111 <p> 112 The launch mode for the custom image. 113 </p> 70 <p>The launch mode for the custom image. </p> 114 71 <p><b outputclass="bold">Paravirtualized</b> mode 115 72 gives improved performance and should be suitable for -
trunk/doc/manual/en_US/dita/topics/cloud-import-oci.dita
r99797 r105289 3 3 <topic xml:lang="en-us" id="cloud-import-oci"> 4 4 <title>Importing an Instance from <ph conkeyref="vbox-conkeyref-phrases/oci"/></title> 5 5 6 6 <body> 7 <p> 8 Perform the following steps to import a cloud instance from 9 <ph conkeyref="vbox-conkeyref-phrases/oci"/> into <ph conkeyref="vbox-conkeyref-phrases/product-name"/>: 10 </p> 7 <p>Perform the following steps to import a cloud instance from <ph conkeyref="vbox-conkeyref-phrases/oci"/> into <ph 8 conkeyref="vbox-conkeyref-phrases/product-name"/>: </p> 11 9 <ol> 12 10 <li> 13 <p> 14 Select <b outputclass="bold">File</b>, 15 <b outputclass="bold">Import Appliance</b> to open 16 the <b outputclass="bold">Import Virtual 17 Appliance</b> wizard. 18 </p> 19 <p> 20 In the <b outputclass="bold">Source</b> drop-down 21 list, select <b outputclass="bold"><ph conkeyref="vbox-conkeyref-phrases/oci"/></b>. 22 </p> 23 <p> 24 In the <b outputclass="bold">Profile</b> drop-down 25 list, select the cloud profile for your <ph conkeyref="vbox-conkeyref-phrases/oci"/> account. 26 </p> 27 <p> 28 Choose the required cloud instance from the list in the 29 <b outputclass="bold">Machines</b> field. 30 </p> 31 <p> 32 Click <b outputclass="bold">Next</b> to make an API 33 request to the <ph conkeyref="vbox-conkeyref-phrases/oci"/> service and display the 34 <b outputclass="bold">Appliance Settings</b> page. 35 </p> 11 <p>Select <b outputclass="bold">File</b>, <b outputclass="bold">Import Appliance</b> to open the <b 12 outputclass="bold">Import Virtual Appliance</b> wizard. </p> 13 <p>In the <b outputclass="bold">Source</b> drop-down list, select <b outputclass="bold"><ph 14 conkeyref="vbox-conkeyref-phrases/oci"/></b>. </p> 15 <p>In the <b outputclass="bold">Profile</b> drop-down list, select the cloud profile for your <ph 16 conkeyref="vbox-conkeyref-phrases/oci"/> account. </p> 17 <p>Choose the required cloud instance from the list in the <b outputclass="bold">Machines</b> field. </p> 18 <p>Click <b outputclass="bold">Next</b> to make an API request to the <ph conkeyref="vbox-conkeyref-phrases/oci" 19 /> service and display the <b outputclass="bold">Appliance Settings</b> page. </p> 36 20 </li> 37 21 <li> 38 <p> 39 (Optional) Edit settings for the new local virtual machine. 40 </p> 41 <p> 42 For example, you can edit the VM name and description. 43 </p> 22 <p>(Optional) Edit settings for the new local virtual machine. </p> 23 <p>For example, you can edit the VM name and description. </p> 44 24 <fig id="fig-import-instance-oci"> 45 25 <title>Import Cloud Instance Wizard: Appliance Settings</title> -
trunk/doc/manual/en_US/dita/topics/cloud-integration-steps.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 Perform the following configuration steps before using 9 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> to integrate with your <ph conkeyref="vbox-conkeyref-phrases/oci"/> account. 10 </p> 7 <p>Perform the following configuration steps before using <ph conkeyref="vbox-conkeyref-phrases/product-name"/> to 8 integrate with your <ph conkeyref="vbox-conkeyref-phrases/oci"/> account. </p> 11 9 <ol> 12 10 <li> … … 22 20 <ph conkeyref="vbox-conkeyref-phrases/oci"/>. See <xref href="cloud-create-api-keypair.dita#cloud-create-api-keypair"/>. 23 21 </p> 24 <p> 25 Upload the public key of the key pair from your client 26 device to the cloud service. See 27 <xref href="cloud-upload-public-key.dita#cloud-upload-public-key"/>. 28 </p> 22 <p>Upload the public key of the key pair from your client device to the cloud service. See <xref 23 href="cloud-upload-public-key.dita#cloud-upload-public-key"/>. </p> 29 24 </li> 30 25 <li> -
trunk/doc/manual/en_US/dita/topics/cloud-integration.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 This section describes how to use the features of <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 9 to integrate with <ph conkeyref="vbox-conkeyref-phrases/oci"/>. 10 </p> 11 <p> 12 Integrating with <ph conkeyref="vbox-conkeyref-phrases/oci"/> involves the following steps: 13 </p> 7 <p>This section describes how to use the features of <ph conkeyref="vbox-conkeyref-phrases/product-name"/> to 8 integrate with <ph conkeyref="vbox-conkeyref-phrases/oci"/>. </p> 9 <p>Integrating with <ph conkeyref="vbox-conkeyref-phrases/oci"/> involves the following steps: </p> 14 10 <ul> 15 11 <li> -
trunk/doc/manual/en_US/dita/topics/cloud-upload-public-key.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 Use the following steps to upload your public key to <ph conkeyref="vbox-conkeyref-phrases/oci"/>. 9 </p> 7 <p>Use the following steps to upload your public key to <ph conkeyref="vbox-conkeyref-phrases/oci"/>. </p> 10 8 <ol> 11 9 <li> 12 <p> 13 Log in to the <ph conkeyref="vbox-conkeyref-phrases/oci"/> Console. 14 </p> 10 <p>Log in to the <ph conkeyref="vbox-conkeyref-phrases/oci"/> Console. </p> 15 11 </li> 16 12 <li> 17 <p> 18 Display the <b outputclass="bold">User Settings</b> 19 page. 20 </p> 21 <p> 22 Click <b outputclass="bold">Profile</b>, 23 <b outputclass="bold">User Settings</b>. 24 </p> 13 <p>Display the <b outputclass="bold">User Settings</b> page. </p> 14 <p>Click <b outputclass="bold">Profile</b>, <b outputclass="bold">User Settings</b>. </p> 25 15 </li> 26 16 <li> 27 <p> 28 Display your current API signing keys. 29 </p> 30 <p> 31 Click <b outputclass="bold">Resources</b>, 32 <b outputclass="bold">API Keys</b>. 33 </p> 17 <p>Display your current API signing keys. </p> 18 <p>Click <b outputclass="bold">Resources</b>, <b outputclass="bold">API Keys</b>. </p> 34 19 </li> 35 20 <li> 36 <p> 37 Upload the public key. 38 </p> 39 <p> 40 Click <b outputclass="bold">Add Public Key</b>. 41 </p> 42 <p> 43 The <b outputclass="bold">Add Public Key</b> dialog 44 is displayed. 45 </p> 21 <p>Upload the public key. </p> 22 <p>Click <b outputclass="bold">Add Public Key</b>. </p> 23 <p>The <b outputclass="bold">Add Public Key</b> dialog is displayed. </p> 46 24 <fig id="fig-upload-key-oci"> 47 25 <title>Upload Public Key Dialog in <ph conkeyref="vbox-conkeyref-phrases/oci"/> Console</title> … … 55 33 </image> 56 34 </fig> 57 <p> 58 Select one of the following options: 59 </p> 35 <p>Select one of the following options: </p> 60 36 <ul> 61 37 <li> … … 72 48 </li> 73 49 </ul> 74 <p> 75 Click <b outputclass="bold">Add</b> to upload the 76 public key. 77 </p> 50 <p>Click <b outputclass="bold">Add</b> to upload the public key. </p> 78 51 </li> 79 52 </ol> -
trunk/doc/manual/en_US/dita/topics/cloud-using-cli.dita
r105134 r105289 5 5 6 6 <body> 7 <p> 8 This section includes some examples of how 9 <userinput>VBoxManage</userinput> commands can be used to integrate 10 with <ph conkeyref="vbox-conkeyref-phrases/oci"/> and perform common cloud operations. 7 <p>This section includes some examples of how <userinput>VBoxManage</userinput> commands can be used to integrate 8 with <ph conkeyref="vbox-conkeyref-phrases/oci"/> and perform common cloud operations. </p> 9 <p><b outputclass="bold">Creating a Cloud Profile</b> 11 10 </p> 12 <p> 13 <b outputclass="bold">Creating a Cloud Profile</b> 14 </p> 15 <p> 16 To create a cloud profile called <codeph>vbox-oci</codeph>: 17 </p> 11 <p>To create a cloud profile called <codeph>vbox-oci</codeph>: </p> 18 12 <pre xml:space="preserve">VBoxManage cloudprofile --provider "OCI" --profile="vbox-oci" add \ 19 13 --clouduser="ocid1.user.oc1..." --keyfile="/home/username/.oci/oci_api_key.pem" \ 20 14 --tenancy="ocid1.tenancy.oc1..." --compartment="ocid1.compartment.oc1..." --region="us-ashburn-1" 21 15 </pre> 22 <p> 23 The new cloud profile is added to the 24 <filepath>oci_config</filepath> file in your <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 25 global configuration directory. For example, this is 26 <filepath>$HOME/.VirtualBox/oci_config</filepath> on a Windows 27 host. 16 <p>The new cloud profile is added to the <filepath>oci_config</filepath> file in your <ph 17 conkeyref="vbox-conkeyref-phrases/product-name"/> global configuration directory. For example, this is 18 <filepath>$HOME/.VirtualBox/oci_config</filepath> on a Windows host. </p> 19 <p><b outputclass="bold">Listing Cloud Instances</b> 28 20 </p> 29 <p> 30 <b outputclass="bold">Listing Cloud Instances</b> 31 </p> 32 <p> 33 To list the instances in your <ph conkeyref="vbox-conkeyref-phrases/oci"/> compartment: 34 </p> 21 <p>To list the instances in your <ph conkeyref="vbox-conkeyref-phrases/oci"/> compartment: </p> 35 22 <pre xml:space="preserve">VBoxManage cloud --provider="OCI" --profile="vbox-oci" list instances 36 23 </pre> 37 <p> 38 <b outputclass="bold">Exporting an <ph conkeyref="vbox-conkeyref-phrases/product-name"/> VM to the 39 Cloud</b> 24 <p><b outputclass="bold">Exporting an <ph conkeyref="vbox-conkeyref-phrases/product-name"/> VM to the Cloud</b> 40 25 </p> 41 <p> 42 To export a VM called <codeph>myVM</codeph> and create a cloud 43 instance called <codeph>myVM_Cloud</codeph>: 44 </p> 26 <p>To export a VM called <codeph>myVM</codeph> and create a cloud instance called <codeph>myVM_Cloud</codeph>: </p> 45 27 <pre xml:space="preserve">VBoxManage export myVM --output OCI:// --cloud 0 --vmname myVM_Cloud \ 46 28 --cloudprofile "vbox-oci" --cloudbucket myBucket \ … … 49 31 --cloudkeepobject true --cloudlaunchinstance true --cloudpublicip true 50 32 </pre> 51 <p> 52 <b outputclass="bold">Importing a Cloud Instance Into 53 <ph conkeyref="vbox-conkeyref-phrases/product-name"/></b> 33 <p><b outputclass="bold">Importing a Cloud Instance Into <ph conkeyref="vbox-conkeyref-phrases/product-name"/></b> 54 34 </p> 55 <p> 56 To import a cloud instance and create an <ph conkeyref="vbox-conkeyref-phrases/product-name"/> VM 57 called <codeph>oci_Import</codeph>: 58 </p> 35 <p>To import a cloud instance and create an <ph conkeyref="vbox-conkeyref-phrases/product-name"/> VM called 36 <codeph>oci_Import</codeph>: </p> 59 37 <pre xml:space="preserve">VBoxManage import OCI:// --cloud --vmname oci_Import --memory 4000 60 38 --cpus 3 --ostype FreeBSD_64 --cloudprofile "vbox-oci" 61 39 --cloudinstanceid ocid1.instance.oc1... --cloudbucket myBucket 62 40 </pre> 63 <p> 64 <b outputclass="bold">Creating a New Cloud Instance From a 65 Custom Image</b> 41 <p><b outputclass="bold">Creating a New Cloud Instance From a Custom Image</b> 66 42 </p> 67 <p> 68 To create a new cloud instance from a custom image on <ph conkeyref="vbox-conkeyref-phrases/oci"/>: 69 </p> 43 <p>To create a new cloud instance from a custom image on <ph conkeyref="vbox-conkeyref-phrases/oci"/>: </p> 70 44 <pre xml:space="preserve">VBoxManage cloud --provider="OCI" --profile="vbox-oci" instance create \ 71 45 --domain-name="oraclecloud.com" --image-id="ocid1.image.oc1..." --display-name="myInstance" \ 72 46 --shape="VM.Standard2.1" --subnet="ocid1.subnet.oc1..."</pre> 73 <p> 74 <b outputclass="bold">Terminating a Cloud Instance</b> 47 <p><b outputclass="bold">Terminating a Cloud Instance</b> 75 48 </p> 76 <p> 77 To terminate an instance in your compartment on <ph conkeyref="vbox-conkeyref-phrases/oci"/>: 78 </p> 49 <p>To terminate an instance in your compartment on <ph conkeyref="vbox-conkeyref-phrases/oci"/>: </p> 79 50 <pre xml:space="preserve">VBoxManage cloud --provider="OCI" --profile="vbox-oci" instance terminate \ 80 51 --id="ocid1.instance.oc1..." </pre> 81 52 82 53 <p><b outputclass="bold">Showing Cloud Instance Performance Metrics</b></p> 83 <p> 84 To show CPU usage metrics for a cloud instance: 85 </p> 54 <p>To show CPU usage metrics for a cloud instance: </p> 86 55 <pre xml:space="preserve">VBoxManage cloud --provider="OCI" --profile="vbox-oci" instance metricdata \ 87 56 --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> 57 <p>For more details about the available commands for cloud operations, see <xref href="vboxmanage-cloud.dita"/>. </p> 90 58 </body> 91 59 -
trunk/doc/manual/en_US/dita/topics/cloud-using-cloud-profile-manager.dita
r105176 r105289 5 5 6 6 <body> 7 <p> 8 This section describes how to use the Cloud Profile Manager to 9 create a cloud profile. 10 </p> 11 <p> 12 To open the Cloud Profile Manager click 13 <b outputclass="bold">File</b>, 14 <b outputclass="bold">Cloud Profile Manager</b> in 15 <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. 16 </p> 7 <p>This section describes how to use the Cloud Profile Manager to create a cloud profile. </p> 8 <p>To open the Cloud Profile Manager click <b outputclass="bold">File</b>, <b outputclass="bold">Cloud Profile 9 Manager</b> in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. </p> 17 10 <fig id="fig-cloud-profile-manager"> 18 11 <title>The Cloud Profile Manager</title> … … 26 19 </image> 27 20 </fig> 28 <p> 29 You can use the Cloud Profile Manager in the following ways: 30 </p> 21 <p>You can use the Cloud Profile Manager in the following ways: </p> 31 22 <ul> 32 23 <li> … … 42 33 </li> 43 34 </ul> 44 <p> 45 Perform the following steps to create a new cloud profile 46 automatically, using the Cloud Profile Manager: 47 </p> 35 <p>Perform the following steps to create a new cloud profile automatically, using the Cloud Profile Manager: </p> 48 36 <ol> 49 37 <li> … … 97 85 </li> 98 86 <li> 99 <p> 100 (Optional) If you are using the cloud profile to connect to 101 cloud virtual machines, select the 102 <b outputclass="bold">Show VMs</b> check box. 103 </p> 104 <p> 105 This creates a new subgroup of the 106 <b outputclass="bold">OCI</b> group in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. 107 See <xref href="cloud-vm-oci-group.dita#cloud-vm-oci-group"/>. 108 </p> 87 <p>(Optional) If you are using the cloud profile to connect to cloud virtual machines, select the <b 88 outputclass="bold">Show VMs</b> check box. </p> 89 <p>This creates a new subgroup of the <b outputclass="bold">OCI</b> group in <ph 90 conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. See <xref href="cloud-vm-oci-group.dita#cloud-vm-oci-group" 91 />. </p> 109 92 </li> 110 93 <li> 111 <p> 112 Click <b outputclass="bold">Apply</b> to save your 113 changes. 114 </p> 115 <p> 116 The cloud profile settings are saved to the 117 <filepath>oci_config</filepath> file in your <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 118 global settings directory. 119 </p> 94 <p>Click <b outputclass="bold">Apply</b> to save your changes. </p> 95 <p>The cloud profile settings are saved to the <filepath>oci_config</filepath> file in your <ph 96 conkeyref="vbox-conkeyref-phrases/product-name"/> global settings directory. </p> 120 97 </li> 121 98 </ol> 122 <p> 123 Perform the following steps to import an existing <ph conkeyref="vbox-conkeyref-phrases/oci"/> 124 configuration file into the Cloud Profile Manager: 125 </p> 99 <p>Perform the following steps to import an existing <ph conkeyref="vbox-conkeyref-phrases/oci"/> configuration file 100 into the Cloud Profile Manager: </p> 126 101 <ol> 127 102 <li> … … 139 114 </p> 140 115 <note> 141 <p> 142 This action overwrites any cloud profiles that are in your 143 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> global settings directory. 144 </p> 116 <p>This action overwrites any cloud profiles that are in your <ph 117 conkeyref="vbox-conkeyref-phrases/product-name"/> global settings directory. </p> 145 118 </note> 146 119 </li> 147 120 <li> 148 <p> 149 Click <b outputclass="bold">Import</b>. 150 </p> 151 <p> 152 Your cloud profile settings are saved to the 153 <filepath>oci_config</filepath> file in your <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 154 global settings directory. 155 </p> 121 <p>Click <b outputclass="bold">Import</b>. </p> 122 <p>Your cloud profile settings are saved to the <filepath>oci_config</filepath> file in your <ph 123 conkeyref="vbox-conkeyref-phrases/product-name"/> global settings directory. </p> 156 124 </li> 157 125 <li> 158 <p> 159 Click <b outputclass="bold">Properties</b> to show 160 the cloud profile settings. 161 </p> 126 <p>Click <b outputclass="bold">Properties</b> to show the cloud profile settings. </p> 162 127 <p> Double-click the appropriate field to change the value. </p> 163 128 </li> 164 129 <li> 165 <p> 166 Click <b outputclass="bold">Apply</b> to save your 167 changes. 168 </p> 130 <p>Click <b outputclass="bold">Apply</b> to save your changes. </p> 169 131 </li> 170 132 </ol> -
trunk/doc/manual/en_US/dita/topics/cloud-vbox-oci-tasks.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 This section describes how you can use <ph conkeyref="vbox-conkeyref-phrases/product-name"/> with <ph conkeyref="vbox-conkeyref-phrases/oci"/> 9 to do the following tasks: 10 </p> 7 <p>This section describes how you can use <ph conkeyref="vbox-conkeyref-phrases/product-name"/> with <ph 8 conkeyref="vbox-conkeyref-phrases/oci"/> to do the following tasks: </p> 11 9 <ul> 12 10 <li> 13 <p> 14 Create, add, and manage <ph conkeyref="vbox-conkeyref-phrases/oci"/> cloud instances using 15 <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. See <xref href="cloud-vm.dita#cloud-vm"/>. 16 </p> 11 <p>Create, add, and manage <ph conkeyref="vbox-conkeyref-phrases/oci"/> cloud instances using <ph 12 conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. See <xref href="cloud-vm.dita#cloud-vm"/>. </p> 17 13 </li> 18 14 <li> 19 <p> 20 Export an <ph conkeyref="vbox-conkeyref-phrases/product-name"/> VM to <ph conkeyref="vbox-conkeyref-phrases/oci"/>. See 21 <xref href="cloud-export-oci.dita#cloud-export-oci"/>. 22 </p> 15 <p>Export an <ph conkeyref="vbox-conkeyref-phrases/product-name"/> VM to <ph 16 conkeyref="vbox-conkeyref-phrases/oci"/>. See <xref href="cloud-export-oci.dita#cloud-export-oci"/>. </p> 23 17 </li> 24 18 <li> 25 <p> 26 Import a cloud instance into <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. See 27 <xref href="cloud-import-oci.dita#cloud-import-oci"/>. 28 </p> 19 <p>Import a cloud instance into <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. See <xref 20 href="cloud-import-oci.dita#cloud-import-oci"/>. </p> 29 21 </li> 30 22 <li> 31 <p> 32 Connect from a local VM to an <ph conkeyref="vbox-conkeyref-phrases/oci"/> cloud subnet. See 33 <xref href="cloud-using-cloud-networks.dita#cloud-using-cloud-networks"/>. 34 </p> 23 <p>Connect from a local VM to an <ph conkeyref="vbox-conkeyref-phrases/oci"/> cloud subnet. See <xref 24 href="cloud-using-cloud-networks.dita#cloud-using-cloud-networks"/>. </p> 35 25 </li> 36 26 <li> 37 <p> 38 Use the <userinput>VBoxManage</userinput> commands to integrate 39 with <ph conkeyref="vbox-conkeyref-phrases/oci"/> and perform cloud operations. See 40 <xref href="cloud-using-cli.dita#cloud-using-cli"/>. 41 </p> 27 <p>Use the <userinput>VBoxManage</userinput> commands to integrate with <ph 28 conkeyref="vbox-conkeyref-phrases/oci"/> and perform cloud operations. See <xref 29 href="cloud-using-cli.dita#cloud-using-cli"/>. </p> 42 30 </li> 43 31 </ul> -
trunk/doc/manual/en_US/dita/topics/cloud-vm-add.dita
r105176 r105289 5 5 6 6 <body> 7 <p> 8 When you add a cloud VM, an <i>existing</i> 9 <ph conkeyref="vbox-conkeyref-phrases/oci"/> instance is associated with the cloud VM. You can only 10 add one cloud VM for each instance. 11 </p> 12 <p> 13 Perform the following steps to add a cloud VM: 14 </p> 7 <p>When you add a cloud VM, an <i>existing</i> 8 <ph conkeyref="vbox-conkeyref-phrases/oci"/> instance is associated with the cloud VM. You can only add one cloud 9 VM for each instance. </p> 10 <p>Perform the following steps to add a cloud VM: </p> 15 11 <ol> 16 12 <li> 17 13 <p> Click a cloud profile in the <b outputclass="bold">OCI</b> group. </p> 18 <p> 19 The cloud VMs for the selected cloud profile are 20 displayed. 21 </p> 14 <p>The cloud VMs for the selected cloud profile are displayed. </p> 22 15 </li> 23 16 <li> 24 <p> 25 Select <b outputclass="bold">Group</b>, 26 <b outputclass="bold">Add Machine</b>. 27 </p> 28 <p> 29 The <b outputclass="bold">Add Cloud Virtual 30 Machine</b> wizard is displayed. 31 </p> 17 <p>Select <b outputclass="bold">Group</b>, <b outputclass="bold">Add Machine</b>. </p> 18 <p>The <b outputclass="bold">Add Cloud Virtual Machine</b> wizard is displayed. </p> 32 19 <fig id="fig-cloudvm-add"> 33 20 <title>Add Cloud Virtual Machine Wizard</title> … … 43 30 </li> 44 31 <li> 45 <p> 46 Configure the following settings: 47 </p> 32 <p>Configure the following settings: </p> 48 33 <ul> 49 34 <li> … … 69 54 </li> 70 55 <li> 71 <p> 72 Click <b outputclass="bold">Finish</b> to add a 73 cloud VM based on the selected instance. 74 </p> 75 <p> 76 A cloud VM with the same name as the instance is added to 77 the <b outputclass="bold">OCI</b> group in 78 <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. 79 </p> 56 <p>Click <b outputclass="bold">Finish</b> to add a cloud VM based on the selected instance. </p> 57 <p>A cloud VM with the same name as the instance is added to the <b outputclass="bold">OCI</b> group in <ph 58 conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. </p> 80 59 </li> 81 60 <li> 82 <p> 83 (Optional) To change the display name for the instance, 84 click <b outputclass="bold">Settings</b> and edit 85 the <b outputclass="bold">Display Name</b> field. 86 </p> 87 <p> 88 The cloud VM name in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> is updated automatically. 89 </p> 61 <p>(Optional) To change the display name for the instance, click <b outputclass="bold">Settings</b> and edit the 62 <b outputclass="bold">Display Name</b> field. </p> 63 <p>The cloud VM name in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> is updated automatically. </p> 90 64 </li> 91 65 </ol> -
trunk/doc/manual/en_US/dita/topics/cloud-vm-clone.dita
r105176 r105289 5 5 6 6 <body> 7 <p> 8 When you clone a cloud VM, a copy of the <ph conkeyref="vbox-conkeyref-phrases/oci"/> instance 9 for the cloud VM is created and associated with the new cloud VM. 10 </p> 11 <p> 12 Perform the following steps to clone a cloud VM: 13 </p> 7 <p>When you clone a cloud VM, a copy of the <ph conkeyref="vbox-conkeyref-phrases/oci"/> instance for the cloud VM 8 is created and associated with the new cloud VM. </p> 9 <p>Perform the following steps to clone a cloud VM: </p> 14 10 <ol> 15 11 <li> 16 <p> 17 Click a cloud profile in the 18 <b outputclass="bold">OCI</b> group. 19 </p> 20 <p> 21 The cloud VMs for the selected cloud profile are 22 displayed. 23 </p> 12 <p>Click a cloud profile in the <b outputclass="bold">OCI</b> group. </p> 13 <p>The cloud VMs for the selected cloud profile are displayed. </p> 24 14 </li> 25 15 <li> 26 <p> 27 Right-click the cloud VM you want to clone and select <b outputclass="bold">Clone</b>. 28 </p> 29 <p> 30 The <b outputclass="bold">Clone Name</b> dialog is displayed. 31 </p> 16 <p>Right-click the cloud VM you want to clone and select <b outputclass="bold">Clone</b>. </p> 17 <p>The <b outputclass="bold">Clone Name</b> dialog is displayed. </p> 32 18 <p>Enter a name for the clone.</p> 33 19 <p>The name you enter is also used as the display name for the related … … 37 23 </li> 38 24 <li> 39 <p> Click <b>OK</b> to create the clone and the related <ph 40 conkeyref="vbox-conkeyref-phrases/oci"/> instance. The new instance is started 41 automatically. </p> 42 <p> 43 The new cloud VM is shown in the 44 <b outputclass="bold">OCI</b> group in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. 45 </p> 25 <p>Click <b>OK</b> to create the clone and the related <ph conkeyref="vbox-conkeyref-phrases/oci"/> instance. 26 The new instance is started automatically. </p> 27 <p>The new cloud VM is shown in the <b outputclass="bold">OCI</b> group in <ph 28 conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. </p> 46 29 </li> 47 30 </ol> -
trunk/doc/manual/en_US/dita/topics/cloud-vm-control.dita
r105176 r105289 5 5 <!-- 7.1: OCI instance reset feature--> 6 6 <body> 7 <p> 8 You can use <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> to control a cloud VM as follows: 9 </p> 7 <p>You can use <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> to control a cloud VM as follows: </p> 10 8 <ul> 11 9 <li> … … 32 30 </p> 33 31 <note type="caution"> 34 <p> 35 This action deletes the instance from <ph conkeyref="vbox-conkeyref-phrases/oci"/>. 36 </p> 32 <p>This action deletes the instance from <ph conkeyref="vbox-conkeyref-phrases/oci"/>. </p> 37 33 </note> 38 34 </li> 39 35 </ul> 40 <p> 41 When you control a cloud VM in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> the machine list is 42 updated automatically with the current instance state, such as 43 <b outputclass="bold">Stopped</b> or <b outputclass="bold">Running</b>. 44 </p> 45 <p> 46 When you control an instance using the <ph conkeyref="vbox-conkeyref-phrases/oci"/> console, 47 <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> updates the status for the corresponding cloud VM 48 automatically. 49 </p> 36 <p>When you control a cloud VM in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> the machine list is updated 37 automatically with the current instance state, such as <b outputclass="bold">Stopped</b> or <b outputclass="bold" 38 >Running</b>. </p> 39 <p>When you control an instance using the <ph conkeyref="vbox-conkeyref-phrases/oci"/> console, <ph 40 conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> updates the status for the corresponding cloud VM automatically. </p> 50 41 </body> 51 42 -
trunk/doc/manual/en_US/dita/topics/cloud-vm-instance-console.dita
r105176 r105289 5 5 6 6 <body> 7 <p> 8 To create a instance console connection, the cloud VM must be 9 in <b outputclass="bold">Running</b> state. 10 </p> 7 <p>To create a instance console connection, the cloud VM must be in <b outputclass="bold">Running</b> state. </p> 11 8 <ol> 9 <li>Right-click the cloud VM name and select <b outputclass="bold">Console</b>, <b outputclass="bold">Create 10 Connection</b>. </li> 12 11 <li> 13 <p> Right-click the cloud VM name and select <b outputclass="bold">Console</b>, <b 14 outputclass="bold">Create Connection</b>. </p> 12 <p>The <b outputclass="bold">Public Key</b> dialog is displayed. Paste the public key used for the instance 13 connection into the dialog and click <b outputclass="bold">OK</b>. </p> 14 <p>By default, either the first entry in your SSH keys folder or the public key used for your previous instance 15 console connection is used. </p> 15 16 </li> 16 17 <li> 17 <p> 18 The <b outputclass="bold">Public Key</b> dialog is 19 displayed. Paste the public key used for the instance 20 connection into the dialog and click 21 <b outputclass="bold">OK</b>. 22 </p> 23 <p> 24 By default, either the first entry in your SSH keys folder 25 or the public key used for your previous instance console 26 connection is used. 27 </p> 18 <p>Click <b outputclass="bold">Connect</b> to connect to the instance. An instance console is displayed 19 automatically on the host. </p> 28 20 </li> 29 21 <li> 30 <p> 31 Click <b outputclass="bold">Connect</b> to connect 32 to the instance. An instance console is displayed 33 automatically on the host. 34 </p> 35 </li> 36 <li> 37 <p> 38 (Optional) Click <b outputclass="bold">Show Log</b> 39 to display log messages for the instance console 40 connection. 41 </p> 22 <p>(Optional) Click <b outputclass="bold">Show Log</b> to display log messages for the instance console 23 connection. </p> 42 24 </li> 43 25 </ol> 44 <p> 45 See the <ph conkeyref="vbox-conkeyref-phrases/oci"/> documentation for details about how you can use 46 an instance console connection to troubleshoot instance 47 problems. 48 </p> 26 <p>See the <ph conkeyref="vbox-conkeyref-phrases/oci"/> documentation for details about how you can use an instance 27 console connection to troubleshoot instance problems. </p> 49 28 </body> 50 29 -
trunk/doc/manual/en_US/dita/topics/cloud-vm-new.dita
r105176 r105289 5 5 6 6 <body> 7 <p> 8 When you create a new cloud VM, a <i>new</i> 9 <ph conkeyref="vbox-conkeyref-phrases/oci"/> instance is created and associated with the cloud VM. 10 </p> 11 <p> 12 Perform the following steps to create a new cloud VM: 13 </p> 7 <p>When you create a new cloud VM, a <i>new</i> 8 <ph conkeyref="vbox-conkeyref-phrases/oci"/> instance is created and associated with the cloud VM. </p> 9 <p>Perform the following steps to create a new cloud VM: </p> 14 10 <ol> 15 11 <li> 16 12 <p> Click a cloud profile in the <b outputclass="bold">OCI</b> group. </p> 17 <p> 18 The cloud VMs for the selected cloud profile are 19 displayed. 20 </p> 13 <p>The cloud VMs for the selected cloud profile are displayed. </p> 21 14 </li> 22 15 <li> 23 <p> 24 Select <b outputclass="bold">Group</b>, 25 <b outputclass="bold">New Machine</b>. 26 </p> 27 <p> 28 The <b outputclass="bold">Create Cloud Virtual 29 Machine</b> wizard is displayed. 30 </p> 16 <p>Select <b outputclass="bold">Group</b>, <b outputclass="bold">New Machine</b>. </p> 17 <p>The <b outputclass="bold">Create Cloud Virtual Machine</b> wizard is displayed. </p> 31 18 <fig id="fig-cloudvm-new"> 32 19 <title>Create Cloud Virtual Machine Wizard</title> … … 42 29 </li> 43 30 <li> 44 <p> 45 On the initial page, configure the following settings for 46 the new cloud VM: 47 </p> 31 <p>On the initial page, configure the following settings for the new cloud VM: </p> 48 32 <ul> 49 33 <li> 50 <p><b outputclass="bold">Location:</b> The cloud 51 service provider that will host the new instance. 52 Select <b outputclass="bold"><ph conkeyref="vbox-conkeyref-phrases/oci"/></b>. 53 </p> 34 <p><b outputclass="bold">Location:</b> The cloud service provider that will host the new instance. Select <b 35 outputclass="bold"><ph conkeyref="vbox-conkeyref-phrases/oci"/></b>. </p> 54 36 </li> 55 37 <li> 56 <p><b outputclass="bold">Profile:</b> The cloud 57 profile used to connect to the new instance. Select 58 from the available cloud profiles. 59 </p> 38 <p><b outputclass="bold">Profile:</b> The cloud profile used to connect to the new instance. Select from the 39 available cloud profiles. </p> 60 40 </li> 61 41 <li> 62 <p><b outputclass="bold">Source:</b> The image 63 that the new instance is based on. Choose from the 64 available images and boot volumes. 65 </p> 42 <p><b outputclass="bold">Source:</b> The image that the new instance is based on. Choose from the available 43 images and boot volumes. </p> 66 44 </li> 67 45 </ul> 68 46 </li> 69 47 <li> 70 <p> 71 Click <b outputclass="bold">Next</b> to display the 72 <b outputclass="bold">Cloud Virtual Machine 73 Settings</b> page. 74 </p> 75 <p> 76 You can use this page to change the default settings for 77 the new <ph conkeyref="vbox-conkeyref-phrases/oci"/> instance, such as the display name, shape, 78 and networking configuration. 79 </p> 80 <p> 81 To add an SSH key to the instance, click the 82 <b outputclass="bold">SSH Authorised Keys</b> field 83 and paste the public key into the displayed dialog. 84 </p> 48 <p>Click <b outputclass="bold">Next</b> to display the <b outputclass="bold">Cloud Virtual Machine Settings</b> 49 page. </p> 50 <p>You can use this page to change the default settings for the new <ph conkeyref="vbox-conkeyref-phrases/oci"/> 51 instance, such as the display name, shape, and networking configuration. </p> 52 <p>To add an SSH key to the instance, click the <b outputclass="bold">SSH Authorised Keys</b> field and paste 53 the public key into the displayed dialog. </p> 85 54 </li> 86 55 <li> 87 <p> 88 Click <b outputclass="bold">Finish</b> to create a 89 new <ph conkeyref="vbox-conkeyref-phrases/oci"/> instance using the selected image or boot 90 volume. The new instance is started automatically. 91 </p> 92 <p> 93 The new cloud VM is shown in the 94 <b outputclass="bold">OCI</b> group in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. 95 </p> 56 <p>Click <b outputclass="bold">Finish</b> to create a new <ph conkeyref="vbox-conkeyref-phrases/oci"/> instance 57 using the selected image or boot volume. The new instance is started automatically. </p> 58 <p>The new cloud VM is shown in the <b outputclass="bold">OCI</b> group in <ph 59 conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. </p> 96 60 </li> 97 61 </ol> -
trunk/doc/manual/en_US/dita/topics/cloud-vm-oci-group.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 All cloud VMs are shown in the machine list in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>, in 9 a special VM group called 10 <b outputclass="bold">OCI</b>. 11 </p> 12 <p> 13 Cloud VMs are further grouped according to the cloud profile 14 used to connect to them. The cloud profile identifies the user 15 and compartment for the cloud VM and includes details of the 16 key pair used to connect to cloud instances. See 17 <xref href="cloud-create-cloud-profile.dita#cloud-create-cloud-profile"/>. 18 </p> 7 <p>All cloud VMs are shown in the machine list in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>, in a special VM 8 group called <b outputclass="bold">OCI</b>. </p> 9 <p>Cloud VMs are further grouped according to the cloud profile used to connect to them. The cloud profile 10 identifies the user and compartment for the cloud VM and includes details of the key pair used to connect to cloud 11 instances. See <xref href="cloud-create-cloud-profile.dita#cloud-create-cloud-profile"/>. </p> 19 12 <fig id="fig-cloud-vm-oci-group"> 20 13 <title>OCI Group, Containing Cloud VMs</title> … … 28 21 </image> 29 22 </fig> 30 <p> 31 All cloud profiles registered with <ph conkeyref="vbox-conkeyref-phrases/product-name"/> are listed 32 automatically in the OCI group. 33 </p> 34 <p> 35 To enable or disable listing of cloud VMs in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> for a 36 specific cloud profile, do the following: 37 </p> 38 <p> 39 Display the <b outputclass="bold">Cloud Profile 40 Manager</b> and select or deselect the 41 <b outputclass="bold">List VMs</b> check box for each 42 cloud profile. 43 </p> 23 <p>All cloud profiles registered with <ph conkeyref="vbox-conkeyref-phrases/product-name"/> are listed automatically 24 in the OCI group. </p> 25 <p>To enable or disable listing of cloud VMs in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> for a specific 26 cloud profile, do the following: </p> 27 <p>Display the <b outputclass="bold">Cloud Profile Manager</b> and select or deselect the <b outputclass="bold">List 28 VMs</b> check box for each cloud profile. </p> 44 29 </body> 45 30 -
trunk/doc/manual/en_US/dita/topics/cloud-vm-remove.dita
r105176 r105289 5 5 6 6 <body> 7 <p> 8 You can use <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> to remove a cloud VM as follows: 9 </p> 7 <p>You can use <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> to remove a cloud VM as follows: </p> 10 8 <p> Right-click the cloud VM name and select <b outputclass="bold">Remove</b>. </p> 11 9 <ul> 12 10 <li> 13 <p> 14 Click <b outputclass="bold">Remove Only</b> to 15 remove the cloud VM from the machine list in VirtualBox 16 Manager. 17 </p> 11 <p>Click <b outputclass="bold">Remove Only</b> to remove the cloud VM from the machine list in VirtualBox 12 Manager. </p> 18 13 </li> 19 14 <li> 20 <p> 21 Click <b outputclass="bold">Delete Everything</b> 22 to remove the cloud VM from <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> and also to delete 23 the <ph conkeyref="vbox-conkeyref-phrases/oci"/> instance and any associated boot volumes. 24 </p> 15 <p>Click <b outputclass="bold">Delete Everything</b> to remove the cloud VM from <ph 16 conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> and also to delete the <ph 17 conkeyref="vbox-conkeyref-phrases/oci"/> instance and any associated boot volumes. </p> 25 18 </li> 26 19 </ul> -
trunk/doc/manual/en_US/dita/topics/cloud-vm-settings.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 Select the cloud VM in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> and click 9 <b outputclass="bold">Settings</b>. 10 </p> 7 <p>Select the cloud VM in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> and click <b outputclass="bold" 8 >Settings</b>. </p> 11 9 <ul> 12 10 <li> 13 <p> 14 For a <i>new</i> cloud VM, you can change 15 many settings for the <ph conkeyref="vbox-conkeyref-phrases/oci"/> instance, such as the display 16 name, shape, and disk size. 17 </p> 11 <p>For a <i>new</i> cloud VM, you can change many settings for the <ph conkeyref="vbox-conkeyref-phrases/oci"/> 12 instance, such as the display name, shape, and disk size. </p> 18 13 </li> 19 14 <li> 20 <p> 21 When you <i>add</i> a cloud VM based on an 22 existing <ph conkeyref="vbox-conkeyref-phrases/oci"/> instance you can only change the display 23 name. 24 </p> 15 <p>When you <i>add</i> a cloud VM based on an existing <ph conkeyref="vbox-conkeyref-phrases/oci"/> instance you 16 can only change the display name. </p> 25 17 </li> 26 18 </ul> -
trunk/doc/manual/en_US/dita/topics/cloud-vm.dita
r105134 r105289 4 4 <title>Using Cloud Virtual Machines</title> 5 5 <body> 6 <p> 7 A cloud virtual machine (<i>cloud VM</i>) is a 8 type of VM that represents an instance on a cloud service. Cloud 9 VMs are shown in the machine list in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>, in the same way 10 as local VMs are. 11 </p> 12 <p> 13 By using cloud VMs you can create, manage, and control your 14 <ph conkeyref="vbox-conkeyref-phrases/oci"/> instances from <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. 15 </p> 6 <p>A cloud virtual machine (<i>cloud VM</i>) is a type of VM that represents an instance on a cloud service. Cloud 7 VMs are shown in the machine list in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>, in the same way as local 8 VMs are. </p> 9 <p>By using cloud VMs you can create, manage, and control your <ph conkeyref="vbox-conkeyref-phrases/oci"/> 10 instances from <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. </p> 16 11 <note> 17 <p> 18 Cloud VMs do not install, export, or import instances to the 19 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> host. All operations are done remotely on the 20 cloud service. 21 </p> 12 <p>Cloud VMs do not install, export, or import instances to the <ph 13 conkeyref="vbox-conkeyref-phrases/product-name"/> host. All operations are done remotely on the cloud service. </p> 22 14 </note> 23 15 <fig id="fig-cloud-vm-overview"> … … 32 24 </image> 33 25 </fig> 34 <p> 35 Cloud VMs can be used to do the following tasks in <ph conkeyref="vbox-conkeyref-phrases/oci"/>: 36 </p> 26 <p>Cloud VMs can be used to do the following tasks in <ph conkeyref="vbox-conkeyref-phrases/oci"/>: </p> 37 27 <ul> 38 28 <li> -
trunk/doc/manual/en_US/dita/topics/configbasics.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 When you select a virtual machine from the list in the VirtualBox 9 Manager window, you will see a summary of that machine's settings 10 on the right. 11 </p> 12 <p> 13 Clicking on <b outputclass="bold">Settings</b> displays a 14 window, where you can configure many of the properties of the 15 selected VM. But be careful when changing VM settings. It is 16 possible to change all VM settings after installing a guest OS, 17 but certain changes might prevent a guest OS from functioning 18 correctly if done after installation. 19 </p> 7 <p>When you select a virtual machine from the list in the VirtualBox Manager window, you will see a summary of that 8 machine's settings on the right. </p> 9 <p>Clicking on <b outputclass="bold">Settings</b> displays a window, where you can configure many of the properties 10 of the selected VM. But be careful when changing VM settings. It is possible to change all VM settings after 11 installing a guest OS, but certain changes might prevent a guest OS from functioning correctly if done after 12 installation. </p> 20 13 <note> 21 <p> 22 The <b outputclass="bold">Settings</b> button is disabled 23 while a VM is either in the Running or Saved state. This is 24 because the <b outputclass="bold">Settings</b> window 25 enables you to change fundamental characteristics of the virtual 26 machine that is created for your guest OS. For example, the 27 guest OS may not perform well if half of its memory is taken 28 away. As a result, if the 29 <b outputclass="bold">Settings</b> button is disabled, 30 shut down the current VM first. 31 </p> 14 <p>The <b outputclass="bold">Settings</b> button is disabled while a VM is either in the Running or Saved state. 15 This is because the <b outputclass="bold">Settings</b> window enables you to change fundamental characteristics 16 of the virtual machine that is created for your guest OS. For example, the guest OS may not perform well if half 17 of its memory is taken away. As a result, if the <b outputclass="bold">Settings</b> button is disabled, shut 18 down the current VM first. </p> 32 19 </note> 33 <p> 34 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> provides a wide range of parameters that can be 35 changed for a virtual machine. The various settings that can be 36 changed in the <b outputclass="bold">Settings</b> window 37 are described in detail in <xref href="BasicConcepts.dita#BasicConcepts"/>. Even 38 more parameters are available when using the 39 <userinput>VBoxManage</userinput> command line interface. See 40 <xref href="vboxmanage.dita#vboxmanage"/>. 41 </p> 20 <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> provides a wide range of parameters that can be changed for 21 a virtual machine. The various settings that can be changed in the <b outputclass="bold">Settings</b> window are 22 described in detail in <xref href="BasicConcepts.dita#BasicConcepts"/>. Even more parameters are available when 23 using the <userinput>VBoxManage</userinput> command line interface. See <xref href="vboxmanage.dita#vboxmanage"/>. </p> 42 24 </body> 43 25 -
trunk/doc/manual/en_US/dita/topics/create-vm-wizard.dita
r105134 r105289 35 35 </ul> 36 36 </note> 37 <p> </p>38 37 </body> 39 38 </topic> -
trunk/doc/manual/en_US/dita/topics/efi.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> includes experimental support for the Extensible 9 Firmware Interface (EFI), which is an industry standard intended 10 to replace the legacy BIOS as the primary interface for 11 bootstrapping computers and certain system services later. 12 </p> 13 <p> 14 By default, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> uses the BIOS firmware for virtual 15 machines. To use EFI for a given virtual machine, you can enable 16 EFI in the machine's <b outputclass="bold">Settings</b> 17 window. See <xref href="settings-motherboard.dita#settings-motherboard"/>. Alternatively, 18 use the <userinput>VBoxManage</userinput> command line interface as 19 follows: 20 </p> 7 <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> includes experimental support for the Extensible Firmware 8 Interface (EFI), which is an industry standard intended to replace the legacy BIOS as the primary interface for 9 bootstrapping computers and certain system services later. </p> 10 <p>By default, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> uses the BIOS firmware for virtual machines. To 11 use EFI for a given virtual machine, you can enable EFI in the machine's <b outputclass="bold">Settings</b> 12 window. See <xref href="settings-motherboard.dita#settings-motherboard"/>. Alternatively, use the 13 <userinput>VBoxManage</userinput> command line interface as follows: </p> 21 14 <pre xml:space="preserve">VBoxManage modifyvm "VM name" --firmware efi</pre> 22 <p> 23 To switch back to using the BIOS: 24 </p> 15 <p>To switch back to using the BIOS: </p> 25 16 <pre xml:space="preserve">VBoxManage modifyvm "VM name" --firmware bios</pre> 26 <p> 27 One notable user of EFI is Apple Mac OS X. More recent Linux 28 versions and Windows releases, starting with Vista, also offer 29 special versions that can be booted using EFI. 30 </p> 31 <p> 32 Another possible use of EFI in <ph conkeyref="vbox-conkeyref-phrases/product-name"/> is development and 33 testing of EFI applications, without booting any OS. 34 </p> 35 <p> 36 Note that the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> EFI support is experimental and will 37 be enhanced as EFI matures and becomes more widespread. Mac OS X, 38 Linux, and newer Windows guests are known to work fine. Windows 7 39 guests are unable to boot with the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> EFI 40 implementation. 41 </p> 17 <p>One notable user of EFI is Apple Mac OS X. More recent Linux versions and Windows releases, starting with Vista, 18 also offer special versions that can be booted using EFI. </p> 19 <p>Another possible use of EFI in <ph conkeyref="vbox-conkeyref-phrases/product-name"/> is development and testing 20 of EFI applications, without booting any OS. </p> 21 <p>Note that the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> EFI support is experimental and will be 22 enhanced as EFI matures and becomes more widespread. Mac OS X, Linux, and newer Windows guests are known to work 23 fine. Windows 7 guests are unable to boot with the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> EFI 24 implementation. </p> 42 25 </body> 43 26 </topic> -
trunk/doc/manual/en_US/dita/topics/efibootargs.dita
r98549 r105289 5 5 6 6 <body> 7 <p> 8 It is currently not possible to manipulate EFI variables from 9 within a running guest. For example, setting the 10 <codeph>boot-args</codeph> variable by running the 11 <userinput>nvram</userinput> tool in a Mac OS X guest will not work. 12 As an alternative method, 13 <codeph>VBoxInternal2/EfiBootArgs</codeph> extradata can be 14 passed to a VM in order to set the <codeph>boot-args</codeph> 15 variable. To change the <codeph>boot-args</codeph> EFI 16 variable, use the following command: 17 </p> 7 <p>It is currently not possible to manipulate EFI variables from within a running guest. For example, setting the 8 <codeph>boot-args</codeph> variable by running the <userinput>nvram</userinput> tool in a Mac OS X guest will 9 not work. As an alternative method, <codeph>VBoxInternal2/EfiBootArgs</codeph> extradata can be passed to a VM in 10 order to set the <codeph>boot-args</codeph> variable. To change the <codeph>boot-args</codeph> EFI variable, use 11 the following command: </p> 18 12 <pre xml:space="preserve">VBoxManage setextradata "VM name" VBoxInternal2/EfiBootArgs <value></pre> 19 13 </body> -
trunk/doc/manual/en_US/dita/topics/efividmode.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 EFI provides two distinct video interfaces: GOP (Graphics Output 9 Protocol) and UGA (Universal Graphics Adapter). Modern OSes, 10 such as Mac OS X, generally use GOP, while some older ones still 11 use UGA. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> provides a configuration option to 12 control the graphics resolution for both interfaces, making the 13 difference mostly irrelevant for users. 14 </p> 15 <p> 16 The default resolution is 1024x768. To select a graphics 17 resolution for EFI, use the following 18 <userinput>VBoxManage</userinput> command: 19 </p> 7 <p>EFI provides two distinct video interfaces: GOP (Graphics Output Protocol) and UGA (Universal Graphics Adapter). 8 Modern OSes, such as Mac OS X, generally use GOP, while some older ones still use UGA. <ph 9 conkeyref="vbox-conkeyref-phrases/product-name"/> provides a configuration option to control the graphics 10 resolution for both interfaces, making the difference mostly irrelevant for users. </p> 11 <p>The default resolution is 1024x768. To select a graphics resolution for EFI, use the following 12 <userinput>VBoxManage</userinput> command: </p> 20 13 <pre xml:space="preserve">VBoxManage setextradata "VM name" VBoxInternal2/EfiGraphicsResolution HxV</pre> 21 <p> 22 Determine the horizontal resolution H and the vertical 23 resolution V from the following list of default resolutions: 24 </p> 14 <p>Determine the horizontal resolution H and the vertical resolution V from the following list of default 15 resolutions: </p> 25 16 <dl> 26 17 <dlentry> … … 335 326 </dlentry> 336 327 </dl> 337 <p> 338 If this list of default resolution does not cover your needs, 339 see <xref href="customvesa.dita">Custom VESA Resolutions</xref>. Note that the color depth 340 value specified in a custom video mode must be specified. Color 341 depths of 8, 16, 24, and 32 are accepted. EFI assumes a color 342 depth of 32 by default. 343 </p> 344 <p> 345 The EFI default video resolution settings can only be changed 346 when the VM is powered off. 347 </p> 328 <p>If this list of default resolution does not cover your needs, see <xref href="customvesa.dita">Custom VESA 329 Resolutions</xref>. Note that the color depth value specified in a custom video mode must be specified. Color 330 depths of 8, 16, 24, and 32 are accepted. EFI assumes a color depth of 32 by default. </p> 331 <p>The EFI default video resolution settings can only be changed when the VM is powered off. </p> 348 332 </body> 349 333 -
trunk/doc/manual/en_US/dita/topics/externalkernelmodules.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 In order to run other operating systems in virtual machines 9 alongside your main operating system, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> needs to 10 integrate very tightly with your system. To do this it installs 11 a driver module called <userinput>vboxdrv</userinput> into the 12 system kernel. The kernel is the part of the operating system 13 which controls your processor and physical hardware. Without 14 this kernel module, you can still use <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> to configure 15 virtual machines, but they will not start. 16 </p> 17 <p> 18 Network drivers called <userinput>vboxnetflt</userinput> and 19 <userinput>vboxnetadp</userinput> are also installed. They enable 20 virtual machines to make more use of your computer's network 21 capabilities and are needed for any virtual machine networking 22 beyond the basic NAT mode. 23 </p> 24 <p> 25 Since distributing driver modules separately from the kernel is 26 not something which Linux supports well, the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 27 install process creates the modules on the system where they 28 will be used. This means that you may need to install some 29 software packages from the distribution which are needed for the 30 build process. Required packages may include the following: 31 </p> 7 <p>In order to run other operating systems in virtual machines alongside your main operating system, <ph 8 conkeyref="vbox-conkeyref-phrases/product-name"/> needs to integrate very tightly with your system. To do this 9 it installs a driver module called <userinput>vboxdrv</userinput> into the system kernel. The kernel is the part 10 of the operating system which controls your processor and physical hardware. Without this kernel module, you can 11 still use <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> to configure virtual machines, but they will not 12 start. </p> 13 <p>Network drivers called <userinput>vboxnetflt</userinput> and <userinput>vboxnetadp</userinput> are also 14 installed. They enable virtual machines to make more use of your computer's network capabilities and are needed 15 for any virtual machine networking beyond the basic NAT mode. </p> 16 <p>Since distributing driver modules separately from the kernel is not something which Linux supports well, the <ph 17 conkeyref="vbox-conkeyref-phrases/product-name"/> install process creates the modules on the system where they 18 will be used. This means that you may need to install some software packages from the distribution which are 19 needed for the build process. Required packages may include the following: </p> 32 20 <ul> 33 21 <li> 34 <p> 35 GNU compiler (GCC) 36 </p> 22 <p>GNU compiler (GCC) </p> 37 23 </li> 38 24 <li> 39 <p> 40 GNU Make (make) 41 </p> 25 <p>GNU Make (make) </p> 42 26 </li> 43 27 <li> 44 <p> 45 Kernel header files 46 </p> 28 <p>Kernel header files </p> 47 29 </li> 48 30 </ul> 49 <p> 50 Also ensure that all system updates have been installed and that 51 your system is running the most up-to-date kernel for the 52 distribution. 53 </p> 31 <p>Also ensure that all system updates have been installed and that your system is running the most up-to-date 32 kernel for the distribution. </p> 54 33 <note> 55 <p> 56 The running kernel and the kernel header files must be updated 57 to matching versions. 58 </p> 34 <p>The running kernel and the kernel header files must be updated to matching versions. </p> 59 35 </note> 60 <p> 61 The following list includes some details of the required files 62 for some common distributions. Start by finding the version name 63 of your kernel, using the command <userinput>uname -r</userinput> in 64 a terminal. The list assumes that you have not changed too much 65 from the original installation, in particular that you have not 66 installed a different kernel type. 67 </p> 36 <p>The following list includes some details of the required files for some common distributions. Start by finding 37 the version name of your kernel, using the command <userinput>uname -r</userinput> in a terminal. The list assumes 38 that you have not changed too much from the original installation, in particular that you have not installed a 39 different kernel type. </p> 68 40 <ul> 69 41 <li> 70 <p> 71 With Debian and Ubuntu-based distributions, you must install 72 the correct version of the 73 <filepath>linux-headers</filepath>, usually whichever of 74 <filepath>linux-headers-generic</filepath>, 75 <filepath>linux-headers-amd64</filepath>, 76 <filepath>linux-headers-i686</filepath> or 77 <filepath>linux-headers-i686-pae</filepath> best matches the 78 kernel version name. Also, the 79 <filepath>linux-kbuild</filepath> package if it exists. 80 Basic Ubuntu releases should have the correct packages 81 installed by default. 82 </p> 42 <p>With Debian and Ubuntu-based distributions, you must install the correct version of the 43 <filepath>linux-headers</filepath>, usually whichever of <filepath>linux-headers-generic</filepath>, 44 <filepath>linux-headers-amd64</filepath>, <filepath>linux-headers-i686</filepath> or 45 <filepath>linux-headers-i686-pae</filepath> best matches the kernel version name. Also, the 46 <filepath>linux-kbuild</filepath> package if it exists. Basic Ubuntu releases should have the correct 47 packages installed by default. </p> 83 48 </li> 84 49 <li> 85 <p> 86 On Fedora, Red Hat, Oracle Linux and many other RPM-based 87 systems, the kernel version sometimes has a code of letters 88 or a word close to the end of the version name. For example 89 "uek" for the Oracle Unbreakable Enterprise Kernel or 90 "default" or "desktop" for the standard kernels. In this 91 case, the package name is 92 <filepath>kernel-uek-devel</filepath> or equivalent. If 93 there is no such code, it is usually 94 <filepath>kernel-devel</filepath>. 95 </p> 50 <p>On Fedora, Red Hat, Oracle Linux and many other RPM-based systems, the kernel version sometimes has a code of 51 letters or a word close to the end of the version name. For example "uek" for the Oracle Unbreakable 52 Enterprise Kernel or "default" or "desktop" for the standard kernels. In this case, the package name is 53 <filepath>kernel-uek-devel</filepath> or equivalent. If there is no such code, it is usually 54 <filepath>kernel-devel</filepath>. </p> 96 55 </li> 97 56 <li> 98 <p> 99 On some SUSE and openSUSE Linux versions, you may need to 100 install the <filepath>kernel-source</filepath> and 101 <filepath>kernel-syms</filepath> packages. 102 </p> 57 <p>On some SUSE and openSUSE Linux versions, you may need to install the <filepath>kernel-source</filepath> and 58 <filepath>kernel-syms</filepath> packages. </p> 103 59 </li> 104 60 </ul> 105 <p> 106 If you suspect that something has gone wrong with module 107 installation, check that your system is set up as described 108 above and try running the following command, as root: 109 </p> 61 <p>If you suspect that something has gone wrong with module installation, check that your system is set up as 62 described above and try running the following command, as root: </p> 110 63 <pre xml:space="preserve">rcvboxdrv setup</pre> 111 64 </body> -
trunk/doc/manual/en_US/dita/topics/features-overview.dita
r105134 r105289 15 15 <xref href="hostossupport.dita#hostossupport"/>. 16 16 </p> 17 <p> 18 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> is a so-called <i>hosted</i> 19 hypervisor, sometimes referred to as a <i>type 20 2</i> hypervisor. Whereas a 21 <i>bare-metal</i> or <i>type 1</i> 22 hypervisor runs directly on the hardware, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 23 requires an existing OS to be installed. It can thus run 24 alongside existing applications on that host. 25 </p> 26 <p> 27 To a very large degree, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> is functionally 28 identical on all of the host platforms, and the same file and 29 image formats are used. This enables you to run virtual 30 machines created on one host on another host with a different 31 host OS. For example, you can create a virtual machine on 32 Windows and then run it on Linux. 33 </p> 34 <p> 35 In addition, virtual machines can easily be imported and 36 exported using the Open Virtualization Format (OVF), an 37 industry standard created for this purpose. You can even 38 import OVFs that were created with a different virtualization 39 software. See <xref href="ovf.dita#ovf"/>. 40 </p> 41 <p> 42 For users of <ph conkeyref="vbox-conkeyref-phrases/oci"/> the functionality extends to exporting and 43 importing virtual machines to and from the cloud. This 44 simplifies development of applications and deployment to the 45 production environment. See 46 <xref href="cloud-export-oci.dita#cloud-export-oci"/>. 47 </p> 17 <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> is a so-called <i>hosted</i> hypervisor, sometimes 18 referred to as a <i>type 2</i> hypervisor. Whereas a <i>bare-metal</i> or <i>type 1</i> hypervisor runs 19 directly on the hardware, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> requires an existing OS to be 20 installed. It can thus run alongside existing applications on that host. </p> 21 <p>To a very large degree, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> is functionally identical on 22 all of the host platforms, and the same file and image formats are used. This enables you to run virtual 23 machines created on one host on another host with a different host OS. For example, you can create a virtual 24 machine on Windows and then run it on Linux. </p> 25 <p>In addition, virtual machines can easily be imported and exported using the Open Virtualization Format (OVF), 26 an industry standard created for this purpose. You can even import OVFs that were created with a different 27 virtualization software. See <xref href="ovf.dita#ovf"/>. </p> 28 <p>For users of <ph conkeyref="vbox-conkeyref-phrases/oci"/> the functionality extends to exporting and 29 importing virtual machines to and from the cloud. This simplifies development of applications and deployment 30 to the production environment. See <xref href="cloud-export-oci.dita#cloud-export-oci"/>. </p> 48 31 </li> 49 32 <li> … … 59 42 <xref href="guestadditions.dita#guestadditions"/>. 60 43 </p> 61 <p> 62 In particular, Guest Additions provide for <i>shared 63 folders</i>, which let you access files on the host 64 system from within a guest machine. See 65 <xref href="sharedfolders.dita#sharedfolders"/>. 66 </p> 44 <p>In particular, Guest Additions provide for <i>shared folders</i>, which let you access files on the host 45 system from within a guest machine. See <xref href="sharedfolders.dita#sharedfolders"/>. </p> 67 46 </li> 68 47 <li> … … 175 154 <xref href="frontends.dita#frontends"/>. 176 155 </p> 177 <p> 178 Due to its modular architecture, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can also 179 expose its full functionality and configurability through a 180 comprehensive <b outputclass="bold">software development kit 181 (SDK),</b> which enables integration of <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 182 with other software systems. See 183 <xref href="VirtualBoxAPI.dita"><ph conkeyref="vbox-conkeyref-phrases/product-name"/> Programming Interfaces</xref>. 184 </p> 156 <p>Due to its modular architecture, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can also expose its 157 full functionality and configurability through a comprehensive <b outputclass="bold">software development kit 158 (SDK),</b> which enables integration of <ph conkeyref="vbox-conkeyref-phrases/product-name"/> with other 159 software systems. See <xref href="VirtualBoxAPI.dita"><ph conkeyref="vbox-conkeyref-phrases/product-name"/> 160 Programming Interfaces</xref>. </p> 185 161 </li> 186 162 <li> … … 192 168 additions for full client USB support. 193 169 </p> 194 <p> 195 The VRDE does not rely on the RDP server that is built into 196 Microsoft Windows. Instead, the VRDE is plugged directly into 197 the virtualization layer. As a result, it works with guest 198 OSes other than Windows, even in text mode, and does not 199 require application support in the virtual machine either. The 200 VRDE is described in detail in <xref href="vrde.dita">Remote Display (VRDP Support)</xref>. 201 </p> 202 <p> 203 On top of this special capacity, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> offers you 204 more unique features: 205 </p> 170 <p>The VRDE does not rely on the RDP server that is built into Microsoft Windows. Instead, the VRDE is plugged 171 directly into the virtualization layer. As a result, it works with guest OSes other than Windows, even in text 172 mode, and does not require application support in the virtual machine either. The VRDE is described in detail 173 in <xref href="vrde.dita">Remote Display (VRDP Support)</xref>. </p> 174 <p>On top of this special capacity, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> offers you more unique 175 features: </p> 206 176 <ul> 207 177 <li> -
trunk/doc/manual/en_US/dita/topics/frontends.dita
r105176 r105289 4 4 <title>Alternative Front Ends</title> 5 5 <body> 6 <p> 7 As briefly mentioned in <xref href="features-overview.dita#features-overview"/>, 8 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> has a very flexible internal design that enables 9 you to use multiple interfaces to control the same virtual 10 machines. For example, you can start a virtual machine with the 11 <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> window and then stop it from the command line. With 12 <ph conkeyref="vbox-conkeyref-phrases/product-name"/>'s support for the Remote Desktop Protocol (RDP), 13 you can even run virtual machines remotely on a headless server 14 and have all the graphical output redirected over the network. 15 </p> 16 <p> The following front ends are shipped in the standard <ph 17 conkeyref="vbox-conkeyref-phrases/product-name"/> package:</p> 6 <p>As briefly mentioned in <xref href="features-overview.dita#features-overview"/>, <ph 7 conkeyref="vbox-conkeyref-phrases/product-name"/> has a very flexible internal design that enables you to use 8 multiple interfaces to control the same virtual machines. For example, you can start a virtual machine with the 9 <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> window and then stop it from the command line. With <ph 10 conkeyref="vbox-conkeyref-phrases/product-name"/>'s support for the Remote Desktop Protocol (RDP), you can even 11 run virtual machines remotely on a headless server and have all the graphical output redirected over the network. </p> 12 <p>The following front ends are shipped in the standard <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 13 package:</p> 18 14 <ul> 19 15 <li> … … 46 42 </li> 47 43 </ul> 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> 44 <p>If the above front ends still do not satisfy your particular needs, it is possible to create yet another front 45 end to the complex virtualization engine that is the core of <ph conkeyref="vbox-conkeyref-phrases/product-name" 46 />, as the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> core neatly exposes all of its features in a 47 clean API. See <xref href="VirtualBoxAPI.dita"><ph conkeyref="vbox-conkeyref-phrases/product-name"/> Programming 48 Interfaces</xref>. </p> 54 49 </body> 55 50 -
trunk/doc/manual/en_US/dita/topics/generalsettings.dita
r98549 r105289 5 5 6 6 <body> 7 <p> 8 In the <b outputclass="bold">Settings</b> window, under 9 <b outputclass="bold">General</b>, you can configure the 10 most fundamental aspects of the virtual machine such as memory and 11 essential hardware. The following tabs are available. 12 </p> 7 <p>In the <b outputclass="bold">Settings</b> window, under <b outputclass="bold">General</b>, you can configure the 8 most fundamental aspects of the virtual machine such as memory and essential hardware. The following tabs are 9 available. </p> 13 10 </body> 14 11 </topic> -
trunk/doc/manual/en_US/dita/topics/guestadd-install.dita
r98549 r105289 5 5 6 6 <body> 7 <p> 8 Guest Additions are available for virtual machines running 9 Windows, Linux, Oracle Solaris, or OS/2. The following sections 10 describe the specifics of each variant in detail. 11 </p> 7 <p>Guest Additions are available for virtual machines running Windows, Linux, Oracle Solaris, or OS/2. The following 8 sections describe the specifics of each variant in detail. </p> 12 9 </body> 13 10 </topic> -
trunk/doc/manual/en_US/dita/topics/guestadd-intro.dita
r105134 r105289 5 5 6 6 <body> 7 <p> 8 As mentioned in <xref href="virtintro.dita#virtintro"/>, the Guest Additions 9 are designed to be installed <i>inside</i> a virtual 10 machine after the guest operating system has been installed. They 11 consist of device drivers and system applications that optimize 12 the guest operating system for better performance and usability. 13 See <xref href="guestossupport.dita#guestossupport"/> for details on what guest 14 operating systems are fully supported with Guest Additions by 15 <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. 16 </p> 17 <p> 18 The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions for all supported guest 19 operating systems are provided as a single CD-ROM image file which 20 is called <filepath>VBoxGuestAdditions.iso</filepath>. This image 21 file is located in the installation directory of <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. 22 To install the Guest Additions for a particular VM, you mount this 23 ISO file in your VM as a virtual CD-ROM and install from there. 24 </p> 25 <p> 26 The Guest Additions offer the following features: 27 </p> 7 <p>As mentioned in <xref href="virtintro.dita#virtintro"/>, the Guest Additions are designed to be installed 8 <i>inside</i> a virtual machine after the guest operating system has been installed. They consist of device 9 drivers and system applications that optimize the guest operating system for better performance and usability. See 10 <xref href="guestossupport.dita#guestossupport"/> for details on what guest operating systems are fully 11 supported with Guest Additions by <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. </p> 12 <p>The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions for all supported guest operating 13 systems are provided as a single CD-ROM image file which is called <filepath>VBoxGuestAdditions.iso</filepath>. 14 This image file is located in the installation directory of <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. 15 To install the Guest Additions for a particular VM, you mount this ISO file in your VM as a virtual CD-ROM and 16 install from there. </p> 17 <p>The Guest Additions offer the following features: </p> 28 18 <ul> 29 19 <li> … … 57 47 the Guest Additions provide you with extra high and nonstandard video modes, as well as 58 48 accelerated video performance. </p> 59 <p> 60 In addition, with Windows, Linux, and Oracle Solaris guests, 61 you can resize the virtual machine's window if the Guest 62 Additions are installed. The video resolution in the guest 63 will be automatically adjusted, as if you had manually entered 64 an arbitrary resolution in the guest's 65 <b outputclass="bold">Display</b> settings. See 66 <xref href="intro-resize-window.dita#intro-resize-window"/>. 67 </p> 68 <p> 69 If the Guest Additions are installed, 3D graphics and 2D video 70 for guest applications can be accelerated. See 71 <xref href="guestadd-video.dita#guestadd-video"/>. 72 </p> 49 <p>In addition, with Windows, Linux, and Oracle Solaris guests, you can resize the virtual machine's window if 50 the Guest Additions are installed. The video resolution in the guest will be automatically adjusted, as if you 51 had manually entered an arbitrary resolution in the guest's <b outputclass="bold">Display</b> settings. See 52 <xref href="intro-resize-window.dita#intro-resize-window"/>. </p> 53 <p>If the Guest Additions are installed, 3D graphics and 2D video for guest applications can be accelerated. See 54 <xref href="guestadd-video.dita#guestadd-video"/>. </p> 73 55 </li> 74 56 <li> … … 89 71 guest. See <xref href="guestadd-guestprops.dita#guestadd-guestprops"/>. 90 72 </p> 91 <p> 92 Additionally, applications can be started in a guest from the 93 host. See <xref href="guestadd-guestcontrol.dita#guestadd-guestcontrol"/>. 94 </p> 73 <p>Additionally, applications can be started in a guest from the host. See <xref 74 href="guestadd-guestcontrol.dita#guestadd-guestcontrol"/>. </p> 95 75 </li> 96 76 <li> … … 100 80 the host. 101 81 </p> 102 <p> 103 For various reasons, the time in the guest might run at a 104 slightly different rate than the time on the host. The host 105 could be receiving updates through NTP and its own time might 106 not run linearly. A VM could also be paused, which stops the 107 flow of time in the guest for a shorter or longer period of 108 time. When the wall clock time between the guest and host only 109 differs slightly, the time synchronization service attempts to 110 gradually and smoothly adjust the guest time in small 111 increments to either catch up or lose time. When the 112 difference is too great, for example if a VM paused for hours 113 or restored from saved state, the guest time is changed 114 immediately, without a gradual adjustment. 115 </p> 116 <p> 117 The Guest Additions will resynchronize the time regularly. See 118 <xref href="changetimesync.dita">Tuning the Guest Additions Time Synchronization Parameters</xref> for how to configure the 119 parameters of the time synchronization mechanism. 120 </p> 82 <p>For various reasons, the time in the guest might run at a slightly different rate than the time on the host. 83 The host could be receiving updates through NTP and its own time might not run linearly. A VM could also be 84 paused, which stops the flow of time in the guest for a shorter or longer period of time. When the wall clock 85 time between the guest and host only differs slightly, the time synchronization service attempts to gradually 86 and smoothly adjust the guest time in small increments to either catch up or lose time. When the difference is 87 too great, for example if a VM paused for hours or restored from saved state, the guest time is changed 88 immediately, without a gradual adjustment. </p> 89 <p>The Guest Additions will resynchronize the time regularly. See <xref href="changetimesync.dita">Tuning the 90 Guest Additions Time Synchronization Parameters</xref> for how to configure the parameters of the time 91 synchronization mechanism. </p> 121 92 </li> 122 93 <li> … … 133 104 </li> 134 105 </ul> 135 <p> 136 Each version of <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, even minor releases, ship with 137 their own version of the Guest Additions. While the interfaces 138 through which the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> core communicates with the Guest 139 Additions are kept stable so that Guest Additions already 140 installed in a VM should continue to work when <ph conkeyref="vbox-conkeyref-phrases/product-name"/> is 141 upgraded on the host, for best results, it is recommended to keep 142 the Guest Additions at the same version. 143 </p> 144 <p> 145 The Windows and Linux Guest Additions therefore check 146 automatically whether they have to be updated. If the host is 147 running a newer <ph conkeyref="vbox-conkeyref-phrases/product-name"/> version than the Guest Additions, a 148 notification with further instructions is displayed in the guest. 149 </p> 150 <p> 151 To disable this update check for the Guest Additions of a given 152 virtual machine, set the value of its 153 <codeph>/VirtualBox/GuestAdd/CheckHostVersion</codeph> guest 154 property to <codeph>0</codeph>. See 155 <xref href="guestadd-guestprops.dita#guestadd-guestprops"/>. 156 </p> 106 <p>Each version of <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, even minor releases, ship with their own 107 version of the Guest Additions. While the interfaces through which the <ph 108 conkeyref="vbox-conkeyref-phrases/product-name"/> core communicates with the Guest Additions are kept stable so 109 that Guest Additions already installed in a VM should continue to work when <ph 110 conkeyref="vbox-conkeyref-phrases/product-name"/> is upgraded on the host, for best results, it is recommended 111 to keep the Guest Additions at the same version. </p> 112 <p>The Windows and Linux Guest Additions therefore check automatically whether they have to be updated. If the host 113 is running a newer <ph conkeyref="vbox-conkeyref-phrases/product-name"/> version than the Guest Additions, a 114 notification with further instructions is displayed in the guest. </p> 115 <p>To disable this update check for the Guest Additions of a given virtual machine, set the value of its 116 <codeph>/VirtualBox/GuestAdd/CheckHostVersion</codeph> guest property to <codeph>0</codeph>. See <xref 117 href="guestadd-guestprops.dita#guestadd-guestprops"/>. </p> 157 118 </body> 158 119 -
trunk/doc/manual/en_US/dita/topics/guestadditions.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 The previous chapter covered getting started with <ph conkeyref="vbox-conkeyref-phrases/product-name"/> and 9 installing operating systems in a virtual machine. For any serious 10 and interactive use, the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions will make 11 your life much easier by providing closer integration between host 12 and guest and improving the interactive performance of guest 13 systems. This chapter describes the Guest Additions in detail. 14 </p> 7 <p>The previous chapter covered getting started with <ph conkeyref="vbox-conkeyref-phrases/product-name"/> and 8 installing operating systems in a virtual machine. For any serious and interactive use, the <ph 9 conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions will make your life much easier by providing 10 closer integration between host and guest and improving the interactive performance of guest systems. This chapter 11 describes the Guest Additions in detail. </p> 15 12 </body> 16 13 </topic> -
trunk/doc/manual/en_US/dita/topics/guestossupport.dita
r105134 r105289 5 5 6 6 <body> 7 <p> 8 Because <ph conkeyref="vbox-conkeyref-phrases/product-name"/> is designed to provide a generic 9 virtualization environment for x86 systems, it can run guest 10 operating systems (OSes) of any kind. 11 </p> 7 <p>Because <ph conkeyref="vbox-conkeyref-phrases/product-name"/> is designed to provide a generic virtualization 8 environment for x86 systems, it can run guest operating systems (OSes) of any kind. </p> 12 9 <!-- 7.1: Require info on supported aarch64 guest OSes --> 13 <p> 14 The following guest OS platforms are supported: 15 </p> 10 <p>The following guest OS platforms are supported: </p> 16 11 <ul> 17 12 <li> -
trunk/doc/manual/en_US/dita/topics/gui-details-preview.dita
r98549 r105289 5 5 6 6 <body> 7 <p> 8 The virtual machine display is shown in a small window. 9 </p> 10 <p> 11 You can use the Preview window to check if your virtual 12 machine has finished booting up. 13 </p> 14 <p> 15 Click the arrow icon to hide or show the Preview window. 16 </p> 7 <p>The virtual machine display is shown in a small window. </p> 8 <p>You can use the Preview window to check if your virtual machine has finished booting up. </p> 9 <p>Click the arrow icon to hide or show the Preview window. </p> 17 10 </body> 18 11 -
trunk/doc/manual/en_US/dita/topics/gui-details-settings.dita
r105134 r105289 5 5 6 6 <body> 7 <p> 8 A summary of settings is shown for the virtual machine. 9 </p> 7 <p>A summary of settings is shown for the virtual machine. </p> 10 8 <note> 11 9 <p>Settings shown may vary, depending on the selected experience level for the <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> user interface.</p> 12 10 <p>See <xref href="ui-experience-level.dita#gui-experience-level"/>.</p> 13 11 </note> 14 <p> 15 You can change some virtual machine settings, by clicking on 16 the setting in the Details pane. 17 </p> 12 <p>You can change some virtual machine settings, by clicking on the setting in the Details pane. </p> 18 13 <note> 19 <p> 20 If a virtual machine is running, some settings cannot be 21 altered. You must stop the virtual machine first in order to 22 change the setting. 23 </p> 14 <p>If a virtual machine is running, some settings cannot be altered. You must stop the virtual machine first in 15 order to change the setting. </p> 24 16 </note> 25 <p> 26 Virtual machine settings can also be changed using the 27 <b outputclass="bold">Settings</b> button on the 28 <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> toolbar. 29 </p> 30 <p> 31 The virtual machine settings on the Details pane are organized 32 in sections that correspond to those used in the 33 <b outputclass="bold">Settings</b> window. See 34 <xref href="BasicConcepts.dita#BasicConcepts"/>. 35 </p> 36 <p> 37 Click the arrow icon to hide or show each section. 38 </p> 17 <p>Virtual machine settings can also be changed using the <b outputclass="bold">Settings</b> button on the <ph 18 conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> toolbar. </p> 19 <p>The virtual machine settings on the Details pane are organized in sections that correspond to those used in the 20 <b outputclass="bold">Settings</b> window. See <xref href="BasicConcepts.dita#BasicConcepts"/>. </p> 21 <p>Click the arrow icon to hide or show each section. </p> 39 22 </body> 40 23 -
trunk/doc/manual/en_US/dita/topics/gui-details-toolbar.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 A toolbar at the top of the Details pane contains buttons that 9 enable you to configure the selected virtual machine, or to 10 create a new virtual machine. 11 </p> 12 <p> 13 The toolbar includes the following buttons: 14 </p> 7 <p>A toolbar at the top of the Details pane contains buttons that enable you to configure the selected virtual 8 machine, or to create a new virtual machine. </p> 9 <p>The toolbar includes the following buttons: </p> 15 10 <ul> 16 11 <li> -
trunk/doc/manual/en_US/dita/topics/gui-details.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 The Details pane shows configuration information for a virtual 9 machine that is selected in the machine list. The pane also 10 includes a toolbar for performing tasks. 11 </p> 7 <p>The Details pane shows configuration information for a virtual machine that is selected in the machine list. The 8 pane also includes a toolbar for performing tasks. </p> 12 9 <fig id="fig-vbox-details-pane"> 13 10 <title><ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> Details Pane, Including Toolbar</title> … … 21 18 </image> 22 19 </fig> 23 <p> 24 The Details pane includes the following: 25 </p> 20 <p>The Details pane includes the following: </p> 26 21 </body> 27 22 </topic> -
trunk/doc/manual/en_US/dita/topics/gui-machine-list.dita
r105176 r105289 5 5 6 6 <body> 7 <p> 8 The list of virtual machines in the left pane is called the 9 <i>machine list</i>. 10 </p> 11 <p> 12 The following methods can be used to control and configure 13 virtual machines in the machine list: 14 </p> 7 <p>The list of virtual machines in the left pane is called the <i>machine list</i>. </p> 8 <p>The following methods can be used to control and configure virtual machines in the machine list: </p> 15 9 <ul> 16 10 <li> … … 22 16 </li> 23 17 <li> 24 <p> 25 Click a button in the toolbar in the Details pane. See 26 <xref href="gui-details.dita#gui-details"/>. 27 </p> 18 <p>Click a button in the toolbar in the Details pane. See <xref href="gui-details.dita#gui-details"/>. </p> 28 19 </li> 29 20 </ul> -
trunk/doc/manual/en_US/dita/topics/gui-notification-center.dita
r98549 r105289 5 5 6 6 <body> 7 <p> 8 Notification messages may be shown in a sliding panel on the 9 right of the Details pane, called the 10 <b outputclass="bold">Notification Center</b>. Click 11 the warning triangle to show the notification messages. 12 </p> 13 <p> 14 Most system messages that do not require user interaction are 15 displayed in the Notification Center, including task failure 16 alerts. 17 </p> 18 <p> 19 The progress of some tasks can be observed and stopped using 20 the Notification Center. 21 </p> 7 <p>Notification messages may be shown in a sliding panel on the right of the Details pane, called the <b 8 outputclass="bold">Notification Center</b>. Click the warning triangle to show the notification messages. </p> 9 <p>Most system messages that do not require user interaction are displayed in the Notification Center, including 10 task failure alerts. </p> 11 <p>The progress of some tasks can be observed and stopped using the Notification Center. </p> 22 12 </body> 23 13 -
trunk/doc/manual/en_US/dita/topics/gui-tools-global.dita
r105134 r105289 5 5 <!-- 7.1: May be best to remove screen shots of menus. Too much of a maintenance headache. --> 6 6 <body> 7 <p> 8 In the left pane of the <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> window, click the 9 <b outputclass="bold">Menu</b> icon in the 10 <b outputclass="bold">Tools</b> banner located above 11 the machine list. The <b outputclass="bold">Global 12 Tools</b> menu is displayed. 13 </p> 14 <p> 15 A drop-down list enables you to select from the following 16 global tools: 17 </p> 7 <p>In the left pane of the <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> window, click the <b outputclass="bold" 8 >Menu</b> icon in the <b outputclass="bold">Tools</b> banner located above the machine list. The <b 9 outputclass="bold">Global Tools</b> menu is displayed. </p> 10 <p>A drop-down list enables you to select from the following global tools: </p> 18 11 <ul> 19 12 <li> … … 66 59 </li> 67 60 </ul> 68 <p> 69 The <b outputclass="bold">Pin</b> icon is used to keep 70 the <b outputclass="bold">Tools</b> banner visible as 71 you scroll down the entries in the machine list. 72 </p> 61 <p>The <b outputclass="bold">Pin</b> icon is used to keep the <b outputclass="bold">Tools</b> banner visible as you 62 scroll down the entries in the machine list. </p> 73 63 <note> 74 64 <p>The available tools may vary, depending on the selected experience level for the <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> user interface.</p> -
trunk/doc/manual/en_US/dita/topics/gui-tools-machine.dita
r105134 r105289 5 5 6 6 <body> 7 <p> 8 In the machine list in the left pane of the <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> window, 9 select a virtual machine. 10 </p> 11 <p> 12 Click the <b outputclass="bold">Menu</b> icon to the 13 right of the virtual machine name. The 14 <b outputclass="bold">Machine Tools</b> menu is 15 displayed. 16 </p> 17 <p> 18 A drop-down list enables you to select from the following 19 machine tools: 20 </p> 7 <p>In the machine list in the left pane of the <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> window, select a 8 virtual machine. </p> 9 <p>Click the <b outputclass="bold">Menu</b> icon to the right of the virtual machine name. The <b outputclass="bold" 10 >Machine Tools</b> menu is displayed. </p> 11 <p>A drop-down list enables you to select from the following machine tools: </p> 21 12 <ul> 22 13 <li> -
trunk/doc/manual/en_US/dita/topics/gui-tools.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> provides two types of user tools, to enable you to 9 perform common tasks easily. 10 </p> 7 <p><ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> provides two types of user tools, to enable you to perform 8 common tasks easily. </p> 11 9 <ul> 12 10 <li> -
trunk/doc/manual/en_US/dita/topics/gui-virtualboxmanager.dita
r105134 r105289 5 5 6 6 <body> 7 <p> 8 <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> is the user interface for <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. You can use 9 <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> to create, configure, and manage your virtual machines. 10 </p> 11 <p> 12 This section describes the main features of the <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> user 13 interface. Subsequent sections and chapters describe how to use 14 <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> to perform tasks in <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. 15 </p> 16 <p> 17 When you start <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, the 18 <b outputclass="bold"><ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/></b> window is displayed. 19 </p> 7 <p><ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> is the user interface for <ph 8 conkeyref="vbox-conkeyref-phrases/product-name"/>. You can use <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> 9 to create, configure, and manage your virtual machines. </p> 10 <p>This section describes the main features of the <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> user interface. 11 Subsequent sections and chapters describe how to use <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> to perform 12 tasks in <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. </p> 13 <p>When you start <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, the <b outputclass="bold"><ph 14 conkeyref="vbox-conkeyref-phrases/vbox-mgr"/></b> window is displayed. </p> 20 15 <p><xref href="#gui-virtualboxmanager/fig-vbox-manager-initial"/> shows <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> the 21 16 first time you start <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, before you have created any … … 48 43 </image> 49 44 </fig> 50 <p> 51 The main components of the <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> window are as follows: 52 </p> 45 <p>The main components of the <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> window are as follows: </p> 53 46 <ul> 54 47 <li> -
trunk/doc/manual/en_US/dita/topics/gui-vmgroups.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 VM groups are groups of VMs that you can create as and when 9 required. You can manage and perform functions on them 10 collectively, as well as individually. 11 </p> 12 <p> 13 The following figure shows VM groups displayed in VirtualBox 14 Manager. 15 </p> 7 <p>VM groups are groups of VMs that you can create as and when required. You can manage and perform functions on 8 them collectively, as well as individually. </p> 9 <p>The following figure shows VM groups displayed in VirtualBox Manager. </p> 16 10 <fig id="fig-vm-groups"> 17 11 <title>Groups of Virtual Machines</title> … … 30 24 <ul> 31 25 <li> 32 <p> 33 Create a group using <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. Do one of the following: 34 </p> 26 <p>Create a group using <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. Do one of the following: </p> 35 27 <ul> 36 28 <li> 37 <p> 38 Drag a VM on top of another VM. 39 </p> 29 <p>Drag a VM on top of another VM. </p> 40 30 </li> 41 31 <li> 42 <p> 43 Select multiple VMs and select 44 <b outputclass="bold">Group</b> from the 45 right-click menu. 46 </p> 32 <p>Select multiple VMs and select <b outputclass="bold">Group</b> from the right-click menu. </p> 47 33 </li> 48 34 </ul> 49 35 </li> 50 36 <li> 51 <p> 52 Create and manage a group using the command line. Do one of 53 the following: 54 </p> 37 <p>Create and manage a group using the command line. Do one of the following: </p> 55 38 <ul> 56 39 <li> 57 <p> 58 Create a group and assign a VM. For example: 59 </p> 40 <p>Create a group and assign a VM. For example: </p> 60 41 <pre xml:space="preserve">VBoxManage modifyvm "vm01" --groups "/TestGroup"</pre> 61 <p> 62 This command creates a group <codeph>TestGroup</codeph> 63 and attaches the VM <codeph>vm01</codeph> to that group. 64 </p> 42 <p>This command creates a group <codeph>TestGroup</codeph> and attaches the VM <codeph>vm01</codeph> to that 43 group. </p> 65 44 </li> 66 45 <li> 67 <p> 68 Detach a VM from the group, and delete the group if empty. 69 For example: 70 </p> 46 <p>Detach a VM from the group, and delete the group if empty. For example: </p> 71 47 <pre xml:space="preserve">VBoxManage modifyvm "vm01" --groups ""</pre> 72 <p> 73 This command detaches all groups from the VM 74 <codeph>vm01</codeph> and deletes the empty group. 75 </p> 48 <p>This command detaches all groups from the VM <codeph>vm01</codeph> and deletes the empty group. </p> 76 49 </li> 77 50 </ul> 78 51 </li> 79 52 <li> 80 <p> 81 Create multiple groups. For example: 82 </p> 53 <p>Create multiple groups. For example: </p> 83 54 <pre xml:space="preserve">VBoxManage modifyvm "vm01" --groups "/TestGroup,/TestGroup2"</pre> 84 <p> 85 This command creates the groups <codeph>TestGroup</codeph> 86 and <codeph>TestGroup2</codeph>, if they do not exist, and 87 attaches the VM <codeph>vm01</codeph> to both of them. 88 </p> 55 <p>This command creates the groups <codeph>TestGroup</codeph> and <codeph>TestGroup2</codeph>, if they do not 56 exist, and attaches the VM <codeph>vm01</codeph> to both of them. </p> 89 57 </li> 90 58 <li> 91 <p> 92 Create nested groups, having a group hierarchy. For example: 93 </p> 59 <p>Create nested groups, having a group hierarchy. For example: </p> 94 60 <pre xml:space="preserve">VBoxManage modifyvm "vm01" --groups "/TestGroup/TestGroup2"</pre> 95 <p> 96 This command attaches the VM <codeph>vm01</codeph> to the 97 subgroup <codeph>TestGroup2</codeph> of the 98 <codeph>TestGroup</codeph> group. 99 </p> 61 <p>This command attaches the VM <codeph>vm01</codeph> to the subgroup <codeph>TestGroup2</codeph> of the 62 <codeph>TestGroup</codeph> group. </p> 100 63 </li> 101 64 <li> 102 <p> 103 Use <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> menu options to control and manage all the VMs 104 in a group. For example: 105 <b outputclass="bold">Start</b>, 106 <b outputclass="bold">Pause</b>, 107 <b outputclass="bold">Reset</b>, 108 <b outputclass="bold">Close</b> (save state, send 109 shutdown signal, poweroff), <b outputclass="bold">Discard 110 Saved State</b>, <b outputclass="bold">Show in 111 Explorer</b>, <b outputclass="bold">Sort</b>. 112 </p> 65 <p>Use <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> menu options to control and manage all the VMs in a 66 group. For example: <b outputclass="bold">Start</b>, <b outputclass="bold">Pause</b>, <b outputclass="bold" 67 >Reset</b>, <b outputclass="bold">Close</b> (save state, send shutdown signal, poweroff), <b 68 outputclass="bold">Discard Saved State</b>, <b outputclass="bold">Show in Explorer</b>, <b 69 outputclass="bold">Sort</b>. </p> 113 70 </li> 114 71 </ul> -
trunk/doc/manual/en_US/dita/topics/help-viewer.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 The Help Viewer is a window that displays context-sensitive help 9 to assist you in completing common <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> tasks. You can 10 display the Help Viewer in the following ways: 11 </p> 7 <p>The Help Viewer is a window that displays context-sensitive help to assist you in completing common <ph 8 conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> tasks. You can display the Help Viewer in the following ways: </p> 12 9 <ul> 13 10 <li> 14 <p> 15 In a <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> wizard or dialog, click 16 <b outputclass="bold">Help</b> to display the 17 relevant help topic. 18 </p> 11 <p>In a <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> wizard or dialog, click <b outputclass="bold">Help</b> 12 to display the relevant help topic. </p> 19 13 </li> 20 14 <li> 21 <p> 22 In <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> or from a guest VM, do either of the 23 following: 24 </p> 15 <p>In <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> or from a guest VM, do either of the following: </p> 25 16 <ul> 26 17 <li> … … 34 25 Press the <b outputclass="bold">F1</b> button. 35 26 </p> 36 <p> 37 The keyboard shortcut used to access the Help Viewer can 38 be configured in the 39 <b outputclass="bold">Preferences</b> window. 40 </p> 27 <p>The keyboard shortcut used to access the Help Viewer can be configured in the <b outputclass="bold" 28 >Preferences</b> window. </p> 41 29 </li> 42 30 </ul> 43 31 </li> 44 32 </ul> 45 <p> 46 The Help Viewer has the following features: 47 </p> 33 <p>The Help Viewer has the following features: </p> 48 34 <ul> 49 35 <li> -
trunk/doc/manual/en_US/dita/topics/hostossupport.dita
r105134 r105289 53 53 very modest. </p> 54 54 <note> 55 <p> 56 Developer Preview is a public release for developers, which 57 provides early access to unsupported software release and 58 features. 59 </p> 55 <p>Developer Preview is a public release for developers, which provides early access to unsupported software 56 release and features. </p> 60 57 </note> 61 58 </li> … … 93 90 formally tested and supported Linux distributions are those for which we offer a dedicated 94 91 package. </p> 95 <p> 96 Note that Linux 2.4-based host OSes are no longer supported. 97 </p> 92 <p>Note that Linux 2.4-based host OSes are no longer supported. </p> 98 93 </li> 99 94 <li> … … 111 106 </li> 112 107 </ul> 113 <p> 114 Note that any feature which is marked as 115 <i>experimental</i> is not supported. Feedback and 116 suggestions about such features are welcome. 117 </p> 108 <p>Note that any feature which is marked as <i>experimental</i> is not supported. Feedback and suggestions about 109 such features are welcome. </p> 118 110 </body> 119 111 </topic> -
trunk/doc/manual/en_US/dita/topics/import-instance-sequence.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 The following describes the sequence of events when you import 9 an instance from <ph conkeyref="vbox-conkeyref-phrases/oci"/>. 10 </p> 7 <p>The following describes the sequence of events when you import an instance from <ph 8 conkeyref="vbox-conkeyref-phrases/oci"/>. </p> 11 9 <ul> 12 10 <li> 13 <p> 14 A custom image is created from the boot volume of the 15 instance. 16 </p> 11 <p>A custom image is created from the boot volume of the instance. </p> 17 12 </li> 18 13 <li> 19 <p> 20 The custom image is exported to an <ph conkeyref="vbox-conkeyref-phrases/oci"/> object and is 21 stored using Object Storage in the bucket specified by the 22 user. 23 </p> 14 <p>The custom image is exported to an <ph conkeyref="vbox-conkeyref-phrases/oci"/> object and is stored using 15 Object Storage in the bucket specified by the user. </p> 24 16 </li> 25 17 <li> 26 <p> 27 The <ph conkeyref="vbox-conkeyref-phrases/oci"/> object is downloaded to the local host. The 28 object is a TAR archive which contains a boot volume of 29 the instance in QCOW2 format and a JSON file containing 30 metadata related to the instance. 31 </p> 18 <p>The <ph conkeyref="vbox-conkeyref-phrases/oci"/> object is downloaded to the local host. The object is a TAR 19 archive which contains a boot volume of the instance in QCOW2 format and a JSON file containing metadata 20 related to the instance. </p> 32 21 </li> 33 22 <li> 34 <p> 35 The boot volume of the instance is extracted from the 36 archive and a new VMDK image is created by converting the 37 boot volume into the VMDK format. The VMDK image is 38 registered with <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. 39 </p> 23 <p>The boot volume of the instance is extracted from the archive and a new VMDK image is created by converting 24 the boot volume into the VMDK format. The VMDK image is registered with <ph 25 conkeyref="vbox-conkeyref-phrases/product-name"/>. </p> 40 26 </li> 41 27 <li> 42 <p> 43 A new VM is created using the VMDK image for the cloud 44 instance. 45 </p> 46 <p> 47 By default, the new VM is not started after import from 48 <ph conkeyref="vbox-conkeyref-phrases/oci"/>. 49 </p> 28 <p>A new VM is created using the VMDK image for the cloud instance. </p> 29 <p>By default, the new VM is not started after import from <ph conkeyref="vbox-conkeyref-phrases/oci"/>. </p> 50 30 </li> 51 31 <li> 52 <p> 53 The downloaded TAR archive is deleted after a successful 54 import. 55 </p> 32 <p>The downloaded TAR archive is deleted after a successful import. </p> 56 33 </li> 57 34 </ul> -
trunk/doc/manual/en_US/dita/topics/install-ext-pack.dita
r105210 r105289 5 5 6 6 <body> 7 <p> 8 Extension packs provide extra functionality to the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 9 base package, such as extended USB device support and cloud 10 integration features. See <xref href="intro-installing.dita#intro-installing"/>. 11 </p> 12 <p> 13 To install an <ph conkeyref="vbox-conkeyref-phrases/vbox-ext"/>, do the following: 14 </p> 7 <p>Extension packs provide extra functionality to the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> base 8 package, such as extended USB device support and cloud integration features. See <xref 9 href="intro-installing.dita#intro-installing"/>. </p> 10 <p>To install an <ph conkeyref="vbox-conkeyref-phrases/vbox-ext"/>, do the following: </p> 15 11 <ol> 16 12 <li> 17 13 <p> Double-click the extension package file name. </p> 18 <p> 19 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> extension packs have a 20 <filepath>.vbox-extpack</filepath> file name extension. 21 </p> 14 <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> extension packs have a 15 <filepath>.vbox-extpack</filepath> file name extension. </p> 22 16 </li> 23 17 <li> 24 <p> 25 Follow the on-screen instructions to install the extension 26 pack. 27 </p> 18 <p>Follow the on-screen instructions to install the extension pack. </p> 28 19 </li> 29 20 </ol> 30 <p> 31 You can also use the Extension Pack Manager tool to install an 32 extension pack. See <xref href="install-ext-pack-manager.dita#install-ext-pack-manager"/>. 33 </p> 21 <p>You can also use the Extension Pack Manager tool to install an extension pack. See <xref 22 href="install-ext-pack-manager.dita#install-ext-pack-manager"/>. </p> 34 23 </body> 35 24 </topic> -
trunk/doc/manual/en_US/dita/topics/install-linux-alt-installer.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 The alternative generic installer performs the following 9 steps: 10 </p> 7 <p>The alternative generic installer performs the following steps: </p> 11 8 <ul> 12 9 <li> 13 <p> 14 Unpacks the application files to the target directory 15 <filepath>/opt/VirtualBox/</filepath>, which cannot be 16 changed. 17 </p> 10 <p>Unpacks the application files to the target directory <filepath>/opt/VirtualBox/</filepath>, which cannot be 11 changed. </p> 18 12 </li> 19 13 <li> 20 <p> 21 Builds and installs the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> kernel modules: 22 <userinput>vboxdrv</userinput>, <userinput>vboxnetflt</userinput>, 23 and <userinput>vboxnetadp</userinput>. 24 </p> 14 <p>Builds and installs the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> kernel modules: 15 <userinput>vboxdrv</userinput>, <userinput>vboxnetflt</userinput>, and <userinput>vboxnetadp</userinput>. </p> 25 16 </li> 26 17 <li> 27 <p> 28 Creates <filepath>/sbin/rcvboxdrv</filepath>, an init 29 script to start the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> kernel module. 30 </p> 18 <p>Creates <filepath>/sbin/rcvboxdrv</filepath>, an init script to start the <ph 19 conkeyref="vbox-conkeyref-phrases/product-name"/> kernel module. </p> 31 20 </li> 32 21 <li> 33 <p> 34 Creates a new system group called 35 <codeph>vboxusers</codeph>. 36 </p> 22 <p>Creates a new system group called <codeph>vboxusers</codeph>. </p> 37 23 </li> 38 24 <li> 39 <p> 40 Creates symbolic links in <filepath>/usr/bin</filepath> to 41 a shell script <filepath>/opt/VirtualBox/VBox</filepath> 42 which does some sanity checks and dispatches to the actual 43 executables: <userinput>VirtualBox</userinput>, 44 <userinput>VBoxVRDP</userinput>, 45 <userinput>VBoxHeadless</userinput> and 46 <userinput>VBoxManage</userinput>. 47 </p> 25 <p>Creates symbolic links in <filepath>/usr/bin</filepath> to a shell script 26 <filepath>/opt/VirtualBox/VBox</filepath> which does some sanity checks and dispatches to the actual 27 executables: <userinput>VirtualBox</userinput>, <userinput>VBoxVRDP</userinput>, 28 <userinput>VBoxHeadless</userinput> and <userinput>VBoxManage</userinput>. </p> 48 29 </li> 49 30 <li> 50 <p> 51 Creates 52 <filepath>/etc/udev/rules.d/60-vboxdrv.rules</filepath>, a 53 description file for udev, if that is present, which makes 54 the USB devices accessible to all users in the 55 <codeph>vboxusers</codeph> group. 56 </p> 31 <p>Creates <filepath>/etc/udev/rules.d/60-vboxdrv.rules</filepath>, a description file for udev, if that is 32 present, which makes the USB devices accessible to all users in the <codeph>vboxusers</codeph> group. </p> 57 33 </li> 58 34 <li> 59 <p> 60 Writes the installation directory to 61 <filepath>/etc/vbox/vbox.cfg</filepath>. 62 </p> 35 <p>Writes the installation directory to <filepath>/etc/vbox/vbox.cfg</filepath>. </p> 63 36 </li> 64 37 </ul> 65 <p> 66 The installer must be executed as root with either 67 <codeph>install</codeph> or <codeph>uninstall</codeph> as 68 the first parameter. For example: 69 </p> 38 <p>The installer must be executed as root with either <codeph>install</codeph> or <codeph>uninstall</codeph> as the 39 first parameter. For example: </p> 70 40 <pre xml:space="preserve">sudo ./VirtualBox.run install</pre> 71 <p> 72 Or if you do not have the <userinput>sudo</userinput> command 73 available, run the following as root instead: 74 </p> 41 <p>Or if you do not have the <userinput>sudo</userinput> command available, run the following as root instead: </p> 75 42 <pre xml:space="preserve">./VirtualBox.run install</pre> 76 <p> 77 Add every user who needs to access USB devices from a 78 VirtualBox guests to the group <codeph>vboxusers</codeph>. 79 Either use the OS user management tools or run the following 80 command as root: 81 </p> 43 <p>Add every user who needs to access USB devices from a VirtualBox guests to the group <codeph>vboxusers</codeph>. 44 Either use the OS user management tools or run the following command as root: </p> 82 45 <pre xml:space="preserve">sudo usermod -a -G vboxusers username</pre> 83 46 <note> 84 <p> 85 The <userinput>usermod</userinput> command of some older Linux 86 distributions does not support the <codeph>-a</codeph> 87 option, which adds the user to the given group without 88 affecting membership of other groups. In this case, find out 89 the current group memberships with the 90 <userinput>groups</userinput> command and add all these groups 91 in a comma-separated list to the command line after the 92 <codeph>-G</codeph> option. For example: <userinput>usermod -G 93 <varname>group1</varname>,<varname>group2</varname>,vboxusers <varname>username</varname></userinput>. 94 </p> 47 <p>The <userinput>usermod</userinput> command of some older Linux distributions does not support the 48 <codeph>-a</codeph> option, which adds the user to the given group without affecting membership of other 49 groups. In this case, find out the current group memberships with the <userinput>groups</userinput> command and 50 add all these groups in a comma-separated list to the command line after the <codeph>-G</codeph> option. For 51 example: <userinput>usermod -G <varname>group1</varname>,<varname>group2</varname>,vboxusers 52 <varname>username</varname></userinput>. </p> 95 53 </note> 96 54 </body> -
trunk/doc/manual/en_US/dita/topics/install-linux-debian-automatic.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 The Debian packages will request some user feedback when 9 installed for the first time. The debconf system is used to 10 perform this task. To prevent any user interaction during 11 installation, default values can be defined. A file 12 <codeph>vboxconf</codeph> can contain the following debconf 13 settings: 14 </p> 7 <p>The Debian packages will request some user feedback when installed for the first time. The debconf system is used 8 to perform this task. To prevent any user interaction during installation, default values can be defined. A file 9 <codeph>vboxconf</codeph> can contain the following debconf settings: </p> 15 10 <pre xml:space="preserve">virtualbox virtualbox/module-compilation-allowed boolean true 16 11 virtualbox virtualbox/delete-old-modules boolean true</pre> 17 <p> 18 The first line enables compilation of the vboxdrv kernel 19 module if no module was found for the current kernel. The 20 second line enables the package to delete any old vboxdrv 21 kernel modules compiled by previous installations. 22 </p> 23 <p> 24 These default settings can be applied prior to the 25 installation of the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Debian package, as follows: 26 </p> 12 <p>The first line enables compilation of the vboxdrv kernel module if no module was found for the current kernel. 13 The second line enables the package to delete any old vboxdrv kernel modules compiled by previous installations. </p> 14 <p>These default settings can be applied prior to the installation of the <ph 15 conkeyref="vbox-conkeyref-phrases/product-name"/> Debian package, as follows: </p> 27 16 <pre xml:space="preserve">debconf-set-selections vboxconf</pre> 28 <p> 29 In addition there are some common configuration options that 30 can be set prior to the installation. See 31 <xref href="linux_install_opts.dita#linux_install_opts"/>. 32 </p> 17 <p>In addition there are some common configuration options that can be set prior to the installation. See <xref 18 href="linux_install_opts.dita#linux_install_opts"/>. </p> 33 19 </body> 34 20 -
trunk/doc/manual/en_US/dita/topics/install-linux-debian-ubuntu.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 Download the appropriate package for your distribution. The 9 following example assumes that you are installing to a 64-bit 10 Ubuntu Xenial system. Use <userinput>dpkg</userinput> to install 11 the Debian package,as follows: 12 </p> 7 <p>Download the appropriate package for your distribution. The following example assumes that you are installing to 8 a 64-bit Ubuntu Xenial system. Use <userinput>dpkg</userinput> to install the Debian package,as follows: </p> 13 9 <pre xml:space="preserve">sudo dpkg -i virtualbox-<varname>version-number</varname>_Ubuntu_xenial_amd64.deb</pre> 14 <p> 15 The installer will also try to build kernel modules suitable 16 for the current running kernel. If the build process is not 17 successful you will be shown a warning and the package will be 18 left unconfigured. Look at 19 <filepath>/var/log/vbox-install.log</filepath> to find out why 20 the compilation failed. You may have to install the 21 appropriate Linux kernel headers, see 22 <xref href="externalkernelmodules.dita#externalkernelmodules"/>. After correcting any 23 problems, run the following command: 24 </p> 10 <p>The installer will also try to build kernel modules suitable for the current running kernel. If the build process 11 is not successful you will be shown a warning and the package will be left unconfigured. Look at 12 <filepath>/var/log/vbox-install.log</filepath> to find out why the compilation failed. You may have to install 13 the appropriate Linux kernel headers, see <xref href="externalkernelmodules.dita#externalkernelmodules"/>. After 14 correcting any problems, run the following command: </p> 25 15 <pre xml:space="preserve">sudo rcvboxdrv setup</pre> 26 <p> 27 This will start a second attempt to build the module. 28 </p> 29 <p> 30 If a suitable kernel module was found in the package or the 31 module was successfully built, the installation script will 32 attempt to load that module. If this fails, please see 33 <xref href="ts_linux-kernelmodule-fails-to-load.dita">Linux Kernel Module Refuses to Load</xref> for 34 further information. 35 </p> 36 <p> 37 Once <ph conkeyref="vbox-conkeyref-phrases/product-name"/> has been successfully installed and 38 configured, you can start it by clicking 39 <b outputclass="bold">VirtualBox</b> in your 40 <b outputclass="bold">Start</b> menu or from the 41 command line. See <xref href="startingvboxonlinux.dita"/>. 42 </p> 16 <p>This will start a second attempt to build the module. </p> 17 <p>If a suitable kernel module was found in the package or the module was successfully built, the installation 18 script will attempt to load that module. If this fails, please see <xref 19 href="ts_linux-kernelmodule-fails-to-load.dita">Linux Kernel Module Refuses to Load</xref> for further 20 information. </p> 21 <p>Once <ph conkeyref="vbox-conkeyref-phrases/product-name"/> has been successfully installed and configured, you 22 can start it by clicking <b outputclass="bold">VirtualBox</b> in your <b outputclass="bold">Start</b> menu or from 23 the command line. See <xref href="startingvboxonlinux.dita"/>. </p> 43 24 </body> 44 25 -
trunk/doc/manual/en_US/dita/topics/install-linux-manual.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 If you cannot use the shell script installer described in 9 <xref href="install-linux-alt-installer.dita#install-linux-alt-installer"/>, you can perform 10 a manual installation. Run the installer as follows: 11 </p> 7 <p>If you cannot use the shell script installer described in <xref 8 href="install-linux-alt-installer.dita#install-linux-alt-installer"/>, you can perform a manual 9 installation. Run the installer as follows: </p> 12 10 <pre xml:space="preserve">./VirtualBox.run --keep --noexec</pre> 13 <p> 14 This will unpack all the files needed for installation in the 15 directory <codeph>install</codeph> under the current 16 directory. The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> application files are contained 17 in <filepath>VirtualBox.tar.bz2</filepath> which you can 18 unpack to any directory on your system. For example: 19 </p> 11 <p>This will unpack all the files needed for installation in the directory <codeph>install</codeph> under the 12 current directory. The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> application files are contained 13 in <filepath>VirtualBox.tar.bz2</filepath> which you can unpack to any directory on your system. For 14 example: </p> 20 15 <pre xml:space="preserve">sudo mkdir /opt/VirtualBox 21 16 sudo tar jxf ./install/VirtualBox.tar.bz2 -C /opt/VirtualBox</pre> 22 <p> 23 To run the same example as root, use the following commands: 24 </p> 17 <p>To run the same example as root, use the following commands: </p> 25 18 <pre xml:space="preserve">mkdir /opt/VirtualBox 26 19 tar jxf ./install/VirtualBox.tar.bz2 -C /opt/VirtualBox</pre> 27 <p> 28 The sources for <ph conkeyref="vbox-conkeyref-phrases/product-name"/>'s kernel module are provided in 29 the <filepath>src</filepath> directory. To build the module, 30 change to the directory and use the following command: 31 </p> 20 <p>The sources for <ph conkeyref="vbox-conkeyref-phrases/product-name"/>'s kernel module are provided in the 21 <filepath>src</filepath> directory. To build the module, change to the directory and use the following 22 command: </p> 32 23 <pre xml:space="preserve">make</pre> 33 <p> 34 If everything builds correctly, run the following command to 35 install the module to the appropriate module directory: 36 </p> 24 <p>If everything builds correctly, run the following command to install the module to the appropriate module 25 directory: </p> 37 26 <pre xml:space="preserve">sudo make install</pre> 38 <p> 39 In case you do not have sudo, switch the user account to root 40 and run the following command: 41 </p> 27 <p>In case you do not have sudo, switch the user account to root and run the following command: </p> 42 28 <pre xml:space="preserve">make install</pre> 43 <p> 44 The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> kernel module needs a device node to 45 operate. The above <userinput>make</userinput> command will tell 46 you how to create the device node, depending on your Linux 47 system. The procedure is slightly different for a classical 48 Linux setup with a <filepath>/dev</filepath> directory, a 49 system with the now deprecated <userinput>devfs</userinput> and a 50 modern Linux system with <userinput>udev</userinput>. 51 </p> 52 <p> 53 On certain Linux distributions, you might experience 54 difficulties building the module. You will have to analyze the 55 error messages from the build system to diagnose the cause of 56 the problems. In general, make sure that the correct Linux 57 kernel sources are used for the build process. 58 </p> 59 <p> 60 Note that the <filepath>/dev/vboxdrv</filepath> kernel module 61 device node must be owned by root:root and must be 62 read/writable only for the user. 63 </p> 64 <p> 65 Next, you install the system initialization script for the 66 kernel module and activate the initialization script using the 67 right method for your distribution, as follows: 68 </p> 29 <p>The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> kernel module needs a device node to operate. The above 30 <userinput>make</userinput> command will tell you how to create the device node, depending on your Linux 31 system. The procedure is slightly different for a classical Linux setup with a <filepath>/dev</filepath> 32 directory, a system with the now deprecated <userinput>devfs</userinput> and a modern Linux system with 33 <userinput>udev</userinput>. </p> 34 <p>On certain Linux distributions, you might experience difficulties building the module. You will have to analyze 35 the error messages from the build system to diagnose the cause of the problems. In general, make sure that 36 the correct Linux kernel sources are used for the build process. </p> 37 <p>Note that the <filepath>/dev/vboxdrv</filepath> kernel module device node must be owned by root:root and must be 38 read/writable only for the user. </p> 39 <p>Next, you install the system initialization script for the kernel module and activate the initialization script 40 using the right method for your distribution, as follows: </p> 69 41 <pre xml:space="preserve">cp /opt/VirtualBox/vboxdrv.sh /sbin/rcvboxdrv</pre> 70 <p> 71 This example assumes you installed <ph conkeyref="vbox-conkeyref-phrases/product-name"/> to the 72 <filepath>/opt/VirtualBox</filepath> directory. 73 </p> 74 <p> 75 Create a configuration file for <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, as follows: 76 </p> 42 <p>This example assumes you installed <ph conkeyref="vbox-conkeyref-phrases/product-name"/> to the 43 <filepath>/opt/VirtualBox</filepath> directory. </p> 44 <p>Create a configuration file for <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, as follows: </p> 77 45 <pre xml:space="preserve">mkdir /etc/vbox 78 46 echo INSTALL_DIR=/opt/VirtualBox > /etc/vbox/vbox.cfg</pre> 79 <p> 80 Create the following symbolic links: 81 </p> 47 <p>Create the following symbolic links: </p> 82 48 <pre xml:space="preserve">ln -sf /opt/VirtualBox/VBox.sh /usr/bin/VirtualBox 83 49 ln -sf /opt/VirtualBox/VBox.sh /usr/bin/VBoxManage -
trunk/doc/manual/en_US/dita/topics/install-linux-performing.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> is available in a number of package formats 9 native to various common Linux distributions. See 10 <xref href="hostossupport.dita#hostossupport"/>. In addition, there is an 11 alternative generic installer (.run) which you can use on 12 supported Linux distributions. 13 </p> 7 <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> is available in a number of package formats native to 8 various common Linux distributions. See <xref href="hostossupport.dita#hostossupport"/>. In addition, there is an 9 alternative generic installer (.run) which you can use on supported Linux distributions. </p> 14 10 </body> 15 11 </topic> -
trunk/doc/manual/en_US/dita/topics/install-linux-prereq.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 For the various versions of Linux that are supported as host 9 operating systems, see <xref href="hostossupport.dita#hostossupport"/>. 10 </p> 11 <p> 12 You may need to install the following packages on your Linux 13 system before starting the installation. Some systems will do 14 this for you automatically when you install <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. 15 </p> 7 <p>For the various versions of Linux that are supported as host operating systems, see <xref 8 href="hostossupport.dita#hostossupport"/>. </p> 9 <p>You may need to install the following packages on your Linux system before starting the installation. Some 10 systems will do this for you automatically when you install <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. </p> 16 11 <ul> 17 12 <li> 18 <p> 19 Qt 5.3.2 or later. Qt 5.6.2 or later is recommended. 20 </p> 13 <p>Qt 5.3.2 or later. Qt 5.6.2 or later is recommended. </p> 21 14 </li> 22 15 <li> 23 <p> 24 SDL 1.2.7 or later. This graphics library is typically 25 called <filepath>libsdl</filepath> or similar. 26 </p> 16 <p>SDL 1.2.7 or later. This graphics library is typically called <filepath>libsdl</filepath> or similar. </p> 27 17 </li> 28 18 </ul> 29 19 <note> 30 <p> 31 These packages are only required if you want to run the 32 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> graphical user interfaces. In particular, 33 <userinput>VirtualBox</userinput>, the graphical VirtualBox 34 Manager, requires both Qt and SDL. If you only want to run 35 <userinput>VBoxHeadless</userinput>, neither Qt nor SDL are 36 required. 37 </p> 20 <p>These packages are only required if you want to run the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 21 graphical user interfaces. In particular, <userinput>VirtualBox</userinput>, the graphical VirtualBox Manager, 22 requires both Qt and SDL. If you only want to run <userinput>VBoxHeadless</userinput>, neither Qt nor SDL are 23 required. </p> 38 24 </note> 39 25 </body> -
trunk/doc/manual/en_US/dita/topics/install-linux-rpm-automatic.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 The RPM format does not provide a configuration system 9 comparable to the debconf system. See 10 <xref href="linux_install_opts.dita#linux_install_opts"/> for how to set some 11 common installation options provided by <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. 12 </p> 7 <p>The RPM format does not provide a configuration system comparable to the debconf system. See <xref 8 href="linux_install_opts.dita#linux_install_opts"/> for how to set some common installation options provided by 9 <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. </p> 13 10 </body> 14 11 -
trunk/doc/manual/en_US/dita/topics/install-linux-update-uninstall.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 Before updating or uninstalling <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, you must 9 terminate any virtual machines which are currently running and 10 exit the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> or VBoxSVC applications. To update 11 <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, simply run the installer of the updated 12 version. To uninstall <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, run the installer as 13 follows: 14 </p> 7 <p>Before updating or uninstalling <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, you must terminate any 8 virtual machines which are currently running and exit the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> or 9 VBoxSVC applications. To update <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, simply run the installer of 10 the updated version. To uninstall <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, run the installer as 11 follows: </p> 15 12 <pre xml:space="preserve">sudo ./VirtualBox.run uninstall</pre> 16 <p> 17 As root, you can use the following command: 18 </p> 13 <p>As root, you can use the following command: </p> 19 14 <pre xml:space="preserve">./VirtualBox.run uninstall</pre> 20 <p> 21 You can uninstall the .run package as follows: 22 </p> 15 <p>You can uninstall the .run package as follows: </p> 23 16 <pre xml:space="preserve">/opt/VirtualBox/uninstall.sh</pre> 24 <p> 25 To manually uninstall <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, perform the manual 26 installation steps in reverse order. 27 </p> 17 <p>To manually uninstall <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, perform the manual installation 18 steps in reverse order. </p> 28 19 </body> 29 20 -
trunk/doc/manual/en_US/dita/topics/install-linux-vboxusers.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 The Linux installers create the system user group 9 <codeph>vboxusers</codeph> during installation. Any system 10 user who is going to use USB devices from <ph conkeyref="vbox-conkeyref-phrases/product-name"/> guests 11 must be a member of that group. A user can be made a member of 12 the group <codeph>vboxusers</codeph> either by using the 13 desktop user and group tools, or with the following command: 14 </p> 7 <p>The Linux installers create the system user group <codeph>vboxusers</codeph> during installation. Any system user 8 who is going to use USB devices from <ph conkeyref="vbox-conkeyref-phrases/product-name"/> guests must be a member 9 of that group. A user can be made a member of the group <codeph>vboxusers</codeph> either by using the desktop 10 user and group tools, or with the following command: </p> 15 11 <pre xml:space="preserve">sudo usermod -a -G vboxusers username</pre> 16 12 </body> -
trunk/doc/manual/en_US/dita/topics/install-mac-performing.dita
r105176 r105289 5 5 6 6 <body> 7 <p> 8 For macOS hosts, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> ships in a 9 <filepath>dmg</filepath> disk image file. Perform the following 10 steps to install on a macOS host: 11 </p> 7 <p>For macOS hosts, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> ships in a <filepath>dmg</filepath> disk 8 image file. Perform the following steps to install on a macOS host: </p> 12 9 <ol> 13 10 <li> … … 15 12 </li> 16 13 <li> 17 <p> A window opens, prompting you to double-click the <filepath>VirtualBox.pkg</filepath>18 installer filedisplayed in that window. </p>14 <p>A window opens, prompting you to double-click the <filepath>VirtualBox.pkg</filepath> installer file 15 displayed in that window. </p> 19 16 </li> 20 17 <li> 21 <p> 22 This starts the installer, which enables you to select where 23 to install <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. 24 </p> 18 <p>This starts the installer, which enables you to select where to install <ph 19 conkeyref="vbox-conkeyref-phrases/product-name"/>. </p> 25 20 </li> 26 21 <li> 27 <p> 28 An <ph conkeyref="vbox-conkeyref-phrases/product-name"/> icon is added to the 29 <filepath>Applications</filepath> folder in the Finder. 30 </p> 22 <p>An <ph conkeyref="vbox-conkeyref-phrases/product-name"/> icon is added to the 23 <filepath>Applications</filepath> folder in the Finder. </p> 31 24 </li> 32 25 </ol> -
trunk/doc/manual/en_US/dita/topics/install-mac-unattended.dita
r105134 r105289 5 5 6 6 <body> 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> 10 <p> 11 Mount the <filepath>dmg</filepath> disk image file, as described 12 in the installation procedure, or use the following command 13 line: 14 </p> 7 <p>To perform a noninteractive installation of <ph conkeyref="vbox-conkeyref-phrases/product-name"/> you can use the 8 command line version of the installer application. </p> 9 <p>Mount the <filepath>dmg</filepath> disk image file, as described in the installation procedure, or use the 10 following command line: </p> 15 11 <pre xml:space="preserve">hdiutil attach /path/to/VirtualBox-xyz.dmg</pre> 16 <p> 17 Open a terminal session and run the following command: 18 </p> 12 <p>Open a terminal session and run the following command: </p> 19 13 <pre xml:space="preserve">sudo installer -pkg /Volumes/VirtualBox/VirtualBox.pkg -target /Volumes/Macintosh\ HD</pre> 20 14 </body> -
trunk/doc/manual/en_US/dita/topics/install-mac-uninstall.dita
r105210 r105289 5 5 6 6 <body> 7 <p> To uninstall <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, open the disk image8 <filepath>dmg</filepath>file and double-click the uninstall icon shown. </p>7 <p>To uninstall <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, open the disk image <filepath>dmg</filepath> 8 file and double-click the uninstall icon shown. </p> 9 9 </body> 10 10 -
trunk/doc/manual/en_US/dita/topics/install-solaris-host.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 For the specific versions of Oracle Solaris that are supported as 9 host operating systems, see <xref href="hostossupport.dita#hostossupport"/>. 10 </p> 11 <p> 12 If you have a previously installed instance of <ph conkeyref="vbox-conkeyref-phrases/product-name"/> on 13 your Oracle Solaris host, please uninstall it first before 14 installing a new instance. See 15 <xref href="uninstall-solaris-host.dita#uninstall-solaris-host"/> for uninstall 16 instructions. 17 </p> 7 <p>For the specific versions of Oracle Solaris that are supported as host operating systems, see <xref 8 href="hostossupport.dita#hostossupport"/>. </p> 9 <p>If you have a previously installed instance of <ph conkeyref="vbox-conkeyref-phrases/product-name"/> on your 10 Oracle Solaris host, please uninstall it first before installing a new instance. See <xref 11 href="uninstall-solaris-host.dita#uninstall-solaris-host"/> for uninstall instructions. </p> 18 12 </body> 19 13 </topic> -
trunk/doc/manual/en_US/dita/topics/install-solaris-performing.dita
r105134 r105289 5 5 6 6 <body> 7 <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 7 <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> is available as a standard Oracle Solaris package. Download 8 the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> SunOS package, which includes the 64-bit version of <ph 9 conkeyref="vbox-conkeyref-phrases/product-name"/>. <i>The installation must be performed as root and from the 10 global zone</i>. This is because the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> installer loads 11 kernel drivers, which cannot be done from non-global zones. To verify which zone you are currently in, execute the 15 12 <userinput>zonename</userinput> command. </p> 16 <p> 17 To start installation, run the following commands: 18 </p> 13 <p>To start installation, run the following commands: </p> 19 14 <pre xml:space="preserve">gunzip -cd VirtualBox-<varname>version-number</varname>-SunOS.tar.gz | tar xvf -</pre> 20 <p> 21 The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> kernel package is integrated into the main 22 package. Install the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> package as follows: 23 </p> 15 <p>The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> kernel package is integrated into the main package. 16 Install the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> package as follows: </p> 24 17 <pre xml:space="preserve">pkgadd -d VirtualBox-<varname>version-number</varname>-SunOS.pkg</pre> 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> 32 <p> 33 Once the postinstall script has been executed your installation 34 is now complete. You may now safely delete the uncompressed 35 package and <filepath>autoresponse</filepath> files from your 36 system. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> is installed in 37 <filepath>/opt/VirtualBox</filepath>. 38 </p> 18 <p>The installer will then prompt you to enter the package you want to install. Choose <b outputclass="bold">1</b> 19 or <b outputclass="bold">all</b> and proceed. Next the installer will ask you if you want to allow the postinstall 20 script to be executed. Choose <b outputclass="bold">y</b> and proceed, as it is essential to execute this script 21 which installs the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> kernel module. Following this 22 confirmation the installer will install <ph conkeyref="vbox-conkeyref-phrases/product-name"/> and execute the 23 postinstall setup script. </p> 24 <p>Once the postinstall script has been executed your installation is now complete. You may now safely delete the 25 uncompressed package and <filepath>autoresponse</filepath> files from your system. <ph 26 conkeyref="vbox-conkeyref-phrases/product-name"/> is installed in <filepath>/opt/VirtualBox</filepath>. </p> 39 27 <note> 40 <p> 41 If you need to use <ph conkeyref="vbox-conkeyref-phrases/product-name"/> from non-global zones, see 42 <xref href="solaris-zones.dita#solaris-zones"/>. 43 </p> 28 <p>If you need to use <ph conkeyref="vbox-conkeyref-phrases/product-name"/> from non-global zones, see <xref 29 href="solaris-zones.dita#solaris-zones"/>. </p> 44 30 </note> 45 31 </body> -
trunk/doc/manual/en_US/dita/topics/install-solaris-starting.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 The easiest way to start an <ph conkeyref="vbox-conkeyref-phrases/product-name"/> program is by running 9 the program of your choice (<userinput>VirtualBox</userinput>, 10 <userinput>VBoxManage</userinput>, or 11 <userinput>VBoxHeadless</userinput>) from a terminal. These are 12 symbolic links to <userinput>VBox.sh</userinput> that start the 13 required program for you. 14 </p> 15 <p> 16 Alternatively, you can directly invoke the required programs 17 from <filepath>/opt/VirtualBox</filepath>. Using the links 18 provided is easier as you do not have to enter the full path. 19 </p> 20 <p> 21 You can configure some elements of the 22 <userinput>VirtualBox</userinput> Qt GUI, such as fonts and colours, 23 by running <userinput>VBoxQtconfig</userinput> from the terminal. 24 </p> 7 <p>The easiest way to start an <ph conkeyref="vbox-conkeyref-phrases/product-name"/> program is by running the 8 program of your choice (<userinput>VirtualBox</userinput>, <userinput>VBoxManage</userinput>, or 9 <userinput>VBoxHeadless</userinput>) from a terminal. These are symbolic links to <userinput>VBox.sh</userinput> 10 that start the required program for you. </p> 11 <p>Alternatively, you can directly invoke the required programs from <filepath>/opt/VirtualBox</filepath>. Using the 12 links provided is easier as you do not have to enter the full path. </p> 13 <p>You can configure some elements of the <userinput>VirtualBox</userinput> Qt GUI, such as fonts and colours, by 14 running <userinput>VBoxQtconfig</userinput> from the terminal. </p> 25 15 </body> 26 16 -
trunk/doc/manual/en_US/dita/topics/install-solaris-unattended.dita
r105134 r105289 5 5 6 6 <body> 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 7 <p>To perform a noninteractive installation of <ph conkeyref="vbox-conkeyref-phrases/product-name"/> there is a 8 response file named <filepath>autoresponse</filepath>. The installer uses this for responses to inputs, rather 10 9 than prompting the user. </p> 11 <p> 12 Extract the tar.gz package as described in 13 <xref href="install-solaris-performing.dita#install-solaris-performing"/>. Then open a root 14 terminal session and run the following command: 15 </p> 10 <p>Extract the tar.gz package as described in <xref 11 href="install-solaris-performing.dita#install-solaris-performing"/>. Then open a root terminal session and run 12 the following command: </p> 16 13 <pre xml:space="preserve">pkgadd -d VirtualBox-<varname>version-number</varname>-SunOS-x86 -n -a autoresponse SUNWvbox</pre> 17 <p> To perform a noninteractive uninstallation, open a root terminal session and run the 18 following command: </p> 14 <p>To perform a noninteractive uninstallation, open a root terminal session and run the following command: </p> 19 15 <pre xml:space="preserve">pkgrm -n -a /opt/VirtualBox/autoresponse SUNWvbox</pre> 20 16 </body> -
trunk/doc/manual/en_US/dita/topics/install-solaris-vboxuser.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 The installer creates the system user group 9 <codeph>vboxuser</codeph> during installation for Oracle 10 Solaris hosts that support the USB features required by 11 <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. Any system user who is going to use USB devices 12 from <ph conkeyref="vbox-conkeyref-phrases/product-name"/> guests must be a member of this group. A 13 user can be made a member of this group either by using the 14 desktop user and group tools or by running the following command 15 as root: 16 </p> 7 <p>The installer creates the system user group <codeph>vboxuser</codeph> during installation for Oracle Solaris 8 hosts that support the USB features required by <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. Any system 9 user who is going to use USB devices from <ph conkeyref="vbox-conkeyref-phrases/product-name"/> guests must be a 10 member of this group. A user can be made a member of this group either by using the desktop user and group tools 11 or by running the following command as root: </p> 17 12 <pre xml:space="preserve">usermod -G vboxuser username</pre> 18 <p> 19 Note that adding an active user to the 20 <codeph>vboxuser</codeph> group will require the user to log 21 out and then log in again. This should be done manually after 22 successful installation of the package. 23 </p> 13 <p>Note that adding an active user to the <codeph>vboxuser</codeph> group will require the user to log out and then 14 log in again. This should be done manually after successful installation of the package. </p> 24 15 </body> 25 16 -
trunk/doc/manual/en_US/dita/topics/install-win-installdir-req.dita
r104427 r105289 5 5 6 6 <body> 7 <p> The installation directory on Windows hosts must meet certain security requirements, in 8 order to be accepted by the Windows installer. </p> 9 <p> 10 This also applies for upgrades of <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. 11 </p> 12 <p> For example, when installing <ph conkeyref="vbox-conkeyref-phrases/product-name"/> into a 13 custom location at X:\Data\MyPrograms\<ph conkeyref="vbox-conkeyref-phrases/product-name"/>, 14 all parent directories of this path (namely X:\Data and X:\Data\MyPrograms) must meet the 15 following Discretionary Access Control List (DACL). <pre xml:space="preserve"> 7 <p>The installation directory on Windows hosts must meet certain security requirements, in order to be accepted by 8 the Windows installer. </p> 9 <p>This also applies for upgrades of <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. </p> 10 <p>For example, when installing <ph conkeyref="vbox-conkeyref-phrases/product-name"/> into a custom location at 11 X:\Data\MyPrograms\<ph conkeyref="vbox-conkeyref-phrases/product-name"/>, all parent directories of this path 12 (namely X:\Data and X:\Data\MyPrograms) must meet the following Discretionary Access Control List (DACL). 13 <pre xml:space="preserve"> 16 14 Users S-1-5-32-545:(OI)(CI)(RX) 17 15 Users S-1-5-32-545:(DE,WD,AD,WEA,WA) … … 19 17 Authenticated Users S-1-5-11:(DE,WD,AD,WEA,WA) 20 18 </pre> Directory inheritance must also be disabled for all parent directories. </p> 21 <p> You can use the <codeph>icacls</codeph> Windows command line tool to modify a directory to22 meet the securityrequirements. For example: <pre xml:space="preserve">19 <p>You can use the <codeph>icacls</codeph> Windows command line tool to modify a directory to meet the security 20 requirements. For example: <pre xml:space="preserve"> 23 21 icacls <Directory> /reset /t /c 24 22 icacls <Directory> /inheritance:d /t /c … … 27 25 icacls <Directory> /grant *S-1-5-11:(OI)(CI)(RX) 28 26 icacls <Directory> /deny *S-1-5-11:(DE,WD,AD,WEA,WA) 29 </pre> Note that these commands must be repeated for all parent directories (X:\Data and30 X:\Data\MyProgramsin this example).</p>27 </pre>Note that these commands must be repeated for all parent directories (X:\Data and X:\Data\MyPrograms 28 in this example).</p> 31 29 </body> 32 30 -
trunk/doc/manual/en_US/dita/topics/install-win-performing.dita
r105134 r105289 5 5 6 6 <body> 7 <p> 8 The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> installation can be started in either of the 9 following ways: 10 </p> 7 <p>The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> installation can be started in either of the following 8 ways: </p> 11 9 <ul> 12 10 <li> 13 <p> 14 By double-clicking on the executable file. 15 </p> 11 <p>By double-clicking on the executable file. </p> 16 12 </li> 17 13 <li> 18 <p> 19 By entering the following command: 20 </p> 14 <p>By entering the following command: </p> 21 15 <pre xml:space="preserve">VirtualBox-<version>-<revision>-Win.exe -extract</pre> 22 <p> 23 This will extract the installer into a temporary directory, 24 along with the .MSI file. Run the following command to 25 perform the installation: 26 </p> 16 <p>This will extract the installer into a temporary directory, along with the .MSI file. Run the following 17 command to perform the installation: </p> 27 18 <pre xml:space="preserve">msiexec /i VirtualBox-<version>-<revision>-Win.msi</pre> 28 19 </li> 29 20 </ul> 30 <p> 31 Using either way displays the installation 32 <b outputclass="bold">Welcome</b> dialog and enables you 33 to choose where to install <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, and which components 34 to install. In addition to the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> application, the 35 following components are available: 36 </p> 21 <p>Using either way displays the installation <b outputclass="bold">Welcome</b> dialog and enables you to choose 22 where to install <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, and which components to install. In 23 addition to the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> application, the following components are 24 available: </p> 37 25 <ul> 38 26 <li> … … 58 46 installation on the system is required. 59 47 </p> 60 <p> 61 See, for example: 62 <ph>http://www.python.org/download/windows/</ph>. 63 </p> 48 <p>See, for example: <ph>http://www.python.org/download/windows/</ph>. </p> 64 49 <note> 65 50 <p> Python version 3 is required. Python version 2.x is no longer supported. </p> … … 67 52 </li> 68 53 </ul> 69 <p> 70 Depending on your Windows configuration, you may see warnings 71 about unsigned drivers, or similar. Click 72 <b outputclass="bold">Continue</b> for these warnings, as 73 otherwise <ph conkeyref="vbox-conkeyref-phrases/product-name"/> might not function correctly after 74 installation. 75 </p> 76 <p> 77 The installer will create an <ph conkeyref="vbox-conkeyref-phrases/product-name"/> group in the Windows 78 <b outputclass="bold">Start</b> menu, which enables you 79 to launch the application and access its documentation. 80 </p> 81 <p> 82 With standard settings, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> will be installed for all 83 users on the local system. If this is not wanted, you must 84 invoke the installer by first extracting as follows: 85 </p> 54 <p>Depending on your Windows configuration, you may see warnings about unsigned drivers, or similar. Click <b 55 outputclass="bold">Continue</b> for these warnings, as otherwise <ph 56 conkeyref="vbox-conkeyref-phrases/product-name"/> might not function correctly after installation. </p> 57 <p>The installer will create an <ph conkeyref="vbox-conkeyref-phrases/product-name"/> group in the Windows <b 58 outputclass="bold">Start</b> menu, which enables you to launch the application and access its documentation. </p> 59 <p>With standard settings, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> will be installed for all users on 60 the local system. If this is not wanted, you must invoke the installer by first extracting as follows: </p> 86 61 <pre xml:space="preserve">VirtualBox.exe -extract</pre> 87 <p> 88 Then, run either of the following commands on the extracted .MSI 89 file. This will install <ph conkeyref="vbox-conkeyref-phrases/product-name"/> only for the current 90 user. 91 </p> 62 <p>Then, run either of the following commands on the extracted .MSI file. This will install <ph 63 conkeyref="vbox-conkeyref-phrases/product-name"/> only for the current user. </p> 92 64 <pre xml:space="preserve">VirtualBox.exe -msiparams ALLUSERS=2</pre> 93 65 <pre xml:space="preserve">msiexec /i VirtualBox-<version>-Win.msi ALLUSERS=2</pre> 94 <p> 95 If you do not want to install all features of <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, 96 you can set the optional <codeph>ADDLOCAL</codeph> parameter 97 to explicitly name the features to be installed. The following 98 features are available: 99 </p> 66 <p>If you do not want to install all features of <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, you can set 67 the optional <codeph>ADDLOCAL</codeph> parameter to explicitly name the features to be installed. The following 68 features are available: </p> 100 69 <dl> 101 70 <dlentry> … … 117 86 </dlentry> 118 87 <dlentry> 119 <dt> 120 VBoxUSB 121 </dt> 88 <dt>VBoxUSB </dt> 122 89 <dd> 123 <p> 124 USB support. 125 </p> 90 <p>USB support. </p> 126 91 </dd> 127 92 </dlentry> 128 93 <dlentry> 129 <dt> 130 VBoxNetwork 131 </dt> 94 <dt>VBoxNetwork </dt> 132 95 <dd> 133 <p> 134 All networking support. This includes the VBoxNetworkFlt 135 and VBoxNetworkAdp features. 136 </p> 96 <p>All networking support. This includes the VBoxNetworkFlt and VBoxNetworkAdp features. </p> 137 97 </dd> 138 98 </dlentry> 139 99 <dlentry> 140 <dt> 141 VBoxNetworkFlt 142 </dt> 100 <dt>VBoxNetworkFlt </dt> 143 101 <dd> 144 <p> 145 Bridged networking support. 146 </p> 102 <p>Bridged networking support. </p> 147 103 </dd> 148 104 </dlentry> 149 105 <dlentry> 150 <dt> 151 VBoxNetworkAdp 152 </dt> 106 <dt>VBoxNetworkAdp </dt> 153 107 <dd> 154 <p> 155 Host-only networking support 156 </p> 108 <p>Host-only networking support </p> 157 109 </dd> 158 110 </dlentry> 159 111 <dlentry> 160 <dt> 161 VBoxPython 162 </dt> 112 <dt>VBoxPython </dt> 163 113 <dd> 164 <p> 165 Python support 166 </p> 114 <p>Python support </p> 167 115 </dd> 168 116 </dlentry> 169 117 </dl> 170 <p> 171 For example, to only install USB support along with the main 172 binaries, run either of the following commands: 173 </p> 118 <p>For example, to only install USB support along with the main binaries, run either of the following commands: </p> 174 119 <pre xml:space="preserve">VirtualBox.exe -msiparams ADDLOCAL=VBoxApplication,VBoxUSB</pre> 175 120 <pre xml:space="preserve">msiexec /i VirtualBox-<version>-Win.msi ADDLOCAL=VBoxApplication,VBoxUSB</pre> 176 <p> 177 The user is able to choose between NDIS5 and NDIS6 host network 178 filter drivers during the installation. This is done using a 179 command line parameter, <codeph>NETWORKTYPE</codeph>. The 180 NDIS6 driver is the default for most supported Windows hosts. 181 For some legacy Windows versions, the installer will 182 automatically select the NDIS5 driver and this cannot be 183 changed. 184 </p> 185 <p> 186 You can force an install of the legacy NDIS5 host network filter 187 driver by specifying <codeph>NETWORKTYPE=NDIS5</codeph>. For 188 example, to install the NDIS5 driver on Windows 7 use either of 189 the following commands: 190 </p> 121 <p>The user is able to choose between NDIS5 and NDIS6 host network filter drivers during the installation. This is 122 done using a command line parameter, <codeph>NETWORKTYPE</codeph>. The NDIS6 driver is the default for most 123 supported Windows hosts. For some legacy Windows versions, the installer will automatically select the NDIS5 124 driver and this cannot be changed. </p> 125 <p>You can force an install of the legacy NDIS5 host network filter driver by specifying 126 <codeph>NETWORKTYPE=NDIS5</codeph>. For example, to install the NDIS5 driver on Windows 7 use either of the 127 following commands: </p> 191 128 <pre xml:space="preserve">VirtualBox.exe -msiparams NETWORKTYPE=NDIS5</pre> 192 129 <pre xml:space="preserve">msiexec /i VirtualBox-<version>-Win;.msi NETWORKTYPE=NDIS5</pre> -
trunk/doc/manual/en_US/dita/topics/install-win-prereq.dita
r98549 r105289 5 5 6 6 <body> 7 <p> 8 For the various versions of Windows that are supported as host 9 operating systems, please refer to 10 <xref href="hostossupport.dita#hostossupport"/>. 11 </p> 12 <p> 13 In addition, Windows Installer must be present on your system. 14 This should be the case for all supported Windows platforms. 15 </p> 7 <p>For the various versions of Windows that are supported as host operating systems, please refer to <xref 8 href="hostossupport.dita#hostossupport"/>. </p> 9 <p>In addition, Windows Installer must be present on your system. This should be the case for all supported Windows 10 platforms. </p> 16 11 </body> 17 12 -
trunk/doc/manual/en_US/dita/topics/install-win-public-props.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 Public properties can be specified with the MSI API, to control 9 additional behavior and features of the Windows host installer. 10 Use either of the following commands: 11 </p> 7 <p>Public properties can be specified with the MSI API, to control additional behavior and features of the Windows 8 host installer. Use either of the following commands: </p> 12 9 <pre xml:space="preserve">VirtualBox.exe -msiparams NAME=VALUE [...]</pre> 13 10 <pre xml:space="preserve">msiexec /i VirtualBox-<version>-Win.msi NAME=VALUE [...]</pre> 14 <p> 15 The following public properties are available. 16 </p> 11 <p>The following public properties are available. </p> 17 12 <ul> 18 13 <li> 19 <p> 20 VBOX_INSTALLDESKTOPSHORTCUT 21 </p> 22 <p> 23 Specifies whether or not an <ph conkeyref="vbox-conkeyref-phrases/product-name"/> icon on the 24 desktop should be created. 25 </p> 26 <p> 27 Set to <codeph>1</codeph> to enable, <codeph>0</codeph> 28 to disable. Default is 1. 29 </p> 14 <p>VBOX_INSTALLDESKTOPSHORTCUT </p> 15 <p>Specifies whether or not an <ph conkeyref="vbox-conkeyref-phrases/product-name"/> icon on the desktop should 16 be created. </p> 17 <p>Set to <codeph>1</codeph> to enable, <codeph>0</codeph> to disable. Default is 1. </p> 30 18 </li> 31 19 <li> 32 <p> 33 VBOX_INSTALLQUICKLAUNCHSHORTCUT 34 </p> 35 <p> 36 Specifies whether or not an <ph conkeyref="vbox-conkeyref-phrases/product-name"/> icon in the Quick 37 Launch Bar should be created. 38 </p> 39 <p> 40 Set to <codeph>1</codeph> to enable, <codeph>0</codeph> 41 to disable. Default is 1. 42 </p> 20 <p>VBOX_INSTALLQUICKLAUNCHSHORTCUT </p> 21 <p>Specifies whether or not an <ph conkeyref="vbox-conkeyref-phrases/product-name"/> icon in the Quick Launch 22 Bar should be created. </p> 23 <p>Set to <codeph>1</codeph> to enable, <codeph>0</codeph> to disable. Default is 1. </p> 43 24 </li> 44 25 <li> 45 <p> 46 VBOX_REGISTERFILEEXTENSIONS 47 </p> 48 <p> 49 Specifies whether or not the file extensions .vbox, 50 .vbox-extpack, .ovf, .ova, .vdi, .vmdk, .vhd and .vdd should 51 be associated with <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. Files of these types then 52 will be opened with <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. 53 </p> 54 <p> 55 Set to <codeph>1</codeph> to enable, <codeph>0</codeph> 56 to disable. Default is 1. 57 </p> 26 <p>VBOX_REGISTERFILEEXTENSIONS </p> 27 <p>Specifies whether or not the file extensions .vbox, .vbox-extpack, .ovf, .ova, .vdi, .vmdk, .vhd and .vdd 28 should be associated with <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. Files of these types then 29 will be opened with <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. </p> 30 <p>Set to <codeph>1</codeph> to enable, <codeph>0</codeph> to disable. Default is 1. </p> 58 31 </li> 59 32 <li> 60 <p> 61 VBOX_START 62 </p> 63 <p> 64 Specifies whether to start <ph conkeyref="vbox-conkeyref-phrases/product-name"/> right after 65 successful installation. 66 </p> 67 <p> 68 Set to <codeph>1</codeph> to enable, <codeph>0</codeph> 69 to disable. Default is 1. 70 </p> 33 <p>VBOX_START </p> 34 <p>Specifies whether to start <ph conkeyref="vbox-conkeyref-phrases/product-name"/> right after successful 35 installation. </p> 36 <p>Set to <codeph>1</codeph> to enable, <codeph>0</codeph> to disable. Default is 1. </p> 71 37 </li> 72 38 </ul> -
trunk/doc/manual/en_US/dita/topics/install-win-unattended.dita
r98549 r105289 5 5 6 6 <body> 7 <p> 8 Unattended installations can be performed using the standard MSI 9 support. 10 </p> 7 <p>Unattended installations can be performed using the standard MSI support. </p> 11 8 </body> 12 9 -
trunk/doc/manual/en_US/dita/topics/install-win-uninstall.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 As <ph conkeyref="vbox-conkeyref-phrases/product-name"/> uses the standard Microsoft Windows installer, 9 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can be safely uninstalled at any time. Click the 10 program entry in the <b outputclass="bold">Add/Remove 11 Programs</b> list in the Windows Control Panel. 12 </p> 7 <p>As <ph conkeyref="vbox-conkeyref-phrases/product-name"/> uses the standard Microsoft Windows installer, <ph 8 conkeyref="vbox-conkeyref-phrases/product-name"/> can be safely uninstalled at any time. Click the program entry 9 in the <b outputclass="bold">Add/Remove Programs</b> list in the Windows Control Panel. </p> 13 10 </body> 14 11 -
trunk/doc/manual/en_US/dita/topics/installation.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 As installation of <ph conkeyref="vbox-conkeyref-phrases/product-name"/> varies depending on your host 9 operating system, the following sections provide installation 10 instructions for Windows, macOS, Linux, and Oracle Solaris. 11 </p> 7 <p>As installation of <ph conkeyref="vbox-conkeyref-phrases/product-name"/> varies depending on your host operating 8 system, the following sections provide installation instructions for Windows, macOS, Linux, and Oracle Solaris. </p> 12 9 </body> 13 10 </topic> -
trunk/doc/manual/en_US/dita/topics/intro-64bitguests.dita
r105176 r105289 6 6 <body> 7 7 <note> 8 <p> 9 Be sure to enable <b outputclass="bold">I/O APIC</b> 10 for virtual machines that you intend to use in 64-bit mode. 11 This is especially true for 64-bit Windows VMs. See 12 <xref href="settings-motherboard.dita#settings-motherboard"/>. For 64-bit Windows 13 guests, ensure that the VM uses the 14 <b outputclass="bold">Intel networking device</b> 15 because there is no 64-bit driver support for the AMD PCNet 16 card. See <xref href="nichardware.dita#nichardware"/>. 17 </p> 8 <p>Be sure to enable <b outputclass="bold">I/O APIC</b> for virtual machines that you intend to use in 64-bit 9 mode. This is especially true for 64-bit Windows VMs. See <xref 10 href="settings-motherboard.dita#settings-motherboard"/>. For 64-bit Windows guests, ensure that the VM uses 11 the <b outputclass="bold">Intel networking device</b> because there is no 64-bit driver support for the AMD 12 PCNet card. See <xref href="nichardware.dita#nichardware"/>. </p> 18 13 </note> 19 <p> 20 If you use the <b outputclass="bold">Create VM</b> wizard 21 of <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> automatically uses the correct 22 settings for each selected 64-bit OS type. See 23 <xref href="create-vm-wizard.dita#create-vm-wizard"/>. 24 </p> 14 <p>If you use the <b outputclass="bold">Create VM</b> wizard of <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>, 15 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> automatically uses the correct settings for each selected 16 64-bit OS type. See <xref href="create-vm-wizard.dita#create-vm-wizard"/>. </p> 25 17 </body> 26 18 -
trunk/doc/manual/en_US/dita/topics/intro-installing.dita
r104714 r105289 5 5 6 6 <body> 7 <p> 8 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> comes in many different packages, and installation 9 depends on your host OS. If you have installed software before, 10 installation should be straightforward. On each host platform, 11 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> uses the installation method that is most common 12 and easy to use. If you run into trouble or have special 13 requirements, see <xref href="installation.dita#installation"/> for details 14 about the various installation methods. 15 </p> 7 <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> comes in many different packages, and installation depends 8 on your host OS. If you have installed software before, installation should be straightforward. On each host 9 platform, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> uses the installation method that is most common 10 and easy to use. If you run into trouble or have special requirements, see <xref 11 href="installation.dita#installation"/> for details about the various installation methods. </p> 16 12 <p> 17 13 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> is split into the following components: … … 63 59 </li> 64 60 </ul> 65 <p> 66 For details of how to install an extension pack, see 61 <p>For details of how to install an extension pack, see 67 62 <xref href="install-ext-pack.dita"/>. 68 63 </p> -
trunk/doc/manual/en_US/dita/topics/intro-macosxguests.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> enables you to install and execute unmodified 9 versions of Mac OS X guests on supported host hardware. Note 10 that this feature is experimental and thus unsupported. 11 </p> 12 <p> 13 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> is the first product to provide the modern PC 14 architecture expected by OS X without requiring any of the 15 modifications used by competing virtualization solutions. For 16 example, some competing solutions perform modifications to the 17 Mac OS X install DVDs, such as a different boot loader and 18 replaced files. 19 </p> 20 <p> 21 Be aware of the following important issues before you attempt to 22 install a Mac OS X guest: 23 </p> 7 <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> enables you to install and execute unmodified versions of 8 Mac OS X guests on supported host hardware. Note that this feature is experimental and thus unsupported. </p> 9 <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> is the first product to provide the modern PC architecture 10 expected by OS X without requiring any of the modifications used by competing virtualization solutions. For 11 example, some competing solutions perform modifications to the Mac OS X install DVDs, such as a different boot 12 loader and replaced files. </p> 13 <p>Be aware of the following important issues before you attempt to install a Mac OS X guest: </p> 24 14 <ul> 25 15 <li> 26 <p> 27 Mac OS X is commercial, licensed software and contains 28 <b outputclass="bold">both license and technical 29 restrictions</b> that limit its use to certain 30 hardware and usage scenarios. You must understand and comply 31 with these restrictions. 32 </p> 33 <p> 34 In particular, Apple prohibits the installation of most 35 versions of Mac OS X on non-Apple hardware. 36 </p> 37 <p> 38 These license restrictions are also enforced on a technical 39 level. Mac OS X verifies that it is running on Apple 40 hardware. Most DVDs that accompany Apple hardware check for 41 the exact model. These restrictions are 42 <i>not</i> circumvented by <ph conkeyref="vbox-conkeyref-phrases/product-name"/> and 43 continue to apply. 44 </p> 16 <p>Mac OS X is commercial, licensed software and contains <b outputclass="bold">both license and technical 17 restrictions</b> that limit its use to certain hardware and usage scenarios. You must understand and comply 18 with these restrictions. </p> 19 <p>In particular, Apple prohibits the installation of most versions of Mac OS X on non-Apple hardware. </p> 20 <p>These license restrictions are also enforced on a technical level. Mac OS X verifies that it is running on 21 Apple hardware. Most DVDs that accompany Apple hardware check for the exact model. These restrictions are 22 <i>not</i> circumvented by <ph conkeyref="vbox-conkeyref-phrases/product-name"/> and continue to apply. </p> 45 23 </li> 46 24 <li> 47 <p> 48 Only <b outputclass="bold">CPUs</b> that are known 49 and tested by Apple are supported. As a result, if your 50 Intel CPU is newer than the Mac OS X build, or if you have a 51 non-Intel CPU, you will likely encounter a panic during 52 bootup with an "Unsupported CPU" exception. 53 </p> 54 <p> 55 Ensure that you use the Mac OS X DVD that comes with your 56 Apple hardware. 57 </p> 25 <p>Only <b outputclass="bold">CPUs</b> that are known and tested by Apple are supported. As a result, if your 26 Intel CPU is newer than the Mac OS X build, or if you have a non-Intel CPU, you will likely encounter a panic 27 during bootup with an "Unsupported CPU" exception. </p> 28 <p>Ensure that you use the Mac OS X DVD that comes with your Apple hardware. </p> 58 29 </li> 59 30 <li> 60 <p> 61 The Mac OS X installer expects the hard disk to be 62 <i>partitioned</i>. So, the installer will not 63 offer a partition selection to you. Before you can install 64 the software successfully, start the Disk Utility from the 65 Tools menu and partition the hard disk. Close the Disk 66 Utility and proceed with the installation. 67 </p> 31 <p>The Mac OS X installer expects the hard disk to be <i>partitioned</i>. So, the installer will not offer a 32 partition selection to you. Before you can install the software successfully, start the Disk Utility from the 33 Tools menu and partition the hard disk. Close the Disk Utility and proceed with the installation. </p> 68 34 </li> 69 35 <li> 70 <p> 71 In addition, Mac OS X support in <ph conkeyref="vbox-conkeyref-phrases/product-name"/> is an 72 experimental feature. See <xref href="KnownIssues.dita">Known Limitations</xref>. 73 </p> 36 <p>In addition, Mac OS X support in <ph conkeyref="vbox-conkeyref-phrases/product-name"/> is an experimental 37 feature. See <xref href="KnownIssues.dita">Known Limitations</xref>. </p> 74 38 </li> 75 39 </ul> -
trunk/doc/manual/en_US/dita/topics/intro-removable-media-changing.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 While a virtual machine is running, you can change removable 9 media in the <b outputclass="bold">Devices</b> menu of 10 the VM's window. Here you can select in detail what 11 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> presents to your VM as a CD, DVD, or floppy 12 drive. 13 </p> 14 <p> 15 The settings are the same as those available for the VM in the 16 <b outputclass="bold">Settings</b> window of <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. 17 But as the <b outputclass="bold">Settings</b> window is 18 disabled while the VM is in the Running or Saved state, the 19 <b outputclass="bold">Devices</b> menu saves you from 20 having to shut down and restart the VM every time you want to 21 change media. 22 </p> 23 <p> 24 Using the <b outputclass="bold">Devices</b> menu, you can 25 attach the host drive to the guest or select a floppy or DVD 26 image, as described in <xref href="settings-storage.dita#settings-storage"/>. 27 </p> 28 <p> 29 The <b outputclass="bold">Devices</b> menu also includes 30 an option for creating a virtual ISO (VISO) from selected files 31 on the host. 32 </p> 7 <p>While a virtual machine is running, you can change removable media in the <b outputclass="bold">Devices</b> menu 8 of the VM's window. Here you can select in detail what <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 9 presents to your VM as a CD, DVD, or floppy drive. </p> 10 <p>The settings are the same as those available for the VM in the <b outputclass="bold">Settings</b> window of <ph 11 conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. But as the <b outputclass="bold">Settings</b> window is disabled 12 while the VM is in the Running or Saved state, the <b outputclass="bold">Devices</b> menu saves you from having to 13 shut down and restart the VM every time you want to change media. </p> 14 <p>Using the <b outputclass="bold">Devices</b> menu, you can attach the host drive to the guest or select a floppy 15 or DVD image, as described in <xref href="settings-storage.dita#settings-storage"/>. </p> 16 <p>The <b outputclass="bold">Devices</b> menu also includes an option for creating a virtual ISO (VISO) from 17 selected files on the host. </p> 33 18 </body> 34 19 -
trunk/doc/manual/en_US/dita/topics/intro-removing.dita
r105176 r105289 5 5 6 6 <body> 7 <p> 8 You can remove a VM from <ph conkeyref="vbox-conkeyref-phrases/product-name"/> or move the VM and its 9 associated files, such as disk images, to another location on the 10 host. 11 </p> 7 <p>You can remove a VM from <ph conkeyref="vbox-conkeyref-phrases/product-name"/> or move the VM and its associated 8 files, such as disk images, to another location on the host. </p> 12 9 <ul> 13 10 <li> … … 29 26 right-click the VM in the <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>'s machine list 30 27 and select <b outputclass="bold">Move</b>. </p> 31 <p> 32 The file dialog prompts you to specify a new location for the 33 VM. 34 </p> 35 <p> 36 When you move a VM, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> configuration files are 37 updated automatically to use the new location on the host. 38 </p> 39 <p> 40 Note that the <b outputclass="bold">Move</b> menu item 41 is disabled while a VM is running. 42 </p> 43 <p> You can also use the <userinput>VBoxManage movevm</userinput> command to move a VM. See 44 <xref href="vboxmanage-movevm.dita"/>. </p> 28 <p>The file dialog prompts you to specify a new location for the VM. </p> 29 <p>When you move a VM, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> configuration files are updated 30 automatically to use the new location on the host. </p> 31 <p>Note that the <b outputclass="bold">Move</b> menu item is disabled while a VM is running. </p> 32 <p>You can also use the <userinput>VBoxManage movevm</userinput> command to move a VM. See <xref 33 href="vboxmanage-movevm.dita"/>. </p> 45 34 </li> 46 35 </ul> 47 <p> 48 For information about removing or moving a disk image file from 49 <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, see <xref href="virtual-media-manager.dita#virtual-media-manager"/>. 50 </p> 36 <p>For information about removing or moving a disk image file from <ph 37 conkeyref="vbox-conkeyref-phrases/product-name"/>, see <xref 38 href="virtual-media-manager.dita#virtual-media-manager"/>. </p> 51 39 </body> 52 40 -
trunk/doc/manual/en_US/dita/topics/intro-resize-window.dita
r98549 r105289 5 5 6 6 <body> 7 <p> 8 You can resize the VM's window while that VM is running. When 9 you do, the window is scaled as follows: 10 </p> 7 <p>You can resize the VM's window while that VM is running. When you do, the window is scaled as follows: </p> 11 8 <ul> 12 9 <li> 13 <p> 14 If you have <b outputclass="bold">scaled mode</b> 15 enabled, then the virtual machine's screen will be scaled to 16 the size of the window. This can be useful if you have many 17 machines running and want to have a look at one of them 18 while it is running in the background. Alternatively, it 19 might be useful to enlarge a window if the VM's output 20 screen is very small, for example because you are running an 21 old OS in it. 22 </p> 23 <p> 24 To enable scaled mode, press <b outputclass="bold">Host key 25 + C</b>, or select <b outputclass="bold">Scaled 26 Mode</b> from the 27 <b outputclass="bold">View</b> menu in the VM window. 28 To leave scaled mode, press <b outputclass="bold">Host key + 29 C </b>again. 30 </p> 31 <p> 32 The aspect ratio of the guest screen is preserved when 33 resizing the window. To ignore the aspect ratio, press 34 <b outputclass="bold">Shift</b> during the resize 35 operation. 36 </p> 37 <p> 38 See <xref href="KnownIssues.dita">Known Limitations</xref> for additional remarks. 39 </p> 10 <p>If you have <b outputclass="bold">scaled mode</b> enabled, then the virtual machine's screen will be scaled 11 to the size of the window. This can be useful if you have many machines running and want to have a look at one 12 of them while it is running in the background. Alternatively, it might be useful to enlarge a window if the 13 VM's output screen is very small, for example because you are running an old OS in it. </p> 14 <p>To enable scaled mode, press <b outputclass="bold">Host key + C</b>, or select <b outputclass="bold">Scaled 15 Mode</b> from the <b outputclass="bold">View</b> menu in the VM window. To leave scaled mode, press <b 16 outputclass="bold">Host key + C </b>again. </p> 17 <p>The aspect ratio of the guest screen is preserved when resizing the window. To ignore the aspect ratio, press 18 <b outputclass="bold">Shift</b> during the resize operation. </p> 19 <p>See <xref href="KnownIssues.dita">Known Limitations</xref> for additional remarks. </p> 40 20 </li> 41 21 <li> 42 <p> 43 If you have the Guest Additions installed and they support 44 automatic <b outputclass="bold">resizing</b>, the 45 Guest Additions will automatically adjust the screen 46 resolution of the guest OS. For example, if you are running 47 a Windows guest with a resolution of 1024x768 pixels and you 48 then resize the VM window to make it 100 pixels wider, the 49 Guest Additions will change the Windows display resolution 50 to 1124x768. 51 </p> 52 <p> 53 See <xref href="guestadditions.dita"/>. 54 </p> 22 <p>If you have the Guest Additions installed and they support automatic <b outputclass="bold">resizing</b>, the 23 Guest Additions will automatically adjust the screen resolution of the guest OS. For example, if you are 24 running a Windows guest with a resolution of 1024x768 pixels and you then resize the VM window to make it 100 25 pixels wider, the Guest Additions will change the Windows display resolution to 1124x768. </p> 26 <p>See <xref href="guestadditions.dita"/>. </p> 55 27 </li> 56 28 <li> 57 <p> 58 Otherwise, if the window is bigger than the VM's screen, the 59 screen will be centered. If it is smaller, then scroll bars 60 will be added to the machine window. 61 </p> 29 <p>Otherwise, if the window is bigger than the VM's screen, the screen will be centered. If it is smaller, then 30 scroll bars will be added to the machine window. </p> 62 31 </li> 63 32 </ul> -
trunk/doc/manual/en_US/dita/topics/intro-running.dita
r105176 r105289 26 26 </li> 27 27 </ul> 28 <p> 29 Starting a virtual machine displays a new window, and the virtual 30 machine which you selected will boot up. Everything which would 31 normally be seen on the virtual system's monitor is shown in the 32 window. See <xref href="Introduction.dita#Introduction/fig-win2016-intro"/>. 33 </p> 34 <p> 35 In general, you can use the virtual machine as you would use a 36 real computer. The following topics describe a few points to note 37 when running a VM. 38 </p> 28 <p>Starting a virtual machine displays a new window, and the virtual machine which you selected will boot up. 29 Everything which would normally be seen on the virtual system's monitor is shown in the window. See <xref 30 href="Introduction.dita#Introduction/fig-win2016-intro"/>. </p> 31 <p>In general, you can use the virtual machine as you would use a real computer. The following topics describe a few 32 points to note when running a VM. </p> 39 33 </body> 40 34 </topic> -
trunk/doc/manual/en_US/dita/topics/intro-save-machine-state.dita
r105176 r105289 4 4 <title>Saving the State of the Machine</title> 5 5 <body> 6 <p> When you click the <b outputclass="bold">Close</b> button of your virtual machine window, at7 the top right of thewindow, just like you would close any other window on your system, <ph8 conkeyref="vbox-conkeyref-phrases/product-name"/> asks you whether you want to save or power 9 off the VM. As ashortcut, you can also press <b outputclass="bold">Host key + Q</b>. </p>6 <p>When you click the <b outputclass="bold">Close</b> button of your virtual machine window, at the top right of the 7 window, just like you would close any other window on your system, <ph 8 conkeyref="vbox-conkeyref-phrases/product-name"/> asks you whether you want to save or power off the VM. As a 9 shortcut, you can also press <b outputclass="bold">Host key + Q</b>. </p> 10 10 <fig id="fig-vm-close"> 11 11 <title>Closing Down a Virtual Machine</title> … … 30 30 completely saving its state to your local disk. 31 31 </p> 32 <p> 33 When you start the VM again later, you will find that the VM 34 continues exactly where it was left off. All your programs 35 will still be open, and your computer resumes operation. 36 Saving the state of a virtual machine is thus in some ways 37 similar to suspending a laptop computer by closing its lid. 38 </p> 32 <p>When you start the VM again later, you will find that the VM continues exactly where it was left off. All 33 your programs will still be open, and your computer resumes operation. Saving the state of a virtual machine 34 is thus in some ways similar to suspending a laptop computer by closing its lid. </p> 39 35 </li> 40 36 <li> … … 52 48 </p> 53 49 <note type="caution"> 54 <p> 55 This is equivalent to pulling the power plug on a real 56 computer without shutting it down properly. If you start 57 the machine again after powering it off, your OS will have 58 to reboot completely and may begin a lengthy check of its 59 virtual system disks. As a result, this should not 60 normally be done, since it can potentially cause data loss 61 or an inconsistent state of the guest system on disk. 62 </p> 50 <p>This is equivalent to pulling the power plug on a real computer without shutting it down properly. If you 51 start the machine again after powering it off, your OS will have to reboot completely and may begin a 52 lengthy check of its virtual system disks. As a result, this should not normally be done, since it can 53 potentially cause data loss or an inconsistent state of the guest system on disk. </p> 63 54 </note> 64 <p> 65 As an exception, if your virtual machine has any snapshots, 66 see <xref href="snapshots.dita#snapshots"/>, you can use this option to 67 quickly <b outputclass="bold">restore the current 68 snapshot</b> of the virtual machine. In that case, 69 powering off the machine will discard the current state and 70 any changes made since the previous snapshot was taken will 71 be lost. 72 </p> 55 <p>As an exception, if your virtual machine has any snapshots, see <xref href="snapshots.dita#snapshots"/>, you 56 can use this option to quickly <b outputclass="bold">restore the current snapshot</b> of the virtual machine. 57 In that case, powering off the machine will discard the current state and any changes made since the previous 58 snapshot was taken will be lost. </p> 73 59 </li> 74 60 </ul> 75 <p> 76 The <b outputclass="bold">Discard</b> button in the 77 <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> window discards a virtual machine's saved state. This 78 has the same effect as powering it off, and the same warnings 79 apply. 80 </p> 61 <p>The <b outputclass="bold">Discard</b> button in the <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> window 62 discards a virtual machine's saved state. This has the same effect as powering it off, and the same warnings 63 apply. </p> 81 64 </body> 82 65 -
trunk/doc/manual/en_US/dita/topics/intro-starting-vm-first-time.dita
r98549 r105289 5 5 6 6 <body> 7 <p> 8 When you start a VM for the first time the OS installation 9 process is started automatically, using the ISO image file 10 specified in the <b outputclass="bold">Create Virtual 11 Machine</b> wizard. 12 </p> 13 <p> 14 Follow the onscreen instructions to install your OS. 15 </p> 7 <p>When you start a VM for the first time the OS installation process is started automatically, using the ISO image 8 file specified in the <b outputclass="bold">Create Virtual Machine</b> wizard. </p> 9 <p>Follow the onscreen instructions to install your OS. </p> 16 10 </body> 17 11 -
trunk/doc/manual/en_US/dita/topics/intro-starting.dita
r105176 r105289 5 5 6 6 <body> 7 <p> 8 After installation, you can start <ph conkeyref="vbox-conkeyref-phrases/product-name"/> as follows: 9 </p> 7 <p>After installation, you can start <ph conkeyref="vbox-conkeyref-phrases/product-name"/> as follows: </p> 10 8 <ul> 11 9 <li> … … 31 29 </li> 32 30 </ul> 33 <p> 34 When you start <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, the <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> interface is shown. 35 See <xref href="gui-virtualboxmanager.dita#gui-virtualboxmanager"/>. 36 </p> 31 <p>When you start <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, the <ph 32 conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> interface is shown. See <xref 33 href="gui-virtualboxmanager.dita#gui-virtualboxmanager"/>. </p> 37 34 </body> 38 35 -
trunk/doc/manual/en_US/dita/topics/kernel-modules-efi-secure-boot.dita
r98549 r105289 5 5 6 6 <body> 7 <p> 8 If you are running on a system using UEFI (Unified Extensible 9 Firmware Interface) Secure Boot, you may need to sign the 10 following kernel modules before you can load them: 11 </p> 7 <p>If you are running on a system using UEFI (Unified Extensible Firmware Interface) Secure Boot, you may need to 8 sign the following kernel modules before you can load them: </p> 12 9 <ul> 13 10 <li> … … 32 29 </li> 33 30 </ul> 34 <p> 35 See your system documentation for details of the kernel module 36 signing process. 37 </p> 31 <p>See your system documentation for details of the kernel module signing process. </p> 38 32 </body> 39 33 -
trunk/doc/manual/en_US/dita/topics/keyb_mouse_normal.dita
r105134 r105289 5 5 6 6 <body> 7 <p> 8 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> provides a virtual USB tablet device to new 9 virtual machines through which mouse events are communicated to 10 the guest OS. If you are running a modern guest OS that can 11 handle such devices, mouse support may work out of the box 12 without the mouse being <i>captured</i> as 13 described below. See <xref href="settings-motherboard.dita#settings-motherboard"/>. 14 </p> 15 <p> 16 Otherwise, if the virtual machine detects only standard PS/2 17 mouse and keyboard devices, since the OS in the virtual machine 18 does not know that it is not running on a real computer, it 19 expects to have exclusive control over your keyboard and mouse. 20 But unless you are running the VM in full screen mode, your VM 21 needs to share keyboard and mouse with other applications and 22 possibly other VMs on your host. 23 </p> 24 <p> 25 After installing a guest OS and before you install the Guest 26 Additions, described in <xref href="guestadditions.dita#guestadditions"/>, either 27 your VM or the rest of your computer can 28 <i>own</i> the keyboard and the mouse. Both cannot 29 own the keyboard and mouse at the same time. You will see a 30 <i>second</i> mouse pointer which is always 31 confined to the limits of the VM window. You activate the VM by 32 clicking inside it. 33 </p> 34 <p> 35 To return ownership of keyboard and mouse to your host OS, 36 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> reserves a special key on your keyboard: the 37 <i>Host key</i>. By default, this is the 38 <i>right Ctrl key</i> on your keyboard. On a Mac 39 host, the default Host key is the left Command key. You can 40 change this default using the Preferences window. See 41 <xref href="preferences.dita#preferences"/>. The current setting for the Host 42 key is always displayed at the bottom right of your VM window. 43 </p> 7 <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> provides a virtual USB tablet device to new virtual 8 machines through which mouse events are communicated to the guest OS. If you are running a modern guest OS that 9 can handle such devices, mouse support may work out of the box without the mouse being <i>captured</i> as 10 described below. See <xref href="settings-motherboard.dita#settings-motherboard"/>. </p> 11 <p>Otherwise, if the virtual machine detects only standard PS/2 mouse and keyboard devices, since the OS in the 12 virtual machine does not know that it is not running on a real computer, it expects to have exclusive control over 13 your keyboard and mouse. But unless you are running the VM in full screen mode, your VM needs to share keyboard 14 and mouse with other applications and possibly other VMs on your host. </p> 15 <p>After installing a guest OS and before you install the Guest Additions, described in <xref 16 href="guestadditions.dita#guestadditions"/>, either your VM or the rest of your computer can <i>own</i> the 17 keyboard and the mouse. Both cannot own the keyboard and mouse at the same time. You will see a <i>second</i> 18 mouse pointer which is always confined to the limits of the VM window. You activate the VM by clicking inside it. </p> 19 <p>To return ownership of keyboard and mouse to your host OS, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 20 reserves a special key on your keyboard: the <i>Host key</i>. By default, this is the <i>right Ctrl key</i> on 21 your keyboard. On a Mac host, the default Host key is the left Command key. You can change this default using the 22 Preferences window. See <xref href="preferences.dita#preferences"/>. The current setting for the Host key is 23 always displayed at the bottom right of your VM window. </p> 44 24 <fig id="fig-host-key"> 45 25 <title>Host Key Setting on the Virtual Machine Status Bar</title> -
trunk/doc/manual/en_US/dita/topics/linux_install_opts.dita
r98549 r105289 5 5 6 6 <body> 7 <p> 8 To configure the installation process for .deb and .rpm 9 packages, you can create a response file named 10 <filepath>/etc/default/virtualbox</filepath>. The automatic 11 generation of the udev rule can be prevented with the 12 following setting: 13 </p> 7 <p>To configure the installation process for .deb and .rpm packages, you can create a response file named 8 <filepath>/etc/default/virtualbox</filepath>. The automatic generation of the udev rule can be prevented with 9 the following setting: </p> 14 10 <pre xml:space="preserve">INSTALL_NO_UDEV=1</pre> 15 <p> 16 The creation of the group vboxusers can be prevented as 17 follows: 18 </p> 11 <p>The creation of the group vboxusers can be prevented as follows: </p> 19 12 <pre xml:space="preserve">INSTALL_NO_GROUP=1</pre> 20 <p> 21 If the following line is specified, the package installer will 22 not try to build the <userinput>vboxdrv</userinput> kernel module 23 if no module fitting the current kernel was found. 24 </p> 13 <p>If the following line is specified, the package installer will not try to build the 14 <userinput>vboxdrv</userinput> kernel module if no module fitting the current kernel was found. </p> 25 15 <pre xml:space="preserve">INSTALL_NO_VBOXDRV=1</pre> 26 16 </body> -
trunk/doc/manual/en_US/dita/topics/log-viewer.dita
r105176 r105289 5 5 6 6 <body> 7 <p> 8 Every time you start up a VM, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> creates a log file 9 that records system configuration and events. The 10 <b outputclass="bold">Log Viewer</b> is a <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> tool 11 that enables you to view and analyze system logs. 12 </p> 7 <p>Every time you start up a VM, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> creates a log file that 8 records system configuration and events. The <b outputclass="bold">Log Viewer</b> is a <ph 9 conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> tool that enables you to view and analyze system logs. </p> 13 10 <!-- 7.1: New pic required? Tab operation changed. Log Viewer/Filter pane. bugref:10496 --> 14 11 <fig id="fig-log-viewer-tool"> … … 23 20 </image> 24 21 </fig> 25 <p> 26 To display the Log Viewer, do either of the following: 27 </p> 22 <p>To display the Log Viewer, do either of the following: </p> 28 23 <ul> 29 24 <li> 30 <p> 31 Click the VM name in the machine list and select 32 <b outputclass="bold">Logs</b> from the machine tools 33 menu. 34 </p> 25 <p>Click the VM name in the machine list and select <b outputclass="bold">Logs</b> from the machine tools menu. </p> 35 26 </li> 36 27 <li> 37 <p> 38 In the guest VM, select 39 <b outputclass="bold">Machine</b>, 40 <b outputclass="bold">Show Log</b>. 41 </p> 28 <p>In the guest VM, select <b outputclass="bold">Machine</b>, <b outputclass="bold">Show Log</b>. </p> 42 29 </li> 43 30 </ul> 44 <p> 45 Log messages for the VM are displayed in tabs in the Log Viewer 46 window. See <xref href="collect-debug-info.dita">Collecting Debugging Information</xref> for details of 47 the various log files generated by <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. 48 </p> 49 <p> 50 If you select multiple VMs in the machine list, logs are listed 51 for each VM. 52 </p> 53 <p> 54 The toolbar of the Log Viewer includes the following options: 55 </p> 31 <p>Log messages for the VM are displayed in tabs in the Log Viewer window. See <xref href="collect-debug-info.dita" 32 >Collecting Debugging Information</xref> for details of the various log files generated by <ph 33 conkeyref="vbox-conkeyref-phrases/product-name"/>. </p> 34 <p>If you select multiple VMs in the machine list, logs are listed for each VM. </p> 35 <p>The toolbar of the Log Viewer includes the following options: </p> 56 36 <ul> 57 37 <li> -
trunk/doc/manual/en_US/dita/topics/network_internal.dita
r99797 r105289 3 3 <topic xml:lang="en-us" id="network_internal"> 4 4 <title>Internal Networking</title> 5 5 6 6 <body> 7 <p> 8 Internal Networking is similar to bridged networking in that the 9 VM can directly communicate with the outside world. However, the 10 outside world is limited to other VMs on the same host which 11 connect to the same internal network. 12 </p> 13 <p> 14 Even though technically, everything that can be done using 15 internal networking can also be done using bridged networking, 16 there are security advantages with internal networking. In bridged 17 networking mode, all traffic goes through a physical interface of 18 the host system. It is therefore possible to attach a packet 19 sniffer such as Wireshark to the host interface and log all 20 traffic that goes over it. If, for any reason, you prefer two or 21 more VMs on the same machine to communicate privately, hiding 22 their data from both the host system and the user, bridged 23 networking therefore is not an option. 24 </p> 25 <p> 26 Internal networks are created automatically as needed. There is no 27 central configuration. Every internal network is identified simply 28 by its name. Once there is more than one active virtual network 29 card with the same internal network ID, the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> support 30 driver will automatically <i>wire</i> the cards and 31 act as a network switch. The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> support driver 32 implements a complete Ethernet switch and supports both 33 broadcast/multicast frames and promiscuous mode. 34 </p> 35 <p> 36 In order to attach a VM's network card to an internal network, set 37 its networking mode to Internal Networking. There are two ways to 38 accomplish this: 39 </p> 7 <p>Internal Networking is similar to bridged networking in that the VM can directly communicate with the outside 8 world. However, the outside world is limited to other VMs on the same host which connect to the same internal 9 network. </p> 10 <p>Even though technically, everything that can be done using internal networking can also be done using bridged 11 networking, there are security advantages with internal networking. In bridged networking mode, all traffic goes 12 through a physical interface of the host system. It is therefore possible to attach a packet sniffer such as 13 Wireshark to the host interface and log all traffic that goes over it. If, for any reason, you prefer two or more 14 VMs on the same machine to communicate privately, hiding their data from both the host system and the user, 15 bridged networking therefore is not an option. </p> 16 <p>Internal networks are created automatically as needed. There is no central configuration. Every internal network 17 is identified simply by its name. Once there is more than one active virtual network card with the same internal 18 network ID, the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> support driver will automatically 19 <i>wire</i> the cards and act as a network switch. The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 20 support driver implements a complete Ethernet switch and supports both broadcast/multicast frames and promiscuous 21 mode. </p> 22 <p>In order to attach a VM's network card to an internal network, set its networking mode to Internal Networking. 23 There are two ways to accomplish this: </p> 40 24 <ul> 41 25 <li> 42 <p> 43 Use the VM's <b outputclass="bold">Settings</b> window 44 in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. In the <b outputclass="bold">Network</b> 45 category of the Settings window, select 46 <b outputclass="bold">Internal Network</b> from the 47 drop-down list of networking modes. Select the name of an 48 existing internal network from the drop-down list below, or 49 enter a new name into the 50 <b outputclass="bold">Name</b> field. 51 </p> 26 <p>Use the VM's <b outputclass="bold">Settings</b> window in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. 27 In the <b outputclass="bold">Network</b> category of the Settings window, select <b outputclass="bold" 28 >Internal Network</b> from the drop-down list of networking modes. Select the name of an existing internal 29 network from the drop-down list below, or enter a new name into the <b outputclass="bold">Name</b> field. </p> 52 30 </li> 53 31 <li> 54 <p> 55 Use the command line, for example: 56 </p> 32 <p>Use the command line, for example: </p> 57 33 <pre xml:space="preserve">VBoxManage modifyvm "VM name" --nic<x> intnet</pre> 58 34 <p> … … 60 36 </p> 61 37 <pre xml:space="preserve">VBoxManage modifyvm "VM name" --intnet<x> "network name"</pre> 62 <p> 63 If you do not specify a network name, the network card will be 64 attached to the network <codeph>intnet</codeph> by default. 65 </p> 38 <p>If you do not specify a network name, the network card will be attached to the network 39 <codeph>intnet</codeph> by default. </p> 66 40 </li> 67 41 </ul> -
trunk/doc/manual/en_US/dita/topics/ovf-about.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 OVF is a cross-platform standard supported by many 9 virtualization products which enables the creation of ready-made 10 virtual machines that can then be imported into a hypervisor 11 such as <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> makes OVF import and 12 export easy to do, using <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> or the command-line 13 interface. 14 </p> 15 <p> 16 Using OVF enables packaging of <i>virtual 17 appliances</i>. These are disk images, together with 18 configuration settings that can be distributed easily. This way 19 one can offer complete ready-to-use software packages, including 20 OSes with applications, that need no configuration or 21 installation except for importing into <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. 22 </p> 7 <p>OVF is a cross-platform standard supported by many virtualization products which enables the creation of 8 ready-made virtual machines that can then be imported into a hypervisor such as <ph 9 conkeyref="vbox-conkeyref-phrases/product-name"/>. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> makes 10 OVF import and export easy to do, using <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> or the command-line 11 interface. </p> 12 <p>Using OVF enables packaging of <i>virtual appliances</i>. These are disk images, together with configuration 13 settings that can be distributed easily. This way one can offer complete ready-to-use software packages, including 14 OSes with applications, that need no configuration or installation except for importing into <ph 15 conkeyref="vbox-conkeyref-phrases/product-name"/>. </p> 23 16 <note> 24 <p> 25 The OVF standard is complex, and support in <ph conkeyref="vbox-conkeyref-phrases/product-name"/> is 26 an ongoing process. In particular, no guarantee is made that 27 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports all appliances created by other 28 virtualization software. For a list of known limitations, see 29 <xref href="KnownIssues.dita">Known Limitations</xref>. 30 </p> 17 <p>The OVF standard is complex, and support in <ph conkeyref="vbox-conkeyref-phrases/product-name"/> is an ongoing 18 process. In particular, no guarantee is made that <ph conkeyref="vbox-conkeyref-phrases/product-name"/> supports 19 all appliances created by other virtualization software. For a list of known limitations, see <xref 20 href="KnownIssues.dita">Known Limitations</xref>. </p> 31 21 </note> 32 <p> 33 Appliances in OVF format can appear in the following variants: 34 </p> 22 <p>Appliances in OVF format can appear in the following variants: </p> 35 23 <ul> 36 24 <li> 37 <p> 38 They can come in several files, as one or several disk 39 images, typically in the widely-used VMDK format. See 40 <xref href="vdidetails.dita"/>. They also include a textual 41 description file in an XML dialect with an 42 <filepath>.ovf</filepath> extension. These files must then 43 reside in the same directory for <ph conkeyref="vbox-conkeyref-phrases/product-name"/> to be able 44 to import them. 45 </p> 25 <p>They can come in several files, as one or several disk images, typically in the widely-used VMDK format. See 26 <xref href="vdidetails.dita"/>. They also include a textual description file in an XML dialect with an 27 <filepath>.ovf</filepath> extension. These files must then reside in the same directory for <ph 28 conkeyref="vbox-conkeyref-phrases/product-name"/> to be able to import them. </p> 46 29 </li> 47 30 <li> 48 <p> 49 Alternatively, the above files can be packed together into a 50 single archive file, typically with an 51 <filepath>.ova</filepath> extension. Such archive files use 52 a variant of the TAR archive format and can therefore be 53 unpacked outside of <ph conkeyref="vbox-conkeyref-phrases/product-name"/> with any utility that can 54 unpack standard TAR files. 55 </p> 31 <p>Alternatively, the above files can be packed together into a single archive file, typically with an 32 <filepath>.ova</filepath> extension. Such archive files use a variant of the TAR archive format and can 33 therefore be unpacked outside of <ph conkeyref="vbox-conkeyref-phrases/product-name"/> with any utility that 34 can unpack standard TAR files. </p> 56 35 </li> 57 36 </ul> 58 37 <note> 59 <p> 60 OVF cannot describe snapshots that were taken for a virtual 61 machine. As a result, when you export a virtual machine that 62 has snapshots, only the current state of the machine will be 63 exported. The disk images in the export will have a 64 <i>flattened</i> state identical to the current 65 state of the virtual machine. 66 </p> 38 <p>OVF cannot describe snapshots that were taken for a virtual machine. As a result, when you export a virtual 39 machine that has snapshots, only the current state of the machine will be exported. The disk images in the 40 export will have a <i>flattened</i> state identical to the current state of the virtual machine. </p> 67 41 </note> 68 42 </body> -
trunk/doc/manual/en_US/dita/topics/ovf-export-appliance.dita
r99797 r105289 3 3 <topic xml:lang="en-us" id="ovf-export-appliance"> 4 4 <title>Exporting an Appliance in OVF Format</title> 5 5 6 6 <body> 7 <p> 8 The following steps show how to export an appliance in OVF 9 format. 10 </p> 7 <p>The following steps show how to export an appliance in OVF format. </p> 11 8 <ol> 12 9 <li> 13 <p> 14 Select <b outputclass="bold">File</b>, 15 <b outputclass="bold"> Export Appliance</b> to 16 display the <b outputclass="bold">Export Virtual 17 Appliance</b> wizard. 18 </p> 19 <p> 20 On the initial <b outputclass="bold">Virtual 21 Machines</b> page, you can combine several VMs into 22 an OVF appliance. 23 </p> 24 <p> 25 Select one or more VMs to export, and click 26 <b outputclass="bold">Next</b>. 27 </p> 10 <p>Select <b outputclass="bold">File</b>, <b outputclass="bold"> Export Appliance</b> to display the <b 11 outputclass="bold">Export Virtual Appliance</b> wizard. </p> 12 <p>On the initial <b outputclass="bold">Virtual Machines</b> page, you can combine several VMs into an OVF 13 appliance. </p> 14 <p>Select one or more VMs to export, and click <b outputclass="bold">Next</b>. </p> 28 15 </li> 29 16 <li> 30 <p> 31 The <b outputclass="bold">Format Settings</b> page 32 enables you to configure the following settings: 33 </p> 17 <p>The <b outputclass="bold">Format Settings</b> page enables you to configure the following settings: </p> 34 18 <ul> 35 19 <li> … … 38 22 Format</b> value for the output files. 39 23 </p> 40 <p> 41 The <b outputclass="bold"><ph conkeyref="vbox-conkeyref-phrases/oci"/></b> value exports 42 the appliance to <ph conkeyref="vbox-conkeyref-phrases/oci"/>. See 43 <xref href="cloud-export-oci.dita#cloud-export-oci"/>. 44 </p> 24 <p>The <b outputclass="bold"><ph conkeyref="vbox-conkeyref-phrases/oci"/></b> value exports the appliance to 25 <ph conkeyref="vbox-conkeyref-phrases/oci"/>. See <xref href="cloud-export-oci.dita#cloud-export-oci"/>. </p> 45 26 </li> 46 27 <li> -
trunk/doc/manual/en_US/dita/topics/ovf-import-appliance.dita
r105176 r105289 5 5 6 6 <body> 7 <p> 8 The following steps show how to import an appliance in OVF 9 format. 10 </p> 7 <p>The following steps show how to import an appliance in OVF format. </p> 11 8 <ol> 12 9 <li> 13 10 <p> Double-click the OVF or OVA file. </p> 14 <p> 15 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> creates file type associations automatically 16 for any OVF and OVA files on your host OS. 17 </p> 18 <p> 19 The <b outputclass="bold">Appliance Settings</b> page 20 of the <b outputclass="bold">Import Virtual 21 Appliance</b> wizard is shown. 22 </p> 11 <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> creates file type associations automatically for any 12 OVF and OVA files on your host OS. </p> 13 <p>The <b outputclass="bold">Appliance Settings</b> page of the <b outputclass="bold">Import Virtual 14 Appliance</b> wizard is shown. </p> 23 15 <fig id="fig-import-appliance"> 24 16 <title>Import Virtual Appliance Wizard: Appliance Settings</title> … … 34 26 </li> 35 27 <li> 36 <p> 37 The <b outputclass="bold">Appliance Settings</b> page 38 shows the VMs described in the OVF or OVA file and enables 39 you to change the VM settings. 40 </p> 41 <p> 42 By default, membership of VM groups is preserved on import 43 for VMs that were initially exported from <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. 44 You can change this behavior by using the 45 <b outputclass="bold">Primary Group</b> setting for 46 the VM. 47 </p> 48 <p> 49 The following global settings apply to all of the VMs that 50 you import: 51 </p> 28 <p>The <b outputclass="bold">Appliance Settings</b> page shows the VMs described in the OVF or OVA file and 29 enables you to change the VM settings. </p> 30 <p>By default, membership of VM groups is preserved on import for VMs that were initially exported from <ph 31 conkeyref="vbox-conkeyref-phrases/product-name"/>. You can change this behavior by using the <b 32 outputclass="bold">Primary Group</b> setting for the VM. </p> 33 <p>The following global settings apply to all of the VMs that you import: </p> 52 34 <ul> 53 35 <li> … … 56 38 VMs. 57 39 </p> 58 <p> 59 If an appliance has multiple VMs, you can specify a 60 different directory for each VM by editing the 61 <b outputclass="bold">Base Folder</b> setting for 62 the VM. 63 </p> 40 <p>If an appliance has multiple VMs, you can specify a different directory for each VM by editing the <b 41 outputclass="bold">Base Folder</b> setting for the VM. </p> 64 42 </li> 65 43 <li> … … 80 58 </li> 81 59 <li> 82 <p> 83 Click <b outputclass="bold">Finish</b> to import the 84 appliance. 85 </p> 86 <p> 87 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> copies the disk images and creates local VMs 88 with the settings described on the 89 <b outputclass="bold">Appliance Settings</b> page. 90 The imported VMs are shown in the list of VMs in VirtualBox 91 Manager. 92 </p> 93 <p> 94 Because disk images are large, the VMDK images that are 95 included with virtual appliances are shipped in a compressed 96 format that cannot be used directly by VMs. So, the images 97 are first unpacked and copied, which might take several 98 minutes. 99 </p> 60 <p>Click <b outputclass="bold">Finish</b> to import the appliance. </p> 61 <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> copies the disk images and creates local VMs with the 62 settings described on the <b outputclass="bold">Appliance Settings</b> page. The imported VMs are shown in the 63 list of VMs in VirtualBox Manager. </p> 64 <p>Because disk images are large, the VMDK images that are included with virtual appliances are shipped in a 65 compressed format that cannot be used directly by VMs. So, the images are first unpacked and copied, which 66 might take several minutes. </p> 100 67 </li> 101 68 </ol> 102 <p> You can use the <userinput>VBoxManage import</userinput> command to import an appliance. See103 <xrefhref="vboxmanage-import.dita"/>. </p>69 <p>You can use the <userinput>VBoxManage import</userinput> command to import an appliance. See <xref 70 href="vboxmanage-import.dita"/>. </p> 104 71 </body> 105 72 -
trunk/doc/manual/en_US/dita/topics/ovf.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can import and export virtual machines in the 9 following formats: 10 </p> 7 <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> can import and export virtual machines in the following 8 formats: </p> 11 9 <ul> 12 10 <li> -
trunk/doc/manual/en_US/dita/topics/preface-accessibility.dita
r105134 r105289 5 5 <body> 6 6 <section id="accessibility-body"> 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> 7 <p>Oracle customers that have purchased support have access to electronic support through <xref 8 href="https://www.oracle.com/corporate/accessibility/learning-support.html#support-tab" format="html" 9 scope="external">Oracle Accessibility Learning and Support</xref>. </p> 9 10 </section> 10 11 </body> -
trunk/doc/manual/en_US/dita/topics/preface-audience.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 This document is intended for administrators with previous 9 experience of using <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. It is assumed that readers are 10 familiar with Web technologies and have a general understanding of 11 Windows and UNIX platforms. 12 </p> 7 <p>This document is intended for administrators with previous experience of using <ph 8 conkeyref="vbox-conkeyref-phrases/product-name"/>. It is assumed that readers are familiar with Web technologies 9 and have a general understanding of Windows and UNIX platforms. </p> 13 10 </body> 14 11 -
trunk/doc/manual/en_US/dita/topics/preface-reldocs.dita
r99016 r105289 5 5 6 6 <body> 7 <p> 8 The documentation for this product is available at: 9 </p> 10 <p> 7 <p>The documentation for this product is available at: 11 8 <xref href="https://docs.oracle.com/en/virtualization/virtualbox/index.html" scope="external" format="html"/> 12 9 </p> -
trunk/doc/manual/en_US/dita/topics/preferences.dita
r105134 r105289 5 5 6 6 <body> 7 <p> 8 The Preferences window offers a selection of settings, which apply 9 to all virtual machines of the current user. 10 </p> 7 <p>The Preferences window offers a selection of settings, which apply to all virtual machines of the current user. </p> 11 8 <note> 12 9 <p>The available Preferences settings depend on the selected experience level. To display all … … 14 11 <p>See <xref href="ui-experience-level.dita#gui-experience-level"/>.</p> 15 12 </note> 16 <p> 17 To display the Preferences window, do either of the following: 18 </p> 13 <p>To display the Preferences window, do either of the following: </p> 19 14 <ul> 20 15 <li> 21 <p> 22 Select <b outputclass="bold">File</b>, 23 <b outputclass="bold">Preferences</b>. 24 </p> 16 <p>Select <b outputclass="bold">File</b>, <b outputclass="bold">Preferences</b>. </p> 25 17 </li> 26 18 <li> … … 29 21 </li> 30 22 </ul> 31 <p> 32 The following settings are available: 33 </p> 23 <p>The following settings are available: </p> 34 24 <ul> 35 25 <li> … … 74 64 conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> user interface. </p> 75 65 <note> 76 <p> 77 This setting is only available on Windows host platforms. 78 </p> 66 <p>This setting is only available on Windows host platforms. </p> 79 67 </note> 80 68 </li> -
trunk/doc/manual/en_US/dita/topics/serialports.dita
r105134 r105289 109 109 <ul> 110 110 <li> 111 <p> 112 On a Windows host, data will be sent and received 113 through a named pipe. The pipe name must be in the 114 format 115 <filepath>\\.\pipe\<varname>name</varname> 116 </filepath> 117 where <varname>name</varname> should identify 118 the virtual machine but may be freely chosen. 119 </p> 111 <p>On a Windows host, data will be sent and received through a named pipe. The pipe name must be in the 112 format <filepath>\\.\pipe\<varname>name</varname> 113 </filepath> where <varname>name</varname> should identify the virtual machine but may be freely 114 chosen. </p> 120 115 </li> 121 116 <li> 122 <p> 123 On a Mac OS, Linux, or Oracle Solaris host, a local 124 domain socket is used instead. The socket filename 125 must be chosen such that the user running 126 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> has sufficient privileges to create and 127 write to it. The <filepath>/tmp</filepath> directory 128 is often a good candidate. 129 </p> 130 <p> 131 On Linux there are various tools which can connect to 132 a local domain socket or create one in server mode. 133 The most flexible tool is <userinput>socat</userinput> and 134 is available as part of many distributions. 135 </p> 117 <p>On a Mac OS, Linux, or Oracle Solaris host, a local domain socket is used instead. The socket 118 filename must be chosen such that the user running <ph conkeyref="vbox-conkeyref-phrases/product-name" 119 /> has sufficient privileges to create and write to it. The <filepath>/tmp</filepath> directory is 120 often a good candidate. </p> 121 <p>On Linux there are various tools which can connect to a local domain socket or create one in server 122 mode. The most flexible tool is <userinput>socat</userinput> and is available as part of many 123 distributions. </p> 136 124 </li> 137 125 </ul> 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> 144 <p> 145 For a direct connection between two virtual machines, 146 corresponding to a null-modem cable, simply configure one 147 VM to create a pipe or socket and another to attach to it. 148 </p> 126 <p>In this case, you can configure whether <ph conkeyref="vbox-conkeyref-phrases/product-name"/> should 127 create the named pipe, or the local domain socket on non-Windows hosts, itself or whether <ph 128 conkeyref="vbox-conkeyref-phrases/product-name"/> should assume that the pipe or socket exists already. 129 With the <userinput>VBoxManage</userinput> command-line options, this is referred to as server mode or 130 client mode, respectively. </p> 131 <p>For a direct connection between two virtual machines, corresponding to a null-modem cable, simply 132 configure one VM to create a pipe or socket and another to attach to it. </p> 149 133 </li> 150 134 <li> … … 175 159 than 1024 for regular users. 176 160 </p> 177 <p> 178 The client can use software such as 179 <userinput>PuTTY</userinput> or the 180 <userinput>telnet</userinput> command line tool to access 181 the TCP Server. 182 </p> 161 <p>The client can use software such as <userinput>PuTTY</userinput> or the <userinput>telnet</userinput> 162 command line tool to access the TCP Server. </p> 183 163 </li> 184 164 <li> … … 198 178 </li> 199 179 </ol> 200 <p> 201 Up to four serial ports can be configured per virtual machine, but 202 you can pick any port numbers out of the above. However, serial 203 ports cannot reliably share interrupts. If both ports are to be 204 used at the same time, they must use different interrupt levels, 205 for example COM1 and COM2, but not COM1 and COM3. 206 </p> 180 <p>Up to four serial ports can be configured per virtual machine, but you can pick any port numbers out of the 181 above. However, serial ports cannot reliably share interrupts. If both ports are to be used at the same time, they 182 must use different interrupt levels, for example COM1 and COM2, but not COM1 and COM3. </p> 207 183 </body> 208 184 209 185 </topic> -
trunk/doc/manual/en_US/dita/topics/settings-acceleration.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 On this tab, you can configure <ph conkeyref="vbox-conkeyref-phrases/product-name"/> to use hardware 9 virtualization extensions that your host CPU supports. 10 </p> 7 <p>On this tab, you can configure <ph conkeyref="vbox-conkeyref-phrases/product-name"/> to use hardware 8 virtualization extensions that your host CPU supports. </p> 11 9 <ul> 12 10 <li> … … 36 34 </li> 37 35 </ul> 38 <p> 39 Advanced users may be interested in technical details about 40 hardware virtualization. See <xref href="hwvirt.dita">Hardware Virtualization</xref>. 41 </p> 36 <p>Advanced users may be interested in technical details about hardware virtualization. See <xref 37 href="hwvirt.dita">Hardware Virtualization</xref>. </p> 42 38 </li> 43 39 </ul> 44 <p> 45 In most cases, the default settings on the 46 <b outputclass="bold">Acceleration</b> tab will work 47 well. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> selects sensible defaults, depending on the 48 OS that you selected when you created the virtual machine. In 49 certain situations, however, you may want to change the 50 preconfigured defaults. 51 </p> 40 <p>In most cases, the default settings on the <b outputclass="bold">Acceleration</b> tab will work well. <ph 41 conkeyref="vbox-conkeyref-phrases/product-name"/> selects sensible defaults, depending on the OS that you 42 selected when you created the virtual machine. In certain situations, however, you may want to change the 43 preconfigured defaults. </p> 52 44 </body> 53 45 -
trunk/doc/manual/en_US/dita/topics/settings-audio.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 The <b outputclass="bold">Audio</b> section in a virtual 9 machine's <b outputclass="bold">Settings</b> window 10 determines whether the VM will detect a connected sound card, and 11 if the audio output should be played on the host system. 12 </p> 13 <p> 14 To enable audio for a guest, select the 15 <b outputclass="bold">Enable Audio</b> check box. The 16 following settings are available: 17 </p> 7 <p>The <b outputclass="bold">Audio</b> section in a virtual machine's <b outputclass="bold">Settings</b> window 8 determines whether the VM will detect a connected sound card, and if the audio output should be played on the host 9 system. </p> 10 <p>To enable audio for a guest, select the <b outputclass="bold">Enable Audio</b> check box. The following settings 11 are available: </p> 18 12 <ul> 19 13 <li> … … 21 15 driver that <ph conkeyref="vbox-conkeyref-phrases/product-name"/> uses on the host. 22 16 </p> 23 <p> 24 The <b outputclass="bold">Default</b> option is enabled 25 by default for all new VMs. This option selects the best audio 26 driver for the host platform automatically. This enables you 27 to move VMs between different platforms without having to 28 change the audio driver. 29 </p> 30 <p> 31 On a Linux host, depending on your host configuration, you can 32 select between the OSS, ALSA, or the PulseAudio subsystem. On 33 newer Linux distributions, the PulseAudio subsystem is 34 preferred. 35 </p> 36 <p> 37 Only OSS is supported on Oracle Solaris hosts. The Oracle 38 Solaris Audio audio backend is no longer supported on Oracle 39 Solaris hosts. 40 </p> 17 <p>The <b outputclass="bold">Default</b> option is enabled by default for all new VMs. This option selects the 18 best audio driver for the host platform automatically. This enables you to move VMs between different 19 platforms without having to change the audio driver. </p> 20 <p>On a Linux host, depending on your host configuration, you can select between the OSS, ALSA, or the 21 PulseAudio subsystem. On newer Linux distributions, the PulseAudio subsystem is preferred. </p> 22 <p>Only OSS is supported on Oracle Solaris hosts. The Oracle Solaris Audio audio backend is no longer supported 23 on Oracle Solaris hosts. </p> 41 24 </li> 42 25 <li> -
trunk/doc/manual/en_US/dita/topics/settings-basic.dita
r105134 r105289 5 5 6 6 <body> 7 <p> 8 In the <b outputclass="bold">Basic</b> tab of the 9 <b outputclass="bold">General</b> settings category, you 10 can find these settings: 11 </p> 7 <p>In the <b outputclass="bold">Basic</b> tab of the <b outputclass="bold">General</b> settings category, you can 8 find these settings: </p> 12 9 <ul> 13 10 <li> … … 19 16 can only use characters which are allowed for file names on your host OS. 20 17 </p> 21 <p> 22 Note that internally, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> uses unique identifiers 23 (UUIDs) to identify virtual machines. You can display these 24 using the <userinput>VBoxManage</userinput> commands. 25 </p> 18 <p>Note that internally, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> uses unique identifiers (UUIDs) 19 to identify virtual machines. You can display these using the <userinput>VBoxManage</userinput> commands. </p> 26 20 </li> 27 21 <li> … … 33 27 wizard. See <xref href="create-vm-wizard.dita#create-vm-wizard"/>. 34 28 </p> 35 <p> 36 Whereas the default settings of a newly created VM depend on 37 the selected OS type, changing the type later has no effect 38 on VM settings. This value is purely informational and 39 decorative. 40 </p> 29 <p>Whereas the default settings of a newly created VM depend on the selected OS type, changing the type later 30 has no effect on VM settings. This value is purely informational and decorative. </p> 41 31 </li> 42 32 <li> -
trunk/doc/manual/en_US/dita/topics/settings-capture.dita
r105134 r105289 5 5 6 6 <body> 7 <p> 8 On the <b outputclass="bold">Recording</b> tab you can 9 enable video and audio recording for a virtual machine and 10 change related settings. Note that these features can be enabled 11 and disabled while a VM is running. 12 </p> 7 <p>On the <b outputclass="bold">Recording</b> tab you can enable video and audio recording for a virtual machine and 8 change related settings. Note that these features can be enabled and disabled while a VM is running. </p> 13 9 <ul> 14 10 <li> … … 22 18 choose to record video, audio, or both video and audio. 23 19 </p> 24 <p> 25 Some settings on the 26 <b outputclass="bold">Recording</b> tab may be grayed 27 out, depending on the <b outputclass="bold">Recording 28 Mode</b> setting. 29 </p> 20 <p>Some settings on the <b outputclass="bold">Recording</b> tab may be grayed out, depending on the <b 21 outputclass="bold">Recording Mode</b> setting. </p> 30 22 </li> 31 23 <li> … … 67 59 </li> 68 60 </ul> 69 <p> 70 As you adjust the video and audio recording settings, the 71 approximate output file size for a five minute video is shown. 72 </p> 61 <p>As you adjust the video and audio recording settings, the approximate output file size for a five minute video is 62 shown. </p> 73 63 </body> 74 64 -
trunk/doc/manual/en_US/dita/topics/settings-description.dita
r99016 r105289 5 5 6 6 <body> 7 <p> 8 On the <b outputclass="bold">Description</b> tab you can 9 enter a description for your virtual machine. This has no effect 10 on the functionality of the machine, but you may find this space 11 useful to note down things such as the configuration of a 12 virtual machine and the software that has been installed into 13 it. 14 </p> 15 <p> 16 To insert a line break into the 17 <b outputclass="bold">Description</b> text field, press 18 Shift+Enter. 19 </p> 7 <p>On the <b outputclass="bold">Description</b> tab you can enter a description for your virtual machine. This has 8 no effect on the functionality of the machine, but you may find this space useful to note down things such as the 9 configuration of a virtual machine and the software that has been installed into it. </p> 10 <p>To insert a line break into the <b outputclass="bold">Description</b> text field, press Shift+Enter. </p> 20 11 </body> 21 12 -
trunk/doc/manual/en_US/dita/topics/settings-disk-encryption.dita
r99016 r105289 6 6 7 7 <body> 8 <p> 9 The <b outputclass="bold">Disk Encryption</b> tab enables 10 you to encrypt disks that are attached to the virtual machine. 11 </p> 12 <p> 13 To enable disk encryption, select the 14 <b outputclass="bold">Enable Disk Encryption</b> check 15 box. 16 </p> 17 <p> 18 Settings are available to configure the cipher used for 19 encryption and the encryption password. 20 </p> 8 <p>The <b outputclass="bold">Disk Encryption</b> tab enables you to encrypt disks that are attached to 9 the virtual machine. </p> 10 <p>To enable disk encryption, select the <b outputclass="bold">Enable Disk Encryption</b> check box. </p> 11 <p>Settings are available to configure the cipher used for encryption and the encryption password. </p> 21 12 <note> 22 <p> 23 All files related to the virtual machine except disk images 24 are stored unencrypted. To encrypt these files, use the 25 <userinput>VBoxManage encryptvm</userinput> command as described 26 in <xref href="vmencryption.dita">Encryption of VMs</xref>. 27 </p> 13 <p>All files related to the virtual machine except disk images are stored unencrypted. To encrypt 14 these files, use the <userinput>VBoxManage encryptvm</userinput> command as described in <xref 15 href="vmencryption.dita">Encryption of VMs</xref>. </p> 28 16 </note> 29 17 </body> -
trunk/doc/manual/en_US/dita/topics/settings-display.dita
r99016 r105289 5 5 6 6 <body> 7 <p> 8 The following tabs are available for configuring the display for a 9 virtual machine. 10 </p> 7 <p>The following tabs are available for configuring the display for a virtual machine. </p> 11 8 </body> 12 9 </topic> -
trunk/doc/manual/en_US/dita/topics/settings-general-advanced.dita
r105134 r105289 5 5 6 6 <body> 7 <p> 8 The following settings are available in the 9 <b outputclass="bold">Advanced</b> tab: 10 </p> 7 <p>The following settings are available in the <b outputclass="bold">Advanced</b> tab: </p> 11 8 <ul> 12 9 <li> … … 30 27 direction. 31 28 </p> 32 <p> 33 Clipboard sharing requires that the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest 34 Additions be installed. In such a case, this setting has no 35 effect. See <xref href="guestadditions.dita#guestadditions"/>. 36 </p> 37 <p> 38 For security reasons, the shared clipboard is disabled by 39 default. This setting can be changed at any time using the 40 <b outputclass="bold">Shared Clipboard</b> menu item 41 in the <b outputclass="bold">Devices</b> menu of the 42 virtual machine. 43 </p> 29 <p>Clipboard sharing requires that the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions be 30 installed. In such a case, this setting has no effect. See <xref href="guestadditions.dita#guestadditions"/>. </p> 31 <p>For security reasons, the shared clipboard is disabled by default. This setting can be changed at any time 32 using the <b outputclass="bold">Shared Clipboard</b> menu item in the <b outputclass="bold">Devices</b> menu 33 of the virtual machine. </p> 44 34 <!--7.1: r159813: checkbox added to the Shared Clipboard menu? --> 45 35 </li> … … 51 41 enable restricting of access in either direction. 52 42 </p> 53 <p> 54 For drag and drop to work the Guest Additions need to be 55 installed on the guest. 56 </p> 43 <p>For drag and drop to work the Guest Additions need to be installed on the guest. </p> 57 44 <note> 58 <p> 59 Drag and drop is disabled by default. This setting can be 60 changed at any time using the <b outputclass="bold">Drag 61 and Drop</b> menu item in the 62 <b outputclass="bold">Devices</b> menu of the 63 virtual machine. 64 </p> 45 <p>Drag and drop is disabled by default. This setting can be changed at any time using the <b 46 outputclass="bold">Drag and Drop</b> menu item in the <b outputclass="bold">Devices</b> menu of the 47 virtual machine. </p> 65 48 </note> 66 <p> 67 See <xref href="guestadd-dnd.dita#guestadd-dnd"/>. 68 </p> 49 <p>See <xref href="guestadd-dnd.dita#guestadd-dnd"/>. </p> 69 50 </li> 70 51 </ul> -
trunk/doc/manual/en_US/dita/topics/settings-motherboard.dita
r105176 r105289 3 3 <topic xml:lang="en-us" id="settings-motherboard"> 4 4 <title>Motherboard Tab</title> 5 5 6 6 <body> 7 <p> 8 On the <b outputclass="bold">Motherboard</b> tab, you can 9 configure virtual hardware that would normally be on the 10 motherboard of a real computer. 11 </p> 7 <p>On the <b outputclass="bold">Motherboard</b> tab, you can configure virtual hardware that would normally be on 8 the motherboard of a real computer. </p> 12 9 <ul> 13 10 <li> … … 22 19 as described in <xref href="create-vm-wizard.dita#create-vm-wizard"/>. 23 20 </p> 24 <p> 25 Generally, it is possible to change the memory size after 26 installing the guest OS. But you must not reduce the memory 27 to an amount where the OS would no longer boot. 28 </p> 21 <p>Generally, it is possible to change the memory size after installing the guest OS. But you must not reduce 22 the memory to an amount where the OS would no longer boot. </p> 29 23 </li> 30 24 <li> … … 77 71 Windows 8 or later. 78 72 </p> 79 <p> 80 Using the virtual USB tablet has the advantage that 81 movements are reported in absolute coordinates, instead of 82 as relative position changes. This enables <ph conkeyref="vbox-conkeyref-phrases/product-name"/> to 83 translate mouse events over the VM window into tablet events 84 without having to "capture" the mouse in the guest as 85 described in <xref href="keyb_mouse_normal.dita#keyb_mouse_normal"/>. This 86 makes using the VM less tedious even if Guest Additions are 87 not installed. 88 </p> 73 <p>Using the virtual USB tablet has the advantage that movements are reported in absolute coordinates, instead 74 of as relative position changes. This enables <ph conkeyref="vbox-conkeyref-phrases/product-name"/> to 75 translate mouse events over the VM window into tablet events without having to "capture" the mouse in the 76 guest as described in <xref href="keyb_mouse_normal.dita#keyb_mouse_normal"/>. This makes using the VM less 77 tedious even if Guest Additions are not installed. </p> 89 78 </li> 90 79 <li> … … 97 86 </p> 98 87 <note> 99 <p> 100 Enabling the I/O APIC is <i>required</i>, 101 especially for 64-bit Windows guest OSes. It is also 102 required if you want to use more than one virtual CPU in a 103 virtual machine. 104 </p> 88 <p>Enabling the I/O APIC is <i>required</i>, especially for 64-bit Windows guest OSes. It is also required if 89 you want to use more than one virtual CPU in a virtual machine. </p> 105 90 </note> 106 <p> 107 However, software support for I/O APICs has been unreliable 108 with some OSes other than Windows. Also, the use of an I/O 109 APIC slightly increases the overhead of virtualization and 110 therefore slows down the guest OS a little. 111 </p> 91 <p>However, software support for I/O APICs has been unreliable with some OSes other than Windows. Also, the use 92 of an I/O APIC slightly increases the overhead of virtualization and therefore slows down the guest OS a 93 little. </p> 112 94 <note> 113 <p> 114 All Windows OSes install different kernels, depending on 115 whether an I/O APIC is available. As with ACPI, the I/O 116 APIC therefore <i>must not be turned off after 117 installation</i> of a Windows guest OS. Turning it 118 on after installation will have no effect however. 119 </p> 95 <p>All Windows OSes install different kernels, depending on whether an I/O APIC is available. As with ACPI, 96 the I/O APIC therefore <i>must not be turned off after installation</i> of a Windows guest OS. Turning it on 97 after installation will have no effect however. </p> 120 98 </note> 121 99 </li> -
trunk/doc/manual/en_US/dita/topics/settings-network.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 The <b outputclass="bold">Network</b> section in a virtual 9 machine's <b outputclass="bold">Settings</b> window enables 10 you to configure how <ph conkeyref="vbox-conkeyref-phrases/product-name"/> presents virtual network cards 11 to your VM, and how they operate. 12 </p> 13 <p> 14 When you first create a virtual machine, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> by default 15 enables one virtual network card and selects the Network Address 16 Translation (NAT) mode for it. This way the guest can connect to 17 the outside world using the host's networking and the outside 18 world can connect to services on the guest which you choose to 19 make visible outside of the virtual machine. 20 </p> 21 <p> 22 This default setup is good for the majority of <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 23 users. However, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> is extremely flexible in how it can 24 virtualize networking. It supports many virtual network cards per 25 virtual machine. The first four virtual network cards can be 26 configured in detail in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. Additional network cards can 27 be configured using the <userinput>VBoxManage</userinput> command. 28 </p> 29 <p> 30 Many networking options are available. See 31 <xref href="networkingdetails.dita#networkingdetails"/> for more information. 32 </p> 7 <p>The <b outputclass="bold">Network</b> section in a virtual machine's <b outputclass="bold">Settings</b> window 8 enables you to configure how <ph conkeyref="vbox-conkeyref-phrases/product-name"/> presents virtual network cards 9 to your VM, and how they operate. </p> 10 <p>When you first create a virtual machine, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> by default enables 11 one virtual network card and selects the Network Address Translation (NAT) mode for it. This way the guest can 12 connect to the outside world using the host's networking and the outside world can connect to services on the 13 guest which you choose to make visible outside of the virtual machine. </p> 14 <p>This default setup is good for the majority of <ph conkeyref="vbox-conkeyref-phrases/product-name"/> users. 15 However, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> is extremely flexible in how it can virtualize 16 networking. It supports many virtual network cards per virtual machine. The first four virtual network cards can 17 be configured in detail in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. Additional network cards can be 18 configured using the <userinput>VBoxManage</userinput> command. </p> 19 <p>Many networking options are available. See <xref href="networkingdetails.dita#networkingdetails"/> for more 20 information. </p> 33 21 </body> 34 22 -
trunk/doc/manual/en_US/dita/topics/settings-processor.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 On the <b outputclass="bold">Processor</b> tab, you can 9 configure settings for the CPU used by the virtual machine. 10 </p> 7 <p>On the <b outputclass="bold">Processor</b> tab, you can configure settings for the CPU used by the virtual 8 machine. </p> 11 9 <ul> 12 10 <li> … … 60 58 </li> 61 59 </ul> 62 <p> 63 With virtual machines running modern server OSes, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 64 also supports CPU hot-plugging. For details, see 65 <xref href="cpuhotplug.dita">CPU Hot-Plugging</xref>. 66 </p> 60 <p>With virtual machines running modern server OSes, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> also 61 supports CPU hot-plugging. For details, see <xref href="cpuhotplug.dita">CPU Hot-Plugging</xref>. </p> 67 62 </body> 68 63 -
trunk/doc/manual/en_US/dita/topics/settings-remote-display.dita
r99797 r105289 5 5 6 6 <body> 7 <p> 8 On the <b outputclass="bold">Remote Display</b> tab, if 9 the VirtualBox Remote Display Extension (VRDE) is installed, you 10 can enable the VRDP server that is built into <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. 11 This enables you to connect to the console of the virtual 12 machine remotely with any standard RDP viewer, such as 13 <userinput>mstsc.exe</userinput> that comes with Microsoft Windows. 14 On Linux and Oracle Solaris systems you can use the standard 15 open source <userinput>rdesktop</userinput> program. These features 16 are described in <xref href="vrde.dita">Remote Display (VRDP Support)</xref>. 17 </p> 7 <p>On the <b outputclass="bold">Remote Display</b> tab, if the VirtualBox Remote Display Extension (VRDE) is 8 installed, you can enable the VRDP server that is built into <ph conkeyref="vbox-conkeyref-phrases/product-name" 9 />. This enables you to connect to the console of the virtual machine remotely with any standard RDP viewer, such 10 as <userinput>mstsc.exe</userinput> that comes with Microsoft Windows. On Linux and Oracle Solaris systems you can 11 use the standard open source <userinput>rdesktop</userinput> program. These features are described in <xref 12 href="vrde.dita">Remote Display (VRDP Support)</xref>. </p> 18 13 <ul> 19 14 <li> -
trunk/doc/manual/en_US/dita/topics/settings-screen.dita
r105134 r105289 11 11 specified amount will be allocated from the host's resident memory. Based on the amount of 12 12 video memory, higher resolutions and color depths may be available. </p> 13 <p> 14 <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> will show a warning if the amount of video memory 15 is too small to be able to switch the VM into full screen 16 mode. The minimum value depends on the number of virtual 17 monitors, the screen resolution and the color depth of the 18 host display as well as on the use of <i>3D 19 acceleration</i> and <i>2D video 20 acceleration</i>. A rough estimate is 21 (<i>color depth</i> / 8) x <i>vertical 22 pixels</i> x <i>horizontal pixels</i> x 23 <i>number of screens</i> = <i>number of 24 bytes</i>. Extra memory may be required if display 25 acceleration is used. 26 </p> 13 <p><ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> will show a warning if the amount of video memory is too 14 small to be able to switch the VM into full screen mode. The minimum value depends on the number of virtual 15 monitors, the screen resolution and the color depth of the host display as well as on the use of <i>3D 16 acceleration</i> and <i>2D video acceleration</i>. A rough estimate is (<i>color depth</i> / 8) x 17 <i>vertical pixels</i> x <i>horizontal pixels</i> x <i>number of screens</i> = <i>number of bytes</i>. Extra 18 memory may be required if display acceleration is used. </p> 27 19 </li> 28 20 <li> … … 34 26 virtual monitors are supported. 35 27 </p> 36 <p> 37 The output of the multiple monitors are displayed on the 38 host in multiple VM windows which are running side by side. 39 However, in full screen and seamless mode, they use the 40 available physical monitors attached to the host. As a 41 result, for full screen and seamless modes to work with 42 multiple monitors, you will need at least as many physical 43 monitors as you have virtual monitors configured, or 44 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> will report an error. 45 </p> 46 <p> 47 You can configure the relationship between guest and host 48 monitors using the <b outputclass="bold">View</b> 49 menu by pressing Host key + Home when you are in full screen 50 or seamless mode. 51 </p> 52 <p> 53 See also <xref href="KnownIssues.dita">Known Limitations</xref>. 54 </p> 28 <p>The output of the multiple monitors are displayed on the host in multiple VM windows which are running side 29 by side. However, in full screen and seamless mode, they use the available physical monitors attached to the 30 host. As a result, for full screen and seamless modes to work with multiple monitors, you will need at least 31 as many physical monitors as you have virtual monitors configured, or <ph 32 conkeyref="vbox-conkeyref-phrases/product-name"/> will report an error. </p> 33 <p>You can configure the relationship between guest and host monitors using the <b outputclass="bold">View</b> 34 menu by pressing Host key + Home when you are in full screen or seamless mode. </p> 35 <p>See also <xref href="KnownIssues.dita">Known Limitations</xref>. </p> 55 36 </li> 56 37 <li> … … 61 42 scaling factor up to 200%. 62 43 </p> 63 <p> 64 You can set a default scale factor for all VMs. Use the 65 <b outputclass="bold">Display</b> tab in the 66 Preferences window. 67 </p> 44 <p>You can set a default scale factor for all VMs. Use the <b outputclass="bold">Display</b> tab in the 45 Preferences window. </p> 68 46 </li> 69 47 <li> … … 80 58 later. 81 59 </p> 82 <p> 83 This graphics controller improves performance and 3D 84 support when compared to the legacy VBoxVGA option. 85 </p> 60 <p>This graphics controller improves performance and 3D support when compared to the legacy VBoxVGA option. </p> 86 61 </li> 87 62 <li> … … 91 66 Windows 7 and for Oracle Solaris. 92 67 </p> 93 <p> 94 3D acceleration is not supported for this graphics 95 controller. 96 </p> 68 <p>3D acceleration is not supported for this graphics controller. </p> 97 69 </li> 98 70 <li> -
trunk/doc/manual/en_US/dita/topics/settings-storage.dita
r105176 r105289 5 5 6 6 <body> 7 <p> 8 The <b outputclass="bold">Storage</b> category in the VM 9 settings enables you to connect virtual hard disk, CD/DVD, and 10 floppy images and drives to your virtual machine. 11 </p> 12 <p> 13 In a real computer, so-called <i>storage 14 controllers</i> connect physical disk drives to the rest of 15 the computer. Similarly, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> presents virtual storage 16 controllers to a virtual machine. Under each controller, the 17 virtual devices, such as hard disks, CD/DVD or floppy drives, 18 attached to the controller are shown. 19 </p> 7 <p>The <b outputclass="bold">Storage</b> category in the VM settings enables you to connect virtual hard disk, 8 CD/DVD, and floppy images and drives to your virtual machine. </p> 9 <p>In a real computer, so-called <i>storage controllers</i> connect physical disk drives to the rest of the 10 computer. Similarly, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> presents virtual storage controllers to 11 a virtual machine. Under each controller, the virtual devices, such as hard disks, CD/DVD or floppy drives, 12 attached to the controller are shown. </p> 20 13 <note> 21 <p> 22 This section gives a quick introduction to the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 23 storage settings. See <xref href="storage.dita#storage"/> for a full 24 description of the available storage settings in <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. 25 </p> 14 <p>This section gives a quick introduction to the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> storage 15 settings. See <xref href="storage.dita#storage"/> for a full description of the available storage settings in 16 <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. </p> 26 17 </note> 27 <p> 28 If you have used the <b outputclass="bold">Create Virtual 29 Machine</b> wizard to create a machine, you will normally 30 see something like the following: 31 </p> 18 <p>If you have used the <b outputclass="bold">Create Virtual Machine</b> wizard to create a machine, you will 19 normally see something like the following: </p> 32 20 <fig id="fig-storage-settings"> 33 21 <title>Storage Settings for a Virtual Machine</title> … … 41 29 </image> 42 30 </fig> 43 <p> 44 Depending on the guest OS type that you selected when you created 45 the VM, a new VM includes the following storage devices: 46 </p> 31 <p>Depending on the guest OS type that you selected when you created the VM, a new VM includes the following storage 32 devices: </p> 47 33 <ul> 48 34 <li> … … 63 49 </li> 64 50 </ul> 65 <p> 66 If you created your VM with an older version of <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, 67 the default storage layout may differ. You might then only have an 68 IDE controller to which both the CD/DVD drive and the hard disks 69 have been attached. This might also apply if you selected an older 70 OS type when you created the VM. Since older OSes do not support 71 SATA without additional drivers, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> will make sure 72 that no such devices are present initially. See 73 <xref href="harddiskcontrollers.dita#harddiskcontrollers"/>. 74 </p> 75 <p> 76 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> also provides a <i>floppy 77 controller</i>. You cannot add devices other than floppy 78 drives to this controller. Virtual floppy drives, like virtual 79 CD/DVD drives, can be connected to either a host floppy drive, if 80 you have one, or a disk image, which in this case must be in RAW 81 format. 82 </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> 51 <p>If you created your VM with an older version of <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, the 52 default storage layout may differ. You might then only have an IDE controller to which both the CD/DVD drive and 53 the hard disks have been attached. This might also apply if you selected an older OS type when you created the VM. 54 Since older OSes do not support SATA without additional drivers, <ph 55 conkeyref="vbox-conkeyref-phrases/product-name"/> will make sure that no such devices are present initially. See 56 <xref href="harddiskcontrollers.dita#harddiskcontrollers"/>. </p> 57 <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> also provides a <i>floppy controller</i>. You cannot add 58 devices other than floppy drives to this controller. Virtual floppy drives, like virtual CD/DVD drives, can be 59 connected to either a host floppy drive, if you have one, or a disk image, which in this case must be in RAW 60 format. </p> 61 <p>You can modify these media attachments freely. For example, if you want to copy some files from another virtual 62 disk that you created, you can connect that disk as a second hard disk, as in the above screenshot. You could also 63 add a second virtual CD/DVD drive, or change where these items are attached. The following options are available: </p> 87 64 <ul> 88 65 <li> 89 <p> To <b outputclass="bold">add another virtual hard disk, or a CD/DVD or floppy drive</b>, 90 select the storage controller to which it should be added (such as IDE, SATA, SCSI, SAS, 91 floppy controller) and then click the <b outputclass="bold">Add Disk</b> button below the 92 tree. You can then either select <b outputclass="bold">Optical Drive</b> or <b 93 outputclass="bold">Hard Disk</b>. If you clicked on a floppy controller, you can add a 94 floppy drive instead. Alternatively, right-click the storage controller and select a menu 95 item there. </p> 96 <p> 97 A dialog is displayed, enabling you to select an existing disk 98 image file or to create a new disk image file. Depending on 99 the type of disk image, the dialog is called 100 <b outputclass="bold">Hard Disk Selector</b>, 101 <b outputclass="bold">Optical Disk Selector</b>, or 102 <b outputclass="bold">Floppy Disk Selector</b>. 103 </p> 104 <p> 105 See <xref href="vdidetails.dita#vdidetails"/> for information on the image 106 file types that are supported by <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. 107 </p> 108 <p> 109 For virtual CD/DVD drives, the image files will typically be 110 in the standard ISO format instead. Most commonly, you will 111 select this option when installing an OS from an ISO file that 112 you have obtained from the Internet. For example, most Linux 113 distributions are available in this way. 114 </p> 115 <p> 116 Depending on the type of disk image, you can set the following 117 <b outputclass="bold">Attributes</b> for the disk image 118 in the right part of the Storage settings page: 119 </p> 66 <p>To <b outputclass="bold">add another virtual hard disk, or a CD/DVD or floppy drive</b>, select the storage 67 controller to which it should be added (such as IDE, SATA, SCSI, SAS, floppy controller) and then click the <b 68 outputclass="bold">Add Disk</b> button below the tree. You can then either select <b outputclass="bold" 69 >Optical Drive</b> or <b outputclass="bold">Hard Disk</b>. If you clicked on a floppy controller, you can 70 add a floppy drive instead. Alternatively, right-click the storage controller and select a menu item there. </p> 71 <p>A dialog is displayed, enabling you to select an existing disk image file or to create a new disk image file. 72 Depending on the type of disk image, the dialog is called <b outputclass="bold">Hard Disk Selector</b>, <b 73 outputclass="bold">Optical Disk Selector</b>, or <b outputclass="bold">Floppy Disk Selector</b>. </p> 74 <p>See <xref href="vdidetails.dita#vdidetails"/> for information on the image file types that are supported by 75 <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. </p> 76 <p>For virtual CD/DVD drives, the image files will typically be in the standard ISO format instead. Most 77 commonly, you will select this option when installing an OS from an ISO file that you have obtained from the 78 Internet. For example, most Linux distributions are available in this way. </p> 79 <p>Depending on the type of disk image, you can set the following <b outputclass="bold">Attributes</b> for the 80 disk image in the right part of the Storage settings page: </p> 120 81 <ul> 121 82 <li> 122 <p> 123 The <b outputclass="bold">device slot</b> of the 124 controller that the virtual disk is connected to. IDE 125 controllers have four slots: primary device 0, primary 126 device 1, secondary device 0, and secondary device 1. By 127 contrast, SATA and SCSI controllers offer you up to 30 128 slots for attaching virtual devices. 129 </p> 83 <p>The <b outputclass="bold">device slot</b> of the controller that the virtual disk is connected to. IDE 84 controllers have four slots: primary device 0, primary device 1, secondary device 0, and secondary device 85 1. By contrast, SATA and SCSI controllers offer you up to 30 slots for attaching virtual devices. </p> 130 86 </li> 87 <li><b outputclass="bold">Solid-state Drive</b> presents a virtual disk to the guest as a solid-state device. </li> 88 <li><b outputclass="bold">Hot-pluggable</b> presents a virtual disk to the guest as a hot-pluggable device. </li> 131 89 <li> 132 <p><b outputclass="bold">Solid-state Drive</b> 133 presents a virtual disk to the guest as a solid-state 134 device. 135 </p> 136 </li> 137 <li> 138 <p><b outputclass="bold">Hot-pluggable</b> presents a 139 virtual disk to the guest as a hot-pluggable device. 140 </p> 141 </li> 142 <li> 143 <p> 144 For virtual CD/DVD drives, you can select 145 <b outputclass="bold">Live CD/DVD</b>. This means 146 that the virtual optical disk is not removed from when the 147 guest system ejects it. 148 </p> 90 <p>For virtual CD/DVD drives, you can select <b outputclass="bold">Live CD/DVD</b>. This means that the 91 virtual optical disk is not removed from when the guest system ejects it. </p> 149 92 </li> 150 93 </ul> 151 94 </li> 152 95 <li> 153 <p> To <b outputclass="bold">remove an attachment</b>, either select it and click the <b 154 outputclass="bold">Remove</b> icon at the bottom, or right-click the attachment and 155 select the menu item. </p> 96 <p>To <b outputclass="bold">remove an attachment</b>, either select it and click the <b outputclass="bold" 97 >Remove</b> icon at the bottom, or right-click the attachment and select the menu item. </p> 156 98 </li> 157 99 </ul> 158 <p> 159 Removable media, such as CD/DVDs and floppies, can be changed 160 while the guest is running. Since the 161 <b outputclass="bold">Settings</b> window is not available 162 at that time, you can also access these settings from the 163 <b outputclass="bold">Devices</b> menu of your virtual 164 machine window. 165 </p> 100 <p>Removable media, such as CD/DVDs and floppies, can be changed while the guest is running. Since the <b 101 outputclass="bold">Settings</b> window is not available at that time, you can also access these settings from 102 the <b outputclass="bold">Devices</b> menu of your virtual machine window. </p> 166 103 </body> 167 104 -
trunk/doc/manual/en_US/dita/topics/settings-system.dita
r99016 r105289 6 6 7 7 <body> 8 <p> 9 The <b outputclass="bold">System</b> category groups 10 various settings that are related to the basic hardware that is 11 presented to the virtual machine. 12 </p> 8 <p>The <b outputclass="bold">System</b> category groups various settings that are related to the basic 9 hardware that is presented to the virtual machine. </p> 13 10 <note> 14 <p> 15 As the activation mechanism of Microsoft Windows is sensitive to 16 hardware changes, if you are changing hardware settings for a 17 Windows guest, some of these changes may trigger a request for 18 another activation with Microsoft. 19 </p> 11 <p>As the activation mechanism of Microsoft Windows is sensitive to hardware changes, if you are 12 changing hardware settings for a Windows guest, some of these changes may trigger a request for another 13 activation with Microsoft. </p> 20 14 </note> 21 <p> 22 The following tabs are available. 23 </p> 15 <p>The following tabs are available. </p> 24 16 </body> 25 17 -
trunk/doc/manual/en_US/dita/topics/shared-folders.dita
r99797 r105289 6 6 7 7 <body> 8 <p> 9 Shared folders enable you to easily exchange data between a 10 virtual machine and your host. This feature requires that the 11 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions be installed in a virtual machine 12 and is described in detail in <xref href="sharedfolders.dita#sharedfolders"/>. 13 </p> 8 <p>Shared folders enable you to easily exchange data between a virtual machine and your host. This 9 feature requires that the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions be installed in a 10 virtual machine and is described in detail in <xref href="sharedfolders.dita#sharedfolders"/>. </p> 14 11 </body> 15 12 -
trunk/doc/manual/en_US/dita/topics/snapshots-take-restore-delete.dita
r105176 r105289 86 86 </image> 87 87 </fig> 88 <p> 89 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> imposes no limits on the number of snapshots 90 you can take. The only practical limitation is disk space on 91 your host. Each snapshot stores the state of the virtual 92 machine and thus occupies some disk space. See 93 <xref href="snapshots-contents.dita#snapshots-contents"/> for details on what is 94 stored in a snapshot. 95 </p> 88 <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> imposes no limits on the number of 89 snapshots you can take. The only practical limitation is disk space on your host. Each snapshot stores the 90 state of the virtual machine and thus occupies some disk space. See <xref 91 href="snapshots-contents.dita#snapshots-contents"/> for details on what is stored in a snapshot. </p> 96 92 </li> 97 93 <li> 98 <p> 99 <b outputclass="bold">Restore a snapshot.</b> In the 100 Snapshots window, select the snapshot you have taken and 101 click <b outputclass="bold">Restore</b> in the 102 toolbar. By restoring a snapshot, you go back or forward in 103 time. The current state of the machine is lost, and the 104 machine is restored to the exact state it was in when the 105 snapshot was taken. 106 </p> 94 <p><b outputclass="bold">Restore a snapshot.</b> In the Snapshots window, select the snapshot 95 you have taken and click <b outputclass="bold">Restore</b> in the toolbar. By restoring a snapshot, you go 96 back or forward in time. The current state of the machine is lost, and the machine is restored to the exact 97 state it was in when the snapshot was taken. </p> 107 98 <note> 108 <p> 109 Restoring a snapshot will affect the virtual hard drives 110 that are connected to your VM, as the entire state of the 111 virtual hard drive will be reverted as well. This means 112 also that all files that have been created since the 113 snapshot and all other file changes <i>will be 114 lost. </i>In order to prevent such data loss while 115 still making use of the snapshot feature, it is possible 116 to add a second hard drive in 117 <i>write-through</i> mode using the 118 <userinput>VBoxManage</userinput> interface and use it to 119 store your data. As write-through hard drives are 120 <i>not</i> included in snapshots, they 121 remain unaltered when a machine is reverted. See 122 <xref href="hdimagewrites.dita#hdimagewrites"/>. 123 </p> 99 <p>Restoring a snapshot will affect the virtual hard drives that are connected to your VM, as 100 the entire state of the virtual hard drive will be reverted as well. This means also that all files that 101 have been created since the snapshot and all other file changes <i>will be lost. </i>In order to prevent 102 such data loss while still making use of the snapshot feature, it is possible to add a second hard drive in 103 <i>write-through</i> mode using the <userinput>VBoxManage</userinput> interface and use it to store your 104 data. As write-through hard drives are <i>not</i> included in snapshots, they remain unaltered when a 105 machine is reverted. See <xref href="hdimagewrites.dita#hdimagewrites"/>. </p> 124 106 </note> 125 <p> 126 To avoid losing the current state when restoring a snapshot, 127 you can create a new snapshot before the restore operation. 128 </p> 129 <p> 130 By restoring an earlier snapshot and taking more snapshots 131 from there, it is even possible to create a kind of 132 alternate reality and to switch between these different 133 histories of the virtual machine. This can result in a whole 134 tree of virtual machine snapshots. 135 </p> 107 <p>To avoid losing the current state when restoring a snapshot, you can create a new snapshot 108 before the restore operation. </p> 109 <p>By restoring an earlier snapshot and taking more snapshots from there, it is even possible to 110 create a kind of alternate reality and to switch between these different histories of the virtual machine. 111 This can result in a whole tree of virtual machine snapshots. </p> 136 112 </li> 137 113 <li> 138 <p> 139 <b outputclass="bold">Delete a snapshot.</b> This 140 does not affect the state of the virtual machine, but only 141 releases the files on disk that <ph conkeyref="vbox-conkeyref-phrases/product-name"/> used to store 142 the snapshot data, thus freeing disk space. To delete a 143 snapshot, select the snapshot name in the Snapshots window 144 and click <b outputclass="bold">Delete</b> in the 145 toolbar. Snapshots can be deleted even while a machine is 146 running. 147 </p> 114 <p><b outputclass="bold">Delete a snapshot.</b> This does not affect the state of the virtual 115 machine, but only releases the files on disk that <ph conkeyref="vbox-conkeyref-phrases/product-name"/> used 116 to store the snapshot data, thus freeing disk space. To delete a snapshot, select the snapshot name in the 117 Snapshots window and click <b outputclass="bold">Delete</b> in the toolbar. Snapshots can be deleted even 118 while a machine is running. </p> 148 119 <note> 149 <p> 150 Whereas taking and restoring snapshots are fairly quick 151 operations, deleting a snapshot can take a considerable 152 amount of time since large amounts of data may need to be 153 copied between several disk image files. Temporary disk 154 files may also need large amounts of disk space while the 155 operation is in progress. 156 </p> 120 <p>Whereas taking and restoring snapshots are fairly quick operations, deleting a snapshot 121 can take a considerable amount of time since large amounts of data may need to be copied between several 122 disk image files. Temporary disk files may also need large amounts of disk space while the operation is in 123 progress. </p> 157 124 </note> 158 <p> 159 There are some situations which cannot be handled while a VM 160 is running, and you will get an appropriate message that you 161 need to perform this snapshot deletion when the VM is shut 162 down. 163 </p> 125 <p>There are some situations which cannot be handled while a VM is running, and you will get an 126 appropriate message that you need to perform this snapshot deletion when the VM is shut down. </p> 164 127 </li> 165 128 </ol> -
trunk/doc/manual/en_US/dita/topics/snapshots.dita
r105176 r105289 6 6 7 7 <body> 8 <p> 9 With snapshots, you can save a particular state of a virtual 10 machine for later use. At any later time, you can revert to that 11 state, even though you may have changed the VM considerably since 12 then. A snapshot of a virtual machine is thus similar to a machine 13 in Saved state, but there can be many of them, and these saved 14 states are preserved. 15 </p> 8 <p>With snapshots, you can save a particular state of a virtual machine for later use. At any later time, 9 you can revert to that state, even though you may have changed the VM considerably since then. A snapshot of a 10 virtual machine is thus similar to a machine in Saved state, but there can be many of them, and these saved states 11 are preserved. </p> 16 12 <p> To see the snapshots of a virtual machine, click the machine name in <ph 17 conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. In the machine tools menu for the VM, click 18 <b outputclass="bold">Snapshots</b>. The Snapshots tool is displayed. </p>13 conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>. In the machine tools menu for the VM, click <b outputclass="bold" 14 >Snapshots</b>. The Snapshots tool is displayed. </p> 19 15 <fig id="fig-snapshots-tool"> 20 16 <title>Snapshots Tool, Showing Snapshot Properties</title> … … 28 24 </image> 29 25 </fig> 30 <p> 31 If you select multiple VMs in the machine list, all snapshots are 32 listed for each VM. 33 </p> 34 <p> 35 Until you take a snapshot of the virtual machine, the list of 36 snapshots will be empty, except for the 37 <b outputclass="bold">Current State</b> item. This item 38 represents the current point in the lifetime of the virtual 39 machine. 40 </p> 41 <p> 42 The Snapshots window includes a toolbar, enabling you to perform 43 the following snapshot operations: 44 </p> 26 <p>If you select multiple VMs in the machine list, all snapshots are listed for each VM. </p> 27 <p>Until you take a snapshot of the virtual machine, the list of snapshots will be empty, except for the 28 <b outputclass="bold">Current State</b> item. This item represents the current point in the lifetime of the 29 virtual machine. </p> 30 <p>The Snapshots window includes a toolbar, enabling you to perform the following snapshot operations: </p> 45 31 <ul> 46 32 <li> 47 <p> 48 <b outputclass="bold">Take.</b> Takes a snapshot of the 49 selected VM. See 50 <xref href="snapshots-take-restore-delete.dita#snapshots-take-restore-delete"/>. 51 </p> 33 <p><b outputclass="bold">Take.</b> Takes a snapshot of the selected VM. See <xref 34 href="snapshots-take-restore-delete.dita#snapshots-take-restore-delete"/>. </p> 52 35 </li> 53 36 <li> 54 <p> 55 <b outputclass="bold">Delete.</b> Removes a snapshot 56 from the list of snapshots. See 57 <xref href="snapshots-take-restore-delete.dita#snapshots-take-restore-delete"/>. 58 </p> 37 <p><b outputclass="bold">Delete.</b> Removes a snapshot from the list of snapshots. See <xref 38 href="snapshots-take-restore-delete.dita#snapshots-take-restore-delete"/>. </p> 59 39 </li> 60 40 <li> 61 <p> 62 <b outputclass="bold">Restore.</b> Restores the VM 63 state to be the same as the selected snapshot. See 64 <xref href="snapshots-take-restore-delete.dita#snapshots-take-restore-delete"/>. 65 </p> 41 <p><b outputclass="bold">Restore.</b> Restores the VM state to be the same as the selected 42 snapshot. See <xref href="snapshots-take-restore-delete.dita#snapshots-take-restore-delete"/>. </p> 66 43 </li> 67 44 <li> 68 <p> 69 <b outputclass="bold">Properties.</b> Displays the 70 properties for the selected snapshot. The 71 <b outputclass="bold">Attributes</b> tab is used to 72 specify a Name and Description for the snapshot. The 73 <b outputclass="bold">Information</b> tab shows VM 74 settings for the snapshot. 75 </p> 45 <p><b outputclass="bold">Properties.</b> Displays the properties for the selected snapshot. The <b 46 outputclass="bold">Attributes</b> tab is used to specify a Name and Description for the snapshot. The <b 47 outputclass="bold">Information</b> tab shows VM settings for the snapshot. </p> 76 48 </li> 77 49 <li> 78 <p> 79 <b outputclass="bold">Clone.</b> Displays the 80 <b outputclass="bold">Clone Virtual Machine</b> wizard. 81 This enables you to create a clone of the VM, based on the 82 selected snapshot. 83 </p> 50 <p><b outputclass="bold">Clone.</b> Displays the <b outputclass="bold">Clone Virtual Machine</b> 51 wizard. This enables you to create a clone of the VM, based on the selected snapshot. </p> 84 52 </li> 85 53 <li> 86 <p> 87 <b outputclass="bold">Settings.</b> Available for the 88 Current State snapshot only. Displays the 89 <b outputclass="bold">Settings</b> window for the VM, 90 enabling you to make configuration changes. 91 </p> 54 <p><b outputclass="bold">Settings.</b> Available for the Current State snapshot only. Displays the 55 <b outputclass="bold">Settings</b> window for the VM, enabling you to make configuration changes. </p> 92 56 </li> 93 57 <li> 94 <p> 95 <b outputclass="bold">Discard.</b> For a running VM, 96 discards the saved state for the VM and closes it down. 97 </p> 58 <p><b outputclass="bold">Discard.</b> For a running VM, discards the saved state for the VM and 59 closes it down. </p> 98 60 </li> 99 61 <li> 100 <p> 101 <b outputclass="bold">Start.</b> Start the VM. This 102 operation is available for the <b outputclass="bold">Current 103 State</b> item. 104 </p> 62 <p><b outputclass="bold">Start.</b> Start the VM. This operation is available for the <b 63 outputclass="bold">Current State</b> item. </p> 105 64 </li> 106 65 </ul> -
trunk/doc/manual/en_US/dita/topics/soft-keyb-custom.dita
r105176 r105289 6 6 7 7 <body> 8 <p> 9 You can use one of the supplied default keyboard layouts as the 10 starting point to create a custom keyboard layout. 11 </p> 8 <p>You can use one of the supplied default keyboard layouts as the starting point to create a custom 9 keyboard layout. </p> 12 10 <note> 13 <p> 14 To permanently save a custom keyboard layout, you must save 15 it to a file. Otherwise, any changes you make are discarded 16 when you close down the <b outputclass="bold">Soft 17 Keyboard</b> window. 18 </p> 19 <p> 20 Custom keyboard layouts that you save are stored as an XML 21 file on the host, in the <filepath>keyboardLayouts</filepath> 22 folder in the global configuration data directory. For 23 example, in 24 <filepath>$HOME/.config/VirtualBox/keyboardLayouts</filepath> 25 on a Linux host. 26 </p> 11 <p>To permanently save a custom keyboard layout, you must save it to a file. Otherwise, any changes 12 you make are discarded when you close down the <b outputclass="bold">Soft Keyboard</b> window. </p> 13 <p>Custom keyboard layouts that you save are stored as an XML file on the host, in the 14 <filepath>keyboardLayouts</filepath> folder in the global configuration data directory. For example, in 15 <filepath>$HOME/.config/VirtualBox/keyboardLayouts</filepath> on a Linux host. </p> 27 16 </note> 28 17 <ol> 29 18 <li> 30 <p> 31 Display the <b outputclass="bold">Layout List</b>. 32 </p> 33 <p> 34 Click the <b outputclass="bold">Layout List</b> icon 35 in the toolbar of the soft keyboard window. 36 </p> 19 <p>Display the <b outputclass="bold">Layout List</b>. </p> 20 <p>Click the <b outputclass="bold">Layout List</b> icon in the toolbar of the soft keyboard 21 window. </p> 37 22 </li> 38 23 <li> 39 <p> 40 Make a copy of an existing keyboard layout. 41 </p> 42 <p> 43 Highlight the required layout and click the 44 <b outputclass="bold">Copy the Selected Layout</b> 45 icon. 46 </p> 47 <p> 48 A new layout entry with a name suffix of 49 <codeph>-Copy</codeph> is created. 50 </p> 24 <p>Make a copy of an existing keyboard layout. </p> 25 <p>Highlight the required layout and click the <b outputclass="bold">Copy the Selected 26 Layout</b> icon. </p> 27 <p>A new layout entry with a name suffix of <codeph>-Copy</codeph> is created. </p> 51 28 </li> 52 29 <li> 53 <p> 54 Edit the new keyboard layout. 55 </p> 56 <p> 57 Highlight the new layout in the <b outputclass="bold">Layout 58 List</b> and click the <b outputclass="bold">Edit the 59 Selected Layout</b> icon. 60 </p> 61 <p> 62 Enter a new name for the layout. 63 </p> 64 <p> Edit keys in the new layout. Click the key that you want to edit and 65 enter new key captions in the <b outputclass="bold">Captions</b> fields. </p> 66 <p> 67 The keyboard graphic is updated with the new captions. 68 </p> 30 <p>Edit the new keyboard layout. </p> 31 <p>Highlight the new layout in the <b outputclass="bold">Layout List</b> and click the <b 32 outputclass="bold">Edit the Selected Layout</b> icon. </p> 33 <p>Enter a new name for the layout. </p> 34 <p>Edit keys in the new layout. Click the key that you want to edit and enter new key captions 35 in the <b outputclass="bold">Captions</b> fields. </p> 36 <p>The keyboard graphic is updated with the new captions. </p> 69 37 </li> 70 38 <li> 71 <p> 72 (Optional) Save the layout to a file. This means that your 73 custom keyboard layout will be available for future use. 74 </p> 75 <p> 76 Highlight the new layout in the <b outputclass="bold">Layout 77 List</b> and click the <b outputclass="bold">Save the 78 Selected Layout into File</b> icon. 79 </p> 80 <p> 81 Any custom layouts that you create can later be removed from 82 the Layout List, by highlighting and clicking the 83 <b outputclass="bold">Delete the Selected Layout</b> 84 icon. 85 </p> 39 <p>(Optional) Save the layout to a file. This means that your custom keyboard layout will be 40 available for future use. </p> 41 <p>Highlight the new layout in the <b outputclass="bold">Layout List</b> and click the <b 42 outputclass="bold">Save the Selected Layout into File</b> icon. </p> 43 <p>Any custom layouts that you create can later be removed from the Layout List, by highlighting 44 and clicking the <b outputclass="bold">Delete the Selected Layout</b> icon. </p> 86 45 </li> 87 46 </ol> -
trunk/doc/manual/en_US/dita/topics/soft-keyb-using.dita
r99016 r105289 8 8 <ol> 9 9 <li> 10 <p> 11 Display the soft keyboard. 12 </p> 13 <p> 14 In the guest VM window, select 15 <b outputclass="bold">Input</b>, 16 <b outputclass="bold">Keyboard</b>, 17 <b outputclass="bold">Soft Keyboard</b>. 18 </p> 10 <p>Display the soft keyboard. </p> 11 <p>In the guest VM window, select <b outputclass="bold">Input</b>, <b outputclass="bold" 12 >Keyboard</b>, <b outputclass="bold">Soft Keyboard</b>. </p> 19 13 </li> 20 14 <li> 21 <p> 22 Select the required keyboard layout. 23 </p> 24 <p> 25 The name of the current keyboard layout is displayed in the 26 toolbar of the soft keyboard window. This is the previous 27 keyboard layout that was used. 28 </p> 29 <p> 30 Click the <b outputclass="bold">Layout List</b> icon 31 in the toolbar of the soft keyboard window. The 32 <b outputclass="bold">Layout List</b> window is 33 displayed. 34 </p> 35 <p> 36 Select the required keyboard layout from the entries in the 37 <b outputclass="bold">Layout List</b> window. 38 </p> 39 <p> 40 The keyboard display graphic is updated to show the 41 available input keys. 42 </p> 15 <p>Select the required keyboard layout. </p> 16 <p>The name of the current keyboard layout is displayed in the toolbar of the soft keyboard 17 window. This is the previous keyboard layout that was used. </p> 18 <p>Click the <b outputclass="bold">Layout List</b> icon in the toolbar of the soft keyboard 19 window. The <b outputclass="bold">Layout List</b> window is displayed. </p> 20 <p>Select the required keyboard layout from the entries in the <b outputclass="bold">Layout 21 List</b> window. </p> 22 <p>The keyboard display graphic is updated to show the available input keys. </p> 43 23 </li> 44 24 <li> 45 <p> 46 Use the soft keyboard to enter keyboard characters on the 47 guest. 48 </p> 25 <p>Use the soft keyboard to enter keyboard characters on the guest. </p> 49 26 <ul> 50 27 <li> 51 <p> 52 Modifier keys such as Shift, Ctrl, and Alt are available 53 on the soft keyboard. Click once to select the modifier 54 key, click twice to lock the modifier key. 55 </p> 56 <p> 57 The <b outputclass="bold">Reset the Keyboard and Release 58 All Keys</b> icon can be used to release all 59 pressed modifier keys, both on the host and the guest. 60 </p> 28 <p>Modifier keys such as Shift, Ctrl, and Alt are available on the soft keyboard. Click 29 once to select the modifier key, click twice to lock the modifier key. </p> 30 <p>The <b outputclass="bold">Reset the Keyboard and Release All Keys</b> icon can be used 31 to release all pressed modifier keys, both on the host and the guest. </p> 61 32 </li> 62 33 <li> 63 <p> 64 To change the look of the soft keyboard, click the 65 <b outputclass="bold">Settings</b> icon in the 66 toolbar. You can change colors used in the keyboard 67 graphic, and can hide or show sections of the keyboard, 68 such as the NumPad or multimedia keys. 69 </p> 34 <p>To change the look of the soft keyboard, click the <b outputclass="bold">Settings</b> 35 icon in the toolbar. You can change colors used in the keyboard graphic, and can hide or show sections of 36 the keyboard, such as the NumPad or multimedia keys. </p> 70 37 </li> 71 38 </ul> -
trunk/doc/manual/en_US/dita/topics/soft-keyb.dita
r105134 r105289 7 7 <title>Soft Keyboard</title> 8 8 <body> 9 <p> 10 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> provides a <i>soft keyboard</i> that 11 enables you to input keyboard characters on the guest. A soft 12 keyboard is an on-screen keyboard that can be used as an 13 alternative to a physical keyboard. See 14 <xref href="soft-keyb-using.dita#soft-keyb-using"/> for details of how to use the 15 soft keyboard. 16 </p> 9 <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> provides a <i>soft keyboard</i> that enables you to input 10 keyboard characters on the guest. A soft keyboard is an on-screen keyboard that can be used as an alternative to a 11 physical keyboard. See <xref href="soft-keyb-using.dita#soft-keyb-using"/> for details of how to use the soft 12 keyboard. </p> 17 13 <note type="caution"> 18 <p> 19 For best results, ensure that the keyboard layout configured on 20 the guest OS matches the keyboard layout used by the soft 21 keyboard. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> does not do this automatically. 22 </p> 14 <p>For best results, ensure that the keyboard layout configured on the guest OS matches the keyboard layout used 15 by the soft keyboard. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> does not do this automatically. </p> 23 16 </note> 24 17 <fig id="fig-soft-keyb"> … … 33 26 </image> 34 27 </fig> 35 <p> 36 The soft keyboard can be used in the following scenarios: 37 </p> 28 <p>The soft keyboard can be used in the following scenarios: </p> 38 29 <ul> 39 30 <li> 40 <p> 41 When the physical keyboard on the host is not the same as the 42 keyboard layout configured on the guest. For example, if the 43 guest is configured to use an international keyboard, but the 44 host keyboard is US English. 45 </p> 31 <p>When the physical keyboard on the host is not the same as the keyboard layout configured on the guest. For 32 example, if the guest is configured to use an international keyboard, but the host keyboard is US English. </p> 46 33 </li> 47 34 <li> 48 <p> 49 To send special key combinations to the guest. Note that some 50 common key combinations are also available in the 51 <b outputclass="bold">Input</b>, 52 <b outputclass="bold">Keyboard</b> menu of the guest VM 53 window. See <xref href="specialcharacters.dita#specialcharacters"/>. 54 </p> 35 <p>To send special key combinations to the guest. Note that some common key combinations are also available in 36 the <b outputclass="bold">Input</b>, <b outputclass="bold">Keyboard</b> menu of the guest VM window. See <xref 37 href="specialcharacters.dita#specialcharacters"/>. </p> 55 38 </li> 56 39 <li> 57 <p> 58 For guests in kiosk mode, where a physical keyboard is not 59 present. 60 </p> 40 <p>For guests in kiosk mode, where a physical keyboard is not present. </p> 61 41 </li> 62 42 <li> 63 <p> 64 When using nested virtualization, the soft keyboard provides a 65 method of sending key presses to a guest. 66 </p> 43 <p>When using nested virtualization, the soft keyboard provides a method of sending key presses to a guest. </p> 67 44 </li> 68 45 </ul> 69 <p> 70 By default, the soft keyboard includes some common international 71 keyboard layouts. You can copy and modify these to meet your own 72 requirements. See <xref href="soft-keyb-custom.dita#soft-keyb-custom"/>. 73 </p> 46 <p>By default, the soft keyboard includes some common international keyboard layouts. You can copy and modify these 47 to meet your own requirements. See <xref href="soft-keyb-custom.dita#soft-keyb-custom"/>. </p> 74 48 </body> 75 49 -
trunk/doc/manual/en_US/dita/topics/solaris-zones.dita
r105134 r105289 6 6 7 7 <body> 8 <p> 9 After installing <ph conkeyref="vbox-conkeyref-phrases/product-name"/> in the global zone 10 (see <xref href="install-solaris-host.dita#install-solaris-host"/> for the installation instructions) 11 the first step required to run <ph conkeyref="vbox-conkeyref-phrases/product-name"/> in a 12 non-global zone is to modify the zone's configuration to be able to access the 13 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> device nodes located in the global zone. 14 This is done by performing the following steps as a zone administrator in the global zone. 15 </p> 8 <p>After installing <ph conkeyref="vbox-conkeyref-phrases/product-name"/> in the global zone (see 9 <xref href="install-solaris-host.dita#install-solaris-host"/> for the installation instructions) the first step 10 required to run <ph conkeyref="vbox-conkeyref-phrases/product-name"/> in a non-global zone is to modify the zone's 11 configuration to be able to access the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> device nodes located 12 in the global zone. This is done by performing the following steps as a zone administrator in the global zone. </p> 16 13 <pre xml:space="preserve">global$ zonecfg -z <varname>vboxzone</varname> 17 14 </pre> 18 <p> 19 Replace <varname>vboxzone</varname> with the name of the 20 non-gloabl zone where you plan to run <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. 21 </p> 22 <p> 23 Use <userinput>zonecfg(8)</userinput> to add the 24 <codeph>device</codeph> resource 25 and the <codeph>match</codeph> property for each 26 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> device node in the global 27 zone to the non-global zone as follows: 28 </p> 15 <p>Replace <varname>vboxzone</varname> with the name of the non-gloabl zone where you plan to run <ph 16 conkeyref="vbox-conkeyref-phrases/product-name"/>. </p> 17 <p>Use <userinput>zonecfg(8)</userinput> to add the <codeph>device</codeph> resource and the 18 <codeph>match</codeph> property for each <ph conkeyref="vbox-conkeyref-phrases/product-name"/> device node in 19 the global zone to the non-global zone as follows: </p> 29 20 <pre xml:space="preserve">zonecfg:vboxzone> add device 30 21 zonecfg:vboxzone:device> set match=/dev/vboxdrv … … 34 25 zonecfg:vboxzone:device> end 35 26 zonecfg:vboxzone> exit</pre> 36 <p> 37 On Oracle Solaris 11 if you plan to use VMs configured to use a USB device, e.g. a USB 38 pointing device or a USB pass-through device, you should also pass through the 39 <filepath>/dev/vboxusbmon</filepath> device using the steps above. 40 </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> 27 <p>On Oracle Solaris 11 if you plan to use VMs configured to use a USB device, e.g. a USB pointing 28 device or a USB pass-through device, you should also pass through the <filepath>/dev/vboxusbmon</filepath> device 29 using the steps above. </p> 30 <p>Oracle Solaris 11 does not support sparse root zones so you will need to loopback mount 31 <filepath>/opt/VirtualBox</filepath> from the global zone into the non-global zone at the same path. This is 32 done using <userinput>zonecfg(8)</userinput> to set the <codeph>dir</codeph> attribute and the 33 <codeph>special</codeph> attribute for this directory. For example: </p> 46 34 <pre xml:space="preserve">zonecfg:vboxzone> add fs 47 35 zonecfg:vboxzone:fs> set dir=/opt/VirtualBox … … 51 39 zonecfg:vboxzone:fs> end 52 40 zonecfg:vboxzone> exit</pre> 53 <p> 54 After making the above changes using <userinput>zonecfg(8)</userinput>, reboot the zone 55 using <userinput>zoneadm(8)</userinput> as follows: 56 </p> 41 <p>After making the above changes using <userinput>zonecfg(8)</userinput>, reboot the zone using 42 <userinput>zoneadm(8)</userinput> as follows: </p> 57 43 <pre xml:space="preserve">global$ zoneadm -z <varname>vboxzone</varname> reboot 58 44 </pre> 59 <p> 60 for the changes to take effect. You will then be able to run 61 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> from /opt/VirtualBox within the 62 configured non-global zone. 63 </p> 45 <p>for the changes to take effect. You will then be able to run <ph 46 conkeyref="vbox-conkeyref-phrases/product-name"/> from /opt/VirtualBox within the configured non-global zone. </p> 64 47 </body> 65 48 -
trunk/doc/manual/en_US/dita/topics/specialcharacters.dita
r99797 r105289 6 6 7 7 <body> 8 <p> 9 Some OSes expect certain key combinations to initiate certain 10 procedures. The key combinations that you type into a VM might 11 target the host OS, the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> software, or the guest 12 OS. The recipient of these keypresses depends on a number of 13 factors, including the key combination itself. 14 </p> 8 <p>Some OSes expect certain key combinations to initiate certain procedures. The key combinations that 9 you type into a VM might target the host OS, the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> software, 10 or the guest OS. The recipient of these keypresses depends on a number of factors, including the key combination 11 itself. </p> 15 12 <ul> 16 13 <li> 17 <p> 18 Host OSes reserve certain key combinations for themselves. 19 For example, you cannot use the 20 <b outputclass="bold">Ctrl+Alt+Delete</b> combination 21 to reboot the guest OS in your VM, because this key 22 combination is reserved by the host OS. Even though both 23 Windows and Linux OSes can intercept this key combination, 24 the host OS is rebooted automatically. 25 </p> 26 <p> 27 On Linux and Oracle Solaris hosts, which use the X Window 28 System, the key combination 29 <b outputclass="bold">Ctrl+Alt+Backspace</b> normally 30 resets the X server and restarts the entire graphical user 31 interface. As the X server intercepts this combination, 32 pressing it will usually restart your 33 <i>host</i> graphical user interface and kill 34 all running programs, including <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, in the 35 process. 36 </p> 37 <p> 38 On Linux hosts supporting virtual terminals, the key 39 combination <b outputclass="bold">Ctrl+Alt+Fx</b>, 40 where Fx is one of the function keys from F1 to F12, 41 normally enables you to switch between virtual terminals. As 42 with <b outputclass="bold">Ctrl+Alt+Delete</b>, these 43 combinations are intercepted by the host OS and therefore 44 always switch terminals on the <i>host</i>. 45 </p> 46 <p> 47 If, instead, you want to send these key combinations to the 48 <i>guest</i> OS in the virtual machine, you 49 will need to use one of the following methods: 50 </p> 14 <p>Host OSes reserve certain key combinations for themselves. For example, you cannot use the <b 15 outputclass="bold">Ctrl+Alt+Delete</b> combination to reboot the guest OS in your VM, because this key 16 combination is reserved by the host OS. Even though both Windows and Linux OSes can intercept this key 17 combination, the host OS is rebooted automatically. </p> 18 <p>On Linux and Oracle Solaris hosts, which use the X Window System, the key combination <b 19 outputclass="bold">Ctrl+Alt+Backspace</b> normally resets the X server and restarts the entire graphical 20 user interface. As the X server intercepts this combination, pressing it will usually restart your <i>host</i> 21 graphical user interface and kill all running programs, including <ph 22 conkeyref="vbox-conkeyref-phrases/product-name"/>, in the process. </p> 23 <p>On Linux hosts supporting virtual terminals, the key combination <b outputclass="bold" 24 >Ctrl+Alt+Fx</b>, where Fx is one of the function keys from F1 to F12, normally enables you to switch 25 between virtual terminals. As with <b outputclass="bold">Ctrl+Alt+Delete</b>, these combinations are 26 intercepted by the host OS and therefore always switch terminals on the <i>host</i>. </p> 27 <p>If, instead, you want to send these key combinations to the <i>guest</i> OS in the virtual 28 machine, you will need to use one of the following methods: </p> 51 29 <ul> 52 30 <li> 53 <p> 54 Use the items in the 55 <b outputclass="bold">Input</b>, 56 <b outputclass="bold">Keyboard</b> menu of the 57 virtual machine window. This menu includes the settings 58 <b outputclass="bold">Insert Ctrl+Alt+Delete</b> 59 and <b outputclass="bold">Insert 60 Ctrl+Alt+Backspace</b>. However, the latter 61 setting affects only Linux guests or Oracle Solaris 62 guests. 63 </p> 64 <p> 65 This menu also includes an option for inserting the Host 66 key combination. 67 </p> 31 <p>Use the items in the <b outputclass="bold">Input</b>, <b outputclass="bold" 32 >Keyboard</b> menu of the virtual machine window. This menu includes the settings <b outputclass="bold" 33 >Insert Ctrl+Alt+Delete</b> and <b outputclass="bold">Insert Ctrl+Alt+Backspace</b>. However, the latter 34 setting affects only Linux guests or Oracle Solaris guests. </p> 35 <p>This menu also includes an option for inserting the Host key combination. </p> 68 36 </li> 69 37 <li> 70 <p> 71 Use special key combinations with the Host key, which is 72 normally the right Control key. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> then 73 translates the following key combinations for the VM: 74 </p> 38 <p>Use special key combinations with the Host key, which is normally the right Control 39 key. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> then translates the following key combinations 40 for the VM: </p> 75 41 <ul> 76 42 <li> 77 <p> 78 <b outputclass="bold">Host key + Del</b> 79 sends <b outputclass="bold">Ctrl+Alt+Del</b> 80 to reboot the guest OS. 81 </p> 43 <p><b outputclass="bold">Host key + Del</b> sends <b outputclass="bold" 44 >Ctrl+Alt+Del</b> to reboot the guest OS. </p> 82 45 </li> 83 46 <li> 84 <p> 85 <b outputclass="bold">Host key + 86 Backspace</b> sends 87 <b outputclass="bold">Ctrl+Alt+Backspace</b> 88 to restart the graphical user interface of a Linux 89 or Oracle Solaris guest. 90 </p> 47 <p><b outputclass="bold">Host key + Backspace</b> sends <b outputclass="bold" 48 >Ctrl+Alt+Backspace</b> to restart the graphical user interface of a Linux or Oracle Solaris guest. </p> 91 49 </li> 92 50 <li> 93 <p> 94 <b outputclass="bold">Host key + Function 95 key</b>. For example, use this key 96 combination to simulate 97 <b outputclass="bold">Ctrl+Alt+Fx</b> to 98 switch between virtual terminals in a Linux guest. 99 </p> 51 <p><b outputclass="bold">Host key + Function key</b>. For example, use this key 52 combination to simulate <b outputclass="bold">Ctrl+Alt+Fx</b> to switch between virtual terminals in a 53 Linux guest. </p> 100 54 </li> 101 55 </ul> … … 104 58 </li> 105 59 <li> 106 <p> 107 For some other keyboard combinations such as 108 <b outputclass="bold">Alt+Tab</b> to switch between 109 open windows, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> enables you to configure 110 whether these combinations will affect the host or the 111 guest, if a virtual machine currently has the focus. This is 112 a global setting for all virtual machines and can be found 113 under <b outputclass="bold">File</b>, 114 <b outputclass="bold">Preferences</b>, 115 <b outputclass="bold">Input</b>. 116 </p> 60 <p>For some other keyboard combinations such as <b outputclass="bold">Alt+Tab</b> to switch 61 between open windows, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> enables you to configure whether 62 these combinations will affect the host or the guest, if a virtual machine currently has the focus. This is a 63 global setting for all virtual machines and can be found under <b outputclass="bold">File</b>, <b 64 outputclass="bold">Preferences</b>, <b outputclass="bold">Input</b>. </p> 117 65 </li> 118 66 <li> 119 <p> 120 A soft keyboard can be used to input key combinations in the 121 guest. See <xref href="soft-keyb.dita#soft-keyb"/>. 122 </p> 67 <p>A soft keyboard can be used to input key combinations in the guest. See <xref 68 href="soft-keyb.dita#soft-keyb"/>. </p> 123 69 </li> 124 70 </ul> -
trunk/doc/manual/en_US/dita/topics/startingvboxonlinux.dita
r105134 r105289 6 6 7 7 <body> 8 <p> 9 The easiest way to start an <ph conkeyref="vbox-conkeyref-phrases/product-name"/> program is by running 10 the program of your choice (<userinput>VirtualBox</userinput>, 11 <userinput>VBoxManage</userinput>, or 12 <userinput>VBoxHeadless</userinput>) from a terminal. These are 13 symbolic links to <userinput>VBox.sh</userinput> that start the 14 required program for you. 15 </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> 28 <p> 29 All <ph conkeyref="vbox-conkeyref-phrases/product-name"/> applications (<userinput>VirtualBox</userinput>, 30 <userinput>VBoxManage</userinput>, and 31 <userinput>VBoxHeadless</userinput>) require the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 32 directory to be in the library path, as follows: 33 </p> 8 <p>The easiest way to start an <ph conkeyref="vbox-conkeyref-phrases/product-name"/> program is by 9 running the program of your choice (<userinput>VirtualBox</userinput>, <userinput>VBoxManage</userinput>, or 10 <userinput>VBoxHeadless</userinput>) from a terminal. These are symbolic links to <userinput>VBox.sh</userinput> 11 that start the required program for you. </p> 12 <p>The following detailed instructions should only be of interest if you want to execute <ph 13 conkeyref="vbox-conkeyref-phrases/product-name"/> without installing it first. You should start by compiling the 14 <userinput>vboxdrv</userinput> kernel module and inserting it into the Linux kernel. <ph 15 conkeyref="vbox-conkeyref-phrases/product-name"/> consists of a service daemon, <userinput>VBoxSVC</userinput>, 16 and several application programs. The daemon is automatically started if necessary. All <ph 17 conkeyref="vbox-conkeyref-phrases/product-name"/> applications will communicate with the daemon through UNIX 18 local domain sockets. There can be multiple daemon instances under different user accounts and applications can 19 only communicate with the daemon running under the user account as the application. The local domain socket 20 resides in a subdirectory of your system's directory for temporary files called 21 <filepath>.vbox-<username>-ipc</filepath>. In case of communication problems or server startup problems, 22 you may try to remove this directory. </p> 23 <p>All <ph conkeyref="vbox-conkeyref-phrases/product-name"/> applications 24 (<userinput>VirtualBox</userinput>, <userinput>VBoxManage</userinput>, and <userinput>VBoxHeadless</userinput>) 25 require the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> directory to be in the library path, as follows: </p> 34 26 <pre xml:space="preserve">LD_LIBRARY_PATH=. ./VBoxManage showvminfo "Windows XP"</pre> 35 27 </body> -
trunk/doc/manual/en_US/dita/topics/ui-experience-level.dita
r105166 r105289 4 4 <title>Experience Levels for VirtualBox Manager</title> 5 5 <body> 6 <p> When you use <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> to configure settings for virtual 7 machines, you can select an <i>experience level</i> for the user interface. The following 8 experience levels are available:</p> 6 <p>When you use <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> to configure settings for virtual machines, you 7 can select an <i>experience level</i> for the user interface. The following experience levels are available:</p> 9 8 <ul> 10 9 <li> -
trunk/doc/manual/en_US/dita/topics/unattended-guest-install-example.dita
r105134 r105289 3 3 PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd"> 4 4 <topic xml:lang="en-us" id="unattended-guest-install-example"> 5 <title>Using VBoxManage Commands for Unattended Guest Installation</title> 5 <title>Using VBoxManage Commands for Unattended Guest Installation</title> 6 6 <body> 7 <p> 8 The following example shows how to perform an unattended guest 9 installation for an Oracle Linux VM. The example uses various 10 <userinput>VBoxManage</userinput> commands to prepare the guest VM. 11 The <userinput>VBoxManage unattended install</userinput> command is 12 then used to install and configure the guest OS. 13 </p> 7 <p>The following example shows how to perform an unattended guest installation for an Oracle Linux VM. 8 The example uses various <userinput>VBoxManage</userinput> commands to prepare the guest VM. The 9 <userinput>VBoxManage unattended install</userinput> command is then used to install and configure the guest OS. </p> 14 10 <ol> 15 11 <li> 16 <p> 17 Create the virtual machine. 18 </p> 12 <p>Create the virtual machine. </p> 19 13 <pre xml:space="preserve"># VM="ol7-autoinstall" 20 14 # VBoxManage list ostypes 21 15 # VBoxManage createvm --name $VM --ostype "Oracle_64" --register</pre> 22 <p> 23 Note the following: 24 </p> 16 <p>Note the following: </p> 25 17 <ul> 26 18 <li> 27 <p> 28 The $VM variable represents the name of the VM. 29 </p> 19 <p>The $VM variable represents the name of the VM. </p> 30 20 </li> 31 21 <li> 32 <p> 33 The <userinput>VBoxManage list ostypes</userinput> command 34 lists the guest OSes supported by <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, 35 including the name used for each OS in the 36 <userinput>VBoxManage</userinput> commands. 37 </p> 22 <p>The <userinput>VBoxManage list ostypes</userinput> command lists the guest OSes 23 supported by <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, including the name used for each OS in 24 the <userinput>VBoxManage</userinput> commands. </p> 38 25 </li> 39 26 <li> 40 <p> 41 A 64-bit Oracle Linux 7 VM is created and registered 42 with <ph conkeyref="vbox-conkeyref-phrases/product-name"/>. 43 </p> 27 <p>A 64-bit Oracle Linux 7 VM is created and registered with <ph 28 conkeyref="vbox-conkeyref-phrases/product-name"/>. </p> 44 29 </li> 45 30 <li> 46 <p> 47 The VM has a unique UUID. 48 </p> 31 <p>The VM has a unique UUID. </p> 49 32 </li> 50 33 <li> 51 <p> 52 An XML settings file is generated. 53 </p> 34 <p>An XML settings file is generated. </p> 54 35 </li> 55 36 </ul> 56 37 </li> 57 38 <li> 58 <p> 59 Create a virtual hard disk and storage devices for the VM. 60 </p> 39 <p>Create a virtual hard disk and storage devices for the VM. </p> 61 40 <pre xml:space="preserve"># VBoxManage createhd --filename /VirtualBox/$VM/$VM.vdi --size 32768 62 41 # VBoxManage storagectl $VM --name "SATA Controller" --add sata --controller IntelAHCI … … 66 45 # VBoxManage storageattach $VM --storagectl "IDE Controller" --port 0 --device 0 \ 67 46 --type dvddrive --medium /u01/Software/OL/OracleLinux-R7-U6-Server-x86_64-dvd.iso</pre> 68 <p> 69 The previous commands do the following: 70 </p> 47 <p>The previous commands do the following: </p> 71 48 <ul> 72 49 <li> 73 <p> 74 Create a 32768 MB virtual hard disk. 75 </p> 50 <p>Create a 32768 MB virtual hard disk. </p> 76 51 </li> 77 52 <li> 78 <p> 79 Create a SATA storage controller and attach the virtual 80 hard disk. 81 </p> 53 <p>Create a SATA storage controller and attach the virtual hard disk. </p> 82 54 </li> 83 55 <li> 84 <p> 85 Create an IDE storage controller for a virtual DVD drive 86 and attach an Oracle Linux installation ISO. 87 </p> 56 <p>Create an IDE storage controller for a virtual DVD drive and attach an Oracle Linux 57 installation ISO. </p> 88 58 </li> 89 59 </ul> 90 60 </li> 91 61 <li> 92 <p> 93 (Optional) Configure some settings for the VM. 94 </p> 62 <p>(Optional) Configure some settings for the VM. </p> 95 63 <pre xml:space="preserve"># VBoxManage modifyvm $VM --ioapic on 96 64 # VBoxManage modifyvm $VM --boot1 dvd --boot2 disk --boot3 none --boot4 none 97 65 # VBoxManage modifyvm $VM --memory 8192 --vram 128</pre> 98 <p> 99 The previous commands do the following: 100 </p> 66 <p>The previous commands do the following: </p> 101 67 <ul> 102 68 <li> 103 <p> 104 Enable I/O APIC for the motherboard of the VM. 105 </p> 69 <p>Enable I/O APIC for the motherboard of the VM. </p> 106 70 </li> 107 71 <li> 108 <p> 109 Configure the boot device order for the VM. 110 </p> 72 <p>Configure the boot device order for the VM. </p> 111 73 </li> 112 74 <li> 113 <p> 114 Allocate 8192 MB of RAM and 128 MB of video RAM to the 115 VM. 116 </p> 75 <p>Allocate 8192 MB of RAM and 128 MB of video RAM to the VM. </p> 117 76 </li> 118 77 </ul> 119 78 </li> 120 79 <li> 121 <p> 122 Perform an unattended install of the OS. 123 </p> 80 <p>Perform an unattended install of the OS. </p> 124 81 <pre xml:space="preserve"># VBoxManage unattended install $VM \ 125 82 --iso=/u01/Software/OL/OracleLinux-R7-U6-Server-x86_64-dvd.iso \ 126 83 --user=<varname>login</varname> --full-user-name=<varname>name</varname> --user-password <varname>password</varname> \ 127 84 --install-additions --time-zone=CET</pre> 128 <p> 129 The previous command does the following: 130 </p> 85 <p>The previous command does the following: </p> 131 86 <ul> 132 87 <li> 133 <p> 134 Specifies an Oracle Linux ISO as the installation ISO. 135 </p> 88 <p>Specifies an Oracle Linux ISO as the installation ISO. </p> 136 89 </li> 137 90 <li> 138 <p> 139 Specifies a login name, full name, and login password 140 for a default user on the guest OS. 141 </p> 142 <p> 143 Note that the specified password is also used for the 144 root user account on the guest. 145 </p> 91 <p>Specifies a login name, full name, and login password for a default user on the guest 92 OS. </p> 93 <p>Note that the specified password is also used for the root user account on the guest. </p> 146 94 </li> 147 95 <li> 148 <p> 149 Installs the Guest Additions on the VM. 150 </p> 96 <p>Installs the Guest Additions on the VM. </p> 151 97 </li> 152 98 <li> 153 <p> 154 Sets the time zone for the guest OS to Central European 155 Time (CET). 156 </p> 99 <p>Sets the time zone for the guest OS to Central European Time (CET). </p> 157 100 </li> 158 101 </ul> 159 102 </li> 160 103 <li> 161 <p> 162 Start the virtual machine. 163 </p> 164 <p> 165 This step completes the unattended installation process. 166 </p> 104 <p>Start the virtual machine. </p> 105 <p>This step completes the unattended installation process. </p> 167 106 <pre xml:space="preserve"># VBoxManage startvm $VM --type headless</pre> 168 <p> 169 The VM starts in headless mode, which means that the 170 <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> window does not open. 171 </p> 107 <p>The VM starts in headless mode, which means that the <ph 108 conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> window does not open. </p> 172 109 </li> 173 <li> 174 <p> 175 (Optional) Update the guest OS to use the latest Oracle 176 Linux packages. 177 </p> 178 <p> 179 On the guest VM, run the following command: 180 </p> 181 <pre xml:space="preserve"># yum update</pre> 182 </li> 110 <li>(Optional) Update the guest OS to use the latest Oracle Linux packages. <p>On the guest VM, run 111 the following command: </p><pre xml:space="preserve"># yum update</pre></li> 183 112 </ol> 184 </body> 113 </body> 185 114 </topic> -
trunk/doc/manual/en_US/dita/topics/uninstall-solaris-host.dita
r99797 r105289 6 6 7 7 <body> 8 <p> 9 Uninstallation of <ph conkeyref="vbox-conkeyref-phrases/product-name"/> on Oracle Solaris requires root 10 permissions. To perform the uninstallation, start a root 11 terminal session and run the following command: 12 </p> 8 <p>Uninstallation of <ph conkeyref="vbox-conkeyref-phrases/product-name"/> on Oracle Solaris requires 9 root permissions. To perform the uninstallation, start a root terminal session and run the following command: </p> 13 10 <pre xml:space="preserve">pkgrm SUNWvbox</pre> 14 <p> 15 After confirmation, this will remove <ph conkeyref="vbox-conkeyref-phrases/product-name"/> from your 16 system. 17 </p> 11 <p>After confirmation, this will remove <ph conkeyref="vbox-conkeyref-phrases/product-name"/> from 12 your system. </p> 18 13 </body> 19 14 -
trunk/doc/manual/en_US/dita/topics/usb-implementation-notes.dita
r99797 r105289 6 6 7 7 <body> 8 <p> 9 On Windows hosts, a kernel mode device driver provides USB proxy 10 support. It implements both a USB monitor, which enables 11 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> to capture devices when they are plugged in, and 12 a USB device driver to claim USB devices for a particular 13 virtual machine. System reboots are not necessary after 14 installing the driver. Also, you do not need to replug devices 15 for <ph conkeyref="vbox-conkeyref-phrases/product-name"/> to claim them. 16 </p> 17 <p> 18 On supported Linux hosts, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> accesses USB devices 19 through special files in the file system. When <ph conkeyref="vbox-conkeyref-phrases/product-name"/> is 20 installed, these are made available to all users in the 21 <codeph>vboxusers</codeph> system group. In order to be able 22 to access USB from guest systems, make sure that you are a 23 member of this group. 24 </p> 8 <p>On Windows hosts, a kernel mode device driver provides USB proxy support. It implements both a USB 9 monitor, which enables <ph conkeyref="vbox-conkeyref-phrases/product-name"/> to capture devices when they are 10 plugged in, and a USB device driver to claim USB devices for a particular virtual machine. System reboots are not 11 necessary after installing the driver. Also, you do not need to replug devices for <ph 12 conkeyref="vbox-conkeyref-phrases/product-name"/> to claim them. </p> 13 <p>On supported Linux hosts, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> accesses USB 14 devices through special files in the file system. When <ph conkeyref="vbox-conkeyref-phrases/product-name"/> is 15 installed, these are made available to all users in the <codeph>vboxusers</codeph> system group. In order to be 16 able to access USB from guest systems, make sure that you are a member of this group. </p> 25 17 </body> 26 18 -
trunk/doc/manual/en_US/dita/topics/user-interface.dita
r99797 r105289 6 6 7 7 <body> 8 <p> 9 The <b outputclass="bold">User Interface</b> section 10 enables you to change certain aspects of the user interface of the 11 selected VM. 12 </p> 8 <p>The <b outputclass="bold">User Interface</b> section enables you to change certain aspects of the user 9 interface of the selected VM. </p> 13 10 <ul> 14 11 <li> 15 <p> 16 <b outputclass="bold">Menu Bar:</b> This widget enables 17 you to disable a complete menu, by clicking on the menu name 18 to deselect it. Menu entries can be disabled, by deselecting 19 the check box next to the entry. On Windows and Linux hosts, 20 the complete menu bar can be disabled by deselecting the check 21 box on the right. 22 </p> 12 <p><b outputclass="bold">Menu Bar:</b> This widget enables you to disable a complete menu, by 13 clicking on the menu name to deselect it. Menu entries can be disabled, by deselecting the check box next to 14 the entry. On Windows and Linux hosts, the complete menu bar can be disabled by deselecting the check box on 15 the right. </p> 23 16 </li> 24 17 <li> 25 <p> 26 <b outputclass="bold">Mini ToolBar:</b> In full screen 27 or seamless mode, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can display a small toolbar 28 that contains some of the items that are normally available 29 from the virtual machine's menu bar. This toolbar reduces 30 itself to a small gray line unless you move the mouse over it. 31 With the toolbar, you can return from full screen or seamless 32 mode, control machine execution, or enable certain devices. If 33 you do not want to see the toolbar, disable the 34 <b outputclass="bold">Show in Full Screen/Seamless</b> 35 setting. 36 </p> 37 <p> 38 The <b outputclass="bold">Show at Top of Screen</b> 39 setting enables you to show the toolbar at the top of the 40 screen, instead of showing it at the bottom. 41 </p> 42 <p> 43 The Mini Toolbar is not available on macOS hosts. 44 </p> 18 <p><b outputclass="bold">Mini ToolBar:</b> In full screen or seamless mode, <ph 19 conkeyref="vbox-conkeyref-phrases/product-name"/> can display a small toolbar that contains some of the 20 items that are normally available from the virtual machine's menu bar. This toolbar reduces itself to a small 21 gray line unless you move the mouse over it. With the toolbar, you can return from full screen or seamless 22 mode, control machine execution, or enable certain devices. If you do not want to see the toolbar, disable the 23 <b outputclass="bold">Show in Full Screen/Seamless</b> setting. </p> 24 <p>The <b outputclass="bold">Show at Top of Screen</b> setting enables you to show the toolbar at 25 the top of the screen, instead of showing it at the bottom. </p> 26 <p>The Mini Toolbar is not available on macOS hosts. </p> 45 27 </li> 46 28 <li> 47 <p> 48 <b outputclass="bold">Status Bar:</b> This widget 49 enables you to disable and reorder icons on the status bar. 50 Deselect the check box of an icon to disable it, or rearrange 51 icons by dragging and dropping the icon. To disable the 52 complete status bar deselect the check box on the left. 53 </p> 29 <p><b outputclass="bold">Status Bar:</b> This widget enables you to disable and reorder icons on 30 the status bar. Deselect the check box of an icon to disable it, or rearrange icons by dragging and dropping 31 the icon. To disable the complete status bar deselect the check box on the left. </p> 54 32 </li> 55 33 </ul> -
trunk/doc/manual/en_US/dita/topics/virtintro.dita
r99797 r105289 14 14 <ul> 15 15 <li> 16 <p> 17 <b outputclass="bold">Host operating system (host 18 OS).</b> This is the OS of the physical computer on 19 which <ph conkeyref="vbox-conkeyref-phrases/product-name"/> was installed. There are versions of 20 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> for Windows, macOS, Linux, and Oracle Solaris 21 hosts. See <xref href="hostossupport.dita#hostossupport"/>. 22 </p> 23 <p> 24 Most of the time, this manual discusses all <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 25 versions together. There may be platform-specific differences 26 which we will point out where appropriate. 27 </p> 16 <p><b outputclass="bold">Host operating system (host OS).</b> This is the OS of the physical 17 computer on which <ph conkeyref="vbox-conkeyref-phrases/product-name"/> was installed. There are versions of 18 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> for Windows, macOS, Linux, and Oracle Solaris hosts. 19 See <xref href="hostossupport.dita#hostossupport"/>. </p> 20 <p>Most of the time, this manual discusses all <ph conkeyref="vbox-conkeyref-phrases/product-name" 21 /> versions together. There may be platform-specific differences which we will point out where appropriate. </p> 28 22 </li> 29 23 <li> 30 <p> 31 <b outputclass="bold">Guest operating system (guest 32 OS).</b> This is the OS that is running inside the 33 virtual machine. Theoretically, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can run any x86 34 OS such as DOS, Windows, OS/2, FreeBSD, and OpenBSD. But to 35 achieve near-native performance of the guest code on your 36 machine, we had to go through a lot of optimizations that are 37 specific to certain OSes. So while your favorite OS 38 <i>may</i> run as a guest, we officially support 39 and optimize for a select few, which include the most common 40 OSes. 41 </p> 42 <p> 43 See <xref href="guestossupport.dita#guestossupport"/>. 44 </p> 24 <p><b outputclass="bold">Guest operating system (guest OS).</b> This is the OS that is running 25 inside the virtual machine. Theoretically, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can run any 26 x86 OS such as DOS, Windows, OS/2, FreeBSD, and OpenBSD. But to achieve near-native performance of the guest 27 code on your machine, we had to go through a lot of optimizations that are specific to certain OSes. So while 28 your favorite OS <i>may</i> run as a guest, we officially support and optimize for a select few, which include 29 the most common OSes. </p> 30 <p>See <xref href="guestossupport.dita#guestossupport"/>. </p> 45 31 </li> 46 32 <li> 47 <p> 48 <b outputclass="bold">Virtual machine (VM).</b> This is 49 the special environment that <ph conkeyref="vbox-conkeyref-phrases/product-name"/> creates for your 50 guest OS while it is running. In other words, you run your 51 guest OS <i>in</i> a VM. Normally, a VM is shown 52 as a window on your computer's desktop. Depending on which of 53 the various frontends of <ph conkeyref="vbox-conkeyref-phrases/product-name"/> you use, the VM might 54 be shown in full screen mode or remotely on another computer. 55 </p> 56 <p> 57 Internally, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> treats a VM as a set of parameters 58 that specify its behavior. Some parameters describe hardware 59 settings, such as the amount of memory and number of CPUs 60 assigned. Other parameters describe the state information, 61 such as whether the VM is running or saved. 62 </p> 63 <p> 64 You can view these VM settings in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>, in the 65 <b outputclass="bold">Settings</b> window, and by 66 running the <userinput>VBoxManage</userinput> command. See 67 <xref href="vboxmanage.dita#vboxmanage"/>. 68 </p> 33 <p><b outputclass="bold">Virtual machine (VM).</b> This is the special environment that <ph 34 conkeyref="vbox-conkeyref-phrases/product-name"/> creates for your guest OS while it is running. In other 35 words, you run your guest OS <i>in</i> a VM. Normally, a VM is shown as a window on your computer's desktop. 36 Depending on which of the various frontends of <ph conkeyref="vbox-conkeyref-phrases/product-name"/> you use, 37 the VM might be shown in full screen mode or remotely on another computer. </p> 38 <p>Internally, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> treats a VM as a set of 39 parameters that specify its behavior. Some parameters describe hardware settings, such as the amount of memory 40 and number of CPUs assigned. Other parameters describe the state information, such as whether the VM is 41 running or saved. </p> 42 <p>You can view these VM settings in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>, in the <b 43 outputclass="bold">Settings</b> window, and by running the <userinput>VBoxManage</userinput> command. See 44 <xref href="vboxmanage.dita#vboxmanage"/>. </p> 69 45 </li> 70 46 <li> 71 <p> 72 <b outputclass="bold">Guest Additions.</b> This refers 73 to special software packages which are shipped with 74 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> but designed to be installed 75 <i>inside</i> a VM to improve performance of the 76 guest OS and to add extra features. See 77 <xref href="guestadditions.dita#guestadditions"/>. 78 </p> 47 <p><b outputclass="bold">Guest Additions.</b> This refers to special software packages which are 48 shipped with <ph conkeyref="vbox-conkeyref-phrases/product-name"/> but designed to be installed <i>inside</i> 49 a VM to improve performance of the guest OS and to add extra features. See <xref 50 href="guestadditions.dita#guestadditions"/>. </p> 79 51 </li> 80 52 </ul> -
trunk/doc/manual/en_US/dita/topics/vm-activity-overview.dita
r105176 r105289 6 6 <title>VM Activity Overview</title> 7 7 <body> 8 <p> 9 The VM Activity Overview tool displays several performance 10 metrics for all running virtual machines and cloud VM instances, and for the host 11 system. This provides an overview of system resources used by 12 individual virtual machines and the host system. 13 </p> 14 <p> 15 To display the VM Activity Overview tool, do the following: 16 </p> 17 <p> 18 Go to the global <b outputclass="bold">Tools</b> menu and 19 click <b outputclass="bold">Activities</b>. The 20 <b outputclass="bold">VM Activity Overview</b> window is 21 shown. 22 </p> 8 <p>The VM Activity Overview tool displays several performance metrics for all running virtual machines 9 and cloud VM instances, and for the host system. This provides an overview of system resources used by individual 10 virtual machines and the host system. </p> 11 <p>To display the VM Activity Overview tool, do the following: </p> 12 <p>Go to the global <b outputclass="bold">Tools</b> menu and click <b outputclass="bold" 13 >Activities</b>. The <b outputclass="bold">VM Activity Overview</b> window is shown. </p> 23 14 <fig id="fig-vm-activity-overview-widget"> 24 15 <title>VM Activity Overview Tool</title> … … 32 23 </image> 33 24 </fig> 34 <p> 35 To show metrics for <i>all</i> virtual machines, 36 including those that are not running, right-click the list of 37 virtual machines and select <b outputclass="bold">List All 38 Virtual Machines</b>. 39 </p> 25 <p>To show metrics for <i>all</i> virtual machines, including those that are not running, right-click 26 the list of virtual machines and select <b outputclass="bold">List All Virtual Machines</b>. </p> 40 27 <p>To show metrics for cloud VMs, right-click the list of virtual machines and select <b 41 28 outputclass="bold">Show Cloud Virtual Machines</b>. </p> 42 <p> 43 To configure the set of metrics to be shown, click 44 <b outputclass="bold">Columns</b> in the toolbar. You can 45 then sort the list of virtual machines by a particular metric. 46 </p> 47 <p> 48 To see more performance information for a virtual machine, 49 select the VM name and click <b outputclass="bold">VM 50 Activity</b> in the toolbar. The <b outputclass="bold">VM 51 Activity</b> tab of the <b outputclass="bold">Session 52 Information</b> dialog is shown, see 53 <xref href="vm-activity-session-information.dita#vm-activity-session-information"/>. 54 </p> 29 <p>To configure the set of metrics to be shown, click <b outputclass="bold">Columns</b> in the 30 toolbar. You can then sort the list of virtual machines by a particular metric. </p> 31 <p>To see more performance information for a virtual machine, select the VM name and click <b 32 outputclass="bold">VM Activity</b> in the toolbar. The <b outputclass="bold">VM Activity</b> tab of the <b 33 outputclass="bold">Session Information</b> dialog is shown, see <xref 34 href="vm-activity-session-information.dita#vm-activity-session-information"/>. </p> 55 35 </body> 56 36 -
trunk/doc/manual/en_US/dita/topics/vm-activity-session-information.dita
r105134 r105289 7 7 <!-- 7.1: Add pic for cloud VM Activity info? --> 8 8 <body> 9 <p> 10 The Session Information dialog includes multiple tabs which show 11 important configuration and runtime information for the guest 12 system. The tabs of the dialog are as follows: 13 </p> 9 <p>The Session Information dialog includes multiple tabs which show important configuration and 10 runtime information for the guest system. The tabs of the dialog are as follows: </p> 14 11 <ul> 15 12 <li> 16 <p> 17 <b outputclass="bold">Configuration Details.</b> 18 Displays the system configuration of the virtual machine in 19 a tabular format. The displayed information includes details 20 such as storage configuration and audio settings. 21 </p> 13 <p><b outputclass="bold">Configuration Details.</b> Displays the system configuration of the 14 virtual machine in a tabular format. The displayed information includes details such as storage configuration 15 and audio settings. </p> 22 16 </li> 23 17 <li> 24 <p> 25 <b outputclass="bold">Runtime Information.</b> 26 Displays runtime information for the guest session in a 27 tabular format similar to the Configuration Details tab. 28 </p> 18 <p><b outputclass="bold">Runtime Information.</b> Displays runtime information for the guest 19 session in a tabular format similar to the Configuration Details tab. </p> 29 20 </li> 30 21 <li> 31 <p> 32 <b outputclass="bold">VM Activity.</b> Includes 33 several time series charts which monitor guest resource 34 usage including CPU, RAM, Disk I/O, and Network. Note that 35 the RAM chart requires the Guest Additions to be running on 36 the guest system. The VM Activity tab can also be accessed 37 directly from the VM Activity Overview tool. See 38 <xref href="vm-activity-overview.dita#vm-activity-overview"/>. 39 </p> 22 <p><b outputclass="bold">VM Activity.</b> Includes several time series charts which monitor 23 guest resource usage including CPU, RAM, Disk I/O, and Network. Note that the RAM chart requires the Guest 24 Additions to be running on the guest system. The VM Activity tab can also be accessed directly from the VM 25 Activity Overview tool. See <xref href="vm-activity-overview.dita#vm-activity-overview"/>. </p> 40 26 </li> 41 27 <li> 42 <p> 43 <b outputclass="bold">Guest Control</b>. Details of 44 processes used by the Guest Control File Manager. See 45 <xref href="guestadd-gc-file-manager.dita#guestadd-gc-file-manager"/>. 46 </p> 28 <p><b outputclass="bold">Guest Control</b>. Details of processes used by the Guest Control File 29 Manager. See <xref href="guestadd-gc-file-manager.dita#guestadd-gc-file-manager"/>. </p> 47 30 </li> 48 31 </ul> 49 32 <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> 33 <p>To display session information for a guest virtual machine or a cloud VM, select the VM name in the 34 machine list and click <b>Activity</b> in the machine tools menu.</p> 53 35 <fig id="fig-vm-session-information"> 54 36 <title>Session Information Dialog, Showing VM Activity Tab</title> -
trunk/doc/manual/en_US/dita/topics/vm-info.dita
r105134 r105289 6 6 <!-- 7.1: metrics info now included for OCI instances --> 7 7 <body> 8 <p> 9 <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> includes the following tools for viewing runtime 10 information, configuration details, and performance metrics of virtual machines and cloud VM instances. 11 </p> 8 <p><ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> includes the following tools for viewing runtime 9 information, configuration details, and performance metrics of virtual machines and cloud VM instances. </p> 12 10 <note><p>To monitor a cloud VM, the Compute Instance Monitoring plugin must be enabled and running on the 13 11 <ph conkeyref="vbox-conkeyref-phrases/oci"/> instance. See the <ph conkeyref="vbox-conkeyref-phrases/oci"/> … … 15 13 <ul> 16 14 <li> 17 <p> 18 <b outputclass="bold"> VM Activity Overview.</b> 19 Displays an overview of performance metrics for all running 20 virtual machines and cloud VM instances. 21 </p> 15 <p><b outputclass="bold"> VM Activity Overview.</b> Displays an overview of performance metrics for 16 all running virtual machines and cloud VM instances. </p> 22 17 <p> 23 18 See <xref href="vm-activity-overview.dita#vm-activity-overview"/>. … … 25 20 </li> 26 21 <li> 27 <p> 28 <b outputclass="bold">Session Information Dialog.</b> 29 Displays configuration and runtime information for the 30 selected guest system or cloud VM. 31 </p> 32 <p> 33 See <xref href="vm-activity-session-information.dita#vm-activity-session-information"/>. 34 </p> 22 <p><b outputclass="bold">Session Information Dialog.</b> Displays configuration and runtime 23 information for the selected guest system or cloud VM. </p> 24 <p>See <xref href="vm-activity-session-information.dita#vm-activity-session-information"/>. </p> 35 25 </li> 36 26 </ul> -
trunk/doc/manual/en_US/dita/topics/vm-status-bar.dita
r105176 r105289 5 5 <!-- 7.1: Processor icon updated --> 6 6 <body> 7 <p> 8 A status bar is displayed at the bottom of the virtual machine window. The status bar contains icons 9 that enable you to view and change settings for the virtual machine, as follows: 10 </p> 7 <p>A status bar is displayed at the bottom of the virtual machine window. The status bar contains icons that enable 8 you to view and change settings for the virtual machine, as follows: </p> 11 9 <ul> 12 10 <li><p>Highlight an icon to show details of the current settings.</p></li>
Note:
See TracChangeset
for help on using the changeset viewer.