Changeset 105388 in vbox for trunk/doc/manual
- Timestamp:
- Jul 17, 2024 7:03:12 PM (7 months ago)
- Location:
- trunk/doc/manual/en_US/dita/topics
- Files:
-
- 14 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/doc/manual/en_US/dita/topics/additions-linux-graphics-mouse.dita
r105134 r105388 5 5 6 6 <body> 7 <p> 8 In Linux and Oracle Solaris guests, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> graphics 9 and mouse integration goes through the X Window System. 10 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can use the X.Org variant of the system, or 11 XFree86 version 4.3 which is identical to the first X.Org 12 release. During the installation process, the X.Org display 13 server will be set up to use the graphics and mouse drivers 14 which come with the Guest Additions. 15 </p> 16 <p> 17 After installing the Guest Additions into a fresh installation 18 of a supported Linux distribution or Oracle Solaris system, 19 many unsupported systems will work correctly too, the guest's 20 graphics mode will change to fit the size of the 21 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> window on the host when it is resized. You can 22 also ask the guest system to switch to a particular resolution 23 by sending a video mode hint using the 24 <userinput>VBoxManage</userinput> tool. 25 </p> 26 <p> 27 Multiple guest monitors are supported in guests using the 28 X.Org server version 1.3, which is part of release 7.3 of the 29 X Window System version 11, or a later version. The layout of 30 the guest screens can be adjusted as needed using the tools 31 which come with the guest operating system. 32 </p> 33 <p> If you want to understand more about the details of how the X.Org drivers are set up, in 34 particular if you want to use them in a setting which our installer does not handle correctly, 35 see <xref href="guestxorgsetup.dita">Guest Graphics and Mouse Driver Setup in Depth</xref>. </p> 36 <p> 37 Starting from <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 7, Linux guest screen resize 38 functionality for guests running VMSVGA graphics configuration 39 has been changed. Since then, this functionality consists of a 40 standalone daemon called VBoxDRMClient and its Desktop 41 Environment helper counterpart. 42 </p> 43 <p> 44 VBoxDRMClient runs as a root process and is a bridge between 45 the host and the guest's vmwgfx driver. This means that 46 VBoxDRMClient listens to screen resize hints from the host and 47 forwards them to the vmwgfx driver. This enables guest screen 48 resize functionality to be available before the user has 49 performed a graphical login. 50 </p> 51 <p> 52 In order to perform Desktop Environment specific actions, such 53 as setting the primary screen in a multimonitor setup, a 54 Desktop Environment helper is used. Once the user has 55 performed a graphical login operation, the helper daemon 56 starts with user session scope and attempts to connect to 57 VBoxDRMClient using an IPC connection. When VBoxDRMClient has 58 received a corresponding command from the host, it is 59 forwarded to the helper daemon over IPC and the action is then 60 performed. 61 </p> 62 <p> 63 By default, VBoxDRMClient allows any process to connect to its 64 IPC socket. This can be restricted by using the following 65 steps: 66 </p> 7 <p>In Linux and Oracle Solaris guests, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> graphics and mouse 8 integration goes through the X Window System. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> can use the 9 X.Org variant of the system, or XFree86 version 4.3 which is identical to the first X.Org release. During the 10 installation process, the X.Org display server will be set up to use the graphics and mouse drivers which come 11 with the Guest Additions. </p> 12 <p>After installing the Guest Additions into a fresh installation of a supported Linux distribution or Oracle 13 Solaris system, many unsupported systems will work correctly too, the guest's graphics mode will change to fit the 14 size of the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> window on the host when it is resized. You can 15 also ask the guest system to switch to a particular resolution by sending a video mode hint using the 16 <userinput>VBoxManage</userinput> tool. </p> 17 <p>Multiple guest monitors are supported in guests using the X.Org server version 1.3, which is part of release 7.3 18 of the X Window System version 11, or a later version. The layout of the guest screens can be adjusted as needed 19 using the tools which come with the guest operating system. </p> 20 <p>If you want to understand more about the details of how the X.Org drivers are set up, in particular if you want 21 to use them in a setting which our installer does not handle correctly, see <xref href="guestxorgsetup.dita">Guest 22 Graphics and Mouse Driver Setup in Depth</xref>. </p> 23 <p>Starting from <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 7, Linux guest screen resize functionality 24 for guests running VMSVGA graphics configuration has been changed. Since then, this functionality consists of a 25 standalone daemon called VBoxDRMClient and its Desktop Environment helper counterpart. </p> 26 <p>VBoxDRMClient runs as a root process and is a bridge between the host and the guest's vmwgfx driver. This means 27 that VBoxDRMClient listens to screen resize hints from the host and forwards them to the vmwgfx driver. This 28 enables guest screen resize functionality to be available before the user has performed a graphical login. </p> 29 <p>In order to perform Desktop Environment specific actions, such as setting the primary screen in a multimonitor 30 setup, a Desktop Environment helper is used. Once the user has performed a graphical login operation, the helper 31 daemon starts with user session scope and attempts to connect to VBoxDRMClient using an IPC connection. When 32 VBoxDRMClient has received a corresponding command from the host, it is forwarded to the helper daemon over IPC 33 and the action is then performed. </p> 34 <p>By default, VBoxDRMClient allows any process to connect to its IPC socket. This can be restricted by using the 35 following steps: </p> 67 36 <ol> 68 37 <li> 69 <p> 70 The Guest Additions Linux installer creates a 71 <codeph>vboxdrmipc</codeph> user group. A corresponding 72 user needs to be added to this group. 73 </p> 38 <p>The Guest Additions Linux installer creates a <codeph>vboxdrmipc</codeph> user group. A corresponding user 39 needs to be added to this group. </p> 74 40 </li> 75 41 <li> 76 <p> 77 You must set the <codeph>DRMIpcRestricted</codeph> guest 78 property, as follows: 79 </p> 42 <p>You must set the <codeph>DRMIpcRestricted</codeph> guest property, as follows: </p> 80 43 <pre xml:space="preserve">VBoxManage guestproperty set "VM name" /VirtualBox/GuestAdd/DRMIpcRestricted 1 \ 81 44 --flags RDONLYGUEST</pre> 82 <p> 83 It is important to set only the RDONLYGUEST flag for the 84 property, so that it cannot be changed from inside the 85 guest. 86 </p> 45 <p>It is important to set only the RDONLYGUEST flag for the property, so that it cannot be changed from inside 46 the guest. </p> 87 47 </li> 88 48 </ol> 89 49 <note> 90 <p> 91 Both steps are required. If one of them is missing, all 92 processes will have access to the IPC socket. 93 </p> 50 <p>Both steps are required. If one of them is missing, all processes will have access to the IPC socket. </p> 94 51 </note> 95 <p> 96 Restricted mode can be disabled by unsetting the guest 97 property, as follows: 98 </p> 52 <p>Restricted mode can be disabled by unsetting the guest property, as follows: </p> 99 53 <pre xml:space="preserve">VBoxManage guestproperty unset "VM name" /VirtualBox/GuestAdd/DRMIpcRestricted</pre> 100 54 </body> -
trunk/doc/manual/en_US/dita/topics/additions-linux-uninstall.dita
r105134 r105388 5 5 6 6 <body> 7 <p> If you have a version of the Guest Additions installed on your virtual machine and want to 8 remove it without installing new ones, you can do so by inserting the Guest Additions CD image 9 into the virtual CD-ROM drive as described above. Then run the installer for the current Guest 10 Additions with the <codeph>uninstall</codeph> parameter from the path that the CD image is 11 mounted on in the guest, as follows: </p> 7 <p>If you have a version of the Guest Additions installed on your virtual machine and want to remove it without 8 installing new ones, you can do so by inserting the Guest Additions CD image into the virtual CD-ROM drive as 9 described above. Then run the installer for the current Guest Additions with the <codeph>uninstall</codeph> 10 parameter from the path that the CD image is mounted on in the guest, as follows: </p> 12 11 <pre xml:space="preserve">sh ./VBoxLinuxAdditions.run uninstall</pre> 13 <p> 14 While this will normally work without issues, you may need to 15 do some manual cleanup of the guest in some cases, especially 16 of the XFree86Config or xorg.conf file. In particular, if the 17 Additions version installed or the guest operating system were 18 very old, or if you made your own changes to the Guest 19 Additions setup after you installed them. 20 </p> 21 <p> 22 You can uninstall the Additions as follows: 23 </p> 12 <p>While this will normally work without issues, you may need to do some manual cleanup of the guest in some cases, 13 especially of the XFree86Config or xorg.conf file. In particular, if the Additions version installed or the guest 14 operating system were very old, or if you made your own changes to the Guest Additions setup after you installed 15 them. </p> 16 <p>You can uninstall the Additions as follows: </p> 24 17 <pre xml:space="preserve">/opt/VBoxGuestAdditions-<varname>version</varname>/uninstall.sh</pre> 25 <p> 26 Replace 27 <filepath>/opt/VBoxGuestAdditions-<varname>version</varname></filepath> 28 with the correct Guest Additions installation directory. 29 </p> 18 <p>Replace <filepath>/opt/VBoxGuestAdditions-<varname>version</varname></filepath> with the correct Guest Additions 19 installation directory. </p> 30 20 </body> 31 21 -
trunk/doc/manual/en_US/dita/topics/additions-linux-updating.dita
r98549 r105388 5 5 6 6 <body> 7 <p> 8 The Guest Additions can simply be updated by going through the 9 installation procedure again with an updated CD-ROM image. 10 This will replace the drivers with updated versions. You 11 should reboot after updating the Guest Additions. 12 </p> 7 <p>The Guest Additions can simply be updated by going through the installation procedure again with an updated 8 CD-ROM image. This will replace the drivers with updated versions. You should reboot after updating the Guest 9 Additions. </p> 13 10 </body> 14 11 -
trunk/doc/manual/en_US/dita/topics/additions-windows-install-unattended-certs.dita
r99797 r105388 5 5 6 6 <body> 7 <p> 8 To avoid popups when performing an unattended installation 9 of the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions, the code signing 10 certificates used to sign the drivers needs to be installed 11 in the correct certificate stores on the guest operating 12 system. Failure to do this will cause a typical Windows 13 installation to display multiple dialogs asking whether you 14 want to install a particular driver. 15 </p> 7 <p>To avoid popups when performing an unattended installation of the <ph 8 conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions, the code signing certificates used to sign 9 the drivers needs to be installed in the correct certificate stores on the guest operating system. Failure to do 10 this will cause a typical Windows installation to display multiple dialogs asking whether you want to install a 11 particular driver. </p> 16 12 <note> 17 <p> 18 On some legacy Windows versions, such as Windows 2000 and 19 Windows XP, the user intervention popups mentioned above 20 are always displayed, even after importing the Oracle 21 certificates. 22 </p> 13 <p>On some legacy Windows versions, such as Windows 2000 and Windows XP, the user intervention popups mentioned 14 above are always displayed, even after importing the Oracle certificates. </p> 23 15 </note> 24 <p> 25 Installing the code signing certificates on a Windows guest 26 can be done automatically. Use the 27 <filepath>VBoxCertUtil.exe</filepath> utility from the 28 <filepath>cert</filepath> folder on the Guest Additions 29 installation CD. 30 </p> 31 <p> 32 Use the following steps: 33 </p> 16 <p>Installing the code signing certificates on a Windows guest can be done automatically. Use the 17 <filepath>VBoxCertUtil.exe</filepath> utility from the <filepath>cert</filepath> folder on the Guest Additions 18 installation CD. </p> 19 <p>Use the following steps: </p> 34 20 <ol> 35 21 <li> … … 62 48 </li> 63 49 </ol> 64 <p> 65 To allow for completely unattended guest installations, you 66 can specify a command line parameter to the install 67 launcher: 68 </p> 50 <p>To allow for completely unattended guest installations, you can specify a command line parameter to the install 51 launcher: </p> 69 52 <pre xml:space="preserve">VBoxWindowsAdditions.exe /S</pre> 70 <p> 71 This automatically installs the right files and drivers for 72 the corresponding platform, either 32-bit or 64-bit. 73 </p> 53 <p>This automatically installs the right files and drivers for the corresponding platform, either 32-bit or 64-bit. </p> 74 54 <note> 75 <p> 76 By default on an unattended installation on a Vista or 77 Windows 7 guest, there will be the XPDM graphics driver 78 installed. This graphics driver does not support Windows 79 Aero / Direct3D on the guest. Instead, the WDDM graphics 80 driver needs to be installed. To select this driver by 81 default, add the command line parameter 82 <codeph>/with_wddm</codeph> when invoking the Windows 83 Guest Additions installer. This is only required for Vista 84 and Windows 7. 85 </p> 55 <p>By default on an unattended installation on a Vista or Windows 7 guest, there will be the XPDM graphics driver 56 installed. This graphics driver does not support Windows Aero / Direct3D on the guest. Instead, the WDDM 57 graphics driver needs to be installed. To select this driver by default, add the command line parameter 58 <codeph>/with_wddm</codeph> when invoking the Windows Guest Additions installer. This is only required for 59 Vista and Windows 7. </p> 86 60 </note> 87 61 <note> 88 <p> 89 For Windows Aero to run correctly on a guest, the guest's 90 VRAM size needs to be configured to at least 128 MB. 91 </p> 62 <p>For Windows Aero to run correctly on a guest, the guest's VRAM size needs to be configured to at least 128 MB. </p> 92 63 </note> 93 <p> 94 For more options regarding unattended guest installations, 95 consult the command line help by using the command: 96 </p> 64 <p>For more options regarding unattended guest installations, consult the command line help by using the command: </p> 97 65 <pre xml:space="preserve">VBoxWindowsAdditions.exe /?</pre> 98 66 </body> -
trunk/doc/manual/en_US/dita/topics/additions-windows-install-unattended.dita
r99797 r105388 5 5 6 6 <body> 7 <p> 8 You can configure unattended installation of the 9 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions when you create a new VM using 10 the <b outputclass="bold">Create Virtual Machine</b> 11 wizard. Select the <b outputclass="bold">Guest 12 Additions</b> check box on the 13 <b outputclass="bold">Unattended Guest OS Install</b> 14 page of the wizard. 15 </p> 16 <p> 17 Guest Additions are installed automatically, following 18 completion of the guest OS installation. 19 </p> 7 <p>You can configure unattended installation of the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest 8 Additions when you create a new VM using the <b outputclass="bold">Create Virtual Machine</b> wizard. Select the 9 <b outputclass="bold">Guest Additions</b> check box on the <b outputclass="bold">Unattended Guest OS Install</b> 10 page of the wizard. </p> 11 <p>Guest Additions are installed automatically, following completion of the guest OS installation. </p> 20 12 </body> 21 13 </topic> -
trunk/doc/manual/en_US/dita/topics/additions-windows.dita
r105134 r105388 5 5 6 6 <body> 7 <p> 8 The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Windows Guest Additions are designed to be 9 installed in a virtual machine running a Windows operating 10 system. The following versions of Windows guests are supported: 11 </p> 7 <p>The <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Windows Guest Additions are designed to be installed in 8 a virtual machine running a Windows operating system. The following versions of Windows guests are supported: </p> 12 9 <ul> 13 10 <li> -
trunk/doc/manual/en_US/dita/topics/clone.dita
r105303 r105388 2 2 <!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd"> 3 3 <topic xml:lang="en-us" id="clone"> 4 <title>Cloning Virtual Machines</title>4 <title>Cloning a Virtual Machine</title> 5 5 6 6 <body> 7 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 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>T he <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>11 <ul>9 <p>To clone a VM: </p> 10 <ol id="ol_ulp_zct_bcc"> 11 <li>Ensure the VM you want to clone is not running.</li> 12 12 <li> 13 <p>Click the VM name in the machine list and then select <b outputclass="bold">Clone</b> from the <b13 <p>Click the VM name in the machine list, and then select <b outputclass="bold">Clone</b> from the <b 14 14 outputclass="bold">Machine</b> menu. </p> 15 15 </li> 16 <li> 17 <p>Click <b outputclass="bold">Clone</b> in the <b outputclass="bold">Snapshots</b> window for the selected VM. </p> 18 </li> 19 </ul> 20 <note> 21 <p>The <b outputclass="bold">Clone</b> menu item is disabled while a virtual machine is running. </p> 22 </note> 23 <p>The <b outputclass="bold">New Machine Name and Path</b> page is displayed. </p> 24 <fig id="fig-clone-wizard-name-path"> 25 <title>Clone Virtual Machine Wizard: New Machine Name and Path</title> 26 <xref href="images/clone-vm-1.png" format="png" platform="htmlhelp"> 27 <image href="images/clone-vm-1.png" width="10cm" placement="break"> 28 <alt>Clone Virtual Machine Wizard: New Machine Name and Path</alt> 29 </image> 30 </xref> 31 <image href="images/clone-vm-1.png" width="10cm" placement="break" platform="ohc"> 32 <alt>Clone Virtual Machine Wizard: New Machine Name and Path</alt> 33 </image> 34 </fig> 35 <p>The following clone options are available: </p> 36 <ul> 37 <li> 38 <p><b outputclass="bold">Name:</b> A name for the cloned 39 machine. 40 </p> 41 </li> 42 <li> 43 <p><b outputclass="bold">Path:</b> Choose a location for 44 the cloned virtual machine, otherwise <ph conkeyref="vbox-conkeyref-phrases/product-name"/> uses the 45 default machines folder. 46 </p> 47 </li> 48 <li> 49 <p><b outputclass="bold">MAC Address Policy:</b> Specifies 50 whether to retain network card MAC addresses when cloning the 51 VM. 52 </p> 53 <p> 54 For example, the <b outputclass="bold">Generate New MAC 55 Addresses For All Network Adapters</b> value assigns a 56 new MAC address to each network card during cloning. This is 57 the default setting. This is the best option when both the 58 source VM and the cloned VM must operate on the same network. 59 Other values enable you to retain the existing MAC addresses 60 in the cloned VM. 61 </p> 62 </li> 63 <li> 64 <p><b outputclass="bold">Keep Disk Names:</b> Retains the 65 disk image names when cloning the VM. 66 </p> 67 </li> 68 <li> 69 <p><b outputclass="bold">Keep Hardware UUIDs:</b> Retains 70 the hardware universally unique identifiers (UUIDs) when 71 cloning the VM. 72 </p> 73 </li> 74 </ul> 75 <p>Click <b outputclass="bold">Next</b>. The <b outputclass="bold">Clone Type</b> page is displayed. </p> 76 <fig id="fig-clone-type"> 77 <title>Clone Virtual Machine Wizard: Clone Type</title> 78 <xref href="images/clone-vm-2.png" format="png" platform="htmlhelp"> 79 <image href="images/clone-vm-2.png" width="10cm" placement="break"> 80 <alt>Clone Virtual Machine Wizard: Clone Type</alt> 81 </image> 82 </xref> 83 <image href="images/clone-vm-2.png" width="10cm" placement="break" platform="ohc"> 84 <alt>Clone Virtual Machine Wizard: Clone Type</alt> 85 </image> 86 </fig> 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> 89 <ul> 90 <li> 91 <p><b outputclass="bold">Full Clone:</b> Copies all 92 dependent disk images to the new VM folder. A full clone can 93 operate fully without the source VM. 94 </p> 95 </li> 96 <li> 97 <p><b outputclass="bold">Linked Clone:</b> Creates new 98 differencing disk images based on the source VM disk images. 99 If you select the current state of the source VM as the clone 100 point, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> creates a new snapshot. 101 </p> 102 </li> 103 </ul> 104 <p> 105 (Optional) Click <b outputclass="bold">Next</b>. The 106 <b outputclass="bold">Snapshots</b> page is displayed. 107 </p> 108 <note> 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> 111 </note> 112 <fig id="fig-clone-wizard-snapshots"> 113 <title>Clone Virtual Machine Wizard: Snapshots</title> 114 <xref href="images/clone-vm-3.png" format="png" platform="htmlhelp"> 115 <image href="images/clone-vm-3.png" width="10cm" placement="break"> 116 <alt>Clone Virtual Machine Wizard: Snapshots</alt> 117 </image> 118 </xref> 119 <image href="images/clone-vm-3.png" width="10cm" placement="break" platform="ohc"> 120 <alt>Clone Virtual Machine Wizard: Snapshots</alt> 121 </image> 122 </fig> 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> 125 <ul> 126 <li> 127 <p><b outputclass="bold">Current Machine State:</b> Clones 128 the current state of the VM. Snapshots are not included. 129 </p> 130 </li> 131 <li> 132 <p><b outputclass="bold">Everything:</b> Clones the 133 current machine state and all its snapshots. 134 </p> 135 </li> 136 </ul> 137 <p>Click <b outputclass="bold">Finish</b> to start the clone operation. </p> 16 <li>Enter the following details for the clone.<ul id="ul_rkb_nct_bcc"> 17 <li><b outputclass="bold">Name:</b> A name for the cloned machine. </li> 18 <li><b outputclass="bold">Path:</b> Choose a location for the cloned virtual machine, otherwise <ph 19 conkeyref="vbox-conkeyref-phrases/product-name"/> uses the default machines folder. </li> 20 <li><b outputclass="bold">MAC Address Policy:</b> Specifies whether to retain network card MAC addresses when 21 cloning the VM.<p>The <b outputclass="bold">Generate New MAC Addresses For All Network Adapters</b> value 22 assigns a new MAC address to each network card during cloning. This is the default setting. This is the 23 best option when both the source VM and the cloned VM must operate on the same network. Other values 24 enable you to retain the existing MAC addresses in the cloned VM.</p></li> 25 <li><b outputclass="bold">Keep Disk Names:</b> Retains the disk image names when cloning the VM.</li> 26 <li><b outputclass="bold">Keep Hardware UUIDs:</b> Retains the hardware universally unique identifiers (UUIDs) 27 when cloning the VM. </li></ul></li> 28 <li>Click <b outputclass="bold">Next</b>. The <b outputclass="bold">Clone Type</b> page is displayed.</li> 29 <li>The <b outputclass="bold">Clone Type</b> option specifies whether to create a clone that is linked to the 30 source VM or to create a fully independent clone:<ul id="ul_i1y_qn5_bcc"> 31 <li><b outputclass="bold">Full Clone:</b> Copies all dependent disk images to the new VM folder. A full clone 32 can operate fully without the source VM. </li> 33 <li><b outputclass="bold">Linked Clone:</b> Creates new differencing disk images based on the source VM disk 34 images. If you select the current state of the source VM as the clone point, <ph 35 conkeyref="vbox-conkeyref-phrases/product-name"/> creates a new snapshot. </li> 36 </ul></li> 37 <li>Click <b outputclass="bold">Next</b>. If your VM has snapshots and you chose Full Clone, use the <b 38 outputclass="bold">Snapshots</b> page to select the parts of the snapshot tree to clone with the VM.<ul 39 id="ul_igj_t45_bcc"> 40 <li><b outputclass="bold">Current Machine State:</b> Clones the current state of the VM. Snapshots are not 41 included. </li> 42 <li><b outputclass="bold">Everything:</b> Clones the current machine state and all its snapshots.</li> 43 </ul></li> 44 45 <li><p>Click <b outputclass="bold">Finish</b> to start the clone operation. </p></li></ol> 138 46 <p>The duration of the clone operation depends on the size and number of attached disk images. In addition, the 139 47 clone operation saves all the differencing disk images of a snapshot. </p> -
trunk/doc/manual/en_US/dita/topics/create-vm-wizard.dita
r105289 r105388 2 2 <!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd"> 3 3 <topic xml:lang="en-us" id="create-vm-wizard"> 4 <title>Creating Your FirstVirtual Machine</title>4 <title>Creating a Virtual Machine</title> 5 5 6 6 <body> -
trunk/doc/manual/en_US/dita/topics/gui-vmgroups.dita
r105289 r105388 5 5 6 6 <body> 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> 10 <fig id="fig-vm-groups"> 11 <title>Groups of Virtual Machines</title> 12 <xref href="images/vm-groups.png" format="png" platform="htmlhelp"> 13 <image href="images/vm-groups.png" width="10cm" placement="break"> 14 <alt>Groups of Virtual Machines</alt> 15 </image> 16 </xref> 17 <image platform="ohc" href="images/vm-groups.png" width="10cm" placement="break"> 18 <alt>Groups of Virtual Machines</alt> 19 </image> 20 </fig> 21 <p> 22 The following features are available for groups: 23 </p> 7 <!-- 7.1: pic removed--> 8 <p>Create VM groups if you want to manage several VMs together, and perform functions on them collectively, as well 9 as individually. </p> 10 <p>The following features are available for groups: </p> 24 11 <ul> 25 12 <li> -
trunk/doc/manual/en_US/dita/topics/intro-running.dita
r105303 r105388 2 2 <!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd"> 3 3 <topic xml:lang="en-us" id="intro-running"> 4 <title>Running YourVirtual Machine</title>4 <title>Running a Virtual Machine</title> 5 5 6 6 <body> -
trunk/doc/manual/en_US/dita/topics/mountingadditionsiso.dita
r105303 r105388 5 5 6 6 <body> 7 <p> 8 In the <b outputclass="bold">Devices</b> menu in the 9 virtual machine's menu bar, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> has a menu item 10 <b outputclass="bold">Insert Guest Additions CD 11 Image</b>, which mounts the Guest Additions ISO file 12 inside your virtual machine. A Windows guest should then 13 automatically start the Guest Additions installer, which 14 installs the Guest Additions on your Windows guest. 15 </p> 16 <p> 17 For other guest operating systems, or if automatic start of 18 software on a CD is disabled, you need to do a manual start of 19 the installer. 20 </p> 7 <p>In the <b outputclass="bold">Devices</b> menu in the virtual machine's menu bar, <ph 8 conkeyref="vbox-conkeyref-phrases/product-name"/> has a menu item <b outputclass="bold">Insert Guest Additions 9 CD Image</b>, which mounts the Guest Additions ISO file inside your virtual machine. A Windows guest should then 10 automatically start the Guest Additions installer, which installs the Guest Additions on your Windows guest. </p> 11 <p>For other guest operating systems, or if automatic start of software on a CD is disabled, you need to do a manual 12 start of the installer. </p> 21 13 <note> 22 <p> 23 For the basic Direct3D acceleration to work in a Windows 24 guest, you have to install the WDDM video driver available 25 for Windows Vista or later. 26 </p> 14 <p>For the basic Direct3D acceleration to work in a Windows guest, you have to install the WDDM video driver 15 available for Windows Vista or later. </p> 27 16 <p> 28 17 For Windows 8 and later, only the WDDM Direct3D video driver … … 33 22 </p> 34 23 </note> 35 <p> 36 If you prefer to mount the Guest Additions manually, you can 37 perform the following steps: 38 </p> 24 <p>If you prefer to mount the Guest Additions manually, you can perform the following steps: </p> 39 25 <ol> 40 26 <li> 41 <p> 42 Start the virtual machine in which you have installed 43 Windows. 44 </p> 27 <p>Start the virtual machine in which you have installed Windows. </p> 45 28 </li> 46 29 <li> 47 <p> 48 Select <b outputclass="bold">Optical Drives</b> 49 from the <b outputclass="bold">Devices</b> menu in 50 the virtual machine's menu bar and then 51 <b outputclass="bold">Choose/Create a Disk 52 Image</b>. This displays the Virtual Media Manager, 53 described in <xref href="virtual-media-manager.dita#virtual-media-manager"/>. 54 </p> 30 <p>Select <b outputclass="bold">Optical Drives</b> from the <b outputclass="bold">Devices</b> menu in the 31 virtual machine's menu bar and then <b outputclass="bold">Choose/Create a Disk Image</b>. This displays the 32 Virtual Media Manager, described in <xref href="virtual-media-manager.dita#virtual-media-manager"/>. </p> 55 33 </li> 56 34 <li> 57 <p> 58 In the Virtual Media Manager, click 59 <b outputclass="bold">Add</b> and browse your host 60 file system for the 61 <filepath>VBoxGuestAdditions.iso</filepath> file. 62 </p> 35 <p>In the Virtual Media Manager, click <b outputclass="bold">Add</b> and browse your host file system for the 36 <filepath>VBoxGuestAdditions.iso</filepath> file. </p> 63 37 <ul> 64 <li> 65 <p> 66 On a Windows host, this file is in the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> 67 installation directory, usually in 68 <filepath>C:\Program 69 files\Oracle\VirtualBox</filepath>. 70 </p> 71 </li> 38 <li>On a Windows host, this file is in the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> installation 39 directory, usually in <filepath>C:\Program files\Oracle\VirtualBox</filepath>. </li> 72 40 <li> 73 41 <p> On macOS hosts, this file is in the application bundle of <ph 74 42 conkeyref="vbox-conkeyref-phrases/product-name"/>. Right-click the <ph 75 conkeyref="vbox-conkeyref-phrases/product-name"/> icon in Finder and choose <b 76 outputclass="bold">Show Package Contents</b>. The file is located in the 77 <filepath>Contents/MacOS</filepath> folder. </p> 43 conkeyref="vbox-conkeyref-phrases/product-name"/> icon in Finder and choose <b outputclass="bold">Show 44 Package Contents</b>. The file is located in the <filepath>Contents/MacOS</filepath> folder. </p> 78 45 </li> 79 46 <li> 80 <p> 81 On a Linux host, this file is in the 82 <filepath>additions</filepath> folder where you 83 installed <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, usually 84 <filepath>/opt/VirtualBox/</filepath>. 85 </p> 47 <p>On a Linux host, this file is in the <filepath>additions</filepath> folder where you installed <ph 48 conkeyref="vbox-conkeyref-phrases/product-name"/>, usually <filepath>/opt/VirtualBox/</filepath>. </p> 86 49 </li> 87 50 <li> 88 <p> 89 On Oracle Solaris hosts, this file is in the 90 <filepath>additions</filepath> folder where you 91 installed <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, usually 92 <filepath>/opt/VirtualBox</filepath>. 93 </p> 51 <p>On Oracle Solaris hosts, this file is in the <filepath>additions</filepath> folder where you installed 52 <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, usually <filepath>/opt/VirtualBox</filepath>. </p> 94 53 </li> 95 54 </ul> 96 55 </li> 97 56 <li> 98 <p> 99 In the Virtual Media Manager, select the ISO file and 100 click the <b outputclass="bold">Add</b> button. 101 This mounts the ISO file and presents it to your Windows 102 guest as a CD-ROM. 103 </p> 57 <p>In the Virtual Media Manager, select the ISO file and click the <b outputclass="bold">Add</b> button. This 58 mounts the ISO file and presents it to your Windows guest as a CD-ROM. </p> 104 59 </li> 105 60 </ol> 106 <p> 107 Unless you have the Autostart feature disabled in your Windows 108 guest, Windows will now autostart the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest 109 Additions installation program from the Additions ISO. If the 110 Autostart feature has been turned off, choose 111 <filepath>VBoxWindowsAdditions.exe</filepath> from the CD/DVD 112 drive inside the guest to start the installer. 113 </p> 114 <p> 115 The installer will add several device drivers to the Windows 116 driver database and then invoke the hardware detection wizard. 117 </p> 118 <p> 119 Depending on your configuration, it might display warnings 120 that the drivers are not digitally signed. You must confirm 121 these in order to continue the installation and properly 122 install the Additions. 123 </p> 124 <p> 125 After installation, reboot your guest operating system to 126 activate the Additions. 127 </p> 61 <p>Unless you have the Autostart feature disabled in your Windows guest, Windows will now autostart the <ph 62 conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions installation program from the Additions ISO. 63 If the Autostart feature has been turned off, choose <filepath>VBoxWindowsAdditions.exe</filepath> from the CD/DVD 64 drive inside the guest to start the installer. </p> 65 <p>The installer will add several device drivers to the Windows driver database and then invoke the hardware 66 detection wizard. </p> 67 <p>Depending on your configuration, it might display warnings that the drivers are not digitally signed. You must 68 confirm these in order to continue the installation and properly install the Additions. </p> 69 <p>After installation, reboot your guest operating system to activate the Additions. </p> 128 70 </body> 129 71 -
trunk/doc/manual/en_US/dita/topics/sharedfolders.dita
r105139 r105388 6 6 7 7 <body> 8 <p> 9 With the <i>shared folders</i> feature of 10 <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, you can access files of your host system from 11 within the guest system. This is similar to how you would use 12 network shares in Windows networks, except that shared folders do 13 not require networking, only the Guest Additions. Shared folders 14 are supported with Windows 2000 or later, Linux, and Oracle 15 Solaris guests. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> includes experimental support for 16 Mac OS X and OS/2 guests. 17 </p> 18 <p> 19 Shared folders physically reside on the <i>host</i> 20 and are then shared with the guest, which uses a special file 21 system driver in the Guest Additions to talk to the host. For 22 Windows guests, shared folders are implemented as a pseudo-network 23 redirector. For Linux and Oracle Solaris guests, the Guest 24 Additions provide a virtual file system. 25 </p> 26 <p> 27 To share a host folder with a virtual machine in <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, 28 you must specify the path of the folder and choose a 29 <i>share name</i> that the guest can use to access 30 the shared folder. This happens on the host. In the guest you can 31 then use the share name to connect to it and access files. 32 </p> 33 <p> 34 There are several ways in which shared folders can be set up for a 35 virtual machine: 36 </p> 8 <p>With the <i>shared folders</i> feature of <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, you 9 can access files of your host system from within the guest system. This is similar to how you would use network 10 shares in Windows networks, except that shared folders do not require networking, only the Guest Additions. Shared 11 folders are supported with Windows 2000 or later, Linux, and Oracle Solaris guests. <ph 12 conkeyref="vbox-conkeyref-phrases/product-name"/> includes experimental support for Mac OS X and OS/2 guests. </p> 13 <p>Shared folders physically reside on the <i>host</i> and are then shared with the guest, which uses a 14 special file system driver in the Guest Additions to talk to the host. For Windows guests, shared folders are 15 implemented as a pseudo-network redirector. For Linux and Oracle Solaris guests, the Guest Additions provide a 16 virtual file system. </p> 17 <p>To share a host folder with a virtual machine in <ph conkeyref="vbox-conkeyref-phrases/product-name" 18 />, you must specify the path of the folder and choose a <i>share name</i> that the guest can use to access the 19 shared folder. This happens on the host. In the guest you can then use the share name to connect to it and access 20 files. </p> 21 <p>There are several ways in which shared folders can be set up for a virtual machine: </p> 37 22 <ul> 38 23 <li> 39 <p> In the window of a running VM, you select <b outputclass="bold">Shared 40 Folders</b> from the <b outputclass="bold">Devices</b> menu, or click the folder icon on 41 the status bar in the bottom right corner. </p> 24 <p>In the window of a running VM, you select <b outputclass="bold">Shared Folders</b> from the <b 25 outputclass="bold">Devices</b> menu, or click the folder icon on the status bar in the bottom right corner. </p> 42 26 </li> 43 27 <li> 44 <p> 45 If a VM is not currently running, you can configure shared 46 folders in the virtual machine's 47 <b outputclass="bold">Settings</b> window. 48 </p> 28 <p>If a VM is not currently running, you can configure shared folders in the virtual machine's <b 29 outputclass="bold">Settings</b> window. </p> 49 30 </li> 50 31 <li> 51 <p> 52 From the command line, you can create shared folders using 53 <userinput>VBoxManage</userinput>, as follows: 54 </p> 32 <p>From the command line, you can create shared folders using <userinput>VBoxManage</userinput>, as 33 follows: </p> 55 34 <pre xml:space="preserve">VBoxManage sharedfolder add "VM name" --name "sharename" --hostpath "C:\test"</pre> 56 35 <p> See <xref href="vboxmanage-sharedfolder.dita"/>. </p> 57 36 </li> 58 37 </ul> 59 <p> 60 There are two types of shares: 61 </p> 38 <p>There are two types of shares: </p> 62 39 <ul> 63 40 <li> 64 <p> 65 Permanent shares, that are saved with the VM settings. 66 </p> 41 <p>Permanent shares, that are saved with the VM settings. </p> 67 42 </li> 68 43 <li> 69 <p> 70 Transient shares, that are added at runtime and disappear when 71 the VM is powered off. These can be created using a check box 72 in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>, or by using the <codeph>--transient</codeph> 73 option of the <userinput>VBoxManage sharedfolder add</userinput> 74 command. 75 </p> 44 <p>Transient shares, that are added at runtime and disappear when the VM is powered off. These can 45 be created using a check box in <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>, or by using the 46 <codeph>--transient</codeph> option of the <userinput>VBoxManage sharedfolder add</userinput> command. </p> 76 47 </li> 77 48 </ul> 78 <p> 79 Shared folders can either be read-write or read-only. This means 80 that the guest is either allowed to both read and write, or just 81 read files on the host. By default, shared folders are read-write. 82 Read-only folders can be created using a check box in the 83 <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>, or with the <codeph>--readonly option</codeph> of the 84 <userinput>VBoxManage sharedfolder add</userinput> command. 85 </p> 86 <p> 87 <ph conkeyref="vbox-conkeyref-phrases/product-name"/> shared folders also support symbolic links, also 88 called <i>symlinks</i>, under the following 89 conditions: 90 </p> 49 <p>Shared folders can either be read-write or read-only. This means that the guest is either allowed to 50 both read and write, or just read files on the host. By default, shared folders are read-write. Read-only folders 51 can be created using a check box in the <ph conkeyref="vbox-conkeyref-phrases/vbox-mgr"/>, or with the 52 <codeph>--readonly option</codeph> of the <userinput>VBoxManage sharedfolder add</userinput> command. </p> 53 <p><ph conkeyref="vbox-conkeyref-phrases/product-name"/> shared folders also support symbolic links, also 54 called <i>symlinks</i>, under the following conditions: </p> 91 55 <ul> 92 56 <li> 93 <p> 94 The host operating system must support symlinks. For example, 95 a macOS, Linux, or Oracle Solaris host is required. 96 </p> 57 <p>The host operating system must support symlinks. For example, a macOS, Linux, or Oracle Solaris 58 host is required. </p> 97 59 </li> 98 60 <li> 99 <p> 100 The guest VM must have a version of the Guest Additions 101 installed which supports symlinks. Currently only the Linux and 102 Oracle Solaris Guest Additions support symlinks. 103 </p> 61 <p>The guest VM must have a version of the Guest Additions installed which supports symlinks. 62 Currently only the Linux and Oracle Solaris Guest Additions support symlinks. </p> 104 63 </li> 105 64 <li> 106 <p> 107 For security reasons the guest OS is not allowed to create 108 symlinks by default. If you trust the guest OS to not abuse 109 this functionality, you can enable the creation of symlinks for 110 a shared folder as follows: 111 </p> 65 <p>For security reasons the guest OS is not allowed to create symlinks by default. If you trust the 66 guest OS to not abuse this functionality, you can enable the creation of symlinks for a shared folder as 67 follows: </p> 112 68 <pre xml:space="preserve">VBoxManage setextradata <varname>VM-name</varname> VBoxInternal2/SharedFoldersEnableSymlinksCreate/<varname>sharename</varname> 1</pre> 113 69 </li> 114 70 </ul> 71 <p>If a symbolic link is created inside a shared folder on the host and the installed Guest Additions do not 72 support symbolic links then the guest will see the target of the symlink as a file inside the shared folder. For 73 example, if a symlink is created to a file on a Linux host: </p> 115 74 <p> 116 If a symbolic link is created inside a shared folder on the host117 and the installed Guest Additions do not support symbolic links118 then the guest will see the target of the symlink as a file119 inside the shared folder. For example, if a symlink is created120 to a file on a Linux host:121 </p>122 <p>123 75 <pre xml:space="preserve">$ cd /SharedFolder && ln -s filename symlink-to-filename</pre> 124 76 </p> 125 <p> 126 When the shared folder is viewed on a Windows guest there 127 will be two identical files listed, <userinput>filename</userinput> 128 and <userinput>symlink-to-filename</userinput>. 129 </p> 77 <p>When the shared folder is viewed on a Windows guest there will be two identical files listed, 78 <userinput>filename</userinput> and <userinput>symlink-to-filename</userinput>. </p> 130 79 </body> 131 80 -
trunk/doc/manual/en_US/dita/topics/soft-keyb.dita
r105289 r105388 4 4 5 5 <topic xml:lang="en-us" id="soft-keyb"> 6 <!-- 7.1: Updated pic added-->6 <!-- 7.1: pic removed--> 7 7 <title>Soft Keyboard</title> 8 8 <body> … … 15 15 by the soft keyboard. <ph conkeyref="vbox-conkeyref-phrases/product-name"/> does not do this automatically. </p> 16 16 </note> 17 <fig id="fig-soft-keyb">18 <title>Soft Keyboard in a Guest Virtual Machine</title>19 <xref href="images/softkeybd.png" format="png" platform="htmlhelp">20 <image href="images/softkeybd.png" width="14cm" placement="break">21 <alt>Soft Keyboard in a Guest Virtual Machine</alt>22 </image>23 </xref>24 <image platform="ohc" href="images/softkeybd.png" width="14cm" placement="break">25 <alt>Soft Keyboard in a Guest Virtual Machine</alt>26 </image>27 </fig>28 17 <p>The soft keyboard can be used in the following scenarios: </p> 29 18 <ul> -
trunk/doc/manual/en_US/dita/topics/windows-guest-file-extraction.dita
r99016 r105388 6 6 7 7 <body> 8 <p> 9 If you would like to install the files and drivers manually, 10 you can extract the files from the Windows Guest Additions 11 setup as follows: 12 </p> 8 <p>If you would like to install the files and drivers manually, you can extract the files from the 9 Windows Guest Additions setup as follows: </p> 13 10 <pre xml:space="preserve">VBoxWindowsAdditions.exe /extract</pre> 14 <p> 15 To explicitly extract the Windows Guest Additions for another 16 platform than the current running one, such as 64-bit files on 17 a 32-bit system, you must use the appropriate platform 18 installer. Use 19 <filepath>VBoxWindowsAdditions-x86.exe</filepath> or 20 <filepath>VBoxWindowsAdditions-amd64.exe</filepath> with the 21 <codeph>/extract</codeph> parameter. 22 </p> 11 <p>To explicitly extract the Windows Guest Additions for another platform than the current running 12 one, such as 64-bit files on a 32-bit system, you must use the appropriate platform installer. Use 13 <filepath>VBoxWindowsAdditions-x86.exe</filepath> or <filepath>VBoxWindowsAdditions-amd64.exe</filepath> with 14 the <codeph>/extract</codeph> parameter. </p> 23 15 </body> 24 16
Note:
See TracChangeset
for help on using the changeset viewer.