VirtualBox

Changeset 34539 in vbox for trunk/doc


Ignore:
Timestamp:
Nov 30, 2010 6:57:50 PM (14 years ago)
Author:
vboxsync
Message:

Manual: misc fixes

Location:
trunk/doc/manual/en_US
Files:
5 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/manual/en_US/user_AdvancedTopics.xml

    r34533 r34539  
    4949      <para>For simplicity, we will abbreviate this as
    5050      <computeroutput>$HOME</computeroutput> below. Using that convention, the
    51       shared folder for all virtual machines is
     51      common folder for all virtual machines is
    5252      <computeroutput>$HOME/VirtualBox VMs</computeroutput>.</para>
    5353
    54       <para>As an example, if you have created a virtual machine called
    55       "Example VM", you will find that VirtualBox has created<orderedlist>
     54      <para>As an example, when you create a virtual machine called "Example
     55      VM", you will find that VirtualBox creates<orderedlist>
    5656          <listitem>
    5757            <para>the folder <computeroutput>$HOME/VirtualBox VMs/Example
    … …  
    8383      "Preferences" from the "File" menu in the VirtualBox main window. Then,
    8484      in the window that pops up, click on the "General" tab. Alternatively,
    85       use VBoxManage setproperty machinefolder; see <xref
     85      use <computeroutput>VBoxManage setproperty
     86      machinefolder</computeroutput>; see <xref
    8687      linkend="vboxmanage-setproperty" />.</para>
    8788    </sect2>
    … …  
    9798      files from virtual disk images. The machine settings files had an
    9899      <computeroutput>.xml</computeroutput> file extension and resided in a
    99       folder called "Machines" under the VirtualBox configuration directory
    100       (see the next section). So, for example, on Linux, this was the hidden
    101       <computeroutput>$HOME/.VirtualBox/Machines</computeroutput> directory.
    102       The default hard disks folder was called "HardDisks" and resided in the
    103       <computeroutput>.VirtualBox</computeroutput> folder as well, but that
    104       could be changed by the user in the global preferences. (The concept of
    105       a "default hard disk folder" has been abandoned with VirtualBox 4.0,
    106       since disk images now reside in each machine's folder by
    107       default.)</para>
     100      folder called "Machines" under the global VirtualBox configuration
     101      directory (see the next section). So, for example, on Linux, this was
     102      the hidden <computeroutput>$HOME/.VirtualBox/Machines</computeroutput>
     103      directory. The default hard disks folder was called "HardDisks" and
     104      resided in the <computeroutput>.VirtualBox</computeroutput> folder as
     105      well. Both locations could be changed by the user in the global
     106      preferences. (The concept of a "default hard disk folder" has been
     107      abandoned with VirtualBox 4.0, since disk images now reside in each
     108      machine's folder by default.)</para>
    108109
    109110      <para>The old layout had several severe disadvantages.<orderedlist>
    … …  
    149150      <computeroutput>$HOME/Library/VirtualBox</computeroutput>.</para>
    150151
    151       <para>VirtualBox creates this configuration directory automatically, if
     152      <para>VirtualBox creates this configuration directory automatically if
    152153      necessary. Optionally, you can supply an alternate configuration
    153154      directory by setting the
    … …  
    14971498
    14981499  <sect1 id="solariscodedumper">
    1499     <title>Configuring VirtualBox CoreDumper on Solaris hosts</title>
     1500    <title>Configuring the VirtualBox CoreDumper on Solaris hosts</title>
    15001501
    15011502    <para>VirtualBox is capable of producing its own core files when things go
    … …  
    15471548
    15481549  <sect1 id="guitweaks">
    1549     <title>Locking down the GUI</title>
     1550    <title>Locking down the VirtualBox manager GUI</title>
    15501551
    15511552    <para>There are several advanced customization settings for locking down
    1552     the GUI, that is, removing some features that the user should not
    1553     see.<screen>VBoxManage setextradata global GUI/Customizations OPTION[,OPTION...]</screen></para>
     1553    the VirtualBox manager, that is, removing some features that the user
     1554    should not see.<screen>VBoxManage setextradata global GUI/Customizations OPTION[,OPTION...]</screen></para>
    15541555
    15551556    <para>where <computeroutput>OPTION</computeroutput> is one of the
    … …  
    15591560
    15601561          <glossdef>
    1561             <para>Don't allow to start the VM selector GUI. Trying to do so
     1562            <para>Don't allow to start the VirtualBox manager. Trying to do so
    15621563            will show a window containing a proper error message.</para>
    15631564          </glossdef>
    … …  
    15681569
    15691570          <glossdef>
    1570             <para>The VM windows will not contain a menu bar.</para>
     1571            <para>VM windows will not contain a menu bar.</para>
    15711572          </glossdef>
    15721573        </glossentry>
    … …  
    15761577
    15771578          <glossdef>
    1578             <para>The VM windows will not contain a status bar.</para>
     1579            <para>VM windows will not contain a status bar.</para>
    15791580          </glossdef>
    15801581        </glossentry>
    … …  
    15831584    <para>To disable any GUI customization do <screen>VBoxManage setextradata global GUI/Customizations</screen></para>
    15841585
    1585     <para>To disable all host key combinations, open the global settings and
     1586    <para>To disable all host key combinations, open the preferences and
    15861587    change the host key to <emphasis>None</emphasis>. This might be useful
    15871588    when using VirtualBox in a kiosk mode.</para>
    15881589
    1589     <para>Furthermore, you can disallow certain actions when terminating a VM
    1590     from the GUI. To disallow specific actions, type:</para>
     1590    <para>Furthermore, you can disallow certain actions when terminating a VM.
     1591    To disallow specific actions, type:</para>
    15911592
    15921593    <para><screen>VBoxManage setextradata "VM name" GUI/RestrictedCloseActions OPTION[,OPTION...]</screen></para>
    … …  
    15981599
    15991600          <glossdef>
    1600             <para>Don't allow the user to save the VM state plus terminate the
    1601             VM.</para>
     1601            <para>Don't allow the user to save the VM state when terminating
     1602            the VM.</para>
    16021603          </glossdef>
    16031604        </glossentry>
    … …  
    16081609          <glossdef>
    16091610            <para>Don't allow the user to shutdown the VM by sending the ACPI
    1610             power off event to the guest.</para>
     1611            power-off event to the guest.</para>
    16111612          </glossdef>
    16121613        </glossentry>
    … …  
    16301631      </glosslist></para>
    16311632
    1632     <para>Combinations of all of these options are allowed. If all options are
    1633     specified, the VM cannot be shut down from the GUI.</para>
     1633    <para>Any combination of the above is allowed. If all options are
     1634    specified, the VM cannot be shut down at all.</para>
    16341635  </sect1>
    16351636
    16361637  <sect1 id="vboxwebsrv-daemon">
    1637     <title>Starting <computeroutput>vboxwebsrv</computeroutput>
    1638     automatically</title>
    1639 
    1640     <para><computeroutput>vboxwebsrv</computeroutput> is used for controlling
    1641     VirtualBox remotely. As the client base using this interface is growing,
    1642     we added start scripts for the various operation systems we support. The
    1643     following describes how to use them. <itemizedlist>
     1638    <title>Starting the VirtualBox web service automatically</title>
     1639
     1640    <para>The VirtualBox web service
     1641    (<computeroutput>vboxwebsrv</computeroutput>) is used for controlling
     1642    VirtualBox remotely. It is documented in detail in the VirtualBox Software
     1643    Development Kit (SDK); please see <xref linkend="VirtualBoxAPI" />. As the
     1644    client base using this interface is growing, we added start scripts for
     1645    the various operation systems we support. The following describes how to
     1646    use them. <itemizedlist>
    16441647        <listitem>
    16451648          <para>On Mac OS X, launchd is used. An example configuration file
    16461649          can be found in
    16471650          <computeroutput>$HOME/Library/LaunchAgents/org.virtualbox.vboxwebsrv.plist</computeroutput>.
    1648           It has to be enabled by changing the
     1651          It can be enabled by changing the
    16491652          <computeroutput>Disabled</computeroutput> key from
    16501653          <computeroutput>true</computeroutput> to

  • trunk/doc/manual/en_US/user_GuestAdditions.xml

    r34392 r34539  
    12441244                virtual machine. As a result, the Guest Additions installation
    12451245                program offers Direct 3D acceleration as an option that must
    1246                 be explicitly enabled.</para>
    1247 
    1248                 <para>Also, you must install the Guest Additions in "Safe
    1249                 Mode"; see <xref linkend="KnownIssues" /> for details.</para>
     1246                be explicitly enabled. Also, you must install the Guest
     1247                Additions in "Safe Mode"; see <xref linkend="KnownIssues" />
     1248                for details.</para>
    12501249              </note></para>
    12511250          </listitem>
    … …  
    12571256            linkend="generalsettings" />).<note>
    12581257                <para>Enabling 3D acceleration may expose security holes to
    1259                 malicious software running the guest. The third-party code
     1258                malicious software running in the guest. The third-party code
    12601259                that VirtualBox uses for this purpose (Chromium) is not
    12611260                hardened enough to prevent every risky 3D operation on the
    … …  
    12721271      hardware acceleration through the OpenGL or Direct3D programming
    12731272      interfaces, these are sent to the host through a special communication
    1274       tunnel implemented by VirtualBox, and then the host performs the
    1275       requested 3D operation via the host's programming interfaces.</para>
     1273      tunnel implemented by VirtualBox, and then the <emphasis>host</emphasis>
     1274      performs the requested 3D operation via the host's programming
     1275      interfaces.</para>
    12761276    </sect2>
    12771277

  • trunk/doc/manual/en_US/user_KnownIssues.xml

    r34124 r34539  
    4141
    4242    <listitem>
    43       <para><emphasis role="bold">Direct 3D support in Windows
    44       guests.</emphasis> For this to work, the Guest Additions must be
    45       installed in Windows "safe mode". Press F8 when the Windows guest is
    46       booting and select "Safe mode", then install the Guest Additions.
    47       Otherwise Windows' file protection mechanism will interfere with the
    48       replacement DLLs installed by VirtualBox and keep restoring the original
    49       Windows system DLLs.</para>
     43      <para>For <emphasis role="bold">Direct3D support in Windows
     44      guests</emphasis> to work, the Guest Additions must be installed in
     45      Windows "safe mode". Press F8 when the Windows guest is booting and
     46      select "Safe mode", then install the Guest Additions. Otherwise Windows'
     47      file protection mechanism will interfere with the replacement DLLs
     48      installed by VirtualBox and keep restoring the original Windows system
     49      DLLs.</para>
    5050    </listitem>
    5151
    5252    <listitem>
    5353      <para><emphasis role="bold">Guest control.</emphasis> On Windows guests,
    54       a process lauched via the guest control execute support is only able to
    55       display a graphical user interface if the user account it is started
    56       under, is currently logged in and has a desktop session. Otherwise, the
    57       process will not be able to display its user interface.</para>
    58 
    59       <para>Also, for using accounts without or with an empty password
    60       specified, the group policy needs to be changed on the guest. To do so,
    61       open the group policy editor on the command line by typing
     54      a process lauched via the guest control execute support will not be able
     55      to display a graphical user interface <emphasis>unless</emphasis> the
     56      user account under which it is running is currently logged in and has a
     57      desktop session.</para>
     58
     59      <para>Also, to use accounts without or with an empty password, the
     60      guest's group policy must be changed. To do so, open the group policy
     61      editor on the command line by typing
    6262      <computeroutput>gpedit.msc</computeroutput>, open the key
    6363      <emphasis>Computer Configuration\Windows Settings\Security
    … …  
    6868
    6969    <listitem>
    70       <para><emphasis role="bold">Guest multi-monitor support.</emphasis> This
    71       feature is currently only supported with Windows guests.</para>
    72     </listitem>
    73 
    74     <listitem>
    75       <para><emphasis role="bold">Deleting the only snapshot with a running VM
    76       is not implemented.</emphasis> Trying to perform this operation will
    77       result in an error message. This feature will be added in one of the
    78       next maintenance releases. It is possible to delete the only snapshot
    79       when the VM is not running, e.g. in "poweroff" or "saved" state.</para>
     70      <para><emphasis role="bold">Guest multi-monitor support</emphasis> is
     71      currently only supported with Windows guests.</para>
    8072    </listitem>
    8173
    … …  
    10193      <para><emphasis role="bold">OVF import/export:</emphasis><itemizedlist>
    10294          <listitem>
    103             <para>When importing an OVF that was previously exported by
    104             VirtualBox 3.2 or higher which contains a complete VirtualBox
    105             machine configuration in the &lt;vbox:Machine&gt; element, some of
    106             the import customizations that can be specified (in either the GUI
    107             or on the VBoxManage command line) are presently ignored. In
    108             particular, customizations of the imported storage configuration
    109             are ignored. This will be fixed in the next release.</para>
    110           </listitem>
    111 
    112           <listitem>
    11395            <para>OVF localization (multiple languages in one OVF file) is not
    11496            yet supported.</para>
    … …  
    140122
    141123    <listitem>
    142       <para><emphasis role="bold">Mac OS X hosts.</emphasis> The following
    143       restrictions apply (all of which will be resolved in future
    144       versions):<itemizedlist>
     124      <para><emphasis role="bold">Mac OS X hosts:</emphasis><itemizedlist>
    145125          <listitem>
    146126            <para>The numlock emulation has not yet been implemented.</para>
    … …  
    164144
    165145    <listitem>
    166       <para><emphasis role="bold">Mac OS X Server guests.</emphasis>
     146      <para><emphasis role="bold">Mac OS X Server guests:</emphasis>
    167147      <itemizedlist>
    168148          <listitem>
    … …  
    215195
    216196    <listitem>
    217       <para><emphasis role="bold">Solaris hosts.</emphasis> The following
    218       restrictions apply for OpenSolaris and Solaris 10:<itemizedlist>
     197      <para><emphasis role="bold">Solaris hosts:</emphasis> <itemizedlist>
    219198          <listitem>
    220199            <para>There is no support for USB devices connected to Solaris 10

  • trunk/doc/manual/en_US/user_Technical.xml

    r31735 r34539  
    11<?xml version="1.0" encoding="UTF-8"?>
    22<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
    3   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
     3"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
    44<chapter id="TechnicalBackground">
    55  <title>Technical background</title>
    … …  
    4040          a client application based on the cross-platform Qt library. When
    4141          started without the <computeroutput>--startvm</computeroutput>
    42           option, this application acts as the VirtualBox main window,
    43           displaying the VMs and their settings. It then communicates settings
    44           and state changes to <computeroutput>VBoxSVC</computeroutput> and
    45           also reflects changes effected through other means, e.g.,
     42          option, this application acts as the VirtualBox manager, displaying
     43          the VMs and their settings. It then communicates settings and state
     44          changes to <computeroutput>VBoxSVC</computeroutput> and also
     45          reflects changes effected through other means, e.g.,
    4646          <computeroutput>VBoxManage</computeroutput>.</para>
    4747        </listitem>
    … …  
    6464
    6565    <para>The VirtualBox GUI application is only one of several available
    66     front-ends (clients). The complete list shipped with VirtualBox
     66    front ends (clients). The complete list shipped with VirtualBox
    6767    is:<orderedlist>
    6868        <listitem>
    69           <para><computeroutput>VirtualBox</computeroutput>, the Qt GUI front
    70           end mentioned earlier.</para>
     69          <para><computeroutput>VirtualBox</computeroutput>, the Qt front end
     70          implementing the manager and running VMs;</para>
    7171        </listitem>
    7272
    7373        <listitem>
    7474          <para><computeroutput>VBoxManage</computeroutput>, a less
    75           user-friendly but more powerful alternative to the GUI described in
    76           <xref linkend="vboxmanage" />.</para>
     75          user-friendly but more powerful alternative, described in <xref
     76          linkend="vboxmanage" />.</para>
    7777        </listitem>
    7878

  • trunk/doc/manual/en_US/user_Troubleshooting.xml

    r34124 r34539  
    102102      is called <computeroutput><literal>VBox.log</literal></computeroutput>
    103103      and resides in the VM log file folder. Typically this will be a
    104       directory like this:<screen>$HOME/.VirtualBox/Machines/{machinename}/Logs</screen>When
    105       starting a VM, the configuration file of the last run will be renamed to
    106       <computeroutput>.1</computeroutput>, up to
     104      directory like this:<screen>$HOME/VirtualBox VMs/{machinename}/Logs</screen></para>
     105
     106      <para>When starting a VM, the configuration file of the last run will be
     107      renamed to <computeroutput>.1</computeroutput>, up to
    107108      <computeroutput>.3</computeroutput>. Sometimes when there is a problem,
    108109      it is useful to have a look at the logs. Also when requesting support
    … …  
    121122      features, whether hardware virtualization is enabled, information about
    122123      VT-x/AMD-V setup, state transitions (creating, running, paused,
    123       stopping, etc.), guest BIOS messages, guest Additions messages, device
    124       specific log entries and at the end of execution, final guest state and
    125       condensed statistics.</para>
     124      stopping, etc.), guest BIOS messages, Guest Additions messages,
     125      device-specific log entries and, at the end of execution, final guest
     126      state and condensed statistics.</para>
    126127
    127128      <para>In case of crashes, it is very important to collect <emphasis
    … …  
    145146          <para><ulink
    146147          url="http://www.virtualbox.org/wiki/Network_tips">http://www.virtualbox.org/wiki/Network_tips</ulink>.</para>
    147         </footnote> for information on enabling this capture. Note that the
    148       trace files created by VirtualBox are in .pcap format and can be easily
    149       analyzed with Wireshark.</para>
     148        </footnote> for information on enabling this capture. The trace files
     149      created by VirtualBox are in <computeroutput>.pcap</computeroutput>
     150      format and can be easily analyzed with Wireshark.</para>
    150151    </sect2>
    151152
    … …  
    154155
    155156      <para>VirtualBox includes a built-in VM debugger, which advanced users
    156       may find useful. This debugger allows the user to examine, and to some
    157       extent, control, the VM state.<note>
     157      may find useful. This debugger allows for examining and, to some extent,
     158      controlling the VM state.<warning>
    158159          <para>Use the VM debugger at your own risk. There is no support for
    159160          it, and the following documentation is only made available for
    … …  
    161162          x86/AMD64 machine instruction set, as well as detailed knowledge of
    162163          the PC architecture. A degree of familiarity with the internals of
    163           the guest OS in question is not required, but may be very
    164           helpful.</para>
    165         </note></para>
     164          the guest OS in question may also be very helpful.</para>
     165        </warning></para>
    166166
    167167      <para>The VM debugger is available in all regular production versions of
    … …  
    181181      <para>The debugger can be enabled in three ways:<itemizedlist>
    182182          <listitem>
    183             <para>Start the <computeroutput>VirtualBox</computeroutput>
    184             process with a <computeroutput>--dbg</computeroutput>,
     183            <para>Start the VM directly using <computeroutput>VirtualBox
     184            --startvm</computeroutput>, with an additional
     185            <computeroutput>--dbg</computeroutput>,
    185186            <computeroutput>--debug</computeroutput>, or
    186187            <computeroutput>--debug-command-line</computeroutput> argument.
    187             See the VirtualBox usage help for details. Note that these
    188             arguments are only useful when a VM is started immediately, using
    189             the <computeroutput>--startvm</computeroutput> argument.</para>
     188            See the VirtualBox usage help for details.</para>
    190189          </listitem>
    191190
    … …  
    896895      an "Error inserting vboxdrv: Invalid argument", check (as root) the
    897896      output of the <computeroutput>dmesg</computeroutput> command to find out
    898       why the load failed. The most common reasons are:</para>
    899 
    900       <itemizedlist>
    901         <listitem>
    902           <para>The kernel disagrees about the version of the gcc used to
    903           compile the module. Make sure that you use the same compiler as used
    904           to build the kernel.</para>
    905         </listitem>
    906       </itemizedlist>
     897      why the load failed. Most probably the kernel disagrees with the version
     898      of the gcc used to compile the module. Make sure that you use the same
     899      compiler as used to build the kernel.</para>
    907900    </sect2>
    908901
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette