Changeset 76786 in vbox for trunk/doc/manual/en_US
- Timestamp:
- Jan 11, 2019 7:39:06 PM (6 years ago)
- svn:sync-xref-src-repo-rev:
- 128121
- Location:
- trunk/doc/manual/en_US
- Files:
-
- 26 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/doc/manual/en_US/UserManual.xml
r76113 r76786 11 11 <bookinfo> 12 12 13 13 <title>&VBOX_PRODUCT;</title> 14 14 15 15 <subtitle>User Manual</subtitle> 16 16 17 <edition>Version 18 &VBOX_VERSION_STRING;</edition> 17 <edition>Version &VBOX_VERSION_STRING;</edition> 19 18 20 19 <corpauthor>&VBOX_VENDOR;</corpauthor> … … 31 30 32 31 </bookinfo> 33 34 32 35 33 <xi:include href="user_Preface.xml" -
trunk/doc/manual/en_US/user_AdvancedTopics.xml
r76078 r76786 1272 1272 webcam device remains attached to the guest and must be manually 1273 1273 detached using the <computeroutput>VBoxManage controlvm "VM 1274 name" webcam detach ...</computeroutput> command.1274 name" webcam detach</computeroutput> command. 1275 1275 </para> 1276 1276 … … 1286 1286 webcam is streaming video. If the emulated webcam is inactive it 1287 1287 should be manually detached using the <computeroutput>VBoxManage 1288 controlvm "VM name" webcam detach ...</computeroutput> command.1288 controlvm "VM name" webcam detach</computeroutput> command. 1289 1289 </para> 1290 1290 … … 1423 1423 Raw hard disk access is for expert users only. Incorrect use 1424 1424 or use of an outdated configuration can lead to 1425 <emphasis 1426 role="bold">total loss of data 1427 </emphasis>on the physical disk. Most importantly, 1428 <emphasis>do not</emphasis> attempt to boot the partition with 1429 the currently running host operating system in a guest. This 1430 will lead to severe data corruption. 1425 <emphasis role="bold">total loss of data</emphasis> on the 1426 physical disk. Most importantly, <emphasis>do not</emphasis> 1427 attempt to boot the partition with the currently running host 1428 operating system in a guest. This will lead to severe data 1429 corruption. 1431 1430 </para> 1432 1431 </warning> … … 1468 1467 1469 1468 <screen>VBoxManage internalcommands createrawvmdk -filename /path/to/file.vmdk 1470 1469 -rawdisk /dev/sda</screen> 1471 1470 1472 1471 <para> … … 1502 1501 1503 1502 <screen>VBoxManage storageattach WindowsXP --storagectl "IDE Controller" 1504 1503 --port 0 --device 0 --type hdd --medium /path/to/file.vmdk</screen> 1505 1504 1506 1505 <para> … … 1536 1535 1537 1536 <screen>VBoxManage internalcommands createrawvmdk -filename /path/to/file.vmdk 1538 1537 -rawdisk /dev/sda -partitions 1,5</screen> 1539 1538 1540 1539 <para> … … 1598 1597 1599 1598 <screen>VBoxManage internalcommands createrawvmdk -filename /path/to/file.vmdk 1600 1599 -rawdisk /dev/sda -partitions 1,5 -relative</screen> 1601 1600 1602 1601 <para> … … 1625 1624 1626 1625 <screen>VBoxManage internalcommands createrawvmdk -filename /path/to/file.vmdk 1627 1626 -rawdisk /dev/sda -partitions 1,5 -mbr winxp.mbr</screen> 1628 1627 1629 1628 <para> … … 1748 1747 1749 1748 <screen>VBoxManage storageattach ... --medium iscsi 1750 1749 --server 10.0.9.30 --target iqn.2008-12.com.sun:sampletarget --intnet</screen> 1751 1750 1752 1751 <para> … … 2131 2130 VBoxManage setextradata "VM name" 2132 2131 "VBoxInternal/Devices/pcbios/0/Config/DmiSystemUuid" 2133 2132 "9852bf98-b83c-49db-a8de-182c42c7226b"</screen> 2134 2133 </listitem> 2135 2134 … … 2246 2245 2247 2246 <screen>VBoxManage setextradata "VM name" 2248 2247 "VBoxInternal/Devices/acpi/0/Config/CustomTable0" "/path/to/table.bin"</screen> 2249 2248 2250 2249 <para> … … 2869 2868 2870 2869 <para> 2871 To disable any of these V M manager customizations use the2872 following command:2870 To disable any of these VirtualBox Manager customizations use 2871 the following command: 2873 2872 </para> 2874 2873 … … 4184 4183 4185 4184 <para> 4186 <xref linkend="table-host-key-customize"/> shows the possible4187 Host key actions, together with their default Host key shortcut.4188 Setting an actionto None will disable that Host key action.4189 </para> 4190 4191 <table id="table-host-key-customize" >4185 The following table shows the possible Host key actions, 4186 together with their default Host key shortcut. Setting an action 4187 to None will disable that Host key action. 4188 </para> 4189 4190 <table id="table-host-key-customize" tabstyle="oracle-all"> 4192 4191 <title>Host Key Customization</title> 4193 4192 <tgroup cols="3"> … … 4842 4841 <computeroutput>VBOXWEB_USER</computeroutput>, which must be set 4843 4842 to the user which will later start the VMs. The parameters in 4844 <xref linkend="table-websrv-config-params"/>all start with the4843 the following table all start with the 4845 4844 <computeroutput>VBOXWEB_</computeroutput> prefix string. For 4846 4845 example: <computeroutput>VBOXWEB_HOST</computeroutput> and … … 4848 4847 </para> 4849 4848 4850 <table id="table-websrv-config-params" >4849 <table id="table-websrv-config-params" tabstyle="oracle-all"> 4851 4850 <title>Web Service Configuration Parameters</title> 4852 4851 <tgroup cols="3"> … … 5397 5396 5398 5397 <para> 5399 The parameters in 5400 <xref linkend="table-vboxwatchdog-config-params"/> all start 5401 with the <computeroutput>VBOXWATCHDOG_</computeroutput> prefix 5402 string. For example: 5398 The parameters in the following table all start with the 5399 <computeroutput>VBOXWATCHDOG_</computeroutput> prefix string. 5400 For example: 5403 5401 <computeroutput>VBOXWATCHDOG_BALLOON_INTERVAL</computeroutput> 5404 5402 and <computeroutput>VBOXWATCHDOG_LOGSIZE</computeroutput>. … … 5408 5406 </para> 5409 5407 5410 <table id="table-vboxwatchdog-config-params" >5408 <table id="table-vboxwatchdog-config-params" tabstyle="oracle-all"> 5411 5409 <title>&product-name; Watchdog Configuration Parameters</title> 5412 5410 <tgroup cols="3"> … … 6640 6638 offers a collection of options, in an attempt to make this work 6641 6639 deterministically and reliably on as many Linux distributions and 6642 system configurations as possible. These are summarized in 6643 <xref linkend="table-pcspeaker-config"/>.6644 </para> 6645 6646 <table id="table-pcspeaker-config" >6640 system configurations as possible. These are summarized in the 6641 following table. 6642 </para> 6643 6644 <table id="table-pcspeaker-config" tabstyle="oracle-all"> 6647 6645 <title>PC Speaker Configuration Options</title> 6648 6646 <tgroup cols="3"> … … 6666 6664 </para></entry> 6667 6665 <entry><para> 6668 <computeroutput>/dev/input/by-path/platform- 6669 pcspkr-event-spkr</computeroutput> 6666 <computeroutput>/dev/input/by-path/platform-pcspkr-event-spkr</computeroutput> 6670 6667 </para></entry> 6671 6668 <entry><para> … … 6943 6940 No configuration is required. &product-name; detects Hyper-V 6944 6941 automatically and uses Hyper-V as the virtualization engine for 6945 the host . The CPU icon in the VM window status bar indicates that6946 Hyper-V is being used.6942 the host system. The CPU icon in the VM window status bar 6943 indicates that Hyper-V is being used. 6947 6944 </para> 6948 6945 … … 6965 6962 passthrough of hardware virtualization functions to the guest VM. 6966 6963 That means that you can install a hypervisor, such as 6967 &product-name; or KVM, on an &product-name; guest. You can then6968 create and run VMs within the guest VM.6964 &product-name;, Oracle VM Server or KVM, on an &product-name; 6965 guest. You can then create and run VMs within the guest VM. 6969 6966 </para> 6970 6967 … … 6980 6977 From the VirtualBox Manager, select the 6981 6978 <emphasis role="bold">Enable Nested VT-x/AMD-V</emphasis> 6982 check box on the <emphasis role="bold"> System</emphasis> tab.6983 To disable the feature, deselect the check box.6979 check box on the <emphasis role="bold">Processor</emphasis> 6980 tab. To disable the feature, deselect the check box. 6984 6981 </para> 6985 6982 </listitem> -
trunk/doc/manual/en_US/user_BasicConcepts.xml
r76678 r76786 90 90 2003, Windows Vista, Windows Server 2008, Windows 7, Windows 91 91 Server 2008 R2, Windows 8, Windows Server 2012, Windows 8.1, 92 Windows Server 2012 R2, Windows 10 (non-Insider Preview releases), 93 Windows Server 2016, Windows server 2019:</emphasis> 92 Windows Server 2012 R2, Windows 10 (non-Insider Preview 93 releases), Windows Server 2016, Windows Server 94 2019:</emphasis> 94 95 </para> 95 96 … … 528 529 529 530 <para> 530 &product-name; is able to install a guest operating system531 automatically. You only need to provide the installation medium532 and a few other parameters,such as the name of the default user.531 &product-name; can install a guest OS automatically. You only need 532 to provide the installation medium and a few other parameters, 533 such as the name of the default user. 533 534 </para> 534 535 … … 542 543 <listitem> 543 544 <para> 544 <emphasis role="bold">Create a new VM.</emphasis> You can use545 either of the following to do this:545 <emphasis role="bold">Create a new VM.</emphasis> Use one of 546 the following methods: 546 547 </para> 547 548 … … 557 558 <listitem> 558 559 <para> 559 The <command>VBoxManage </command> command, see560 The <command>VBoxManage createvm</command> command, see 560 561 <xref linkend="vboxmanage-createvm" />. 561 562 </para> … … 565 566 566 567 <para> 567 For the new VM, you can usually just choose the type of the 568 guest operating system and accept the default settings for 569 that operating system. The following sections in this chapter 570 describe how to change the settings for a VM. 568 For the new VM, choose the guest OS type and accept the 569 default settings for that OS. The following sections in this 570 chapter describe how to change the settings for a VM. 571 571 </para> 572 572 </listitem> … … 589 589 <listitem> 590 590 <para> 591 <emphasis role="bold">Start the VM.</emphasis> You can use the591 <emphasis role="bold">Start the VM.</emphasis> Use the 592 592 VirtualBox Manager or the <command>VBoxManage 593 593 startvm</command> command. … … 600 600 601 601 <para> 602 Note that the boot order is changed during the preparation 603 step, giving the virtual hard disk the highest priority. As 604 this disk is normally empty before an automatic installation 605 is started, the VM will instead boot from the virtual DVD 606 drive as next available boot medium and the installation will 607 start. If the virtual hard disk contains a bootable operating 608 system, then the installation will not start. The boot order 609 must be manually changed, by pressing F12 during the BIOS 610 splash screen. 602 The installation operation changes the boot device order to 603 boot the virtual hard disk first and then the virtual DVD 604 drive. If the virtual hard disk is empty prior to the 605 automatic installation, the VM boots from the virtual DVD 606 drive and begins the installation. 607 </para> 608 609 <para> 610 If the virtual hard disk contains a bootable OS, the 611 installation operation exits. In this case, change the boot 612 device order manually by pressing F12 during the BIOS splash 613 screen. 611 614 </para> 612 615 </listitem> … … 626 629 <para> 627 630 The following example shows how to perform an unattended guest 628 installation for an Oracle Linux virtual machine. The example 629 uses various <command>VBoxManage</command> commands to prepare 630 the guest VM. The <command>VBoxManage unattended 631 install</command> command is then used to install and configure 632 the guest operating system. 631 installation for an Oracle Linux VM. The example uses various 632 <command>VBoxManage</command> commands to prepare the guest VM. 633 The <command>VBoxManage unattended install</command> command is 634 then used to install and configure the guest OS. 633 635 </para> 634 636 … … 652 654 <listitem> 653 655 <para> 654 The variable $VMrepresents the name of the VM.656 The $VM variable represents the name of the VM. 655 657 </para> 656 658 </listitem> … … 659 661 <para> 660 662 The <command>VBoxManage list ostypes</command> command 661 lists the guest operating systems supported by 662 &product-name;, including the name used for each 663 operating system in the <command>VBoxManage</command> 664 commands. 663 lists the guest OSes supported by &product-name;, 664 including the name used for each OS in the 665 <command>VBoxManage</command> commands. 665 666 </para> 666 667 </listitem> … … 702 703 703 704 <para> 704 Notethe following:705 The previous commands do the following: 705 706 </para> 706 707 … … 709 710 <listitem> 710 711 <para> 711 A 32768 MB virtual hard disk is created.712 Create a 32768 MB virtual hard disk. 712 713 </para> 713 714 </listitem> … … 715 716 <listitem> 716 717 <para> 717 A SATA storage controller is created andthe virtual718 hard disk is attached.718 Create a SATA storage controller and attach the virtual 719 hard disk. 719 720 </para> 720 721 </listitem> … … 722 723 <listitem> 723 724 <para> 724 An IDE storage controller for a virtual DVD drive is 725 created and an Oracle Linux installation ISO is 726 attached. 725 Create an IDE storage controller for a virtual DVD drive 726 and attach an Oracle Linux installation ISO. 727 727 </para> 728 728 </listitem> … … 741 741 742 742 <para> 743 Notethe following:743 The previous commands do the following: 744 744 </para> 745 745 … … 748 748 <listitem> 749 749 <para> 750 I/O APIC is enabledfor the motherboard of the VM.750 Enable I/O APIC for the motherboard of the VM. 751 751 </para> 752 752 </listitem> … … 754 754 <listitem> 755 755 <para> 756 The boot order for the VM is configured.756 Configure the boot device order for the VM. 757 757 </para> 758 758 </listitem> … … 760 760 <listitem> 761 761 <para> 762 8192 MB of RAM and 128 MB of video RAM are allocated to763 theVM.762 Allocate 8192 MB of RAM and 128 MB of video RAM to the 763 VM. 764 764 </para> 765 765 </listitem> … … 770 770 <listitem> 771 771 <para> 772 Perform an unattended install of the operating system.772 Perform an unattended install of the OS. 773 773 </para> 774 774 … … 779 779 780 780 <para> 781 Notethe following:781 The previous command does the following: 782 782 </para> 783 783 … … 786 786 <listitem> 787 787 <para> 788 An Oracle Linux ISO is specified as the installation 789 ISO. 788 Specifies an Oracle Linux ISO as the installation ISO. 790 789 </para> 791 790 </listitem> … … 793 792 <listitem> 794 793 <para> 795 Specif y a login name, full name, and login password for796 a default user on the guest operating system.794 Specifies a login name, full name, and login password 795 for a default user on the guest OS. 797 796 </para> 798 797 799 798 <para> 800 The specified password is also used for the root user801 account on the guest.799 Note that the specified password is also used for the 800 root user account on the guest. 802 801 </para> 803 802 </listitem> … … 805 804 <listitem> 806 805 <para> 807 The Guest Additions are installedon the VM.806 Installs the Guest Additions on the VM. 808 807 </para> 809 808 </listitem> … … 811 810 <listitem> 812 811 <para> 813 The time zone for the guest operating system is set to814 Central EuropeanTime (CET).812 Sets the time zone for the guest OS to Central European 813 Time (CET). 815 814 </para> 816 815 </listitem> … … 825 824 826 825 <para> 827 This step completes the unattended install process.826 This step completes the unattended installation process. 828 827 </para> 829 828 … … 831 830 832 831 <para> 833 The VM is started in headless mode. The VirtualBox Manager834 window is not displayed.835 </para> 836 </listitem> 837 838 <listitem> 839 <para> 840 (Optional) Update the guest operating system to use the841 latest OracleLinux packages.832 The VM starts in headless mode, which means that the 833 VirtualBox Manager window does not open. 834 </para> 835 </listitem> 836 837 <listitem> 838 <para> 839 (Optional) Update the guest OS to use the latest Oracle 840 Linux packages. 842 841 </para> 843 842 … … 872 871 &product-name; emulates a standard PS/2 keyboard and mouse. 873 872 These devices are supported by almost all past and present 874 operating systems.873 OSes. 875 874 </para> 876 875 … … 922 921 <emphasis role="bold">USB.</emphasis> &product-name; emulates 923 922 three USB host controllers: xHCI, EHCI, and OHCI. While xHCI 924 handles all USB transfer speeds, only guest operating systems 925 released approximately after 2011 support xHCI. Note that for 926 Windows 7 guests, 3rd party drivers must be installed for xHCI 927 support. 928 </para> 929 930 <para> 931 Older operating systems typically support OHCI and EHCI. The 932 two controllers are needed because OHCI only handles USB 933 low-speed and full-speed devices (both USB 1.x and 2.0), while 934 EHCI only handles high-speed devices (USB 2.0 only). 923 handles all USB transfer speeds, only guest OSes released 924 approximately after 2011 support xHCI. Note that for Windows 7 925 guests, 3rd party drivers must be installed for xHCI support. 926 </para> 927 928 <para> 929 Older OSes typically support OHCI and EHCI. The two 930 controllers are needed because OHCI only handles USB low-speed 931 and full-speed devices (both USB 1.x and 2.0), while EHCI only 932 handles high-speed devices (USB 2.0 only). 935 933 </para> 936 934 … … 984 982 files. By changing the name, &product-name; renames these 985 983 files as well. As a result, you can only use characters 986 which are allowed in your host operating system's file 987 names. 984 which are allowed in your host OS's file names. 988 985 </para> 989 986 … … 998 995 <para> 999 996 <emphasis role="bold">Type:</emphasis> The type of the guest 1000 operating system for the VM. This is the same setting that 1001 is specified in the <emphasis role="bold">New Virtual 1002 Machine</emphasis> wizard. See 1003 <xref linkend="gui-createvm" />. 997 OS for the VM. This is the same setting that is specified in 998 the <emphasis role="bold">New Virtual Machine</emphasis> 999 wizard. See <xref linkend="gui-createvm" />. 1004 1000 </para> 1005 1001 1006 1002 <para> 1007 1003 Whereas the default settings of a newly created VM depend on 1008 the selected operating system type, changing the type later1009 has no effect on VM settings. This value is purely1010 informational anddecorative.1004 the selected OS type, changing the type later has no effect 1005 on VM settings. This value is purely informational and 1006 decorative. 1011 1007 </para> 1012 1008 </listitem> … … 1015 1011 <para> 1016 1012 <emphasis role="bold">Version:</emphasis> The version of the 1017 guest operating system for the VM. This is the same setting1018 that isspecified in the <emphasis role="bold">New Virtual1013 guest OS for the VM. This is the same setting that is 1014 specified in the <emphasis role="bold">New Virtual 1019 1015 Machine</emphasis> wizard. See 1020 1016 <xref linkend="gui-createvm" />. … … 1050 1046 <para> 1051 1047 <emphasis role="bold">Shared Clipboard:</emphasis> You can 1052 select here whether the clipboard of the guest operating1053 s ystem should be shared with that of your host. If you1054 select<emphasis role="bold">Bidirectional</emphasis>, then1048 select here whether the clipboard of the guest OS should be 1049 shared with that of your host. If you select 1050 <emphasis role="bold">Bidirectional</emphasis>, then 1055 1051 &product-name; will always make sure that both clipboards 1056 1052 contain the same data. If you select … … 1194 1190 amount of RAM that is allocated and given to the VM when it 1195 1191 is running. The specified amount of memory will be requested 1196 from the host operating system, so it must be available or1197 made available as free memory on the host when attempting to1198 start the VM and will not be available to the host while the1199 VM is running. This is the same setting that was specified1200 in the <emphasis role="bold">New Virtual Machine</emphasis>1201 wizard,as described in <xref linkend="gui-createvm" />.1192 from the host OS, so it must be available or made available 1193 as free memory on the host when attempting to start the VM 1194 and will not be available to the host while the VM is 1195 running. This is the same setting that was specified in the 1196 <emphasis role="bold">New Virtual Machine</emphasis> wizard, 1197 as described in <xref linkend="gui-createvm" />. 1202 1198 </para> 1203 1199 1204 1200 <para> 1205 1201 Generally, it is possible to change the memory size after 1206 installing the guest operating system. But you must not 1207 reduce the memory to an amount where the operating system 1208 would no longer boot. 1202 installing the guest OS. But you must not reduce the memory 1203 to an amount where the OS would no longer boot. 1209 1204 </para> 1210 1205 </listitem> … … 1213 1208 <para> 1214 1209 <emphasis role="bold">Boot Order:</emphasis> Determines the 1215 order in which the guest operating system will attempt to1216 boot from the various virtual boot devices. Analogous to a1217 real PC's BIOS setting, &product-name; can tell a guest OS1218 t o start from the virtual floppy, the virtual CD/DVD drive,1219 the virtual hard drive (each of these as defined by the1220 other VMsettings), the network, or none of these.1210 order in which the guest OS will attempt to boot from the 1211 various virtual boot devices. Analogous to a real PC's BIOS 1212 setting, &product-name; can tell a guest OS to start from 1213 the virtual floppy, the virtual CD/DVD drive, the virtual 1214 hard drive (each of these as defined by the other VM 1215 settings), the network, or none of these. 1221 1216 </para> 1222 1217 … … 1234 1229 which chipset will be presented to the virtual machine. In 1235 1230 legacy versions of &product-name;, PIIX3 was the only 1236 available option. For modern guest operating systems such as1237 Mac OS X, that old chipset is no longer well supported. As a1238 result, &product-name; supports an emulation of the more1239 modern ICH9 chipset, which supports PCI express, three PCI1240 buses, PCI-to-PCI bridges and Message Signaled Interrupts1241 (MSI). This enables modern operating systems to address more1242 PCI devices and no longer requires IRQ sharing. Using the1243 ICH9 chipset it is also possible to configure up to 361244 network cards, up to 8 network adapters with PIIX3. Note1245 that the ICH9 support is experimental and not recommended1246 for guest operating systems which do notrequire it.1231 available option. For modern guest OSes such as Mac OS X, 1232 that old chipset is no longer well supported. As a result, 1233 &product-name; supports an emulation of the more modern ICH9 1234 chipset, which supports PCI express, three PCI buses, 1235 PCI-to-PCI bridges and Message Signaled Interrupts (MSI). 1236 This enables modern OSes to address more PCI devices and no 1237 longer requires IRQ sharing. Using the ICH9 chipset it is 1238 also possible to configure up to 36 network cards, up to 8 1239 network adapters with PIIX3. Note that the ICH9 support is 1240 experimental and not recommended for guest OSes which do not 1241 require it. 1247 1242 </para> 1248 1243 </listitem> … … 1278 1273 hardware feature that have replaced old-style Programmable 1279 1274 Interrupt Controllers (PICs) in recent years. With an I/O 1280 APIC, operating systems can use more than 16 interrupt 1281 requests (IRQs) and therefore avoid IRQ sharing for improved 1282 reliability. 1275 APIC, OSes can use more than 16 interrupt requests (IRQs) 1276 and therefore avoid IRQ sharing for improved reliability. 1283 1277 </para> 1284 1278 … … 1286 1280 <para> 1287 1281 Enabling the I/O APIC is <emphasis>required</emphasis> for 1288 64-bit guest operating systems, especially Windows Vista.1289 It is also required if you want to use more than one1290 virtual CPU in a virtualmachine.1282 64-bit guest OSes, especially Windows Vista. It is also 1283 required if you want to use more than one virtual CPU in a 1284 virtual machine. 1291 1285 </para> 1292 1286 </note> … … 1294 1288 <para> 1295 1289 However, software support for I/O APICs has been unreliable 1296 with some operating systems other than Windows. Also, the 1297 use of an I/O APIC slightly increases the overhead of 1298 virtualization and therefore slows down the guest OS a 1299 little. 1290 with some OSes other than Windows. Also, the use of an I/O 1291 APIC slightly increases the overhead of virtualization and 1292 therefore slows down the guest OS a little. 1300 1293 </para> 1301 1294 1302 1295 <warning> 1303 1296 <para> 1304 All Windows operating systems starting with Windows 20001305 install different kernels, depending on whether an I/O1306 APIC isavailable. As with ACPI, the I/O APIC therefore1297 All Windows OSes starting with Windows 2000 install 1298 different kernels, depending on whether an I/O APIC is 1299 available. As with ACPI, the I/O APIC therefore 1307 1300 <emphasis>must not be turned off after 1308 1301 installation</emphasis> of a Windows guest OS. Turning it … … 1327 1320 UTC format to the guest instead of the local (host) time. 1328 1321 This affects how the virtual real-time clock (RTC) operates 1329 and may be useful for UNIX-like guest operating systems,1330 which typicallyexpect the hardware clock to be set to UTC.1322 and may be useful for UNIX-like guest OSes, which typically 1323 expect the hardware clock to be set to UTC. 1331 1324 </para> 1332 1325 </listitem> … … 1337 1330 In addition, you can turn off the <emphasis role="bold">Advanced 1338 1331 Configuration and Power Interface (ACPI)</emphasis> which 1339 &product-name; presents to the guest operating system by 1340 default. 1341 </para> 1342 1343 <para> 1344 ACPI is the current industry standard to allow operating systems 1345 to recognize hardware, configure motherboards and other devices 1346 and manage power. As all modern PCs contain this feature and 1347 Windows and Linux have been supporting it for years, it is also 1348 enabled by default in &product-name;. ACPI can only be turned 1349 off using the command line. See 1350 <xref linkend="vboxmanage-modifyvm" />. 1332 &product-name; presents to the guest OS by default. 1333 </para> 1334 1335 <para> 1336 ACPI is the current industry standard to allow OSes to recognize 1337 hardware, configure motherboards and other devices and manage 1338 power. As all modern PCs contain this feature and Windows and 1339 Linux have been supporting it for years, it is also enabled by 1340 default in &product-name;. ACPI can only be turned off using the 1341 command line. See <xref linkend="vboxmanage-modifyvm" />. 1351 1342 </para> 1352 1343 1353 1344 <warning> 1354 1345 <para> 1355 All Windows operating systems starting with Windows 20001356 install different kernels, depending on whether ACPI is1357 available. This means that ACPI <emphasis>must not be turned1358 off</emphasis> after installation of a Windows guest OS.1359 However, turning it onafter installation will have no effect.1346 All Windows OSes starting with Windows 2000 install different 1347 kernels, depending on whether ACPI is available. This means 1348 that ACPI <emphasis>must not be turned off</emphasis> after 1349 installation of a Windows guest OS. However, turning it on 1350 after installation will have no effect. 1360 1351 </para> 1361 1352 </warning> … … 1377 1368 <para> 1378 1369 <emphasis role="bold">Processor(s):</emphasis> Sets the 1379 number of virtual CPU cores the guest operating systems can1380 see. &product-name; supports symmetrical multiprocessing1381 (SMP) and can present up to 32 virtual CPU cores to each1382 virtualmachine.1370 number of virtual CPU cores the guest OSes can see. 1371 &product-name; supports symmetrical multiprocessing (SMP) 1372 and can present up to 32 virtual CPU cores to each virtual 1373 machine. 1383 1374 </para> 1384 1375 … … 1412 1403 <emphasis role="bold">Enable PAE/NX:</emphasis> Determines 1413 1404 whether the PAE and NX capabilities of the host CPU will be 1414 exposed to the virtual machine. To enable this feature, 1415 select the <emphasis role="bold">Extended 1416 Features</emphasis> check box. 1405 exposed to the virtual machine. 1417 1406 </para> 1418 1407 1419 1408 <para> 1420 1409 PAE stands for Physical Address Extension. Normally, if 1421 enabled and supported by the operating system, then even a 1422 32-bit x86 CPU can access more than 4 GB of RAM. This is 1423 made possible by adding another 4 bits to memory addresses, 1424 so that with 36 bits, up to 64 GB can be addressed. Some 1425 operating systems, such as Ubuntu Server, require PAE 1426 support from the CPU and cannot be run in a virtual machine 1427 without it. 1410 enabled and supported by the OS, then even a 32-bit x86 CPU 1411 can access more than 4 GB of RAM. This is made possible by 1412 adding another 4 bits to memory addresses, so that with 36 1413 bits, up to 64 GB can be addressed. Some OSes, such as 1414 Ubuntu Server, require PAE support from the CPU and cannot 1415 be run in a virtual machine without it. 1416 </para> 1417 </listitem> 1418 1419 <listitem> 1420 <para> 1421 <emphasis role="bold">Enable Nested VT-x/AMD-V</emphasis>: 1422 Enables nested virtualization, with passthrough of hardware 1423 virtualization functions to the guest VM. 1424 </para> 1425 1426 <para> 1427 This feature is available on host systems that use an AMD 1428 CPU. For Intel CPUs, the option is grayed out. 1428 1429 </para> 1429 1430 </listitem> … … 1432 1433 1433 1434 <para> 1434 With virtual machines running modern server operating systems,1435 &product-name;also supports CPU hot-plugging. For details, see1435 With virtual machines running modern server OSes, &product-name; 1436 also supports CPU hot-plugging. For details, see 1436 1437 <xref linkend="cpuhotplug" />. 1437 1438 </para> … … 1455 1456 Interface:</emphasis> &product-name; provides 1456 1457 paravirtualization interfaces to improve time-keeping 1457 accuracy and performance of guest operating systems. The1458 optionsavailable are documented under the1458 accuracy and performance of guest OSes. The options 1459 available are documented under the 1459 1460 <computeroutput>paravirtprovider</computeroutput> option in 1460 1461 <xref linkend="vboxmanage-modifyvm" />. For further details … … 1510 1511 <emphasis role="bold">Acceleration</emphasis> tab will work 1511 1512 well. &product-name; selects sensible defaults, depending on the 1512 operating system that you selected when you created the virtual1513 machine. In certain situations, however, you may want to change1514 thepreconfigured defaults.1513 OS that you selected when you created the virtual machine. In 1514 certain situations, however, you may want to change the 1515 preconfigured defaults. 1515 1516 </para> 1516 1517 … … 1564 1565 <emphasis role="bold">Monitor Count:</emphasis> With this 1565 1566 setting, &product-name; can provide more than one virtual 1566 monitor to a virtual machine. If a guest operating system1567 supports multiple attached monitors, &product-name; can1568 pretend that multiple virtual monitors are present. Up to1569 eight suchvirtual monitors are supported.1567 monitor to a virtual machine. If a guest OS supports 1568 multiple attached monitors, &product-name; can pretend that 1569 multiple virtual monitors are present. Up to eight such 1570 virtual monitors are supported. 1570 1571 </para> 1571 1572 … … 1631 1632 <para> 1632 1633 <emphasis role="bold">Graphics Controller:</emphasis> 1633 Specifies the graphics adapter type used by the VM. The 1634 following options are available: 1634 Specifies the graphics adapter type used by the guest VM. 1635 Note that you must install the Guest Additions on the guest 1636 VM to specify the VBoxSVGA or VMSVGA graphics controller. 1637 The following options are available: 1635 1638 </para> 1636 1639 … … 1641 1644 <emphasis role="bold">VBoxSVGA:</emphasis> The default 1642 1645 graphics controller for new VMs that use Linux or 1643 Windows 7 or later. Requires the Guest Additions. 1646 Windows 7 or later. 1647 </para> 1648 1649 <para> 1650 This graphics controller improves performance and 3D 1651 support when compared to the legacy VBoxVGA option. 1644 1652 </para> 1645 1653 </listitem> … … 1647 1655 <listitem> 1648 1656 <para> 1649 <emphasis role="bold">VBoxVGA:</emphasis> Used for 1650 legacy guest operating systems. This was the default 1651 graphics controller in previous releases. 1652 </para> 1653 1654 <para> 1655 For Windows versions before Windows 7, this is the 1656 default option. Does not require the Guest Additions. 1657 <emphasis role="bold">VBoxVGA:</emphasis> Use this 1658 graphics controller for legacy guest OSes. This is the 1659 default graphics controller for Windows versions before 1660 Windows 7. 1657 1661 </para> 1658 1662 </listitem> … … 1660 1664 <listitem> 1661 1665 <para> 1662 <emphasis role="bold">VMSVGA:</emphasis> Use d to emulate1663 a VMware SVGA graphic device. Requires the Guest1664 Additions.1666 <emphasis role="bold">VMSVGA:</emphasis> Use this 1667 graphics controller to emulate a VMware SVGA graphics 1668 device. 1665 1669 </para> 1666 1670 </listitem> … … 1668 1672 <listitem> 1669 1673 <para> 1670 <emphasis role="bold">None:</emphasis> Do not emulate a1671 graphics adapter type.1674 <emphasis role="bold">None:</emphasis> Does not emulate 1675 a graphics adapter type. 1672 1676 </para> 1673 1677 </listitem> … … 1714 1718 <title>Recording Tab</title> 1715 1719 1716 <remark>1717 Renamed to Recording tab? Check against RC version.1718 </remark>1719 1720 1720 <para> 1721 1721 On the <emphasis role="bold">Recording</emphasis> tab you can … … 1729 1729 <listitem> 1730 1730 <para> 1731 <emphasis role="bold">Enable Capture:</emphasis> Select this1732 check box and select a <emphasis role="bold">Capture1731 <emphasis role="bold">Enable Recording:</emphasis> Select 1732 this check box and select a <emphasis role="bold">Recording 1733 1733 Mode</emphasis> option. 1734 1734 </para> … … 1737 1737 <listitem> 1738 1738 <para> 1739 <emphasis role="bold"> CaptureMode:</emphasis> You can1739 <emphasis role="bold">Recording Mode:</emphasis> You can 1740 1740 choose to record video, audio, or both video and audio. 1741 1741 </para> … … 1744 1744 Some settings on the 1745 1745 <emphasis role="bold">Recording</emphasis> tab may be grayed 1746 out, depending on the <emphasis role="bold"> Capture1746 out, depending on the <emphasis role="bold">Recording 1747 1747 Mode</emphasis> setting. 1748 1748 </para> … … 1855 1855 1856 1856 <para> 1857 Depending on the guest operating system type that you selected 1858 when you created the VM, a new VM includes the following storage 1859 devices: 1857 Depending on the guest OS type that you selected when you created 1858 the VM, a new VM includes the following storage devices: 1860 1859 </para> 1861 1860 … … 1889 1888 IDE controller to which both the CD/DVD drive and the hard disks 1890 1889 have been attached. This might also apply if you selected an older 1891 operating system type when you created the VM. Since older1892 operating systems do not support SATA without additional drivers,1893 &product-name; will make sure that no such devices are present1894 initially. See<xref linkend="harddiskcontrollers" />.1890 OS type when you created the VM. Since older OSes do not support 1891 SATA without additional drivers, &product-name; will make sure 1892 that no such devices are present initially. See 1893 <xref linkend="harddiskcontrollers" />. 1895 1894 </para> 1896 1895 … … 1938 1937 <listitem> 1939 1938 <para> 1940 You can then select to which <emphasis role="bold">device 1941 slot</emphasis> of the controller the virtual disk should 1942 be connected to. IDE controllers have four slots which 1943 have traditionally been called primary master, primary 1944 slave, secondary master, and secondary slave. By contrast, 1945 SATA and SCSI controllers offer you up to 30 slots for 1946 attaching virtual devices. 1947 </para> 1948 </listitem> 1949 1950 <listitem> 1951 <para> 1952 You can select which <emphasis role="bold">image 1953 file</emphasis> to use. 1939 The <emphasis role="bold">device slot</emphasis> of the 1940 controller that the virtual disk is connected to. IDE 1941 controllers have four slots which have traditionally been 1942 called primary master, primary slave, secondary master, 1943 and secondary slave. By contrast, SATA and SCSI 1944 controllers offer you up to 30 slots for attaching virtual 1945 devices. 1946 </para> 1947 </listitem> 1948 1949 <listitem> 1950 <para> 1951 The <emphasis role="bold">image file</emphasis> to use. 1954 1952 </para> 1955 1953 … … 1986 1984 typically be in the standard ISO format instead. Most 1987 1985 commonly, you will select this option when installing 1988 an operating system from an ISO file that you have1989 obtained from the Internet. For example, most Linux1990 distributions areavailable in this way.1986 an OS from an ISO file that you have obtained from the 1987 Internet. For example, most Linux distributions are 1988 available in this way. 1991 1989 </para> 1992 1990 … … 2003 2001 Drive</emphasis> from the list, then the physical 2004 2002 device of the host computer is connected to the 2005 VM, so that the guest operating system can read 2006 from and write to your physical device. This is, 2007 for instance, useful if you want to install 2008 Windows from a real installation CD. In this case, 2009 select your host drive from the drop-down list 2010 presented. 2003 VM, so that the guest OS can read from and write 2004 to your physical device. This is, for instance, 2005 useful if you want to install Windows from a real 2006 installation CD. In this case, select your host 2007 drive from the drop-down list presented. 2011 2008 </para> 2012 2009 … … 2187 2184 2188 2185 <para> 2189 If a virtual serial port is enabled, the guest operating system 2190 sees a standard 16550A compatible UART device. Other UART types 2191 can be configured using the <command>VBoxManage modifyvm</command> 2192 command. Both receiving and transmitting data is supported. How 2193 this virtual serial port is then connected to the host is 2194 configurable, and the details depend on your host operating 2195 system. 2186 If a virtual serial port is enabled, the guest OS sees a standard 2187 16550A compatible UART device. Other UART types can be configured 2188 using the <command>VBoxManage modifyvm</command> command. Both 2189 receiving and transmitting data is supported. How this virtual 2190 serial port is then connected to the host is configurable, and the 2191 details depend on your host OS. 2196 2192 </para> 2197 2193 … … 2294 2290 <emphasis role="bold">Host Pipe:</emphasis> Configure 2295 2291 &product-name; to connect the virtual serial port to a 2296 software pipe on the host. This depends on your host 2297 operating system,as follows:2292 software pipe on the host. This depends on your host OS, 2293 as follows: 2298 2294 </para> 2299 2295 … … 2441 2437 &product-name; can enable virtual machines to access the USB 2442 2438 devices on your host directly. To achieve this, &product-name; 2443 presents the guest operating system with a virtual USB2444 controller. As soon as the guest system starts using a USB2445 device, it will appear asunavailable on the host.2439 presents the guest OS with a virtual USB controller. As soon as 2440 the guest system starts using a USB device, it will appear as 2441 unavailable on the host. 2446 2442 </para> 2447 2443 … … 2809 2805 <para> 2810 2806 EFI provides two distinct video interfaces: GOP (Graphics Output 2811 Protocol) and UGA (Universal Graphics Adapter). Modern operating2812 s ystems, such as Mac OS X, generally use GOP, while some older2813 ones still use UGA. &product-name; provides a configuration2814 option to control the graphics resolution for both interfaces,2815 making thedifference mostly irrelevant for users.2807 Protocol) and UGA (Universal Graphics Adapter). Modern OSes, 2808 such as Mac OS X, generally use GOP, while some older ones still 2809 use UGA. &product-name; provides a configuration option to 2810 control the graphics resolution for both interfaces, making the 2811 difference mostly irrelevant for users. 2816 2812 </para> 2817 2813 -
trunk/doc/manual/en_US/user_ChangeLog.xml
r76078 r76786 10 10 11 11 <para> 12 This section summarizes the changes between VirtualBoxversions.12 This section summarizes the changes between &product-name; versions. 13 13 Note that this change log is not exhaustive and not all changes are 14 14 listed. … … 16 16 17 17 <para> 18 VirtualBoxversion numbers consist of three numbers separated by18 &product-name; version numbers consist of three numbers separated by 19 19 dots where the first and second number represent the major version 20 20 and the third number the minor version. Minor version numbers of … … 33 33 <para> 34 34 To view the change log for a legacy version of VirtualBox see the 35 documentation for the relevant VirtualBoxrelease.35 documentation for the relevant &product-name; release. 36 36 </para> 37 37 -
trunk/doc/manual/en_US/user_Frontends.xml
r76078 r76786 198 198 <listitem> 199 199 <para> 200 The Remmina remote desktop client can be usedwith VRDP.200 You can use the Remmina remote desktop client with VRDP. 201 201 This application is included with some Linux distributions, 202 202 such as Debian and Ubuntu. … … 404 404 <para> 405 405 An RDP viewer on the remote client. See 406 <xref 407 linkend="rdp-viewers" /> for examples. 406 <xref linkend="rdp-viewers" /> for examples. 408 407 </para> 409 408 </listitem> … … 469 468 470 469 <screen>VBoxManage storagectl "Windows XP" --name "IDE Controller" 471 470 --add ide --controller PIIX4</screen> 472 471 </listitem> 473 472 … … 479 478 480 479 <screen>VBoxManage storageattach "Windows XP" --storagectl "IDE Controller" 481 480 --port 0 --device 0 --type hdd --medium "WinXP.vdi"</screen> 482 481 </listitem> 483 482 … … 490 489 491 490 <screen>VBoxManage storageattach "Windows XP" --storagectl "IDE Controller" 492 491 --port 0 --device 1 --type dvddrive --medium /full/path/to/iso.iso</screen> 493 492 </listitem> 494 493 … … 1102 1101 running. This works regardless of the host operating system that 1103 1102 is running on the hosts. You can teleport virtual machines between 1104 Oracle Solaris and Mac hosts, for example.1103 Oracle Solaris and Mac OS X hosts, for example. 1105 1104 </para> 1106 1105 -
trunk/doc/manual/en_US/user_GuestAdditions.xml
r76162 r76786 1356 1356 The guest properties 1357 1357 <computeroutput>/VirtualBox/GuestAdd/SharedFolders/MountDir</computeroutput> 1358 and (more generic)1358 and the more generic 1359 1359 <computeroutput>/VirtualBox/GuestAdd/SharedFolders/MountPrefix</computeroutput> 1360 1360 can be used to override the automatic mount directory and … … 1433 1433 Drop</emphasis> menu item in the 1434 1434 <emphasis role="bold">Devices</emphasis> menu of the virtual 1435 machine, as shown below, or the <command>VBoxManage</command>. 1435 machine, as shown below, or the <command>VBoxManage</command> 1436 command. 1436 1437 </para> 1437 1438 … … 1603 1604 </para> 1604 1605 1605 < orderedlist>1606 <itemizedlist> 1606 1607 1607 1608 <listitem> … … 1665 1666 disabled by default and must be <emphasis>manually 1666 1667 enabled</emphasis> in the VM settings. See 1667 <xref 1668 linkend="generalsettings" />. 1668 <xref linkend="settings-display" />. 1669 1669 </para> 1670 1670 1671 1671 <note> 1672 1672 <para> 1673 Untrusted guest systems should not be allowed to use 1674 &product-name;'s 3D acceleration features, just as1673 Untrusted guest systems should not be allowed to use the 1674 3D acceleration features of &product-name;, just as 1675 1675 untrusted host software should not be allowed to use 3D 1676 1676 acceleration. Drivers for 3D hardware are generally too … … 1686 1686 </listitem> 1687 1687 1688 </ orderedlist>1688 </itemizedlist> 1689 1689 1690 1690 <para> … … 1764 1764 acceleration hardware instead of performing overlay stretching 1765 1765 and color conversion in software, which would be slow. This 1766 currently works for Windows, Linux and Mac host platforms,1766 currently works for Windows, Linux and Mac OS X host platforms, 1767 1767 provided that your host operating system can make use of 2D 1768 1768 video acceleration in the first place. … … 1774 1774 </para> 1775 1775 1776 < orderedlist>1776 <itemizedlist> 1777 1777 1778 1778 <listitem> … … 1794 1794 disabled by default and must be <emphasis>manually 1795 1795 enabled</emphasis> in the VM settings. See 1796 <xref 1797 linkend="generalsettings" />. 1798 </para> 1799 </listitem> 1800 1801 </orderedlist> 1796 <xref linkend="settings-display" />. 1797 </para> 1798 </listitem> 1799 1800 </itemizedlist> 1802 1801 1803 1802 <para> … … 2037 2036 2038 2037 <para> 2039 The properties <computeroutput>/VirtualBox/HostInfo/VBoxVer</computeroutput>, 2040 <computeroutput>/VirtualBox/HostInfo/VBoxVerExt</computeroutput> or 2041 <computeroutput>/VirtualBox/HostInfo/VBoxRev</computeroutput> can be waited 2042 on to detect that the VM state was restored from saved state or snapshot: 2038 The properties 2039 <computeroutput>/VirtualBox/HostInfo/VBoxVer</computeroutput>, 2040 <computeroutput>/VirtualBox/HostInfo/VBoxVerExt</computeroutput> 2041 or <computeroutput>/VirtualBox/HostInfo/VBoxRev</computeroutput> 2042 can be waited on to detect that the VM state was restored from 2043 saved state or snapshot: 2043 2044 </para> 2044 2045 … … 2046 2047 2047 2048 <para> 2048 Similarly the <computeroutput>/VirtualBox/HostInfo/ResumeCounter</computeroutput> 2049 can be used to detect that a VM was resumed from the paused state or saved state. 2049 Similarly the 2050 <computeroutput>/VirtualBox/HostInfo/ResumeCounter</computeroutput> 2051 can be used to detect that a VM was resumed from the paused 2052 state or saved state. 2050 2053 </para> 2051 2054 … … 2061 2064 The Guest Control File Manager is a feature of the Guest Additions 2062 2065 that enables easy copying and moving of files between a guest and 2063 the host system. 2064 </para> 2065 2066 <para> 2067 Other file management operations are supported, such as creating 2068 new folders and renaming files or deleting files. 2066 the host system. Other file management operations provide support 2067 to create new folders and to rename or delete files. 2069 2068 </para> 2070 2069 … … 2074 2073 <imageobject> 2075 2074 <imagedata align="center" fileref="images/guest-fm.png" 2076 width="1 0cm" />2075 width="12cm" /> 2077 2076 </imageobject> 2078 2077 </mediaobject> … … 2098 2097 <listitem> 2099 2098 <para> 2100 Displaythe Guest Control File Manager.2099 Open the Guest Control File Manager. 2101 2100 </para> 2102 2101 … … 2108 2107 2109 2108 <para> 2110 The Guest Control File Manager is displayed. Files on the 2111 host system are shown in the left pane. 2109 The left pane shows the files on the host system. 2112 2110 </para> 2113 2111 </listitem> … … 2119 2117 2120 2118 <para> 2121 In the panel at the bottom of the Guest Control File 2122 Manager, enter authentication credentials for a user on the 2123 guest system. 2119 At the bottom of the Guest Control File Manager, enter 2120 authentication credentials for a user on the guest system. 2124 2121 </para> 2125 2122 … … 2129 2126 2130 2127 <para> 2131 The guest VM file system is shown in the right pane of the 2132 Guest Control File Manager. 2133 </para> 2134 </listitem> 2135 2136 <listitem> 2137 <para> 2138 Transfer files between the guest and the host. 2139 </para> 2140 2141 <para> 2142 Use the file transfer icons to copy or move files between 2143 the guest and host. 2144 </para> 2145 2146 <para> 2147 You can copy and move files from guest to host, or from host 2148 to guest. 2149 </para> 2150 </listitem> 2151 2152 <listitem> 2153 <para> 2154 Close down the Guest Control File Manager. 2155 </para> 2156 2157 <para> 2158 Click <emphasis role="bold">Close</emphasis>. The guest 2159 session is ended and the Guest Control File Manager is 2160 closed down. 2128 The contents of the guest VM file system appears in the 2129 right pane of the Guest Control File Manager. 2130 </para> 2131 </listitem> 2132 2133 <listitem> 2134 <para> 2135 Transfer files between the guest and the host system by 2136 using the move and copy file transfer icons. 2137 </para> 2138 2139 <para> 2140 You can copy and move files from a guest to the host system 2141 or from the host system to the guest. 2142 </para> 2143 </listitem> 2144 2145 <listitem> 2146 <para> 2147 Close the Guest Control File Manager. 2148 </para> 2149 2150 <para> 2151 Click <emphasis role="bold">Close</emphasis> to end the 2152 guest session. 2161 2153 </para> 2162 2154 </listitem> … … 2432 2424 Enabling Page Fusion might indirectly increase the chances for 2433 2425 malicious guests to successfully attack other VMs running on 2434 the same host. 2435 2436 <!--See <xref linkend="pot-insecure"/>.--> 2426 the same host. See <xref linkend="pot-insecure"/>. 2437 2427 </para> 2438 2428 </note> -
trunk/doc/manual/en_US/user_Installation.xml
r76080 r76786 8 8 9 9 <title>Installation Details</title> 10 10 11 <para> 11 12 As installation of &product-name; varies depending on your host … … 76 77 Using either way displays the installation 77 78 <emphasis role="bold">Welcome</emphasis> dialog and enables you 78 to choose where to install &product-name;, and which components to79 install. In addition to the &product-name; application, the79 to choose where to install &product-name;, and which components 80 to install. In addition to the &product-name; application, the 80 81 following components are available: 81 82 </para> … … 87 88 <emphasis role="bold">USB support.</emphasis> This package 88 89 contains special drivers for your Windows host that 89 &product-name; requires to fully support USB devices inside your90 virtual machines.90 &product-name; requires to fully support USB devices inside 91 your virtual machines. 91 92 </para> 92 93 </listitem> … … 96 97 <emphasis role="bold">Networking.</emphasis> This package 97 98 contains extra networking drivers for your Windows host that 98 &product-name; needs to support Bridged Networking. This enables99 your VM's virtual network cards to be accessed from other100 machines on your physical network.99 &product-name; needs to support Bridged Networking. This 100 enables your VM's virtual network cards to be accessed from 101 other machines on your physical network. 101 102 </para> 102 103 </listitem> … … 105 106 <para> 106 107 <emphasis role="bold">Python support.</emphasis> This 107 package contains Python scripting support for the &product-name;108 API, see <xref linkend="VirtualBoxAPI" />. For this to work,109 an already working Windows Python installation on the system110 i s required.108 package contains Python scripting support for the 109 &product-name; API, see <xref linkend="VirtualBoxAPI" />. 110 For this to work, an already working Windows Python 111 installation on the system is required. 111 112 </para> 112 113 … … 119 120 <note> 120 121 <para> 121 Python version at least 2.6 is required. Since &product-name;122 5.1, Python 3 is also supported.122 Python version at least 2.6 is required. Since 123 &product-name; 5.1, Python 3 is also supported. 123 124 </para> 124 125 </note> … … 151 152 <para> 152 153 Then, run either of the following commands on the extracted .MSI 153 files. This will install &product-name; only for the current user. 154 files. This will install &product-name; only for the current 155 user. 154 156 </para> 155 157 … … 159 161 160 162 <para> 161 If you do not want to install all features of &product-name;, you 162 can set the optional <computeroutput>ADDLOCAL</computeroutput> 163 parameter to explicitly name the features to be installed. The 164 following features are available: 163 If you do not want to install all features of &product-name;, 164 you can set the optional 165 <computeroutput>ADDLOCAL</computeroutput> parameter to 166 explicitly name the features to be installed. The following 167 features are available: 165 168 </para> 166 169 … … 337 340 338 341 <para> 339 Specifies whether or not an &product-name; icon on the desktop340 should be created.342 Specifies whether or not an &product-name; icon on the 343 desktop should be created. 341 344 </para> 342 345 … … 387 390 388 391 <para> 389 Specifies whether to start &product-name; right 390 aftersuccessful installation.392 Specifies whether to start &product-name; right after 393 successful installation. 391 394 </para> 392 395 … … 467 470 468 471 <para> 469 To perform a non-interactive installation of &product-name; you can470 use the command line version of the installer application.472 To perform a non-interactive installation of &product-name; you 473 can use the command line version of the installer application. 471 474 </para> 472 475 … … 531 534 &product-name; graphical user interfaces. In particular, 532 535 <computeroutput>VirtualBox</computeroutput>, the graphical 533 VirtualBox Manager, requires both Qt and SDL. 534 If you only want to run <command>VBoxHeadless</command>,535 neither Qt nor SDL arerequired.536 VirtualBox Manager, requires both Qt and SDL. If you only want 537 to run <command>VBoxHeadless</command>, neither Qt nor SDL are 538 required. 536 539 </para> 537 540 </note> … … 639 642 640 643 <para> 641 &product-name; is available in a number of package formats native to642 various common Linux distributions. See644 &product-name; is available in a number of package formats 645 native to various common Linux distributions. See 643 646 <xref linkend="hostossupport"/>. In addition, there is an 644 647 alternative generic installer (.run) which should work on most … … 848 851 849 852 <para> 850 The sources for &product-name;'s kernel module are provided in the 851 <computeroutput>src</computeroutput> directory. To build the 852 module, change to the directory and use the following command: 853 The sources for &product-name;'s kernel module are provided in 854 the <computeroutput>src</computeroutput> directory. To build 855 the module, change to the directory and use the following 856 command: 853 857 </para> 854 858 … … 870 874 871 875 <para> 872 The &product-name; kernel module needs a device node to operate. 873 The above <command>make</command> command will tell you how to 874 create the device node, depending on your Linux system. The 875 procedure is slightly different for a classical Linux setup 876 with a <computeroutput>/dev</computeroutput> directory, a 877 system with the now deprecated <command>devfs</command> and a 878 modern Linux system with <command>udev</command>. 876 The &product-name; kernel module needs a device node to 877 operate. The above <command>make</command> command will tell 878 you how to create the device node, depending on your Linux 879 system. The procedure is slightly different for a classical 880 Linux setup with a <computeroutput>/dev</computeroutput> 881 directory, a system with the now deprecated 882 <command>devfs</command> and a modern Linux system with 883 <command>udev</command>. 879 884 </para> 880 885 … … 928 933 929 934 <para> 930 Before updating or uninstalling &product-name;, you must terminate 931 any virtual machines which are currently running and exit the 932 &product-name; or VBoxSVC applications. To update &product-name;, 933 simply run the installer of the updated version. To uninstall 934 &product-name;, run the installer as follows: 935 Before updating or uninstalling &product-name;, you must 936 terminate any virtual machines which are currently running and 937 exit the &product-name; or VBoxSVC applications. To update 938 &product-name;, simply run the installer of the updated 939 version. To uninstall &product-name;, run the installer as 940 follows: 935 941 </para> 936 942 … … 1050 1056 The Linux installers create the system user group 1051 1057 <computeroutput>vboxusers</computeroutput> during installation. 1052 Any system user who is going to use USB devices from &product-name;1053 guests must be a member of that group. A user can be made a1054 member of the group <computeroutput>vboxusers</computeroutput>1055 through the GUI user/group management or using the following1056 command:1058 Any system user who is going to use USB devices from 1059 &product-name; guests must be a member of that group. A user can 1060 be made a member of the group 1061 <computeroutput>vboxusers</computeroutput> through the GUI 1062 user/group management or using the following command: 1057 1063 </para> 1058 1064 … … 1066 1072 1067 1073 <para> 1068 The easiest way to start a &product-name; program is by running the1069 program of your choice (<command>VirtualBox</command>,1074 The easiest way to start a &product-name; program is by running 1075 the program of your choice (<command>VirtualBox</command>, 1070 1076 <command>VBoxManage</command>, or 1071 1077 <command>VBoxHeadless</command>) from a terminal. These are … … 1076 1082 <para> 1077 1083 The following detailed instructions should only be of interest 1078 if you wish to execute &product-name; without installing it first.1079 You should start by compiling the1084 if you wish to execute &product-name; without installing it 1085 first. You should start by compiling the 1080 1086 <computeroutput>vboxdrv</computeroutput> kernel module and 1081 1087 inserting it into the Linux kernel. &product-name; consists of a … … 1112 1118 1113 1119 <para> 1114 For the specific versions of Oracle Solaris that are supported as host1115 operating systems, see <xref1120 For the specific versions of Oracle Solaris that are supported as 1121 host operating systems, see <xref 1116 1122 linkend="hostossupport" />. 1117 1123 </para> 1118 1124 1119 1125 <para> 1120 If you have a previously installed instance of &product-name; on your 1121 Oracle Solaris host, please uninstall it first before installing a new 1122 instance. See <xref linkend="uninstall-solaris-host" /> for 1123 uninstall instructions. 1126 If you have a previously installed instance of &product-name; on 1127 your Oracle Solaris host, please uninstall it first before 1128 installing a new instance. See 1129 <xref linkend="uninstall-solaris-host" /> for uninstall 1130 instructions. 1124 1131 </para> 1125 1132 … … 1129 1136 1130 1137 <para> 1131 &product-name; is available as a standard Oracle Solaris package. Download 1132 the &product-name; SunOS package which includes the 64-bit versions 1133 of &product-name;. <emphasis>The installation must be performed as 1134 root and from the global zone</emphasis> as the &product-name; 1135 installer loads kernel drivers which cannot be done from 1136 non-global zones. To verify which zone you are currently in, 1137 execute the <command>zonename</command> command. Execute the 1138 following commands: 1138 &product-name; is available as a standard Oracle Solaris 1139 package. Download the &product-name; SunOS package which 1140 includes the 64-bit versions of &product-name;. <emphasis>The 1141 installation must be performed as root and from the global 1142 zone</emphasis> as the &product-name; installer loads kernel 1143 drivers which cannot be done from non-global zones. To verify 1144 which zone you are currently in, execute the 1145 <command>zonename</command> command. Execute the following 1146 commands: 1139 1147 </para> 1140 1148 … … 1142 1150 1143 1151 <para> 1144 The &product-name; kernel package is no longer a separate package1145 and has been integrated into the main package. Install the1146 &product-name; package as follows:1152 The &product-name; kernel package is no longer a separate 1153 package and has been integrated into the main package. Install 1154 the &product-name; package as follows: 1147 1155 </para> 1148 1156 … … 1157 1165 and proceed, as it is essential to execute this script which 1158 1166 installs the &product-name; kernel module. Following this 1159 confirmation the installer will install &product-name; and execute1160 the postinstall setup script.1167 confirmation the installer will install &product-name; and 1168 execute the postinstall setup script. 1161 1169 </para> 1162 1170 … … 1185 1193 The installer creates the system user group 1186 1194 <computeroutput>vboxuser</computeroutput> during installation 1187 for Oracle Solaris hosts that support the USB features required by 1188 &product-name;. Any system user who is going to use USB devices from 1189 &product-name; guests must be a member of this group. A user can be 1190 made a member of this group through the GUI user/group 1191 management or at the command line by executing as root: 1195 for Oracle Solaris hosts that support the USB features required 1196 by &product-name;. Any system user who is going to use USB 1197 devices from &product-name; guests must be a member of this 1198 group. A user can be made a member of this group through the GUI 1199 user/group management or at the command line by executing as 1200 root: 1192 1201 </para> 1193 1202 … … 1207 1216 1208 1217 <para> 1209 The easiest way to start a &product-name; program is by running the1210 program of your choice (<command>VirtualBox</command>,1218 The easiest way to start a &product-name; program is by running 1219 the program of your choice (<command>VirtualBox</command>, 1211 1220 <command>VBoxManage</command>, or 1212 1221 <command>VBoxHeadless</command>) from a terminal. These are … … 1262 1271 1263 1272 <para> 1264 To perform a non-interactive installation of &product-name; there is1265 a response file named1273 To perform a non-interactive installation of &product-name; 1274 there is a response file named 1266 1275 <computeroutput>autoresponse</computeroutput>, that the 1267 1276 installer will use for responses to inputs rather than ask them … … 1291 1300 1292 1301 <para> 1293 Assuming that &product-name; has already been installed into your1294 zone, you need to give the zone access to &product-name;'s device1295 node. This is done by performing the following steps. Start a1296 root terminal and run the following command:1302 Assuming that &product-name; has already been installed into 1303 your zone, you need to give the zone access to &product-name;'s 1304 device node. This is done by performing the following steps. 1305 Start a root terminal and run the following command: 1297 1306 </para> 1298 1307 … … 1320 1329 1321 1330 <para> 1322 If you are running &product-name; 2.2.0 or above on Oracle Solaris 11 or1323 above, you may also add a device for1331 If you are running &product-name; 2.2.0 or above on Oracle 1332 Solaris 11 or above, you may also add a device for 1324 1333 <computeroutput>/dev/vboxusbmon</computeroutput>, similar to 1325 that shown above. This does not apply to Oracle Solaris 10 hosts, due1326 to lack of USB support.1334 that shown above. This does not apply to Oracle Solaris 10 1335 hosts, due to lack of USB support. 1327 1336 </para> 1328 1337 -
trunk/doc/manual/en_US/user_Introduction.xml
r76079 r76786 16 16 &product-name; is a cross-platform virtualization application. What 17 17 does that mean? For one thing, it installs on your existing Intel or 18 AMD-based computers, whether they are running Windows, Mac , Linux or19 Oracle Solaris operating systems. Secondly, it extends the20 capabilities of your existing computer so that it can run multiple21 operating systems, inside multiple virtual machines, at the same22 time. So, for example, you can run Windows and Linux on your Mac,23 run Windows Server 2008 on your Linux server, run Linux on your24 Windows PC, and so on, all alongside your existing applications. You25 caninstall and run as many virtual machines as you like. The only18 AMD-based computers, whether they are running Windows, Mac OS X, 19 Linux, or Oracle Solaris operating systems (OSes). Secondly, it 20 extends the capabilities of your existing computer so that it can 21 run multiple OSes, inside multiple virtual machines, at the same 22 time. As an example, you can run Windows and Linux on your Mac, run 23 Windows Server 2016 on your Linux server, run Linux on your Windows 24 PC, and so on, all alongside your existing applications. You can 25 install and run as many virtual machines as you like. The only 26 26 practical limits are disk space and memory. 27 27 </para> … … 35 35 36 36 <para> 37 The following screenshot shows how &product-name;, installed on a 38 Mac computer, is running Windows 8 in a virtual machine window: 37 The following screenshot shows how &product-name;, installed on an 38 Apple Mac OS X computer, is running Windows Server 2016 in a virtual 39 machine window. 39 40 </para> 40 41 41 <figure id="fig-win 8-intro">42 <title>Windows 8Virtual Machine, Displayed on a Mac OS X Host</title>42 <figure id="fig-win2016-intro"> 43 <title>Windows Server 2016 Virtual Machine, Displayed on a Mac OS X Host</title> 43 44 <mediaobject> 44 45 <imageobject> … … 62 63 <xref linkend="features-overview" />. For existing &product-name; 63 64 users who just want to find out what is new in this release, see the 64 < emphasis>&product-name; Release Notes</emphasis>.65 <xref linkend="ChangeLog"/>. 65 66 </para> 66 67 … … 80 81 <emphasis role="bold">Running multiple operating systems 81 82 simultaneously.</emphasis> &product-name; enables you to run 82 more than one operating system at a time. This way, you can 83 run software written for one operating system on another, such 84 as Windows software on Linux or a Mac, without having to 85 reboot to use it. Since you can configure what kinds of 86 <emphasis>virtual</emphasis> hardware should be presented to 87 each such operating system, you can install an old operating 88 system such as DOS or OS/2 even if your real computer's 89 hardware is no longer supported by that operating system. 83 more than one OS at a time. This way, you can run software 84 written for one OS on another, such as Windows software on 85 Linux or a Mac, without having to reboot to use it. Since you 86 can configure what kinds of <emphasis>virtual</emphasis> 87 hardware should be presented to each such OS, you can install 88 an old OS such as DOS or OS/2 even if your real computer's 89 hardware is no longer supported by that OS. 90 90 </para> 91 91 </listitem> … … 166 166 <para> 167 167 <emphasis role="strong">Host operating system (host 168 OS).</emphasis> This is the operating system of the physical169 computer on which &product-name; was installed. There are170 versions of &product-name; for Windows, Mac OS X, Linux, and171 OracleSolaris hosts. See <xref linkend="hostossupport" />.168 OS).</emphasis> This is the OS of the physical computer on 169 which &product-name; was installed. There are versions of 170 &product-name; for Windows, Mac OS X, Linux, and Oracle 171 Solaris hosts. See <xref linkend="hostossupport" />. 172 172 </para> 173 173 … … 181 181 <listitem> 182 182 <para> 183 <emphasis role="strong"> Guest operating system (guest 184 OS).</emphasis> This is the operating system that is running 185 inside the virtual machine. Theoretically, &product-name; can 186 run any x86 operating system. such as DOS, Windows, OS/2, 187 FreeBSD, and OpenBSD. But to achieve near-native performance 188 of the guest code on your machine, we had to go through a lot 189 of optimizations that are specific to certain operating 190 systems. So while your favorite operating system 183 <emphasis role="strong">Guest operating system (guest 184 OS).</emphasis> This is the OS that is running inside the 185 virtual machine. Theoretically, &product-name; can run any x86 186 OS. such as DOS, Windows, OS/2, FreeBSD, and OpenBSD. But to 187 achieve near-native performance of the guest code on your 188 machine, we had to go through a lot of optimizations that are 189 specific to certain OSes. So while your favorite OS 191 190 <emphasis>may</emphasis> run as a guest, we officially support 192 191 and optimize for a select few, which include the most common 193 operating systems.192 OSes. 194 193 </para> 195 194 … … 203 202 <emphasis role="strong">Virtual machine (VM).</emphasis> This 204 203 is the special environment that &product-name; creates for 205 your guest operating system while it is running. In other206 words, you run your guest operating system207 <emphasis>in</emphasis> a VM. Normally, a VM will be shown as208 a window on your computer's desktop, but depending on which of209 the various frontends of &product-name; you use, it can be210 displayed in full screen mode or remotelyon another computer.204 your guest OS while it is running. In other words, you run 205 your guest OS <emphasis>in</emphasis> a VM. Normally, a VM 206 will be shown as a window on your computer's desktop, but 207 depending on which of the various frontends of &product-name; 208 you use, it can be displayed in full screen mode or remotely 209 on another computer. 211 210 </para> 212 211 … … 256 255 <para> 257 256 <emphasis role="bold">Portability.</emphasis> &product-name; 258 runs on a large number of 32-bit and 64-bit host operating 259 systems See <xref linkend="hostossupport" />. 257 runs on a large number of 32-bit and 64-bit host OS. See 258 <xref 259 linkend="hostossupport" />. 260 260 </para> 261 261 … … 266 266 <emphasis>bare-metal</emphasis> or <emphasis>type 1</emphasis> 267 267 hypervisor would run directly on the hardware, &product-name; 268 requires an existing operating system to be installed. It can269 thus runalongside existing applications on that host.268 requires an existing OS to be installed. It can thus run 269 alongside existing applications on that host. 270 270 </para> 271 271 … … 275 275 image formats are used. This enables you to run virtual 276 276 machines created on one host on another host with a different 277 host operating system. For example, you can create a virtual278 machine onWindows and then run it under Linux.277 host OS. For example, you can create a virtual machine on 278 Windows and then run it under Linux. 279 279 </para> 280 280 … … 374 374 into &product-name;. With its unique <emphasis>ACPI power 375 375 status support</emphasis>, &product-name; can even report 376 to ACPI-aware guest operating systems the power status of377 the host. For mobile systems running on battery, the guest378 can thus enable energy saving and notify the user of the379 remainingpower, for example in full screen modes.376 to ACPI-aware guest OSes the power status of the host. For 377 mobile systems running on battery, the guest can thus 378 enable energy saving and notify the user of the remaining 379 power, for example in full screen modes. 380 380 </para> 381 381 </listitem> … … 480 480 Microsoft Windows. Instead, the VRDE is plugged directly into 481 481 the virtualization layer. As a result, it works with guest 482 operating systems other than Windows, even in text mode, and 483 does not require application support in the virtual machine 484 either. The VRDE is described in detail in 485 <xref linkend="vrde" />. 482 OSes other than Windows, even in text mode, and does not 483 require application support in the virtual machine either. The 484 VRDE is described in detail in <xref linkend="vrde" />. 486 485 </para> 487 486 … … 527 526 528 527 <para> 529 Currently, &product-name; runs on the following host operating 530 systems: 528 Currently, &product-name; runs on the following host OSes: 531 529 </para> 532 530 … … 669 667 <listitem> 670 668 <para> 671 <emphasis role="bold">Linux hosts (64-bit).</emphasis> Includes the following: 669 <emphasis role="bold">Linux hosts (64-bit).</emphasis> 670 Includes the following: 672 671 </para> 673 672 … … 734 733 735 734 <para> 736 Note that Linux 2.4-based host operating systems are no longer 737 supported. 735 Note that Linux 2.4-based host OSes are no longer supported. 738 736 </para> 739 737 </listitem> … … 762 760 Note that the above list is informal. Oracle support for customers 763 761 who have a support contract is limited to a subset of the listed 764 host operating systems. Also, any feature which is marked as762 host OSes. Also, any feature which is marked as 765 763 <emphasis>experimental</emphasis> is not supported. Feedback and 766 764 suggestions about such features are welcome. … … 786 784 <para> 787 785 &product-name; comes in many different packages, and installation 788 depends on your host operating system. If you have installed789 software before, installation should be straightforward. On each790 host platform, &product-name; uses the installation method that is791 most common and easy to use. If you run into trouble or have792 special requirements, see <xref linkend="installation" /> for793 detailsabout the various installation methods.786 depends on your host OS. If you have installed software before, 787 installation should be straightforward. On each host platform, 788 &product-name; uses the installation method that is most common 789 and easy to use. If you run into trouble or have special 790 requirements, see <xref linkend="installation" /> for details 791 about the various installation methods. 794 792 </para> 795 793 … … 964 962 <para> 965 963 This window is called the <emphasis role="bold">VirtualBox 966 Manager</emphasis>. On the left, you can see a pane that will 967 later list all your virtual machines. Since you have not created 968 any, the list is empty. A row of buttons above it enables you to 969 create new VMs and work on existing VMs, once you have some. The 970 pane on the right displays the properties of the virtual machine 971 currently selected, if any. Again, since you do not have any 972 machines yet, the pane displays a welcome message. 973 </para> 974 975 <para> 976 To give you an idea what &product-name; might look like later, 977 after you have created many machines, here is another example: 964 Manager</emphasis>. The left pane will later list all your virtual 965 machines. Since you have not yet created any virtual machines, 966 this list is empty. The <emphasis role="bold">Tools</emphasis> 967 button provides access to user tools, such as the Virtual Media 968 Manager. 969 </para> 970 971 <para> 972 The pane on the right displays the properties of the currently 973 selected virtual machine. Since you do not have any machines yet, 974 the pane displays a welcome message. 975 </para> 976 977 <para> 978 The buttons on the right pane are used to create and work with 979 VMs. 980 </para> 981 982 <para> 983 The following figure gives an idea of what &product-name; might 984 look like after you have created some VMs. 978 985 </para> 979 986 … … 983 990 <imageobject> 984 991 <imagedata align="center" fileref="images/virtualbox-main.png" 985 width="1 0cm" />992 width="12cm" /> 986 993 </imageobject> 987 994 </mediaobject> … … 995 1002 996 1003 <para> 997 Click the <emphasis role="bold">New</emphasis> button at the top998 of the VirtualBox Manager window. A wizard is shown, to guide you999 through setting up a new virtual machine (VM):1004 Click <emphasis role="bold">New</emphasis> in the VirtualBox 1005 Manager window. A wizard is shown, to guide you through setting up 1006 a new virtual machine (VM). 1000 1007 </para> 1001 1008 … … 1032 1039 <listitem> 1033 1040 <para> 1041 The <emphasis role="bold">Machine Folder</emphasis> is the 1042 location where VMs are stored on your computer. The default 1043 folder location is shown. 1044 </para> 1045 </listitem> 1046 1047 <listitem> 1048 <para> 1034 1049 For <emphasis role="bold">Operating System Type</emphasis> 1035 select the operating system that you want to install later.1036 The supported operating systems are grouped. If you want to1037 install something veryunusual that is not listed, select1050 select the OS that you want to install later. The supported 1051 OSes are grouped. If you want to install something very 1052 unusual that is not listed, select 1038 1053 <emphasis role="bold">Other</emphasis>. Depending on your 1039 1054 selection, &product-name; will enable or disable certain VM 1040 settings that your guest operating system may require. This is1041 particularlyimportant for 64-bit guests. See1055 settings that your guest OS may require. This is particularly 1056 important for 64-bit guests. See 1042 1057 <xref linkend="intro-64bitguests" />. It is therefore 1043 1058 recommended to always set it to the correct value. … … 1051 1066 time the virtual machine is started. The amount of memory 1052 1067 given here will be taken away from your host machine and 1053 presented to the guest operating system, which will report1054 this size as thevirtual computer's installed RAM.1068 presented to the guest OS, which will report this size as the 1069 virtual computer's installed RAM. 1055 1070 </para> 1056 1071 … … 1083 1098 host computer, it is usually safe to allocate 512 MB to each 1084 1099 VM. In any case, make sure you always have at least 256 to 512 1085 MB of RAM left on your host operating system. Otherwise you 1086 may cause your host OS to excessively swap out memory to your 1087 hard disk, effectively bringing your host system to a 1088 standstill. 1100 MB of RAM left on your host OS. Otherwise you may cause your 1101 host OS to excessively swap out memory to your hard disk, 1102 effectively bringing your host system to a standstill. 1089 1103 </para> 1090 1104 … … 1214 1228 To prevent your physical hard disk from running full, 1215 1229 &product-name; limits the size of the image file. Still, it 1216 needs to be large enough to hold the contents of your 1217 operating system and the applications you want to install. For 1218 a modern Windows or Linux guest, you will probably need 1219 several gigabytes for any serious use. The limit of the image 1220 file size can be changed later, see 1221 <xref linkend="vboxmanage-modifyvdi"/>. 1230 needs to be large enough to hold the contents of your OS and 1231 the applications you want to install. For a modern Windows or 1232 Linux guest, you will probably need several gigabytes for any 1233 serious use. The limit of the image file size can be changed 1234 later, see <xref linkend="vboxmanage-modifyvdi"/>. 1222 1235 </para> 1223 1236 … … 1320 1333 displayed. This wizard helps you to select an installation 1321 1334 medium. Since the VM is created empty, it would otherwise behave 1322 just like a real computer with no operating system installed. It1323 will do nothing and display an error message that no bootable1324 operating system wasfound.1335 just like a real computer with no OS installed. It will do 1336 nothing and display an error message that no bootable OS was 1337 found. 1325 1338 </para> 1326 1339 1327 1340 <para> 1328 1341 For this reason, the wizard helps you to select a medium to 1329 install an operating systemfrom.1342 install an OS from. 1330 1343 </para> 1331 1344 … … 1335 1348 <para> 1336 1349 If you have physical CD or DVD media from which you want to 1337 install your guest operating system, such as a Windows 1338 installation CD or DVD, put the media into your host's CD or 1339 DVD drive. 1350 install your guest OS, such as a Windows installation CD or 1351 DVD, put the media into your host's CD or DVD drive. 1340 1352 </para> 1341 1353 … … 1380 1392 <para> 1381 1393 After completing the choices in the wizard, you will be able to 1382 install your operating system.1394 install your OS. 1383 1395 </para> 1384 1396 … … 1392 1404 &product-name; provides a virtual USB tablet device to new 1393 1405 virtual machines through which mouse events are communicated to 1394 the guest operating system. If you are running a modern guest 1395 operating system that can handle such devices, mouse support may 1396 work out of the box without the mouse being 1397 <emphasis>captured</emphasis> as described below. See 1398 <xref linkend="settings-motherboard" />. 1406 the guest OS. If you are running a modern guest OS that can 1407 handle such devices, mouse support may work out of the box 1408 without the mouse being <emphasis>captured</emphasis> as 1409 described below. See <xref linkend="settings-motherboard" />. 1399 1410 </para> 1400 1411 1401 1412 <para> 1402 1413 Otherwise, if the virtual machine only sees standard PS/2 mouse 1403 and keyboard devices, since the operating system in the virtual1404 machine does not know that it is not running on a real computer,1405 it expects to have exclusive control over your keyboard and1406 mouse. But unless you are running the VM in full screen mode,1407 your VM needs to share keyboard and mouse with other1408 applications and possiblyother VMs on your host.1409 </para> 1410 1411 <para> 1412 After installing a guest operating system and before you install1413 the Guest Additions, described later, either your VM or the rest1414 of your computer can "own" the keyboard and the mouse. Both1415 cannot own the keyboard and mouse at the same time. You will see1416 a<emphasis>second</emphasis> mouse pointer which is always1414 and keyboard devices, since the OS in the virtual machine does 1415 not know that it is not running on a real computer, it expects 1416 to have exclusive control over your keyboard and mouse. But 1417 unless you are running the VM in full screen mode, your VM needs 1418 to share keyboard and mouse with other applications and possibly 1419 other VMs on your host. 1420 </para> 1421 1422 <para> 1423 After installing a guest OS and before you install the Guest 1424 Additions, described later, either your VM or the rest of your 1425 computer can "own" the keyboard and the mouse. Both cannot own 1426 the keyboard and mouse at the same time. You will see a 1427 <emphasis>second</emphasis> mouse pointer which is always 1417 1428 confined to the limits of the VM window. You activate the VM by 1418 1429 clicking inside it. … … 1420 1431 1421 1432 <para> 1422 To return ownership of keyboard and mouse to your host operating1423 system, &product-name; reserves a special key on your keyboard:1424 the<emphasis>Host key</emphasis>. By default, this is the1433 To return ownership of keyboard and mouse to your host OS, 1434 &product-name; reserves a special key on your keyboard: the 1435 <emphasis>Host key</emphasis>. By default, this is the 1425 1436 <emphasis>right Ctrl key</emphasis> on your keyboard. On a Mac 1426 1437 host, the default Host key is the left Command key. You can … … 1452 1463 the VM if the VM window on your host desktop has the 1453 1464 keyboard focus. If you have many windows open in your guest 1454 operating system, the window that has the focus in your VM1455 is used. This means that if you want to enter text within1456 your VM, clickon the title bar of your VM window first.1465 OS, the window that has the focus in your VM is used. This 1466 means that if you want to enter text within your VM, click 1467 on the title bar of your VM window first. 1457 1468 </para> 1458 1469 … … 1518 1529 1519 1530 <para> 1520 Operating systems expect certain key combinations to initiate 1521 certain procedures. Some of these key combinations may be 1522 difficult to enter into a virtual machine, as there are three 1523 candidates as to who receives keyboard input: the host operating 1524 system, &product-name;, or the guest operating system. Which of 1525 these three receives keypresses depends on a number of factors, 1526 including the key itself. 1531 OSes expect certain key combinations to initiate certain 1532 procedures. Some of these key combinations may be difficult to 1533 enter into a virtual machine, as there are three candidates as 1534 to who receives keyboard input: the host OS, &product-name;, or 1535 the guest OS. Which of these three receives keypresses depends 1536 on a number of factors, including the key itself. 1527 1537 </para> 1528 1538 … … 1531 1541 <listitem> 1532 1542 <para> 1533 Host operating systems reserve certain key combinations for1534 themselves.For example, it is impossible to enter the1543 Host OSes reserve certain key combinations for themselves. 1544 For example, it is impossible to enter the 1535 1545 <emphasis role="bold">Ctrl+Alt+Delete</emphasis> combination 1536 if you want to reboot the guest operating system in your1537 virtual machine, because this key combination is usually1538 h ard-wired into the host OS, both Windows and Linux1539 intercept this, and pressing this key combination will1540 therefore reboot your<emphasis>host</emphasis>.1546 if you want to reboot the guest OS in your virtual machine, 1547 because this key combination is usually hard-wired into the 1548 host OS, both Windows and Linux intercept this, and pressing 1549 this key combination will therefore reboot your 1550 <emphasis>host</emphasis>. 1541 1551 </para> 1542 1552 … … 1559 1569 normally enables you to switch between virtual terminals. As 1560 1570 with Ctrl+Alt+Delete, these combinations are intercepted by 1561 the host operating system and therefore always switch1562 terminals on the<emphasis>host</emphasis>.1571 the host OS and therefore always switch terminals on the 1572 <emphasis>host</emphasis>. 1563 1573 </para> 1564 1574 1565 1575 <para> 1566 1576 If, instead, you want to send these key combinations to the 1567 <emphasis>guest</emphasis> operating system in the virtual1568 machine, youwill need to use one of the following methods:1577 <emphasis>guest</emphasis> OS in the virtual machine, you 1578 will need to use one of the following methods: 1569 1579 </para> 1570 1580 … … 1656 1666 media in the <emphasis role="bold">Devices</emphasis> menu of 1657 1667 the VM's window. Here you can select in detail what 1658 &product-name; presents to your VM as a CD, DVD, or floppy. 1659 </para> 1660 1661 <para> 1662 The settings are the same as would be available for the VM in 1663 the <emphasis role="bold">Settings</emphasis> dialog of the 1668 &product-name; presents to your VM as a CD, DVD, or floppy 1669 drive. 1670 </para> 1671 1672 <para> 1673 The settings are the same as those available for the VM in the 1674 <emphasis role="bold">Settings</emphasis> dialog of the 1664 1675 &product-name; main window. But as the 1665 1676 <emphasis role="bold">Settings</emphasis> dialog is disabled 1666 while the VM is in the Running or Saved state, this extra menu 1667 saves you from having to shut down and restart the VM every time 1668 you want to change media. 1669 </para> 1670 1671 <para> 1672 Hence, in the <emphasis role="bold">Devices</emphasis> menu, 1673 &product-name; enables you to attach the host drive to the guest 1674 or select a floppy or DVD image using the Disk Image Manager, as 1675 described in <xref linkend="configbasics" />. 1677 while the VM is in the Running or Saved state, the 1678 <emphasis role="bold">Devices</emphasis> menu saves you from 1679 having to shut down and restart the VM every time you want to 1680 change media. 1681 </para> 1682 1683 <para> 1684 Using the <emphasis role="bold">Devices</emphasis> menu, you can 1685 attach the host drive to the guest or select a floppy or DVD 1686 image, as described in <xref linkend="settings-storage" />. 1687 </para> 1688 1689 <para> 1690 The <emphasis role="bold">Devices</emphasis> menu also includes 1691 an option for creating a virtual ISO (VISO) from selected files 1692 on the host. 1676 1693 </para> 1677 1694 … … 1691 1708 <listitem> 1692 1709 <para> 1693 If you have <emphasis role="bold">scale mode</emphasis>1710 If you have <emphasis role="bold">scaled mode</emphasis> 1694 1711 enabled, then the virtual machine's screen will be scaled to 1695 1712 the size of the window. This can be useful if you have many … … 1698 1715 might be useful to enlarge a window if the VM's output 1699 1716 screen is very small, for example because you are running an 1700 old operating system in it. 1701 </para> 1702 1703 <para> 1704 To enable scale mode, press the <emphasis role="bold">Host 1705 key + C</emphasis>, or select <emphasis role="bold">Scale 1706 mode</emphasis> from the 1707 <emphasis role="bold">Machine</emphasis> menu in the VM 1708 window. To leave scale mode, press the Host key + C again. 1717 old OS in it. 1718 </para> 1719 1720 <para> 1721 To enable scaled mode, press <emphasis role="bold">Host key 1722 + C</emphasis>, or select <emphasis role="bold">Scaled 1723 Mode</emphasis> from the 1724 <emphasis role="bold">View</emphasis> menu in the VM window. 1725 To leave scaled mode, press <emphasis role="bold">Host key + 1726 C </emphasis>again. 1709 1727 </para> 1710 1728 … … 1726 1744 automatic <emphasis role="bold">resizing</emphasis>, the 1727 1745 Guest Additions will automatically adjust the screen 1728 resolution of the guest operating system. For example, if1729 you are running a Windows guest with a resolution of1730 1024x768 pixels and you then resize the VM window to make it1731 100 pixels wider, the Guest Additions will change the1732 Windows display resolutionto 1124x768.1746 resolution of the guest OS. For example, if you are running 1747 a Windows guest with a resolution of 1024x768 pixels and you 1748 then resize the VM window to make it 100 pixels wider, the 1749 Guest Additions will change the Windows display resolution 1750 to 1124x768. 1733 1751 </para> 1734 1752 … … 1768 1786 <imageobject> 1769 1787 <imagedata align="center" fileref="images/vm-close.png" 1770 width="1 1cm" />1788 width="10cm" /> 1771 1789 </imageobject> 1772 1790 </mediaobject> … … 1803 1821 machine, which has the same effect as if you had pressed the 1804 1822 power button on a real computer. So long as the VM is 1805 running a fairly modern operating system, this should1806 trigger a propershutdown mechanism from within the VM.1823 running a fairly modern OS, this should trigger a proper 1824 shutdown mechanism from within the VM. 1807 1825 </para> 1808 1826 </listitem> … … 1819 1837 This is equivalent to pulling the power plug on a real 1820 1838 computer without shutting it down properly. If you start 1821 the machine again after powering it off, your operating 1822 system will have to reboot completely and may begin a 1823 lengthy check of its virtual system disks. As a result, 1824 this should not normally be done, since it can potentially 1825 cause data loss or an inconsistent state of the guest 1826 system on disk. 1839 the machine again after powering it off, your OS will have 1840 to reboot completely and may begin a lengthy check of its 1841 virtual system disks. As a result, this should not 1842 normally be done, since it can potentially cause data loss 1843 or an inconsistent state of the guest system on disk. 1827 1844 </para> 1828 1845 </warning> … … 1859 1876 VM groups enable the user to create ad hoc groups of VMs, and to 1860 1877 manage and perform functions on them collectively, as well as 1861 individually. There are a number of features relating to groups. 1862 </para> 1863 1864 <orderedlist> 1865 1866 <listitem> 1867 <para> 1868 Create a group using the GUI. Do one of the following: 1878 individually. 1879 </para> 1880 1881 <para> 1882 The following figure shows VM groups displayed in VirtualBox 1883 Manager. 1884 </para> 1885 1886 <figure id="fig-vm-groups"> 1887 <title>Groups of Virtual Machines</title> 1888 <mediaobject> 1889 <imageobject> 1890 <imagedata align="center" fileref="images/vm-groups.png" 1891 width="10cm" /> 1892 </imageobject> 1893 </mediaobject> 1894 </figure> 1895 1896 <para> 1897 The following features are available for groups: 1898 </para> 1899 1900 <itemizedlist> 1901 1902 <listitem> 1903 <para> 1904 Create a group using the VirtualBox Manager. Do one of the 1905 following: 1869 1906 </para> 1870 1907 … … 1881 1918 Select multiple VMs and select 1882 1919 <emphasis role="bold">Group</emphasis> from the 1883 right-click menu, as shown in the following image. 1884 </para> 1885 1886 <figure id="fig-vm-groups"> 1887 <title>Creating a Group of Virtual Machines</title> 1888 <mediaobject> 1889 <imageobject> 1890 <imagedata align="center" fileref="images/vm-groups.png" 1891 width="10cm" /> 1892 </imageobject> 1893 </mediaobject> 1894 </figure> 1920 right-click menu. 1921 </para> 1895 1922 </listitem> 1896 1923 … … 1911 1938 </para> 1912 1939 1913 <screen>VBoxManage modifyvm " Fred" --groups "/TestGroup"</screen>1940 <screen>VBoxManage modifyvm "vm01" --groups "/TestGroup"</screen> 1914 1941 1915 1942 <para> 1916 1943 This command creates a group "TestGroup" and attaches the 1917 VM " Fred" to that group.1944 VM "vm01" to that group. 1918 1945 </para> 1919 1946 </listitem> … … 1925 1952 </para> 1926 1953 1927 <screen>VBoxManage modifyvm " Fred" --groups ""</screen>1928 1929 <para> 1930 This command detaches all groups from the VM " Fred" and1954 <screen>VBoxManage modifyvm "vm01" --groups ""</screen> 1955 1956 <para> 1957 This command detaches all groups from the VM "vm01" and 1931 1958 deletes the empty group. 1932 1959 </para> … … 1941 1968 </para> 1942 1969 1943 <screen>VBoxManage modifyvm " Fred" --groups "/TestGroup,/TestGroup2"</screen>1970 <screen>VBoxManage modifyvm "vm01" --groups "/TestGroup,/TestGroup2"</screen> 1944 1971 1945 1972 <para> 1946 1973 This command creates the groups "TestGroup" and "TestGroup2", 1947 if they do not exist, and attaches the VM " Fred" to both of1974 if they do not exist, and attaches the VM "vm01" to both of 1948 1975 them. 1949 1976 </para> … … 1955 1982 </para> 1956 1983 1957 <screen>VBoxManage modifyvm " Fred" --groups "/TestGroup/TestGroup2"</screen>1958 1959 <para> 1960 This command attaches the VM " Fred" to the subgroup1984 <screen>VBoxManage modifyvm "vm01" --groups "/TestGroup/TestGroup2"</screen> 1985 1986 <para> 1987 This command attaches the VM "vm01" to the subgroup 1961 1988 "TestGroup2" of the "TestGroup" group. 1962 1989 </para> … … 1971 1998 </listitem> 1972 1999 1973 </ orderedlist>2000 </itemizedlist> 1974 2001 1975 2002 </sect1> … … 1989 2016 1990 2017 <para> 1991 You can see the snapshots of a virtual machine by first selecting 1992 a machine in the VirtualBox Manager and then clicking 1993 <emphasis role="bold">Snapshots</emphasis> at the top right. Until 2018 To see the snapshots of a virtual machine, click on the machine 2019 name in VirtualBox Manager. Then click the 2020 <emphasis role="bold">List</emphasis> icon next to the machine 2021 name, and select <emphasis role="bold">Snapshots</emphasis>. Until 1994 2022 you take a snapshot of the machine, the list of snapshots will be 1995 2023 empty except for the <emphasis role="bold">Current … … 2019 2047 <listitem> 2020 2048 <para> 2021 If your VM is currently running, select2022 <emphasis role="bold">TakeSnapshot</emphasis> from the2049 If your VM is running, select <emphasis role="bold">Take 2050 Snapshot</emphasis> from the 2023 2051 <emphasis role="bold">Machine</emphasis> pull-down menu 2024 2052 of the VM window. … … 2028 2056 <listitem> 2029 2057 <para> 2030 If your VM is currently in either the Saved or the 2031 Powered Off state, as displayed next to the VM in the 2032 &product-name; main window, click on the 2033 <emphasis role="bold">Snapshots </emphasis>tab on the 2034 top right of the main window. Do one of the following: 2058 If your VM is in either the Saved or the Powered Off 2059 state, as displayed next to the VM name in the 2060 &product-name; main window, click the 2061 <emphasis role="bold">List</emphasis> icon next to the 2062 machine name and select 2063 <emphasis role="bold">Snapshots</emphasis>. The 2064 snapshots window is shown. Do one of the following: 2035 2065 </para> 2036 2066 … … 2039 2069 <listitem> 2040 2070 <para> 2041 Click on the small camera icon. 2071 Click the <emphasis role="bold">Take</emphasis> 2072 icon. 2042 2073 </para> 2043 2074 </listitem> … … 2047 2078 Right-click on the <emphasis role="bold">Current 2048 2079 State </emphasis>item in the list and select 2049 <emphasis role="bold">Take Snapshot</emphasis> from 2050 the menu. 2080 <emphasis role="bold">Take</emphasis>. 2051 2081 </para> 2052 2082 </listitem> … … 2070 2100 Your new snapshot will then appear in the snapshots list. 2071 2101 Underneath your new snapshot, you will see an item called 2072 Current State, signifying that the current state of your VM 2073 is a variation based on the snapshot you took earlier. If 2074 you later take another snapshot, you will see that they will 2075 be displayed in sequence, and each subsequent snapshot is 2076 derived from an earlier one. 2102 <emphasis role="bold">Current State</emphasis>, signifying 2103 that the current state of your VM is a variation based on 2104 the snapshot you took earlier. If you later take another 2105 snapshot, you will see that they are displayed in sequence, 2106 and that each subsequent snapshot is derived from an earlier 2107 one. 2077 2108 </para> 2078 2109 2079 2110 <figure id="fig-snapshots-list"> 2080 <title>Snapshots List for a Virtual Machine</title>2111 <title>Snapshots List For a Virtual Machine</title> 2081 2112 <mediaobject> 2082 2113 <imageobject> 2083 2114 <imagedata align="center" fileref="images/snapshots-1.png" 2084 width="1 2cm" />2115 width="10cm" /> 2085 2116 </imageobject> 2086 2117 </mediaobject> … … 2099 2130 <listitem> 2100 2131 <para> 2101 <emphasis role="bold">Restore a snapshot</emphasis>. You do 2102 this by right-clicking on any snapshot you have taken in the 2103 list of snapshots. By restoring a snapshot, you go back or 2104 forward in time. The current state of the machine is lost, 2105 and the machine is restored to the exact state it was in 2106 when the snapshot was taken. 2132 <emphasis role="bold">Restore a snapshot</emphasis>. In the 2133 list of snapshots, right-click on any snapshot you have 2134 taken and select <emphasis role="bold">Restore</emphasis>. 2135 By restoring a snapshot, you go back or forward in time. The 2136 current state of the machine is lost, and the machine is 2137 restored to the exact state it was in when the snapshot was 2138 taken. 2107 2139 </para> 2108 2140 … … 2122 2154 <emphasis>not</emphasis> included in snapshots, they 2123 2155 remain unaltered when a machine is reverted. See 2124 <xref 2125 linkend="hdimagewrites" />. 2156 <xref linkend="hdimagewrites" />. 2126 2157 </para> 2127 2158 </note> … … 2129 2160 <para> 2130 2161 To avoid losing the current state when restoring a snapshot, 2131 you can create a new snapshot before the restore .2162 you can create a new snapshot before the restore operation. 2132 2163 </para> 2133 2164 … … 2148 2179 releases the files on disk that &product-name; used to store 2149 2180 the snapshot data, thus freeing disk space. To delete a 2150 snapshot, right-click on it in the snapshots tree and select2151 <emphasis role="bold">Delete</emphasis>. Snapshots can be2152 deleted even while a machine is running.2181 snapshot, right-click on the snapshot name in the snapshots 2182 tree and select <emphasis role="bold">Delete</emphasis>. 2183 Snapshots can be deleted even while a machine is running. 2153 2184 </para> 2154 2185 … … 2182 2213 <para> 2183 2214 Think of a snapshot as a point in time that you have preserved. 2184 More formally, a snapshot consists of the following three 2185 things: 2215 More formally, a snapshot consists of the following: 2186 2216 </para> 2187 2217 … … 2219 2249 in "normal" mode. You can configure disks to behave 2220 2250 differently with snapshots, see 2221 <xref linkend="hdimagewrites" />. Even more formally and2222 technically correct, it is not the virtual disk itself that2223 is restored when a snapshot is restored. Instead, when a2224 snapshot is taken, &product-name; creates differencing2225 images which contain only the changes since the snapshot2226 were taken, and when the snapshot is restored,2227 &product-name; throws away that differencing image, thus2228 going back to the previous state. This is both faster and2229 uses less disk space. For the details, which can be complex,2230 see<xref linkend="diffimages" />.2251 <xref linkend="hdimagewrites" />. In technical terms, it is 2252 not the virtual disk itself that is restored when a snapshot 2253 is restored. Instead, when a snapshot is taken, 2254 &product-name; creates differencing images which contain 2255 only the changes since the snapshot were taken. When the 2256 snapshot is restored, &product-name; throws away that 2257 differencing image, thus going back to the previous state. 2258 This is both faster and uses less disk space. For the 2259 details, which can be complex, see 2260 <xref linkend="diffimages" />. 2231 2261 </para> 2232 2262 … … 2275 2305 2276 2306 <para> 2277 Clicking on the <emphasis role="bold">Settings</emphasis> button 2278 in the toolbar at the top brings up a detailed window where you 2279 can configure many of the properties of the selected VM. But be 2280 careful. Even though it is possible to change all VM settings 2281 after installing a guest operating system, certain changes might 2282 prevent a guest operating system from functioning correctly if 2283 done after installation. 2307 Clicking on <emphasis role="bold">Settings</emphasis> displays a 2308 window, where you can configure many of the properties of the 2309 selected VM. But be careful when changing VM settings. It is 2310 possible to change all VM settings after installing a guest OS, 2311 but certain changes might prevent a guest OS from functioning 2312 correctly if done after installation. 2284 2313 </para> 2285 2314 … … 2290 2319 because the <emphasis role="bold">Settings</emphasis> dialog 2291 2320 enables you to change fundamental characteristics of the virtual 2292 computer that is created for your guest operating system, and2293 this operating system may perform well when, for example, half2294 of its memory is takenaway. As a result, if the2321 machine that is created for your guest OS. For example, the 2322 guest OS may not perform well if half of its memory is taken 2323 away. As a result, if the 2295 2324 <emphasis role="bold">Settings</emphasis> button is disabled, 2296 2325 shut down the current VM first. … … 2303 2332 changed in the <emphasis role="bold">Settings</emphasis> window 2304 2333 are described in detail in <xref linkend="BasicConcepts" />. Even 2305 more parameters are available with the &product-name; command line 2306 interface. See <xref linkend="vboxmanage" />. 2334 more parameters are available when using the 2335 <command>VBoxManage</command> command line interface. See 2336 <xref linkend="vboxmanage" />. 2307 2337 </para> 2308 2338 … … 2314 2344 2315 2345 <para> 2316 You can easily remove a virtual machine from &product-name;.2317 Alternatively, you can move the virtual machine and associated2318 files, such as a disk image, to another location on thehost.2346 You can remove a VM from &product-name; or move the VM and its 2347 associated files, such as disk images, to another location on the 2348 host. 2319 2349 </para> 2320 2350 … … 2324 2354 <para> 2325 2355 <emphasis role="bold">Removing a VM.</emphasis> To remove a 2326 virtual machine which you no longer need, right-click on the 2327 VM in the VirtualBox Manager's machine list and select 2328 <emphasis role="bold">Remove</emphasis>. 2329 </para> 2330 2331 <para> 2332 A confirmation dialog is displayed that enables you to select 2333 whether the virtual machine should only be removed from the 2334 list of machines, or whether the files associated with it 2335 should also be deleted. 2336 </para> 2337 2338 <para> 2339 The <emphasis role="bold">Remove</emphasis> menu item is 2340 disabled while a VM is running. 2341 </para> 2342 </listitem> 2343 2344 <listitem> 2345 <para> 2346 <emphasis role="bold">Moving a VM.</emphasis> To move a 2347 virtual machine to a new location on the host, right-click on 2348 the VM in the VirtualBox Manager's machine list and select 2349 <emphasis role="bold">Move</emphasis>. 2350 </para> 2351 2352 <para> 2353 A file dialog prompts you to select a new location for the 2354 virtual machine. 2356 VM, right-click on the VM in the VirtualBox Manager's machine 2357 list and select <emphasis role="bold">Remove</emphasis>. 2358 </para> 2359 2360 <para> 2361 The confirmation dialog enables you to specify whether to only 2362 remove the VM from the list of machines or to remove the files 2363 associated with the VM. 2364 </para> 2365 2366 <para> 2367 Note that the <emphasis role="bold">Remove</emphasis> menu 2368 item is disabled while a VM is running. 2369 </para> 2370 </listitem> 2371 2372 <listitem> 2373 <para> 2374 <emphasis role="bold">Moving a VM.</emphasis> To move a VM to 2375 a new location on the host, right-click on the VM in the 2376 VirtualBox Manager's machine list and select 2377 <emphasis 2378 role="bold">Move</emphasis>. 2379 </para> 2380 2381 <para> 2382 The file dialog prompts you to specify a new location for the 2383 VM. 2355 2384 </para> 2356 2385 … … 2361 2390 2362 2391 <para> 2363 The <emphasis role="bold">Move</emphasis> menu item is2364 disabled while a VM is running.2365 </para> 2366 2367 <para> 2368 You can also use the <command>VBoxManage </command> command to2369 move a VM. See <xref linkend="vboxmanage-movevm"/>.2392 Note that the <emphasis role="bold">Move</emphasis> menu item 2393 is disabled while a VM is running. 2394 </para> 2395 2396 <para> 2397 You can also use the <command>VBoxManage movevm</command> 2398 command to move a VM. See <xref linkend="vboxmanage-movevm"/>. 2370 2399 </para> 2371 2400 </listitem> … … 2374 2403 2375 2404 <para> 2376 For details ofremoving or moving a disk image file from2405 For information about removing or moving a disk image file from 2377 2406 &product-name;, see <xref linkend="vdis"/>. 2378 2407 </para> … … 2385 2414 2386 2415 <para> 2387 To experiment with a VM configuration, test different guest OS2388 levels or to simply backup a VM, &product-name; can create a full2389 or a linked copy of an existing VM. This is called2390 <emphasis>cloning</emphasis> a virtual machine.2416 You can create a full copy or a linked copy of an existing VM. 2417 This copy is called a <emphasis>clone</emphasis>. You might use a 2418 cloned VM to experiment with a VM configuration, to test different 2419 guest OS levels, or to back up a VM. 2391 2420 </para> 2392 2421 … … 2409 2438 Start the wizard by clicking 2410 2439 <emphasis role="bold">Clone</emphasis> in the right-click menu of 2411 the VirtualBox Manager's machine list ,or in the2440 the VirtualBox Manager's machine list or in the 2412 2441 <emphasis role="bold">Snapshots</emphasis> view of the selected 2413 2442 VM. … … 2415 2444 2416 2445 <para> 2417 Entera new <emphasis role="bold">Name</emphasis> for the clone.2446 Specify a new <emphasis role="bold">Name</emphasis> for the clone. 2418 2447 You can choose a <emphasis role="bold">Path</emphasis> for the 2419 cloned virtual machine, otherwise the default machines folder is2420 used.2421 </para> 2422 2423 <para> 2424 The <emphasis role="bold">Clone Type</emphasis> option is used to2425 specify if the clone should be linked to the source VM, or ifa2426 fully independent clone should be created, as follows:2448 cloned virtual machine, otherwise &product-name; uses the default 2449 machines folder. 2450 </para> 2451 2452 <para> 2453 The <emphasis role="bold">Clone Type</emphasis> option specifies 2454 whether to create a clone linked to the source VM or to create a 2455 fully independent clone: 2427 2456 </para> 2428 2457 … … 2431 2460 <listitem> 2432 2461 <para> 2433 <emphasis role="bold">Full Clone:</emphasis> In this mode, all 2434 dependent disk images are copied to the new VM folder. The 2435 clone can fully operate without the source VM. 2436 </para> 2437 </listitem> 2438 2439 <listitem> 2440 <para> 2441 <emphasis role="bold">Linked Clone:</emphasis> In this mode, 2442 new differencing disk images are created where the parent disk 2443 images are the source disk images. If you selected the current 2444 state of the source VM as clone point, a new snapshot will be 2445 created implicitly. 2462 <emphasis role="bold">Full Clone:</emphasis> Copies all 2463 dependent disk images to the new VM folder. A full clone can 2464 operate fully without the source VM. 2465 </para> 2466 </listitem> 2467 2468 <listitem> 2469 <para> 2470 <emphasis role="bold">Linked Clone:</emphasis> Creates new 2471 differencing disk images based on the source VM disk images. 2472 If you select the current state of the source VM as the clone 2473 point, &product-name; creates a new snapshot. 2446 2474 </para> 2447 2475 </listitem> … … 2450 2478 2451 2479 <para> 2452 The <emphasis role="bold">Snapshots</emphasis> option determines 2453 what should be cloned. You can create a clone of the 2454 <emphasis role="bold">Current Machine State</emphasis> only or 2455 <emphasis role="bold">Everything</emphasis>. When you select 2456 <emphasis role="bold">Everything</emphasis>, the current machine 2457 state and additionally all snapshots are cloned. If you started 2458 from a snapshot which has additional children, you can also clone 2459 the <emphasis role="bold">Current Machine State and All 2460 Children</emphasis>. This creates a clone starting with this 2461 snapshot and includes all child snapshots. 2462 </para> 2480 The <emphasis role="bold">Snapshots</emphasis> option specifies 2481 whether to create a clone of the current machine state only or of 2482 everything. 2483 </para> 2484 2485 <itemizedlist> 2486 2487 <listitem> 2488 <para> 2489 <emphasis role="bold">Everything:</emphasis> Clones the 2490 current machine state and all its snapshots. 2491 </para> 2492 </listitem> 2493 2494 <listitem> 2495 <para> 2496 <emphasis role="bold">Current Machine State and All 2497 Children:</emphasis>. Clones a VM snapshot and all its child 2498 snapshots. 2499 </para> 2500 </listitem> 2501 2502 </itemizedlist> 2463 2503 2464 2504 <para> … … 2470 2510 <listitem> 2471 2511 <para> 2472 <emphasis role="bold">MAC Address Policy:</emphasis> S elect an2473 option for retaining network card MAC addresses when cloning2474 the VM.2475 </para> 2476 2477 <para>2478 For example, when you select <emphasis role="bold">Generate2479 New MAC Addresses For All Network Adapters</emphasis> every2480 network card is assigned a new MAC address during cloning.2481 This is the default setting, and is useful when both the2482 source VM and the cloned VM have to operate on the same2483 network. Other options enable you to retain existing MAC2484 addresses in the cloned VM.2485 </para>2486 </listitem> 2487 2488 <listitem>2489 <para>2490 <emphasis role="bold">Keep Disk Names:</emphasis> The names of2491 disk images are retained when cloning the VM.2492 </para>2493 </listitem> 2494 2495 <listitem>2496 <para>2497 <emphasis role="bold">Keep Hardware UUIDs:</emphasis> Hardware2498 UUIDs are retained whencloning the VM.2512 <emphasis role="bold">MAC Address Policy:</emphasis> Specifies 2513 how to retain network card MAC addresses when cloning the VM. 2514 </para> 2515 2516 <para> 2517 For example, the <emphasis role="bold">Generate New MAC 2518 Addresses For All Network Adapters</emphasis> value assigns a 2519 new MAC address to each network card during cloning. This is 2520 the default setting. This is the best option when both the 2521 source VM and the cloned VM must operate on the same network. 2522 Other values enable you to retain the existing MAC addresses 2523 in the cloned VM. 2524 </para> 2525 </listitem> 2526 2527 <listitem> 2528 <para> 2529 <emphasis role="bold">Keep Disk Names:</emphasis> Retains the 2530 disk image names when cloning the VM. 2531 </para> 2532 </listitem> 2533 2534 <listitem> 2535 <para> 2536 <emphasis role="bold">Keep Hardware UUIDs:</emphasis> Retains 2537 the hardware universally unique identifiers (UUIDs) when 2538 cloning the VM. 2499 2539 </para> 2500 2540 </listitem> … … 2503 2543 2504 2544 <para> 2505 The clone operation itself can be a lengthy operation depending on 2506 the size and count of the attached disk images. Also keep in mind 2507 that every snapshot has differencing disk images attached, which 2508 need to be cloned as well. 2509 </para> 2510 2511 <para> 2512 The <emphasis role="bold">Clone</emphasis> menu item is disabled 2513 while a machine is running. 2514 </para> 2515 2516 <para> 2517 To clone a VM from the command line, see 2518 <xref linkend="vboxmanage-clonevm" />. 2545 The duration of the clone operation depends on the size and number 2546 of attached disk images. In addition, the clone operation saves 2547 all the differencing disk images of a snapshot. 2548 </para> 2549 2550 <para> 2551 Note that the <emphasis role="bold">Clone</emphasis> menu item is 2552 disabled while a machine is running. 2553 </para> 2554 2555 <para> 2556 You can also use the <command>VBoxManage clonevm</command> command 2557 to clone a VM. See <xref linkend="vboxmanage-clonevm" />. 2519 2558 </para> 2520 2559 … … 2568 2607 configuration settings that can be distributed easily. This way 2569 2608 one can offer complete ready-to-use software packages, including 2570 operating systems with applications, that need no configuration2571 orinstallation except for importing into &product-name;.2609 OSes with applications, that need no configuration or 2610 installation except for importing into &product-name;. 2572 2611 </para> 2573 2612 … … 2632 2671 2633 2672 <para> 2634 To import an appliance in OVF format, use the following steps. 2673 The following steps show how to import an appliance in OVF 2674 format. 2635 2675 </para> 2636 2676 … … 2644 2684 <para> 2645 2685 &product-name; creates file type associations automatically 2646 for any OVF and OVA files on your host operating system.2686 for any OVF and OVA files on your host OS. 2647 2687 </para> 2648 2688 </listitem> … … 2651 2691 <para> 2652 2692 Select <emphasis role="bold">File</emphasis>, 2653 <emphasis role="bold">Import Appliance</emphasis> in the 2654 VirtualBox Manager window. In the displayed file dialog, 2655 navigate to the file with either the 2693 <emphasis 2694 role="bold">Import 2695 Appliance</emphasis> from the VirtualBox Manager window. 2696 </para> 2697 2698 <para> 2699 From the file dialog, go to the file with either the 2656 2700 <computeroutput>.ovf</computeroutput> or the 2657 2701 <computeroutput>.ova</computeroutput> file extension. … … 2659 2703 2660 2704 <para> 2661 Click <emphasis role="bold">Import</emphasis>. The 2662 <emphasis role="bold">Appliance Settings</emphasis> screen 2663 is shown. 2705 Click <emphasis role="bold">Import</emphasis> to open the 2706 <emphasis role="bold">Appliance Settings</emphasis> screen. 2664 2707 </para> 2665 2708 … … 2675 2718 2676 2719 <para> 2677 This screen shows the virtual machines described in the OVF 2678 or OVA file and enables you to change the virtual machine 2679 settings. 2720 This screen shows the VMs described in the OVF or OVA file 2721 and enables you to change the VM settings. 2680 2722 </para> 2681 2723 … … 2683 2725 By default, membership of VM groups is preserved on import 2684 2726 for VMs that were initially exported from &product-name;. 2685 This can be changed using the <emphasis role="bold">Primary 2686 Group</emphasis> setting for the VM. 2687 </para> 2688 2689 <para> 2690 The following global settings apply for all of the VMs that 2691 you are importing: 2727 You can change this behavior by using the 2728 <emphasis 2729 role="bold">Primary Group</emphasis> 2730 setting for the VM. 2731 </para> 2732 2733 <para> 2734 The following global settings apply to all of the VMs that 2735 you import: 2692 2736 </para> 2693 2737 … … 2696 2740 <listitem> 2697 2741 <para> 2698 <emphasis role="bold">Base Folder:</emphasis> The 2699 directory on the host where the imported VMs are stored. 2742 <emphasis role="bold">Base Folder:</emphasis> Specifies 2743 the directory on the host in which to store the imported 2744 VMs. 2700 2745 </para> 2701 2746 2702 2747 <para> 2703 If there are multiple VMs in an appliance, you can2704 specify adifferent directory for each VM by editing the2748 If an appliance has multiple VMs, you can specify a 2749 different directory for each VM by editing the 2705 2750 <emphasis role="bold">Base Folder</emphasis> setting for 2706 2751 the VM. … … 2710 2755 <listitem> 2711 2756 <para> 2712 <emphasis role="bold">MAC Address Policy</emphasis>: By 2713 default, MAC addresses of network cards on your VMs are 2714 reinitialized before import. You can choose to preserve 2715 MAC addresses on import. 2757 <emphasis role="bold">MAC Address Policy:</emphasis> 2758 Reinitializes the MAC addresses of network cards in your 2759 VMs prior to import, by default. You can override the 2760 default behavior and preserve the MAC addresses on 2761 import. 2716 2762 </para> 2717 2763 </listitem> … … 2720 2766 <para> 2721 2767 <emphasis role="bold">Import Hard Drives as 2722 VDI:</emphasis> By default, hard drives are imported in2723 VMDK format. This option enables import in VDIformat.2768 VDI:</emphasis> Imports hard drives in the VDI format 2769 rather that in the defalut VMDK format. 2724 2770 </para> 2725 2771 </listitem> … … 2735 2781 2736 2782 <para> 2737 &product-name; copies the disk images and creates local 2738 virtual machines with the settings described in the2783 &product-name; copies the disk images and creates local VMs 2784 with the settings described on the 2739 2785 <emphasis role="bold">Appliance Settings</emphasis> screen. 2740 The imported VMs are shown in the list of virtual machines2741 in VirtualBoxManager.2742 </para> 2743 2744 <para> 2745 Note that since disk images tend to be big, and VMDK images2746 that come with virtual appliances are typically shipped in a2747 special compressed format that is unsuitable for being used2748 by virtual machines directly, the images are unpacked and2749 copied first, which can take a fewminutes.2786 The imported VMs are shown in the list of VMs in VirtualBox 2787 Manager. 2788 </para> 2789 2790 <para> 2791 Because disk images are large, the VMDK images that are 2792 included with virtual appliances are shipped in a compressed 2793 format that cannot be used directly by VMs. So, the images 2794 are first unpacked and copied, which might take several 2795 minutes. 2750 2796 </para> 2751 2797 </listitem> … … 2754 2800 2755 2801 <para> 2756 To import an appliance using the command line, see2757 <xref linkend="vboxmanage-import" />.2802 You can use the <command>VBoxManage import</command> command to 2803 import an appliance. See <xref linkend="vboxmanage-import" />. 2758 2804 </para> 2759 2805 … … 2765 2811 2766 2812 <para> 2767 To export an appliance in OVF format, use the following steps. 2813 The following steps show how to export an appliance in OVF 2814 format. 2768 2815 </para> 2769 2816 … … 2773 2820 <para> 2774 2821 Select <emphasis role="bold">File</emphasis>, 2775 <emphasis role="bold"> Export Appliance</emphasis> .2776 </para>2777 2778 < para>2779 The <emphasis role="bold">Export Virtual 2780 Appliance</emphasis> wizard is shown. The initial window2781 enables you to combine several virtual machines into an OVF2782 appliance.2783 </para> 2784 2785 <para> 2786 Select one or more VMs to export and click2822 <emphasis role="bold"> Export Appliance</emphasis> to open 2823 the <emphasis role="bold">Export Virtual 2824 Appliance</emphasis> wizard. 2825 </para> 2826 2827 <para> 2828 From the initial window, you can combine several VMs into an 2829 OVF appliance. 2830 </para> 2831 2832 <para> 2833 Select one or more VMs to export, and click 2787 2834 <emphasis role="bold">Next</emphasis>. 2788 2835 </para> … … 2792 2839 <para> 2793 2840 The <emphasis role="bold">Appliance Settings</emphasis> 2794 screen is shown, where you can choose the following 2795 settings: 2841 screen enables you to select the following settings: 2796 2842 </para> 2797 2843 … … 2800 2846 <listitem> 2801 2847 <para> 2802 <emphasis role="bold">Format:</emphasis> Select an2848 <emphasis role="bold">Format:</emphasis> Selects the 2803 2849 <emphasis role="bold">Open Virtualization 2804 Format</emphasis> optionfor the output files.2850 Format</emphasis> value for the output files. 2805 2851 </para> 2806 2852 2807 2853 <para> 2808 The <emphasis role="bold">&oci;</emphasis> option is 2809 used for export to &oci;. See 2810 <xref linkend="ovf-export-oci"/>. 2854 The <emphasis role="bold">&oci;</emphasis> value exports 2855 export to &oci;. See <xref linkend="ovf-export-oci"/>. 2811 2856 </para> 2812 2857 </listitem> … … 2814 2859 <listitem> 2815 2860 <para> 2816 <emphasis role="bold">File:</emphasis> Select the2817 location where the exported files are to be stored.2861 <emphasis role="bold">File:</emphasis> Selects the 2862 location in which to store the exported files. 2818 2863 </para> 2819 2864 </listitem> … … 2822 2867 <para> 2823 2868 <emphasis role="bold">MAC Address Policy:</emphasis> 2824 S elect an option for retainingnetwork card MAC2869 Specifies whether to retain or reassign network card MAC 2825 2870 addresses on export. 2826 2871 </para> … … 2848 2893 <listitem> 2849 2894 <para> 2850 Click <emphasis role="bold">Next</emphasis> to displaythe2895 Click <emphasis role="bold">Next</emphasis> to show the 2851 2896 <emphasis role="bold">Virtual System Settings</emphasis> 2852 2897 screen. … … 2855 2900 <para> 2856 2901 You can edit settings for the virtual appliance. For 2857 example, you can change the name and add product information 2858 such as vendor details or license text. 2859 </para> 2860 2861 <para> 2862 To change a setting, double-click on the required field. 2863 </para> 2864 </listitem> 2865 2866 <listitem> 2867 <para> 2868 Click <emphasis role="bold">Export</emphasis> and the export 2869 process begins. Note that this can take a while. 2902 example, you can change the name of the virtual appliance or 2903 add product information, such as vendor details or license 2904 text. 2905 </para> 2906 2907 <para> 2908 Double-click the appropriate field to change its value. 2909 </para> 2910 </listitem> 2911 2912 <listitem> 2913 <para> 2914 Click <emphasis role="bold">Export</emphasis> to begin the 2915 export process. Note that this operation might take several 2916 minutes. 2870 2917 </para> 2871 2918 </listitem> … … 2874 2921 2875 2922 <para> 2876 To export an appliance using the command line, see2877 <xref linkend="vboxmanage-export" />.2923 You can use the <command>VBoxManage export</command> command to 2924 export an appliance. See <xref linkend="vboxmanage-export" />. 2878 2925 </para> 2879 2926 2880 2927 </sect2> 2881 2928 2882 <!-- New content for 6.0 -->2883 2884 2929 <sect2 id="ovf-export-oci"> 2885 2930 … … 2891 2936 2892 2937 <para> 2893 Before you export a VM to &oci;, you need to do the following: 2938 Before you can export a VM to &oci;, ensure that you perform the 2939 following configuration steps: 2894 2940 </para> 2895 2941 … … 2898 2944 <listitem> 2899 2945 <para> 2900 Generate an API signing key pair . Thisis used for API2946 Generate an API signing key pair that is used for API 2901 2947 requests to &oci;. 2902 2948 </para> … … 2916 2962 <listitem> 2917 2963 <para> 2918 The public key of the key pair must be uploaded to the2919 cloudservice.2964 Upload the public key of the key pair to the cloud 2965 service. 2920 2966 </para> 2921 2967 </listitem> … … 2924 2970 2925 2971 <para> 2926 Instructions for creating and uploading an API signing key2927 for &oci; are at:2972 For step-by-step instructions for creating and uploading an 2973 API signing key for &oci;, see: 2928 2974 </para> 2929 2975 … … 2949 2995 <listitem> 2950 2996 <para> 2951 Automatically ,using the <emphasis role="bold">Cloud2997 Automatically by using the <emphasis role="bold">Cloud 2952 2998 Profile Manager</emphasis>. See 2953 2999 <xref linkend="ovf-cloud-profile-manager"/>. … … 2957 3003 <listitem> 2958 3004 <para> 2959 Manually ,by creating an3005 Manually by creating an 2960 3006 <computeroutput>oci_config</computeroutput> file in your 2961 3007 &product-name; global configuration directory. For … … 2968 3014 <listitem> 2969 3015 <para> 2970 Manually ,by creating a3016 Manually by creating a 2971 3017 <computeroutput>config</computeroutput> file in your 2972 3018 &oci; configuration directory. For example, this is … … 2976 3022 2977 3023 <para> 2978 This is the same file that is used by the &oci; Command2979 Line Interface.3024 This is the same file that is used by the &oci; command 3025 line interface. 2980 3026 </para> 2981 3027 2982 3028 <para> 2983 &product-name; uses this file automatically if a cloud 2984 profile file is not present in your global configuration 3029 &product-name; automatically uses the 3030 <computeroutput>config</computeroutput> file if no cloud 3031 profile file is present in your global configuration 2985 3032 directory. Alternatively, you can import this file 2986 3033 manually into the Cloud Profile Manager. … … 2991 3038 2992 3039 <para> 2993 For information on cloud profile settings used by &oci; see2994 the following:3040 For more information about the cloud profile settings used 3041 by &oci; see: 2995 3042 </para> 2996 3043 … … 3002 3049 <listitem> 3003 3050 <para> 3004 Ensure that the subnet used by source VMs are available in3005 the target compartment on the cloud service.3051 Ensure that the subnets that are used by source VMs are 3052 available in the target compartment on the cloud service. 3006 3053 </para> 3007 3054 </listitem> … … 3010 3057 3011 3058 <para> 3012 To export a VM to &oci;, use the following steps.3059 Perform the following steps to export a VM to &oci;: 3013 3060 </para> 3014 3061 … … 3018 3065 <para> 3019 3066 Select <emphasis role="bold">File</emphasis>, 3020 <emphasis role="bold"> Export Appliance</emphasis>. 3021 </para> 3022 3023 <para> 3024 The <emphasis role="bold">Export Virtual 3025 Appliance</emphasis> wizard is shown. 3067 <emphasis role="bold">Export Appliance</emphasis> to open 3068 the <emphasis role="bold">Export Virtual 3069 Appliance</emphasis> wizard. 3026 3070 </para> 3027 3071 3028 3072 <para> 3029 3073 Select a VM to export and click 3030 <emphasis role="bold">Next</emphasis>. 3031 </para> 3032 </listitem> 3033 3034 <listitem> 3035 <para> 3036 The <emphasis role="bold">Appliance Settings</emphasis> 3037 screen is shown. 3038 </para> 3039 3040 <para> 3041 In the <emphasis role="bold">Format</emphasis> drop-down 3074 <emphasis role="bold">Next</emphasis> to open the 3075 <emphasis role="bold">Appliance Settings</emphasis> screen. 3076 </para> 3077 </listitem> 3078 3079 <listitem> 3080 <para> 3081 From the <emphasis role="bold">Format</emphasis> drop-down 3042 3082 list, select <emphasis role="bold">&oci;</emphasis>. 3043 3083 </para> … … 3049 3089 3050 3090 <para> 3051 &oci; accounts can be set upusing the Cloud Profile3091 You can set up &oci; accounts by using the Cloud Profile 3052 3092 Manager. 3053 3093 </para> 3054 3094 3055 3095 <para> 3056 The window below the 3057 <emphasis role="bold">Account</emphasis> field displays the 3058 profile settings for your cloud account. 3096 The list after the <emphasis role="bold">Account</emphasis> 3097 field shows the profile settings for your cloud account. 3059 3098 </para> 3060 3099 … … 3070 3109 3071 3110 <para> 3072 Click <emphasis role="bold">Next</emphasis>. &product-name; 3073 makes an API request to the &oci; service. 3074 </para> 3075 </listitem> 3076 3077 <listitem> 3078 <para> 3079 The <emphasis role="bold">Virtual System Settings</emphasis> 3080 screen is shown. 3081 </para> 3082 3083 <para> 3084 You can edit settings used for the virtual machine on &oci;. 3111 Click <emphasis role="bold">Next</emphasis> to make an API 3112 request to the &oci; service and open the 3113 <emphasis 3114 role="bold">Virtual System 3115 Settings</emphasis> screen. 3116 </para> 3117 </listitem> 3118 3119 <listitem> 3120 <para> 3121 Optionally edit settings used for the virtual machine on 3122 &oci;. 3123 </para> 3124 3125 <para> 3085 3126 For example, you can edit the Disk Size and Shape used for 3086 3127 the VM instance. … … 3089 3130 <para> 3090 3131 Click <emphasis role="bold">Export</emphasis> to export the 3091 virtual machines to the cloud service. 3092 </para> 3093 </listitem> 3094 3095 <listitem> 3132 VMs to the cloud service. 3133 </para> 3134 3096 3135 <para> 3097 3136 The VMs are uploaded to &oci;. … … 3103 3142 3104 3143 <para> 3105 If the <emphasis role="bold">Launch Instance</emphasis>3106 setting was enabled on the <emphasis role="bold">Virtual3107 System Settings</emphasis> screen, the VM instance is3108 started.3109 </para> 3110 3111 <para> 3112 You can monitor the export processusing the &oci; Console.3144 By default, the VM instance is started after upload to 3145 &oci;. 3146 </para> 3147 </listitem> 3148 3149 <listitem> 3150 <para> 3151 Monitor the export process by using the &oci; Console. 3113 3152 </para> 3114 3153 </listitem> 3115 3154 3116 3155 </orderedlist> 3156 3157 <para> 3158 You can also use the <command>VBoxManage export</command> 3159 command to export a VM to &oci;. See 3160 <xref linkend="vboxmanage-export-cloud"/>. 3161 </para> 3117 3162 3118 3163 </sect2> … … 3139 3184 3140 3185 <para> 3141 To displaythe Cloud Profile Manager select3186 To open the Cloud Profile Manager select 3142 3187 <emphasis role="bold">File</emphasis>, 3143 <emphasis role="bold">Cloud Profile Manager</emphasis> inthe3188 <emphasis role="bold">Cloud Profile Manager</emphasis> from the 3144 3189 VirtualBox Manager window. 3145 3190 </para> 3146 3191 3147 3192 <para> 3148 You can use the Cloud Profile Manager to create a new cloud3149 profile automatically, or you can create a cloud profile by3150 importing settings from your &oci; configuration file into the3151 Cloud ProfileManager.3152 </para> 3153 3154 <para> 3155 To create a new cloud profile, do the following:3193 Use the Cloud Profile Manager to create a new cloud profile 3194 automatically. Or, create a cloud profile by importing settings 3195 from your &oci; configuration file into the Cloud Profile 3196 Manager. 3197 </para> 3198 3199 <para> 3200 Perform the following steps to create a new cloud profile: 3156 3201 </para> 3157 3202 … … 3168 3213 <listitem> 3169 3214 <para> 3170 Click <emphasis role="bold">Properties</emphasis> and enter3171 the following settings for the profile:3215 Click <emphasis role="bold">Properties</emphasis> and 3216 specify the following property values for the profile: 3172 3217 </para> 3173 3218 … … 3220 3265 3221 3266 <para> 3222 Some of these are settings for your &oci; account . They can3223 be viewed usingthe &oci; Console.3267 Some of these are settings for your &oci; account, which you 3268 can view from the &oci; Console. 3224 3269 </para> 3225 3270 </listitem> … … 3232 3277 3233 3278 <para> 3234 Settings for your cloud profile are added tothe3279 The cloud profile settings are saved in the 3235 3280 <computeroutput>oci_config</computeroutput> file in your 3236 3281 &product-name; global settings directory. … … 3241 3286 3242 3287 <para> 3243 To import an existing &oci; configuration file, do the3244 following:3288 Perform the following steps to import an existing &oci; 3289 configuration file: 3245 3290 </para> 3246 3291 … … 3259 3304 <listitem> 3260 3305 <para> 3261 Click the <emphasis role="bold">Import</emphasis> icon. 3262 </para> 3263 3264 <para> 3265 A dialog prompting you to import cloud profiles from 3266 external files is shown. 3306 Click the <emphasis role="bold">Import</emphasis> icon to 3307 open a dialog that prompts you to import cloud profiles from 3308 external files. 3267 3309 </para> 3268 3310 3269 3311 <warning> 3270 3312 <para> 3271 The dialog warns you that any cloud profiles in your 3272 &product-name; global settings directory will be 3273 overwritten. 3313 This action overwrites any cloud profiles that are in your 3314 &product-name; global settings directory. 3274 3315 </para> 3275 3316 </warning> … … 3282 3323 3283 3324 <para> 3284 Settings for your cloud profile are added to the3325 Your cloud profile settings are saved to the 3285 3326 <computeroutput>oci_config</computeroutput> file in your 3286 3327 &product-name; global settings directory. … … 3290 3331 <listitem> 3291 3332 <para> 3292 Click <emphasis role="bold">Properties</emphasis> to display3293 settings for the cloud profile.3294 </para> 3295 3296 <para> 3297 To change a setting, double-click on the required field.3333 Click <emphasis role="bold">Properties</emphasis> to show 3334 the cloud profile settings. 3335 </para> 3336 3337 <para> 3338 Double-click on the appropriate field to change the value. 3298 3339 </para> 3299 3340 </listitem> … … 3344 3385 <emphasis role="bold">Input.</emphasis> Enables the user to 3345 3386 specify the Host key. It identifies the key that toggles 3346 whether the cursor is in the focus of the VM or the Host 3347 operating system windows, see 3348 <xref linkend="keyb_mouse_normal"/>, and which is also used to 3349 trigger certain VM actions, see 3387 whether the cursor is in the focus of the VM or the Host OS 3388 windows, see <xref linkend="keyb_mouse_normal"/>, and which is 3389 also used to trigger certain VM actions, see 3350 3390 <xref linkend="specialcharacters"/>. 3351 3391 </para> -
trunk/doc/manual/en_US/user_Networking.xml
r76078 r76786 287 287 288 288 <para> 289 <xref linkend="table-networking-modes"/> provides a quick overview290 of the most importantnetworking modes.291 </para> 292 293 <table id="table-networking-modes" >289 The following table provides an overview of the most important 290 networking modes. 291 </para> 292 293 <table id="table-networking-modes" tabstyle="oracle-all"> 294 294 <title>Overview of Networking Modes</title> 295 295 <tgroup cols="6"> … … 302 302 <thead valign="middle"> 303 303 <row> 304 <entry>< /entry>304 <entry><emphasis role="bold">Mode</emphasis></entry> 305 305 <entry><para> 306 306 <emphasis role="bold">VM→Host</emphasis> … … 1470 1470 </para> 1471 1471 1472 < orderedlist>1472 <itemizedlist> 1473 1473 1474 1474 <listitem> … … 1496 1496 <listitem> 1497 1497 <para> 1498 Perform a full ,detailed analysis of network traffic on the1498 Perform a full detailed analysis of network traffic on the 1499 1499 VM's network adaptor using a third party tool such as 1500 1500 Wireshark. To do this, a promiscuous mode policy needs to be … … 1545 1545 </listitem> 1546 1546 1547 </ orderedlist>1547 </itemizedlist> 1548 1548 1549 1549 </sect1> -
trunk/doc/manual/en_US/user_Preface.xml
r76704 r76786 1 1 <?xml version="1.0" encoding="utf-8"?> 2 <!DOCTYPE chapterPUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"2 <!DOCTYPE preface PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" 3 3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" 4 4 [ … … 11 11 12 12 <para> 13 The <emphasis>&product-name; </emphasis> User Manualprovides an13 The <emphasis>&product-name; User Manual</emphasis> provides an 14 14 introduction to using &product-name;. The manual provides 15 15 information on how to install &product-name; and use it to create … … 101 101 102 102 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" 103 href="../common/oracle- legal-notices/oracle-support-en.xml"103 href="../common/oracle-support-en.xml" 104 104 xpointer="xpointer(simplesect/title/following-sibling::node())" /> 105 105 -
trunk/doc/manual/en_US/user_Security.xml
r76678 r76786 516 516 517 517 <sect1 id="security-recommendations"> 518 518 519 <title>Security Recommendations</title> 519 520 520 <para>This section contains security recommendations for specific issues. 521 By default VirtualBox will configure the VMs to run in a secure manner, 522 however this may not always be possible without additional user actions (e.g. 523 host OS / firmware configuration changes).</para> 521 <para> 522 This section contains security recommendations for specific 523 issues. By default VirtualBox will configure the VMs to run in a 524 secure manner, however this may not always be possible without 525 additional user actions (e.g. host OS / firmware configuration 526 changes). 527 </para> 524 528 525 529 <sect2 id="sec-rec-cve-2018-3646"> 530 526 531 <title>CVE-2018-3646</title> 527 532 528 <para>This security issue affect a range of Intel CPUs with nested paging. 529 AMD CPUs are expected not to be impacted (pending direct confirmation by AMD). 530 Also the issue does not affect VMs running with hardware virtualization 531 disabled or with nested paging disabled.</para> 532 533 <para>For more information about nested paging, see <xref linkend="nestedpaging" />.</para> 534 535 <para>Mitigation options:</para> 533 <para> 534 This security issue affect a range of Intel CPUs with nested 535 paging. AMD CPUs are expected not to be impacted (pending direct 536 confirmation by AMD). Also the issue does not affect VMs running 537 with hardware virtualization disabled or with nested paging 538 disabled. 539 </para> 540 541 <para> 542 For more information about nested paging, see 543 <xref linkend="nestedpaging" />. 544 </para> 545 546 <para> 547 Mitigation options: 548 </para> 536 549 537 550 <sect3> 551 538 552 <title>Disable nested paging</title> 539 553 540 <para>By disabling nested paging (EPT), the VMM will construct page tables 541 shadowing the ones in the guest. It is no possible for the guest to insert 542 anything fishy into the page tables, since the VMM carefully validates each 543 entry before shadowing it.</para> 544 545 <para>As a side effect of disabling nested paging, several CPU features 546 will not be made available to the guest. Among these features are AVX, 547 AVX2, XSAVE, AESNI, and POPCNT. Not all guests may be able to cope with 548 dropping these features after installation. Also, for some guests, 549 especially in SMP configurations, there could be stability issues arrising 550 from disabling nested paging. Finally, some workloads may experience a 551 performance degradation.</para> 554 <para> 555 By disabling nested paging (EPT), the VMM will construct page 556 tables shadowing the ones in the guest. It is no possible for 557 the guest to insert anything fishy into the page tables, since 558 the VMM carefully validates each entry before shadowing it. 559 </para> 560 561 <para> 562 As a side effect of disabling nested paging, several CPU 563 features will not be made available to the guest. Among these 564 features are AVX, AVX2, XSAVE, AESNI, and POPCNT. Not all 565 guests may be able to cope with dropping these features after 566 installation. Also, for some guests, especially in SMP 567 configurations, there could be stability issues arrising from 568 disabling nested paging. Finally, some workloads may 569 experience a performance degradation. 570 </para> 571 552 572 </sect3> 553 573 554 574 <sect3> 575 555 576 <title>Flushing the level 1 data cache</title> 556 577 557 <para>This aims at removing potentially sensitive data from the level 1 558 data cache when running guest code. However, it is made difficult by 559 hyper-threading setups sharing the level 1 cache and thereby potentially 560 letting the other thread in a pair refill the cache with data the user 561 does not want the guest to see. In addition, flushing the level 1 data 562 cache is usually not without performance side effects.</para> 563 564 <para>Up to date CPU microcode is a prerequisite for the cache flushing 565 mitigations. Some host OSes may install these automatically, though it 566 has traditionally been a task best performed by the system firmware. So, 567 please check with your system / mainboard manufacturer for the latest 568 firmware update.</para> 569 570 <para>We recommend disabling hyper threading on the host. This is 571 traditionally done from the firmware setup, but some OSes also offers 572 ways disable HT. In some cases it may be disabled by default, but please 573 verify as the effectiveness of the mitigation depends on it.</para> 574 575 <para>The default action taken by VirtualBox is to flush the level 1 576 data cache when a thread is scheduled to execute guest code, rather 577 than on each VM entry. This reduces the performance impact, while 578 making the assumption that the host OS will not handle security 579 sensitive data from interrupt handlers and similar without taking 580 precautions.</para> 581 582 <para>A more aggressive flushing option is provided via the VBoxManage 583 modifyvm option <computeroutput>--l1d-flush-on-vm-entry</computeroutput>. 584 When enabled the level 1 data cache will be flushed on every VM entry. 585 The performance impact is greater than with the default option, though 586 this of course depends on the workload. Workloads producing a lot of 587 VM exits (like networking, VGA access, and similiar) will probably be 588 most impacted.</para> 589 590 <para>For users not concerned by this security issue, the default 591 mitigation can be disabled using</para> 592 <para><computeroutput>VBoxManage modifyvm name --l1d-flush-on-sched off</computeroutput></para> 578 <para> 579 This aims at removing potentially sensitive data from the 580 level 1 data cache when running guest code. However, it is 581 made difficult by hyper-threading setups sharing the level 1 582 cache and thereby potentially letting the other thread in a 583 pair refill the cache with data the user does not want the 584 guest to see. In addition, flushing the level 1 data cache is 585 usually not without performance side effects. 586 </para> 587 588 <para> 589 Up to date CPU microcode is a prerequisite for the cache 590 flushing mitigations. Some host OSes may install these 591 automatically, though it has traditionally been a task best 592 performed by the system firmware. So, please check with your 593 system / mainboard manufacturer for the latest firmware 594 update. 595 </para> 596 597 <para> 598 We recommend disabling hyper threading on the host. This is 599 traditionally done from the firmware setup, but some OSes also 600 offers ways disable HT. In some cases it may be disabled by 601 default, but please verify as the effectiveness of the 602 mitigation depends on it. 603 </para> 604 605 <para> 606 The default action taken by VirtualBox is to flush the level 1 607 data cache when a thread is scheduled to execute guest code, 608 rather than on each VM entry. This reduces the performance 609 impact, while making the assumption that the host OS will not 610 handle security sensitive data from interrupt handlers and 611 similar without taking precautions. 612 </para> 613 614 <para> 615 A more aggressive flushing option is provided via the 616 VBoxManage modifyvm option 617 <computeroutput>--l1d-flush-on-vm-entry</computeroutput>. When 618 enabled the level 1 data cache will be flushed on every VM 619 entry. The performance impact is greater than with the default 620 option, though this of course depends on the workload. 621 Workloads producing a lot of VM exits (like networking, VGA 622 access, and similiar) will probably be most impacted. 623 </para> 624 625 <para> 626 For users not concerned by this security issue, the default 627 mitigation can be disabled using 628 </para> 629 630 <para> 631 <computeroutput>VBoxManage modifyvm name --l1d-flush-on-sched 632 off</computeroutput> 633 </para> 634 593 635 </sect3> 594 636 -
trunk/doc/manual/en_US/user_Storage.xml
r76078 r76786 90 90 91 91 <para> 92 Even if your guest operating system has no support for SCSI or 93 SATA devices, it should always be able to see an IDE 94 controller. 92 Even if your guest OS has no support for SCSI or SATA devices, 93 it should always be able to see an IDE controller. 95 94 </para> 96 95 … … 100 99 PIIX3, PIIX4, or ICH6. This makes no difference in terms of 101 100 performance, but if you import a virtual machine from another 102 virtualization product, the operating system in that machine 103 may expect a particular controller type and crash if it is not 104 found. 101 virtualization product, the OS in that machine may expect a 102 particular controller type and crash if it is not found. 105 103 </para> 106 104 … … 136 134 137 135 <para> 138 For this reason, depending on the selected guest operating139 system, &product-name; uses SATA as the default for newly140 created virtual machines. One virtual SATA controller is141 created by default, and the default disk that is created with142 a new VM is attached to this controller.136 For this reason, depending on the selected guest OS, 137 &product-name; uses SATA as the default for newly created 138 virtual machines. One virtual SATA controller is created by 139 default, and the default disk that is created with a new VM is 140 attached to this controller. 143 141 </para> 144 142 … … 147 145 The entire SATA controller and the virtual disks attached to 148 146 it, including those in IDE compatibility mode, will not be 149 seen by operating systems that do not have device support150 for AHCI. In particular, <emphasis>there is no support for151 AHCI in Windows before Windows Vista</emphasis>. So Windows152 XP, even SP3, will not see such disks unless you install153 additional drivers. It is possible to switch from IDE to154 SATA after installation by installing the SATA drivers and155 c hanging the controller type in the VM147 seen by OSes that do not have device support for AHCI. In 148 particular, <emphasis>there is no support for AHCI in 149 Windows before Windows Vista</emphasis>. So Windows XP, even 150 SP3, will not see such disks unless you install additional 151 drivers. It is possible to switch from IDE to SATA after 152 installation by installing the SATA drivers and changing the 153 controller type in the VM 156 154 <emphasis role="bold">Settings</emphasis> dialog. 157 155 </para> … … 169 167 been enabled by default, either because it was created by an 170 168 earlier version of &product-name;, or because SATA is not 171 supported by default by the selected guest operating system,172 do the following. Go to the173 <emphasis role="bold">Storage</emphasis>page of the machine's169 supported by default by the selected guest OS, do the 170 following. Go to the <emphasis role="bold">Storage</emphasis> 171 page of the machine's 174 172 <emphasis role="bold">Settings</emphasis> dialog, click 175 173 <emphasis role="bold">Add Controller</emphasis> under the … … 218 216 <para> 219 217 As with the other controller types, a SCSI controller will 220 only be seen by operating systems with device support for221 it. Windows 2003 and later ships with drivers for the LSI222 Logic controller, while Windows NT 4.0 and Windows 2000223 ships with drivers for the BusLogic controller. Windows XP224 ships withdrivers for neither.218 only be seen by OSes with device support for it. Windows 219 2003 and later ships with drivers for the LSI Logic 220 controller, while Windows NT 4.0 and Windows 2000 ships with 221 drivers for the BusLogic controller. Windows XP ships with 222 drivers for neither. 225 223 </para> 226 224 </warning> … … 248 246 <warning> 249 247 <para> 250 As with SATA, the SAS controller will only be seen by 251 operating systems with device support for it. In particular,252 <emphasis>there is no support for SAS in Windows before253 Windows Vista</emphasis>. So Windows XP, even SP3, will not254 see suchdisks unless you install additional drivers.248 As with SATA, the SAS controller will only be seen by OSes 249 with device support for it. In particular, <emphasis>there 250 is no support for SAS in Windows before Windows 251 Vista</emphasis>. So Windows XP, even SP3, will not see such 252 disks unless you install additional drivers. 255 253 </para> 256 254 </warning> … … 262 260 class</emphasis> is a standard to connect external storage 263 261 devices like hard disks or flash drives to a host through USB. 264 All major operating systems support these devices for a long 265 time and ship generic drivers making third-party drivers 266 superfluous. In particular, legacy operating systems without 267 support for SATA controllers may benefit from USB mass storage 268 devices. 262 All major OSes support these devices for a long time and ship 263 generic drivers making third-party drivers superfluous. In 264 particular, legacy OSes without support for SATA controllers 265 may benefit from USB mass storage devices. 269 266 </para> 270 267 … … 290 287 <para> 291 288 <emphasis role="bold">Non volatile memory express 292 (NVMe)</emphasis> is a very recent standard which emerged in293 2011 connecting non volatile memory (NVM) directly over PCI294 express to lift the bandwidth limitation of the previously295 used SATA protocol for SSDs. Unlike other standards the296 command set is very simple to achieve maximum throughput and297 is not compatible with ATA or SCSI. Operating systems need to298 support NVMe devices to make use of them. For example, Windows299 8.1 added native NVMe support. For Windows 7, native support300 was added with anupdate.289 (NVMe)</emphasis> is a standard which emerged in 2011 for 290 connecting non volatile memory (NVM) directly over PCI express 291 to lift the bandwidth limitation of the previously used SATA 292 protocol for SSDs. Unlike other standards the command set is 293 very simple to achieve maximum throughput and is not 294 compatible with ATA or SCSI. OSes need to support NVMe devices 295 to make use of them. For example, Windows 8.1 added native 296 NVMe support. For Windows 7, native support was added with an 297 update. 301 298 </para> 302 299 … … 333 330 <para> 334 331 30 slots attached to the SATA controller, if enabled and 335 supported by the guest operating system.332 supported by the guest OS. 336 333 </para> 337 334 </listitem> … … 340 337 <para> 341 338 15 slots attached to the SCSI controller, if enabled and 342 supported by the guest operating system.339 supported by the guest OS. 343 340 </para> 344 341 </listitem> … … 347 344 <para> 348 345 Eight slots attached to the SAS controller, if enabled and 349 supported by the guest operating system.346 supported by the guest OS. 350 347 </para> 351 348 </listitem> … … 354 351 <para> 355 352 Eight slots attached to the virtual USB controller, if enabled 356 and supported by the guest operating system.353 and supported by the guest OS. 357 354 </para> 358 355 </listitem> … … 361 358 <para> 362 359 Up to 255 slots attached to the NVMe controller, if enabled 363 and supported by the guest operating system.360 and supported by the guest OS. 364 361 </para> 365 362 </listitem> … … 384 381 <para> 385 382 Disk image files reside on the host system and are seen by the 386 guest systems as hard disks of a certain geometry. When a guest 387 operating system reads from or writes to a hard disk,388 &product-name; redirects therequest to the image file.383 guest systems as hard disks of a certain geometry. When a guest OS 384 reads from or writes to a hard disk, &product-name; redirects the 385 request to the image file. 389 386 </para> 390 387 … … 581 578 <listitem> 582 579 <para> 583 <emphasis role="bold">Copy</emphasis> a virtual hard disk, to 584 create another one. The target type can be different. 585 Available options are: VDI, VHD, or VMDK. 580 <emphasis role="bold">Copy</emphasis> a virtual hard disk to 581 create another one. 582 </para> 583 584 <para> 585 You can specify one of the following target types: VDI, VHD, 586 or VMDK. 586 587 </para> 587 588 </listitem> … … 590 591 <para> 591 592 <emphasis role="bold">Move</emphasis> an image that is 592 currently in the registry. A file dialog prompts you for the 593 new image file location. 594 </para> 595 596 <para> 597 When you move a disk image using the Virtual Media Manager, 598 any related &product-name; configuration files are updated 593 currently in the registry to another location. 594 </para> 595 596 <para> 597 A file dialog prompts you for the new image file location. 598 </para> 599 600 <para> 601 When you use the Virtual Media Manager to move a disk image, 602 &product-name; updates all related configuration files 599 603 automatically. 600 604 </para> … … 602 606 <note> 603 607 <para> 604 If possible, always use the Virtual Media Manager or the608 Always use the Virtual Media Manager or the 605 609 <command>VBoxManage modifymedium</command> command to move a 606 610 disk image. … … 608 612 609 613 <para> 610 If you move a disk image to a new location by using a file 611 management feature of the host operating system, use the 612 <computeroutput>--setlocation</computeroutput> option of the 613 <command>VBoxManage modifymedium</command> command to 614 configure the new path of the disk image on the host file 615 system. This updates the &product-name; configuration 616 automatically. 614 If you use a file management feature of the host OS to move 615 a disk image to a new location, run the <command>VBoxManage 616 modifymedium</command> <option>--setlocation</option> 617 command to configure the new path of the disk image on the 618 host file system. This command updates the &product-name; 619 configuration automatically. 617 620 </para> 618 621 </note> … … 622 625 <para> 623 626 <emphasis role="bold">Remove</emphasis> an image from the 624 registry. You can optionally delete the image file when doing625 so.626 </para> 627 </listitem> 628 629 <listitem> 630 <para> 631 <emphasis role="bold">Release</emphasis> an image . Detach it632 from a virtual machine, if it is currently attached to one as633 a virtual hard disk.634 </para> 635 </listitem> 636 637 <listitem> 638 <para> 639 Display and edit the640 <emphasis role="bold">Properties</emphasis>of a disk image.627 registry. You can optionally delete the image file when 628 removing the image. 629 </para> 630 </listitem> 631 632 <listitem> 633 <para> 634 <emphasis role="bold">Release</emphasis> an image to detach it 635 from a VM. This action only applies if the image is currently 636 attached to a VM as a virtual hard disk. 637 </para> 638 </listitem> 639 640 <listitem> 641 <para> 642 View and edit the <emphasis role="bold">Properties</emphasis> 643 of a disk image. 641 644 </para> 642 645 … … 649 652 <listitem> 650 653 <para> 651 <emphasis role="bold">Type:</emphasis> Defines the654 <emphasis role="bold">Type:</emphasis> Specifies the 652 655 snapshot behavior of the disk. See 653 656 <xref linkend="hdimagewrites"/>. … … 657 660 <listitem> 658 661 <para> 659 <emphasis role="bold">Location:</emphasis> The location of 660 the disk image file on the host system. A file dialog 661 selector is available. 662 <emphasis role="bold">Location:</emphasis> Specifies the 663 location of the disk image file on the host system. You 664 can use a file dialog to browse for the disk image 665 location. 662 666 </para> 663 667 </listitem> … … 665 669 <listitem> 666 670 <para> 667 <emphasis role="bold">Description:</emphasis> A short668 description of the disk image.671 <emphasis role="bold">Description:</emphasis> Specifies a 672 short description of the disk image. 669 673 </para> 670 674 </listitem> … … 672 676 <listitem> 673 677 <para> 674 <emphasis role="bold">Size:</emphasis> The size of the675 disk image. Use the slider to increase or decrease the676 d isk image size.678 <emphasis role="bold">Size:</emphasis> Specifies the size 679 of the disk image. You can use the slider to increase or 680 decrease the disk image size. 677 681 </para> 678 682 </listitem> … … 680 684 <listitem> 681 685 <para> 682 <emphasis role="bold">Information:</emphasis> Further 683 details about the disk image can be added on the 684 <emphasis role="bold">Information</emphasis> tab. 686 <emphasis role="bold">Information:</emphasis> Specifies 687 detailed information about the disk image. 685 688 </para> 686 689 </listitem> … … 691 694 <listitem> 692 695 <para> 693 <emphasis role="bold">Refresh</emphasis> the values for the694 displayed attributes of the currently-selected disk image.696 <emphasis role="bold">Refresh</emphasis> the property values 697 of the selected disk image. 695 698 </para> 696 699 </listitem> … … 700 703 <para> 701 704 To perform these actions, highlight the medium in the Virtual 702 Media Manager . Then do eitherof the following:705 Media Manager and then do one of the following: 703 706 </para> 704 707 … … 720 723 721 724 <para> 722 To create a new disk image, you use the 723 <emphasis role="bold">Storage</emphasis> page in a virtual 724 machine's <emphasis role="bold">Settings</emphasis> dialog. This 725 is because disk images are by default stored in each machine's own 726 folder. 727 </para> 728 729 <para> 730 Hard disk image files can be copied to other host systems and 731 imported into virtual machines there. However, certain guest 732 operating systems, such as Windows 2000 and Windows XP, require 733 that the new virtual machine be set up in a similar way to the old 734 one. 725 Use the <emphasis role="bold">Storage</emphasis> page in a VM's 726 <emphasis role="bold">Settings</emphasis> dialog to create a new 727 disk image. By default, disk images are stored in the VM's folder. 728 </para> 729 730 <para> 731 You can copy hard disk image files to other host systems and 732 import them in to VMs from the host system. However, certain guest 733 OSes, such as Windows 2000 and Windows XP, require that you 734 configure the new VM in a similar way to the old one. 735 735 </para> 736 736 … … 738 738 <para> 739 739 Do not simply make copies of virtual disk images. If you import 740 such a second copy into a virtual machine, &product-name; will 741 complain with an error, since &product-name; assigns a unique 742 identifier (UUID) to each disk image to make sure it is only 743 used once. See <xref linkend="cloningvdis" />. Also, if you want 744 to copy a virtual machine to another system, &product-name; has 745 import and export features that might be better suited for your 746 needs. See <xref linkend="ovf" />. 740 such a second copy into a VM, &product-name; issues an error 741 because &product-name; assigns a universally unique identifier 742 (UUID) to each disk image to ensure that it is only used one 743 time. See <xref linkend="cloningvdis" />. Also, if you want to 744 copy a VM to another system, use the &product-name; import and 745 export features. See <xref linkend="ovf" />. 747 746 </para> 748 747 </note> … … 954 953 955 954 <para> 956 Assume you have installed your guest operating system in your VM,957 and you have taken a snapshot. Later, your VM is infected with a958 virus and you would like to go back to the snapshot. With a normal959 hard disk image, you simply restore the snapshot, and the earlier960 state of your hard disk image will be restored as well and your961 virus infection will be undone. With an immutable hard disk, all962 ittakes is to shut down and power on your VM, and the virus955 Assume you have installed your guest OS in your VM, and you have 956 taken a snapshot. Later, your VM is infected with a virus and you 957 would like to go back to the snapshot. With a normal hard disk 958 image, you simply restore the snapshot, and the earlier state of 959 your hard disk image will be restored as well and your virus 960 infection will be undone. With an immutable hard disk, all it 961 takes is to shut down and power on your VM, and the virus 963 962 infection will be discarded. With a write-through image however, 964 963 you cannot easily undo the virus infection by means of … … 971 970 critical data irrespective of snapshots. As you can attach more 972 971 than one image to a VM, you may want to have one immutable image 973 for the operating system and one write-through image for your data 974 files. 972 for the OS and one write-through image for your data files. 975 973 </para> 976 974 … … 1086 1084 </para> 1087 1085 1088 < orderedlist>1086 <itemizedlist> 1089 1087 1090 1088 <listitem> … … 1121 1119 </listitem> 1122 1120 1123 </ orderedlist>1121 </itemizedlist> 1124 1122 1125 1123 <para> … … 1163 1161 <para> 1164 1162 You can duplicate hard disk image files on the same host to 1165 quickly produce a second virtual machine with the same operating1166 system setup. However, you should <emphasis>only</emphasis> make1167 copies ofvirtual disk images using the utility supplied with1163 quickly produce a second virtual machine with the same OS setup. 1164 However, you should <emphasis>only</emphasis> make copies of 1165 virtual disk images using the utility supplied with 1168 1166 &product-name;. See <xref linkend="vboxmanage-clonevdi" />. This 1169 is because &product-name; assigns a unique identity number (UUID)1170 to each disk image, which is also stored inside the image, and1171 &product-name; will refuse to work with two images that use the1172 same number. If you do accidentally try to reimport a disk image1173 which you copied normally, you can make a second copy using1174 &product-name;'s utilityand import that instead.1167 is because &product-name; assigns a UUID to each disk image, which 1168 is also stored inside the image, and &product-name; will refuse to 1169 work with two images that use the same number. If you do 1170 accidentally try to reimport a disk image which you copied 1171 normally, you can make a second copy using the <command>VBoxManage 1172 clonevm</command> command and import that instead. 1175 1173 </para> 1176 1174 … … 1184 1182 loader script, for example 1185 1183 <computeroutput>/boot/grub/menu.lst</computeroutput>. The disk ID 1186 looks like th is:1184 looks like the following: 1187 1185 </para> 1188 1186 … … 1190 1188 1191 1189 <para> 1192 The ID for the copied image can be determined with:1190 The ID for the copied image can be determined as follows: 1193 1191 </para> 1194 1192 … … 1203 1201 <para> 1204 1202 &product-name; can optionally disable the I/O caching that the 1205 host operating systemwould otherwise perform on disk image files.1203 host OS would otherwise perform on disk image files. 1206 1204 </para> 1207 1205 1208 1206 <para> 1209 1207 Traditionally, &product-name; has opened disk image files as 1210 normal files, which results in them being cached by the host 1211 operating system like any other file. The main advantage of this1212 is speed: when the guest OS writes to disk and the host OS cache1213 uses delayed writing, the write operation can be reported as1214 completed to the guest OS quickly while the host OS can perform1215 the operation asynchronously. Also, when you start a VM a second1216 time and have enough memory available for the OS to use for1217 caching, large parts of the virtual disk may be in system memory,1218 and the VM can accessthe data much faster.1208 normal files, which results in them being cached by the host OS 1209 like any other file. The main advantage of this is speed: when the 1210 guest OS writes to disk and the host OS cache uses delayed 1211 writing, the write operation can be reported as completed to the 1212 guest OS quickly while the host OS can perform the operation 1213 asynchronously. Also, when you start a VM a second time and have 1214 enough memory available for the OS to use for caching, large parts 1215 of the virtual disk may be in system memory, and the VM can access 1216 the data much faster. 1219 1217 </para> 1220 1218 … … 1260 1258 <listitem> 1261 1259 <para> 1262 Physical memory is often wasted as guest operating systems1263 t ypically have their own I/O caches, which may result in the1264 data being cached twice, in both the guest and the host1265 caches, forlittle effect.1260 Physical memory is often wasted as guest OSes typically have 1261 their own I/O caches, which may result in the data being 1262 cached twice, in both the guest and the host caches, for 1263 little effect. 1266 1264 </para> 1267 1265 </listitem> … … 1274 1272 read caching since this is typically already performed by the 1275 1273 guest OS. In addition, &product-name; fully supports asynchronous 1276 I/O for its virtual SATA, SCSI and SAS controllers through1274 I/O for its virtual SATA, SCSI, and SAS controllers through 1277 1275 multiple I/O threads. 1278 1276 </para> … … 1389 1387 Changing between the above, or changing a medium in the host drive 1390 1388 that is accessed by a machine, or changing an image file will 1391 signal a medium change to the guest operating system. The guest OS1392 can then react to the change, for example by starting an1393 installationprogram.1389 signal a medium change to the guest OS. The guest OS can then 1390 react to the change, for example by starting an installation 1391 program. 1394 1392 </para> 1395 1393 … … 1412 1410 Manager, is always VBOX CD-ROM, irrespective of the current 1413 1411 configuration of the virtual drive. This is to prevent hardware 1414 detection from being triggered in the guest operating system1415 every time theconfiguration is changed.1412 detection from being triggered in the guest OS every time the 1413 configuration is changed. 1416 1414 </para> 1417 1415 </note> … … 1490 1488 <para> 1491 1489 &product-name; can transparently present iSCSI remote storage to a 1492 virtual machine as a virtual hard disk. The guest operating system1493 will not see any difference between a virtual disk image (VDI1494 file) and an iSCSI target. To achieve this, &product-name; has an1495 i ntegrated iSCSI initiator.1490 virtual machine as a virtual hard disk. The guest OS will not see 1491 any difference between a virtual disk image (VDI file) and an 1492 iSCSI target. To achieve this, &product-name; has an integrated 1493 iSCSI initiator. 1496 1494 </para> 1497 1495 … … 1505 1503 </sect1> 1506 1504 1505 <sect1 id="vboximg-mount"> 1506 1507 <title>vboximg-mount: A Utility for FUSE Mounting a Virtual Disk Image</title> 1508 1509 <para> 1510 <command>vboximg-mount</command> is a command line utility for Mac 1511 OS X hosts that provides raw access to an &product-name; virtual 1512 disk image on the host system. Use this utility to mount, view, 1513 and optionally modify the disk image contents. 1514 </para> 1515 1516 <para> 1517 The utility is based on Filesystem in Userspace (FUSE) technology 1518 and uses the VirtualBox runtime engine. Ensure that &product-name; 1519 is running on the host system. 1520 </para> 1521 1522 <note> 1523 <para> 1524 When using <command>vboximg-mount</command>, ensure that the 1525 following conditions apply: 1526 </para> 1527 1528 <itemizedlist> 1529 1530 <listitem> 1531 <para> 1532 The disk image is not being used by any other systems, such 1533 as by guest VMs. 1534 </para> 1535 </listitem> 1536 1537 <listitem> 1538 <para> 1539 No VMs are running on the host system. 1540 </para> 1541 </listitem> 1542 1543 </itemizedlist> 1544 </note> 1545 1546 <para> 1547 Raw access using FUSE is preferred over direct loopback mounting 1548 of virtual disk images, because it is snapshot aware. It can 1549 selectively merge disk differencing images in an exposed virtual 1550 hard disk, providing historical or up-to-date representations of 1551 the virtual disk contents. 1552 </para> 1553 1554 <para> 1555 <command>vboximg-mount</command> enables you to view information 1556 about registered VMs, their attached disk media, and any 1557 snapshots. Also, you can view partition information for a disk 1558 image. 1559 </para> 1560 1561 <para> 1562 Use the <option>--help</option> option to view information about 1563 the <command>vboximg-mount</command> command usage. 1564 </para> 1565 1566 <para> 1567 When <command>vboximg-mount</command> mounts an &product-name; 1568 disk image, it creates a one level deep file system at a mount 1569 point that you specify. The file system includes a device node 1570 that represents the synthesized disk image as a readable or 1571 readable-writeable bytestream. This bytestream can be mounted 1572 either by using the host OS or by using other FUSE-based file 1573 systems. 1574 </para> 1575 1576 <sect2 id="vboximg-mount-display"> 1577 1578 <title>Viewing Detailed Information About a Virtual Disk Image</title> 1579 1580 <para> 1581 The following examples show how to use the 1582 <command>vboximg-mount</command> command to view information 1583 about virtual disk images. 1584 </para> 1585 1586 <para> 1587 The following command outputs detailed information about all 1588 registered VMs and associated snapshots: 1589 </para> 1590 1591 <screen>$ vboximg-mount --list --verbose 1592 1593 ------------------------------------------------------ 1594 VM Name: "macOS High Sierra 10.13" 1595 UUID: 3887d96d-831c-4187-a55a-567c504ff0e1 1596 Location: /Volumes/work/vm_guests/macOS High Sierra 10.13/macOS High Sierra 10.13.vbox 1597 ----------------------- 1598 HDD base: "macOS High Sierra 10.13.vdi" 1599 UUID: f9ea7173-6869-4aa9-b487-68023a655980 1600 Location: /Volumes/work/vm_guests/macOS High Sierra 10.13/macOS High Sierra 10.13.vdi 1601 1602 Diff 1: 1603 UUID: 98c2bac9-cf37-443d-a935-4e879b70166d 1604 Location: /Volumes/work/vm_guests/macOS High Sierra 10.13/ 1605 Snapshots/{98c2bac9-cf37-443d-a935-4e879b70166d}.vdi 1606 Diff 2: 1607 UUID: f401f381-7377-40b3-948e-3c61241b1a42 1608 Location: /Volumes/work/vm_guests/macOS High Sierra 10.13/ 1609 Snapshots/{f401f381-7377-40b3-948e-3c61241b1a42}.vdi 1610 ----------------------- 1611 HDD base: "simple_fixed_disk.vdi" 1612 UUID: ffba4d7e-1277-489d-8173-22ca7660773d 1613 Location: /Volumes/work/vm_guests/macOS High Sierra 10.13/simple_fixed_disk.vdi 1614 1615 Diff 1: 1616 UUID: aecab681-0d2d-468b-8682-93f79dc97a48 1617 Location: /Volumes/work/vm_guests/macOS High Sierra 10.13/ 1618 Snapshots/{aecab681-0d2d-468b-8682-93f79dc97a48}.vdi 1619 Diff 2: 1620 UUID: 70d6b34d-8422-47fa-8521-3b6929a1971c 1621 Location: /Volumes/work/vm_guests/macOS High Sierra 10.13/ 1622 Snapshots/{70d6b34d-8422-47fa-8521-3b6929a1971c}.vdi 1623 ------------------------------------------------------ 1624 VM Name: "debian" 1625 UUID: 5365ab5f-470d-44c0-9863-dad532ee5905 1626 Location: /Volumes/work/vm_guests/debian/debian.vbox 1627 ----------------------- 1628 HDD base: "debian.vdi" 1629 UUID: 96d2e92e-0d4e-46ab-a0f1-008fdbf997e7 1630 Location: /Volumes/work/vm_guests/debian/ol7.vdi 1631 1632 Diff 1: 1633 UUID: f9cc866a-9166-42e9-a503-bbfe9b7312e8 1634 Location: /Volumes/work/vm_guests/debian/Snapshots/ 1635 {f9cc866a-9166-42e9-a503-bbfe9b7312e8}.vdi</screen> 1636 1637 <para> 1638 The following command outputs partition information about the 1639 specified disk image: 1640 </para> 1641 1642 <screen>$ vboximg-mount --image=f9ea7173-6869-4aa9-b487-68023a655980 --list 1643 1644 Virtual disk image: 1645 1646 Path: /Volumes/work/vm_guests/macOS High Sierra 10.13/macOS High Sierra 10.13.vdi 1647 UUID: f9ea7173-6869-4aa9-b487-68023a655980 1648 1649 # Start Sectors Size Offset Type 1650 1 40 409599 199.9M 20480 EFI System 1651 2 409640 67453071 32.1G 209735680 Hierarchical File System Plus (HFS+) 1652 3 67862712 1269535 107.8M 34745708544 Apple Boot (Recovery HD)</screen> 1653 1654 </sect2> 1655 1656 <sect2 id="vboximg-mount-steps"> 1657 1658 <title>Mounting a Virtual Disk Image</title> 1659 1660 <para> 1661 The following steps show how to use the 1662 <command>vboximg-mount</command> command to mount a partition of 1663 a virtual disk image on the host OS. 1664 </para> 1665 1666 <orderedlist> 1667 1668 <listitem> 1669 <para> 1670 Create a mount point on the host OS. For example: 1671 </para> 1672 1673 <screen>$ mkdir macOS_sysdisk</screen> 1674 </listitem> 1675 1676 <listitem> 1677 <para> 1678 Show partition information about the virtual disk image. 1679 </para> 1680 1681 <screen>$ vboximg-mount --image=<replaceable>uuid</replaceable> --list</screen> 1682 1683 <para> 1684 where <replaceable>uuid</replaceable> is the UUID of the 1685 disk image. 1686 </para> 1687 </listitem> 1688 1689 <listitem> 1690 <para> 1691 Use <command>vboximg-mount</command> to perform a FUSE mount 1692 of a partition on the virtual disk image. For example: 1693 </para> 1694 1695 <screen>$ vboximg-mount --image=<replaceable>uuid</replaceable> -p 2 macos_sysdisk</screen> 1696 1697 <para> 1698 where <replaceable>uuid</replaceable> is the UUID for the 1699 disk image. 1700 </para> 1701 1702 <para> 1703 In this example, partition 2 is mounted on the 1704 <computeroutput>macos_sysdisk</computeroutput> mount point. 1705 The mount includes all snapshots for the disk image. 1706 </para> 1707 </listitem> 1708 1709 <listitem> 1710 <para> 1711 Use the host OS to mount the 1712 <computeroutput>vhdd</computeroutput> device node. The 1713 FUSE-mounted device node represents the virtual disk image. 1714 </para> 1715 1716 <screen>$ ls macOS_sysdisk 1717 macOS High Sierra 10.13.vdi vhdd 1718 $ sudo mount macos_sysdisk/vhdd /mnt</screen> 1719 </listitem> 1720 1721 </orderedlist> 1722 1723 </sect2> 1724 1725 </sect1> 1726 1507 1727 </chapter> -
trunk/doc/manual/en_US/user_Technical.xml
r76678 r76786 317 317 318 318 <para> 319 <xref linkend="table-version4-config-changes"/> gives a brief 320 overview of the configuration changes between legacy versions 321 and version 4.0 or later. 322 </para> 323 324 <table id="table-version4-config-changes"> 319 The following table gives a brief overview of the configuration 320 changes between legacy versions and version 4.0 or later. 321 </para> 322 323 <table id="table-version4-config-changes" tabstyle="oracle-all"> 325 324 <title>Configuration Changes in Version 4.0 or Above</title> 326 325 <tgroup cols="3"> … … 510 509 application based on the cross-platform Qt library. When 511 510 started without the <computeroutput>--startvm</computeroutput> 512 option, this application acts as the &product-name; manager,511 option, this application acts as the VirtualBox Manager, 513 512 displaying the VMs and their settings. It then communicates 514 513 settings and state changes to … … 551 550 <para> 552 551 <computeroutput>VirtualBoxVM</computeroutput>: The Qt front 553 end implementing the manager and running VMs.552 end implementing the VirtualBox Manager and running VMs. 554 553 </para> 555 554 </listitem> … … 1328 1327 also use <emphasis>large pages</emphasis> to reduce TLB usage 1329 1328 and overhead. This can yield a performance improvement of up 1330 to 5%. To enable this feature for a VM, you need to use the 1331 <computeroutput>VBoxManage modifyvm --largepages</computeroutput> 1332 command. See <xref linkend="vboxmanage-modifyvm" />. 1329 to 5%. To enable this feature for a VM, you use the 1330 <computeroutput>VBoxManage modifyvm 1331 --largepages</computeroutput> command. See 1332 <xref linkend="vboxmanage-modifyvm" />. 1333 1333 </para> 1334 1334 … … 1349 1349 1350 1350 <para> 1351 To enable these features for a VM, you need touse the1351 To enable these features for a VM, you use the 1352 1352 <computeroutput>VBoxManage modifyvm --vtxvpid</computeroutput> 1353 1353 and <computeroutput>--largepages</computeroutput> commands. -
trunk/doc/manual/en_US/user_ThirdParty.xml
r76123 r76786 550 550 <listitem> 551 551 <para> 552 &product-name; may contain portions of FUSE for macOS which is governed by553 the licenses in552 &product-name; may contain portions of FUSE for macOS which is 553 governed by the licenses in 554 554 <xref linkend="licOsxFuse" xrefstyle="template: %n" /> and 555 555 <xref linkend="licLGPL" xrefstyle="template: %n"/> and … … 557 557 558 558 <para> 559 Copyright (c) 2011-2017 Benjamin Fleischer; 560 Copyright (c) 2011-2012 Erik Larsson 561 All rights reserved. 559 Copyright (c) 2011-2017 Benjamin Fleischer; Copyright (c) 560 2011-2012 Erik Larsson All rights reserved. 562 561 </para> 563 562 </listitem> … … 4786 4785 <listitem> 4787 4786 <para> 4788 Neither the name of the copyright holder nor the names of its 4789 contributors may be used to endorse or promote products derived 4790 from this software without specific prior written permission. 4787 Neither the name of the copyright holder nor the names of 4788 its contributors may be used to endorse or promote products 4789 derived from this software without specific prior written 4790 permission. 4791 4791 </para> 4792 4792 </listitem> -
trunk/doc/manual/en_US/user_Troubleshooting.xml
r76078 r76786 159 159 Manager window can show these logs in a window. To access it, 160 160 select a virtual machine from the list on the left and select 161 <emphasis role="bold">Show logs...</emphasis> from the161 <emphasis role="bold">Show Log</emphasis> from the 162 162 <emphasis role="bold">Machine</emphasis> menu. 163 163 </para> … … 685 685 686 686 <screen>VBoxManage setextradata "VM name" 687 687 "VBoxInternal/Devices/piix3ide/0/LUN#[x]/Config/FlushInterval" [b]</screen> 688 688 689 689 <para> … … 692 692 693 693 <screen>VBoxManage setextradata "VM name" 694 694 "VBoxInternal/Devices/ahci/0/LUN#[x]/Config/FlushInterval" [b]</screen> 695 695 696 696 <para> … … 1294 1294 <para> 1295 1295 Download and install the latest version of 7-Zip File 1296 Manager. See 1297 <ulink 1298 url="http//www.7-zip.org">http//www.7-zip.org</ulink>. 1296 Manager. 1299 1297 </para> 1300 1298 </listitem> … … 1345 1343 <para> 1346 1344 Download and install the latest version of 7-Zip File 1347 Manager. See 1348 <ulink 1349 url="http//www.7-zip.org">http//www.7-zip.org</ulink>. 1345 Manager. 1350 1346 </para> 1351 1347 </listitem> … … 1396 1392 <para> 1397 1393 Download and install the latest version of 7-Zip File 1398 Manager. See 1399 <ulink 1400 url="http//www.7-zip.org">http//www.7-zip.org</ulink>. 1401 </para> 1402 </listitem> 1403 1404 <listitem> 1405 <para> 1406 Browse into the installation CD. for example E:\sources. 1394 Manager. 1395 </para> 1396 </listitem> 1397 1398 <listitem> 1399 <para> 1400 Browse into the installation CD. For example E:\sources. 1407 1401 </para> 1408 1402 </listitem> … … 1907 1901 <para> 1908 1902 If a host-only adapter cannot be created, either with the 1909 VirtualBox Manager or the <command>VBoxManage</command> 1910 command, then the INF cache is probably corrupt. In this case,1911 theinstall log1903 VirtualBox Manager or the <command>VBoxManage</command> command, 1904 then the INF cache is probably corrupt. In this case, the 1905 install log 1912 1906 (<computeroutput>%windir%\inf\setupapi.log</computeroutput> on 1913 1907 Windows XP or -
trunk/doc/manual/en_US/user_VBoxManage.xml
r76678 r76786 1003 1003 enables or disables the use of the nested paging feature in 1004 1004 the processor of your host system. See 1005 <xref 1006 linkend="hwvirt" /> and<xref linkend="sec-rec-cve-2018-3646" />.1005 <xref linkend="hwvirt" /> and 1006 <xref linkend="sec-rec-cve-2018-3646" />. 1007 1007 </para> 1008 1008 </listitem> … … 1397 1397 option. Use this option to specify which host-only 1398 1398 networking interface the given virtual network interface 1399 will use. See 1400 <xref 1401 linkend="network_hostonly" />. 1399 will use. See <xref linkend="network_hostonly" />. 1402 1400 </para> 1403 1401 </listitem> … … 1410 1408 the <computeroutput>--nic</computeroutput> option. Use this 1411 1409 option to specify the name of the internal network. See 1412 <xref 1413 linkend="network_internal" />. 1410 <xref linkend="network_internal" />. 1414 1411 </para> 1415 1412 </listitem> … … 1836 1833 <computeroutput>--usb on|off</computeroutput>: Enables and 1837 1834 disables the VM's virtual USB controller. See 1838 <xref 1839 linkend="settings-usb" />. 1835 <xref linkend="settings-usb" />. 1840 1836 </para> 1841 1837 </listitem> … … 2022 2018 standard port for RDP. See the description for the 2023 2019 <computeroutput>--vrdeport</computeroutput> option in 2024 <xref 2025 linkend="vboxmanage-modifyvm-vrde" />. 2020 <xref linkend="vboxmanage-modifyvm-vrde" />. 2026 2021 </para> 2027 2022 </listitem> … … 2035 2030 interface. See the description for the 2036 2031 <computeroutput>--vrdeaddress</computeroutput> option in 2037 <xref 2038 linkend="vboxmanage-modifyvm-vrde" />. 2032 <xref linkend="vboxmanage-modifyvm-vrde" />. 2039 2033 </para> 2040 2034 </listitem> … … 2321 2315 <listitem> 2322 2316 <para> 2323 Only IPv4: <computeroutput>--vrdeaddress "0.0.0.0"</computeroutput> 2324 </para> 2325 </listitem> 2326 2327 <listitem> 2328 <para> 2329 Only IPv6: <computeroutput>--vrdeaddress "::"</computeroutput> 2330 </para> 2331 </listitem> 2332 2333 <listitem> 2334 <para> 2335 Both IPv6 and IPv4: <computeroutput>--vrdeaddress ""</computeroutput> 2317 Only IPv4: <computeroutput>--vrdeaddress 2318 "0.0.0.0"</computeroutput> 2319 </para> 2320 </listitem> 2321 2322 <listitem> 2323 <para> 2324 Only IPv6: <computeroutput>--vrdeaddress 2325 "::"</computeroutput> 2326 </para> 2327 </listitem> 2328 2329 <listitem> 2330 <para> 2331 Both IPv6 and IPv4: <computeroutput>--vrdeaddress 2332 ""</computeroutput> 2336 2333 </para> 2337 2334 … … 2358 2355 default|<name></computeroutput>: Specifies the library 2359 2356 used for RDP authentication. See 2360 <xref 2361 linkend="vbox-auth" />. 2357 <xref linkend="vbox-auth" />. 2362 2358 </para> 2363 2359 </listitem> … … 2368 2364 Enables multiple connections to be made to the same VRDE 2369 2365 server, if the server supports this feature. See 2370 <xref 2371 linkend="vrde-multiconnection" />. 2366 <xref linkend="vrde-multiconnection" />. 2372 2367 </para> 2373 2368 </listitem> … … 2398 2393 <percent></computeroutput>: Specifies the image 2399 2394 quality for video redirection. See 2400 <xref 2401 linkend="vrde-videochannel" />. 2395 <xref linkend="vrde-videochannel" />. 2402 2396 </para> 2403 2397 </listitem> … … 2756 2750 <option>--register</option> automatically registers the new 2757 2751 clone in this &product-name; installation. You can manually 2758 register the new VM later by using the <command>V MBoxManage2759 registervm</command> command. See the2760 <xref linkend="vboxmanage-registervm" /> man page.2752 register the new VM later by using the <command>VBoxManage 2753 registervm</command> command. See 2754 <xref linkend="vboxmanage-registervm" />. 2761 2755 </para> 2762 2756 </listitem> … … 2804 2798 virtual machine which should be moved. 2805 2799 </para> 2806 2807 <remark>2808 What does the --type basic setting do?2809 </remark>2810 2800 2811 2801 <para> … … 2958 2948 <para> 2959 2949 A virtual appliance in OVF format, including copying their 2960 virtual disk images to compressed VMDK 2961 </para> 2962 </listitem> 2963 2964 <listitem> 2965 <para> 2966 A cloud service, such as &oci;. 2950 virtual disk images to compressed VMDK. 2951 </para> 2952 </listitem> 2953 2954 <listitem> 2955 <para> 2956 A cloud service, such as &oci;. A single VM can be exported in 2957 VMDK format. 2967 2958 </para> 2968 2959 </listitem> … … 3037 3028 <title>Export to &oci;</title> 3038 3029 3039 <note> 3040 <para> 3041 By default an exported image is converted into "stream vmdk" 3042 to comply OCI requirement. 3043 </para> 3044 </note> 3030 <para> 3031 By default, an exported disk image is converted into stream VMDK 3032 format. This ensures compatibility with &oci;. 3033 </para> 3045 3034 3046 3035 <para> 3047 3036 List the machine that you want to export to &oci; and specify 3048 output to &oci;by using the3037 the target cloud service provider by using the 3049 3038 <computeroutput>--output</computeroutput> or 3050 3039 <computeroutput>-o</computeroutput> option. … … 3052 3041 3053 3042 <para> 3054 To export a VM to a cloud service such as &oci;, you must use3055 the <option>--cloud</option> option to identify the virtual3056 machine that you want to export. This option works in the same3057 way as the <option>--vsys</option>option for OVF export.3043 To export a VM to a cloud service such as &oci;, use the 3044 <option>--cloud</option> option to specify the VM to export. 3045 This option works in the same way as the <option>--vsys</option> 3046 option for OVF export. 3058 3047 </para> 3059 3048 3060 3049 <para> 3061 Specify the following options. Some of these are settings for 3062 the VM instance and require you to enter an Oracle Cloud 3063 Identifier (OCID) for a resource. OCIDs can be viewed using the 3064 &oci; Console. 3050 Some of the following options are settings for the VM instance. 3051 As a result, you must enter an Oracle Cloud Identifier (OCID) 3052 for a resource. Use the &oci; Console to view OCIDs. 3065 3053 </para> 3066 3054 … … 3069 3057 <listitem> 3070 3058 <para> 3071 <computeroutput>--output</computeroutput>: The short name 3072 for the cloud service you are exporting to. For &oci;, enter 3073 <computeroutput>OCI://</computeroutput>. 3074 </para> 3075 </listitem> 3076 3077 <listitem> 3078 <para> 3079 <computeroutput>--cloud <number of virtual 3080 system></computeroutput>: A number identifying the VM 3081 that you are exporting. Numbering starts at 3059 <option>--output/-o</option>: Specifies the short name of 3060 the cloud service provider to which you export. For &oci;, 3061 enter <computeroutput>OCI://</computeroutput>. 3062 </para> 3063 </listitem> 3064 3065 <listitem> 3066 <para> 3067 <option>--cloud</option> 3068 <replaceable>number-of-virtual-system</replaceable>: 3069 Specifies a number that identifies the VM that you are 3070 exporting. Numbering starts at 3082 3071 <computeroutput>0</computeroutput> for the first VM. 3083 3072 </para> … … 3086 3075 <listitem> 3087 3076 <para> 3088 <computeroutput>--vmname <name></computeroutput>: 3089 The exported VM gets this name in the cloud service. 3090 </para> 3091 </listitem> 3092 3093 <listitem> 3094 <para> 3095 <computeroutput>--cloudprofile <cloud profile 3096 name></computeroutput>: The cloud profile contains data for 3097 communication with a cloud provider or service. The cloud profile contains details 3098 for your &oci; account, such as your user OCID, and the fingerprint for 3099 your public key. See <xref linkend="ovf-export-oci"/>. 3100 </para> 3101 </listitem> 3102 3103 <listitem> 3104 <para> 3105 <computeroutput>--cloudshape <shape></computeroutput>: 3106 The shape is used for the VM instance. Usually, determines the 3107 number of CPUs and the amount of memory allocated to a 3108 VM instance. The shape must be compatible with the exported image. 3109 </para> 3110 </listitem> 3111 3112 <listitem> 3113 <para> 3114 <computeroutput>--clouddomain 3115 <domain></computeroutput>: The availability domain 3116 used for the VM instance. Enter the OCID for the 3117 availability domain. 3118 </para> 3119 </listitem> 3120 3121 <listitem> 3122 <para> 3123 <computeroutput>--clouddisksize <disk 3124 size></computeroutput>: The disk size used for the exported 3125 image, in gigabytes. Minimum is 50GB, maximum - 300GB. 3126 </para> 3127 </listitem> 3128 3129 <listitem> 3130 <para> 3131 <computeroutput>--cloudbucket <bucket 3132 name></computeroutput>: A bucket is a kind of storage for the uploaded 3133 objects. In the &oci; a bucket is used to store the uploaded files. 3134 </para> 3135 </listitem> 3136 3137 <listitem> 3138 <para> 3139 <computeroutput>--cloudocivcn <OCI vcn 3140 id></computeroutput>: The virtual cloud network (VCN) 3141 used for the VM instance. Enter the OCID for the VCN. 3142 </para> 3143 </listitem> 3144 3145 <listitem> 3146 <para> 3147 <computeroutput>--cloudocisubnet <OCI subnet 3148 ID></computeroutput>: The subnet of the VCN used for the 3149 VM instance. Enter the OCID for the subnet. 3150 </para> 3151 </listitem> 3152 3153 <listitem> 3154 <para> 3155 <computeroutput>--cloudkeepobject 3156 <true/false></computeroutput>: Whether to store the 3157 exported image in Oracle Object Storage or not. 3158 </para> 3159 </listitem> 3160 3161 <listitem> 3162 <para> 3163 <computeroutput>--cloudlaunchinstance 3164 <true/false></computeroutput>: Whether to start the VM 3165 instance after export to &oci; or not. 3166 </para> 3167 </listitem> 3168 3169 <listitem> 3170 <para> 3171 <computeroutput>--cloudpublicip 3172 <true/false></computeroutput>: Whether to enable a 3173 public IP address for the VM instance or not. 3077 <option>--vmname</option> <replaceable>name</replaceable>: 3078 Specifies the name of the exported VM. This name is used as 3079 the VM instance name in &oci;. 3080 </para> 3081 </listitem> 3082 3083 <listitem> 3084 <para> 3085 <option>--cloudprofile</option> 3086 <replaceable>cloud-profile-name</replaceable>: Specifies the 3087 cloud profile that is used to connect to the cloud service 3088 provider. The cloud profile contains your &oci; account 3089 details, such as your user OCID and the fingerprint for your 3090 public key. See <xref linkend="ovf-export-oci"/>. 3091 </para> 3092 3093 <para> 3094 To use a cloud profile, you must have the required 3095 permissions on &oci;. 3096 </para> 3097 3098 <remark> 3099 Add xref to information about the required permissions. 3100 </remark> 3101 </listitem> 3102 3103 <listitem> 3104 <para> 3105 <option>--cloudshape</option> 3106 <replaceable>shape</replaceable>: Specifies the shape used 3107 for the VM instance. The shape defines the number of CPUs 3108 and the amount of memory allocated to the VM instance. The 3109 shape must be compatible with the exported image. 3110 </para> 3111 </listitem> 3112 3113 <listitem> 3114 <para> 3115 <option>--clouddomain</option> 3116 <replaceable>domain</replaceable>: Specifies the 3117 availability domain to use for the VM instance. Enter the 3118 OCID for the availability domain. 3119 </para> 3120 </listitem> 3121 3122 <listitem> 3123 <para> 3124 <option>--clouddisksize</option> 3125 <replaceable>disk-size-in-GB</replaceable>: Specifies the 3126 disk size used for the exported disk image in gigabytes. The 3127 minimum value is 50 GB and the maximum value is 300 GB. 3128 </para> 3129 </listitem> 3130 3131 <listitem> 3132 <para> 3133 <option>--cloudbucket</option> 3134 <replaceable>bucket-name</replaceable>: Specifies the bucket 3135 in which to store the uploaded files. In &oci;, a bucket is 3136 a logical container for storing objects. 3137 </para> 3138 </listitem> 3139 3140 <listitem> 3141 <para> 3142 <option>--cloudocivcn</option> 3143 <replaceable>OCI-vcn-ID</replaceable>: Specifies the virtual 3144 cloud network (VCN) to use for the VM instance. Enter the 3145 OCID for the VCN. 3146 </para> 3147 </listitem> 3148 3149 <listitem> 3150 <para> 3151 <option>--cloudocisubnet</option> 3152 <replaceable>OCI-subnet-ID</replaceable>: Specifies the 3153 subnet of the VCN to use for the VM instance. Enter the OCID 3154 for the subnet. 3155 </para> 3156 </listitem> 3157 3158 <listitem> 3159 <para> 3160 <option>--cloudkeepobject true | false</option>: Specifies 3161 whether to store the exported disk image in Oracle Object 3162 Storage. 3163 </para> 3164 </listitem> 3165 3166 <listitem> 3167 <para> 3168 <option>--cloudlaunchinstance true | false</option>: 3169 Specifies whether to start the VM instance after the export 3170 to &oci; completes. 3171 </para> 3172 </listitem> 3173 3174 <listitem> 3175 <para> 3176 <option>--cloudpublicip true | false</option>: Specifies 3177 whether to enable a public IP address for the VM instance. 3174 3178 </para> 3175 3179 </listitem> … … 3182 3186 </para> 3183 3187 3184 <screen>VBoxManage export "OCI_Export" --output OCI:// --cloud 0 --vmname OCI_export \ 3185 --cloudshape VM.Standard2.1 --clouddomain abcd:US-ASHBURN-AD-1 --clouddisksize 50 \ 3186 --cloudbucket test_bucket --cloudocivcn ocid1.vcn.oc1.iad.aaaa... \ 3187 --cloudpublicip true --cloudprofile "standard user" --cloudocisubnet ocid1.subnet.oc1.iad.aaaa... \ 3188 --cloudkeepobject true --cloudlaunchinstance true</screen> 3188 <remark> 3189 For the next release, describe exactly what this command does in 3190 terms of the command line options. 3191 </remark> 3192 3193 <screen># VBoxManage export myVM --output OCI:// --cloud 0 --vmname myVM_Cloud \ 3194 --cloudprofile "standard user" --cloudbucket myBucket \ 3195 --cloudshape VM.Standard2.1 --clouddomain aaaa:US-ASHBURN-AD-1 --clouddisksize 50 \ 3196 --cloudocivcn ocid1.vcn.oc1.iad.aaaa... --cloudocisubnet ocid1.subnet.oc1.iad.aaaa... \ 3197 --cloudkeepobject true --cloudlaunchinstance true --cloudpublicip true</screen> 3189 3198 3190 3199 </sect2> … … 3479 3488 <computeroutput>nicproperty<1-N> 3480 3489 <paramname>="paramvalue"</computeroutput>: This option, 3481 in combination with <computeroutput>nicgenericdrv</computeroutput>3482 enables you to pass parameters to rarely-used3483 network backends.3490 in combination with 3491 <computeroutput>nicgenericdrv</computeroutput> enables you to 3492 pass parameters to rarely-used network backends. 3484 3493 </para> 3485 3494 … … 3872 3881 <computeroutput>vrdevideochannelquality 3873 3882 <percent></computeroutput>: Sets the image quality for 3874 video redirection. See 3875 <xref 3876 linkend="vrde-videochannel" />. 3883 video redirection. See <xref linkend="vrde-videochannel" />. 3877 3884 </para> 3878 3885 </listitem> … … 4229 4236 4230 4237 <para> 4231 For a headless encrypted VM start, use the fol owing command:4238 For a headless encrypted VM start, use the following command: 4232 4239 </para> 4233 4240 … … 6919 6926 <varlistentry> 6920 6927 <term> 6921 <computeroutput>-E|--putenv <NAME>=<VALUE></computeroutput> 6928 <computeroutput>-E|--putenv 6929 <NAME>=<VALUE></computeroutput> 6922 6930 </term> 6923 6931 … … 7196 7204 <varlistentry> 7197 7205 <term> 7198 <computeroutput>-E|--putenv <NAME>=<VALUE></computeroutput> 7206 <computeroutput>-E|--putenv 7207 <NAME>=<VALUE></computeroutput> 7199 7208 </term> 7200 7209 … … 8380 8389 Metric collection can only be enabled for started VMs. Collected 8381 8390 data and collection settings for a particular VM will disappear as 8382 soon as it shuts down. Use <command>VBoxManage metrics list</command>8383 subcommand to see which metrics are currently8384 available. You can also use <option>--list</option> option with8385 any subcommand that modifies metric settings to find out which8386 metrics were affected.8391 soon as it shuts down. Use the <command>VBoxManage metrics 8392 list</command> subcommand to see which metrics are currently 8393 available. You can also use the <option>--list</option> option 8394 with any subcommand that modifies metric settings to find out 8395 which metrics were affected. 8387 8396 </para> 8388 8397 -
trunk/doc/manual/en_US/user_VirtualBoxAPI.xml
r76113 r76786 11 11 <para> 12 12 &product-name; comes with comprehensive support for third-party 13 developers. The so-called "Main API" of &product-name; exposes the14 entire feature set of the virtualization engine. It is completely15 documented and available to anyone who wishes to control16 &product-name; programmatically.13 developers. The so-called <emphasis>Main API</emphasis> of 14 &product-name; exposes the entire feature set of the virtualization 15 engine. It is completely documented and available to anyone who 16 wishes to control &product-name; programmatically. 17 17 </para> 18 18 … … 29 29 Development Kit (SDK)</emphasis>. The SDK is available for download 30 30 from 31 <ulink 32 url="http://www.virtualbox.org">http://www.virtualbox.org</ulink>. 31 <ulink url="http://www.virtualbox.org">http://www.virtualbox.org</ulink>. 33 32 In particular, the SDK comes with a Programming Guide and Reference 34 33 manual in PDF format. This manual contains, among other things, the
Note:
See TracChangeset
for help on using the changeset viewer.