VirtualBox

Changeset 82350 in vbox


Ignore:
Timestamp:
Dec 3, 2019 6:44:23 PM (5 years ago)
Author:
vboxsync
Message:

manual: integrate 6.1 drop #10 with minimal manual adjustments (frontmatter for preface and eliminated trailing whitespace)

Location:
trunk/doc/manual
Files:
3 added
23 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/manual/Config.kmk

    r82058 r82350  
    297297                '<!ENTITY VBOX_PRODUCT '\''<trademark class="registered">Oracle</trademark> VM <trademark class="registered">VirtualBox</trademark>'\'' >' \
    298298                '' \
    299                 '<!-- Entities for OTN -->' \
    300                 '<!ENTITY otn-base-url "https://www.oracle.com/technetwork">' \
    301                 '<!ENTITY otn-doc-tab "&otn-base-url;/server-storage/virtualbox/documentation/index.html">'
     299                '<!-- Entities for Oracle Help Center -->' \
     300                '<!ENTITY ohc-base-url "https://docs.oracle.com/en">' \
     301                '<!ENTITY ohc-doc-page "&ohc-base-url;/virtualization/virtualbox/index.html">'
    302302
    303303endif # VBOX_XML_ENTITIES
  • trunk/doc/manual/en_US/UserManual.xml

    r76786 r82350  
    99<!-- VBox bookinfo section -->
    1010
    11 <bookinfo>
     11  <bookinfo>
    1212
    13  <title>&VBOX_PRODUCT;</title>
     13    <title>&VBOX_PRODUCT;</title>
    1414
    1515    <subtitle>User Manual</subtitle>
  • trunk/doc/manual/en_US/user_AdvancedTopics.xml

    r81589 r82350  
    3030
    3131      <para>
    32         Since Windows NT, Windows has provided a modular system login
    33         subsystem, called Winlogon, which can be customized and extended
    34         by means of so-called GINA (Graphical Identification and
    35         Authentication) modules. With Windows Vista and Windows 7, the
    36         GINA modules were replaced with a new mechanism called
    37         credential providers. The &product-name; Guest Additions for
    38         Windows come with both, a GINA and a credential provider module,
    39         and therefore enable any Windows guest to perform automated
    40         logins.
     32        Windows provides a modular system login subsystem, called
     33        Winlogon, which can be customized and extended by means of
     34        so-called GINA (Graphical Identification and Authentication)
     35        modules. In Windows Vista and later releases, the GINA modules
     36        were replaced with a new mechanism called credential providers.
     37        The &product-name; Guest Additions for Windows come with both, a
     38        GINA and a credential provider module, and therefore enable any
     39        Windows guest to perform automated logins.
    4140      </para>
    4241
     
    4443        To activate the &product-name; GINA or credential provider
    4544        module, install the Guest Additions using the command line
    46         switch <computeroutput>/with_autologon</computeroutput>. All the
    47         following manual steps required for installing these modules
    48         will be then done by the installer.
     45        switch <option>/with_autologon</option>. All the following
     46        manual steps required for installing these modules will be then
     47        done by the installer.
    4948      </para>
    5049
     
    5251        To manually install the &product-name; GINA module, extract the
    5352        Guest Additions as shown in
    54         <xref linkend="windows-guest-file-extraction" /> and copy the
    55         file <computeroutput>VBoxGINA.dll</computeroutput> to the
    56         Windows <computeroutput>SYSTEM32</computeroutput> directory.
    57         Then, in the registry, create the following key with a value of
    58         <computeroutput>VBoxGINA.dll</computeroutput>:
     53        <xref linkend="windows-guest-file-extraction" />, and copy the
     54        <filename>VBoxGINA.dll</filename> file to the Windows
     55        <filename>SYSTEM32</filename> directory. In the registry, create
     56        the following key with a value of
     57        <filename>VBoxGINA.dll</filename>:
    5958      </para>
    6059
     
    6463        <para>
    6564          The &product-name; GINA module is implemented as a wrapper
    66           around the standard Windows GINA module,
    67           <computeroutput>MSGINA.DLL</computeroutput>. As a result, it
    68           may not work correctly with third party GINA modules.
     65          around the <filename>MSGINA.DLL</filename> standard Windows
     66          GINA module. As a result, it might not work correctly with
     67          third-party GINA modules.
    6968        </para>
    7069      </note>
     
    7372        To manually install the &product-name; credential provider
    7473        module, extract the Guest Additions as shown in
    75         <xref
    76       linkend="windows-guest-file-extraction" /> and copy
    77         the file <computeroutput>VBoxCredProv.dll</computeroutput> to
    78         the Windows <computeroutput>SYSTEM32</computeroutput> directory.
    79         In the registry, create the following keys:
     74        <xref linkend="windows-guest-file-extraction" /> and copy the
     75        <filename>VBoxCredProv.dll</filename> file to the Windows
     76        <filename>SYSTEM32</filename> directory. In the registry, create
     77        the following keys:
    8078      </para>
    8179
     
    8886
    8987      <para>
    90         All default values, the key named
    91         <computeroutput>Default</computeroutput>, must be set to
    92         <computeroutput>VBoxCredProv</computeroutput>.
    93       </para>
    94 
    95       <para>
    96         Create a new string named as follows, with a value of
    97         <computeroutput>Apartment</computeroutput>.
     88        All default values, the key named <literal>Default</literal>,
     89        must be set to <literal>VBoxCredProv</literal>.
     90      </para>
     91
     92      <para>
     93        Create the following string and assign it a value of
     94        <literal>Apartment</literal>.
    9895      </para>
    9996
     
    105102      </para>
    106103
    107 <screen>VBoxManage controlvm "Windows XP" setcredentials "John Doe" "secretpassword" "DOMTEST"</screen>
     104<screen>$ VBoxManage controlvm "Windows XP" setcredentials "John Doe" "secretpassword" "DOMTEST"</screen>
    108105
    109106      <para>
     
    127124
    128125      <para>
    129         Depending on the particular variant of the Windows guest, the
    130         following restrictions apply:
     126        Depending on the Windows guest version, the following
     127        restrictions apply:
    131128      </para>
    132129
     
    138135            login subsystem needs to be configured to use the classic
    139136            login dialog, as the &product-name; GINA module does not
    140             support the XP-style welcome dialog.
     137            support the Windows XP-style welcome dialog.
    141138          </para>
    142139        </listitem>
     
    147144            and Windows 10 guests.</emphasis> The login subsystem does
    148145            not support the so-called Secure Attention Sequence,
    149             <computeroutput>Ctrl+Alt+Del</computeroutput>. As a result,
    150             the guest's group policy settings need to be changed to not
    151             use the Secure Attention Sequence. Also, the user name given
    152             is only compared to the true user name, not the user
    153             friendly name. This means that when you rename a user, you
    154             still have to supply the original user name as Windows never
    155             renames user accounts internally.
     146            <literal>Ctrl+Alt+Del</literal>. As a result, the guest's
     147            group policy settings need to be changed to not use the
     148            Secure Attention Sequence. Also, the user name given is only
     149            compared to the true user name, not the user friendly name.
     150            This means that when you rename a user, you still have to
     151            supply the original user name as Windows never renames user
     152            accounts internally.
    156153          </para>
    157154        </listitem>
     
    163160            Service</emphasis>, formerly known as Terminal Services, is
    164161            disabled by default. To enable it, create the following
    165             registry key with a <computeroutput>DWORD</computeroutput>
    166             value of <computeroutput>1</computeroutput>.
     162            registry key with a <literal>DWORD</literal> value of
     163            <literal>1</literal>.
    167164          </para>
    168165
     
    177174      </para>
    178175
    179 <screen>VBoxManage setextradata "Windows XP" VBoxInternal/Devices/VMMDev/0/Config/KeepCredentials 1</screen>
     176<screen>$ VBoxManage setextradata "Windows XP" VBoxInternal/Devices/VMMDev/0/Config/KeepCredentials 1</screen>
    180177
    181178      <para>
     
    205202
    206203      <para>
    207         The <computeroutput>pam_vbox.so</computeroutput> module itself
     204        The <filename>pam_vbox.so</filename> module itself
    208205        <emphasis>does not</emphasis> do an actual verification of the
    209206        credentials passed to the guest OS. Instead it relies on other
    210         modules such as <computeroutput>pam_unix.so</computeroutput> or
    211         <computeroutput>pam_unix2.so</computeroutput> down in the PAM
    212         stack to do the actual validation using the credentials
    213         retrieved by <computeroutput>pam_vbox.so</computeroutput>.
    214         Therefore <computeroutput>pam_vbox.so</computeroutput> has to be
    215         on top of the authentication PAM service list.
     207        modules such as <filename>pam_unix.so</filename> or
     208        <filename>pam_unix2.so</filename> down in the PAM stack to do
     209        the actual validation using the credentials retrieved by
     210        <filename>pam_vbox.so</filename>. Therefore
     211        <filename>pam_vbox.so</filename> has to be on top of the
     212        authentication PAM service list.
    216213      </para>
    217214
    218215      <note>
    219216        <para>
    220           The <computeroutput>pam_vbox.so</computeroutput> module only
    221           supports the <computeroutput>auth</computeroutput> primitive.
    222           Other primitives such as
    223           <computeroutput>account</computeroutput>,
    224           <computeroutput>session</computeroutput>, or
    225           <computeroutput>password</computeroutput> are not supported.
     217          The <filename>pam_vbox.so</filename> module only supports the
     218          <literal>auth</literal> primitive. Other primitives such as
     219          <literal>account</literal>, <literal>session</literal>, or
     220          <literal>password</literal> are not supported.
    226221        </para>
    227222      </note>
    228223
    229224      <para>
    230         The <computeroutput>pam_vbox.so</computeroutput> module is
    231         shipped as part of the Guest Additions but it is not installed
    232         and/or activated on the guest OS by default. In order to install
    233         it, it has to be copied from
    234         <computeroutput>/opt/VBoxGuestAdditions-&lt;version&gt;/other/</computeroutput>
     225        The <filename>pam_vbox.so</filename> module is shipped as part
     226        of the Guest Additions but it is not installed and/or activated
     227        on the guest OS by default. In order to install it, it has to be
     228        copied from
     229        <filename>/opt/VBoxGuestAdditions-<replaceable>version</replaceable>/other/</filename>
    235230        to the security modules directory. This is usually
    236         <computeroutput>/lib/security/</computeroutput> on 32-bit Linux
    237         guests or <computeroutput>/lib64/security/</computeroutput> on
    238         64-bit Linux guests. Please refer to your guest OS documentation
    239         for the correct PAM module directory.
    240       </para>
    241 
    242       <para>
    243         For example, to use <computeroutput>pam_vbox.so</computeroutput>
    244         with a Ubuntu Linux guest OS and the GNOME Desktop Manager (GDM)
    245         to log in users automatically with the credentials passed by the
    246         host, configure the guest OS as follows:
     231        <filename>/lib/security/</filename> on 32-bit Linux guests or
     232        <filename>/lib64/security/</filename> on 64-bit Linux guests.
     233        Please refer to your guest OS documentation for the correct PAM
     234        module directory.
     235      </para>
     236
     237      <para>
     238        For example, to use <filename>pam_vbox.so</filename> with a
     239        Ubuntu Linux guest OS and the GNOME Desktop Manager (GDM) to log
     240        in users automatically with the credentials passed by the host,
     241        configure the guest OS as follows:
    247242      </para>
    248243
     
    251246        <listitem>
    252247          <para>
    253             Copy the <computeroutput>pam_vbox.so</computeroutput> module
    254             to the security modules directory. In this case,
    255             <computeroutput>/lib/security</computeroutput>.
     248            Copy the <filename>pam_vbox.so</filename> module to the
     249            security modules directory. In this case,
     250            <filename>/lib/security</filename>.
    256251          </para>
    257252        </listitem>
     
    260255          <para>
    261256            Edit the PAM configuration file for GDM, found at
    262             <computeroutput>/etc/pam.d/gdm</computeroutput>. Add the
    263             line <computeroutput>auth requisite
    264             pam_vbox.so</computeroutput> at the top. Additionally, in
    265             most Linux distributions there is a file called
    266             <computeroutput>/etc/pam.d/common-auth</computeroutput>.
    267             This file is included in many other services, like the GDM
    268             file mentioned above. There you also have to add the line
    269             <computeroutput>auth requisite pam_vbox.so</computeroutput>.
     257            <filename>/etc/pam.d/gdm</filename>. Add the line
     258            <literal>auth requisite pam_vbox.so</literal> at the top.
     259            Additionally, in most Linux distributions there is a file
     260            called <filename>/etc/pam.d/common-auth</filename>. This
     261            file is included in many other services, like the GDM file
     262            mentioned above. There you also have to add the line
     263            <literal>auth requisite pam_vbox.so</literal>.
    270264          </para>
    271265        </listitem>
     
    274268          <para>
    275269            If authentication against the shadow database using
    276             <computeroutput>pam_unix.so</computeroutput> or
    277             <computeroutput>pam_unix2.so</computeroutput> is desired,
    278             the argument <computeroutput>try_first_pass</computeroutput>
    279             for <computeroutput>pam_unix.so</computeroutput> or
    280             <computeroutput>use_first_pass</computeroutput> for
    281             <computeroutput>pam_unix2.so</computeroutput> is needed in
    282             order to pass the credentials from the &product-name; module
    283             to the shadow database authentication module. For Ubuntu,
    284             this needs to be added to
    285             <computeroutput>/etc/pam.d/common-auth</computeroutput>, to
    286             the end of the line referencing
    287             <computeroutput>pam_unix.so</computeroutput>. This argument
    288             tells the PAM module to use credentials already present in
    289             the stack, such as the ones provided by the &product-name;
    290             PAM module.
     270            <filename>pam_unix.so</filename> or
     271            <filename>pam_unix2.so</filename> is desired, the argument
     272            <literal>try_first_pass</literal> for
     273            <filename>pam_unix.so</filename> or
     274            <literal>use_first_pass</literal> for
     275            <filename>pam_unix2.so</filename> is needed in order to pass
     276            the credentials from the &product-name; module to the shadow
     277            database authentication module. For Ubuntu, this needs to be
     278            added to <filename>/etc/pam.d/common-auth</filename>, to the
     279            end of the line referencing
     280            <filename>pam_unix.so</filename>. This argument tells the
     281            PAM module to use credentials already present in the stack,
     282            such as the ones provided by the &product-name; PAM module.
    291283          </para>
    292284        </listitem>
     
    303295      <para>
    304296        To make deployment easier, you can pass the argument
    305         <computeroutput>debug</computeroutput> right after the
    306         <computeroutput>pam_vbox.so</computeroutput> statement. Debug
    307         log output will then be recorded using syslog.
     297        <literal>debug</literal> right after the
     298        <filename>pam_vbox.so</filename> statement. Debug log output
     299        will then be recorded using syslog.
    308300      </para>
    309301
    310302      <note>
    311303        <para>
    312           By default, <computeroutput>pam_vbox</computeroutput> will not
    313           wait for credentials to arrive from the host. When a login
    314           prompt is shown, for example by GDM/KDM or the text console,
    315           and pam_vbox does not yet have credentials it does not wait
    316           until they arrive. Instead the next module in the PAM stack,
    317           depending on the PAM configuration, will have the chance for
    318           authentication.
     304          By default, <command>pam_vbox</command> does not wait for
     305          credentials to arrive from the host. When a login prompt is
     306          shown, for example by GDM/KDM or the text console, and
     307          <command>pam_vbox</command> does not yet have credentials it
     308          does not wait until they arrive. Instead the next module in
     309          the PAM stack, depending on the PAM configuration, will have
     310          the chance for authentication.
    319311        </para>
    320312      </note>
    321313
    322314      <para>
    323         <computeroutput>pam_vbox</computeroutput> supports various guest
    324         property parameters that are located in
    325         <computeroutput>/VirtualBox/GuestAdd/PAM/</computeroutput>.
    326         These parameters allow pam_vbox to wait for credentials to be
     315        <command>pam_vbox</command> supports various guest property
     316        parameters that are located in
     317        <filename>/VirtualBox/GuestAdd/PAM/</filename>. These parameters
     318        allow <command>pam_vbox</command> to wait for credentials to be
    327319        provided by the host and optionally can show a message while
    328320        waiting for those. The following guest properties can be set:
     
    333325        <listitem>
    334326          <para>
    335             <computeroutput>CredsWait</computeroutput>: Set to 1 if
    336             pam_vbox should start waiting until credentials arrive from
    337             the host. Until then no other authentication methods such as
    338             manually logging in will be available. If this property is
    339             empty or gets deleted no waiting for credentials will be
    340             performed and pam_vbox will act like before. This property
    341             must be set read-only for the guest
    342             (<computeroutput>RDONLYGUEST</computeroutput>).
     327            <literal>CredsWait</literal>: Set to 1 if
     328            <command>pam_vbox</command> should start waiting until
     329            credentials arrive from the host. Until then no other
     330            authentication methods such as manually logging in will be
     331            available. If this property is empty or gets deleted no
     332            waiting for credentials will be performed and
     333            <command>pam_vbox</command> will act like before. This
     334            property must be set read-only for the guest
     335            (<literal>RDONLYGUEST</literal>).
    343336          </para>
    344337        </listitem>
     
    346339        <listitem>
    347340          <para>
    348             <computeroutput>CredsWaitAbort</computeroutput>: Aborts
    349             waiting for credentials when set to any value. Can be set
    350             from host and the guest.
     341            <literal>CredsWaitAbort</literal>: Aborts waiting for
     342            credentials when set to any value. Can be set from host and
     343            the guest.
    351344          </para>
    352345        </listitem>
     
    354347        <listitem>
    355348          <para>
    356             <computeroutput>CredsWaitTimeout</computeroutput>: Timeout,
    357             in seconds, to let pam_vbox wait for credentials to arrive.
    358             When no credentials arrive within this timeout,
    359             authentication of pam_vbox will be set to failed and the
    360             next PAM module in chain will be asked. If this property is
    361             not specified, set to 0 or an invalid value, an infinite
    362             timeout will be used. This property must be set read-only
    363             for the guest
    364             (<computeroutput>RDONLYGUEST</computeroutput>).
     349            <literal>CredsWaitTimeout</literal>: Timeout, in seconds, to
     350            let <command>pam_vbox</command> wait for credentials to
     351            arrive. When no credentials arrive within this timeout,
     352            authentication of <command>pam_vbox</command> will be set to
     353            failed and the next PAM module in chain will be asked. If
     354            this property is not specified, set to 0 or an invalid
     355            value, an infinite timeout will be used. This property must
     356            be set read-only for the guest
     357            (<literal>RDONLYGUEST</literal>).
    365358          </para>
    366359        </listitem>
     
    369362
    370363      <para>
    371         To customize pam_vbox further there are the following guest
    372         properties:
     364        To customize <command>pam_vbox</command> further there are the
     365        following guest properties:
    373366      </para>
    374367
     
    377370        <listitem>
    378371          <para>
    379             <computeroutput>CredsMsgWaiting</computeroutput>: Custom
    380             message showed while pam_vbox is waiting for credentials
    381             from the host. This property must be set read-only for the
    382             guest (<computeroutput>RDONLYGUEST</computeroutput>).
     372            <literal>CredsMsgWaiting</literal>: Custom message showed
     373            while pam_vbox is waiting for credentials from the host.
     374            This property must be set read-only for the guest
     375            (<literal>RDONLYGUEST</literal>).
    383376          </para>
    384377        </listitem>
     
    386379        <listitem>
    387380          <para>
    388             <computeroutput>CredsMsgWaitTimeout</computeroutput>: Custom
    389             message showed when waiting for credentials by pam_vbox has
    390             timed out. For example, they did not arrive within time.
    391             This property must be set read-only for the guest
    392             (<computeroutput>RDONLYGUEST</computeroutput>).
     381            <literal>CredsMsgWaitTimeout</literal>: Custom message
     382            showed when waiting for credentials by
     383            <command>pam_vbox</command> has timed out. For example, they
     384            did not arrive within time. This property must be set
     385            read-only for the guest (<literal>RDONLYGUEST</literal>).
    393386          </para>
    394387        </listitem>
     
    398391      <note>
    399392        <para>
    400           If a pam_vbox guest property does not have the correct flag
    401           set (<computeroutput>RDONLYGUEST</computeroutput>) the
     393          If a <command>pam_vbox</command> guest property does not have
     394          the correct flag set (<literal>RDONLYGUEST</literal>) the
    402395          property is ignored and, depending on the property, a default
    403396          value will be used. This can result in pam_vbox not waiting
    404397          for credentials. Consult the appropriate syslog file for more
    405           information and use the <computeroutput>debug</computeroutput>
    406           option.
     398          information and use the <literal>debug</literal> option.
    407399        </para>
    408400      </note>
     
    413405
    414406        <para>
    415           &product-name; comes with an own greeter module, named
    416           vbox-greeter. The module can be used with LightDM 1.0.1 or
    417           later. LightDM is the default display manager since Ubuntu
    418           10.11 and therefore also can be used for automated guest
     407          &product-name; comes with a greeter module, named
     408          <command>vbox-greeter</command>, that can be used with
     409          LightDM. LightDM is the default display manager for Ubuntu
     410          Linux and therefore can also be used for automated guest
    419411          logins.
    420412        </para>
    421413
    422414        <para>
    423           vbox-greeter does not need the
    424           <computeroutput>pam_vbox</computeroutput> module described
    425           above in order to function. It comes with its own
    426           authentication mechanism provided by LightDM. However, to
    427           provide maximum of flexibility both modules can be used
    428           together on the same guest.
    429         </para>
    430 
    431         <para>
    432           As with the <computeroutput>pam_vbox</computeroutput> module,
    433           vbox-greeter is shipped as part of the Guest Additions but it
    434           is not installed or activated on the guest OS by default. To
    435           install vbox-greeter automatically upon Guest Additions
    436           installation, use the
    437           <computeroutput>--with-autologon</computeroutput> switch when
    438           starting the VBoxLinuxAdditions.run file:
     415          <command>vbox-greeter</command> does not need the
     416          <command>pam_vbox</command> module described in
     417          <xref linkend="autologon_unix"/>in order to function. It comes
     418          with its own authentication mechanism provided by LightDM.
     419          However, to provide maximum flexibility both modules can be
     420          used together on the same guest.
     421        </para>
     422
     423        <para>
     424          As with the <command>pam_vbox</command> module,
     425          <command>vbox-greeter</command> is shipped as part of the
     426          Guest Additions but it is not installed or activated on the
     427          guest OS by default. To install
     428          <command>vbox-greeter</command> automatically upon Guest
     429          Additions installation, use the
     430          <option>--with-autologon</option> option when starting the
     431          <command>VBoxLinuxAdditions.run</command> file:
    439432        </para>
    440433
     
    442435
    443436        <para>
    444           For manual or postponed installation, the
    445           <computeroutput>vbox-greeter.desktop</computeroutput> file has
    446           to be copied from
    447           <computeroutput>/opt/VBoxGuestAdditions-&lt;version&gt;/other/</computeroutput>
    448           to the <computeroutput>xgreeters</computeroutput> directory
    449           This is usually
    450           <computeroutput>/usr/share/xgreeters/</computeroutput>. Please
    451           refer to your guest OS documentation for the correct LightDM
     437          For manual or postponed installation, copy the
     438          <filename>vbox-greeter.desktop</filename> file from
     439          <filename>/opt/VBoxGuestAdditions-&lt;version&gt;/other/</filename>
     440          to the <filename>xgreeters</filename> directory, which is
     441          usually <filename>/usr/share/xgreeters/</filename>. See your
     442          guest OS documentation for the name of the correct LightDM
    452443          greeter directory.
    453444        </para>
    454445
    455446        <para>
    456           The vbox-greeter module itself already was installed by the
    457           &product-name; Guest Additions installer and resides in
    458           <computeroutput>/usr/sbin/</computeroutput>. To enable
    459           vbox-greeter as the standard greeter module, the file
    460           <computeroutput>/etc/lightdm/lightdm.conf</computeroutput>
    461           needs to be edited:
     447          The <command>vbox-greeter</command> module is installed by the
     448          &product-name; Guest Additions installer and is located in
     449          <filename>/usr/sbin/</filename>. To enable
     450          <command>vbox-greeter</command> as the standard greeter
     451          module, edit the file
     452          <filename>/etc/lightdm/lightdm.conf</filename> as follows:
    462453        </para>
    463454
     
    470461            <listitem>
    471462              <para>
    472                 The LightDM server needs to be fully restarted in order
    473                 for vbox-greeter to be used as the default greeter. As
    474                 root, run <computeroutput>service lightdm
    475                 --full-restart</computeroutput> on Ubuntu, or simply
     463                The LightDM server must be fully restarted in order for
     464                <command>vbox-greeter</command> to be used as the
     465                default greeter. As <literal>root</literal> on Ubuntu,
     466                run <command>service lightdm --full-restart</command> or
    476467                restart the guest.
    477468              </para>
     
    480471            <listitem>
    481472              <para>
    482                 vbox-greeter is independent of the graphical session
    483                 chosen by the user, such as Gnome, KDE, or Unity.
    484                 However, it requires FLTK 1.3 for representing its own
    485                 user interface.
     473                <command>vbox-greeter</command> is independent of the
     474                graphical session you choose, such as Gnome, KDE, or
     475                Unity. However, <command>vbox-greeter</command> does
     476                require FLTK 1.3 or later to implement its own user
     477                interface.
    486478              </para>
    487479            </listitem>
     
    494486          further customize the login experience. For automatically
    495487          logging in users, the same guest properties apply as for
    496           pam_vbox. See <xref linkend="autologon_unix" />.
    497         </para>
    498 
    499         <para>
    500           In addition to the above mentioned guest properties,
    501           vbox-greeter allows further customization of its user
    502           interface. These special guest properties all reside in
    503           <computeroutput>/VirtualBox/GuestAdd/Greeter/</computeroutput>:
     488          <command>pam_vbox</command>. See
     489          <xref linkend="autologon_unix" />.
     490        </para>
     491
     492        <para>
     493          In addition to the previously mentioned guest properties,
     494          <command>vbox-greeter</command> enables you to further
     495          customize its user interface. The following guest properties
     496          are located in the
     497          <filename>/VirtualBox/GuestAdd/Greeter/</filename> directory:
    504498        </para>
    505499
     
    508502          <listitem>
    509503            <para>
    510               <computeroutput>HideRestart</computeroutput>: Set to 1 if
    511               vbox-greeter should hide the button to restart the guest.
    512               This property must be set read-only for the guest
    513               (<computeroutput>RDONLYGUEST</computeroutput>).
    514             </para>
    515           </listitem>
    516 
    517           <listitem>
    518             <para>
    519               <computeroutput>HideShutdown</computeroutput>: Set to 1 if
    520               vbox-greeter should hide the button to shutdown the guest.
    521               This property must be set read-only for the guest
    522               (<computeroutput>RDONLYGUEST</computeroutput>).
    523             </para>
    524           </listitem>
    525 
    526           <listitem>
    527             <para>
    528               <computeroutput>BannerPath</computeroutput>: Path to a
    529               .PNG file for using it as a banner on the top. The image
    530               size must be 460 x 90 pixels, any bit depth. This property
    531               must be set read-only for the guest
    532               (<computeroutput>RDONLYGUEST</computeroutput>).
    533             </para>
    534           </listitem>
    535 
    536           <listitem>
    537             <para>
    538               <computeroutput>UseTheming</computeroutput>: Set to 1 for
    539               turning on the following theming options. This property
    540               must be set read-only for the guest
    541               (<computeroutput>RDONLYGUEST</computeroutput>).
    542             </para>
    543           </listitem>
    544 
    545           <listitem>
    546             <para>
    547               <computeroutput>Theme/BackgroundColor</computeroutput>:
    548               Hexadecimal RRGGBB color for the background. This property
    549               must be set read-only for the guest
    550               (<computeroutput>RDONLYGUEST</computeroutput>).
    551             </para>
    552           </listitem>
    553 
    554           <listitem>
    555             <para>
    556               <computeroutput>Theme/LogonDialog/HeaderColor</computeroutput>:
     504              <literal>HideRestart</literal>: Set to 1 if
     505              <command>vbox-greeter</command> should hide the button to
     506              restart the guest. This property must be set read-only for
     507              the guest (<literal>RDONLYGUEST</literal>).
     508            </para>
     509          </listitem>
     510
     511          <listitem>
     512            <para>
     513              <literal>HideShutdown</literal>: Set to 1 if
     514              <command>vbox-greeter</command> should hide the button to
     515              shutdown the guest. This property must be set read-only
     516              for the guest (<literal>RDONLYGUEST</literal>).
     517            </para>
     518          </listitem>
     519
     520          <listitem>
     521            <para>
     522              <literal>BannerPath</literal>: Path to a
     523              <filename>.PNG</filename> file to use as a banner image on
     524              the top of the greeter. The image size must be 460 x 90
     525              pixels, any bit depth. This property must be set read-only
     526              for the guest (<literal>RDONLYGUEST</literal>).
     527            </para>
     528          </listitem>
     529
     530          <listitem>
     531            <para>
     532              <literal>UseTheming</literal>: Set to 1 for turning on the
     533              following theming options. This property must be set
     534              read-only for the guest (<literal>RDONLYGUEST</literal>).
     535            </para>
     536          </listitem>
     537
     538          <listitem>
     539            <para>
     540              <literal>Theme/BackgroundColor</literal>: Hexadecimal
     541              RRGGBB color for the background. This property must be set
     542              read-only for the guest (<literal>RDONLYGUEST</literal>).
     543            </para>
     544          </listitem>
     545
     546          <listitem>
     547            <para>
     548              <literal>Theme/LogonDialog/HeaderColor</literal>:
    557549              Hexadecimal RRGGBB foreground color for the header text.
    558550              This property must be set read-only for the guest
    559               (<computeroutput>RDONLYGUEST</computeroutput>).
    560             </para>
    561           </listitem>
    562 
    563           <listitem>
    564             <para>
    565               <computeroutput>Theme/LogonDialog/BackgroundColor</computeroutput>:
     551              (<literal>RDONLYGUEST</literal>).
     552            </para>
     553          </listitem>
     554
     555          <listitem>
     556            <para>
     557              <literal>Theme/LogonDialog/BackgroundColor</literal>:
    566558              Hexadecimal RRGGBB color for the login dialog background.
    567559              This property must be set read-only for the guest
    568               (<computeroutput>RDONLYGUEST</computeroutput>).
    569             </para>
    570           </listitem>
    571 
    572           <listitem>
    573             <para>
    574               <computeroutput>Theme/LogonDialog/ButtonColor</computeroutput>:
     560              (<literal>RDONLYGUEST</literal>).
     561            </para>
     562          </listitem>
     563
     564          <listitem>
     565            <para>
     566              <literal>Theme/LogonDialog/ButtonColor</literal>:
    575567              Hexadecimal RRGGBB background color for the login dialog
    576568              button. This property must be set read-only for the guest
    577               (<computeroutput>RDONLYGUEST</computeroutput>).
     569              (<literal>RDONLYGUEST</literal>).
    578570            </para>
    579571          </listitem>
     
    584576          <para>
    585577            The same restrictions for the guest properties above apply
    586             as for the ones specified in the pam_vbox section.
     578            as for the ones specified in the <literal>pam_vbox</literal>
     579            section.
    587580          </para>
    588581        </note>
     
    603596
    604597      <para>
    605         Beginning with Windows NT 4.0, Microsoft offers a system
    606         preparation tool called Sysprep, to prepare a Windows system for
    607         deployment or redistribution. Whereas Windows 2000 and XP ship
    608         with Sysprep on the installation medium, the tool also is
    609         available for download on the Microsoft web site. In a standard
    610         installation of Windows Vista and 7, Sysprep is already
    611         included. Sysprep mainly consists of an executable called
    612         <computeroutput>sysprep.exe</computeroutput> which is invoked by
    613         the user to put the Windows installation into preparation mode.
     598        Microsoft offers a system preparation tool called Sysprep, to
     599        prepare a Windows system for deployment or redistribution. Some
     600        Windows releases include Sysprep on the installation medium, but
     601        the tool is also available for download from the Microsoft web
     602        site. In a standard For most Windows versions, Sysprep is
     603        included in a default installation. Sysprep mainly consists of
     604        an executable called <command>sysprep.exe</command> which is
     605        invoked by the user to put the Windows installation into
     606        preparation mode.
    614607      </para>
    615608
     
    620613        <xref linkend="guestadd-guestcontrol" /> for details of how to
    621614        use this feature with the special identifier
    622         <computeroutput>sysprep</computeroutput> as the program to
    623         execute, along with the user name
    624         <computeroutput>sysprep</computeroutput> and password
    625         <computeroutput>sysprep</computeroutput> for the credentials.
    626         Sysprep then gets launched with the required system rights.
     615        <literal>sysprep</literal> as the program to execute, along with
     616        the user name <literal>sysprep</literal> and password
     617        <literal>sysprep</literal> for the credentials. Sysprep is then
     618        started with the required system rights.
    627619      </para>
    628620
    629621      <note>
    630622        <para>
    631           Specifying the location of "sysprep.exe" is
    632           <emphasis
    633         role="bold">not possible</emphasis>. Instead
    634           the following paths are used, based on the operating system:
     623          Specifying the location of <command>sysprep.exe</command> is
     624          <emphasis role="bold">not possible</emphasis>. Instead the
     625          following paths are used, based on the Windows release:
    635626        </para>
    636627
     
    639630          <listitem>
    640631            <para>
    641               <computeroutput>C:\sysprep\sysprep.exe</computeroutput>
    642               for Windows NT 4.0, 2000 and XP
    643             </para>
    644           </listitem>
    645 
    646           <listitem>
    647             <para>
    648               <computeroutput>%WINDIR%\System32\Sysprep\sysprep.exe</computeroutput>
    649               for Windows Vista, 2008 Server and 7
     632              <filename>C:\sysprep\sysprep.exe</filename> for Windows XP
     633              and earlier
     634            </para>
     635          </listitem>
     636
     637          <listitem>
     638            <para>
     639              <filename>%WINDIR%\System32\sysprep\sysprep.exe</filename>
     640              for Windows Vista and later
    650641            </para>
    651642          </listitem>
     
    673664      <para>
    674665        The &product-name; Guest Additions contain several different
    675         drivers. If for any reason you do not wish to set them all up,
    676         you can install the Guest Additions using the following command:
    677       </para>
    678 
    679 <screen>  sh ./VBoxLinuxAdditions.run no_setup</screen>
    680 
    681       <para>
    682         After this, you will need to at least compile the kernel modules
    683         by running the command as root:
    684       </para>
    685 
    686 <screen>  rcvboxadd setup</screen>
    687 
    688       <para>
    689         You will need to replace <emphasis>lib</emphasis> by
    690         <emphasis>lib64</emphasis> on some 64bit guests, and on older
    691         guests without the udev service you will need to add the
    692         <emphasis>vboxadd</emphasis> service to the default runlevel to
    693         ensure that the modules get loaded.
    694       </para>
    695 
    696       <para>
    697         To setup the time synchronization service, add the service
    698         vboxadd-service to the default runlevel. To set up the X11 and
    699         OpenGL part of the Guest Additions, run the following command:
    700       </para>
    701 
    702 <screen>  rcvboxadd-x11 setup</screen>
    703 
    704       <para>
    705         You do not need to enable any services for this.
    706       </para>
    707 
    708       <para>
    709         To recompile the guest kernel modules, use this command:
    710       </para>
    711 
    712 <screen>  rcvboxadd setup</screen>
    713 
    714       <para>
    715         After compilation you should reboot your guest to ensure that
    716         the new modules are actually used.
     666        drivers. If you do not want to configure them all, use the
     667        following command to install the Guest Additions:
     668      </para>
     669
     670<screen>$ sh ./VBoxLinuxAdditions.run no_setup</screen>
     671
     672      <para>
     673        After running this script, run the <command>rcvboxadd
     674        setup</command> command as <literal>root</literal> to compile
     675        the kernel modules.
     676      </para>
     677
     678      <para>
     679        On some 64-bit guests, you must replace <filename>lib</filename>
     680        with <filename>lib64</filename>. On older guests that do not run
     681        the <command>udev</command> service, you must add the
     682        <command>vboxadd</command> service to the default runlevel to
     683        ensure that the modules are loaded.
     684      </para>
     685
     686      <para>
     687        To set up the time synchronization service, add the
     688        <command>vboxadd-service</command> service to the default
     689        runlevel. To set up the X11 and OpenGL part of the Guest
     690        Additions, run the <command>rcvboxadd-x11 setup</command>
     691        command. Note that you do not need to enable additional
     692        services.
     693      </para>
     694
     695      <para>
     696        Use the <command>rcvboxadd setup</command> to recompile the
     697        guest kernel modules.
     698      </para>
     699
     700      <para>
     701        After compilation, reboot your guest to ensure that the new
     702        modules are loaded.
    717703      </para>
    718704
     
    731717
    732718      <para>
    733         The &product-name; Guest Additions include the following drivers
    734         for X.Org versions:
    735       </para>
    736 
    737       <itemizedlist>
    738 
    739         <listitem>
    740           <para>
    741             X11R6.8/X11R6.9 and XFree86 version 4.3 (vboxvideo_drv_68.o
    742             and vboxmouse_drv_68.o)
    743           </para>
    744         </listitem>
    745 
    746         <listitem>
    747           <para>
    748             X11R7.0 (vboxvideo_drv_70.so and vboxmouse_drv_70.so)
    749           </para>
    750         </listitem>
    751 
    752         <listitem>
    753           <para>
    754             X11R7.1 (vboxvideo_drv_71.so and vboxmouse_drv_71.so)
    755           </para>
    756         </listitem>
    757 
    758         <listitem>
    759           <para>
    760             X.Org Server versions 1.3 and later (vboxvideo_drv_13.so
    761             vboxmouse_drv_13.so, and later versions).
    762           </para>
    763         </listitem>
    764 
    765       </itemizedlist>
    766 
    767       <para>
    768         By default these drivers can be found in the folowing directory:
    769       </para>
    770 
    771       <para>
    772         <computeroutput>/opt/VBoxGuestAdditions-&lt;version&gt;/other/</computeroutput>
     719        The &product-name; Guest Additions includes drivers for X.Org.
     720        By default these drivers are in the following directory:
     721      </para>
     722
     723      <para>
     724        <filename>/opt/VBoxGuestAdditions-<replaceable>version</replaceable>/other/</filename>
    773725      </para>
    774726
     
    780732      <para>
    781733        For graphics integration to work correctly, the X server must
    782         load the vboxvideo driver. Many recent X server versions look
    783         for it automatically if they see that they are running in
    784         &product-name;. For an optimal user experience the guest kernel
    785         drivers must be loaded and the Guest Additions tool VBoxClient
    786         must be running as a client in the X session. For mouse
    787         integration to work correctly, the guest kernel drivers must be
    788         loaded and in addition, in X servers from X.Org X11R6.8 to
    789         X11R7.1 and in XFree86 version 4.3 the right vboxmouse driver
    790         must be loaded and associated with /dev/mouse or /dev/psaux. In
    791         X.Org server 1.3 or later a driver for a PS/2 mouse must be
    792         loaded and the right vboxmouse driver must be associated with
    793         /dev/vboxguest.
     734        load the <literal>vboxvideo</literal> driver. Many recent X
     735        server versions look for it automatically if they see that they
     736        are running in &product-name;. For an optimal user experience,
     737        the guest kernel drivers must be loaded and the Guest Additions
     738        tool <command>VBoxClient</command> must be running as a client
     739        in the X session.
     740      </para>
     741
     742      <para>
     743        For mouse integration to work correctly, the guest kernel
     744        drivers must be loaded. In addition, for legacy X servers the
     745        correct <literal>vboxmouse</literal> driver must be loaded and
     746        associated with <filename>/dev/mouse</filename> or
     747        <filename>/dev/psaux</filename>. For most guests, a driver for a
     748        PS/2 mouse must be loaded and the correct vboxmouse driver must
     749        be associated with <filename>/dev/vboxguest</filename>.
    794750      </para>
    795751
     
    799755        virtual video memory allocated to the virtual machine, minus a
    800756        small amount used by the guest driver, as described in
    801         <xref
    802       linkend="settings-display" />. The driver will offer
    803         a range of standard modes at least up to the default guest
    804         resolution for all active guest monitors. In X.Org Server 1.3
    805         and later the default mode can be changed by setting the output
    806         property VBOX_MODE to "&lt;width&gt;x&lt;height&gt;" for any
    807         guest monitor. When VBoxClient and the kernel drivers are active
    808         this is done automatically when the host requests a mode change.
    809         The driver for older versions can only receive new modes by
    810         querying the host for requests at regular intervals.
    811       </para>
    812 
    813       <para>
    814         With X Servers before version 1.3, you can also add your own
    815         modes to the X server configuration file. You simply need to add
    816         them to the "Modes" list in the "Display" subsection of the
    817         "Screen" section. For example, the following section has a
    818         custom 2048x800 resolution mode added:
     757        <xref linkend="settings-display" />. The driver will offer a
     758        range of standard modes at least up to the default guest
     759        resolution for all active guest monitors. The default mode can
     760        be changed by setting the output property VBOX_MODE to
     761        "&lt;width&gt;x&lt;height&gt;" for any guest monitor. When
     762        VBoxClient and the kernel drivers are active this is done
     763        automatically when the host requests a mode change. The driver
     764        for older versions can only receive new modes by querying the
     765        host for requests at regular intervals.
     766      </para>
     767
     768      <para>
     769        With legacy X Servers before version 1.3, you can also add your
     770        own modes to the X server configuration file. Add them to the
     771        "Modes" list in the "Display" subsection of the "Screen"
     772        section. For example, the following section has a custom
     773        2048x800 resolution mode added:
    819774      </para>
    820775
     
    864819    </para>
    865820
    866 <screen>VBoxManage modifyvm "VM name" --cpuhotplug on</screen>
    867 
    868     <para>
    869       The <computeroutput>--cpus</computeroutput> option is used to
    870       specify the maximum number of CPUs that the virtual machine can
    871       have:
    872     </para>
    873 
    874 <screen>VBoxManage modifyvm "VM name" --cpus 8</screen>
     821<screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> --cpuhotplug on</screen>
     822
     823    <para>
     824      The <option>--cpus</option> option is used to specify the maximum
     825      number of CPUs that the virtual machine can have:
     826    </para>
     827
     828<screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> --cpus 8</screen>
    875829
    876830    <para>
    877831      When the VM is off, you can then add and remove virtual CPUs with
    878       the <computeroutput>modifyvm --plugcpu</computeroutput> and
    879       <computeroutput>--unplugcpu</computeroutput> subcommands, which
     832      the <command>VBoxManage modifyvm --plugcpu</command> and
     833      <command>VBoxManage modifyvm --unplugcpu</command> commands, which
    880834      take the number of the virtual CPU as a parameter, as follows:
    881835    </para>
    882836
    883 <screen>VBoxManage modifyvm "VM name" --plugcpu 3
    884 VBoxManage modifyvm "VM name" --unplugcpu 3</screen>
     837<screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> --plugcpu 3
     838$ VBoxManage modifyvm <replaceable>VM-name</replaceable> --unplugcpu 3</screen>
    885839
    886840    <para>
     
    890844    <para>
    891845      While the VM is running, CPUs can be added and removed with the
    892       <computeroutput>controlvm plugcpu</computeroutput> and
    893       <computeroutput>unplugcpu</computeroutput> commands instead, as
    894       follows:
    895     </para>
    896 
    897 <screen>VBoxManage controlvm "VM name" plugcpu 3
    898 VBoxManage controlvm "VM name" unplugcpu 3</screen>
     846      <command>VBoxManage controlvm plugcpu</command> and
     847      <command>VBoxManage controlvm unplugcpu</command> commands
     848      instead, as follows:
     849    </para>
     850
     851<screen>$ VBoxManage controlvm <replaceable>VM-name</replaceable> plugcpu 3
     852$ VBoxManage controlvm <replaceable>VM-name</replaceable> unplugcpu 3</screen>
    899853
    900854    <para>
    901855      See <xref linkend="vboxmanage-modifyvm" /> and
    902       <xref
    903     linkend="vboxmanage-controlvm" /> for details.
     856      <xref linkend="vboxmanage-controlvm" /> for details.
    904857    </para>
    905858
     
    918871    </para>
    919872
    920 <screen>echo 1 &gt; /sys/devices/system/cpu/cpu&lt;id&gt;/online</screen>
     873<screen>$ echo 1 &gt; /sys/devices/system/cpu/cpu&lt;id&gt;/online</screen>
    921874
    922875  </sect1>
    923876
    924   <sect1 id="pcipassthrough">
     877<!--<sect1 id="pcipassthrough">
    925878
    926879    <title>PCI Passthrough</title>
     
    928881    <para>
    929882      When running on Linux hosts with a kernel version later than
    930       <computeroutput>2.6.31</computeroutput>, experimental host PCI
    931       devices passthrough is available.
     883      <literal>2.6.31</literal>, experimental host PCI devices
     884      passthrough is available.
    932885    </para>
    933886
    934887    <note>
    935888      <para>
    936         The PCI passthrough module is shipped as a &product-name;
     889        The PCI passthrough module is shipped as an &product-name;
    937890        extension package, which must be installed separately. See
    938         <xref
    939       linkend="intro-installing" />.
     891        <xref linkend="intro-installing" />.
    940892      </para>
    941893    </note>
     
    954906    <para>
    955907      To be fully functional, PCI passthrough support in &product-name;
    956       depends upon an IOMMU hardware unit which is not yet too widely
    957       available. If the device uses bus mastering, for example it
    958       performs DMA to the OS memory on its own, then an IOMMU is
    959       required. Otherwise such DMA transactions may write to the wrong
    960       physical memory address as the device DMA engine is programmed
    961       using a device-specific protocol to perform memory transactions.
    962       The IOMMU functions as translation unit mapping physical memory
    963       access requests from the device using knowledge of the guest
    964       physical address to host physical addresses translation rules.
     908      depends upon an IOMMU hardware unit. If the device uses bus
     909      mastering, for example it performs DMA to the OS memory on its
     910      own, then an IOMMU is required. Otherwise such DMA transactions
     911      may write to the wrong physical memory address as the device DMA
     912      engine is programmed using a device-specific protocol to perform
     913      memory transactions. The IOMMU functions as translation unit
     914      mapping physical memory access requests from the device using
     915      knowledge of the guest physical address to host physical addresses
     916      translation rules.
    965917    </para>
    966918
     
    1010962        <para>
    1011963          Your Linux kernel was compiled with IOMMU support, including
    1012           DMA remapping. See the
    1013           <computeroutput>CONFIG_DMAR</computeroutput> kernel
     964          DMA remapping. See the <literal>CONFIG_DMAR</literal> kernel
    1014965          compilation option. The PCI stub driver
    1015           (<computeroutput>CONFIG_PCI_STUB</computeroutput>) is required
    1016           as well.
     966          (<literal>CONFIG_PCI_STUB</literal>) is required as well.
    1017967        </para>
    1018968      </listitem>
     
    1021971        <para>
    1022972          Your Linux kernel recognizes and uses the IOMMU unit. The
    1023           <computeroutput>intel_iommu=on</computeroutput> boot option
    1024           could be needed. Search for DMAR and PCI-DMA in kernel boot
    1025           log.
     973          <literal>intel_iommu=on</literal> boot option could be needed.
     974          Search for DMAR and PCI-DMA in kernel boot log.
    1026975        </para>
    1027976      </listitem>
     
    1046995    <para>
    1047996      The first column is a PCI address, in the format
    1048       <computeroutput>bus:device.function</computeroutput>. This address
    1049       could be used to identify the device for further operations. For
    1050       example, to attach a PCI network controller on the system listed
    1051       above to the second PCI bus in the guest, as device 5, function 0,
    1052       use the following command:
    1053     </para>
    1054 
    1055 <screen>VBoxManage modifyvm "VM name" --pciattach 02:00.0@01:05.0</screen>
     997      <literal><replaceable>bus</replaceable>:<replaceable>device</replaceable>.<replaceable>function</replaceable></literal>.
     998      This address could be used to identify the device for further
     999      operations. For example, to attach a PCI network controller on the
     1000      system listed above to the second PCI bus in the guest, as device
     1001      5, function 0, use the following command:
     1002    </para>
     1003
     1004<screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> -\-pciattach 02:00.0@01:05.0</screen>
    10561005
    10571006    <para>
     
    10591008    </para>
    10601009
    1061 <screen>VBoxManage modifyvm "VM name" --pcidetach 02:00.0</screen>
     1010<screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> -\-pcidetach 02:00.0</screen>
    10621011
    10631012    <para>
     
    11071056    </itemizedlist>
    11081057
    1109   </sect1>
     1058  </sect1>-->
    11101059
    11111060  <sect1 id="webcam-passthrough">
     
    11181067
    11191068      <para>
    1120         &product-name; 4.3 includes an experimental feature which
    1121         enables a guest to use a host webcam. This complements the
    1122         general USB passthrough support which was the typical way of
    1123         using host webcams in earlier versions. The webcam passthrough
    1124         support can handle non-USB video sources in theory, but this is
    1125         completely untested.
     1069        &product-name; includes a feature called <emphasis>webcam
     1070        passthrough</emphasis>, which enables a guest to use a host
     1071        webcam. This complements the general USB passthrough support
     1072        which was the typical way of using host webcams in legacy
     1073        releases. The webcam passthrough support can handle non-USB
     1074        video sources in theory, but this is completely untested.
    11261075      </para>
    11271076
     
    11301079          The webcam passthrough module is shipped as part of the
    11311080          &product-name; extension pack, which must be installed
    1132           separately. See <xref
    1133         linkend="intro-installing" />.
     1081          separately. See <xref linkend="intro-installing" />.
    11341082        </para>
    11351083      </note>
     
    11581106          </para>
    11591107
    1160 <screen>VBoxManage list webcams</screen>
     1108<screen>$ VBoxManage list webcams</screen>
    11611109
    11621110          <para>
     
    11801128          </para>
    11811129
    1182 <screen>VBoxManage controlvm "VM name" webcam attach [host_path|alias [settings]]</screen>
     1130<screen>VBoxManage controlvm <replaceable>VM name</replaceable> webcam attach [<replaceable>host_path</replaceable>|<replaceable>alias</replaceable> [<replaceable>settings</replaceable>]]</screen>
    11831131
    11841132          <para>
     
    11871135
    11881136          <para>
    1189             The <computeroutput>settings</computeroutput> parameter is a
    1190             string
    1191             <computeroutput>Setting1=Value1;Setting2=Value2</computeroutput>,
    1192             which enables you to configure the emulated webcam device.
    1193             The following settings are supported:
     1137            The <literal>settings</literal> parameter is a string
     1138            <literal>Setting1=Value1;Setting2=Value2</literal>, which
     1139            enables you to configure the emulated webcam device. The
     1140            following settings are supported:
    11941141          </para>
    11951142
     
    11981145            <listitem>
    11991146              <para>
    1200                 <computeroutput>MaxFramerate</computeroutput>: The
    1201                 highest rate at which video frames are sent to the
    1202                 guest. A higher frame rate requires more CPU power.
    1203                 Therefore sometimes it is useful to set a lower limit.
    1204                 Default is no limit and allow the guest to use all frame
    1205                 rates supported by the host webcam.
     1147                <literal>MaxFramerate</literal>: The highest rate at
     1148                which video frames are sent to the guest. A higher frame
     1149                rate requires more CPU power. Therefore sometimes it is
     1150                useful to set a lower limit. Default is no limit and
     1151                allow the guest to use all frame rates supported by the
     1152                host webcam.
    12061153              </para>
    12071154            </listitem>
     
    12091156            <listitem>
    12101157              <para>
    1211                 <computeroutput>MaxPayloadTransferSize</computeroutput>:
    1212                 How many bytes the emulated webcam can send to the guest
    1213                 at a time. Default value is 3060 bytes, which is used by
    1214                 some webcams. Higher values can slightly reduce CPU
    1215                 load, if the guest is able to use larger buffers.
    1216                 However, a high
    1217                 <computeroutput>MaxPayloadTransferSize</computeroutput>
    1218                 might be not supported by some guests.
     1158                <literal>MaxPayloadTransferSize</literal>: How many
     1159                bytes the emulated webcam can send to the guest at a
     1160                time. Default value is 3060 bytes, which is used by some
     1161                webcams. Higher values can slightly reduce CPU load, if
     1162                the guest is able to use larger buffers. However, a high
     1163                <literal>MaxPayloadTransferSize</literal> might be not
     1164                supported by some guests.
    12191165              </para>
    12201166            </listitem>
     
    12281174          </para>
    12291175
    1230 <screen>VBoxManage controlvm "VM name" webcam detach [host_path|alias]</screen>
     1176<screen>VBoxManage controlvm <replaceable>VM-name</replaceable> webcam detach [<replaceable>host_path</replaceable>|<replaceable>alias</replaceable>]</screen>
    12311177        </listitem>
    12321178
     
    12361182          </para>
    12371183
    1238 <screen>VBoxManage controlvm "VM name" webcam list</screen>
     1184<screen>VBoxManage controlvm <replaceable>VM-name</replaceable> webcam list</screen>
    12391185
    12401186          <para>
     
    12651211
    12661212      <para>
    1267         OS X version 10.9 or later is required.
     1213        Mac OS X version 10.9 or later is required.
    12681214      </para>
    12691215
     
    12711217        When the webcam device is detached from the host, the emulated
    12721218        webcam device remains attached to the guest and must be manually
    1273         detached using the <computeroutput>VBoxManage controlvm "VM
    1274         name" webcam detach</computeroutput> command.
     1219        detached using the <command>VBoxManage controlvm
     1220        <replaceable>VM-name</replaceable> webcam detach</command>
     1221        command.
    12751222      </para>
    12761223
     
    12851232        device is automatically detached from the guest only if the
    12861233        webcam is streaming video. If the emulated webcam is inactive it
    1287         should be manually detached using the <computeroutput>VBoxManage
    1288         controlvm "VM name" webcam detach</computeroutput> command.
    1289       </para>
    1290 
    1291       <para>
    1292         Aliases <computeroutput>.0</computeroutput> and
    1293         <computeroutput>.1</computeroutput> are mapped to
    1294         <computeroutput>/dev/video0</computeroutput>, alias
    1295         <computeroutput>.2</computeroutput> is mapped to
    1296         <computeroutput>/dev/video1</computeroutput> and so forth.
     1234        should be manually detached using the <command>VBoxManage
     1235        controlvm <replaceable>VM-name</replaceable> webcam
     1236        detach</command> command.
     1237      </para>
     1238
     1239      <para>
     1240        Aliases <filename>.0</filename> and <filename>.1</filename> are
     1241        mapped to <filename>/dev/video0</filename>, alias
     1242        <filename>.2</filename> is mapped to
     1243        <filename>/dev/video1</filename> and so forth.
    12971244      </para>
    12981245
     
    13211268        Additional video modes can be configured for each VM using the
    13221269        extra data facility. The extra data key is called
    1323         <computeroutput>CustomVideoMode&lt;x&gt;</computeroutput> with
    1324         <computeroutput>x</computeroutput> being a number from 1 to 16.
     1270        <literal>CustomVideoMode<replaceable>x</replaceable></literal>
     1271        with <replaceable>x</replaceable> being a number from 1 to 16.
    13251272        Please note that modes will be read from 1 until either the
    13261273        following number is not defined or 16 is reached. The following
     
    13291276      </para>
    13301277
    1331 <screen>VBoxManage setextradata "VM name" "CustomVideoMode1" "1400x1050x16"</screen>
     1278<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> "CustomVideoMode1" "1400x1050x16"</screen>
    13321279
    13331280      <para>
    13341281        The VESA mode IDs for custom video modes start at
    1335         <computeroutput>0x160</computeroutput>. In order to use the
    1336         above defined custom video mode, the following command line has
    1337         to be supplied to Linux:
     1282        <literal>0x160</literal>. In order to use the above defined
     1283        custom video mode, the following command line has to be supplied
     1284        to Linux:
    13381285      </para>
    13391286
     
    13621309        seamless mode or sending a video mode hint using
    13631310        <command>VBoxManage</command>. This behavior is what most users
    1364         will want, but if you have different needs, it is possible to
    1365         change it by issuing one of the following commands from the
    1366         command line:
    1367       </para>
     1311        will want, but if you have different needs, you can change it by
     1312        issuing one of the following commands from the command line:
     1313      </para>
     1314
     1315      <itemizedlist>
     1316
     1317        <listitem>
     1318          <para>
     1319            Remove all limits on guest resolutions.
     1320          </para>
    13681321
    13691322<screen>VBoxManage setextradata global GUI/MaxGuestResolution any</screen>
    1370 
    1371       <para>
    1372         will remove all limits on guest resolutions.
    1373       </para>
    1374 
    1375 <screen>VBoxManage setextradata global GUI/MaxGuestResolution &gt;width,height&lt;</screen>
    1376 
    1377       <para>
    1378         manually specifies a maximum resolution.
    1379       </para>
     1323        </listitem>
     1324
     1325        <listitem>
     1326          <para>
     1327            Manually specify a maximum resolution.
     1328          </para>
     1329
     1330<screen>VBoxManage setextradata global GUI/MaxGuestResolution <replaceable>width</replaceable>x<replaceable>height</replaceable></screen>
     1331        </listitem>
     1332
     1333        <listitem>
     1334          <para>
     1335            Restore the default settings to all guest VMs.
     1336          </para>
    13801337
    13811338<screen>VBoxManage setextradata global GUI/MaxGuestResolution auto</screen>
    1382 
    1383       <para>
    1384         restores the default settings. Note that these settings apply
    1385         globally to all guest systems, not just to a single machine.
    1386       </para>
     1339        </listitem>
     1340
     1341      </itemizedlist>
    13871342
    13881343    </sect2>
     
    14101365        to access its virtual hard disk without going through the host
    14111366        OS file system. The actual performance difference for image
    1412         files vs. raw disk varies greatly depending on the overhead of
    1413         the host file system, whether dynamically growing images are
    1414         used, and on host OS caching strategies. The caching indirectly
    1415         also affects other aspects such as failure behavior. For
    1416         example, whether the virtual disk contains all data written
     1367        files compared to raw disk varies greatly depending on the
     1368        overhead of the host file system, whether dynamically growing
     1369        images are used, and on host OS caching strategies. The caching
     1370        indirectly also affects other aspects such as failure behavior.
     1371        For example, whether the virtual disk contains all data written
    14171372        before a host OS crash. Consult your host OS documentation for
    14181373        details on this.
     
    14661421        </para>
    14671422
    1468 <screen>VBoxManage internalcommands createrawvmdk -filename /path/to/file.vmdk
    1469   -rawdisk /dev/sda</screen>
    1470 
    1471         <para>
    1472           This creates the image
    1473           <computeroutput>/path/to/file.vmdk</computeroutput>, which
    1474           must be an absolute path. All data will be read and written
    1475           from <computeroutput>/dev/sda</computeroutput>.
     1423<screen>$ VBoxManage internalcommands createrawvmdk -filename \
     1424/path/to/file.vmdk -rawdisk /dev/sda</screen>
     1425
     1426        <para>
     1427          This creates the
     1428          <filename>/<replaceable>path-to-file</replaceable>.vmdk</filename>
     1429          file image that must be an absolute path. All data is read and
     1430          written from <filename>/dev/sda</filename>.
    14761431        </para>
    14771432
    14781433        <para>
    14791434          On a Windows host, instead of the above device specification,
    1480           for example use
    1481           <computeroutput>\\.\PhysicalDrive0</computeroutput>. On a Mac
    1482           OS X host, instead of the above device specification use for
    1483           example <computeroutput>/dev/disk1</computeroutput>. Note that
    1484           on OS X you can only get access to an entire disk if no volume
    1485           is mounted from it.
     1435          for example use <filename>\\.\PhysicalDrive0</filename>. On a
     1436          Mac OS X host, instead of the above device specification use
     1437          for example <filename>/dev/disk1</filename>. Note that on Mac
     1438          OS X you can only get access to an entire disk if no volume is
     1439          mounted from it.
    14861440        </para>
    14871441
     
    14901444          device. Read/write access is also later needed when using the
    14911445          image from a virtual machine. On some host platforms, such as
    1492           Windows Vista and later, raw disk access may be restricted and
    1493           not permitted by the host OS in some situations.
     1446          Windows, raw disk access may be restricted and not permitted
     1447          by the host OS in some situations.
    14941448        </para>
    14951449
     
    15001454        </para>
    15011455
    1502 <screen>VBoxManage storageattach WindowsXP --storagectl "IDE Controller"
     1456<screen>$ VBoxManage storageattach WindowsXP --storagectl "IDE Controller" \
    15031457 --port 0 --device 0 --type hdd --medium /path/to/file.vmdk</screen>
    15041458
     
    15341488        </para>
    15351489
    1536 <screen>VBoxManage internalcommands createrawvmdk -filename /path/to/file.vmdk
    1537  -rawdisk /dev/sda -partitions 1,5</screen>
     1490<screen>$ VBoxManage internalcommands createrawvmdk -filename \
     1491/path/to/file.vmdk -rawdisk /dev/sda -partitions 1,5</screen>
    15381492
    15391493        <para>
    15401494          The command is identical to the one for full hard disk access,
    1541           except for the additional
    1542           <computeroutput>-partitions</computeroutput> parameter. This
    1543           example would create the image
    1544           <computeroutput>/path/to/file.vmdk</computeroutput>, which
    1545           must be absolute, and partitions 1 and 5 of
    1546           <computeroutput>/dev/sda</computeroutput> would be made
    1547           accessible to the guest.
     1495          except for the additional <option>-partitions</option>
     1496          parameter. This example would create the image
     1497          <filename>/<replaceable>path-to-file</replaceable>.vmdk</filename>,
     1498          which must be absolute, and partitions 1 and 5 of
     1499          <filename>/dev/sda</filename> would be made accessible to the
     1500          guest.
    15481501        </para>
    15491502
     
    15571510        <para>
    15581511          On a Windows host, instead of the above device specification,
    1559           use for example
    1560           <computeroutput>\\.\PhysicalDrive0</computeroutput>. On a Mac
    1561           OS X host, instead of the above device specification use
    1562           <computeroutput>/dev/disk1</computeroutput>, for example. Note
    1563           that on OS X you can only use partitions which are not
    1564           mounted. Eject the respective volume first. Partition numbers
    1565           are the same on Linux, Windows, and Mac OS X hosts.
     1512          use for example <filename>\\.\PhysicalDrive0</filename>. On a
     1513          Mac OS X host, instead of the above device specification use
     1514          <filename>/dev/disk1</filename>, for example. Note that on OS
     1515          X you can only use partitions which are not mounted. Eject the
     1516          respective volume first. Partition numbers are the same on
     1517          Linux, Windows, and Mac OS X hosts.
    15661518        </para>
    15671519
     
    15711523        </para>
    15721524
    1573 <screen>VBoxManage internalcommands listpartitions -rawdisk /dev/sda</screen>
     1525<screen>$ VBoxManage internalcommands listpartitions -rawdisk /dev/sda</screen>
    15741526
    15751527        <para>
     
    15961548        </para>
    15971549
    1598 <screen>VBoxManage internalcommands createrawvmdk -filename /path/to/file.vmdk
    1599  -rawdisk /dev/sda -partitions 1,5 -relative</screen>
     1550<screen>$ VBoxManage internalcommands createrawvmdk -filename \
     1551/path/to/file.vmdk -rawdisk /dev/sda -partitions 1,5 -relative</screen>
    16001552
    16011553        <para>
    16021554          When used from a virtual machine, the image will then refer
    16031555          not to the entire disk, but only to the individual partitions.
    1604           In this example, <computeroutput>/dev/sda1</computeroutput>
    1605           and <computeroutput>/dev/sda5</computeroutput>. As a
    1606           consequence, read/write access is only required for the
    1607           affected partitions, not for the entire disk. During creation
    1608           however, read-only access to the entire disk is required to
    1609           obtain the partitioning information.
     1556          In this example, <filename>/dev/sda1</filename> and
     1557          <filename>/dev/sda5</filename>. As a consequence, read/write
     1558          access is only required for the affected partitions, not for
     1559          the entire disk. During creation however, read-only access to
     1560          the entire disk is required to obtain the partitioning
     1561          information.
    16101562        </para>
    16111563
     
    16161568          This enables for example the guest to boot directly to
    16171569          Windows, while the host boots Linux from the "same" disk. For
    1618           this purpose the <computeroutput>-mbr</computeroutput>
    1619           parameter is provided. It specifies a file name from which to
    1620           take the MBR code. The partition table is not modified at all,
    1621           so a MBR file from a system with totally different
    1622           partitioning can be used. An example of this is:
    1623         </para>
    1624 
    1625 <screen>VBoxManage internalcommands createrawvmdk -filename /path/to/file.vmdk
    1626  -rawdisk /dev/sda -partitions 1,5 -mbr winxp.mbr</screen>
     1570          this purpose the <option>-mbr</option> option is provided. It
     1571          specifies a file name from which to take the MBR code. The
     1572          partition table is not modified at all, so a MBR file from a
     1573          system with totally different partitioning can be used. An
     1574          example of this is:
     1575        </para>
     1576
     1577<screen>$ VBoxManage internalcommands createrawvmdk -filename
     1578/path/to/file.vmdk -rawdisk /dev/sda -partitions 1,5 -mbr winxp.mbr</screen>
    16271579
    16281580        <para>
     
    16511603      </para>
    16521604
    1653 <screen>VBoxManage setextradata "VM name"
    1654       "VBoxInternal/Devices/ahci/0/Config/Port0/SerialNumber" "serial"
    1655 VBoxManage setextradata "VM name"
    1656       "VBoxInternal/Devices/ahci/0/Config/Port0/FirmwareRevision" "firmware"
    1657 VBoxManage setextradata "VM name"
    1658       "VBoxInternal/Devices/ahci/0/Config/Port0/ModelNumber" "model"</screen>
     1605<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     1606"VBoxInternal/Devices/ahci/0/Config/Port0/SerialNumber" "serial"
     1607$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     1608"VBoxInternal/Devices/ahci/0/Config/Port0/FirmwareRevision" "firmware"
     1609$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     1610"VBoxInternal/Devices/ahci/0/Config/Port0/ModelNumber" "model"</screen>
    16591611
    16601612      <para>
     
    16711623      </para>
    16721624
    1673 <screen>VBoxManage setextradata "VM name"
    1674       "VBoxInternal/Devices/piix3ide/0/Config/PrimaryMaster/SerialNumber" "serial"
    1675 VBoxManage setextradata "VM name"
    1676       "VBoxInternal/Devices/piix3ide/0/Config/PrimaryMaster/FirmwareRevision" "firmware"
    1677 VBoxManage setextradata "VM name"
    1678       "VBoxInternal/Devices/piix3ide/0/Config/PrimaryMaster/ModelNumber" "model"</screen>
    1679 
    1680       <para>
    1681         For hard disks it is also possible to mark the drive as having a
    1682         non-rotational medium with:
    1683       </para>
    1684 
    1685 <screen>VBoxManage setextradata "VM name"
    1686       "VBoxInternal/Devices/ahci/0/Config/Port0/NonRotational" "1"</screen>
     1625<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     1626"VBoxInternal/Devices/piix3ide/0/Config/PrimaryMaster/SerialNumber" "serial"
     1627$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     1628"VBoxInternal/Devices/piix3ide/0/Config/PrimaryMaster/FirmwareRevision" "firmware"
     1629$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     1630"VBoxInternal/Devices/piix3ide/0/Config/PrimaryMaster/ModelNumber" "model"</screen>
     1631
     1632      <para>
     1633        For hard disks, you can mark the drive as having a
     1634        non-rotational medium by using the following command:
     1635      </para>
     1636
     1637<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     1638"VBoxInternal/Devices/ahci/0/Config/Port0/NonRotational" "1"</screen>
    16871639
    16881640      <para>
     
    16911643      </para>
    16921644
    1693 <screen>VBoxManage setextradata "VM name"
    1694       "VBoxInternal/Devices/ahci/0/Config/Port0/ATAPIVendorId" "vendor"
    1695 VBoxManage setextradata "VM name"
    1696       "VBoxInternal/Devices/ahci/0/Config/Port0/ATAPIProductId" "product"
    1697 VBoxManage setextradata "VM name"
    1698       "VBoxInternal/Devices/ahci/0/Config/Port0/ATAPIRevision" "revision"</screen>
     1645<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     1646"VBoxInternal/Devices/ahci/0/Config/Port0/ATAPIVendorId" "vendor"
     1647VBoxManage setextradata <replaceable>VM-name</replaceable> \
     1648"VBoxInternal/Devices/ahci/0/Config/Port0/ATAPIProductId" "product"
     1649VBoxManage setextradata <replaceable>VM-name</replaceable> \
     1650"VBoxInternal/Devices/ahci/0/Config/Port0/ATAPIRevision" "revision"</screen>
    16991651
    17001652      <para>
     
    17311683      </para>
    17321684
    1733 <screen>VBoxManage setextradata "VM name" VBoxInternal/Devices/IntNetIP/0/Trusted 1
    1734 VBoxManage setextradata "VM name" VBoxInternal/Devices/IntNetIP/0/Config/MAC 08:00:27:01:02:0f
    1735 VBoxManage setextradata "VM name" VBoxInternal/Devices/IntNetIP/0/Config/IP 10.0.9.1
    1736 VBoxManage setextradata "VM name" VBoxInternal/Devices/IntNetIP/0/Config/Netmask 255.255.255.0
    1737 VBoxManage setextradata "VM name" VBoxInternal/Devices/IntNetIP/0/LUN#0/Driver IntNet
    1738 VBoxManage setextradata "VM name" VBoxInternal/Devices/IntNetIP/0/LUN#0/Config/Network MyIntNet
    1739 VBoxManage setextradata "VM name" VBoxInternal/Devices/IntNetIP/0/LUN#0/Config/TrunkType 2
    1740 VBoxManage setextradata "VM name" VBoxInternal/Devices/IntNetIP/0/LUN#0/Config/IsService 1</screen>
     1685<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     1686VBoxInternal/Devices/IntNetIP/0/Trusted 1
     1687$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     1688VBoxInternal/Devices/IntNetIP/0/Config/MAC 08:00:27:01:02:0f
     1689$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     1690VBoxInternal/Devices/IntNetIP/0/Config/IP 10.0.9.1
     1691$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     1692VBoxInternal/Devices/IntNetIP/0/Config/Netmask 255.255.255.0
     1693$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     1694VBoxInternal/Devices/IntNetIP/0/LUN#0/Driver IntNet
     1695$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     1696VBoxInternal/Devices/IntNetIP/0/LUN#0/Config/Network MyIntNet
     1697$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     1698VBoxInternal/Devices/IntNetIP/0/LUN#0/Config/TrunkType 2
     1699$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     1700VBoxInternal/Devices/IntNetIP/0/LUN#0/Config/IsService 1</screen>
    17411701
    17421702      <para>
    17431703        Finally the iSCSI disk must be attached with the
    1744         <computeroutput>--intnet</computeroutput> option to tell the
    1745         iSCSI initiator to use internal networking, as follows:
    1746       </para>
    1747 
    1748 <screen>VBoxManage storageattach ... --medium iscsi
    1749 --server 10.0.9.30 --target iqn.2008-12.com.sun:sampletarget --intnet</screen>
     1704        <option>--intnet</option> option to tell the iSCSI initiator to
     1705        use internal networking, as follows:
     1706      </para>
     1707
     1708<screen>$ VBoxManage storageattach ... --medium iscsi --server 10.0.9.30 \
     1709--target iqn.2008-12.com.sun:sampletarget --intnet</screen>
    17501710
    17511711      <para>
     
    17671727  </sect1>
    17681728
    1769   <sect1 id="serialports-legacy-cmds">
    1770 
    1771     <title>Legacy Commands for Using Serial Ports</title>
    1772 
    1773     <para>
    1774       In legacy releases, &product-name; provided support for virtual
    1775       serial ports. This was rather complicated to set up, requiring a
    1776       sequence of <command>VBoxManage setextradata</command> statements.
    1777       That method of setting up serial ports is no longer necessary and
    1778       <emphasis>deprecated.</emphasis> To set up virtual serial ports,
    1779       use the methods described in <xref linkend="serialports" />.
    1780     </para>
    1781 
    1782     <note>
    1783       <para>
    1784         For backwards compatibility, the legacy
    1785         <computeroutput>setextradata</computeroutput> statements, whose
    1786         description is retained below from the old version of the
    1787         manual, take <emphasis>precedence</emphasis> over the new way of
    1788         configuring serial ports. As a result, if configuring serial
    1789         ports the new way does not work, make sure the VM in question
    1790         does not have old configuration data such as below still active.
    1791       </para>
    1792     </note>
    1793 
    1794     <para>
    1795       The legacy sequence of configuring a serial port used the
    1796       following commands:
    1797     </para>
    1798 
    1799 <screen>VBoxManage setextradata "VM name"
    1800       "VBoxInternal/Devices/serial/0/Config/IRQ" 4
    1801 VBoxManage setextradata "VM name"
    1802       "VBoxInternal/Devices/serial/0/Config/IOBase" 0x3f8
    1803 VBoxManage setextradata "VM name"
    1804       "VBoxInternal/Devices/serial/0/LUN#0/Driver" Char
    1805 VBoxManage setextradata "VM name"
    1806       "VBoxInternal/Devices/serial/0/LUN#0/AttachedDriver/Driver" NamedPipe
    1807 VBoxManage setextradata "VM name"
    1808       "VBoxInternal/Devices/serial/0/LUN#0/AttachedDriver/Config/Location" "\\.\pipe\vboxCOM1"
    1809 VBoxManage setextradata "VM name"
    1810       "VBoxInternal/Devices/serial/0/LUN#0/AttachedDriver/Config/IsServer" 1</screen>
    1811 
    1812     <para>
    1813       This sets up a serial port in the guest with the default settings
    1814       for COM1 (IRQ 4, I/O address 0x3f8) and the
    1815       <computeroutput>Location</computeroutput> setting assumes that
    1816       this configuration is used on a Windows host, because the Windows
    1817       named pipe syntax is used. Keep in mind that on Windows hosts a
    1818       named pipe must always start with
    1819       <computeroutput>\\.\pipe\</computeroutput>. On Linux the same
    1820       configuration settings apply, except that the path name for the
    1821       <computeroutput>Location</computeroutput> can be chosen more
    1822       freely. Local domain sockets can be placed anywhere, provided the
    1823       user running &product-name; has the permission to create a new
    1824       file in the directory. The final command above defines that
    1825       &product-name; acts as a server. It creates the named pipe itself
    1826       instead of connecting to an already existing one.
    1827     </para>
    1828 
    1829   </sect1>
    1830 
    18311729  <sect1 id="changenat">
    18321730
     
    18391737      <para>
    18401738        In NAT mode, the guest network interface is assigned to the IPv4
    1841         range <computeroutput>10.0.x.0/24</computeroutput> by default
    1842         where <computeroutput>x</computeroutput> corresponds to the
     1739        range <literal>10.0.<replaceable>x</replaceable>.0/24</literal>
     1740        by default where <replaceable>x</replaceable> corresponds to the
    18431741        instance of the NAT interface +2. So
    1844         <computeroutput>x</computeroutput> is 2 when there is only one
    1845         NAT instance active. In that case the guest is assigned to the
    1846         address <computeroutput>10.0.2.15</computeroutput>, the gateway
    1847         is set to <computeroutput>10.0.2.2</computeroutput> and the name
    1848         server can be found at
    1849         <computeroutput>10.0.2.3</computeroutput>.
     1742        <replaceable>x</replaceable> is 2 when there is only one NAT
     1743        instance active. In that case the guest is assigned to the
     1744        address <literal>10.0.2.15</literal>, the gateway is set to
     1745        <literal>10.0.2.2</literal> and the name server can be found at
     1746        <literal>10.0.2.3</literal>.
    18501747      </para>
    18511748
     
    18551752      </para>
    18561753
    1857 <screen>VBoxManage modifyvm "VM name" --natnet1 "192.168/16"</screen>
     1754<screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> \
     1755--natnet1 "192.168/16"</screen>
    18581756
    18591757      <para>
    18601758        This command would reserve the network addresses from
    1861         <computeroutput>192.168.0.0</computeroutput> to
    1862         <computeroutput>192.168.254.254</computeroutput> for the first
    1863         NAT network instance of "VM name". The guest IP would be
    1864         assigned to <computeroutput>192.168.0.15</computeroutput> and
    1865         the default gateway could be found at
    1866         <computeroutput>192.168.0.2</computeroutput>.
     1759        <literal>192.168.0.0</literal> to
     1760        <literal>192.168.254.254</literal> for the first NAT network
     1761        instance of <replaceable>VM-name</replaceable> The guest IP
     1762        would be assigned to <literal>192.168.0.15</literal> and the
     1763        default gateway could be found at
     1764        <literal>192.168.0.2</literal>.
    18671765      </para>
    18681766
     
    18811779      </para>
    18821780
    1883 <screen>VBoxManage modifyvm "VM name" --nattftpserver1 10.0.2.2
    1884 VBoxManage modifyvm "VM name" --nattftpfile1 /srv/tftp/boot/MyPXEBoot.pxe</screen>
     1781<screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> \
     1782--nattftpserver1 10.0.2.2
     1783$ VBoxManage modifyvm <replaceable>VM-name</replaceable> \
     1784--nattftpfile1 /srv/tftp/boot/MyPXEBoot.pxe</screen>
    18851785
    18861786    </sect2>
     
    18931793        The &product-name; NAT stack performance is often determined by
    18941794        its interaction with the host's TCP/IP stack and the size of
    1895         several buffers, <computeroutput>SO_RCVBUF</computeroutput> and
    1896         <computeroutput>SO_SNDBUF</computeroutput>. For certain setups
    1897         users might want to adjust the buffer size for a better
    1898         performance. This can by achieved using the following commands,
    1899         where values are in kilobytes and can range from 8 to 1024:
    1900       </para>
    1901 
    1902 <screen>VBoxManage modifyvm "VM name" --natsettings1 16000,128,128,0,0</screen>
     1795        several buffers, <literal>SO_RCVBUF</literal> and
     1796        <literal>SO_SNDBUF</literal>. For certain setups users might
     1797        want to adjust the buffer size for a better performance. This
     1798        can by achieved using the following commands, where values are
     1799        in kilobytes and can range from 8 to 1024:
     1800      </para>
     1801
     1802<screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> \
     1803--natsettings1 16000,128,128,0,0</screen>
    19031804
    19041805      <para>
     
    19321833      </para>
    19331834
    1934 <screen>VBoxManage modifyvm "VM name" --natbindip1 "10.45.0.2"</screen>
     1835<screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> \
     1836--natbindip1 "10.45.0.2"</screen>
    19351837
    19361838      <para>
     
    19561858      </para>
    19571859
    1958 <screen>VBoxManage modifyvm "VM name" --natdnsproxy1 on</screen>
     1860<screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> --natdnsproxy1 on</screen>
    19591861
    19601862    </sect2>
     
    19731875      </para>
    19741876
    1975 <screen>VBoxManage modifyvm "VM name" --natdnshostresolver1 on</screen>
     1877<screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> --natdnshostresolver1 on</screen>
    19761878
    19771879      <para>
     
    20001902        </para>
    20011903
    2002 <screen>VBoxManage setextradata "VM name" \
    2003       "VBoxInternal/Devices/{pcnet,e1000}/0/LUN#0/AttachedDriver/Config/HostResolverMappings/ \
    2004       &lt;unique rule name of interception rule&gt;/HostIP" &lt;IPv4&gt;
    2005 VBoxManage setextradata "VM name" \
    2006       "VBoxInternal/Devices/{pcnet,e1000}/0/LUN#0/AttachedDriver/Config/HostResolverMappings/ \
    2007       &lt;unique rule name&gt;/HostName" &lt;name of host&gt;</screen>
     1904<screen>VBoxManage setextradata <replaceable>VM-name</replaceable> \
     1905"VBoxInternal/Devices/{pcnet,e1000}/0/LUN#0/AttachedDriver/Config/HostResolverMappings/ \
     1906<replaceable>unique-rule-name-of-interception-rule</replaceable>/HostIP" <replaceable>IPv4</replaceable>
     1907
     1908VBoxManage setextradata <replaceable>VM-name</replaceable> \
     1909"VBoxInternal/Devices/{pcnet,e1000}/0/LUN#0/AttachedDriver/Config/HostResolverMappings/ \
     1910<replaceable>unique-rule-name</replaceable>/HostName" <replaceable>hostname</replaceable></screen>
    20081911
    20091912        <para>
     
    20121915        </para>
    20131916
    2014 <screen>VBoxManage setextradata "VM name" \
    2015       "VBoxInternal/Devices/{pcnet,e1000}/0/LUN#0/AttachedDriver/Config/HostResolverMappings/ \
    2016       &lt;unique rule name&gt;/HostIP" &lt;IPv4&gt;
    2017 VBoxManage setextradata "VM name" \
    2018       "VBoxInternal/Devices/{pcnet,e1000}/0/LUN#0/AttachedDriver/Config/HostResolverMappings/ \
    2019       &lt;unique rule name&gt;/HostNamePattern" &lt;hostpattern&gt;</screen>
    2020 
    2021         <para>
    2022           The host pattern may include <computeroutput>"|", "?" and
    2023           "*"</computeroutput>.
     1917<screen>VBoxManage setextradata <replaceable>VM-name</replaceable> \
     1918"VBoxInternal/Devices/{pcnet,e1000}/0/LUN#0/AttachedDriver/Config/HostResolverMappings/ \
     1919<replaceable>unique-rule-name</replaceable>/HostIP" <replaceable>IPv4</replaceable>
     1920
     1921VBoxManage setextradata <replaceable>VM-name</replaceable> \
     1922"VBoxInternal/Devices/{pcnet,e1000}/0/LUN#0/AttachedDriver/Config/HostResolverMappings/ \
     1923<replaceable>unique-rule-name</replaceable>/HostNamePattern" <replaceable>hostpattern</replaceable></screen>
     1924
     1925        <para>
     1926          The host name pattern can include the following wildcard
     1927          characters: pipe (<literal>|</literal>), question mark
     1928          (<literal>?</literal>), and asterisk (<literal>*</literal>).
    20241929        </para>
    20251930
     
    20301935        </para>
    20311936
    2032 <screen>VBoxManage setextradata "VM name" \
    2033       "VBoxInternal/Devices/e1000/0/LUN#0/AttachedDriver/Config/HostResolverMappings/ \
    2034       all_blocked_site/HostIP" 127.0.0.1
    2035 VBoxManage setextradata "VM name" \
    2036       "VBoxInternal/Devices/e1000/0/LUN#0/AttachedDriver/Config/HostResolverMappings/ \
    2037       all_blocked_site/HostNamePattern" "*.blocked-site.*|*.fb.org"</screen>
     1937<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     1938"VBoxInternal/Devices/e1000/0/LUN#0/AttachedDriver/Config/HostResolverMappings/all_blocked_site/HostIP" 127.0.0.1
     1939$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     1940"VBoxInternal/Devices/e1000/0/LUN#0/AttachedDriver/Config/HostResolverMappings/all_blocked_site/HostNamePattern" "*.blocked-site.*|*.fb.org"</screen>
    20381941
    20391942        <para>
     
    20561959        the most protocols like SSH, FTP and so on. Though some
    20571960        protocols might need a more transparent behavior or may depend
    2058         on the real port number the packet was sent from. It is possible
    2059         to change the NAT mode using the <command>VBoxManage</command>
    2060         frontend with the following commands:
    2061       </para>
    2062 
    2063 <screen>VBoxManage modifyvm "VM name" --nataliasmode1 proxyonly</screen>
    2064 
    2065 <screen>VBoxManage modifyvm "Linux Guest" --nataliasmode1 sameports</screen>
     1961        on the real port number the packet was sent from. You can change
     1962        the NAT mode by using the following commands:
     1963      </para>
     1964
     1965<screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> \
     1966--nataliasmode1 proxyonly</screen>
     1967
     1968<screen>$ VBoxManage modifyvm "Linux Guest" --nataliasmode1 sameports</screen>
    20661969
    20671970      <para>
     
    20831986      for a specific VM. Use the following commands to configure the DMI
    20841987      BIOS information. In case your VM is configured to use EFI
    2085       firmware you need to replace
    2086       <computeroutput>pcbios</computeroutput> by
    2087       <computeroutput>efi</computeroutput> in the keys.
     1988      firmware you need to replace <literal>pcbios</literal> by
     1989      <literal>efi</literal> in the keys.
    20881990    </para>
    20891991
     
    20951997        </para>
    20961998
    2097 <screen>VBoxManage setextradata "VM name"
    2098       "VBoxInternal/Devices/pcbios/0/Config/DmiBIOSVendor"        "BIOS Vendor"
    2099 VBoxManage setextradata "VM name"
    2100       "VBoxInternal/Devices/pcbios/0/Config/DmiBIOSVersion"       "BIOS Version"
    2101 VBoxManage setextradata "VM name"
    2102       "VBoxInternal/Devices/pcbios/0/Config/DmiBIOSReleaseDate"   "BIOS Release Date"
    2103 VBoxManage setextradata "VM name"
    2104       "VBoxInternal/Devices/pcbios/0/Config/DmiBIOSReleaseMajor"  1
    2105 VBoxManage setextradata "VM name"
    2106       "VBoxInternal/Devices/pcbios/0/Config/DmiBIOSReleaseMinor"  2
    2107 VBoxManage setextradata "VM name"
    2108       "VBoxInternal/Devices/pcbios/0/Config/DmiBIOSFirmwareMajor" 3
    2109 VBoxManage setextradata "VM name"
    2110       "VBoxInternal/Devices/pcbios/0/Config/DmiBIOSFirmwareMinor" 4</screen>
     1999<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2000"VBoxInternal/Devices/pcbios/0/Config/DmiBIOSVendor"        "BIOS Vendor"
     2001$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2002"VBoxInternal/Devices/pcbios/0/Config/DmiBIOSVersion"       "BIOS Version"
     2003$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2004"VBoxInternal/Devices/pcbios/0/Config/DmiBIOSReleaseDate"   "BIOS Release Date"
     2005$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2006"VBoxInternal/Devices/pcbios/0/Config/DmiBIOSReleaseMajor"  1
     2007$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2008"VBoxInternal/Devices/pcbios/0/Config/DmiBIOSReleaseMinor"  2
     2009$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2010"VBoxInternal/Devices/pcbios/0/Config/DmiBIOSFirmwareMajor" 3
     2011$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2012"VBoxInternal/Devices/pcbios/0/Config/DmiBIOSFirmwareMinor" 4</screen>
    21112013      </listitem>
    21122014
     
    21162018        </para>
    21172019
    2118 <screen>VBoxManage setextradata "VM name"
    2119       "VBoxInternal/Devices/pcbios/0/Config/DmiSystemVendor"      "System Vendor"
    2120 VBoxManage setextradata "VM name"
    2121       "VBoxInternal/Devices/pcbios/0/Config/DmiSystemProduct"     "System Product"
    2122 VBoxManage setextradata "VM name"
    2123       "VBoxInternal/Devices/pcbios/0/Config/DmiSystemVersion"     "System Version"
    2124 VBoxManage setextradata "VM name"
    2125       "VBoxInternal/Devices/pcbios/0/Config/DmiSystemSerial"      "System Serial"
    2126 VBoxManage setextradata "VM name"
    2127       "VBoxInternal/Devices/pcbios/0/Config/DmiSystemSKU"         "System SKU"
    2128 VBoxManage setextradata "VM name"
    2129       "VBoxInternal/Devices/pcbios/0/Config/DmiSystemFamily"      "System Family"
    2130 VBoxManage setextradata "VM name"
    2131       "VBoxInternal/Devices/pcbios/0/Config/DmiSystemUuid"
    2132        "9852bf98-b83c-49db-a8de-182c42c7226b"</screen>
     2020<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2021"VBoxInternal/Devices/pcbios/0/Config/DmiSystemVendor"      "System Vendor"
     2022$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2023"VBoxInternal/Devices/pcbios/0/Config/DmiSystemProduct"     "System Product"
     2024$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2025"VBoxInternal/Devices/pcbios/0/Config/DmiSystemVersion"     "System Version"
     2026$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2027"VBoxInternal/Devices/pcbios/0/Config/DmiSystemSerial"      "System Serial"
     2028$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2029"VBoxInternal/Devices/pcbios/0/Config/DmiSystemSKU"         "System SKU"
     2030$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2031"VBoxInternal/Devices/pcbios/0/Config/DmiSystemFamily"      "System Family"
     2032$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2033"VBoxInternal/Devices/pcbios/0/Config/DmiSystemUuid" \
     2034"9852bf98-b83c-49db-a8de-182c42c7226b"</screen>
    21332035      </listitem>
    21342036
     
    21382040        </para>
    21392041
    2140 <screen>VBoxManage setextradata "VM name"
    2141       "VBoxInternal/Devices/pcbios/0/Config/DmiBoardVendor"       "Board Vendor"
    2142 VBoxManage setextradata "VM name"
    2143       "VBoxInternal/Devices/pcbios/0/Config/DmiBoardProduct"      "Board Product"
    2144 VBoxManage setextradata "VM name"
    2145       "VBoxInternal/Devices/pcbios/0/Config/DmiBoardVersion"      "Board Version"
    2146 VBoxManage setextradata "VM name"
    2147       "VBoxInternal/Devices/pcbios/0/Config/DmiBoardSerial"       "Board Serial"
    2148 VBoxManage setextradata "VM name"
    2149       "VBoxInternal/Devices/pcbios/0/Config/DmiBoardAssetTag"     "Board Tag"
    2150 VBoxManage setextradata "VM name"
    2151       "VBoxInternal/Devices/pcbios/0/Config/DmiBoardLocInChass"   "Board Location"
    2152 VBoxManage setextradata "VM name"
    2153       "VBoxInternal/Devices/pcbios/0/Config/DmiBoardBoardType"    10</screen>
     2042<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2043"VBoxInternal/Devices/pcbios/0/Config/DmiBoardVendor"       "Board Vendor"
     2044$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2045"VBoxInternal/Devices/pcbios/0/Config/DmiBoardProduct"      "Board Product"
     2046$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2047"VBoxInternal/Devices/pcbios/0/Config/DmiBoardVersion"      "Board Version"
     2048$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2049"VBoxInternal/Devices/pcbios/0/Config/DmiBoardSerial"       "Board Serial"
     2050$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2051"VBoxInternal/Devices/pcbios/0/Config/DmiBoardAssetTag"     "Board Tag"
     2052$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2053"VBoxInternal/Devices/pcbios/0/Config/DmiBoardLocInChass"   "Board Location"
     2054$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2055"VBoxInternal/Devices/pcbios/0/Config/DmiBoardBoardType"    10</screen>
    21542056      </listitem>
    21552057
     
    21592061        </para>
    21602062
    2161 <screen>VBoxManage setextradata "VM name"
    2162       "VBoxInternal/Devices/pcbios/0/Config/DmiChassisVendor"     "Chassis Vendor"
    2163 VBoxManage setextradata "VM name"
    2164       "VBoxInternal/Devices/pcbios/0/Config/DmiChassisType"       3
    2165 VBoxManage setextradata "VM name"
    2166       "VBoxInternal/Devices/pcbios/0/Config/DmiChassisVersion"    "Chassis Version"
    2167 VBoxManage setextradata "VM name"
    2168       "VBoxInternal/Devices/pcbios/0/Config/DmiChassisSerial"     "Chassis Serial"
    2169 VBoxManage setextradata "VM name"
    2170       "VBoxInternal/Devices/pcbios/0/Config/DmiChassisAssetTag"   "Chassis Tag"</screen>
     2063<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2064"VBoxInternal/Devices/pcbios/0/Config/DmiChassisVendor"     "Chassis Vendor"
     2065$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2066"VBoxInternal/Devices/pcbios/0/Config/DmiChassisType"       3
     2067$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2068"VBoxInternal/Devices/pcbios/0/Config/DmiChassisVersion"    "Chassis Version"
     2069$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2070"VBoxInternal/Devices/pcbios/0/Config/DmiChassisSerial"     "Chassis Serial"
     2071$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2072"VBoxInternal/Devices/pcbios/0/Config/DmiChassisAssetTag"   "Chassis Tag"</screen>
    21712073      </listitem>
    21722074
     
    21762078        </para>
    21772079
    2178 <screen>VBoxManage setextradata "VM name"
    2179       "VBoxInternal/Devices/pcbios/0/Config/DmiProcManufacturer"  "GenuineIntel"
    2180 VBoxManage setextradata "VM name"
    2181       "VBoxInternal/Devices/pcbios/0/Config/DmiProcVersion"       "Pentium(R) III"</screen>
     2080<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2081"VBoxInternal/Devices/pcbios/0/Config/DmiProcManufacturer"  "GenuineIntel"
     2082$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2083"VBoxInternal/Devices/pcbios/0/Config/DmiProcVersion"       "Pentium(R) III"</screen>
    21822084      </listitem>
    21832085
     
    21872089        </para>
    21882090
    2189 <screen>VBoxManage setextradata "VM name"
    2190       "VBoxInternal/Devices/pcbios/0/Config/DmiOEMVBoxVer"        "vboxVer_1.2.3"
    2191 VBoxManage setextradata "VM name"
    2192       "VBoxInternal/Devices/pcbios/0/Config/DmiOEMVBoxRev"        "vboxRev_12345"</screen>
     2091<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2092"VBoxInternal/Devices/pcbios/0/Config/DmiOEMVBoxVer"        "vboxVer_1.2.3"
     2093$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2094"VBoxInternal/Devices/pcbios/0/Config/DmiOEMVBoxRev"        "vboxRev_12345"</screen>
    21932095      </listitem>
    21942096
     
    21982100      If a DMI string is not set, the default value of &product-name; is
    21992101      used. To set an empty string use
    2200       <computeroutput>"&lt;EMPTY&gt;"</computeroutput>.
     2102      <literal>"&lt;EMPTY&gt;"</literal>.
    22012103    </para>
    22022104
     
    22062108      strings. If such a string is a valid number, the parameter is
    22072109      treated as number and the VM will most probably refuse to start
    2208       with an <computeroutput>VERR_CFGM_NOT_STRING</computeroutput>
    2209       error. In that case, use
    2210       <computeroutput>"string:&lt;value&gt;"</computeroutput>. For
     2110      with an <literal>VERR_CFGM_NOT_STRING</literal> error. In that
     2111      case, use
     2112      <literal>"string:<replaceable>value</replaceable>"</literal>. For
    22112113      example:
    22122114    </para>
    22132115
    2214 <screen>VBoxManage setextradata "VM name"
    2215       "VBoxInternal/Devices/pcbios/0/Config/DmiSystemSerial"      "string:1234"</screen>
     2116<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     2117"VBoxInternal/Devices/pcbios/0/Config/DmiSystemSerial"      "string:1234"</screen>
    22162118
    22172119    <para>
     
    22222124    </para>
    22232125
    2224 <screen>dmidecode -t0</screen>
     2126<screen>$ dmidecode -t0</screen>
    22252127
    22262128    <para>
     
    22282130    </para>
    22292131
    2230 <screen>dmidecode -t1</screen>
     2132<screen>$ dmidecode -t1</screen>
    22312133
    22322134  </sect1>
     
    22372139
    22382140    <para>
    2239       &product-name; can be configured to present up to four custom ACPI
    2240       tables to the guest. A command such as the following can be used
    2241       to configure custom ACPI tables. Note that CustomTable1,
    2242       CustomTable2, and CustomTable3 are available in addition to
    2243       CustomTable0.
    2244     </para>
    2245 
    2246 <screen>VBoxManage setextradata "VM name"
     2141      You can configure &product-name; to present up to four custom ACPI
     2142      tables to the guest. Use a command such as the following to
     2143      configure custom ACPI tables. Note that
     2144      <literal>CustomTable1</literal>, <literal>CustomTable2</literal>,
     2145      and <literal>CustomTable3</literal> are available in addition to
     2146      <literal>CustomTable0</literal>.
     2147    </para>
     2148
     2149<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
    22472150"VBoxInternal/Devices/acpi/0/Config/CustomTable0" "/path/to/table.bin"</screen>
    22482151
     
    22522155      8 and later guests. On Linux hosts, one of the system's ACPI
    22532156      tables can be read from
    2254       <computeroutput>/sys/firmware/acpi/tables/</computeroutput>.
     2157      <filename>/sys/firmware/acpi/tables/</filename>.
    22552158    </para>
    22562159
     
    22832186      </para>
    22842187
    2285 <screen>VBoxManage setextradata "VM name" "VBoxInternal/TM/TSCTiedToExecution" 1</screen>
     2188<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxInternal/TM/TSCTiedToExecution" 1</screen>
    22862189
    22872190      <para>
     
    22892192      </para>
    22902193
    2291 <screen>VBoxManage setextradata "VM name" "VBoxInternal/TM/TSCTiedToExecution"</screen>
     2194<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxInternal/TM/TSCTiedToExecution"</screen>
    22922195
    22932196      <para>
     
    23112214      </para>
    23122215
    2313 <screen>VBoxManage setextradata "VM name" "VBoxInternal/TM/WarpDrivePercentage" 200</screen>
     2216<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxInternal/TM/WarpDrivePercentage" 200</screen>
    23142217
    23152218      <para>
     
    23172220      </para>
    23182221
    2319 <screen>VBoxManage setextradata "VM name" "VBoxInternal/TM/WarpDrivePercentage" 50</screen>
     2222<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxInternal/TM/WarpDrivePercentage" 50</screen>
    23202223
    23212224      <para>
     
    23472250      </para>
    23482251
    2349 <screen>VBoxManage guestproperty set "VM name" "/VirtualBox/GuestAdd/VBoxService/PARAMETER" VALUE</screen>
    2350 
    2351       <para>
    2352         where <computeroutput>PARAMETER</computeroutput> is one of the
    2353         following:
     2252<screen>$ VBoxManage guestproperty set <replaceable>VM-name</replaceable> "/VirtualBox/GuestAdd/VBoxService/<replaceable>property</replaceable>" <replaceable>value</replaceable></screen>
     2253
     2254      <para>
     2255        <replaceable>property</replaceable> is one of the following:
    23542256      </para>
    23552257
     
    23582260        <varlistentry>
    23592261          <term>
    2360             <computeroutput>--timesync-interval</computeroutput>
     2262            <option>--timesync-interval</option>
    23612263          </term>
    23622264
     
    23712273        <varlistentry>
    23722274          <term>
    2373             <computeroutput>--timesync-min-adjust</computeroutput>
     2275            <option>--timesync-min-adjust</option>
    23742276          </term>
    23752277
     
    23852287        <varlistentry>
    23862288          <term>
    2387             <computeroutput>--timesync-latency-factor</computeroutput>
     2289            <option>--timesync-latency-factor</option>
    23882290          </term>
    23892291
     
    24082310        <varlistentry>
    24092311          <term>
    2410             <computeroutput>--timesync-max-latency</computeroutput>
     2312            <option>--timesync-max-latency</option>
    24112313          </term>
    24122314
     
    24212323        <varlistentry>
    24222324          <term>
    2423             <computeroutput>--timesync-set-threshold</computeroutput>
     2325            <option>--timesync-set-threshold</option>
    24242326          </term>
    24252327
     
    24352337        <varlistentry>
    24362338          <term>
    2437             <computeroutput>--timesync-set-start</computeroutput>
     2339            <option>--timesync-set-start</option>
    24382340          </term>
    24392341
     
    24472349        <varlistentry>
    24482350          <term>
    2449             <computeroutput>--timesync-set-on-restore
    2450             0|1</computeroutput>
     2351            <option>--timesync-set-on-restore 0|1</option>
    24512352          </term>
    24522353
     
    24812382      </para>
    24822383
    2483 <screen>VBoxManage setextradata "VM name" "VBoxInternal/Devices/VMMDev/0/Config/GetHostTimeDisabled" 1</screen>
     2384<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxInternal/Devices/VMMDev/0/Config/GetHostTimeDisabled" 1</screen>
    24842385
    24852386    </sect2>
     
    24902391
    24912392    <title>Installing the Alternate Bridged Networking Driver on Oracle Solaris 11
    2492       hosts</title>
     2393      Hosts</title>
    24932394
    24942395    <para>
    24952396      &product-name; includes a network filter driver that utilizes
    24962397      Oracle Solaris 11's Crossbow functionality. By default, this new
    2497       driver is installed for Oracle Solaris 11 hosts, builds 159 and
    2498       above, that have support for it.
     2398      driver is installed for Oracle Solaris 11 hosts that have support
     2399      for it.
    24992400    </para>
    25002401
     
    25052406    </para>
    25062407
    2507 <screen>touch /etc/vboxinst_vboxflt</screen>
     2408<screen>$ touch /etc/vboxinst_vboxflt</screen>
    25082409
    25092410    <para>
     
    25132414    </para>
    25142415
    2515 <screen>touch /etc/vboxinst_vboxbow</screen>
     2416<screen>$ touch /etc/vboxinst_vboxbow</screen>
    25162417
    25172418    <para>
     
    25202421    </para>
    25212422
    2522 <screen>modinfo | grep vbox</screen>
     2423<screen>$ modinfo | grep vbox</screen>
    25232424
    25242425    <para>
     
    25382439      for configuring VMs over VLANs. An &product-name; VNIC template is
    25392440      a VNIC whose name starts with
    2540       <computeroutput>vboxvnic_template</computeroutput>. The string is
     2441      <filename>vboxvnic_template</filename>. The string is
    25412442      case-sensitive.
    25422443    </para>
     
    25542455    </para>
    25552456
    2556 <screen>dladm create-vnic -t -l nge0 -v 23 vboxvnic_template0</screen>
    2557 
    2558     <para>
    2559       This will create a temporary VNIC template over interface "nge0"
    2560       with the VLAN ID 23. To create VNIC templates that are persistent
    2561       across host reboots, skip the <computeroutput>-t</computeroutput>
    2562       parameter in the above command. You may check the current state of
    2563       links using the following command:
     2457<screen># dladm create-vnic -t -l nge0 -v 23 vboxvnic_template0</screen>
     2458
     2459    <para>
     2460      This will create a temporary VNIC template over interface
     2461      <command>nge0</command> with the VLAN ID 23. To create VNIC
     2462      templates that are persistent across host reboots, skip the
     2463      <option>-t</option> parameter in the above command. You may check
     2464      the current state of links using the following command:
    25642465    </para>
    25652466
     
    25762477    <para>
    25772478      Once the VNIC template is created, any VMs that need to be on VLAN
    2578       23 over the interface <computeroutput>nge0</computeroutput> can be
    2579       configured to bridge using this VNIC template.
     2479      23 over the interface <command>nge0</command> can be configured to
     2480      bridge using this VNIC template.
    25802481    </para>
    25812482
     
    25902491    <para>
    25912492      VNIC templates can be created with additional properties such as
    2592       bandwidth limits, CPU fanout etc. Refer to your Oracle Solaris
    2593       network documentation on how to accomplish this. These additional
    2594       properties, if any, are also applied to VMs which bridge using the
    2595       VNIC template.
     2493      bandwidth limits and CPU fanout. Refer to your Oracle Solaris
     2494      network documentation for details. The additional properties are
     2495      also applied to VMs which bridge using the VNIC template.
    25962496    </para>
    25972497
     
    26152515    </para>
    26162516
    2617 <screen>ifconfig vboxnet0 unplumb</screen>
     2517<screen># ifconfig vboxnet0 unplumb</screen>
    26182518
    26192519    <para>
     
    26232523    </para>
    26242524
    2625 <screen>rem_drv vboxnet</screen>
     2525<screen># rem_drv vboxnet</screen>
    26262526
    26272527    <para>
    26282528      Edit the file
    2629       <computeroutput>/platform/i86pc/kernel/drv/vboxnet.conf</computeroutput>
    2630       and add a line for the new interface we want to add as shown
    2631       below:
     2529      <filename>/platform/i86pc/kernel/drv/vboxnet.conf</filename> and
     2530      add a line for the new interface we want to add as shown below:
    26322531    </para>
    26332532
     
    26452544    </para>
    26462545
    2647 <screen>add_drv vboxnet</screen>
     2546<screen># add_drv vboxnet</screen>
    26482547
    26492548    <para>
     
    26532552    </para>
    26542553
    2655 <screen>dladm show-phys
     2554<screen>$ dladm show-phys
    26562555LINK              MEDIA                STATE      SPEED  DUPLEX    DEVICE
    26572556net0              Ethernet             up         100    full      e1000g0
     
    26652564    </para>
    26662565
    2667 <screen>dladm rename-link net2 vboxnet1</screen>
    2668 
    2669     <para>
    2670       Now plumb all the interfaces using <computeroutput>ifconfig
    2671       vboxnetX plumb</computeroutput>, where 'X' would be 1 in this
    2672       case. Once the interface is plumbed, it may be configured like any
    2673       other network interface. Refer to the
    2674       <computeroutput>ifconfig</computeroutput> documentation for
    2675       further details.
     2566<screen># dladm rename-link net2 vboxnet1</screen>
     2567
     2568    <para>
     2569      Now plumb all the interfaces using <command>ifconfig
     2570      vboxnet<replaceable>X</replaceable> plumb</command>, where
     2571      <replaceable>X</replaceable> would be 1 in this case. Once the
     2572      interface is plumbed, it may be configured like any other network
     2573      interface. Refer to the <command>ifconfig</command> documentation
     2574      for further details.
    26762575    </para>
    26772576
     
    26792578      To make the settings for the newly added interfaces persistent
    26802579      across reboots, you will need to edit the files
    2681       <computeroutput>/etc/inet/netmasks</computeroutput>, and if you
    2682       are using NWAM <computeroutput>/etc/nwam/llp</computeroutput> and
    2683       add the appropriate entries to set the netmask and static IP for
    2684       each of those interfaces. The &product-name; installer only
    2685       updates these configuration files for the one "vboxnet0" interface
    2686       it creates by default.
     2580      <filename>/etc/inet/netmasks</filename>, and if you are using NWAM
     2581      <filename>/etc/nwam/llp</filename> and add the appropriate entries
     2582      to set the netmask and static IP for each of those interfaces. The
     2583      &product-name; installer only updates these configuration files
     2584      for the one "vboxnet0" interface it creates by default.
    26872585    </para>
    26882586
     
    27042602    </para>
    27052603
    2706 <screen>VBoxManage setextradata "VM name" VBoxInternal2/CoreDumpEnabled 1</screen>
     2604<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> VBoxInternal2/CoreDumpEnabled 1</screen>
    27072605
    27082606    <para>
     
    27112609    </para>
    27122610
    2713 <screen>VBoxManage setextradata "VM name" VBoxInternal2/CoreDumpDir &lt;path-to-directory&gt;</screen>
     2611<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> VBoxInternal2/CoreDumpDir <replaceable>path-to-directory</replaceable></screen>
    27142612
    27152613    <para>
     
    27292627    </para>
    27302628
    2731 <screen>VBoxManage setextradata "VM name" VBoxInternal2/CoreDumpReplaceSystemDump 1
    2732 VBoxManage setextradata "VM name" VBoxInternal2/CoreDumpLive 1</screen>
     2629<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> VBoxInternal2/CoreDumpReplaceSystemDump 1
     2630$ VBoxManage setextradata <replaceable>VM-name</replaceable> VBoxInternal2/CoreDumpLive 1</screen>
    27332631
    27342632    <para>
     
    27382636
    27392637    <para>
    2740       Setting <computeroutput>CoreDumpReplaceSystemDump</computeroutput>
    2741       sets up the VM to override the host's core dumping mechanism and
    2742       in the event of any crash only the &product-name; CoreDumper would
    2743       produce the core file.
    2744     </para>
    2745 
    2746     <para>
    2747       Setting <computeroutput>CoreDumpLive</computeroutput> sets up the
    2748       VM to produce cores whenever the VM process receives a
    2749       <computeroutput>SIGUSR2</computeroutput> signal. After producing
    2750       the core file, the VM will not be terminated and will continue to
    2751       run. You can thus take cores of the VM process using the following
    2752       command:
    2753     </para>
    2754 
    2755 <screen>kill -s SIGUSR2 &lt;VM-process-id&gt;</screen>
    2756 
    2757     <para>
    2758       Core files produced by the &product-name; CoreDumper are of the
    2759       form
    2760       <computeroutput>core.vb.&lt;ProcessName&gt;.&lt;ProcessID&gt;</computeroutput>,
    2761       for example
    2762       <computeroutput>core.vb.VBoxHeadless.11321</computeroutput>.
     2638      Setting <literal>CoreDumpReplaceSystemDump</literal> sets up the
     2639      VM to override the host's core dumping mechanism and in the event
     2640      of any crash only the &product-name; CoreDumper would produce the
     2641      core file.
     2642    </para>
     2643
     2644    <para>
     2645      Setting <literal>CoreDumpLive</literal> sets up the VM to produce
     2646      cores whenever the VM process receives a
     2647      <literal>SIGUSR2</literal> signal. After producing the core file,
     2648      the VM will not be terminated and will continue to run. You can
     2649      thus take cores of the VM process using the following command:
     2650    </para>
     2651
     2652<screen>$ kill -s SIGUSR2 <replaceable>VM-process-id</replaceable></screen>
     2653
     2654    <para>
     2655      The &product-name; CoreDumper creates core files of the form
     2656      <filename>core.vb.<replaceable>process-name</replaceable>.<replaceable>process-ID</replaceable></filename>
     2657      such as <filename>core.vb.VBoxHeadless.11321</filename>.
    27632658    </para>
    27642659
     
    27932688    </para>
    27942689
    2795 <screen>VBoxManage setproperty hwvirtexclusive off</screen>
     2690<screen>$ VBoxManage setproperty hwvirtexclusive off</screen>
    27962691
    27972692    <para>
     
    28182713      </para>
    28192714
    2820 <screen>VBoxManage setextradata global GUI/Customizations OPTION[,OPTION...]</screen>
    2821 
    2822       <para>
    2823         where <computeroutput>OPTION</computeroutput> is one of the
    2824         following keywords:
     2715<screen>VBoxManage setextradata global GUI/Customizations <replaceable>property</replaceable>[,<replaceable>property</replaceable> ...]</screen>
     2716
     2717      <para>
     2718        <replaceable>property</replaceable> is one of the following
     2719        properties:
    28252720      </para>
    28262721
     
    28292724        <varlistentry>
    28302725          <term>
    2831             <computeroutput>noSelector</computeroutput>
     2726            <literal>noSelector</literal>
    28322727          </term>
    28332728
     
    28432738        <varlistentry>
    28442739          <term>
    2845             <computeroutput>noMenuBar</computeroutput>
     2740            <literal>noMenuBar</literal>
    28462741          </term>
    28472742
     
    28552750        <varlistentry>
    28562751          <term>
    2857             <computeroutput>noStatusBar</computeroutput>
     2752            <literal>noStatusBar</literal>
    28582753          </term>
    28592754
     
    28722767      </para>
    28732768
    2874 <screen>VBoxManage setextradata global GUI/Customizations</screen>
     2769<screen>$ VBoxManage setextradata global GUI/Customizations</screen>
    28752770
    28762771    </sect2>
     
    28862781      </para>
    28872782
    2888 <screen>VBoxManage setextradata "VM name" SETTING true</screen>
    2889 
    2890       <para>
    2891         where <computeroutput>SETTING</computeroutput> can be:
     2783<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> <replaceable>property</replaceable> true</screen>
     2784
     2785      <para>
     2786        <replaceable>property</replaceable> can be any of the following:
    28922787      </para>
    28932788
     
    28962791        <varlistentry>
    28972792          <term>
    2898             <computeroutput>GUI/HideDetails</computeroutput>
     2793            <literal>GUI/HideDetails</literal>
    28992794          </term>
    29002795
     
    29102805        <varlistentry>
    29112806          <term>
    2912             <computeroutput>GUI/PreventReconfiguration</computeroutput>
     2807            <literal>GUI/PreventReconfiguration</literal>
    29132808          </term>
    29142809
     
    29242819        <varlistentry>
    29252820          <term>
    2926             <computeroutput>GUI/PreventSnapshotOperations</computeroutput>
     2821            <literal>GUI/PreventSnapshotOperations</literal>
    29272822          </term>
    29282823
     
    29372832        <varlistentry>
    29382833          <term>
    2939             <computeroutput>GUI/HideFromManager</computeroutput>
     2834            <literal>GUI/HideFromManager</literal>
    29402835          </term>
    29412836
     
    29492844        <varlistentry>
    29502845          <term>
    2951             <computeroutput>GUI/PreventApplicationUpdate</computeroutput>
     2846            <literal>GUI/PreventApplicationUpdate</literal>
    29522847          </term>
    29532848
     
    29632858
    29642859      <para>
    2965         Please note that these settings would not prevent the user from
    2966         reconfiguring the VM by using <command>VBoxManage
    2967         modifyvm</command>.
     2860        Note that these settings do not prevent the user from
     2861        reconfiguring the VM by using the <command>VBoxManage
     2862        modifyvm</command> command.
    29682863      </para>
    29692864
     
    29792874      </para>
    29802875
    2981 <screen>VBoxManage setextradata global GUI/RestrictedGlobalSettingsPages OPTION[,OPTION...]</screen>
    2982 
    2983       <para>
    2984         where <computeroutput>OPTION</computeroutput> is one of the
    2985         following keywords:
     2876<screen>$ VBoxManage setextradata global GUI/RestrictedGlobalSettingsPages <replaceable>property</replaceable>[,<replaceable>property</replaceable>...]</screen>
     2877
     2878      <para>
     2879        <replaceable>property</replaceable> is one of the following:
    29862880      </para>
    29872881
     
    29902884        <varlistentry>
    29912885          <term>
    2992             <computeroutput>General</computeroutput>
     2886            <literal>General</literal>
    29932887          </term>
    29942888
     
    30032897        <varlistentry>
    30042898          <term>
    3005             <computeroutput>Input</computeroutput>
     2899            <literal>Input</literal>
    30062900          </term>
    30072901
     
    30162910        <varlistentry>
    30172911          <term>
    3018             <computeroutput>Update</computeroutput>
     2912            <literal>Update</literal>
    30192913          </term>
    30202914
     
    30292923        <varlistentry>
    30302924          <term>
    3031             <computeroutput>Language</computeroutput>
     2925            <literal>Language</literal>
    30322926          </term>
    30332927
     
    30422936        <varlistentry>
    30432937          <term>
    3044             <computeroutput>Display</computeroutput>
     2938            <literal>Display</literal>
    30452939          </term>
    30462940
     
    30552949        <varlistentry>
    30562950          <term>
    3057             <computeroutput>Network</computeroutput>
     2951            <literal>Network</literal>
    30582952          </term>
    30592953
     
    30682962        <varlistentry>
    30692963          <term>
    3070             <computeroutput>Extensions</computeroutput>
     2964            <literal>Extensions</literal>
    30712965          </term>
    30722966
     
    30812975        <varlistentry>
    30822976          <term>
    3083             <computeroutput>Proxy</computeroutput>
     2977            <literal>Proxy</literal>
    30842978          </term>
    30852979
     
    30952989
    30962990      <para>
    3097         This is a global setting. Any combination of the above is
    3098         allowed. To restore the default behavior, use
    3099       </para>
    3100 
    3101 <screen>VBoxManage setextradata global GUI/RestrictedGlobalSettingsPages</screen>
     2991        This is a global setting. You can specify any combination of
     2992        properties. To restore the default behavior, use the following
     2993        command:
     2994      </para>
     2995
     2996<screen>$ VBoxManage setextradata global GUI/RestrictedGlobalSettingsPages</screen>
    31022997
    31032998    </sect2>
     
    31153010
    31163011      <para>
    3117         where <computeroutput>OPTION</computeroutput> is one of the
    3118         following keywords:
     3012        where <literal>OPTION</literal> is one of the following
     3013        keywords:
    31193014      </para>
    31203015
     
    31233018        <varlistentry>
    31243019          <term>
    3125             <computeroutput>All</computeroutput>
     3020            <literal>All</literal>
    31263021          </term>
    31273022
     
    31353030        <varlistentry>
    31363031          <term>
    3137             <computeroutput>Application</computeroutput>
    3138           </term>
    3139 
    3140           <listitem>
    3141             <para>
    3142                Do not show <emphasis role="bold">Application/File</emphasis> menu in the VM window.
    3143             </para>
    3144           </listitem>
    3145         </varlistentry>
    3146 
    3147         <varlistentry>
    3148           <term>
    3149             <computeroutput>Machine</computeroutput>
     3032            <literal>Application</literal>
     3033          </term>
     3034
     3035          <listitem>
     3036            <para>
     3037              Do not show
     3038              <emphasis role="bold">Application/File</emphasis> menu in
     3039              the VM window.
     3040            </para>
     3041          </listitem>
     3042        </varlistentry>
     3043
     3044        <varlistentry>
     3045          <term>
     3046            <literal>Machine</literal>
    31503047          </term>
    31513048
     
    31603057        <varlistentry>
    31613058          <term>
    3162             <computeroutput>View</computeroutput>
     3059            <literal>View</literal>
    31633060          </term>
    31643061
     
    31733070        <varlistentry>
    31743071          <term>
    3175             <computeroutput>Input</computeroutput>
    3176           </term>
    3177 
    3178           <listitem>
    3179             <para>
    3180                Do not show <emphasis role="bold">Input</emphasis> menu in the VM window.
    3181             </para>
    3182           </listitem>
    3183         </varlistentry>
    3184 
    3185         <varlistentry>
    3186           <term>
    3187             <computeroutput>Devices</computeroutput>
     3072            <literal>Input</literal>
     3073          </term>
     3074
     3075          <listitem>
     3076            <para>
     3077              Do not show <emphasis role="bold">Input</emphasis> menu in
     3078              the VM window.
     3079            </para>
     3080          </listitem>
     3081        </varlistentry>
     3082
     3083        <varlistentry>
     3084          <term>
     3085            <literal>Devices</literal>
    31883086          </term>
    31893087
     
    31983096        <varlistentry>
    31993097          <term>
    3200             <computeroutput>Help</computeroutput>
     3098            <literal>Help</literal>
    32013099          </term>
    32023100
     
    32113109        <varlistentry>
    32123110          <term>
    3213             <computeroutput>Debug</computeroutput>
     3111            <literal>Debug</literal>
    32143112          </term>
    32153113
     
    32273125
    32283126      <para>
    3229         This is a per-VM or global setting. Any combination of the above is
    3230         allowed. To restore the default behavior, use
     3127        This is a per-VM or global setting. Any combination of the above
     3128        is allowed. To restore the default behavior, use the following
     3129        command:
    32313130      </para>
    32323131
     
    32433142
    32443143      <para>
    3245         where <computeroutput>OPTION</computeroutput> is one of the
    3246         following keywords:
     3144        where <literal>OPTION</literal> is one of the following
     3145        keywords:
    32473146      </para>
    32483147
     
    32513150        <varlistentry>
    32523151          <term>
    3253             <computeroutput>All</computeroutput>
     3152            <literal>All</literal>
    32543153          </term>
    32553154
     
    32633162        <varlistentry>
    32643163          <term>
    3265             <computeroutput>About</computeroutput>
     3164            <literal>About</literal>
    32663165          </term>
    32673166
     
    32763175        <varlistentry>
    32773176          <term>
    3278             <computeroutput>Preferences</computeroutput>
    3279           </term>
    3280 
    3281           <listitem>
    3282             <para>
    3283               Do not show the <emphasis role="bold">Preferences</emphasis>
    3284               menu item in this menu.
    3285             </para>
    3286           </listitem>
    3287         </varlistentry>
    3288 
    3289         <varlistentry>
    3290           <term>
    3291             <computeroutput>NetworkAccessManager</computeroutput>
    3292           </term>
    3293 
    3294           <listitem>
    3295             <para>
    3296               Do not show the <emphasis role="bold">Network Operations Manager</emphasis>
    3297               menu item in this menu.
    3298             </para>
    3299           </listitem>
    3300         </varlistentry>
    3301 
    3302         <varlistentry>
    3303           <term>
    3304             <computeroutput>ResetWarnings</computeroutput>
    3305           </term>
    3306 
    3307           <listitem>
    3308             <para>
    3309               Do not show the <emphasis role="bold">Reset All Warnings</emphasis>
    3310               menu item in this menu.
    3311             </para>
    3312           </listitem>
    3313         </varlistentry>
    3314 
    3315         <varlistentry>
    3316           <term>
    3317             <computeroutput>Close</computeroutput>
     3177            <literal>Preferences</literal>
     3178          </term>
     3179
     3180          <listitem>
     3181            <para>
     3182              Do not show the
     3183              <emphasis role="bold">Preferences</emphasis> menu item in
     3184              this menu.
     3185            </para>
     3186          </listitem>
     3187        </varlistentry>
     3188
     3189        <varlistentry>
     3190          <term>
     3191            <literal>NetworkAccessManager</literal>
     3192          </term>
     3193
     3194          <listitem>
     3195            <para>
     3196              Do not show the <emphasis role="bold">Network Operations
     3197              Manager</emphasis> menu item in this menu.
     3198            </para>
     3199          </listitem>
     3200        </varlistentry>
     3201
     3202        <varlistentry>
     3203          <term>
     3204            <literal>ResetWarnings</literal>
     3205          </term>
     3206
     3207          <listitem>
     3208            <para>
     3209              Do not show the <emphasis role="bold">Reset All
     3210              Warnings</emphasis> menu item in this menu.
     3211            </para>
     3212          </listitem>
     3213        </varlistentry>
     3214
     3215        <varlistentry>
     3216          <term>
     3217            <literal>Close</literal>
    33183218          </term>
    33193219
     
    33293229
    33303230      <para>
    3331         This is a per-VM or global setting. Any combination of the above is
    3332         allowed. To restore the default behavior, use
     3231        This is a per-VM or global setting. Any combination of the above
     3232        is allowed. To restore the default behavior, use the following
     3233        command:
    33333234      </para>
    33343235
     
    33433244
    33443245      <para>
    3345         where <computeroutput>OPTION</computeroutput> is one of the
    3346         following keywords:
     3246        where <literal>OPTION</literal> is one of the following
     3247        keywords:
    33473248      </para>
    33483249
     
    33513252        <varlistentry>
    33523253          <term>
    3353             <computeroutput>All</computeroutput>
     3254            <literal>All</literal>
    33543255          </term>
    33553256
     
    33633264        <varlistentry>
    33643265          <term>
    3365             <computeroutput>SettingsDialog</computeroutput>
     3266            <literal>SettingsDialog</literal>
    33663267          </term>
    33673268
     
    33763277        <varlistentry>
    33773278          <term>
    3378             <computeroutput>TakeSnapshot</computeroutput>
     3279            <literal>TakeSnapshot</literal>
    33793280          </term>
    33803281
     
    33893290        <varlistentry>
    33903291          <term>
    3391             <computeroutput>InformationDialog</computeroutput>
     3292            <literal>InformationDialog</literal>
    33923293          </term>
    33933294
     
    34023303        <varlistentry>
    34033304          <term>
    3404             <computeroutput>FileManagerDialog</computeroutput>
     3305            <literal>FileManagerDialog</literal>
    34053306          </term>
    34063307
     
    34133314        </varlistentry>
    34143315
    3415 
    3416         <varlistentry>
    3417           <term>
    3418             <computeroutput>Pause</computeroutput>
    3419           </term>
    3420 
    3421           <listitem>
    3422             <para>
    3423               Do not show the <emphasis role="bold">Pause</emphasis> menu item in this menu.
    3424             </para>
    3425           </listitem>
    3426         </varlistentry>
    3427 
    3428         <varlistentry>
    3429           <term>
    3430             <computeroutput>Reset</computeroutput>
    3431           </term>
    3432 
    3433           <listitem>
    3434             <para>
    3435               Do not show the <emphasis role="bold">Reset</emphasis> menu item in this menu.
    3436             </para>
    3437           </listitem>
    3438         </varlistentry>
    3439 
    3440 
    3441         <varlistentry>
    3442           <term>
    3443             <computeroutput>Shutdown</computeroutput>
     3316        <varlistentry>
     3317          <term>
     3318            <literal>Pause</literal>
     3319          </term>
     3320
     3321          <listitem>
     3322            <para>
     3323              Do not show the <emphasis role="bold">Pause</emphasis>
     3324              menu item in this menu.
     3325            </para>
     3326          </listitem>
     3327        </varlistentry>
     3328
     3329        <varlistentry>
     3330          <term>
     3331            <literal>Reset</literal>
     3332          </term>
     3333
     3334          <listitem>
     3335            <para>
     3336              Do not show the <emphasis role="bold">Reset</emphasis>
     3337              menu item in this menu.
     3338            </para>
     3339          </listitem>
     3340        </varlistentry>
     3341
     3342        <varlistentry>
     3343          <term>
     3344            <literal>Shutdown</literal>
    34443345          </term>
    34453346
     
    34553356
    34563357      <para>
    3457         This is a per-VM or global setting. Any combination of the above is
    3458         allowed. To restore the default behavior, use
     3358        This is a per-VM or global setting. Any combination of the above
     3359        is allowed. To restore the default behavior, use
    34593360      </para>
    34603361
     
    34693370
    34703371      <para>
    3471         where <computeroutput>OPTION</computeroutput> is one of the
    3472         following keywords:
     3372        where <literal>OPTION</literal> is one of the following
     3373        keywords:
    34733374      </para>
    34743375
     
    34773378        <varlistentry>
    34783379          <term>
    3479             <computeroutput>All</computeroutput>
     3380            <literal>All</literal>
    34803381          </term>
    34813382
     
    34893390        <varlistentry>
    34903391          <term>
    3491             <computeroutput>Fullscreen</computeroutput>
    3492           </term>
    3493 
    3494           <listitem>
    3495             <para>
    3496               Do not show the <emphasis role="bold">Full-screen Mode</emphasis> menu item in this menu.
    3497             </para>
    3498           </listitem>
    3499         </varlistentry>
    3500 
    3501         <varlistentry>
    3502           <term>
    3503             <computeroutput>Seamless</computeroutput>
     3392            <literal>Fullscreen</literal>
     3393          </term>
     3394
     3395          <listitem>
     3396            <para>
     3397              Do not show the <emphasis role="bold">Full-screen
     3398              Mode</emphasis> menu item in this menu.
     3399            </para>
     3400          </listitem>
     3401        </varlistentry>
     3402
     3403        <varlistentry>
     3404          <term>
     3405            <literal>Seamless</literal>
    35043406          </term>
    35053407
     
    35143416        <varlistentry>
    35153417          <term>
    3516             <computeroutput>Scale</computeroutput>
     3418            <literal>Scale</literal>
    35173419          </term>
    35183420
     
    35273429        <varlistentry>
    35283430          <term>
    3529             <computeroutput>GuestAutoresize</computeroutput>
     3431            <literal>GuestAutoresize</literal>
    35303432          </term>
    35313433
     
    35403442        <varlistentry>
    35413443          <term>
    3542             <computeroutput>AdjustWindow</computeroutput>
     3444            <literal>AdjustWindow</literal>
    35433445          </term>
    35443446
     
    35533455        <varlistentry>
    35543456          <term>
    3555             <computeroutput>TakeScreenshot</computeroutput>
    3556           </term>
    3557 
    3558           <listitem>
    3559             <para>
    3560               Do not show the
    3561               <emphasis role="bold">Take Screenshot...</emphasis> menu item in
    3562               this menu.
    3563             </para>
    3564           </listitem>
    3565         </varlistentry>
    3566 
    3567         <varlistentry>
    3568           <term>
    3569             <computeroutput>Recording</computeroutput>
    3570           </term>
    3571 
    3572           <listitem>
    3573             <para>
    3574               Do not show the
    3575               <emphasis role="bold">Recording</emphasis> menu item in
    3576               this menu.
    3577             </para>
    3578           </listitem>
    3579         </varlistentry>
    3580 
    3581         <varlistentry>
    3582           <term>
    3583             <computeroutput>VRDEServer</computeroutput>
    3584           </term>
    3585 
    3586           <listitem>
    3587             <para>
    3588               Do not show the
    3589               <emphasis role="bold">Remote Display</emphasis> menu item in
    3590               this menu.
    3591             </para>
    3592           </listitem>
    3593         </varlistentry>
    3594 
    3595         <varlistentry>
    3596           <term>
    3597             <computeroutput>MenuBar</computeroutput>
    3598           </term>
    3599 
    3600           <listitem>
    3601             <para>
    3602               Do not show the
    3603               <emphasis role="bold">Menu Bar</emphasis> menu item in
    3604               this menu.
    3605             </para>
    3606           </listitem>
    3607         </varlistentry>
    3608 
    3609         <varlistentry>
    3610           <term>
    3611             <computeroutput>MenuBarSettings</computeroutput>
    3612           </term>
    3613 
    3614           <listitem>
    3615             <para>
    3616               Do not show the
    3617               <emphasis role="bold">Menu Bar Settings...</emphasis> menu item in
    3618               this menu.
    3619             </para>
    3620           </listitem>
    3621         </varlistentry>
    3622 
    3623         <varlistentry>
    3624           <term>
    3625               <computeroutput>StatusBar</computeroutput>
    3626           </term>
    3627 
    3628           <listitem>
    3629             <para>
    3630               Do not show the
    3631               <emphasis role="bold">Status Bar</emphasis> menu item in
    3632               this menu.
    3633             </para>
    3634           </listitem>
    3635         </varlistentry>
    3636 
    3637         <varlistentry>
    3638           <term>
    3639             <computeroutput>StatusbarSettings</computeroutput>
    3640           </term>
    3641 
    3642           <listitem>
    3643             <para>
    3644               Do not show the
    3645               <emphasis role="bold">Statusbar Settings...</emphasis> menu item in
    3646               this menu.
     3457            <literal>TakeScreenshot</literal>
     3458          </term>
     3459
     3460          <listitem>
     3461            <para>
     3462              Do not show the <emphasis role="bold">Take
     3463              Screenshot...</emphasis> menu item in this menu.
     3464            </para>
     3465          </listitem>
     3466        </varlistentry>
     3467
     3468        <varlistentry>
     3469          <term>
     3470            <literal>Recording</literal>
     3471          </term>
     3472
     3473          <listitem>
     3474            <para>
     3475              Do not show the <emphasis role="bold">Recording</emphasis>
     3476              menu item in this menu.
     3477            </para>
     3478          </listitem>
     3479        </varlistentry>
     3480
     3481        <varlistentry>
     3482          <term>
     3483            <literal>VRDEServer</literal>
     3484          </term>
     3485
     3486          <listitem>
     3487            <para>
     3488              Do not show the <emphasis role="bold">Remote
     3489              Display</emphasis> menu item in this menu.
     3490            </para>
     3491          </listitem>
     3492        </varlistentry>
     3493
     3494        <varlistentry>
     3495          <term>
     3496            <literal>MenuBar</literal>
     3497          </term>
     3498
     3499          <listitem>
     3500            <para>
     3501              Do not show the <emphasis role="bold">Menu Bar</emphasis>
     3502              menu item in this menu.
     3503            </para>
     3504          </listitem>
     3505        </varlistentry>
     3506
     3507        <varlistentry>
     3508          <term>
     3509            <literal>MenuBarSettings</literal>
     3510          </term>
     3511
     3512          <listitem>
     3513            <para>
     3514              Do not show the <emphasis role="bold">Menu Bar
     3515              Settings...</emphasis> menu item in this menu.
     3516            </para>
     3517          </listitem>
     3518        </varlistentry>
     3519
     3520        <varlistentry>
     3521          <term>
     3522            <literal>StatusBar</literal>
     3523          </term>
     3524
     3525          <listitem>
     3526            <para>
     3527              Do not show the <emphasis role="bold">Status
     3528              Bar</emphasis> menu item in this menu.
     3529            </para>
     3530          </listitem>
     3531        </varlistentry>
     3532
     3533        <varlistentry>
     3534          <term>
     3535            <literal>StatusbarSettings</literal>
     3536          </term>
     3537
     3538          <listitem>
     3539            <para>
     3540              Do not show the <emphasis role="bold">Statusbar
     3541              Settings...</emphasis> menu item in this menu.
    36473542            </para>
    36483543          </listitem>
     
    36523547
    36533548      <para>
    3654         This is a per-VM or global setting. Any combination of the above is
    3655         allowed. To restore the default behavior, use
    3656       </para>
    3657 
    3658       <screen>VBoxManage setextradata "VM name"|global GUI/RestrictedRuntimeViewMenuActions</screen>
    3659 
    3660      <para>
     3549        This is a per-VM or global setting. Any combination of the above
     3550        is allowed. To restore the default behavior, use
     3551      </para>
     3552
     3553<screen>VBoxManage setextradata "VM name"|global GUI/RestrictedRuntimeViewMenuActions</screen>
     3554
     3555      <para>
    36613556        Use the following command to disable certain actions of the
    36623557        <emphasis role="bold">Input</emphasis> menu:
     
    36663561
    36673562      <para>
    3668         where <computeroutput>OPTION</computeroutput> is one of the
    3669         following keywords:
     3563        where <literal>OPTION</literal> is one of the following
     3564        keywords:
    36703565      </para>
    36713566
     
    36743569        <varlistentry>
    36753570          <term>
    3676             <computeroutput>All</computeroutput>
     3571            <literal>All</literal>
    36773572          </term>
    36783573
     
    36853580
    36863581        <varlistentry>
    3687             <term>
    3688                 <computeroutput>Keyboard</computeroutput>
    3689             </term>
    3690 
    3691             <listitem>
    3692                 <para>
    3693                     Do not show the
    3694                     <emphasis role="bold">Keyboard</emphasis> menu item in
    3695                     this menu.
    3696                 </para>
    3697             </listitem>
    3698         </varlistentry>
    3699 
    3700         <varlistentry>
    3701             <term>
    3702                 <computeroutput>KeyboardSettings</computeroutput>
    3703             </term>
    3704 
    3705             <listitem>
    3706                 <para>
    3707                     Do not show the
    3708                     <emphasis role="bold">Keyboard Settings...</emphasis> menu item in
    3709                     this menu.
    3710                 </para>
    3711             </listitem>
    3712         </varlistentry>
    3713 
    3714         <varlistentry>
    3715             <term>
    3716                 <computeroutput>SoftKeyboard</computeroutput>
    3717             </term>
    3718 
    3719             <listitem>
    3720                 <para>
    3721                     Do not show the
    3722                     <emphasis role="bold">Soft Keyboard...</emphasis> menu item in
    3723                     this menu.
    3724                 </para>
    3725             </listitem>
    3726         </varlistentry>
    3727 
    3728         <varlistentry>
    3729             <term>
    3730                 <computeroutput>TypeCAD</computeroutput>
    3731             </term>
    3732 
    3733             <listitem>
    3734                 <para>
    3735                     Do not show the
    3736                     <emphasis role="bold">Insert Ctrl-Alt-Del</emphasis> menu item in
    3737                     this menu.
    3738                 </para>
    3739             </listitem>
    3740         </varlistentry>
    3741 
    3742         <varlistentry>
    3743             <term>
    3744                 <computeroutput>TypeCABS</computeroutput>
    3745             </term>
    3746 
    3747             <listitem>
    3748                 <para>
    3749                     Do not show the
    3750                     <emphasis role="bold">Insert Ctrl-Alt-Backspace</emphasis> menu item in
    3751                     this menu.
    3752                 </para>
    3753             </listitem>
    3754         </varlistentry>
    3755 
    3756         <varlistentry>
    3757             <term>
    3758                 <computeroutput>TypeCtrlBreak</computeroutput>
    3759             </term>
    3760 
    3761             <listitem>
    3762                 <para>
    3763                     Do not show the
    3764                     <emphasis role="bold">Insert Ctrl-Break</emphasis> menu item in
    3765                     this menu.
    3766                 </para>
    3767             </listitem>
    3768         </varlistentry>
    3769 
    3770         <varlistentry>
    3771             <term>
    3772                 <computeroutput>TypeInsert</computeroutput>
    3773             </term>
    3774 
    3775             <listitem>
    3776                 <para>
    3777                     Do not show the
    3778                     <emphasis role="bold">Insert Insert</emphasis> menu item in
    3779                     this menu.
    3780                 </para>
    3781             </listitem>
    3782         </varlistentry>
    3783 
    3784         <varlistentry>
    3785             <term>
    3786                 <computeroutput>TypePrintScreen</computeroutput>
    3787             </term>
    3788 
    3789             <listitem>
    3790                 <para>
    3791                     Do not show the
    3792                     <emphasis role="bold">Insert Print Screen</emphasis> menu item in
    3793                     this menu.
    3794                 </para>
    3795             </listitem>
    3796         </varlistentry>
    3797 
    3798         <varlistentry>
    3799             <term>
    3800                 <computeroutput>TypeAltPrintScreen</computeroutput>
    3801             </term>
    3802 
    3803             <listitem>
    3804                 <para>
    3805                     Do not show the
    3806                     <emphasis role="bold">Insert Alt Print Screen</emphasis> menu item in
    3807                     this menu.
    3808                 </para>
    3809             </listitem>
    3810         </varlistentry>
    3811 
    3812       <varlistentry>
    3813             <term>
    3814                 <computeroutput>TypeHostKeyCombo</computeroutput>
    3815             </term>
    3816 
    3817             <listitem>
    3818                 <para>
    3819                     Do not show the
    3820                     <emphasis role="bold">Insert Host Key Combo</emphasis> menu item in
    3821                     this menu.
    3822                 </para>
    3823             </listitem>
    3824         </varlistentry>
    3825 
    3826         <varlistentry>
    3827             <term>
    3828                 <computeroutput>MouseIntegration</computeroutput>
    3829             </term>
    3830 
    3831             <listitem>
    3832                 <para>
    3833                     Do not show the
    3834                     <emphasis role="bold">MouseIntegration</emphasis> menu item in
    3835                     this menu.
    3836                 </para>
    3837             </listitem>
     3582          <term>
     3583            <literal>Keyboard</literal>
     3584          </term>
     3585
     3586          <listitem>
     3587            <para>
     3588              Do not show the <emphasis role="bold">Keyboard</emphasis>
     3589              menu item in this menu.
     3590            </para>
     3591          </listitem>
     3592        </varlistentry>
     3593
     3594        <varlistentry>
     3595          <term>
     3596            <literal>KeyboardSettings</literal>
     3597          </term>
     3598
     3599          <listitem>
     3600            <para>
     3601              Do not show the <emphasis role="bold">Keyboard
     3602              Settings...</emphasis> menu item in this menu.
     3603            </para>
     3604          </listitem>
     3605        </varlistentry>
     3606
     3607        <varlistentry>
     3608          <term>
     3609            <literal>SoftKeyboard</literal>
     3610          </term>
     3611
     3612          <listitem>
     3613            <para>
     3614              Do not show the <emphasis role="bold">Soft
     3615              Keyboard...</emphasis> menu item in this menu.
     3616            </para>
     3617          </listitem>
     3618        </varlistentry>
     3619
     3620        <varlistentry>
     3621          <term>
     3622            <literal>TypeCAD</literal>
     3623          </term>
     3624
     3625          <listitem>
     3626            <para>
     3627              Do not show the <emphasis role="bold">Insert
     3628              Ctrl-Alt-Del</emphasis> menu item in this menu.
     3629            </para>
     3630          </listitem>
     3631        </varlistentry>
     3632
     3633        <varlistentry>
     3634          <term>
     3635            <literal>TypeCABS</literal>
     3636          </term>
     3637
     3638          <listitem>
     3639            <para>
     3640              Do not show the <emphasis role="bold">Insert
     3641              Ctrl-Alt-Backspace</emphasis> menu item in this menu.
     3642            </para>
     3643          </listitem>
     3644        </varlistentry>
     3645
     3646        <varlistentry>
     3647          <term>
     3648            <literal>TypeCtrlBreak</literal>
     3649          </term>
     3650
     3651          <listitem>
     3652            <para>
     3653              Do not show the <emphasis role="bold">Insert
     3654              Ctrl-Break</emphasis> menu item in this menu.
     3655            </para>
     3656          </listitem>
     3657        </varlistentry>
     3658
     3659        <varlistentry>
     3660          <term>
     3661            <literal>TypeInsert</literal>
     3662          </term>
     3663
     3664          <listitem>
     3665            <para>
     3666              Do not show the <emphasis role="bold">Insert
     3667              Insert</emphasis> menu item in this menu.
     3668            </para>
     3669          </listitem>
     3670        </varlistentry>
     3671
     3672        <varlistentry>
     3673          <term>
     3674            <literal>TypePrintScreen</literal>
     3675          </term>
     3676
     3677          <listitem>
     3678            <para>
     3679              Do not show the <emphasis role="bold">Insert Print
     3680              Screen</emphasis> menu item in this menu.
     3681            </para>
     3682          </listitem>
     3683        </varlistentry>
     3684
     3685        <varlistentry>
     3686          <term>
     3687            <literal>TypeAltPrintScreen</literal>
     3688          </term>
     3689
     3690          <listitem>
     3691            <para>
     3692              Do not show the <emphasis role="bold">Insert Alt Print
     3693              Screen</emphasis> menu item in this menu.
     3694            </para>
     3695          </listitem>
     3696        </varlistentry>
     3697
     3698        <varlistentry>
     3699          <term>
     3700            <literal>TypeHostKeyCombo</literal>
     3701          </term>
     3702
     3703          <listitem>
     3704            <para>
     3705              Do not show the <emphasis role="bold">Insert Host Key
     3706              Combo</emphasis> menu item in this menu.
     3707            </para>
     3708          </listitem>
     3709        </varlistentry>
     3710
     3711        <varlistentry>
     3712          <term>
     3713            <literal>MouseIntegration</literal>
     3714          </term>
     3715
     3716          <listitem>
     3717            <para>
     3718              Do not show the
     3719              <emphasis role="bold">MouseIntegration</emphasis> menu
     3720              item in this menu.
     3721            </para>
     3722          </listitem>
    38383723        </varlistentry>
    38393724
    38403725      </variablelist>
    3841       <para>
    3842         This is a per-VM or global setting. Any combination of the above is
    3843         allowed. To restore the default behavior, use
    3844       </para>
    3845 
    3846       <screen>VBoxManage setextradata "VM name"|global GUI/RestrictedRuntimeInputMenuActions</screen>
     3726
     3727      <para>
     3728        This is a per-VM or global setting. Any combination of the above
     3729        is allowed. To restore the default behavior, use
     3730      </para>
     3731
     3732<screen>VBoxManage setextradata "VM name"|global GUI/RestrictedRuntimeInputMenuActions</screen>
    38473733
    38483734      <para>
     
    38543740
    38553741      <para>
    3856         where <computeroutput>OPTION</computeroutput> is one of the
    3857         following keywords to disable actions in the
     3742        where <literal>OPTION</literal> is one of the following keywords
     3743        to disable actions in the
    38583744        <emphasis role="bold">Devices</emphasis> menu:
    38593745      </para>
     
    38633749        <varlistentry>
    38643750          <term>
    3865             <computeroutput>All</computeroutput>
     3751            <literal>All</literal>
    38663752          </term>
    38673753
     
    38753761        <varlistentry>
    38763762          <term>
    3877             <computeroutput>HardDrives</computeroutput>
    3878           </term>
    3879 
    3880           <listitem>
    3881             <para>
    3882               Do not show the <emphasis role="bold">Hard Disks</emphasis> menu item in this menu.
    3883             </para>
    3884           </listitem>
    3885         </varlistentry>
    3886 
    3887         <varlistentry>
    3888           <term>
    3889             <computeroutput>OpticalDevices</computeroutput>
     3763            <literal>HardDrives</literal>
     3764          </term>
     3765
     3766          <listitem>
     3767            <para>
     3768              Do not show the <emphasis role="bold">Hard
     3769              Disks</emphasis> menu item in this menu.
     3770            </para>
     3771          </listitem>
     3772        </varlistentry>
     3773
     3774        <varlistentry>
     3775          <term>
     3776            <literal>OpticalDevices</literal>
    38903777          </term>
    38913778
     
    39003787        <varlistentry>
    39013788          <term>
    3902             <computeroutput>FloppyDevices</computeroutput>
     3789            <literal>FloppyDevices</literal>
    39033790          </term>
    39043791
     
    39133800        <varlistentry>
    39143801          <term>
    3915             <computeroutput>Audio</computeroutput>
    3916           </term>
    3917 
    3918           <listitem>
    3919             <para>
    3920                 Do not show the <emphasis role="bold">Audio</emphasis>
    3921                 menu item in this menu.
    3922             </para>
    3923           </listitem>
    3924         </varlistentry>
    3925 
    3926         <varlistentry>
    3927           <term>
    3928             <computeroutput>Network</computeroutput>
    3929           </term>
    3930 
    3931           <listitem>
    3932             <para>
    3933                 Do not show the <emphasis role="bold">Network</emphasis>
    3934                 menu item in this menu.
    3935             </para>
    3936           </listitem>
    3937         </varlistentry>
    3938 
    3939 
    3940         <varlistentry>
    3941           <term>
    3942             <computeroutput>NetworkSettings</computeroutput>
     3802            <literal>Audio</literal>
     3803          </term>
     3804
     3805          <listitem>
     3806            <para>
     3807              Do not show the <emphasis role="bold">Audio</emphasis>
     3808              menu item in this menu.
     3809            </para>
     3810          </listitem>
     3811        </varlistentry>
     3812
     3813        <varlistentry>
     3814          <term>
     3815            <literal>Network</literal>
     3816          </term>
     3817
     3818          <listitem>
     3819            <para>
     3820              Do not show the <emphasis role="bold">Network</emphasis>
     3821              menu item in this menu.
     3822            </para>
     3823          </listitem>
     3824        </varlistentry>
     3825
     3826        <varlistentry>
     3827          <term>
     3828            <literal>NetworkSettings</literal>
    39433829          </term>
    39443830
     
    39533839        <varlistentry>
    39543840          <term>
    3955             <computeroutput>USBDevices</computeroutput>
    3956           </term>
    3957 
    3958           <listitem>
    3959             <para>
    3960               Do not show the <emphasis role="bold">USB
    3961               </emphasis> menu item in this menu.
    3962             </para>
    3963           </listitem>
    3964         </varlistentry>
    3965 
    3966         <varlistentry>
    3967           <term>
    3968             <computeroutput>WebCams</computeroutput>
    3969           </term>
    3970 
    3971           <listitem>
    3972             <para>
    3973               Do not show the <emphasis role="bold">WebCams
    3974               </emphasis> menu item in this menu.
    3975             </para>
    3976           </listitem>
    3977         </varlistentry>
    3978 
    3979         <varlistentry>
    3980           <term>
    3981             <computeroutput>SharedFolders</computeroutput>
    3982           </term>
    3983 
    3984           <listitem>
    3985             <para>
    3986                 Do not show the <emphasis role="bold">Shared Folders</emphasis>
    3987                 menu item in this menu.
    3988             </para>
    3989           </listitem>
    3990         </varlistentry>
    3991 
    3992         <varlistentry>
    3993           <term>
    3994             <computeroutput>SharedFoldersSettings</computeroutput>
     3841            <literal>USBDevices</literal>
     3842          </term>
     3843
     3844          <listitem>
     3845            <para>
     3846              Do not show the <emphasis role="bold">USB </emphasis> menu
     3847              item in this menu.
     3848            </para>
     3849          </listitem>
     3850        </varlistentry>
     3851
     3852        <varlistentry>
     3853          <term>
     3854            <literal>WebCams</literal>
     3855          </term>
     3856
     3857          <listitem>
     3858            <para>
     3859              Do not show the <emphasis role="bold">WebCams </emphasis>
     3860              menu item in this menu.
     3861            </para>
     3862          </listitem>
     3863        </varlistentry>
     3864
     3865        <varlistentry>
     3866          <term>
     3867            <literal>SharedFolders</literal>
     3868          </term>
     3869
     3870          <listitem>
     3871            <para>
     3872              Do not show the <emphasis role="bold">Shared
     3873              Folders</emphasis> menu item in this menu.
     3874            </para>
     3875          </listitem>
     3876        </varlistentry>
     3877
     3878        <varlistentry>
     3879          <term>
     3880            <literal>SharedFoldersSettings</literal>
    39953881          </term>
    39963882
     
    40053891        <varlistentry>
    40063892          <term>
    4007             <computeroutput>SharedClipboard</computeroutput>
     3893            <literal>SharedClipboard</literal>
    40083894          </term>
    40093895
     
    40183904        <varlistentry>
    40193905          <term>
    4020             <computeroutput>DragAndDrop</computeroutput>
     3906            <literal>DragAndDrop</literal>
    40213907          </term>
    40223908
     
    40313917        <varlistentry>
    40323918          <term>
    4033             <computeroutput>InstallGuestTools</computeroutput>
     3919            <literal>InstallGuestTools</literal>
    40343920          </term>
    40353921
     
    40453931
    40463932      <para>
    4047         This is a per-VM or global setting. Any combination of the above is
    4048         allowed. To restore the default behavior, use
     3933        This is a per-VM or global or global setting. Any combination of
     3934        the above is allowed. To restore the default behavior, use
    40493935      </para>
    40503936
     
    40593945
    40603946      <para>
    4061         where <computeroutput>OPTION</computeroutput> is one of the
    4062         following keywords to disable actions in the
    4063         <emphasis>Debug</emphasis> menu, which is normally completely
    4064         disabled:
     3947        where <literal>OPTION</literal> is one of the following keywords
     3948        to disable actions in the <emphasis>Debug</emphasis> menu, which
     3949        is normally completely disabled:
    40653950      </para>
    40663951
     
    40693954        <varlistentry>
    40703955          <term>
    4071             <computeroutput>All</computeroutput>
     3956            <literal>All</literal>
    40723957          </term>
    40733958
     
    40813966        <varlistentry>
    40823967          <term>
    4083             <computeroutput>Statistics</computeroutput>
     3968            <literal>Statistics</literal>
    40843969          </term>
    40853970
     
    40953980        <varlistentry>
    40963981          <term>
    4097             <computeroutput>CommandLine</computeroutput>
     3982            <literal>CommandLine</literal>
    40983983          </term>
    40993984
     
    41083993        <varlistentry>
    41093994          <term>
    4110             <computeroutput>Logging</computeroutput>
     3995            <literal>Logging</literal>
    41113996          </term>
    41123997
     
    41224007        <varlistentry>
    41234008          <term>
    4124             <computeroutput>LogDialog</computeroutput>
     4009            <literal>LogDialog</literal>
    41254010          </term>
    41264011
     
    41354020        <varlistentry>
    41364021          <term>
    4137             <computeroutput>GuestControlConsole</computeroutput>
     4022            <literal>GuestControlConsole</literal>
    41384023          </term>
    41394024
     
    41494034
    41504035      <para>
    4151         This is a per-VM or global setting. Any combination of the above is
    4152         allowed. To restore the default behavior, use
     4036        This is a per-VM or global setting. Any combination of the above
     4037        is allowed. To restore the default behavior, use
    41534038      </para>
    41544039
     
    41634048
    41644049      <para>
    4165         where <computeroutput>OPTION</computeroutput> is one of the
    4166         following keywords to disable actions in the
    4167         <emphasis role="bold">Help</emphasis> menu, which is normally
    4168         completely disabled:
     4050        where <literal>OPTION</literal> is one of the following keywords
     4051        to disable actions in the <emphasis role="bold">Help</emphasis>
     4052        menu, which is normally completely disabled:
    41694053      </para>
    41704054
     
    41734057        <varlistentry>
    41744058          <term>
    4175             <computeroutput>All</computeroutput>
     4059            <literal>All</literal>
    41764060          </term>
    41774061
     
    41854069        <varlistentry>
    41864070          <term>
    4187             <computeroutput>Contents</computeroutput>
     4071            <literal>Contents</literal>
    41884072          </term>
    41894073
     
    41994083        <varlistentry>
    42004084          <term>
    4201             <computeroutput>WebSite</computeroutput>
     4085            <literal>WebSite</literal>
    42024086          </term>
    42034087
     
    42114095
    42124096        <varlistentry>
    4213             <term>
    4214                 <computeroutput>BugTracker</computeroutput>
    4215             </term>
    4216 
    4217             <listitem>
    4218                 <para>
    4219                     Do not show the
    4220                     <emphasis role="bold">VirtualBox Bug Tracker...</emphasis> menu item in
    4221                     this menu.
    4222                 </para>
    4223             </listitem>
    4224         </varlistentry>
    4225 
    4226         <varlistentry>
    4227             <term>
    4228                 <computeroutput>Forums</computeroutput>
    4229             </term>
    4230 
    4231             <listitem>
    4232                 <para>
    4233                     Do not show the
    4234                     <emphasis role="bold">VirtualBox Forums...</emphasis> menu item in this menu.
    4235                 </para>
    4236             </listitem>
    4237         </varlistentry>
    4238 
    4239         <varlistentry>
    4240             <term>
    4241                 <computeroutput>Oracle</computeroutput>
    4242             </term>
    4243 
    4244             <listitem>
    4245                 <para>
    4246                     Do not show the
    4247                     <emphasis role="bold">Oracle Web Site...</emphasis> menu item in this menu.
    4248                 </para>
    4249             </listitem>
    4250         </varlistentry>
    4251 
    4252         <varlistentry>
    4253           <term>
    4254             <computeroutput>About</computeroutput>
    4255           </term>
    4256 
    4257           <listitem>
    4258             <para>
    4259               Do not show the <emphasis role="bold">About VirtualBox...</emphasis>
    4260               menu item in this menu. Only for non-Mac OS X hosts.
     4097          <term>
     4098            <literal>BugTracker</literal>
     4099          </term>
     4100
     4101          <listitem>
     4102            <para>
     4103              Do not show the <emphasis role="bold">VirtualBox Bug
     4104              Tracker...</emphasis> menu item in this menu.
     4105            </para>
     4106          </listitem>
     4107        </varlistentry>
     4108
     4109        <varlistentry>
     4110          <term>
     4111            <literal>Forums</literal>
     4112          </term>
     4113
     4114          <listitem>
     4115            <para>
     4116              Do not show the <emphasis role="bold">VirtualBox
     4117              Forums...</emphasis> menu item in this menu.
     4118            </para>
     4119          </listitem>
     4120        </varlistentry>
     4121
     4122        <varlistentry>
     4123          <term>
     4124            <literal>Oracle</literal>
     4125          </term>
     4126
     4127          <listitem>
     4128            <para>
     4129              Do not show the <emphasis role="bold">Oracle Web
     4130              Site...</emphasis> menu item in this menu.
     4131            </para>
     4132          </listitem>
     4133        </varlistentry>
     4134
     4135        <varlistentry>
     4136          <term>
     4137            <literal>About</literal>
     4138          </term>
     4139
     4140          <listitem>
     4141            <para>
     4142              Do not show the <emphasis role="bold">About
     4143              VirtualBox...</emphasis> menu item in this menu. Only for
     4144              non-Mac OS X hosts.
    42614145            </para>
    42624146          </listitem>
     
    42664150
    42674151      <para>
    4268         This is a per-VM or global setting. Any combination of the above is
    4269         allowed. To restore the default behavior, use
     4152        This is a per-VM or global setting. Any combination of the above
     4153        is allowed. To restore the default behavior, use
    42704154      </para>
    42714155
     
    42854169
    42864170      <para>
    4287         where <computeroutput>OPTION</computeroutput> is one of the
    4288         following keywords:
     4171        where <literal>OPTION</literal> is one of the following
     4172        keywords:
    42894173      </para>
    42904174
     
    42934177        <varlistentry>
    42944178          <term>
    4295             <computeroutput>HardDisks</computeroutput>
     4179            <literal>HardDisks</literal>
    42964180          </term>
    42974181
     
    43074191        <varlistentry>
    43084192          <term>
    4309             <computeroutput>OpticalDisks</computeroutput>
     4193            <literal>OpticalDisks</literal>
    43104194          </term>
    43114195
     
    43214205        <varlistentry>
    43224206          <term>
    4323             <computeroutput>FloppyDisks</computeroutput>
     4207            <literal>FloppyDisks</literal>
    43244208          </term>
    43254209
     
    43354219        <varlistentry>
    43364220          <term>
    4337             <computeroutput>Network</computeroutput>
     4221            <literal>Network</literal>
    43384222          </term>
    43394223
     
    43504234        <varlistentry>
    43514235          <term>
    4352             <computeroutput>USB</computeroutput>
     4236            <literal>USB</literal>
    43534237          </term>
    43544238
     
    43624246        <varlistentry>
    43634247          <term>
    4364             <computeroutput>SharedFolders</computeroutput>
     4248            <literal>SharedFolders</literal>
    43654249          </term>
    43664250
     
    43744258        <varlistentry>
    43754259          <term>
    4376             <computeroutput>Capture</computeroutput>
     4260            <literal>Capture</literal>
    43774261          </term>
    43784262
     
    43864270        <varlistentry>
    43874271          <term>
    4388             <computeroutput>Features</computeroutput>
     4272            <literal>Features</literal>
    43894273          </term>
    43904274
     
    43984282        <varlistentry>
    43994283          <term>
    4400             <computeroutput>Mouse</computeroutput>
     4284            <literal>Mouse</literal>
    44014285          </term>
    44024286
     
    44104294        <varlistentry>
    44114295          <term>
    4412             <computeroutput>Keyboard</computeroutput>
     4296            <literal>Keyboard</literal>
    44134297          </term>
    44144298
     
    44234307
    44244308      <para>
    4425         This is a per-VM or global setting. Any combination of the above is
    4426         allowed. If all options are specified, no icons are displayed in
    4427         the status bar of the VM window. To restore the default
     4309        This is a per-VM or global setting. Any combination of the above
     4310        is allowed. If all options are specified, no icons are displayed
     4311        in the status bar of the VM window. To restore the default
    44284312        behavior, use
    44294313      </para>
     
    44414325      </para>
    44424326
    4443 <screen>VBoxManage setextradata "VM name" GUI/RestrictedVisualStates OPTION[,OPTION...]</screen>
    4444 
    4445       <para>
    4446         where <computeroutput>OPTION</computeroutput> is one of the
    4447         following keywords:
     4327<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> GUI/RestrictedVisualStates <replaceable>property</replaceable>[,<replaceable>property</replaceable>...]</screen>
     4328
     4329      <para>
     4330        <replaceable>property</replaceable> is one of the following:
    44484331      </para>
    44494332
     
    44524335        <varlistentry>
    44534336          <term>
    4454             <computeroutput>Fullscreen</computeroutput>
     4337            <literal>Fullscreen</literal>
    44554338          </term>
    44564339
     
    44644347        <varlistentry>
    44654348          <term>
    4466             <computeroutput>Seamless</computeroutput>
     4349            <literal>Seamless</literal>
    44674350          </term>
    44684351
     
    44764359        <varlistentry>
    44774360          <term>
    4478             <computeroutput>Scale</computeroutput>
     4361            <literal>Scale</literal>
    44794362          </term>
    44804363
     
    44894372
    44904373      <para>
    4491         This is a per-VM setting. Any combination of the above is
    4492         allowed. To restore the default behavior, use
    4493       </para>
    4494 
    4495 <screen>VBoxManage setextradata "VM name" GUI/RestrictedVisualStates</screen>
     4374        This is a per-VM setting. You can specify any combination of
     4375        properties. To restore the default behavior, use the following
     4376        command:
     4377      </para>
     4378
     4379<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> GUI/RestrictedVisualStates</screen>
    44964380
    44974381    </sect2>
     
    45124396      </para>
    45134397
    4514 <screen>VBoxManage setextradata global GUI/Input/MachineShortcuts "FullscreenMode=F,...."</screen>
     4398<screen>$ VBoxManage setextradata global GUI/Input/MachineShortcuts "FullscreenMode=F,...."</screen>
    45154399
    45164400      <para>
     
    45394423            <row>
    45404424              <entry><para>
    4541                   <computeroutput>TakeSnapshot</computeroutput>
     4425                  <literal>TakeSnapshot</literal>
    45424426                </para></entry>
    45434427              <entry><para>
     
    45504434            <row>
    45514435              <entry><para>
    4552                   <computeroutput>TakeScreenshot</computeroutput>
     4436                  <literal>TakeScreenshot</literal>
    45534437                </para></entry>
    45544438              <entry><para>
     
    45614445            <row>
    45624446              <entry><para>
    4563                   <computeroutput>MouseIntegration</computeroutput>
     4447                  <literal>MouseIntegration</literal>
    45644448                </para></entry>
    45654449              <entry><para>
     
    45724456            <row>
    45734457              <entry><para>
    4574                   <computeroutput>TypeCAD</computeroutput>
     4458                  <literal>TypeCAD</literal>
    45754459                </para></entry>
    45764460              <entry><para>
     
    45834467            <row>
    45844468              <entry><para>
    4585                   <computeroutput>TypeCABS</computeroutput>
     4469                  <literal>TypeCABS</literal>
    45864470                </para></entry>
    45874471              <entry><para>
     
    45944478            <row>
    45954479              <entry><para>
    4596                   <computeroutput>Pause</computeroutput>
     4480                  <literal>Pause</literal>
    45974481                </para></entry>
    45984482              <entry><para>
     
    46054489            <row>
    46064490              <entry><para>
    4607                   <computeroutput>Reset</computeroutput>
     4491                  <literal>Reset</literal>
    46084492                </para></entry>
    46094493              <entry><para>
     
    46144498            <row>
    46154499              <entry><para>
    4616                   <computeroutput>SaveState</computeroutput>
     4500                  <literal>SaveState</literal>
    46174501                </para></entry>
    46184502              <entry><para></para></entry>
     
    46234507            <row>
    46244508              <entry><para>
    4625                   <computeroutput>Shutdown</computeroutput>
     4509                  <literal>Shutdown</literal>
    46264510                </para></entry>
    46274511              <entry><para>
     
    46344518            <row>
    46354519              <entry><para>
    4636                   <computeroutput>PowerOff</computeroutput>
     4520                  <literal>PowerOff</literal>
    46374521                </para></entry>
    46384522              <entry><para></para></entry>
     
    46434527            <row>
    46444528              <entry><para>
    4645                   <computeroutput>Close</computeroutput>
     4529                  <literal>Close</literal>
    46464530                </para></entry>
    46474531              <entry><para>
     
    46544538            <row>
    46554539              <entry><para>
    4656                   <computeroutput>FullscreenMode</computeroutput>
     4540                  <literal>FullscreenMode</literal>
    46574541                </para></entry>
    46584542              <entry><para>
     
    46654549            <row>
    46664550              <entry><para>
    4667                   <computeroutput>SeamlessMode</computeroutput>
     4551                  <literal>SeamlessMode</literal>
    46684552                </para></entry>
    46694553              <entry><para>
     
    46764560            <row>
    46774561              <entry><para>
    4678                   <computeroutput>ScaleMode</computeroutput>
     4562                  <literal>ScaleMode</literal>
    46794563                </para></entry>
    46804564              <entry><para>
     
    46874571            <row>
    46884572              <entry><para>
    4689                   <computeroutput>GuestAutoResize</computeroutput>
     4573                  <literal>GuestAutoResize</literal>
    46904574                </para></entry>
    46914575              <entry><para>
     
    46984582            <row>
    46994583              <entry><para>
    4700                   <computeroutput>WindowAdjust</computeroutput>
     4584                  <literal>WindowAdjust</literal>
    47014585                </para></entry>
    47024586              <entry><para>
     
    47094593            <row>
    47104594              <entry><para>
    4711                   <computeroutput>PopupMenu</computeroutput>
     4595                  <literal>PopupMenu</literal>
    47124596                </para></entry>
    47134597              <entry><para>
     
    47214605            <row>
    47224606              <entry><para>
    4723                   <computeroutput>SettingsDialog</computeroutput>
     4607                  <literal>SettingsDialog</literal>
    47244608                </para></entry>
    47254609              <entry><para>
     
    47324616            <row>
    47334617              <entry><para>
    4734                   <computeroutput>InformationDialog</computeroutput>
     4618                  <literal>InformationDialog</literal>
    47354619                </para></entry>
    47364620              <entry><para>
     
    47434627            <row>
    47444628              <entry><para>
    4745                   <computeroutput>NetworkAdaptersDialog</computeroutput>
     4629                  <literal>NetworkAdaptersDialog</literal>
    47464630                </para></entry>
    47474631              <entry><para></para></entry>
     
    47524636            <row>
    47534637              <entry><para>
    4754                   <computeroutput>SharedFoldersDialog</computeroutput>
     4638                  <literal>SharedFoldersDialog</literal>
    47554639                </para></entry>
    47564640              <entry><para></para></entry>
     
    47614645            <row>
    47624646              <entry><para>
    4763                   <computeroutput>InstallGuestAdditions</computeroutput>
     4647                  <literal>InstallGuestAdditions</literal>
    47644648                </para></entry>
    47654649              <entry><para>
     
    47794663      </para>
    47804664
    4781 <screen>VBoxManage setextradata global GUI/Input/MachineShortcuts "FullscreenMode=None,SeamlessMode=None"</screen>
     4665<screen>$ VBoxManage setextradata global GUI/Input/MachineShortcuts "FullscreenMode=None,SeamlessMode=None"</screen>
    47824666
    47834667    </sect2>
     
    47924676      </para>
    47934677
    4794 <screen>VBoxManage setextradata "VM name" GUI/RestrictedCloseActions OPTION[,OPTION...]</screen>
    4795 
    4796       <para>
    4797         where <computeroutput>OPTION</computeroutput> is one of the
    4798         following keywords:
     4678<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> GUI/RestrictedCloseActions <replaceable>property</replaceable>[,<replaceable>property</replaceable>...]</screen>
     4679
     4680      <para>
     4681        <replaceable>property</replaceable> is one of the following:
    47994682      </para>
    48004683
     
    48034686        <varlistentry>
    48044687          <term>
    4805             <computeroutput>SaveState</computeroutput>
     4688            <literal>SaveState</literal>
    48064689          </term>
    48074690
     
    48164699        <varlistentry>
    48174700          <term>
    4818             <computeroutput>Shutdown</computeroutput>
     4701            <literal>Shutdown</literal>
    48194702          </term>
    48204703
     
    48294712        <varlistentry>
    48304713          <term>
    4831             <computeroutput>PowerOff</computeroutput>
     4714            <literal>PowerOff</literal>
    48324715          </term>
    48334716
     
    48414724        <varlistentry>
    48424725          <term>
    4843             <computeroutput>PowerOffRestoringSnapshot</computeroutput>
     4726            <literal>PowerOffRestoringSnapshot</literal>
    48444727          </term>
    48454728
     
    48544737        <varlistentry>
    48554738          <term>
    4856             <computeroutput>Detach</computeroutput>
     4739            <literal>Detach</literal>
    48574740          </term>
    48584741
     
    48684751
    48694752      <para>
    4870         This is a per-VM setting. Any combination of the above is
    4871         allowed. If all options are specified, the VM cannot be shut
    4872         down at all.
     4753        This is a per-VM setting. You can specify any combination of
     4754        properties. If all properties are specified, the VM cannot be
     4755        shut down.
    48734756      </para>
    48744757
     
    48864769      </para>
    48874770
    4888 <screen>VBoxManage setextradata "VM name" GUI/DefaultCloseAction ACTION</screen>
    4889 
    4890       <para>
    4891         where <computeroutput>ACTION</computeroutput> is one of the
    4892         following keywords:
     4771<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> GUI/DefaultCloseAction <replaceable>action</replaceable></screen>
     4772
     4773      <para>
     4774        <replaceable>action</replaceable> is one of the following:
    48934775      </para>
    48944776
     
    48974779        <varlistentry>
    48984780          <term>
    4899             <computeroutput>SaveState</computeroutput>
     4781            <literal>SaveState</literal>
    49004782          </term>
    49014783
     
    49094791        <varlistentry>
    49104792          <term>
    4911             <computeroutput>Shutdown</computeroutput>
     4793            <literal>Shutdown</literal>
    49124794          </term>
    49134795
     
    49224804        <varlistentry>
    49234805          <term>
    4924             <computeroutput>PowerOff</computeroutput>
     4806            <literal>PowerOff</literal>
    49254807          </term>
    49264808
     
    49344816        <varlistentry>
    49354817          <term>
    4936             <computeroutput>PowerOffRestoringSnapshot</computeroutput>
     4818            <literal>PowerOffRestoringSnapshot</literal>
    49374819          </term>
    49384820
     
    49474829        <varlistentry>
    49484830          <term>
    4949             <computeroutput>Detach</computeroutput>
     4831            <literal>Detach</literal>
    49504832          </term>
    49514833
     
    49604842
    49614843      <para>
    4962         This is a per-VM setting. Any combination of the above is
    4963         allowed. If all options are specified, the VM cannot be shut
    4964         down at all.
     4844        This is a per-VM setting. You can specify any combination of
     4845        properties. If all properties are specified, the VM cannot be
     4846        shut down.
    49654847      </para>
    49664848
     
    49824864      </para>
    49834865
    4984 <screen>VBoxManage setextradata "VM name" GUI/GuruMeditationHandler MODE</screen>
    4985 
    4986       <para>
    4987         where <computeroutput>MODE</computeroutput> is one of the
    4988         following keywords:
     4866<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> GUI/GuruMeditationHandler <replaceable>mode</replaceable></screen>
     4867
     4868      <para>
     4869        <replaceable>mode</replaceable> is one of the following:
    49894870      </para>
    49904871
     
    49934874        <varlistentry>
    49944875          <term>
    4995             <computeroutput>Default</computeroutput>
     4876            <literal>Default</literal>
    49964877          </term>
    49974878
     
    50064887        <varlistentry>
    50074888          <term>
    5008             <computeroutput>PowerOff</computeroutput>
     4889            <literal>PowerOff</literal>
    50094890          </term>
    50104891
     
    50204901        <varlistentry>
    50214902          <term>
    5022             <computeroutput>Ignore</computeroutput>
     4903            <literal>Ignore</literal>
    50234904          </term>
    50244905
     
    50624943      </para>
    50634944
    5064 <screen>VBoxManage setextradata "VM name" GUI/MouseCapturePolicy MODE</screen>
    5065 
    5066       <para>
    5067         where <computeroutput>MODE</computeroutput> is one of the
    5068         following keywords:
     4945<screen>VBoxManage setextradata <replaceable>VM-name</replaceable> GUI/MouseCapturePolicy <replaceable>mode</replaceable></screen>
     4946
     4947      <para>
     4948        <replaceable>mode</replaceable> is one of the following:
    50694949      </para>
    50704950
     
    50734953        <varlistentry>
    50744954          <term>
    5075             <computeroutput>Default</computeroutput>
     4955            <literal>Default</literal>
    50764956          </term>
    50774957
     
    50854965        <varlistentry>
    50864966          <term>
    5087             <computeroutput>HostComboOnly</computeroutput>
     4967            <literal>HostComboOnly</literal>
    50884968          </term>
    50894969
     
    50974977        <varlistentry>
    50984978          <term>
    5099             <computeroutput>Disabled</computeroutput>
     4979            <literal>Disabled</literal>
    51004980          </term>
    51014981
     
    51465026    <sect2 id="restrict-network-attachments">
    51475027
    5148       <title>Removing Certain Modes of Networking from the GUI</title>
    5149 
    5150       <para>
    5151        It is possible to remove  networking modes from
    5152        &product-name; GUI. To achieve this:
    5153       </para>
    5154 
    5155 <screen>VBoxManage setextradata global GUI/RestrictedNetworkAttachmentTypes OPTION[,OPTION...]</screen>
    5156 
    5157       <para>
    5158         where <computeroutput>OPTION</computeroutput> is one of the
    5159         following keywords:
     5028      <title>Removing Certain Modes of Networking From the GUI</title>
     5029
     5030      <para>
     5031        It is possible to remove networking modes from &product-name;
     5032        GUI. To do this, use the following command:
     5033      </para>
     5034
     5035<screen>VBoxManage setextradata global GUI/RestrictedNetworkAttachmentTypes <replaceable>property</replaceable>[,<replaceable>property</replaceable>...]</screen>
     5036
     5037      <para>
     5038        <replaceable>property</replaceable> is one of the following:
    51605039      </para>
    51615040
     
    51645043        <varlistentry>
    51655044          <term>
    5166             <computeroutput>NAT</computeroutput>
     5045            <literal>NAT</literal>
    51675046          </term>
    51685047
     
    51775056        <varlistentry>
    51785057          <term>
    5179             <computeroutput>NATNetwork</computeroutput>
    5180           </term>
    5181 
    5182           <listitem>
    5183             <para>
    5184               Remove the <emphasis role="bold">NAT network</emphasis> option
    5185               from the GUI.
    5186             </para>
    5187           </listitem>
    5188         </varlistentry>
    5189 
    5190         <varlistentry>
    5191           <term>
    5192             <computeroutput>BridgetAdapter</computeroutput>
    5193           </term>
    5194 
    5195           <listitem>
    5196             <para>
    5197               Remove the <emphasis role="bold">Bridged networking</emphasis> option
    5198               from the GUI.
    5199             </para>
    5200           </listitem>
    5201         </varlistentry>
    5202 
    5203         <varlistentry>
    5204           <term>
    5205             <computeroutput>InternalNetwork</computeroutput>
    5206           </term>
    5207 
    5208           <listitem>
    5209             <para>
    5210               Remove the <emphasis role="bold">Internal networking</emphasis> option
    5211               from the GUI.
    5212             </para>
    5213           </listitem>
    5214         </varlistentry>
    5215 
    5216         <varlistentry>
    5217           <term>
    5218             <computeroutput>HostOnlyAdapter</computeroutput>
    5219           </term>
    5220 
    5221           <listitem>
    5222             <para>
    5223               Remove the <emphasis role="bold">Host Only networking</emphasis> option
    5224               from the GUI.
    5225             </para>
    5226           </listitem>
    5227         </varlistentry>
    5228 
    5229         <varlistentry>
    5230           <term>
    5231             <computeroutput>GenericDriver</computeroutput>
    5232           </term>
    5233 
    5234           <listitem>
    5235             <para>
    5236               Remove the <emphasis role="bold">Generic networking</emphasis> option
    5237               from the GUI.
     5058            <literal>NATNetwork</literal>
     5059          </term>
     5060
     5061          <listitem>
     5062            <para>
     5063              Remove the <emphasis role="bold">NAT network</emphasis>
     5064              option from the GUI.
     5065            </para>
     5066          </listitem>
     5067        </varlistentry>
     5068
     5069        <varlistentry>
     5070          <term>
     5071            <literal>BridgedAdapter</literal>
     5072          </term>
     5073
     5074          <listitem>
     5075            <para>
     5076              Remove the <emphasis role="bold">Bridged
     5077              networking</emphasis> option from the GUI.
     5078            </para>
     5079          </listitem>
     5080        </varlistentry>
     5081
     5082        <varlistentry>
     5083          <term>
     5084            <literal>InternalNetwork</literal>
     5085          </term>
     5086
     5087          <listitem>
     5088            <para>
     5089              Remove the <emphasis role="bold">Internal
     5090              networking</emphasis> option from the GUI.
     5091            </para>
     5092          </listitem>
     5093        </varlistentry>
     5094
     5095        <varlistentry>
     5096          <term>
     5097            <literal>HostOnlyAdapter</literal>
     5098          </term>
     5099
     5100          <listitem>
     5101            <para>
     5102              Remove the <emphasis role="bold">Host Only
     5103              networking</emphasis> option from the GUI.
     5104            </para>
     5105          </listitem>
     5106        </varlistentry>
     5107
     5108        <varlistentry>
     5109          <term>
     5110            <literal>GenericDriver</literal>
     5111          </term>
     5112
     5113          <listitem>
     5114            <para>
     5115              Remove the <emphasis role="bold">Generic
     5116              networking</emphasis> option from the GUI.
    52385117            </para>
    52395118          </listitem>
     
    52425121      </variablelist>
    52435122
    5244 
    5245       <para>
    5246         This is a global setting. Any combination of the above is
    5247         allowed. To restore the default behavior, use
     5123      <para>
     5124        This is a global setting. You can specify any combination of
     5125        properties. To restore the default behavior, use the following
     5126        command:
    52485127      </para>
    52495128
    52505129<screen>VBoxManage setextradata global GUI/RestrictedNetworkAttachmentTypes</screen>
    52515130
    5252 
    52535131    </sect2>
     5132
    52545133  </sect1>
    52555134
     
    52595138
    52605139    <para>
    5261       The &product-name; web service,
    5262       <computeroutput>vboxwebsrv</computeroutput>, is used for
    5263       controlling &product-name; remotely. It is documented in detail in
    5264       the &product-name; Software Development Kit (SDK). See
    5265       <xref linkend="VirtualBoxAPI" />. As the client base using this
    5266       interface is growing, we added start scripts for the various
    5267       operation systems we support. The following sections describe how
    5268       to use them. The &product-name; web service is never started
    5269       automatically as a result of a standard installation.
     5140      The &product-name; web service, <command>vboxwebsrv</command>, is
     5141      used for controlling &product-name; remotely. It is documented in
     5142      detail in the &product-name; Software Development Kit (SDK). See
     5143      <xref linkend="VirtualBoxAPI" />. Web service start scripts are
     5144      available for supported host operating systems. The following
     5145      sections describe how to use the scripts. The &product-name; web
     5146      service is never started automatically as a result of a standard
     5147      installation.
    52705148    </para>
    52715149
     
    52775155        On Linux, the web service can be automatically started during
    52785156        host boot by adding appropriate parameters to the file
    5279         <computeroutput>/etc/default/virtualbox</computeroutput>. There
    5280         is one mandatory parameter,
    5281         <computeroutput>VBOXWEB_USER</computeroutput>, which must be set
    5282         to the user which will later start the VMs. The parameters in
    5283         the following table all start with the
    5284         <computeroutput>VBOXWEB_</computeroutput> prefix string. For
    5285         example: <computeroutput>VBOXWEB_HOST</computeroutput> and
    5286         <computeroutput>VBOXWEB_PORT</computeroutput>.
     5157        <filename>/etc/default/virtualbox</filename>. There is one
     5158        mandatory parameter, <literal>VBOXWEB_USER</literal>, which must
     5159        be set to the user which will later start the VMs. The
     5160        parameters in the following table all start with the
     5161        <literal>VBOXWEB_</literal> prefix string. For example:
     5162        <literal>VBOXWEB_HOST</literal> and
     5163        <literal>VBOXWEB_PORT</literal>.
    52875164      </para>
    52885165
     
    53065183            <row>
    53075184              <entry><para>
    5308                   <computeroutput>USER</computeroutput>
     5185                  <literal>USER</literal>
    53095186                </para></entry>
    53105187              <entry><para>
     
    53155192            <row>
    53165193              <entry><para>
    5317                   <computeroutput>HOST</computeroutput>
     5194                  <literal>HOST</literal>
    53185195                </para></entry>
    53195196              <entry><para>
     
    53265203            <row>
    53275204              <entry><para>
    5328                   <computeroutput>PORT</computeroutput>
     5205                  <literal>PORT</literal>
    53295206                </para></entry>
    53305207              <entry><para>
     
    53375214            <row>
    53385215              <entry><para>
    5339                   <computeroutput>SSL_KEYFILE</computeroutput>
     5216                  <literal>SSL_KEYFILE</literal>
    53405217                </para></entry>
    53415218              <entry><para>
     
    53465223            <row>
    53475224              <entry><para>
    5348                   <computeroutput>SSL_PASSWORDFILE</computeroutput>
     5225                  <literal>SSL_PASSWORDFILE</literal>
    53495226                </para></entry>
    53505227              <entry><para>
     
    53555232            <row>
    53565233              <entry><para>
    5357                   <computeroutput>SSL_CACERT</computeroutput>
     5234                  <literal>SSL_CACERT</literal>
    53585235                </para></entry>
    53595236              <entry><para>
     
    53645241            <row>
    53655242              <entry><para>
    5366                   <computeroutput>SSL_CAPATH</computeroutput>
     5243                  <literal>SSL_CAPATH</literal>
    53675244                </para></entry>
    53685245              <entry><para>
     
    53735250            <row>
    53745251              <entry><para>
    5375                   <computeroutput>SSL_DHFILE</computeroutput>
     5252                  <literal>SSL_DHFILE</literal>
    53765253                </para></entry>
    53775254              <entry><para>
     
    53825259            <row>
    53835260              <entry><para>
    5384                   <computeroutput>SSL_RANDFILE</computeroutput>
     5261                  <literal>SSL_RANDFILE</literal>
    53855262                </para></entry>
    53865263              <entry><para>
     
    53915268            <row>
    53925269              <entry><para>
    5393                   <computeroutput>TIMEOUT</computeroutput>
     5270                  <literal>TIMEOUT</literal>
    53945271                </para></entry>
    53955272              <entry><para>
     
    54025279            <row>
    54035280              <entry><para>
    5404                   <computeroutput>CHECK_INTERVAL</computeroutput>
     5281                  <literal>CHECK_INTERVAL</literal>
    54055282                </para></entry>
    54065283              <entry><para>
     
    54135290            <row>
    54145291              <entry><para>
    5415                   <computeroutput>THREADS</computeroutput>
     5292                  <literal>THREADS</literal>
    54165293                </para></entry>
    54175294              <entry><para>
     
    54245301            <row>
    54255302              <entry><para>
    5426                   <computeroutput>KEEPALIVE</computeroutput>
     5303                  <literal>KEEPALIVE</literal>
    54275304                </para></entry>
    54285305              <entry><para>
     
    54365313            <row>
    54375314              <entry><para>
    5438                   <computeroutput>ROTATE</computeroutput>
     5315                  <literal>ROTATE</literal>
    54395316                </para></entry>
    54405317              <entry><para>
     
    54475324            <row>
    54485325              <entry><para>
    5449                   <computeroutput>LOGSIZE</computeroutput>
     5326                  <literal>LOGSIZE</literal>
    54505327                </para></entry>
    54515328              <entry><para>
     
    54585335            <row>
    54595336              <entry><para>
    5460                   <computeroutput>LOGINTERVAL</computeroutput>
     5337                  <literal>LOGINTERVAL</literal>
    54615338                </para></entry>
    54625339              <entry><para>
     
    54735350
    54745351      <para>
    5475         Setting the parameter
    5476         <computeroutput>SSL_KEYFILE</computeroutput> enables the SSL/TLS
    5477         support. Using encryption is strongly encouraged, as otherwise
    5478         everything, including passwords, is transferred in clear text.
     5352        Setting the parameter <literal>SSL_KEYFILE</literal> enables the
     5353        SSL/TLS support. Using encryption is strongly encouraged, as
     5354        otherwise everything, including passwords, is transferred in
     5355        clear text.
    54795356      </para>
    54805357
     
    54975374
    54985375      <para>
    5499         <xref linkend="table-websrv-config-params"/> showing the
     5376        The table in <xref linkend="vboxwebsrv-linux"/> showing the
    55005377        parameter names and defaults also applies for Oracle Solaris.
    55015378        The parameter names must be changed to lowercase and a prefix of
    5502         <computeroutput>config/</computeroutput> has to be added. For
    5503         example: <computeroutput>config/user</computeroutput> or
    5504         <computeroutput>config/ssl_keyfile</computeroutput>. If you make
    5505         any change, do not forget to run the following command to put
    5506         the changes into effect immediately:
     5379        <literal>config/</literal> has to be added. For example:
     5380        <literal>config/user</literal> or
     5381        <literal>config/ssl_keyfile</literal>. If you make any change,
     5382        do not forget to run the following command to put the changes
     5383        into effect immediately:
    55075384      </para>
    55085385
     
    55385415        On Mac OS X, launchd is used to start the &product-name;
    55395416        webservice. An example configuration file can be found in
    5540         <computeroutput>$HOME/Library/LaunchAgents/org.virtualbox.vboxwebsrv.plist</computeroutput>.
    5541         It can be enabled by changing the
    5542         <computeroutput>Disabled</computeroutput> key from
    5543         <computeroutput>true</computeroutput> to
    5544         <computeroutput>false</computeroutput>. To manually start the
    5545         service use the following command:
     5417        <filename>$HOME/Library/LaunchAgents/org.virtualbox.vboxwebsrv.plist</filename>.
     5418        It can be enabled by changing the <literal>Disabled</literal>
     5419        key from <literal>true</literal> to <literal>false</literal>. To
     5420        manually start the service use the following command:
    55465421      </para>
    55475422
     
    55555430      <para>
    55565431        <ulink
    5557       url="https://developer.apple.com/library/mac/documentation/MacOSX/Conceptual/BPSystemStartup/Chapters/CreatingLaunchdJobs.html">https://developer.apple.com/library/mac/documentation/MacOSX/Conceptual/BPSystemStartup/Chapters/CreatingLaunchdJobs.html</ulink>.
     5432      url="https://developer.apple.com/library/mac/documentation/MacOSX/Conceptual/BPSystemStartup/Chapters/CreatingLaunchdJobs.html" />.
    55585433      </para>
    55595434
     
    55685443    <para>
    55695444      The memory ballooning service, formerly known as
    5570       <computeroutput>VBoxBalloonCtrl</computeroutput>, was renamed to
    5571       VBoxWatchdog. This service now incorporates the following host
    5572       services that are meant to be run in a server environment:
     5445      <command>VBoxBalloonCtrl</command>, was renamed to VBoxWatchdog.
     5446      This service now incorporates the following host services that are
     5447      meant to be run in a server environment:
    55735448    </para>
    55745449
     
    57675642        <listitem>
    57685643          <para>
    5769             <computeroutput>none</computeroutput>. This has no effect.
     5644            <literal>none</literal>. This has no effect.
    57705645          </para>
    57715646        </listitem>
     
    57735648        <listitem>
    57745649          <para>
    5775             <computeroutput>pause</computeroutput>. Pauses the execution
    5776             of a VM.
     5650            <literal>pause</literal>. Pauses the execution of a VM.
    57775651          </para>
    57785652        </listitem>
     
    57805654        <listitem>
    57815655          <para>
    5782             <computeroutput>poweroff</computeroutput>. Shuts down the VM
    5783             by pressing the virtual power button. The VM will not have
    5784             the chance of saving any data or veto the shutdown process.
     5656            <literal>poweroff</literal>. Shuts down the VM by pressing
     5657            the virtual power button. The VM will not have the chance of
     5658            saving any data or veto the shutdown process.
    57855659          </para>
    57865660        </listitem>
     
    57885662        <listitem>
    57895663          <para>
    5790             <computeroutput>save</computeroutput>. Saves the current
    5791             machine state and powers off the VM afterwards. If saving
    5792             the machine state fails the VM will be paused.
     5664            <literal>save</literal>. Saves the current machine state and
     5665            powers off the VM afterwards. If saving the machine state
     5666            fails the VM will be paused.
    57935667          </para>
    57945668        </listitem>
     
    57965670        <listitem>
    57975671          <para>
    5798             <computeroutput>shutdown</computeroutput>. Shuts down the VM
    5799             in a gentle way by sending an
    5800             <computeroutput>ACPI</computeroutput> shutdown event to the
    5801             VM's operating system. The OS then has the chance of doing a
    5802             clean shutdown.
     5672            <literal>shutdown</literal>. Shuts down the VM in a gentle
     5673            way by sending an <literal>ACPI</literal> shutdown event to
     5674            the VM's operating system. The OS then has the chance of
     5675            doing a clean shutdown.
    58035676          </para>
    58045677        </listitem>
     
    58155688        For more advanced options and parameters like verbose logging
    58165689        check the built-in command line help accessible with
    5817         <computeroutput>--help</computeroutput>.
     5690        <option>--help</option>.
    58185691      </para>
    58195692
     
    58275700        On Linux, the watchdog service can be automatically started
    58285701        during host boot by adding appropriate parameters to the file
    5829         <computeroutput>/etc/default/virtualbox</computeroutput>. There
    5830         is one mandatory parameter,
    5831         <computeroutput>VBOXWATCHDOG_USER</computeroutput>, which must
    5832         be set to the user which will later start the VMs. For backward
    5833         compatibility you can also specify
    5834         <computeroutput>VBOXBALLOONCTRL_USER</computeroutput>.
     5702        <filename>/etc/default/virtualbox</filename>. There is one
     5703        mandatory parameter, <literal>VBOXWATCHDOG_USER</literal>, which
     5704        must be set to the user which will later start the VMs. For
     5705        backward compatibility you can also specify
     5706        <literal>VBOXBALLOONCTRL_USER</literal>.
    58355707      </para>
    58365708
    58375709      <para>
    58385710        The parameters in the following table all start with the
    5839         <computeroutput>VBOXWATCHDOG_</computeroutput> prefix string.
    5840         For example:
    5841         <computeroutput>VBOXWATCHDOG_BALLOON_INTERVAL</computeroutput>
    5842         and <computeroutput>VBOXWATCHDOG_LOGSIZE</computeroutput>.
    5843         Legacy parameters such as
    5844         <computeroutput>VBOXBALLOONCTRL_INTERVAL</computeroutput> can
    5845         still be used.
     5711        <literal>VBOXWATCHDOG_</literal> prefix string. For example:
     5712        <literal>VBOXWATCHDOG_BALLOON_INTERVAL</literal> and
     5713        <literal>VBOXWATCHDOG_LOGSIZE</literal>. Legacy parameters such
     5714        as <literal>VBOXBALLOONCTRL_INTERVAL</literal> can still be
     5715        used.
    58465716      </para>
    58475717
     
    58655735            <row>
    58665736              <entry><para>
    5867                   <computeroutput>USER</computeroutput>
     5737                  <literal>USER</literal>
    58685738                </para></entry>
    58695739              <entry><para>
     
    58745744            <row>
    58755745              <entry><para>
    5876                   <computeroutput>ROTATE</computeroutput>
     5746                  <literal>ROTATE</literal>
    58775747                </para></entry>
    58785748              <entry><para>
     
    58855755            <row>
    58865756              <entry><para>
    5887                   <computeroutput>LOGSIZE</computeroutput>
     5757                  <literal>LOGSIZE</literal>
    58885758                </para></entry>
    58895759              <entry><para>
     
    58965766            <row>
    58975767              <entry><para>
    5898                   <computeroutput>LOGINTERVAL</computeroutput>
     5768                  <literal>LOGINTERVAL</literal>
    58995769                </para></entry>
    59005770              <entry><para>
     
    59085778            <row>
    59095779              <entry><para>
    5910                   <computeroutput>BALLOON_INTERVAL</computeroutput>
     5780                  <literal>BALLOON_INTERVAL</literal>
    59115781                </para></entry>
    59125782              <entry><para>
     
    59205790            <row>
    59215791              <entry><para>
    5922                   <computeroutput>BALLOON_INCREMENT</computeroutput>
     5792                  <literal>BALLOON_INCREMENT</literal>
    59235793                </para></entry>
    59245794              <entry><para>
     
    59315801            <row>
    59325802              <entry><para>
    5933                   <computeroutput>BALLOON_DECREMENT</computeroutput>
     5803                  <literal>BALLOON_DECREMENT</literal>
    59345804                </para></entry>
    59355805              <entry><para>
     
    59425812            <row>
    59435813              <entry><para>
    5944                   <computeroutput>BALLOON_LOWERLIMIT</computeroutput>
     5814                  <literal>BALLOON_LOWERLIMIT</literal>
    59455815                </para></entry>
    59465816              <entry><para>
     
    59535823            <row>
    59545824              <entry><para>
    5955                   <computeroutput>BALLOON_SAFETYMARGIN</computeroutput>
     5825                  <literal>BALLOON_SAFETYMARGIN</literal>
    59565826                </para></entry>
    59575827              <entry><para>
     
    59885858        <xref linkend="table-vboxwatchdog-config-params"/> also applies
    59895859        for Oracle Solaris. The parameter names must be changed to
    5990         lowercase and a prefix of
    5991         <computeroutput>config/</computeroutput> has to be added. For
    5992         example: <computeroutput>config/user</computeroutput> or
    5993         <computeroutput>config/balloon_safetymargin</computeroutput>. If
    5994         you made any change, do not forget to run the following command
    5995         to put the changes into effect immediately:
     5860        lowercase and a prefix of <literal>config/</literal> has to be
     5861        added. For example: <literal>config/user</literal> or
     5862        <literal>config/balloon_safetymargin</literal>. If you made any
     5863        change, do not forget to run the following command to put the
     5864        changes into effect immediately:
    59965865      </para>
    59975866
     
    60615930    </para>
    60625931
    6063 <screen>VBoxManage modifyvm "VM name" --vrdeproperty VNCPassword=secret</screen>
     5932<screen>VBoxManage modifyvm <replaceable>VM-name</replaceable> --vrdeproperty VNCPassword=secret</screen>
    60645933
    60655934    <para>
     
    60955964      <para>
    60965965        On Linux, the autostart service is activated by setting two
    6097         variables in
    6098         <computeroutput>/etc/default/virtualbox</computeroutput>. The
    6099         first one is <computeroutput>VBOXAUTOSTART_DB</computeroutput>
    6100         which contains an absolute path to the autostart database
    6101         directory. The directory should have write access for every user
    6102         who should be able to start virtual machines automatically.
    6103         Furthermore the directory should have the sticky bit set. The
    6104         second variable is
    6105         <computeroutput>VBOXAUTOSTART_CONFIG</computeroutput> which
    6106         points the service to the autostart configuration file which is
    6107         used during boot to determine whether to allow individual users
    6108         to start a VM automatically and configure startup delays. The
    6109         configuration file can be placed in
    6110         <computeroutput>/etc/vbox</computeroutput> and contains several
    6111         options. One is <computeroutput>default_policy</computeroutput>
    6112         which controls whether the autostart service allows or denies to
    6113         start a VM for users which are not in the exception list. The
    6114         exception list starts with
    6115         <computeroutput>exception_list</computeroutput> and contains a
    6116         comma separated list with usernames. Furthermore a separate
    6117         startup delay can be configured for every user to avoid
    6118         overloading the host. A sample configuration is given below:
     5966        variables in <filename>/etc/default/virtualbox</filename>. The
     5967        first one is <literal>VBOXAUTOSTART_DB</literal> which contains
     5968        an absolute path to the autostart database directory. The
     5969        directory should have write access for every user who should be
     5970        able to start virtual machines automatically. Furthermore the
     5971        directory should have the sticky bit set. The second variable is
     5972        <literal>VBOXAUTOSTART_CONFIG</literal> which points the service
     5973        to the autostart configuration file which is used during boot to
     5974        determine whether to allow individual users to start a VM
     5975        automatically and configure startup delays. The configuration
     5976        file can be placed in <filename>/etc/vbox</filename> and
     5977        contains several options. One is
     5978        <literal>default_policy</literal> which controls whether the
     5979        autostart service allows or denies to start a VM for users which
     5980        are not in the exception list. The exception list starts with
     5981        <literal>exception_list</literal> and contains a comma separated
     5982        list with usernames. Furthermore a separate startup delay can be
     5983        configured for every user to avoid overloading the host. A
     5984        sample configuration is given below:
    61195985      </para>
    61205986
     
    61356001    allow = false
    61366002}
    6137       </screen>
    6138 
    6139       <para>
    6140         Every user who wants to enable autostart for individual machines
    6141         has to set the path to the autostart database directory with the
     6003</screen>
     6004
     6005      <para>
     6006        Any user who wants to enable autostart for individual machines
     6007        must set the path to the autostart database directory with the
    61426008        following command:
    61436009      </para>
    61446010
    6145 <screen>VBoxManage setproperty autostartdbpath &lt;Autostart directory&gt;</screen>
     6011<screen>VBoxManage setproperty autostartdbpath <replaceable>autostart-directory</replaceable></screen>
    61466012
    61476013    </sect2>
     
    61536019      <para>
    61546020        On Oracle Solaris hosts, the &product-name; autostart daemon is
    6155         integrated into the SMF framework. To enable it you have to
    6156         point the service to an existing configuration file which has
    6157         the same format as on Linux, see
    6158         <xref linkend="autostart-linux" />. For example:
    6159       </para>
    6160 
    6161 <screen>svccfg -s svc:/application/virtualbox/autostart:default setprop \
     6021        integrated into the SMF framework. To enable it you must point
     6022        the service to an existing configuration file which has the same
     6023        format as on Linux, see <xref linkend="autostart-linux" />. For
     6024        example:
     6025      </para>
     6026
     6027<screen># svccfg -s svc:/application/virtualbox/autostart:default setprop \
    61626028  config/config=/etc/vbox/autostart.cfg</screen>
    61636029
     
    61676033      </para>
    61686034
    6169 <screen>svcadm enable svc:/application/virtualbox/autostart:default</screen>
    6170 
    6171       <para>
    6172         For more information about SMF, please refer to the Oracle
    6173         Solaris documentation.
     6035<screen># svcadm enable svc:/application/virtualbox/autostart:default</screen>
     6036
     6037      <para>
     6038        For more information about SMF, see the Oracle Solaris
     6039        documentation.
    61746040      </para>
    61756041
     
    61836049        On Mac OS X, launchd is used to start the &product-name;
    61846050        autostart service. An example configuration file can be found in
    6185         <computeroutput>/Applications/VirtualBox.app/Contents/MacOS/org.virtualbox.vboxautostart.plist</computeroutput>.
     6051        <filename>/Applications/VirtualBox.app/Contents/MacOS/org.virtualbox.vboxautostart.plist</filename>.
    61866052        To enable the service copy the file to
    6187         <computeroutput>/Library/LaunchDaemons</computeroutput> and
    6188         change the <computeroutput>Disabled</computeroutput> key from
    6189         <computeroutput>true</computeroutput> to
    6190         <computeroutput>false</computeroutput>. Furthermore replace the
    6191         second parameter to an existing configuration file which has the
    6192         same format as on Linux, see <xref linkend="autostart-linux" />.
     6053        <filename>/Library/LaunchDaemons</filename> and change the
     6054        <literal>Disabled</literal> key from <literal>true</literal> to
     6055        <literal>false</literal>. Furthermore replace the second
     6056        parameter to an existing configuration file which has the same
     6057        format as on Linux, see <xref linkend="autostart-linux" />.
    61936058      </para>
    61946059
     
    61976062      </para>
    61986063
    6199 <screen>launchctl load /Library/LaunchDaemons/org.virtualbox.vboxautostart.plist</screen>
     6064<screen># launchctl load /Library/LaunchDaemons/org.virtualbox.vboxautostart.plist</screen>
    62006065
    62016066      <para>
     
    62066071      <para>
    62076072        <ulink
    6208       url="http://developer.apple.com/mac/library/documentation/MacOSX/Conceptual/BPSystemStartup/BPSystemStartup.html">http://developer.apple.com/mac/library/documentation/MacOSX/Conceptual/BPSystemStartup/BPSystemStartup.html</ulink>.
     6073      url="http://developer.apple.com/mac/library/documentation/MacOSX/Conceptual/BPSystemStartup/BPSystemStartup.html" />.
    62096074      </para>
    62106075
     
    62136078    <sect2 id="autostart-windows">
    62146079
    6215       <title>Windows: Starting the Autostart Service With windows service</title>
    6216 
    6217       <para>
    6218         On Windows, the autostarting is implemented as Windows service.
    6219         The service is installed for every user with her/his own credentials.
    6220         Before installing any autostart services on a system you have to define
    6221         the <computeroutput>VBOXAUTOSTART_CONFIG</computeroutput> environment
    6222         variable in the system variables with the path to the config file.
    6223         The config file has the same format as on Linux,
    6224         see <xref linkend="autostart-linux" />, except the user name
    6225         can be specified using following formats: "user", "domain\user",
    6226         ".\user" and "user@domain".
    6227       </para>
    6228 
    6229       <para>
    6230         To activate the autostart ability for particular user a member of
     6080      <title>Windows: Starting the Autostart Service With a Windows service</title>
     6081
     6082      <para>
     6083        On Windows, autostarting is implemented as a Windows service.
     6084        The service is installed for every user with their own
     6085        credentials. Before installing any autostart services on a
     6086        system you first have to define the
     6087        <literal>VBOXAUTOSTART_CONFIG</literal> environment variable in
     6088        the system variables with the path to the autostart
     6089        configuration file. The configuration file has the same format
     6090        as on Linux, see <xref linkend="autostart-linux" />, except the
     6091        user name can be specified using the following formats: "user",
     6092        "domain\user", ".\user" and "user@domain".
     6093      </para>
     6094
     6095      <para>
     6096        To enable autostarting for a particular user, a member of the
    62316097        administrators group must run the following command:
    62326098      </para>
    62336099
    6234       <screen>VBoxAutostartSvc install --user=&lt;user&gt; [--password-file=&lt;password_file&gt;]</screen>
    6235 
    6236       <para>
    6237         The password file should contain the password followed by a line break.
    6238         The rest of the file is ignored. The user will be asked for a password
    6239         if the password file is not specified.
    6240       </para>
    6241 
    6242       <para>
    6243         To remove the autostart ability for particular user a member of
     6100<screen>VBoxAutostartSvc install --user=&lt;user&gt; [--password-file=&lt;password_file&gt;]</screen>
     6101
     6102      <para>
     6103        The password file should contain the password followed by a line
     6104        break. The rest of the file is ignored. The user will be asked
     6105        for a password if the password file is not specified.
     6106      </para>
     6107
     6108      <para>
     6109        To disable autostarting for particular user, a member of the
    62446110        administrators group must run the following command:
    62456111      </para>
    62466112
    6247       <screen>VBoxAutostartSvc delete --user=&lt;user&gt;</screen>
    6248 
    6249       <para>
    6250         The user can be specified for both commands using following formats:
    6251         "user", "domain\user", ".\user" and "user@domain"
    6252       </para>
    6253 
    6254       <para>
    6255         Note:
    6256       </para>
    6257 
    6258       <para>
    6259         If user has changed his password a member of administrators group
    6260         must either reinstall the service or change the service credentials
    6261         using windows service manager. The autostart service can not be
    6262         installed for users with empty passwords due to Windows security policies.
     6113<screen>VBoxAutostartSvc delete --user=&lt;user&gt;</screen>
     6114
     6115      <para>
     6116        If a user has changed their password then a member of the
     6117        administrators group must either reinstall the service or change
     6118        the service credentials using Windows Service Manager. Due to
     6119        Windows security policies, the autostart service cannot be
     6120        installed for users with empty passwords.
    62636121      </para>
    62646122
     
    62856143    </para>
    62866144
    6287 <screen>VBoxManage setextradata "VM name" "VBoxInternal2/SilentReconfigureWhilePaused" 1</screen>
    6288 
    6289     <para>
    6290       Storage attachments can be reconfigured while the VM is paused
    6291       afterwards using:
    6292     </para>
    6293 
    6294 <screen>VBoxManage storageattach ...</screen>
     6145<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxInternal2/SilentReconfigureWhilePaused" 1</screen>
     6146
     6147    <para>
     6148      You can reconfigure storage attachments later while the VM is
     6149      paused by using the <command>VBoxManage storageattach</command>
     6150      command.
     6151    </para>
    62956152
    62966153  </sect1>
     
    63536210        </para>
    63546211
    6355 <screen>VBoxManage setextradata global "VBoxInternal2/SavestateOnBatteryLow" 0</screen>
     6212<screen>$ VBoxManage setextradata global "VBoxInternal2/SavestateOnBatteryLow" 0</screen>
    63566213
    63576214        <para>
     
    63626219        </para>
    63636220
    6364 <screen>VBoxManage setextradata global "VBoxInternal2/SavestateOnBatteryLow" 1
    6365 VBoxManage setextradata "foo" "VBoxInternal2/SavestateOnBatteryLow" 0</screen>
     6221<screen>$ VBoxManage setextradata global "VBoxInternal2/SavestateOnBatteryLow" 1
     6222$ VBoxManage setextradata "foo" "VBoxInternal2/SavestateOnBatteryLow" 0</screen>
    63666223
    63676224        <para>
     
    63866243    </para>
    63876244
    6388 <screen>VBoxManage setextradata "VM name" VBoxInternal/CPUM/IsaExts/SSE4.1 0
    6389 VBoxManage setextradata "VM name" VBoxInternal/CPUM/IsaExts/SSE4.2 0</screen>
     6245<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     6246VBoxInternal/CPUM/IsaExts/SSE4.1 0
     6247$ VBoxManage setextradata <replaceable>VM-name</replaceable> \
     6248VBoxInternal/CPUM/IsaExts/SSE4.2 0</screen>
    63906249
    63916250    <para>
     
    64076266    </para>
    64086267
    6409 <screen>VBoxManage setextradata "VM name" GUI/HidLedsSync 0</screen>
    6410 
    6411     <para>
    6412       This is a per-VM setting, which is enabled by default.
     6268<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> GUI/HidLedsSync 0</screen>
     6269
     6270    <para>
     6271      This is a per-VM setting that is enabled by default.
    64136272    </para>
    64146273
     
    64286287    </para>
    64296288
    6430 <screen>VBoxManage controlvm "VM name" usbattach "device uuid|address" --capturefile "filename"</screen>
     6289<screen>VBoxManage controlvm <replaceable>VM-name</replaceable> usbattach <replaceable>device uuid</replaceable>|<replaceable>address</replaceable> --capturefile <replaceable>filename</replaceable></screen>
    64316290
    64326291    <para>
     
    64356294    </para>
    64366295
    6437 <screen>VBoxManage setextradata "VM name" \
    6438   VBoxInternal/Devices/usb-ehci/0/LUN#0/Config/CaptureFilename "filename"</screen>
     6296<screen>VBoxManage setextradata <replaceable>VM-name</replaceable> \
     6297VBoxInternal/Devices/usb-ehci/0/LUN#0/Config/CaptureFilename <replaceable>filename</replaceable></screen>
    64396298
    64406299    <para>
    64416300      The command above enables capturing on the root hub attached to
    64426301      the EHCI controller. To enable it for the OHCI or XHCI controller
    6443       replace <computeroutput>usb-ehci</computeroutput> with
    6444       <computeroutput>usb-ohci</computeroutput> or
    6445       <computeroutput>usb-xhci</computeroutput> respectively.
     6302      replace <literal>usb-ehci</literal> with
     6303      <literal>usb-ohci</literal> or <literal>usb-xhci</literal>,
     6304      respectively.
    64466305    </para>
    64476306
     
    64716330    </para>
    64726331
    6473 <screen>VBoxManage setextradata "VM name"\
    6474   VBoxInternal/Devices/VMMDev/0/Config/HeartbeatInterval 2000000000</screen>
     6332<screen>VBoxManage setextradata <replaceable>VM-name</replaceable> \
     6333VBoxInternal/Devices/VMMDev/0/Config/HeartbeatInterval 2000000000</screen>
    64756334
    64766335    <para>
     
    64826341    </para>
    64836342
    6484 <screen>VBoxManage setextradata "VM name" \
    6485   VBoxInternal/Devices/VMMDev/0/Config/HeartbeatTimeout 4000000000</screen>
     6343<screen>VBoxManage setextradata <replaceable>VM-name</replaceable> \
     6344VBoxInternal/Devices/VMMDev/0/Config/HeartbeatTimeout 4000000000</screen>
    64866345
    64876346    <para>
     
    66186477      </para>
    66196478
    6620 <screen>VBoxManage encryptmedium "uuid|filename" \
    6621   --newpassword "file|-" --cipher "cipher id" --newpasswordid "id"</screen>
     6479<screen>VBoxManage encryptmedium <replaceable>uuid</replaceable>|<replaceable>filename</replaceable> \
     6480--newpassword <replaceable>filename</replaceable>|- --cipher <replaceable>cipher-ID</replaceable> --newpasswordid "<replaceable>ID</replaceable></screen>
    66226481
    66236482      <para>
     
    66306489      <para>
    66316490        The cipher parameter specifies the cipher to use for encryption
    6632         and can be either
    6633         <computeroutput>AES-XTS128-PLAIN64</computeroutput> or
    6634         <computeroutput>AES-XTS256-PLAIN64</computeroutput>. The
    6635         specified password identifier can be freely chosen by the user
    6636         and is used for correct identification when supplying multiple
    6637         passwords during VM startup.
     6491        and can be either <literal>AES-XTS128-PLAIN64</literal> or
     6492        <literal>AES-XTS256-PLAIN64</literal>. The specified password
     6493        identifier can be freely chosen by the user and is used for
     6494        correct identification when supplying multiple passwords during
     6495        VM startup.
    66386496      </para>
    66396497
     
    66606518      </para>
    66616519
    6662 <screen>VBoxManage controlvm "uuid|vmname" addencpassword "id" "password" [--removeonsuspend "yes|no"]</screen>
    6663 
    6664       <para>
    6665         The <computeroutput>id</computeroutput> parameter must be the
    6666         same as the password identifier supplied when encrypting the
    6667         images. <computeroutput>password</computeroutput> is the
    6668         password used when encrypting the images. The user can
    6669         optionally specify <computeroutput>--removeonsuspend
    6670         "yes|no"</computeroutput> to specify whether to remove the
    6671         password from VM memory when the VM is suspended. Before the VM
    6672         can be resumed, the user needs to supply the passwords again.
    6673         This is useful when a VM is suspended by a host suspend event
    6674         and the user does not want the password to remain in memory.
     6520<screen>VBoxManage controlvm <replaceable>uuid</replaceable>|<replaceable>vmname</replaceable> addencpassword <replaceable>ID</replaceable> <replaceable>password</replaceable> [--removeonsuspend yes|no]</screen>
     6521
     6522      <para>
     6523        <replaceable>ID</replaceable> must be the same as the password
     6524        identifier supplied when encrypting the images.
     6525        <replaceable>password</replaceable> is the password used when
     6526        encrypting the images. Optionally, you can specify
     6527        <option>--removeonsuspend yes|no</option> to specify whether to
     6528        remove the password from VM memory when the VM is suspended.
     6529        Before the VM can be resumed, the user needs to supply the
     6530        passwords again. This is useful when a VM is suspended by a host
     6531        suspend event and the user does not want the password to remain
     6532        in memory.
    66756533      </para>
    66766534
     
    66886546      </para>
    66896547
    6690 <screen>VBoxManage encryptmedium "uuid|filename" --oldpassword "file|-"</screen>
     6548<screen>VBoxManage encryptmedium <replaceable>uuid</replaceable>|<replaceable>filename</replaceable> --oldpassword <replaceable>file</replaceable>|-</screen>
    66916549
    66926550      <para>
     
    67056563
    67066564    <para>
    6707       In this section we cover debugging of guest operating systems
    6708       using interfaces supported by paravirtualization providers.
     6565      This section covers debugging of guest operating systems using
     6566      interfaces supported by paravirtualization providers.
    67096567    </para>
    67106568
     
    67386596          <para>
    67396597            Key:
    6740             <emphasis role="bold"><computeroutput>enabled</computeroutput></emphasis>
     6598            <emphasis role="bold"><literal>enabled</literal></emphasis>
    67416599          </para>
    67426600
    67436601          <para>
    6744             Value: <computeroutput>0</computeroutput> or
    6745             <computeroutput>1</computeroutput>
     6602            Value: <literal>0</literal> or <literal>1</literal>
    67466603          </para>
    67476604
    67486605          <para>
    6749             Default: <computeroutput>0</computeroutput>
     6606            Default: <literal>0</literal>
    67506607          </para>
    67516608
    67526609          <para>
    6753             Specify <computeroutput>1</computeroutput> to enable the
    6754             Hyper-V debug interface. If this key-value pair is not
    6755             specified or the value is not
    6756             <computeroutput>1</computeroutput>, the Hyper-V debug
     6610            Specify <literal>1</literal> to enable the Hyper-V debug
     6611            interface. If this key-value pair is not specified or the
     6612            value is not <literal>1</literal>, the Hyper-V debug
    67576613            interface is disabled regardless of other key-value pairs
    67586614            being present.
     
    67636619          <para>
    67646620            Key:
    6765             <emphasis role="bold"><computeroutput>address</computeroutput></emphasis>
     6621            <emphasis role="bold"><literal>address</literal></emphasis>
    67666622          </para>
    67676623
     
    67836639          <para>
    67846640            Key:
    6785             <emphasis role="bold"><computeroutput>port</computeroutput></emphasis>
     6641            <emphasis role="bold"><literal>port</literal></emphasis>
    67866642          </para>
    67876643
     
    68036659          <para>
    68046660            Key:
    6805             <emphasis role="bold"><computeroutput>vendor</computeroutput></emphasis>
     6661            <emphasis role="bold"><literal>vendor</literal></emphasis>
    68066662          </para>
    68076663
     
    68126668
    68136669          <para>
    6814             Default: When debugging is enabled:
    6815             <computeroutput>Microsoft Hv</computeroutput>, otherwise:
    6816             <computeroutput>VBoxVBoxVBox</computeroutput>
     6670            Default: When debugging is enabled: <literal>Microsoft
     6671            Hv</literal>, otherwise: <literal>VBoxVBoxVBox</literal>
    68176672          </para>
    68186673
     
    68276682          <para>
    68286683            Key:
    6829             <emphasis role="bold"><computeroutput>hypercallinterface</computeroutput>
     6684            <emphasis role="bold"><literal>hypercallinterface</literal>
    68306685            </emphasis>
    68316686          </para>
    68326687
    68336688          <para>
    6834             Value: <computeroutput>0</computeroutput> or
    6835             <computeroutput>1</computeroutput>
     6689            Value: <literal>0</literal> or <literal>1</literal>
    68366690          </para>
    68376691
    68386692          <para>
    6839             Default: <computeroutput>0</computeroutput>
     6693            Default: <literal>0</literal>
    68406694          </para>
    68416695
     
    68496703        <listitem>
    68506704          <para>
    6851             Key:
    6852             <emphasis role="bold"><computeroutput>vsinterface</computeroutput>
     6705            Key: <emphasis role="bold"><literal>vsinterface</literal>
    68536706            </emphasis>
    68546707          </para>
    68556708
    68566709          <para>
    6857             Value: <computeroutput>0</computeroutput> or
    6858             <computeroutput>1</computeroutput>
     6710            Value: <literal>0</literal> or <literal>1</literal>
    68596711          </para>
    68606712
    68616713          <para>
    6862             Default: When debugging is enabled,
    6863             <computeroutput>1</computeroutput>, otherwise
    6864             <computeroutput>0</computeroutput>
     6714            Default: When debugging is enabled, <literal>1</literal>,
     6715            otherwise <literal>0</literal>
    68656716          </para>
    68666717
     
    69136764            </para>
    69146765
    6915 <screen>VBoxManage showvminfo "VM name"</screen>
     6766<screen>$ VBoxManage showvminfo <replaceable>VM-name</replaceable></screen>
    69166767          </listitem>
    69176768
     
    69296780              debug support, Windows 7 and Vista do not. To use Hyper-V
    69306781              debugging with a Windows 7 or Vista guest, copy the file
    6931               <computeroutput>kdvm.dll</computeroutput> from a Windows
    6932               8.0 installation. This file is typically located in
    6933               <computeroutput>C:\Windows\System32</computeroutput>. Copy
    6934               it to the same location in your Windows 7/Vista guest.
    6935               Make sure you copy the 32-bit or 64-bit version of the DLL
    6936               which matches your guest OS.
     6782              <filename>kdvm.dll</filename> from a Windows 8.0
     6783              installation. This file is typically located in
     6784              <filename>C:\Windows\System32</filename>. Copy it to the
     6785              same location in your Windows 7/Vista guest. Make sure you
     6786              copy the 32-bit or 64-bit version of the DLL which matches
     6787              your guest OS.
    69376788            </para>
    69386789
    69396790            <note>
    69406791              <para>
    6941                 Only Windows 8.0 ships
    6942                 <computeroutput>kdvm.dll</computeroutput>. Windows 8.1
    6943                 and newer Windows versions do not.
     6792                Only Windows 8.0 ships <filename>kdvm.dll</filename>.
     6793                Windows 8.1 and newer Windows versions do not.
    69446794              </para>
    69456795            </note>
     
    69666816            </para>
    69676817
    6968 <screen>VBoxManage modifyvm "VM name" --paravirtdebug "enabled=1"</screen>
     6818<screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> --paravirtdebug "enabled=1"</screen>
    69696819
    69706820            <para>
     
    69756825            </para>
    69766826
    6977 <screen>VBoxManage modifyvm "VM name" --paravirtdebug "enabled=1,address=192.168.32.1,port=55000"</screen>
     6827<screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> \
     6828--paravirtdebug "enabled=1,address=192.168.32.1,port=55000"</screen>
    69786829
    69796830            <para>
     
    70716922              the <emphasis role="bold">NET</emphasis> tab, specify the
    70726923              UDP port number you used in the
    7073               <computeroutput>paravirtdebug</computeroutput> options. If
    7074               you did not specify any, leave it as 50000. Ensure that
    7075               the UDP port is not blocked by a firewall or other
    7076               security software.
     6924              <literal>paravirtdebug</literal> options. If you did not
     6925              specify any, leave it as 50000. Ensure that the UDP port
     6926              is not blocked by a firewall or other security software.
    70776927            </para>
    70786928
    70796929            <para>
    70806930              In the <emphasis role="bold">Key</emphasis> field, enter
    7081               <computeroutput>1.2.3.4</computeroutput> or the encryption
    7082               key from the <computeroutput>bcdedit</computeroutput>
    7083               command in your Windows guest.
     6931              <literal>1.2.3.4</literal> or the encryption key from the
     6932              <command>bcdedit</command> command in your Windows guest.
    70846933            </para>
    70856934
     
    71677016              </para></entry>
    71687017            <entry><para>
    7169                 <computeroutput>/dev/input/by-path/platform-pcspkr-event-spkr</computeroutput>
     7018                <filename>/dev/input/by-path/platform-pcspkr-event-spkr</filename>
    71707019              </para></entry>
    71717020            <entry><para>
     
    71777026                2
    71787027              </para></entry>
    7179             <entry><computeroutput>/dev/tty</computeroutput></entry>
     7028            <entry><filename>/dev/tty</filename></entry>
    71807029            <entry><para>
    71817030                Uses the terminal association of the VM process. VM
     
    71887037              </para></entry>
    71897038            <entry><para>
    7190                 <computeroutput>/dev/tty0</computeroutput> or
    7191                 <computeroutput>/dev/vc/0</computeroutput>
     7039                <filename>/dev/tty0</filename> or
     7040                <filename>/dev/vc/0</filename>
    71927041              </para></entry>
    71937042            <entry><para>
    7194                 Can only be used by user
    7195                 <computeroutput>root</computeroutput> or users with
    7196                 <computeroutput>cap_sys_tty_config</computeroutput>
     7043                Can only be used by user <literal>root</literal> or
     7044                users with <literal>cap_sys_tty_config</literal>
    71977045                capability.
    71987046              </para></entry>
     
    72147062              </para></entry>
    72157063            <entry><para>
    7216                 <computeroutput>/dev/tty</computeroutput>
     7064                <filename>/dev/tty</filename>
    72177065              </para></entry>
    72187066            <entry><para>
     
    72517099    </para>
    72527100
    7253 <screen>VBoxManage setextradata "VM name" "VBoxInternal/Devices/i8254/0/Config/PassthroughSpeaker" N</screen>
    7254 
    7255     <para>
    7256       Replace <computeroutput>N</computeroutput> with the code
    7257       representing the case you want to use. Changing this setting will
    7258       take effect when the VM is started next. It is safe to enable PC
    7259       speaker passthrough on all host OSes. It will only have an effect
    7260       on Linux.
    7261     </para>
    7262 
    7263     <para>
    7264       The VM log file, <computeroutput>VBox.log</computeroutput>, will
    7265       contain lines with the prefix <computeroutput>PIT:
    7266       speaker:</computeroutput> showing the PC speaker passthrough setup
    7267       activities. It gives hints which device it picked or why it
    7268       failed.
     7101<screen>VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxInternal/Devices/i8254/0/Config/PassthroughSpeaker" <replaceable>N</replaceable></screen>
     7102
     7103    <para>
     7104      Replace <replaceable>N</replaceable> with the code representing
     7105      the case you want to use. Changing this setting takes effect when
     7106      you next start the VM. It is safe to enable PC speaker passthrough
     7107      on all host OSes. It will only have an effect on Linux.
     7108    </para>
     7109
     7110    <para>
     7111      The VM log file, <filename>VBox.log</filename>, contains lines
     7112      with the prefix <literal>PIT: speaker:</literal> showing the PC
     7113      speaker passthrough setup activities. It gives hints which device
     7114      it picked or why it failed.
    72697115    </para>
    72707116
     
    72737119      part. The real difficulty is making sure that &product-name; can
    72747120      access the necessary device, because in a typical Linux install
    7275       most of them can only be accessed by user
    7276       <computeroutput>root</computeroutput>. You should follow the
    7277       preferred way to persistently change this, such as by referring to
    7278       your distribution's documentation. Since there are countless Linux
    7279       distribution variants, we can only give the general hints that
    7280       there is often a way to give the X11 session user access to
    7281       additional devices, or you need to find a working solution using a
    7282       udev configuration file. If everything fails you might try setting
    7283       the permissions using a script which is run late enough in the
    7284       host system startup.
     7121      most of them can only be accessed by user <literal>root</literal>.
     7122      You should follow the preferred way to persistently change this,
     7123      such as by referring to your distribution's documentation. Since
     7124      there are countless Linux distribution variants, we can only give
     7125      the general hints that there is often a way to give the X11
     7126      session user access to additional devices, or you need to find a
     7127      working solution using a udev configuration file. If everything
     7128      fails you might try setting the permissions using a script which
     7129      is run late enough in the host system startup.
    72857130    </para>
    72867131
     
    73227167
    73237168    <para>
    7324       To enable support for passing through USB/IP devices, the device
    7325       server exporting the devices must be added with the following
    7326       command:
    7327     </para>
    7328 
    7329 <screen>VBoxManage usbdevsource add "Unique name" --backend "USBIP" --address "Device server[:port]"</screen>
     7169      To enable support for passing through USB/IP devices, use the
     7170      following command to add the device server that exports the
     7171      devices:
     7172    </para>
     7173
     7174<screen>VBoxManage usbdevsource add <replaceable>unique-name</replaceable> --backend <replaceable>USB-IP</replaceable> --address <replaceable>device-server</replaceable>[:<replaceable>port</replaceable>]</screen>
    73307175
    73317176    <para>
     
    73407185    </para>
    73417186
    7342 <screen>VBoxManage usbdevsource remove "Unique name"</screen>
     7187<screen>$ VBoxManage usbdevsource remove <replaceable>unique-name</replaceable></screen>
    73437188
    73447189    <sect2 id="usbip-setup-server">
     
    73497194        This section gives a brief overview on how to set up a Linux
    73507195        based system to act as a USB device server. The system on the
    7351         server requires that the
    7352         <computeroutput>usbip-core.ko</computeroutput> and
    7353         <computeroutput>usbip-host.ko</computeroutput> kernel drivers
    7354         are available, and that the USB/IP tools package is installed.
    7355         The particular installation method for the necessary tools
    7356         depends on which distribution is used. For example, for Debian
    7357         based systems, the following command should be used to install
    7358         the required tools:
    7359       </para>
    7360 
    7361 <screen>apt-get install usbip-utils</screen>
     7196        server requires that the <filename>usbip-core.ko</filename> and
     7197        <filename>usbip-host.ko</filename> kernel drivers are available,
     7198        and that the USB/IP tools package is installed. The particular
     7199        installation method for the necessary tools depends on which
     7200        distribution is used. For example, for Debian based systems, use
     7201        the following command to install the required tools:
     7202      </para>
     7203
     7204<screen>$ apt-get install usbip-utils</screen>
    73627205
    73637206      <para>
     
    73857228      <para>
    73867229        If everything is installed, the USB/IP server needs to be
    7387         started as <computeroutput>root</computeroutput> using the
    7388         following command:
    7389       </para>
    7390 
    7391 <screen>usbipd -D</screen>
    7392 
    7393       <para>
    7394         Refer to the documentation for the installed distribution to
     7230        started as <literal>root</literal> using the following command:
     7231      </para>
     7232
     7233<screen># usbipd -D</screen>
     7234
     7235      <para>
     7236        See the documentation for the installed distribution to
    73957237        determine how to start the service when the system boots.
    73967238      </para>
     
    74027244      </para>
    74037245
    7404 <screen>usbip bind -b "bus identifier"</screen>
     7246<screen># usbip bind -b "bus identifier"</screen>
    74057247
    74067248      <para>
     
    74087250      </para>
    74097251
    7410 <screen>usbip bind -b 4-2</screen>
     7252<screen># usbip bind -b 4-2</screen>
    74117253
    74127254    </sect2>
     
    74497291    <note>
    74507292      <para>
    7451         When using this feature, you might experience significant
    7452         &product-name; performance degradation on some host systems.
     7293        When using this feature, some host systems might experience
     7294        significant &product-name; performance degradation.
    74537295      </para>
    74547296    </note>
     
    74617303
    74627304    <para>
    7463       &product-name; supports <emphasis>nested virtualization</emphasis>.
    7464       This feature enables the passthrough of hardware virtualization
    7465       functions to the guest VM. That means that you can install a
    7466       hypervisor, such as &product-name;, Oracle VM Server or KVM, on
    7467       a &product-name; guest. You can then create and run VMs within the
    7468       guest VM.
     7305      &product-name; supports <emphasis>nested
     7306      virtualization</emphasis>. This feature enables the passthrough of
     7307      hardware virtualization functions to the guest VM. That means that
     7308      you can install a hypervisor, such as &product-name;, Oracle VM
     7309      Server or KVM, on an &product-name; guest. You can then create and
     7310      run VMs within the guest VM.
    74697311    </para>
    74707312
  • trunk/doc/manual/en_US/user_BasicConcepts.xml

    r81233 r82350  
    458458
    459459      <title>64-bit Guests</title>
    460 
    461       <para>
    462         &product-name; enables you to run 64-bit guest OSes even on a
    463         32-bit host OS. To run a 64-bit guest OS on a 32-bit host
    464         system, ensure that you meet the following conditions:
    465       </para>
    466 
    467       <itemizedlist>
    468 
    469         <listitem>
    470           <para>
    471             You need a 64-bit processor that has hardware virtualization
    472             support. See <xref linkend="hwvirt" />.
    473           </para>
    474         </listitem>
    475 
    476         <listitem>
    477           <para>
    478             You must enable hardware virtualization for the particular
    479             VM that requires 64-bit support. Software virtualization is
    480             not supported for 64-bit VMs.
    481           </para>
    482         </listitem>
    483 
    484         <listitem>
    485           <para>
    486             To use 64-bit guest support on a 32-bit host OS, you must
    487             select a 64-bit OS for the particular VM. Since supporting
    488             64 bits on 32-bit hosts incurs additional overhead,
    489             &product-name; only enables this support only upon explicit
    490             request.
    491           </para>
    492 
    493           <para>
    494             64-bit hosts typically come with hardware virtualization
    495             support. So, you can install a 64-bit guest OS in the guest
    496             regardless of the settings.
    497           </para>
    498         </listitem>
    499 
    500       </itemizedlist>
    501460
    502461      <warning>
     
    515474      <para>
    516475        If you use the <emphasis role="bold">Create VM</emphasis> wizard
    517         of the &product-name; graphical user interface (GUI),
    518         &product-name; automatically uses the correct settings for each
    519         selected 64-bit OS type. See <xref linkend="gui-createvm" />.
     476        of the VirtualBox Manager, &product-name; automatically uses the
     477        correct settings for each selected 64-bit OS type. See
     478        <xref linkend="gui-createvm" />.
    520479      </para>
    521480
     
    868827      <listitem>
    869828        <para>
    870           <emphasis role="bold">Input devices.</emphasis> By default,
    871           &product-name; emulates a standard PS/2 keyboard and mouse.
    872           These devices are supported by almost all past and present
    873           OSes.
     829          <emphasis role="bold">Input devices.</emphasis> &product-name;
     830          can emulate a standard PS/2 keyboard and mouse. These devices
     831          are supported by most guest OSes.
    874832        </para>
    875833
     
    877835          In addition, &product-name; can provide virtual USB input
    878836          devices to avoid having to capture mouse and keyboard, as
    879           described in <xref
    880           linkend="keyb_mouse_normal" />.
    881         </para>
    882       </listitem>
    883 
    884       <listitem>
    885         <para>
    886           <emphasis role="bold">Graphics.</emphasis> The &product-name;
    887           graphics device, sometimes referred to as a VGA device, is not
    888           based on any physical counterpart. This is unlike nearly all
    889           other emulated devices. It is a simple, synthetic device which
    890           provides compatibility with standard VGA and several extended
    891           registers used by the VESA BIOS Extensions (VBE).
     837          described in <xref linkend="keyb_mouse_normal" />.
     838        </para>
     839      </listitem>
     840
     841      <listitem>
     842        <para>
     843          <emphasis role="bold">Graphics.</emphasis> The default
     844          &product-name; graphics device for Windows guests is an SVGA
     845          device. For Linux guests, the default graphics device emulates
     846          a VMware SVGA graphics device. See
     847          <xref linkend="settings-screen"/>.
     848        </para>
     849
     850        <para>
     851          For legacy guest OSes, a VGA-compatible graphics device is
     852          available.
    892853        </para>
    893854      </listitem>
     
    896857        <para>
    897858          <emphasis role="bold">Storage.</emphasis> &product-name;
    898           currently emulates the standard ATA interface found on Intel
    899           PIIX3/PIIX4 chips, the SATA (AHCI) interface, and two SCSI
    900           adapters (LSI Logic and BusLogic). See
    901           <xref linkend="harddiskcontrollers" /> for details. Whereas
    902           providing one of these would be enough for &product-name; by
    903           itself, this multitude of storage adapters is required for
    904           compatibility with other hypervisors. Windows is particularly
    905           picky about its boot devices, and migrating VMs between
    906           hypervisors is very difficult or impossible if the storage
    907           controllers are different.
     859          emulates the most common types of hard disk controllers. See
     860          <xref linkend="harddiskcontrollers" />. Whereas supporting
     861          only one of these controllers would be enough for
     862          &product-name; by itself, this multitude of storage adapters
     863          is required for compatibility with other hypervisors. Windows
     864          is very selective about its boot devices, and migrating VMs
     865          between hypervisors is very difficult or impossible if the
     866          storage controllers are different.
    908867        </para>
    909868      </listitem>
     
    912871        <para>
    913872          <emphasis role="bold">Networking.</emphasis> See
    914           <xref
    915           linkend="nichardware" />.
     873          <xref linkend="nichardware" />.
    916874        </para>
    917875      </listitem>
     
    920878        <para>
    921879          <emphasis role="bold">USB.</emphasis> &product-name; emulates
    922           three USB host controllers: xHCI, EHCI, and OHCI. While xHCI
    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
     880          these types of USB host controllers: xHCI, EHCI, and OHCI.
     881          While xHCI handles all USB transfer speeds, some legacy guest
     882          OSes may not support xHCI. Note that for some legacy Windows
     883          guests, third party drivers must be installed for xHCI
     884          support.
     885        </para>
     886
     887        <para>
     888          Legacy guest OSes typically support OHCI and EHCI. These two
    930889          controllers are needed because OHCI only handles USB low-speed
    931890          and full-speed devices (both USB 1.x and 2.0), while EHCI only
     
    935894        <para>
    936895          The emulated USB controllers do not communicate directly with
    937           devices on the host but rather with a virtual USB layer which
    938           abstracts the USB protocol and enables the use of remote USB
    939           devices.
     896          devices on the host. Instead they communicate with a virtual
     897          USB layer which abstracts the USB protocol and enables the use
     898          of remote USB devices.
    940899        </para>
    941900      </listitem>
     
    977936        <listitem>
    978937          <para>
    979             <emphasis role="bold">Name:</emphasis> The name under which
    980             the VM is shown in the list of VMs in the main window. Under
    981             this name, &product-name; also saves the VM's configuration
    982             files. By changing the name, &product-name; renames these
    983             files as well. As a result, you can only use characters
    984             which are allowed in your host OS's file names.
     938            <emphasis role="bold">Name:</emphasis> The name of the the
     939            VM, as shown in the list of VMs in the main VirtualBox
     940            Manager window. Using this name, &product-name; also saves
     941            the VM's configuration files. If you change the name,
     942            &product-name; renames these files as well. As a result, you
     943            can only use characters which are allowed for file names on
     944            your host OS.
    985945          </para>
    986946
     
    988948            Note that internally, &product-name; uses unique identifiers
    989949            (UUIDs) to identify virtual machines. You can display these
    990             with <command>VBoxManage</command>.
     950            using the <command>VBoxManage</command> commands.
    991951          </para>
    992952        </listitem>
     
    10771037            enables support for drag and drop. Select an object, such as
    10781038            a file, from the host or guest and directly copy or open it
    1079             on the guest or host. Multiple per-VM drag and drop modes
    1080             allow restricting access in either direction.
     1039            on the guest or host. Multiple drag and drop modes for a VM
     1040            enable restricting of access in either direction.
    10811041          </para>
    10821042
     
    11481108      <note>
    11491109        <para>
    1150           All files related to the virtual machine except disk images are
    1151           stored unencrypted.
     1110          All files related to the virtual machine except disk images
     1111          are stored unencrypted.
    11521112        </para>
    11531113      </note>
     
    12341194          <para>
    12351195            <emphasis role="bold">Chipset:</emphasis> You can select
    1236             which chipset will be presented to the virtual machine. In
    1237             legacy versions of &product-name;, PIIX3 was the only
    1238             available option. For modern guest OSes such as Mac OS X,
    1239             that old chipset is no longer well supported. As a result,
    1240             &product-name; supports an emulation of the more modern ICH9
    1241             chipset, which supports PCI express, three PCI buses,
    1242             PCI-to-PCI bridges and Message Signaled Interrupts (MSI).
    1243             This enables modern OSes to address more PCI devices and no
    1244             longer requires IRQ sharing. Using the ICH9 chipset it is
    1245             also possible to configure up to 36 network cards, up to 8
    1246             network adapters with PIIX3. Note that the ICH9 support is
    1247             experimental and not recommended for guest OSes which do not
    1248             require it.
     1196            which chipset will be presented to the virtual machine.
     1197            PIIX3 is the default chipset for most guests. For some guest
     1198            OSes such as Mac OS X, the PIIX3 chipset is not well
     1199            supported. As a result, &product-name; supports an emulation
     1200            of the ICH9 chipset, which supports PCI express, three PCI
     1201            buses, PCI-to-PCI bridges and Message Signaled Interrupts
     1202            (MSI). This enables modern OSes to address more PCI devices
     1203            and no longer requires IRQ sharing. Using the ICH9 chipset
     1204            it is also possible to configure up to 36 network cards,
     1205            compared to a maximum of eight network adapters with PIIX3.
     1206            Note that ICH9 support is experimental and not recommended
     1207            for guest OSes which do not require it.
    12491208          </para>
    12501209        </listitem>
     
    12531212          <para>
    12541213            <emphasis role="bold">Pointing Device:</emphasis> The
    1255             default virtual pointing devices for older guests is the
    1256             traditional PS/2 mouse. If set to <emphasis>USB
    1257             tablet</emphasis>, &product-name; reports to the virtual
     1214            default virtual pointing device for some guest OSes is the
     1215            traditional PS/2 mouse. If set to <emphasis role="bold">USB
     1216            Tablet</emphasis>, &product-name; reports to the virtual
    12581217            machine that a USB tablet device is present and communicates
    1259             mouse events to the virtual machine through this device. The
    1260             third setting is a <emphasis>USB Multi-Touch
    1261             Tablet</emphasis> which is suited for recent Windows guests.
     1218            mouse events to the virtual machine through this device.
     1219            Another setting is <emphasis role="bold">USB Multi-Touch
     1220            Tablet</emphasis>, which is suitable for guests running
     1221            Windows 8 or later.
    12621222          </para>
    12631223
     
    12771237          <para>
    12781238            <emphasis role="bold">Enable I/O APIC:</emphasis> Advanced
    1279             Programmable Interrupt Controllers (APICs) are a newer x86
    1280             hardware feature that have replaced old-style Programmable
    1281             Interrupt Controllers (PICs) in recent years. With an I/O
    1282             APIC, OSes can use more than 16 interrupt requests (IRQs)
    1283             and therefore avoid IRQ sharing for improved reliability.
     1239            Programmable Interrupt Controllers (APICs) are an x86
     1240            hardware feature that have replaced Programmable Interrupt
     1241            Controllers (PICs). With an I/O APIC, OSes can use more than
     1242            16 interrupt requests (IRQs) and therefore avoid IRQ sharing
     1243            for improved reliability.
    12841244          </para>
    12851245
    12861246          <note>
    12871247            <para>
    1288               Enabling the I/O APIC is <emphasis>required</emphasis> for
    1289               64-bit guest OSes, especially Windows Vista. It is also
     1248              Enabling the I/O APIC is <emphasis>required</emphasis>,
     1249              especially for 64-bit Windows guest OSes. It is also
    12901250              required if you want to use more than one virtual CPU in a
    12911251              virtual machine.
     
    13021262          <warning>
    13031263            <para>
    1304               All Windows OSes starting with Windows 2000 install
    1305               different kernels, depending on whether an I/O APIC is
    1306               available. As with ACPI, the I/O APIC therefore
    1307               <emphasis>must not be turned off after
     1264              All Windows OSes install different kernels, depending on
     1265              whether an I/O APIC is available. As with ACPI, the I/O
     1266              APIC therefore <emphasis>must not be turned off after
    13081267              installation</emphasis> of a Windows guest OS. Turning it
    13091268              on after installation will have no effect however.
     
    13431302        ACPI is the current industry standard to allow OSes to recognize
    13441303        hardware, configure motherboards and other devices and manage
    1345         power. As all modern PCs contain this feature and Windows and
    1346         Linux have been supporting it for years, it is also enabled by
    1347         default in &product-name;. ACPI can only be turned off using the
    1348         command line. See <xref linkend="vboxmanage-modifyvm" />.
     1304        power. As most computers contain this feature and Windows and
     1305        Linux support ACPI, it is also enabled by default in
     1306        &product-name;. ACPI can only be turned off using the command
     1307        line. See <xref linkend="vboxmanage-modifyvm" />.
    13491308      </para>
    13501309
    13511310      <warning>
    13521311        <para>
    1353           All Windows OSes starting with Windows 2000 install different
    1354           kernels, depending on whether ACPI is available. This means
    1355           that ACPI <emphasis>must not be turned off</emphasis> after
    1356           installation of a Windows guest OS. However, turning it on
    1357           after installation will have no effect.
     1312          All Windows OSes install different kernels, depending on
     1313          whether ACPI is available. This means that ACPI <emphasis>must
     1314          not be turned off</emphasis> after installation of a Windows
     1315          guest OS. However, turning it on after installation will have
     1316          no effect.
    13581317        </para>
    13591318      </warning>
     
    14601419            accuracy and performance of guest OSes. The options
    14611420            available are documented under the
    1462             <computeroutput>paravirtprovider</computeroutput> option in
     1421            <option>--paravirtprovider</option> option in
    14631422            <xref linkend="vboxmanage-modifyvm" />. For further details
    14641423            on the paravirtualization providers, see
     
    14701429          <para>
    14711430            <emphasis role="bold">Hardware Virtualization:</emphasis>
    1472             You can select for each virtual machine individually whether
    1473             &product-name; should use software or hardware
    1474             virtualization.
     1431            You can configure hardware virtualization features for each
     1432            virtual machine.
    14751433          </para>
    14761434
    14771435          <itemizedlist>
    1478 
    1479             <listitem>
    1480               <para>
    1481                 <emphasis role="bold">Enable VT-x/AMD-V:</emphasis>
    1482                 Enables Intel VT-x and AMD-V hardware extensions if the
    1483                 host CPU supports them.
    1484               </para>
    1485             </listitem>
    14861436
    14871437            <listitem>
     
    15021452          <para>
    15031453            Advanced users may be interested in technical details about
    1504             software versus hardware virtualization. See
    1505             <xref linkend="hwvirt" />.
     1454            hardware virtualization. See <xref linkend="hwvirt" />.
    15061455          </para>
    15071456        </listitem>
     
    16141563        <listitem>
    16151564          <para>
    1616             <emphasis role="bold">Enable 3D Acceleration:</emphasis> If
    1617             a virtual machine has Guest Additions installed, you can
    1618             select here whether the guest should support accelerated 3D
    1619             graphics. See <xref linkend="guestadd-3d" />.
    1620           </para>
    1621         </listitem>
    1622 
    1623         <listitem>
    1624           <para>
    1625             <emphasis role="bold">Enable 2D Video
    1626             Acceleration:</emphasis> If a virtual machine with Microsoft
    1627             Windows has Guest Additions installed, you can select here
    1628             whether the guest should support accelerated 2D video
    1629             graphics. See <xref linkend="guestadd-2d" />.
    1630           </para>
    1631         </listitem>
    1632 
    1633         <listitem>
    1634           <para>
    16351565            <emphasis role="bold">Graphics Controller:</emphasis>
    16361566            Specifies the graphics adapter type used by the guest VM.
     
    16611591                default graphics controller for Windows versions before
    16621592                Windows 7 and for Oracle Solaris.
     1593              </para>
     1594
     1595              <para>
     1596                3D acceleration is not supported for this graphics
     1597                controller.
    16631598              </para>
    16641599            </listitem>
     
    16811616
    16821617          </itemizedlist>
     1618        </listitem>
     1619
     1620        <listitem>
     1621          <para>
     1622            <emphasis role="bold">Enable 3D Acceleration:</emphasis> If
     1623            a virtual machine has Guest Additions installed, you can
     1624            select here whether the guest should support accelerated 3D
     1625            graphics. See <xref linkend="guestadd-3d" />.
     1626          </para>
     1627        </listitem>
     1628
     1629        <listitem>
     1630          <para>
     1631            <emphasis role="bold">Enable 2D Video
     1632            Acceleration:</emphasis> If a virtual machine with Microsoft
     1633            Windows has Guest Additions installed, you can select here
     1634            whether the guest should support accelerated 2D video
     1635            graphics. See <xref linkend="guestadd-2d" />.
     1636          </para>
    16831637        </listitem>
    16841638
     
    17791733        <listitem>
    17801734          <para>
    1781             <emphasis role="bold">Quality:</emphasis> Use the slider to
    1782             set the the bit rate of the video in kilobits per second.
    1783             Increasing this value improves the appearance of the video
    1784             at the cost of an increased file size.
     1735            <emphasis role="bold">Video Quality:</emphasis> Use the
     1736            slider to set the the bit rate of the video in kilobits per
     1737            second. Increasing this value improves the appearance of the
     1738            video at the cost of an increased file size.
    17851739          </para>
    17861740        </listitem>
     
    18251779
    18261780    <para>
    1827       In a real PC, so-called <emphasis>storage controllers</emphasis>
    1828       connect physical disk drives to the rest of the computer.
    1829       Similarly, &product-name; presents virtual storage controllers to
    1830       a virtual machine. Under each controller, the virtual devices,
    1831       such as hard disks, CD/DVD or floppy drives, attached to the
    1832       controller are shown.
     1781      In a real computer, so-called <emphasis>storage
     1782      controllers</emphasis> connect physical disk drives to the rest of
     1783      the computer. Similarly, &product-name; presents virtual storage
     1784      controllers to a virtual machine. Under each controller, the
     1785      virtual devices, such as hard disks, CD/DVD or floppy drives,
     1786      attached to the controller are shown.
    18331787    </para>
    18341788
     
    18491803    <figure id="fig-storage-settings">
    18501804      <title>Storage Settings for a Virtual Machine</title>
    1851       <mediaobject>
     1805     <mediaobject>
    18521806        <imageobject>
    18531807          <imagedata align="center" fileref="images/vm-settings-harddisk.png"
     
    18551809        </imageobject>
    18561810      </mediaobject>
    1857     </figure>
     1811      </figure>
    18581812
    18591813    <para>
     
    19211875          To <emphasis role="bold">add another virtual hard disk, or a
    19221876          CD/DVD or floppy drive</emphasis>, select the storage
    1923           controller to which it should be added (IDE, SATA, SCSI, SAS,
    1924           floppy controller) and then click the
     1877          controller to which it should be added (such as IDE, SATA,
     1878          SCSI, SAS, floppy controller) and then click the
    19251879          <emphasis role="bold">Add Disk</emphasis> button below the
    1926           tree. You can then either select <emphasis role="bold">Add
    1927           CD/DVD Device</emphasis> or <emphasis role="bold">Add Hard
     1880          tree. You can then either select <emphasis role="bold">Optical
     1881          Drive</emphasis> or <emphasis role="bold">Hard
    19281882          Disk</emphasis>. If you clicked on a floppy controller, you
    19291883          can add a floppy drive instead. Alternatively, right-click on
     
    19321886
    19331887        <para>
    1934           On the right part of the window, you can then set the
    1935           following:
    1936         </para>
    1937 
    1938         <orderedlist>
     1888          A dialog is displayed, enabling you to select an existing disk
     1889          image file or to create a new disk image file. Depending on
     1890          the type of disk image, the dialog is called
     1891          <emphasis role="bold">Hard Disk Selector</emphasis>,
     1892          <emphasis role="bold">Optical Disk Selector</emphasis>, or
     1893          <emphasis role="bold">Floppy Disk Selector</emphasis>.
     1894        </para>
     1895
     1896        <para>
     1897          See <xref linkend="vdidetails"/> for information on the image
     1898          file types that are supported by &product-name;.
     1899        </para>
     1900
     1901        <para>
     1902          For virtual CD/DVD drives, the image files will typically be
     1903          in the standard ISO format instead. Most commonly, you will
     1904          select this option when installing an OS from an ISO file that
     1905          you have obtained from the Internet. For example, most Linux
     1906          distributions are available in this way.
     1907        </para>
     1908
     1909        <para>
     1910          Depending on the type of disk image, you can set the following
     1911          <emphasis role="bold">Attributes</emphasis> for the disk image
     1912          in the right part of the Storage settings page:
     1913        </para>
     1914
     1915        <itemizedlist>
    19391916
    19401917          <listitem>
     
    19521929          <listitem>
    19531930            <para>
    1954               The <emphasis role="bold">image file</emphasis> to use.
    1955             </para>
    1956 
    1957             <itemizedlist>
    1958 
    1959               <listitem>
    1960                 <para>
    1961                   For virtual hard disks, a button with a drop-down list
    1962                   appears on the right, offering you to either select a
    1963                   <emphasis role="bold">virtual hard disk
    1964                   file</emphasis> using a standard file dialog or to
    1965                   <emphasis role="bold">create a new hard
    1966                   disk</emphasis> (image file). The latter option
    1967                   displays the <emphasis role="bold">Create New
    1968                   Disk</emphasis> wizard, described in
    1969                   <xref linkend="gui-createvm" />.
    1970                 </para>
    1971 
    1972                 <para>
    1973                   For virtual floppy drives, a dialog enables you to
    1974                   create and format a new floppy disk image
    1975                   automatically.
    1976                 </para>
    1977 
    1978                 <para>
    1979                   For details on the image file types that are
    1980                   supported, see <xref linkend="vdidetails" />.
    1981                 </para>
    1982               </listitem>
    1983 
    1984               <listitem>
    1985                 <para>
    1986                   For virtual CD/DVD drives, the image files will
    1987                   typically be in the standard ISO format instead. Most
    1988                   commonly, you will select this option when installing
    1989                   an OS from an ISO file that you have obtained from the
    1990                   Internet. For example, most Linux distributions are
    1991                   available in this way.
    1992                 </para>
    1993 
    1994                 <para>
    1995                   For virtual CD/DVD drives, the following additional
    1996                   options are available:
    1997                 </para>
    1998 
    1999                 <itemizedlist>
    2000 
    2001                   <listitem>
    2002                     <para>
    2003                       If you select <emphasis role="bold">Host
    2004                       Drive</emphasis> from the list, then the physical
    2005                       device of the host computer is connected to the
    2006                       VM, so that the guest OS can read from and write
    2007                       to your physical device. This is, for instance,
    2008                       useful if you want to install Windows from a real
    2009                       installation CD. In this case, select your host
    2010                       drive from the drop-down list presented.
    2011                     </para>
    2012 
    2013                     <para>
    2014                       If you want to write, or burn, CDs or DVDs using
    2015                       the host drive, you need to also enable the
    2016                       <emphasis role="bold">Passthrough</emphasis>
    2017                       option. See <xref linkend="storage-cds" />.
    2018                     </para>
    2019                   </listitem>
    2020 
    2021                   <listitem>
    2022                     <para>
    2023                       If you select <emphasis role="bold">Remove Disk
    2024                       from Virtual Drive</emphasis>, &product-name; will
    2025                       present an empty CD/DVD drive to the guest into
    2026                       which no media has been inserted.
    2027                     </para>
    2028                   </listitem>
    2029 
    2030                 </itemizedlist>
    2031               </listitem>
    2032 
    2033             </itemizedlist>
    2034           </listitem>
    2035 
    2036         </orderedlist>
     1931              <emphasis role="bold">Solid-state Drive</emphasis>
     1932              presents a virtual disk to the guest as a solid-state
     1933              device.
     1934            </para>
     1935          </listitem>
     1936
     1937          <listitem>
     1938            <para>
     1939              <emphasis role="bold">Hot-pluggable</emphasis> presents a
     1940              virtual disk to the guest as a hot-pluggable device.
     1941            </para>
     1942          </listitem>
     1943
     1944          <listitem>
     1945            <para>
     1946              For virtual CD/DVD drives, you can select
     1947              <emphasis role="bold">Live CD/DVD</emphasis>. This means
     1948              that the virtual optical disk is not removed from when the
     1949              guest system ejects it.
     1950            </para>
     1951          </listitem>
     1952
     1953        </itemizedlist>
    20371954      </listitem>
    20381955
     
    21992116      <command>VBoxManage</command> command to set up virtual serial
    22002117      ports. For the latter, see <xref linkend="vboxmanage-modifyvm" />
    2201       for information on the <computeroutput>--uart</computeroutput>,
    2202       <computeroutput>--uartmode</computeroutput> and
    2203       <computeroutput>--uarttype</computeroutput> options.
     2118      for information on the <option>--uart</option>,
     2119      <option>--uartmode</option> and <option>--uarttype</option>
     2120      options.
    22042121    </para>
    22052122
     
    22502167          I/O base address and interrupt (IRQ).
    22512168        </para>
    2252 
    2253         <para>
    2254           See also
    2255           <ulink
    2256               url="http://en.wikipedia.org/wiki/COM_(hardware_interface)">http://en.wikipedia.org/wiki/COM_(hardware_interface)</ulink>.
    2257         </para>
    22582169      </listitem>
    22592170
     
    22802191              virtual serial port to a physical serial port on your
    22812192              host. On a Windows host, this will be a name like
    2282               <computeroutput>COM1</computeroutput>. On Linux or Oracle
    2283               Solaris hosts, it will be a device node like
    2284               <computeroutput>/dev/ttyS0</computeroutput>.
    2285               &product-name; will then simply redirect all data received
    2286               from and sent to the virtual serial port to the physical
    2287               device.
     2193              <literal>COM1</literal>. On Linux or Oracle Solaris hosts,
     2194              it will be a device node like
     2195              <filename>/dev/ttyS0</filename>. &product-name; will then
     2196              simply redirect all data received from and sent to the
     2197              virtual serial port to the physical device.
    22882198            </para>
    22892199          </listitem>
     
    23042214                  through a named pipe. The pipe name must be in the
    23052215                  format
    2306                   <computeroutput>\\.\pipe\&lt;name&gt;</computeroutput>
    2307                   where <computeroutput>&lt;name&gt;</computeroutput>
    2308                   should identify the virtual machine but may be freely
    2309                   chosen.
     2216                  <filename>\\.\pipe\<replaceable>name</replaceable></filename>
     2217                  where <replaceable>name</replaceable> should identify
     2218                  the virtual machine but may be freely chosen.
    23102219                </para>
    23112220              </listitem>
     
    23132222              <listitem>
    23142223                <para>
    2315                   On a Mac, Linux, or Oracle Solaris host, a local
     2224                  On a Mac OS, Linux, or Oracle Solaris host, a local
    23162225                  domain socket is used instead. The socket filename
    23172226                  must be chosen such that the user running
    23182227                  &product-name; has sufficient privileges to create and
    2319                   write to it. The <computeroutput>/tmp</computeroutput>
    2320                   directory is often a good candidate.
     2228                  write to it. The <filename>/tmp</filename> directory
     2229                  is often a good candidate.
    23212230                </para>
    23222231
     
    23242233                  On Linux there are various tools which can connect to
    23252234                  a local domain socket or create one in server mode.
    2326                   The most flexible tool is
    2327                   <computeroutput>socat</computeroutput> and is
    2328                   available as part of many distributions.
     2235                  The most flexible tool is <command>socat</command> and
     2236                  is available as part of many distributions.
    23292237                </para>
    23302238              </listitem>
     
    23962304                  a virtual null-modem cable over the Internet or LAN,
    23972305                  the other side can connect using TCP by specifying
    2398                   <computeroutput>hostname:port</computeroutput> in the
    2399                   <emphasis role="bold">Path/Address</emphasis> field.
    2400                   The TCP socket will act in client mode if you select
    2401                   the <emphasis role="bold">Connect to Existing
     2306                  <literal><replaceable>hostname</replaceable>:<replaceable>port</replaceable></literal>
     2307                  in the <emphasis role="bold">Path/Address</emphasis>
     2308                  field. The TCP socket will act in client mode if you
     2309                  select the <emphasis role="bold">Connect to Existing
    24022310                  Pipe/Socket</emphasis> check box.
    24032311                </para>
     
    25672475                in hexadecimal, and a colon separates the vendor from
    25682476                the product ID. For example,
    2569                 <computeroutput>046d:c016</computeroutput> stands for
    2570                 Logitech as a vendor, and the M-UV69a Optical Wheel
    2571                 Mouse product.
     2477                <literal>046d:c016</literal> stands for Logitech as a
     2478                vendor, and the M-UV69a Optical Wheel Mouse product.
    25722479              </para>
    25732480
     
    26512558        &product-name; to capture devices when they are plugged in, and
    26522559        a USB device driver to claim USB devices for a particular
    2653         virtual machine. As opposed to &product-name; versions before
    2654         1.4.0, system reboots are no longer necessary after installing
    2655         the driver. Also, you no longer need to replug devices for
    2656         &product-name; to claim them.
    2657       </para>
    2658 
    2659       <para>
    2660         On newer Linux hosts, &product-name; accesses USB devices
     2560        virtual machine. System reboots are not necessary after
     2561        installing the driver. Also, you do not need to replug devices
     2562        for &product-name; to claim them.
     2563      </para>
     2564
     2565      <para>
     2566        On supported Linux hosts, &product-name; accesses USB devices
    26612567        through special files in the file system. When &product-name; is
    26622568        installed, these are made available to all users in the
    2663         <computeroutput>vboxusers</computeroutput> system group. In
    2664         order to be able to access USB from guest systems, make sure
    2665         that you are a member of this group.
    2666       </para>
    2667 
    2668       <para>
    2669         On older Linux hosts, USB devices are accessed using the
    2670         <computeroutput>usbfs</computeroutput> file system. Therefore,
    2671         the user executing &product-name; needs read and write
    2672         permission to the USB file system. Most distributions provide a
    2673         group, such as <computeroutput>usbusers</computeroutput>, which
    2674         the &product-name; user needs to be added to. Also,
    2675         &product-name; can only proxy to virtual machines USB devices
    2676         which are not claimed by a Linux host USB driver. The
    2677         <computeroutput>Driver=</computeroutput> entry in
    2678         <computeroutput>/proc/bus/usb/devices</computeroutput> will show
    2679         you which devices are currently claimed. See also
    2680         <xref
    2681       linkend="ts_usb-linux" /> for details about
    2682         <computeroutput>usbfs</computeroutput>.
     2569        <literal>vboxusers</literal> system group. In order to be able
     2570        to access USB from guest systems, make sure that you are a
     2571        member of this group.
    26832572      </para>
    26842573
     
    27602649    <para>
    27612650      &product-name; includes experimental support for the Extensible
    2762       Firmware Interface (EFI), which is a new industry standard
    2763       intended to eventually replace the legacy BIOS as the primary
    2764       interface for bootstrapping computers and certain system services
    2765       later.
     2651      Firmware Interface (EFI), which is an industry standard intended
     2652      to replace the legacy BIOS as the primary interface for
     2653      bootstrapping computers and certain system services later.
    27662654    </para>
    27672655
     
    32253113      <para>
    32263114        It is currently not possible to manipulate EFI variables from
    3227         within a running guest. For example, setting the "boot-args"
    3228         variable by running the <computeroutput>nvram</computeroutput>
    3229         tool in a Mac OS X guest will not work. As an alternative way,
    3230         "VBoxInternal2/EfiBootArgs" extradata can be passed to a VM in
    3231         order to set the "boot-args" variable. To change the "boot-args"
    3232         EFI variable, use the following command:
     3115        within a running guest. For example, setting the
     3116        <literal>boot-args</literal> variable by running the
     3117        <command>nvram</command> tool in a Mac OS X guest will not work.
     3118        As an alternative method,
     3119        <literal>VBoxInternal2/EfiBootArgs</literal> extradata can be
     3120        passed to a VM in order to set the <literal>boot-args</literal>
     3121        variable. To change the <literal>boot-args</literal> EFI
     3122        variable, use the following command:
    32333123      </para>
    32343124
  • trunk/doc/manual/en_US/user_ChangeLog.xml

    r76786 r82350  
    4141
    4242    <para>
    43       <ulink url="https://www.virtualbox.org/wiki/Changelog">https://www.virtualbox.org/wiki/Changelog</ulink>.
     43      <ulink url="https://www.virtualbox.org/wiki/Changelog" />.
    4444    </para>
    4545
  • trunk/doc/manual/en_US/user_Frontends.xml

    r82045 r82350  
    3434    <para>
    3535      Oracle provides support for the VirtualBox Remote Display Protocol
    36       (VRDP) in such an &product-name; extension package. When this
    37       package is installed, &product-name; versions 4.0 and later
    38       support VRDP the same way as binary, non-open source, versions of
    39       &product-name; before 4.0 did.
     36      (VRDP) in such an &product-name; extension package.
    4037    </para>
    4138
     
    5552    </para>
    5653
    57 <screen>VBoxManage modifyvm "VM name" --vrde on</screen>
    58 
    59     <para>
    60       By default, the VRDP server uses TCP port
    61       <computeroutput>3389</computeroutput>. You will need to change the
    62       default port if you run more than one VRDP server, since the port
    63       can only be used by one server at a time. You might also need to
    64       change it on Windows hosts since the default port might already be
    65       used by the RDP server that is built into Windows itself. Ports
    66       5000 through 5050 are typically not used and might be a good
    67       choice.
     54<screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> --vrde on</screen>
     55
     56    <para>
     57      By default, the VRDP server uses TCP port <literal>3389</literal>.
     58      You will need to change the default port if you run more than one
     59      VRDP server, since the port can only be used by one server at a
     60      time. You might also need to change it on Windows hosts since the
     61      default port might already be used by the RDP server that is built
     62      into Windows itself. Ports 5000 through 5050 are typically not
     63      used and might be a good choice.
    6864    </para>
    6965
     
    7672      dash between two port numbers to specify a range. The VRDP server
    7773      will bind to <emphasis>one</emphasis> of the available ports from
    78       the specified list. For example, <computeroutput>VBoxManage
    79       modifyvm "VM name" --vrdeport 5000,5010-5012</computeroutput> will
    80       configure the server to bind to one of the ports 5000, 5010, 5011,
    81       or 5012. See <xref linkend="vboxmanage-modifyvm-vrde" />.
     74      the specified list. For example, <command>VBoxManage modifyvm
     75      <replaceable>VM-name</replaceable> --vrdeport
     76      5000,5010-5012</command> configures the server to bind to one of
     77      the ports 5000, 5010, 5011, or 5012. See
     78      <xref linkend="vboxmanage-modifyvm" />.
    8279    </para>
    8380
     
    9289
    9390    <para>
    94       Support for IPv6 has been implemented in &product-name; 4.3. If
    95       the host OS supports IPv6 the VRDP server will automatically
    96       listen for IPv6 connections in addition to IPv4.
     91      &product-name; supports IPv6. If the host OS supports IPv6 the
     92      VRDP server will automatically listen for IPv6 connections in
     93      addition to IPv4.
    9794    </para>
    9895
     
    134131
    135132          <para>
    136             Replace <computeroutput>1.2.3.4</computeroutput> with the
    137             host IP address, and <computeroutput>3389</computeroutput>
    138             with a different port, if necessary.
     133            Replace <literal>1.2.3.4</literal> with the host IP address,
     134            and <literal>3389</literal> with a different port, if
     135            necessary.
    139136          </para>
    140137
     
    145142                <para>
    146143                  IPv6 addresses must be enclosed in square brackets to
    147                   specify a port. For example: <computeroutput>mstsc
    148                   [fe80::1:2:3:4]:3389</computeroutput>
     144                  specify a port. For example: <literal>mstsc
     145                  [fe80::1:2:3:4]:3389</literal>
    149146                </para>
    150147              </listitem>
     
    153150                <para>
    154151                  When connecting to localhost in order to test the
    155                   connection, the addresses
    156                   <computeroutput>localhost</computeroutput> and
    157                   <computeroutput>127.0.0.1</computeroutput> might not
    158                   work using <command>mstsc.exe</command>. Instead, the
    159                   address
    160                   <computeroutput>127.0.0.2[:3389]</computeroutput> has
    161                   to be used.
     152                  connection, the addresses <literal>localhost</literal>
     153                  and <literal>127.0.0.1</literal> might not work using
     154                  <command>mstsc.exe</command>. Instead, the address
     155                  <literal>127.0.0.2[:3389]</literal> has to be used.
    162156                </para>
    163157              </listitem>
     
    181175          </para>
    182176
    183 <screen>rdesktop -a 16 -N 1.2.3.4:3389</screen>
    184 
    185           <para>
    186             Replace <computeroutput>1.2.3.4</computeroutput> with the
    187             host IP address, and <computeroutput>3389</computeroutput>
    188             with a different port, if necessary. The <computeroutput>-a
    189             16</computeroutput> option requests a color depth of 16 bits
    190             per pixel, which we recommend. For best performance, after
    191             installation of the guest operating system, you should set
    192             its display color depth to the same value. The
    193             <computeroutput>-N</computeroutput> option enables use of
    194             the NumPad keys.
     177<screen>$ rdesktop -a 16 -N 1.2.3.4:3389</screen>
     178
     179          <para>
     180            Replace <literal>1.2.3.4</literal> with the host IP address,
     181            and <literal>3389</literal> with a different port, if
     182            necessary. The <option>-a 16</option> option requests a
     183            color depth of 16 bits per pixel, which we recommend. For
     184            best performance, after installation of the guest operating
     185            system, you should set its display color depth to the same
     186            value. The <option>-N</option> option enables use of the
     187            NumPad keys.
    195188          </para>
    196189        </listitem>
     
    207200          <para>
    208201            If you run the KDE desktop, you can use
    209             <computeroutput>krdc</computeroutput>, the KDE RDP viewer. A
    210             typical command line is as follows:
    211           </para>
    212 
    213 <screen>krdc rdp://1.2.3.4:3389</screen>
    214 
    215           <para>
    216             Replace <computeroutput>1.2.3.4</computeroutput> with the
    217             host IP address, and <computeroutput>3389</computeroutput>
    218             with a different port, if necessary. The "rdp://" prefix is
    219             required with krdc to switch it into RDP mode.
     202            <command>krdc</command>, the KDE RDP viewer. A typical
     203            command line is as follows:
     204          </para>
     205
     206<screen>$ krdc rdp://1.2.3.4:3389</screen>
     207
     208          <para>
     209            Replace <literal>1.2.3.4</literal> with the host IP address,
     210            and <literal>3389</literal> with a different port, if
     211            necessary. The <literal>rdp:// </literal> prefix is required
     212            with <command>krdc</command> to switch it into RDP mode.
    220213          </para>
    221214        </listitem>
     
    241234        While any VM started from the VirtualBox Manager is capable of
    242235        running virtual machines remotely, it is not convenient to have
    243         to run the full-fledged GUI if you never want to have VMs
    244         displayed locally in the first place. In particular, if you are
    245         running server hardware whose only purpose is to host VMs, and
    246         all your VMs are supposed to run remotely over VRDP, then it is
    247         pointless to have a graphical user interface on the server at
    248         all. This is especially true for Linux or Oracle Solaris hosts,
    249         as the VirtualBox Manager comes with dependencies on the Qt and
    250         SDL libraries. This is inconvenient if you would rather not have
    251         the X Window system on your server at all.
     236        to run the full GUI if you never want to have VMs displayed
     237        locally in the first place. In particular, if you are running
     238        server hardware whose only purpose is to host VMs, and all your
     239        VMs are supposed to run remotely over VRDP, then it is pointless
     240        to have a graphical user interface on the server at all. This is
     241        especially true for Linux or Oracle Solaris hosts, as the
     242        VirtualBox Manager comes with dependencies on the Qt and SDL
     243        libraries. This is inconvenient if you would rather not have the
     244        X Window system on your server at all.
    252245      </para>
    253246
    254247      <para>
    255248        &product-name; therefore comes with a front-end called
    256         <computeroutput>VBoxHeadless</computeroutput>, which produces no
    257         visible output on the host at all, but still can optionally deliver
    258         VRDP data. This front-end has no dependencies on the X Window system
     249        <command>VBoxHeadless</command>, which produces no visible
     250        output on the host at all, but still can optionally deliver VRDP
     251        data. This front-end has no dependencies on the X Window system
    259252        on Linux and Oracle Solaris hosts.
    260253      </para>
     
    262255      <note>
    263256        <para>
    264           Before &product-name; 1.6, the headless server was called
    265           <computeroutput>VBoxVRDP</computeroutput>. For the sake of
    266           backwards compatibility, the &product-name; installation still
    267           installs an executable with that name as well.
     257          In legacy releases of &product-name;, the headless server was
     258          called <command>VBoxVRDP</command>. For backwards
     259          compatibility, the &product-name; installation still includes
     260          an executable with that name.
    268261        </para>
    269262      </note>
    270263
    271264      <para>
    272         To start a virtual machine with
    273         <computeroutput>VBoxHeadless</computeroutput>, you have the
    274         following options:
     265        To start a virtual machine with <command>VBoxHeadless</command>,
     266        you have the following options:
    275267      </para>
    276268
     
    282274          </para>
    283275
    284 <screen>VBoxManage startvm "VM name" --type headless</screen>
    285 
    286           <para>
    287             The <computeroutput>--type</computeroutput> option causes
    288             &product-name; to use
    289             <computeroutput>VBoxHeadless</computeroutput> as the
    290             front-end to the internal virtualization engine, instead of
    291             the Qt front-end.
     276<screen>$ VBoxManage startvm <replaceable>VM-name</replaceable> --type headless</screen>
     277
     278          <para>
     279            The <option>--type</option> option causes &product-name; to
     280            use <command>VBoxHeadless</command> as the front-end to the
     281            internal virtualization engine, instead of the Qt front-end.
    292282          </para>
    293283        </listitem>
     
    298288          </para>
    299289
    300 <screen>VBoxHeadless --startvm &lt;uuid|name&gt;</screen>
     290<screen>VBoxHeadless --startvm <replaceable>uuid</replaceable>|<replaceable>vmname</replaceable></screen>
    301291
    302292          <para>
     
    309299            directly as a background process which has to be done
    310300            explicitly when directly starting with
    311             <computeroutput>VBoxHeadless</computeroutput>. The full
    312             documentation of the command is in
    313             <xref linkend="man_vboxheadless"/>.
    314           </para>
    315         </listitem>
    316 
    317         <listitem>
    318           <para>
    319             Start <computeroutput>VBoxHeadless</computeroutput> from the
    320             VirtualBox Manager GUI, by pressing the Shift key when
    321             starting a virtual machine or by selecting
     301            <command>VBoxHeadless</command>. The full documentation of
     302            the command is in <xref linkend="man_vboxheadless"/>.
     303          </para>
     304        </listitem>
     305
     306        <listitem>
     307          <para>
     308            Start <command>VBoxHeadless</command> from the VirtualBox
     309            Manager GUI, by pressing the Shift key when starting a
     310            virtual machine or by selecting
    322311            <emphasis role="bold">Headless Start</emphasis> from the
    323312            <emphasis role="bold">Machine</emphasis> menu.
     
    328317
    329318      <para>
    330         When you use the <computeroutput>VBoxHeadless</computeroutput>
    331         command to start a VM, the VRDP server will be enabled according
    332         to the VM configuration. You can override the VM's setting using
    333         <computeroutput>--vrde</computeroutput> command line parameter.
    334         To enable the VRDP server, start the VM as follows:
    335       </para>
    336 
    337 <screen>VBoxHeadless --startvm &lt;uuid|name&gt; --vrde on</screen>
     319        When you use the <command>VBoxHeadless</command> command to
     320        start a VM, the VRDP server will be enabled according to the VM
     321        configuration. You can override the VM's setting using
     322        <option>--vrde</option> command line parameter. To enable the
     323        VRDP server, start the VM as follows:
     324      </para>
     325
     326<screen>VBoxHeadless --startvm <replaceable>uuid</replaceable>|<replaceable>vmname</replaceable> --vrde on</screen>
    338327
    339328      <para>
     
    341330      </para>
    342331
    343 <screen>VBoxHeadless --startvm &lt;uuid|name&gt; --vrde off</screen>
     332<screen>VBoxHeadless --startvm <replaceable>uuid</replaceable>|<replaceable>vmname</replaceable> --vrde off</screen>
    344333
    345334      <para>
     
    348337      </para>
    349338
    350 <screen>VBoxHeadless --startvm &lt;uuid|name&gt; --vrde config</screen>
     339<screen>VBoxHeadless --startvm <replaceable>uuid</replaceable>|<replaceable>vmname</replaceable> --vrde config</screen>
    351340
    352341      <para>
     
    354343      </para>
    355344
    356 <screen>VBoxHeadless --startvm &lt;uuid|name&gt;</screen>
     345<screen>VBoxHeadless --startvm <replaceable>uuid</replaceable>|<replaceable>vmname</replaceable></screen>
    357346
    358347      <para>
     
    398387          <para>
    399388            A terminal connection to that host through which you can
    400             access a command line, such as
    401             <computeroutput>ssh</computeroutput>.
     389            access a command line, such as <command>ssh</command>.
    402390          </para>
    403391        </listitem>
     
    428416
    429417          <para>
    430             If you do not specify
    431             <computeroutput>--register</computeroutput>, you will have
    432             to manually use the <command>registervm</command> command
    433             later.
    434           </para>
    435 
    436           <para>
    437             You do not need to specify
    438             <computeroutput>--ostype</computeroutput>, but doing so
    439             selects some sensible default values for certain VM
     418            If you do not specify <option>--register</option>, you will
     419            have to manually use the <command>registervm</command>
     420            command later.
     421          </para>
     422
     423          <para>
     424            You do not need to specify <option>--ostype</option>, but
     425            doing so selects some sensible default values for certain VM
    440426            parameters. For example, the RAM size and the type of the
    441427            virtual network device. To get a complete list of supported
     
    564550        supports this extension. On Linux and Oracle Solaris hosts, the
    565551        &product-name; installation provides a suitable VRDP client
    566         called <command>rdesktop-vrdp</command>. Recent versions of
     552        called <command>rdesktop-vrdp</command>. Some versions of
    567553        <command>uttsc</command>, a client tailored for the use with Sun
    568554        Ray thin clients, also support accessing remote USB devices. RDP
     
    628614              <para>
    629615                The default authentication library,
    630                 <computeroutput>VBoxAuth</computeroutput>, authenticates
    631                 against user credentials of the hosts. Depending on the
    632                 host platform, this means the following:
     616                <command>VBoxAuth</command>, authenticates against user
     617                credentials of the hosts. Depending on the host
     618                platform, this means the following:
    633619              </para>
    634620
     
    637623                <listitem>
    638624                  <para>
    639                     On Linux hosts,
    640                     <computeroutput>VBoxAuth.so</computeroutput>
     625                    On Linux hosts, <command>VBoxAuth.so</command>
    641626                    authenticates users against the host's PAM system.
    642627                  </para>
     
    645630                <listitem>
    646631                  <para>
    647                     On Windows hosts,
    648                     <computeroutput>VBoxAuth.dll</computeroutput>
     632                    On Windows hosts, <command>VBoxAuth.dll</command>
    649633                    authenticates users against the host's WinLogon
    650634                    system.
     
    654638                <listitem>
    655639                  <para>
    656                     On Mac OS X hosts,
    657                     <computeroutput>VBoxAuth.dylib</computeroutput>
     640                    On Mac OS X hosts, <command>VBoxAuth.dylib</command>
    658641                    authenticates users against the host's directory
    659642                    service.
     
    675658              <para>
    676659                An additional library called
    677                 <computeroutput>VBoxAuthSimple</computeroutput> performs
     660                <command>VBoxAuthSimple</command> performs
    678661                authentication against credentials configured in the
    679                 "extradata" section of a virtual machine's XML settings
    680                 file. This is probably the simplest way to get
    681                 authentication that does not depend on a running and
    682                 supported guest. The following steps are required:
     662                <literal>extradata</literal> section of a virtual
     663                machine's XML settings file. This is probably the
     664                simplest way to get authentication that does not depend
     665                on a running and supported guest. The following steps
     666                are required:
    683667              </para>
    684668
     
    687671                <listitem>
    688672                  <para>
    689                     Enable
    690                     <computeroutput>VBoxAuthSimple</computeroutput> with
    691                     the following command:
     673                    Enable <command>VBoxAuthSimple</command> with the
     674                    following command:
    692675                  </para>
    693676
     
    701684                  </para>
    702685
    703 <screen>VBoxManage modifyvm "VM name" --vrdeauthtype external</screen>
     686<screen>VBoxManage modifyvm <replaceable>VM-name</replaceable> --vrdeauthtype external</screen>
    704687
    705688                  <para>
    706                     Replace <computeroutput>&lt;vm&gt;</computeroutput>
    707                     with the VM name or UUID.
     689                    Replace <replaceable>VM-name</replaceable> with the
     690                    VM name or UUID.
    708691                  </para>
    709692                </listitem>
     
    714697                    writing items into the machine's extradata. Since
    715698                    the XML machine settings file, into whose
    716                     <computeroutput>extradata</computeroutput> section
    717                     the password needs to be written, is a plain text
    718                     file, &product-name; uses hashes to encrypt
    719                     passwords. The following command must be used:
     699                    <literal>extradata</literal> section the password
     700                    needs to be written, is a plain text file,
     701                    &product-name; uses hashes to encrypt passwords. The
     702                    following command must be used:
    720703                  </para>
    721704
    722 <screen>VBoxManage setextradata "VM name" "VBoxAuthSimple/users/&lt;user&gt;" &lt;hash&gt;</screen>
     705<screen>VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxAuthSimple/users/<replaceable>user</replaceable>" <replaceable>hash</replaceable></screen>
    723706
    724707                  <para>
    725                     Replace <computeroutput>&lt;vm&gt;</computeroutput>
    726                     with the VM name or UUID,
    727                     <computeroutput>&lt;user&gt;</computeroutput> with
    728                     the user name who should be allowed to log in and
    729                     <computeroutput>&lt;hash&gt;</computeroutput> with
    730                     the encrypted password. As an example, to obtain the
    731                     hash value for the password
    732                     <computeroutput>secret</computeroutput>, you can use
    733                     the following command:
     708                    Replace <replaceable>VM-name</replaceable> with the
     709                    VM name or UUID, <replaceable>user</replaceable>
     710                    with the user name who should be allowed to log in
     711                    and <replaceable>hash</replaceable> with the
     712                    encrypted password. The following command example
     713                    obtains the hash value for the password
     714                    <literal>secret</literal>:
    734715                  </para>
    735716
    736 <screen>VBoxManage internalcommands passwordhash "secret"</screen>
    737 
    738                   <para>
    739                     This command will generate output similar to the
    740                     following:
    741                   </para>
    742 
    743 <screen>2bb80d537b1da3e38bd30361aa855686bde0eacd7162fef6a25fe97bf527a25b</screen>
     717<screen>$ VBoxManage internalcommands passwordhash "secret"
     7182bb80d537b1da3e38bd30361aa855686bde0eacd7162fef6a25fe97bf527a25b</screen>
    744719
    745720                  <para>
    746721                    You then use <command>VBoxManage
    747722                    setextradata</command> to store this value in the
    748                     machine's <computeroutput>extradata</computeroutput>
    749                     section.
     723                    machine's <literal>extradata</literal> section.
    750724                  </para>
    751725
    752726                  <para>
    753727                    As a combined example, to set the password for the
    754                     user <computeroutput>john</computeroutput> and the
    755                     machine <computeroutput>My VM</computeroutput> to
    756                     <computeroutput>secret</computeroutput>, use this
    757                     command:
     728                    user <literal>john</literal> and the machine
     729                    <literal>My VM</literal> to
     730                    <literal>secret</literal>, use this command:
    758731                  </para>
    759732
     
    814787        <listitem>
    815788          <para>
    816             <emphasis role="bold">RDP4</emphasis> authentication was
    817             used historically. With RDP4, the RDP client does not
     789            <emphasis role="bold">RDP 4</emphasis> authentication was
     790            used historically. With RDP 4, the RDP client does not
    818791            perform any checks in order to verify the identity of the
    819792            server it connects to. Since user credentials can be
     
    825798        <listitem>
    826799          <para>
    827             <emphasis role="bold">RDP5.1</emphasis> authentication
     800            <emphasis role="bold">RDP 5.1</emphasis> authentication
    828801            employs a server certificate for which the client possesses
    829802            the public key. This way it is guaranteed that the server
    830803            possess the corresponding private key. However, as this
    831             hard-coded private key became public some years ago, RDP5.1
     804            hard-coded private key became public some years ago, RDP 5.1
    832805            authentication is also insecure.
    833806          </para>
     
    836809        <listitem>
    837810          <para>
    838             <emphasis role="bold">RDP5.2</emphasis> authentication uses
    839             Enhanced RDP Security, which means that an external security
    840             protocol is used to secure the connection. RDP4 and RDP5.1
    841             use Standard RDP Security. The VRDP server supports Enhanced
    842             RDP Security with TLS protocol and, as a part of TLS
    843             handshake, sends the server certificate to the client.
    844           </para>
    845 
    846           <para>
    847             The <computeroutput>Security/Method</computeroutput> VRDE
    848             property sets the desired security method, which is used for
    849             a connection. Valid values are as follows:
     811            <emphasis role="bold">RDP 5.2 or later</emphasis>
     812            authentication uses Enhanced RDP Security, which means that
     813            an external security protocol is used to secure the
     814            connection. RDP 4 and RDP 5.1 use Standard RDP Security. The
     815            VRDP server supports Enhanced RDP Security with TLS protocol
     816            and, as a part of the TLS handshake, sends the server
     817            certificate to the client.
     818          </para>
     819
     820          <para>
     821            The <literal>Security/Method</literal> VRDE property sets
     822            the desired security method, which is used for a connection.
     823            Valid values are as follows:
    850824          </para>
    851825
     
    875849
    876850              <para>
    877                 The OpenSSL library version determines which versions of
    878                 TLS are supported. The &product-name; clients include at
    879                 least Version 1.1.0 of the OpenSSL library. This library
    880                 supports TLS versions 1.0, 1.1, and 1.2. Some clients
    881                 might include newer versions of the OpenSSL library and
    882                 thus support additional TLS versions.
     851                The version of OpenSSL used by &product-name; supports
     852                TLS versions 1.0, 1.1, 1.2, and 1.3.
    883853              </para>
    884854            </listitem>
     
    891861          </para>
    892862
    893 <screen>vboxmanage modifyvm "VM name" --vrdeproperty "Security/Method=negotiate"</screen>
    894 
    895           <para>
    896             If the <computeroutput>Security/Method</computeroutput>
    897             property is set to either Negotiate or TLS, the TLS protocol
    898             will be automatically used by the server, if the client
    899             supports TLS. However, in order to use TLS the server must
    900             possess the Server Certificate, the Server Private Key and
    901             the Certificate Authority (CA) Certificate. The following
     863<screen>vboxmanage modifyvm <replaceable>VM-name</replaceable> --vrdeproperty "Security/Method=negotiate"</screen>
     864
     865          <para>
     866            If the <literal>Security/Method</literal> property is set to
     867            either Negotiate or TLS, the TLS protocol will be
     868            automatically used by the server, if the client supports
     869            TLS. However, in order to use TLS the server must possess
     870            the Server Certificate, the Server Private Key and the
     871            Certificate Authority (CA) Certificate. The following
    902872            example shows how to generate a server certificate.
    903873          </para>
     
    939909          </para>
    940910
    941 <screen>vboxmanage modifyvm "VM name" \
     911<screen>vboxmanage modifyvm <replaceable>VM-name</replaceable> \
    942912  --vrdeproperty "Security/CACertificate=path/ca_cert.pem"</screen>
    943913
    944 <screen>vboxmanage modifyvm "VM name" \
     914<screen>vboxmanage modifyvm <replaceable>VM-name</replaceable> \
    945915  --vrdeproperty "Security/ServerCertificate=path/server_cert.pem"</screen>
    946916
    947 <screen>vboxmanage modifyvm "VM name" \
     917<screen>vboxmanage modifyvm <replaceable>VM-name</replaceable> \
    948918  --vrdeproperty "Security/ServerPrivateKey=path/server_key_private.pem"</screen>
    949919        </listitem>
     
    954924        As the client that connects to the server determines what type
    955925        of encryption will be used, with <command>rdesktop</command>,
    956         the Linux RDP viewer, use the
    957         <computeroutput>-4</computeroutput> or
    958         <computeroutput>-5</computeroutput> options.
     926        the Linux RDP viewer, use the <option>-4</option> or
     927        <option>-5</option> options.
    959928      </para>
    960929
     
    978947      </para>
    979948
    980 <screen>VBoxManage modifyvm "VM name" --vrdemulticon on</screen>
     949<screen>VBoxManage modifyvm <replaceable>VM-name</replaceable> --vrdemulticon on</screen>
    981950
    982951    </sect2>
     
    994963      <para>
    995964        The RDP client can select the virtual monitor number to connect
    996         to using the <computeroutput>domain</computeroutput> login
    997         parameter (<computeroutput>-d</computeroutput>). If the
    998         parameter ends with <computeroutput>@</computeroutput> followed
    999         by a number, &product-name; interprets this number as the screen
    1000         index. The primary guest screen is selected with
    1001         <computeroutput>@1</computeroutput>, the first secondary screen
    1002         is <computeroutput>@2</computeroutput>, and so on.
    1003       </para>
    1004 
    1005       <para>
    1006         The Microsoft RDP6 client does not let you specify a separate
     965        to using the <literal>domain</literal> login parameter
     966        (<option>-d</option>). If the parameter ends with
     967        <literal>@</literal> followed by a number, &product-name;
     968        interprets this number as the screen index. The primary guest
     969        screen is selected with <literal>@1</literal>, the first
     970        secondary screen is <literal>@2</literal>, and so on.
     971      </para>
     972
     973      <para>
     974        The Microsoft RDP 6 client does not let you specify a separate
    1007975        domain name. Instead, enter
    1008         <computeroutput>domain\username</computeroutput> in the
    1009         <emphasis role="bold">Username</emphasis> field. For example,
    1010         <computeroutput>@2\name</computeroutput>.
    1011         <computeroutput>name</computeroutput> must be supplied, and must
    1012         be the name used to log in if the VRDP server is set up to
    1013         require credentials. If it is not, you may use any text as the
    1014         username.
     976        <literal><replaceable>domain</replaceable>\<replaceable>username</replaceable></literal>
     977        in the <emphasis role="bold">Username</emphasis> field. For
     978        example, <literal>@2\<replaceable>name</replaceable></literal>.
     979        <replaceable>name</replaceable> must be supplied, and must be
     980        the name used to log in if the VRDP server is set up to require
     981        credentials. If it is not, you may use any text as the username.
    1015982      </para>
    1016983
     
    10481015      </para>
    10491016
    1050 <screen>VBoxManage modifyvm "VM name" --vrdevideochannel on</screen>
     1017<screen>VBoxManage modifyvm <replaceable>VM-name</replaceable> --vrdevideochannel on</screen>
    10511018
    10521019      <para>
     
    10571024      </para>
    10581025
    1059 <screen>VBoxManage modifyvm "VM name" --vrdevideochannelquality 75</screen>
     1026<screen>VBoxManage modifyvm <replaceable>VM-name</replaceable> --vrdevideochannelquality 75</screen>
    10601027
    10611028    </sect2>
     
    10661033
    10671034      <para>
    1068         With &product-name; it is possible to disable display output,
    1069         mouse and keyboard input, audio, remote USB, or clipboard
    1070         individually in the VRDP server.
     1035        You can disable display output, mouse and keyboard input, audio,
     1036        remote USB, or clipboard individually in the VRDP server.
    10711037      </para>
    10721038
     
    10751041      </para>
    10761042
    1077 <screen>VBoxManage modifyvm "VM name" --vrdeproperty Client/DisableDisplay=1
    1078 VBoxManage modifyvm "VM name" --vrdeproperty Client/DisableInput=1
    1079 VBoxManage modifyvm "VM name" --vrdeproperty Client/DisableUSB=1
    1080 VBoxManage modifyvm "VM name" --vrdeproperty Client/DisableAudio=1
    1081 VBoxManage modifyvm "VM name" --vrdeproperty Client/DisableClipboard=1
    1082 VBoxManage modifyvm "VM name" --vrdeproperty Client/DisableUpstreamAudio=1</screen>
     1043<screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> --vrdeproperty Client/DisableDisplay=1
     1044$ VBoxManage modifyvm <replaceable>VM-name</replaceable> --vrdeproperty Client/DisableInput=1
     1045$ VBoxManage modifyvm <replaceable>VM-name</replaceable> --vrdeproperty Client/DisableUSB=1
     1046$ VBoxManage modifyvm <replaceable>VM-name</replaceable> --vrdeproperty Client/DisableAudio=1
     1047$ VBoxManage modifyvm <replaceable>VM-name</replaceable> --vrdeproperty Client/DisableClipboard=1
     1048$ VBoxManage modifyvm <replaceable>VM-name</replaceable> --vrdeproperty Client/DisableUpstreamAudio=1</screen>
    10831049
    10841050      <para>
     
    10871053      </para>
    10881054
    1089 <screen>VBoxManage modifyvm "VM name" --vrdeproperty Client/DisableDisplay=</screen>
     1055<screen>$ VBoxManage modifyvm <replaceable>VM-name</replaceable> --vrdeproperty Client/DisableDisplay=</screen>
    10901056
    10911057    </sect2>
     
    11741140        </para>
    11751141
    1176 <screen>VBoxManage modifyvm &lt;targetvmname&gt; --teleporter on --teleporterport &lt;port&gt;</screen>
     1142<screen>VBoxManage modifyvm <replaceable>targetvmname</replaceable> --teleporter on --teleporterport <replaceable>port</replaceable></screen>
    11771143
    11781144        <para>
    1179           where <computeroutput>&lt;targetvmname&gt;</computeroutput> is
    1180           the name of the virtual machine on the target host and
    1181           <computeroutput>&lt;port&gt;</computeroutput> is a TCP/IP port
    1182           number to be used on both the source and the target hosts. For
    1183           example, use 6000. See
    1184           <xref linkend="vboxmanage-modifyvm-teleport" />.
     1145          <replaceable>targetvmname</replaceable> is the name of the
     1146          virtual machine on the target host and
     1147          <replaceable>port</replaceable> is a TCP/IP port number to be
     1148          used on both the source and the target hosts. For example, use
     1149          6000. See <xref linkend="vboxmanage-modifyvm" />.
    11851150        </para>
    11861151      </listitem>
     
    12011166        </para>
    12021167
    1203 <screen>VBoxManage controlvm &lt;sourcevmname&gt; teleport --host &lt;targethost&gt; --port &lt;port&gt;</screen>
     1168<screen>VBoxManage controlvm <replaceable>sourcevmname</replaceable> teleport --host <replaceable>targethost</replaceable> --port <replaceable>port</replaceable></screen>
    12041169
    12051170        <para>
    1206           where <computeroutput>&lt;sourcevmname&gt;</computeroutput> is
    1207           the name of the virtual machine on the source host, which is
    1208           the machine that is currently running.
    1209           <computeroutput>&lt;targethost&gt;</computeroutput> is the
    1210           host or IP name of the target host on which the machine is
    1211           waiting for the teleport request, and
    1212           <computeroutput>&lt;port&gt;</computeroutput> must be the same
    1213           number as specified in the command on the target host. See
    1214           <xref linkend="vboxmanage-controlvm" />.
     1171          where <replaceable>sourcevmname</replaceable> is the name of
     1172          the virtual machine on the source host, which is the machine
     1173          that is currently running.
     1174          <replaceable>targethost</replaceable> is the host or IP name
     1175          of the target host on which the machine is waiting for the
     1176          teleport request, and <replaceable>port</replaceable> must be
     1177          the same number as specified in the command on the target
     1178          host. See <xref linkend="vboxmanage-controlvm" />.
    12151179        </para>
    12161180      </listitem>
     
    12341198        capabilities are presented to the guest operating system.
    12351199        Advanced users can attempt to restrict these virtual CPU
    1236         capabilities with the <computeroutput>VBoxManage modifyvm
    1237         --cpuid</computeroutput> command. See
    1238         <xref linkend="vboxmanage-modifyvm-teleport" />.
     1200        capabilities with the <command>VBoxManage modifyvm
     1201        --cpuid</command> command. See
     1202        <xref linkend="vboxmanage-modifyvm" />.
    12391203      </para>
    12401204    </note>
     
    12441208  <xi:include href="user_man_VBoxHeadless.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
    12451209
    1246 
    12471210</chapter>
  • trunk/doc/manual/en_US/user_Glossary.xml

    r76078 r82350  
    138138          application programming interfaces which can be accessed from
    139139          various other programming languages and applications.
    140           &product-name; makes use of COM both internally and externally to
    141           provide a comprehensive API to 3rd party developers.
     140          &product-name; makes use of COM both internally and externally
     141          to provide a comprehensive API to 3rd party developers.
    142142        </para>
    143143
     
    221221          "command line interface". In the context of &product-name;, we
    222222          sometimes refer to the main graphical
    223           <computeroutput>VirtualBox</computeroutput> program as the
    224           "GUI", to differentiate it from the
    225           <command>VBoxManage</command> interface.
     223          <command>VirtualBox</command> program as the "GUI", to
     224          differentiate it from the <command>VBoxManage</command>
     225          interface.
    226226        </para>
    227227
     
    300300          card. It is typically written in hexadecimal notation where
    301301          the bytes are separated by colons, such as
    302           <computeroutput>00:17:3A:5E:CB:08</computeroutput>.
     302          <literal>00:17:3A:5E:CB:08</literal>.
    303303        </para>
    304304
     
    339339          target IP addresses of network packets according to specific
    340340          rules. Commonly employed by routers and firewalls to shield an
    341           internal network from the Internet, &product-name; can use NAT to
    342           easily share a host's physical networking hardware with its
     341          internal network from the Internet, &product-name; can use NAT
     342          to easily share a host's physical networking hardware with its
    343343          virtual machines. See <xref
    344344        linkend="network_nat" />.
     
    382382          Physical Address Extension. This enables access to more than 4
    383383          GB of RAM, even in 32-bit environments. See
    384           <xref
    385         linkend="settings-general-advanced" />.
     384          <xref linkend="settings-general-advanced" />.
    386385        </para>
    387386
     
    435434          transferred in both directions. Typically graphics updates and
    436435          audio are sent from the remote machine and keyboard and mouse
    437           input events are sent from the client. An &product-name; extension
    438           package by Oracle provides VRDP, an enhanced implementation of
    439           the relevant standards which is largely compatible with
    440           Microsoft's RDP implementation. See <xref linkend="vrde" />
    441           for details.
     436          input events are sent from the client. An &product-name;
     437          extension package by Oracle provides VRDP, an enhanced
     438          implementation of the relevant standards which is largely
     439          compatible with Microsoft's RDP implementation. See
     440          <xref linkend="vrde" /> for details.
    442441        </para>
    443442
     
    537536          UNIX versions for backing up data on tape. The file format is
    538537          still widely used today. For example, with OVF archives using
    539           an <computeroutput>.ova</computeroutput> file extension. See
     538          an <filename>.ova</filename> file extension. See
    540539          <xref
    541540        linkend="ovf" />.
     
    561560          and letters which can be computed dynamically and is
    562561          guaranteed to be unique. Generally, it is used as a global
    563           handle to identify entities. &product-name; makes use of UUIDs to
    564           identify VMs, Virtual Disk Images (VDI files), and other
     562          handle to identify entities. &product-name; makes use of UUIDs
     563          to identify VMs, Virtual Disk Images (VDI files), and other
    565564          entities.
    566565        </para>
     
    581580
    582581        <para>
    583           Virtual Machine. A virtual computer that &product-name; enables
    584           you to run on top of your actual hardware. See
     582          Virtual Machine. A virtual computer that &product-name;
     583          enables you to run on top of your actual hardware. See
    585584          <xref
    586585        linkend="virtintro" /> for details.
     
    612611        <para>
    613612          VirtualBox Remote Desktop Extension. This interface is built
    614           into &product-name; to allow &product-name; extension packages to
    615           supply remote access to virtual machines. An &product-name;
     613          into &product-name; to allow &product-name; extension packages
     614          to supply remote access to virtual machines. An &product-name;
    616615          extension package by Oracle provides VRDP support. See
    617616          <xref linkend="vrde" />.
     
    689688          infrastructure developed by the Mozilla browser project which
    690689          is similar to Microsoft COM and enables applications to
    691           provide a modular programming interface. &product-name; makes use
    692           of XPCOM on Linux both internally and externally to provide a
    693           comprehensive API to third-party developers.
     690          provide a modular programming interface. &product-name; makes
     691          use of XPCOM on Linux both internally and externally to
     692          provide a comprehensive API to third-party developers.
    694693        </para>
    695694
  • trunk/doc/manual/en_US/user_GuestAdditions.xml

    r76786 r82350  
    3636      The &product-name; Guest Additions for all supported guest
    3737      operating systems are provided as a single CD-ROM image file which
    38       is called <computeroutput>VBoxGuestAdditions.iso</computeroutput>.
    39       This image file is located in the installation directory of
    40       &product-name;. To install the Guest Additions for a particular
    41       VM, you mount this ISO file in your VM as a virtual CD-ROM and
    42       install from there.
     38      is called <filename>VBoxGuestAdditions.iso</filename>. This image
     39      file is located in the installation directory of &product-name;.
     40      To install the Guest Additions for a particular VM, you mount this
     41      ISO file in your VM as a virtual CD-ROM and install from there.
    4342    </para>
    4443
     
    5655          you with seamless mouse support. You will only have one mouse
    5756          pointer and pressing the Host key is no longer required to
    58           "free" the mouse from being captured by the guest OS. To make
    59           this work, a special mouse driver is installed in the guest
    60           that communicates with the "real" mouse driver on your host
    61           and moves the guest mouse pointer accordingly.
     57          <emphasis>free</emphasis> the mouse from being captured by the
     58          guest OS. To make this work, a special mouse driver is
     59          installed in the guest that communicates with the physical
     60          mouse driver on your host and moves the guest mouse pointer
     61          accordingly.
    6262        </para>
    6363      </listitem>
     
    7171          folder, and &product-name; will make it available to the guest
    7272          operating system as a network share, irrespective of whether
    73           guest actually has a network. See
    74           <xref
    75             linkend="sharedfolders" />.
     73          the guest actually has a network. See
     74          <xref linkend="sharedfolders" />.
    7675        </para>
    7776      </listitem>
     
    118117          <emphasis role="bold">Generic host/guest communication
    119118          channels.</emphasis> The Guest Additions enable you to control
    120           and monitor guest execution. The "guest properties" provide a
    121           generic string-based mechanism to exchange data bits between a
    122           guest and a host, some of which have special meanings for
    123           controlling and monitoring the guest. See
    124           <xref linkend="guestadd-guestprops" />.
     119          and monitor guest execution. The <emphasis>guest
     120          properties</emphasis> provide a generic string-based mechanism
     121          to exchange data bits between a guest and a host, some of
     122          which have special meanings for controlling and monitoring the
     123          guest. See <xref linkend="guestadd-guestprops" />.
    125124        </para>
    126125
     
    148147          differs slightly, the time synchronization service attempts to
    149148          gradually and smoothly adjust the guest time in small
    150           increments to either "catch up" or "lose" time. When the
     149          increments to either catch up or lose time. When the
    151150          difference is too great, for example if a VM paused for hours
    152151          or restored from saved state, the guest time is changed
     
    199198      To disable this update check for the Guest Additions of a given
    200199      virtual machine, set the value of its
    201       <computeroutput>/VirtualBox/GuestAdd/CheckHostVersion</computeroutput>
    202       guest property to <computeroutput>0</computeroutput>. See
     200      <literal>/VirtualBox/GuestAdd/CheckHostVersion</literal> guest
     201      property to <literal>0</literal>. See
    203202      <xref
    204203    linkend="guestadd-guestprops" />.
     
    343342          <listitem>
    344343            <para>
    345               Select <emphasis role="bold">Mount CD/DVD-ROM</emphasis>
     344              Select <emphasis role="bold">Optical Drives</emphasis>
    346345              from the <emphasis role="bold">Devices</emphasis> menu in
    347346              the virtual machine's menu bar and then
    348               <emphasis role="bold">CD/DVD-ROM Image</emphasis>. This
    349               displays the Virtual Media Manager, described in
    350               <xref
    351             linkend="vdis" />.
     347              <emphasis role="bold">Choose/Create a Disk
     348              Image</emphasis>. This displays the Virtual Media Manager,
     349              described in <xref linkend="vdis" />.
    352350            </para>
    353351          </listitem>
     
    358356              <emphasis role="bold">Add</emphasis> and browse your host
    359357              file system for the
    360               <computeroutput>VBoxGuestAdditions.iso</computeroutput>
    361               file.
     358              <filename>VBoxGuestAdditions.iso</filename> file.
    362359            </para>
    363360
     
    368365                  On a Windows host, this file is in the &product-name;
    369366                  installation directory, usually in
    370                   <computeroutput>C:\Program
    371                   files\Oracle\VirtualBox</computeroutput>.
     367                  <filename>C:\Program
     368                  files\Oracle\VirtualBox</filename>.
    372369                </para>
    373370              </listitem>
     
    380377                  <emphasis role="bold">Show Package
    381378                  Contents</emphasis>. The file is located in the
    382                   <computeroutput>Contents/MacOS</computeroutput>
    383                   folder.
     379                  <filename>Contents/MacOS</filename> folder.
    384380                </para>
    385381              </listitem>
     
    388384                <para>
    389385                  On a Linux host, this file is in the
    390                   <computeroutput>additions</computeroutput> folder
    391                   where you installed &product-name;, usually
    392                   <computeroutput>/opt/VirtualBox/</computeroutput>.
     386                  <filename>additions</filename> folder where you
     387                  installed &product-name;, usually
     388                  <filename>/opt/VirtualBox/</filename>.
    393389                </para>
    394390              </listitem>
     
    397393                <para>
    398394                  On Oracle Solaris hosts, this file is in the
    399                   <computeroutput>additions</computeroutput> folder
    400                   where you installed &product-name;, usually
    401                   <computeroutput>/opt/VirtualBox</computeroutput>.
     395                  <filename>additions</filename> folder where you
     396                  installed &product-name;, usually
     397                  <filename>/opt/VirtualBox</filename>.
    402398                </para>
    403399              </listitem>
     
    409405            <para>
    410406              In the Virtual Media Manager, select the ISO file and
    411               click <emphasis role="bold">Select</emphasis> button. This
    412               mounts the ISO file and presents it to your Windows guest
    413               as a CD-ROM.
     407              click the <emphasis role="bold">Add</emphasis> button.
     408              This mounts the ISO file and presents it to your Windows
     409              guest as a CD-ROM.
    414410            </para>
    415411          </listitem>
     
    422418          Additions installation program from the Additions ISO. If the
    423419          Autostart feature has been turned off, choose
    424           <computeroutput>VBoxWindowsAdditions.exe</computeroutput> from
    425           the CD/DVD drive inside the guest to start the installer.
     420          <filename>VBoxWindowsAdditions.exe</filename> from the CD/DVD
     421          drive inside the guest to start the installer.
    426422        </para>
    427423
     
    461457        </para>
    462458
    463         <orderedlist>
     459        <itemizedlist>
    464460
    465461          <listitem>
     
    475471          </listitem>
    476472
    477         </orderedlist>
     473        </itemizedlist>
    478474
    479475        <para>
     
    510506          Installing the code signing certificates on a Windows guest
    511507          can be done automatically. Use the
    512           <computeroutput>VBoxCertUtil.exe</computeroutput> utility from
    513           the <computeroutput>cert</computeroutput> folder on the Guest
    514           Additions installation CD.
     508          <filename>VBoxCertUtil.exe</filename> utility from the
     509          <filename>cert</filename> folder on the Guest Additions
     510          installation CD.
    515511        </para>
    516512
     
    536532            <para>
    537533              Open a command line window on the guest and change to the
    538               <computeroutput>cert</computeroutput> folder on the
    539               &product-name; Guest Additions CD.
     534              <filename>cert</filename> folder on the &product-name;
     535              Guest Additions CD.
    540536            </para>
    541537          </listitem>
     
    577573            driver needs to be installed. To select this driver by
    578574            default, add the command line parameter
    579             <computeroutput>/with_wddm</computeroutput> when invoking
    580             the Windows Guest Additions installer. This is only required
    581             for Vista and Windows 7.
     575            <literal>/with_wddm</literal> when invoking the Windows
     576            Guest Additions installer. This is only required for Vista
     577            and Windows 7.
    582578          </para>
    583579        </note>
     
    616612          a 32-bit system, you must use the appropriate platform
    617613          installer. Use
    618           <computeroutput>VBoxWindowsAdditions-x86.exe</computeroutput>
    619           or
    620           <computeroutput>VBoxWindowsAdditions-amd64.exe</computeroutput>
    621           with the <computeroutput>/extract</computeroutput> parameter.
     614          <filename>VBoxWindowsAdditions-x86.exe</filename> or
     615          <filename>VBoxWindowsAdditions-amd64.exe</filename> with the
     616          <literal>/extract</literal> parameter.
    622617        </para>
    623618
     
    657652        <listitem>
    658653          <para>
    659             Redhat Enterprise Linux as of version 3
     654            Red Hat Enterprise Linux as of version 3
    660655          </para>
    661656        </listitem>
     
    744739          <listitem>
    745740            <para>
    746               Insert the
    747               <computeroutput>VBoxGuestAdditions.iso</computeroutput> CD
     741              Insert the <filename>VBoxGuestAdditions.iso</filename> CD
    748742              file into your Linux guest's virtual CD-ROM drive, as
    749743              described for a Windows guest in
     
    830824          into the virtual CD-ROM drive as described above. Then run the
    831825          installer for the current Guest Additions with the
    832           <computeroutput>uninstall</computeroutput> parameter from the
    833           path that the CD image is mounted on in the guest, as follows:
     826          <literal>uninstall</literal> parameter from the path that the
     827          CD image is mounted on in the guest, as follows:
    834828        </para>
    835829
     
    853847        <para>
    854848          Replace
    855           <computeroutput>/opt/VBoxGuestAdditions-<replaceable>version</replaceable></computeroutput>
     849          <filename>/opt/VBoxGuestAdditions-<replaceable>version</replaceable></filename>
    856850          with the correct Guest Additions installation directory.
    857851        </para>
     
    917911          <listitem>
    918912            <para>
    919               Mount the
    920               <computeroutput>VBoxGuestAdditions.iso</computeroutput>
    921               file as your Oracle Solaris guest's virtual CD-ROM drive,
     913              Mount the <filename>VBoxGuestAdditions.iso</filename> file
     914              as your Oracle Solaris guest's virtual CD-ROM drive,
    922915              exactly the same way as described for a Windows guest in
    923916              <xref
     
    1002995        those for the other platforms. Mount the ISO in OS/2 as
    1003996        described previously. The OS/2 Guest Additions are located in
    1004         the directory <computeroutput>\OS2</computeroutput>.
     997        the directory <filename>\OS2</filename>.
    1005998      </para>
    1006999
    10071000      <para>
    10081001        We do not provide an automatic installer at this time. See the
    1009         <computeroutput>readme.txt</computeroutput> file in the CD-ROM
    1010         directory, which describes how to install the OS/2 Guest
    1011         Additions manually.
     1002        <filename>readme.txt</filename> file in the CD-ROM directory,
     1003        which describes how to install the OS/2 Guest Additions
     1004        manually.
    10121005      </para>
    10131006
     
    10271020      not require networking, only the Guest Additions. Shared folders
    10281021      are supported with Windows 2000 or later, Linux, and Oracle
    1029       Solaris guests. &product-name; release 6.0 includes experimental
    1030       support for Mac OS X and OS/2 guests.
     1022      Solaris guests. &product-name; includes experimental support for
     1023      Mac OS X and OS/2 guests.
    10311024    </para>
    10321025
     
    11041097          the VM is powered off. These can be created using a checkbox
    11051098          in the VirtualBox Manager, or by using the
    1106           <computeroutput>--transient</computeroutput> option of the
    1107           <command>VBoxManage sharedfolder add</command> command.
     1099          <option>--transient</option> option of the <command>VBoxManage
     1100          sharedfolder add</command> command.
    11081101        </para>
    11091102      </listitem>
     
    11161109      read files on the host. By default, shared folders are read-write.
    11171110      Read-only folders can be created using a checkbox in the
    1118       VirtualBox Manager, or with the
    1119       <computeroutput>--readonly</computeroutput> option of the
    1120       <command>VBoxManage sharedfolder add</command> command.
     1111      VirtualBox Manager, or with the <option>--readonly</option> option
     1112      of the <command>VBoxManage sharedfolder add</command> command.
    11211113    </para>
    11221114
     
    11891181
    11901182          <para>
    1191             While <computeroutput>vboxsvr</computeroutput> is a fixed
    1192             name, note that <computeroutput>vboxsrv</computeroutput>
    1193             would also work, replace <replaceable>x:</replaceable> with
    1194             the drive letter that you want to use for the share, and
     1183            While <literal>vboxsvr</literal> is a fixed name, note that
     1184            <literal>vboxsrv</literal> would also work, replace
     1185            <replaceable>x:</replaceable> with the drive letter that you
     1186            want to use for the share, and
    11951187            <replaceable>sharename</replaceable> with the share name
    11961188            specified with <command>VBoxManage</command>.
     
    12071199          <para>
    12081200            To mount a shared folder during boot, add the following
    1209             entry to <computeroutput>/etc/fstab</computeroutput>:
     1201            entry to <filename>/etc/fstab</filename>:
    12101202          </para>
    12111203
     
    12231215            Replace <replaceable>sharename</replaceable>, use a
    12241216            lowercase string, with the share name specified with
    1225             <command>VBoxManage</command> or the GUI. Replace
    1226             <replaceable>mountpoint</replaceable> with the path where
    1227             you want the share to be mounted on the guest, such as
    1228             <computeroutput>/mnt/share</computeroutput>. The usual mount
    1229             rules apply. For example, create this directory first if it
    1230             does not exist yet.
     1217            <command>VBoxManage</command> or the VirtualBox Manager.
     1218            Replace <replaceable>mountpoint</replaceable> with the path
     1219            where you want the share to be mounted on the guest, such as
     1220            <filename>/mnt/share</filename>. The usual mount rules
     1221            apply. For example, create this directory first if it does
     1222            not exist yet.
    12311223          </para>
    12321224
     
    12561248            This option sets the character set used for I/O operations.
    12571249            Note that on Linux guests, if the
    1258             <computeroutput>iocharset</computeroutput> option is not
    1259             specified, then the Guest Additions driver will attempt to
    1260             use the character set specified by the CONFIG_NLS_DEFAULT
    1261             kernel option. If this option is not set either, then UTF-8
    1262             is used.
     1250            <literal>iocharset</literal> option is not specified, then
     1251            the Guest Additions driver will attempt to use the character
     1252            set specified by the CONFIG_NLS_DEFAULT kernel option. If
     1253            this option is not set either, then UTF-8 is used.
    12631254          </para>
    12641255
     
    12721263          <para>
    12731264            The generic mount options, documented in the
    1274             <computeroutput>mount</computeroutput> manual page, apply
    1275             also. Especially useful are the options
    1276             <computeroutput>uid</computeroutput>,
    1277             <computeroutput>gid</computeroutput> and
    1278             <computeroutput>mode</computeroutput>, as they can allow
    1279             access by normal users in read/write mode, depending on the
    1280             settings, even if root has mounted the filesystem.
     1265            <command>mount</command> manual page, apply also. Especially
     1266            useful are the options <literal>uid</literal>,
     1267            <literal>gid</literal> and <literal>mode</literal>, as they
     1268            can allow access by normal users in read/write mode,
     1269            depending on the settings, even if root has mounted the
     1270            filesystem.
    12811271          </para>
    12821272        </listitem>
     
    12941284          <para>
    12951285            As with Windows guests, shared folders can also be accessed
    1296             via UNC using <computeroutput>\\VBoxSF\</computeroutput>,
    1297             <computeroutput>\\VBoxSvr\</computeroutput> or
    1298             <computeroutput>\\VBoxSrv\</computeroutput> as the server
    1299             name and the shared folder name as
    1300             <replaceable>sharename</replaceable>.
     1286            via UNC using <filename>\\VBoxSF\</filename>,
     1287            <filename>\\VBoxSvr\</filename> or
     1288            <filename>\\VBoxSrv\</filename> as the server name and the
     1289            shared folder name as <replaceable>sharename</replaceable>.
    13011290          </para>
    13021291        </listitem>
     
    13321321            <emphasis role="bold">Windows and OS/2 guests.</emphasis>
    13331322            Search for a free drive letter, starting at
    1334             <computeroutput>Z:</computeroutput>. If all drive letters
    1335             are assigned, the folder is not mounted.
     1323            <filename>Z:</filename>. If all drive letters are assigned,
     1324            the folder is not mounted.
    13361325          </para>
    13371326        </listitem>
     
    13411330            <emphasis role="bold">Linux and Oracle Solaris
    13421331            guests.</emphasis> Folders are mounted under the
    1343             <computeroutput>/media</computeroutput> directory. The
    1344             folder name is normalized (no spaces, slashes or colons) and
    1345             is prefixed with <computeroutput>sf_</computeroutput>.
     1332            <filename>/media</filename> directory. The folder name is
     1333            normalized (no spaces, slashes or colons) and is prefixed
     1334            with <filename>sf_</filename>.
    13461335          </para>
    13471336
    13481337          <para>
    13491338            For example, if you have a shared folder called
    1350             <computeroutput>myfiles</computeroutput>, it will appear as
    1351             <computeroutput>/media/sf_myfiles</computeroutput> in the
    1352             guest.
     1339            <filename>myfiles</filename>, it will appear as
     1340            <filename>/media/sf_myfiles</filename> in the guest.
    13531341          </para>
    13541342
    13551343          <para>
    13561344            The guest properties
    1357             <computeroutput>/VirtualBox/GuestAdd/SharedFolders/MountDir</computeroutput>
     1345            <literal>/VirtualBox/GuestAdd/SharedFolders/MountDir</literal>
    13581346            and the more generic
    1359             <computeroutput>/VirtualBox/GuestAdd/SharedFolders/MountPrefix</computeroutput>
     1347            <literal>/VirtualBox/GuestAdd/SharedFolders/MountPrefix</literal>
    13601348            can be used to override the automatic mount directory and
    13611349            prefix. See <xref linkend="guestadd-guestprops" />.
     
    13691357        everyone in a Windows guest, including the guest user. For Linux
    13701358        and Oracle Solaris guests, access is restricted to members of
    1371         the group <computeroutput>vboxsf</computeroutput> and the
    1372         <computeroutput>root</computeroutput> user.
     1359        the group <literal>vboxsf</literal> and the
     1360        <literal>root</literal> user.
    13731361      </para>
    13741362
     
    13831371    <para>
    13841372      &product-name; enables you to drag and drop content from the host
    1385       to the guest, and vice versa. For this to work the latest Guest
    1386       Additions must be installed on the guest.
     1373      to the guest, and vice versa. For this to work the latest version
     1374      of the Guest Additions must be installed on the guest.
    13871375    </para>
    13881376
     
    14391427    <figure id="fig-drag-drop-options">
    14401428      <title>Drag and Drop Menu Options</title>
    1441       <mediaobject>
     1429    <mediaobject>
    14421430        <imageobject>
    14431431          <imagedata align="center" fileref="images/dnd-modes.png"
     
    16171605              <para>
    16181606                3D acceleration with Windows guests requires Windows
    1619                 2000, Windows XP, Vista, or Windows 7. Apart from on
    1620                 Windows 2000 guests, both OpenGL and Direct3D 8/9 are
    1621                 supported on an experimental basis.
     1607                2000 or later. Apart from on Windows 2000 guests, both
     1608                OpenGL and Direct3D 8/9 are supported on an experimental
     1609                basis.
    16221610              </para>
    16231611            </listitem>
     
    16921680        driver must be installed, which is available with the Guest
    16931681        Additions installation. The WDDM driver is not installed by
    1694         default for Vista and Windows 7 guest and must be
     1682        default for Vista and Windows 7 guests and must be
    16951683        <emphasis>manually selected</emphasis> in the Guest Additions
    16961684        installer by clicking <emphasis role="bold">No</emphasis> in the
     
    17011689
    17021690      <para>
    1703         The Aero theme is not enabled by default. To enable it, do the
    1704         following:
    1705       </para>
    1706 
    1707       <itemizedlist>
    1708 
    1709         <listitem>
    1710           <para>
    1711             <emphasis role="bold">Windows Vista guests:</emphasis>
    1712             Right-click on the desktop and select
    1713             <emphasis role="bold">Personalize</emphasis>, then select
    1714             <emphasis role="bold">Windows Color and
    1715             Appearance</emphasis> in the
    1716             <emphasis role="bold">Personalization</emphasis> window. In
    1717             the <emphasis role="bold">Appearance Settings</emphasis>
    1718             dialog, select <emphasis role="bold">Windows Aero</emphasis>
    1719             and click <emphasis role="bold">OK</emphasis>.
    1720           </para>
    1721         </listitem>
    1722 
    1723         <listitem>
    1724           <para>
    1725             <emphasis role="bold">Windows 7 guests:</emphasis>
    1726             Right-click on the desktop and select
    1727             <emphasis role="bold">Personalize</emphasis>. Select any
    1728             Aero theme in the
    1729             <emphasis role="bold">Personalization</emphasis> window.
    1730           </para>
    1731         </listitem>
    1732 
    1733       </itemizedlist>
    1734 
    1735       <para>
    1736         Technically, &product-name; implements this by installing an
    1737         additional hardware 3D driver inside your guest when the Guest
    1738         Additions are installed. This driver acts as a hardware 3D
    1739         driver and reports to the guest operating system that the
    1740         virtual hardware is capable of 3D hardware acceleration. When an
    1741         application in the guest then requests hardware acceleration
    1742         through the OpenGL or Direct3D programming interfaces, these are
    1743         sent to the host through a special communication tunnel
    1744         implemented by &product-name;, and then the
    1745         <emphasis>host</emphasis> performs the requested 3D operation
    1746         using the host's programming interfaces.
     1691        The Aero theme is not enabled by default on Windows. See your
     1692        Windows platform documentation for details of how to enable the
     1693        Aero theme.
     1694      </para>
     1695
     1696      <para>
     1697        Technically, &product-name; implements 3D acceleration by
     1698        installing an additional hardware 3D driver inside the guest
     1699        when the Guest Additions are installed. This driver acts as a
     1700        hardware 3D driver and reports to the guest operating system
     1701        that the virtual hardware is capable of 3D hardware
     1702        acceleration. When an application in the guest then requests
     1703        hardware acceleration through the OpenGL or Direct3D programming
     1704        interfaces, these are sent to the host through a special
     1705        communication tunnel implemented by &product-name;. The
     1706        <emphasis>host</emphasis> then performs the requested 3D
     1707        operation using the host's programming interfaces.
    17471708      </para>
    17481709
     
    18061767        through a special communication tunnel implemented by
    18071768        &product-name;. On the host side, OpenGL is then used to
    1808         implement color space transformation and scaling
     1769        implement color space transformation and scaling.
    18091770      </para>
    18101771
     
    18291790      <listitem>
    18301791        <para>
    1831           Windows guests. Support was added in &product-name; 1.5.
     1792          Windows guests.
    18321793        </para>
    18331794      </listitem>
     
    18361797        <para>
    18371798          Supported Linux or Oracle Solaris guests running the X Window
    1838           System. Support was added with &product-name; 1.6.
     1799          System.
    18391800        </para>
    18401801      </listitem>
     
    18511812    <figure id="fig-seamless-windows">
    18521813      <title>Seamless Windows on a Host Desktop</title>
    1853       <mediaobject>
     1814    <mediaobject>
    18541815        <imageobject>
    18551816          <imagedata align="center" fileref="images/seamless.png" width="14cm" />
     
    19181879      version of the Guest Additions, users that are currently logged
    19191880      into the guest OS, network statistics and more. These predefined
    1920       properties are all prefixed with
    1921       <computeroutput>/VirtualBox/</computeroutput> and organized into a
    1922       hierarchical tree of keys.
     1881      properties are all prefixed with <literal>/VirtualBox/</literal>
     1882      and organized into a hierarchical tree of keys.
    19231883    </para>
    19241884
     
    19401900<screen>$ VBoxManage guestproperty enumerate "Windows Vista III"
    19411901VirtualBox Command Line Management Interface Version <replaceable>version-number</replaceable>
    1942 (C) 2005-2018 Oracle Corporation
     1902(C) 2005-2019 Oracle Corporation
    19431903All rights reserved.
    19441904
     
    19971957    <para>
    19981958      To query the value of a single property, use the
    1999       <computeroutput>get</computeroutput> subcommand as follows:
     1959      <command>get</command> subcommand as follows:
    20001960    </para>
    20011961
    20021962<screen>$ VBoxManage guestproperty get "Windows Vista III" "/VirtualBox/GuestInfo/OS/Product"
    20031963VirtualBox Command Line Management Interface Version <replaceable>version-number</replaceable>
    2004 (C) 2005-2018 Oracle Corporation
     1964(C) 2005-2019 Oracle Corporation
    20051965All rights reserved.
    20061966
     
    20091969    <para>
    20101970      To add or change guest properties from the guest, use the tool
    2011       <computeroutput>VBoxControl</computeroutput>. This tool is
    2012       included in the Guest Additions of &product-name; 2.2 or later.
    2013       When started from a Linux guest, this tool requires root
    2014       privileges for security reasons:
     1971      <command>VBoxControl</command>. This tool is included in the Guest
     1972      Additions. When started from a Linux guest, this tool requires
     1973      root privileges for security reasons.
    20151974    </para>
    20161975
    20171976<screen>$ sudo VBoxControl guestproperty enumerate
    20181977VirtualBox Guest Additions Command Line Management Interface Version <replaceable>version-number</replaceable>
    2019 (C) 2005-2018 Oracle Corporation
     1978(C) 2005-2019 Oracle Corporation
    20201979All rights reserved.
    20211980
     
    20361995
    20371996      <para>
    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:
     1997        The properties <literal>/VirtualBox/HostInfo/VBoxVer</literal>,
     1998        <literal>/VirtualBox/HostInfo/VBoxVerExt</literal> or
     1999        <literal>/VirtualBox/HostInfo/VBoxRev</literal> can be waited on
     2000        to detect that the VM state was restored from saved state or
     2001        snapshot:
    20442002      </para>
    20452003
     
    20482006      <para>
    20492007        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.
     2008        <literal>/VirtualBox/HostInfo/ResumeCounter</literal> can be
     2009        used to detect that a VM was resumed from the paused state or
     2010        saved state.
    20532011      </para>
    20542012
     
    20702028    <figure id="fig-guest-control-fm">
    20712029      <title>Guest Control File Manager</title>
    2072       <mediaobject>
     2030    <mediaobject>
    20732031        <imageobject>
    20742032          <imagedata align="center" fileref="images/guest-fm.png"
     
    21652123
    21662124    <para>
    2167       The Guest Additions enable starting of applications inside a VM
    2168       from the host system.
    2169     </para>
    2170 
    2171     <para>
    2172       For this to work, the application needs to be installed inside the
     2125      The Guest Additions enable starting of applications inside a guest
     2126      VM from the host system. This feature can be used to automate
     2127      deployment of software within the guest.
     2128    </para>
     2129
     2130    <para>
     2131      For this to work, the application needs to be installed on the
    21732132      guest. No additional software needs to be installed on the host.
    21742133      Additionally, text mode output to stdout and stderr can be shown
     
    21792138
    21802139    <para>
    2181       This feature can be used to automate deployment of software within
    2182       the guest.
    2183     </para>
    2184 
    2185     <para>
    21862140      The Guest Additions for Windows allow for automatic updating. This
    2187       applies for already installed Guest Additions version 4.0 or
    2188       later. Also, copying files from host to the guest as well as
    2189       remotely creating guest directories is available.
     2141      applies for already installed Guest Additions versions. Also,
     2142      copying files from host to the guest as well as remotely creating
     2143      guest directories is available.
    21902144    </para>
    21912145
     
    22342188              Memory ballooning does not work with large pages enabled.
    22352189              To turn off large pages support for a VM, run
    2236               <computeroutput>VBoxManage modifyvm &lt;VM name&gt;
    2237               --largepages off</computeroutput>
     2190              <command>VBoxManage modifyvm
     2191              <replaceable>vmname</replaceable> --largepages
     2192              off</command>
    22382193            </para>
    22392194          </listitem>
     
    23032258      <para>
    23042259        By default, no balloon memory is allocated. This is a VM
    2305         setting, like other <computeroutput>modifyvm</computeroutput>
    2306         settings, and therefore can only be set while the machine is
    2307         shut down. See <xref
     2260        setting, like other <command>modifyvm</command> settings, and
     2261        therefore can only be set while the machine is shut down. See
     2262        <xref
    23082263      linkend="vboxmanage-modifyvm" />.
    23092264      </para>
     
    23412296        efficiently Page Fusion can reduce the amount of host memory
    23422297        that is in use. It therefore works best if all VMs on a host run
    2343         identical operating systems, such as Windows XP Service Pack 2.
    2344         Instead of having a complete copy of each operating system in
    2345         each VM, Page Fusion identifies the identical memory pages in
    2346         use by these operating systems and eliminates the duplicates,
    2347         sharing host memory between several machines. This is called
    2348         <emphasis>deduplication</emphasis>. If a VM tries to modify a
    2349         page that has been shared with other VMs, a new page is
    2350         allocated again for that VM with a copy of the shared page. This
    2351         is called <emphasis>copy on write</emphasis>. All this is fully
    2352         transparent to the virtual machine.
     2298        identical operating systems. Instead of having a complete copy
     2299        of each operating system in each VM, Page Fusion identifies the
     2300        identical memory pages in use by these operating systems and
     2301        eliminates the duplicates, sharing host memory between several
     2302        machines. This is called <emphasis>deduplication</emphasis>. If
     2303        a VM tries to modify a page that has been shared with other VMs,
     2304        a new page is allocated again for that VM with a copy of the
     2305        shared page. This is called <emphasis>copy on write</emphasis>.
     2306        All this is fully transparent to the virtual machine.
    23532307      </para>
    23542308
     
    24112365      <para>
    24122366        You can observe Page Fusion operation using some metrics.
    2413         <computeroutput>RAM/VMM/Shared</computeroutput> shows the total
    2414         amount of fused pages, whereas the per-VM metric
    2415         <computeroutput>Guest/RAM/Usage/Shared</computeroutput> will
    2416         return the amount of fused memory for a given VM. See
    2417         <xref
    2418         linkend="vboxmanage-metrics" /> for information on
    2419         how to query metrics.
     2367        <literal>RAM/VMM/Shared</literal> shows the total amount of
     2368        fused pages, whereas the per-VM metric
     2369        <literal>Guest/RAM/Usage/Shared</literal> will return the amount
     2370        of fused memory for a given VM. See
     2371        <xref linkend="vboxmanage-metrics" /> for information on how to
     2372        query metrics.
    24202373      </para>
    24212374
  • trunk/doc/manual/en_US/user_Installation.xml

    r76786 r82350  
    2626        For the various versions of Windows that are supported as host
    2727        operating systems, please refer to
    28         <xref
    29       linkend="hostossupport" />.
    30       </para>
    31 
    32       <para>
    33         In addition, Windows Installer 1.1 or later must be present on
    34         your system. This should be the case if you have all recent
    35         Windows updates installed.
     28        <xref linkend="hostossupport" />.
     29      </para>
     30
     31      <para>
     32        In addition, Windows Installer must be present on your system.
     33        This should be the case for all supported Windows platforms.
    3634      </para>
    3735
     
    5149        <listitem>
    5250          <para>
    53             By double-clicking on the executable file, which contains
    54             both 32-bit and 64-bit architectures.
     51            By double-clicking on the executable file.
    5552          </para>
    5653        </listitem>
     
    6461
    6562          <para>
    66             This will extract both installers into a temporary
    67             directory, along with .MSI files. Run the following command
    68             to to perform the installation:
    69           </para>
    70 
    71 <screen>msiexec /i VirtualBox-&lt;version&gt;-&lt;revision&gt;-MultiArch_&lt;x86|amd64&gt;.msi</screen>
     63            This will extract the installer into a temporary directory,
     64            along with the .MSI file. Run the following command to
     65            perform the installation:
     66          </para>
     67
     68<screen>msiexec /i VirtualBox-&lt;version&gt;-&lt;revision&gt;-Win.msi</screen>
    7269        </listitem>
    7370
     
    114111          <para>
    115112            See, for example:
    116             <ulink
    117               url="http://www.python.org/download/windows/">http://www.python.org/download/windows/</ulink>.
     113            <ulink url="http://www.python.org/download/windows/" />.
    118114          </para>
    119115
    120116          <note>
    121117            <para>
    122               Python version at least 2.6 is required. Since
    123               &product-name; 5.1, Python 3 is also supported.
     118              Python version at least 2.6 is required. Python 3 is also
     119              supported.
    124120            </para>
    125121          </note>
     
    137133
    138134      <para>
    139         The installer will create a &product-name; group in the Windows
     135        The installer will create an &product-name; group in the Windows
    140136        <emphasis role="bold">Start</emphasis> menu, which enables you
    141137        to launch the application and access its documentation.
     
    152148      <para>
    153149        Then, run either of the following commands on the extracted .MSI
    154         files. This will install &product-name; only for the current
     150        file. This will install &product-name; only for the current
    155151        user.
    156152      </para>
     
    158154<screen>VirtualBox.exe -msiparams ALLUSERS=2</screen>
    159155
    160 <screen>msiexec /i VirtualBox-&lt;version&gt;-MultiArch_&lt;x86|amd64&gt;.msi ALLUSERS=2</screen>
     156<screen>msiexec /i VirtualBox-&lt;version&gt;-Win.msi ALLUSERS=2</screen>
    161157
    162158      <para>
    163159        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
     160        you can set the optional <literal>ADDLOCAL</literal> parameter
     161        to explicitly name the features to be installed. The following
    167162        features are available:
    168163      </para>
     
    248243              Python support
    249244            </para>
    250 
    251             <note>
    252               <para>
    253                 Python version at least 2.6 is required. Since
    254                 &product-name; 5.1, Python 3 is also supported.
    255               </para>
    256             </note>
    257245          </listitem>
    258246        </varlistentry>
     
    267255<screen>VirtualBox.exe -msiparams ADDLOCAL=VBoxApplication,VBoxUSB</screen>
    268256
    269 <screen>msiexec /i VirtualBox-&lt;version&gt;-MultiArch_&lt;x86|amd64&gt;.msi ADDLOCAL=VBoxApplication,VBoxUSB</screen>
     257<screen>msiexec /i VirtualBox-&lt;version&gt;-Win.msi ADDLOCAL=VBoxApplication,VBoxUSB</screen>
    270258
    271259      <para>
    272260        The user is able to choose between NDIS5 and NDIS6 host network
    273261        filter drivers during the installation. This is done using a
    274         command line parameter,
    275         <computeroutput>NETWORKTYPE</computeroutput>. The NDIS6 driver
    276         is default for Windows Vista and later. For older Windows
    277         versions, the installer will automatically select the NDIS5
    278         driver and this cannot be changed. For Windows Vista and later
    279         the user can force an install of the legacy NDIS5 host network
    280         filter driver by using
    281         <computeroutput>NETWORKTYPE=NDIS5</computeroutput>. For example,
    282         to install the NDIS5 driver on Windows 7 use either of the
    283         following commands:
     262        command line parameter, <literal>NETWORKTYPE</literal>. The
     263        NDIS6 driver is the default for most supported Windows hosts.
     264        For some legacy Windows versions, the installer will
     265        automatically select the NDIS5 driver and this cannot be
     266        changed.
     267      </para>
     268
     269      <para>
     270        You can force an install of the legacy NDIS5 host network filter
     271        driver by specifying <literal>NETWORKTYPE=NDIS5</literal>. For
     272        example, to install the NDIS5 driver on Windows 7 use either of
     273        the following commands:
    284274      </para>
    285275
    286276<screen>VirtualBox.exe -msiparams NETWORKTYPE=NDIS5</screen>
    287277
    288 <screen>msiexec /i VirtualBox-&lt;version&gt;-MultiArch_&lt;x86|amd64&gt;.msi NETWORKTYPE=NDIS5</screen>
     278<screen>msiexec /i VirtualBox-&lt;version&gt;-Win;.msi NETWORKTYPE=NDIS5</screen>
    289279
    290280    </sect2>
     
    326316<screen>VirtualBox.exe -msiparams NAME=VALUE [...]</screen>
    327317
    328 <screen>msiexec /i VirtualBox-&lt;version&gt;-MultiArch_&lt;x86|amd64&gt;.msi NAME=VALUE [...]</screen>
     318<screen>msiexec /i VirtualBox-&lt;version&gt;-Win.msi NAME=VALUE [...]</screen>
    329319
    330320      <para>
     
    345335
    346336          <para>
    347             Set to <computeroutput>1</computeroutput> to enable,
    348             <computeroutput>0</computeroutput> to disable. Default is 1.
     337            Set to <literal>1</literal> to enable, <literal>0</literal>
     338            to disable. Default is 1.
    349339          </para>
    350340        </listitem>
     
    361351
    362352          <para>
    363             Set to <computeroutput>1</computeroutput> to enable,
    364             <computeroutput>0</computeroutput> to disable. Default is 1.
     353            Set to <literal>1</literal> to enable, <literal>0</literal>
     354            to disable. Default is 1.
    365355          </para>
    366356        </listitem>
     
    379369
    380370          <para>
    381             Set to <computeroutput>1</computeroutput> to enable,
    382             <computeroutput>0</computeroutput> to disable. Default is 1.
     371            Set to <literal>1</literal> to enable, <literal>0</literal>
     372            to disable. Default is 1.
    383373          </para>
    384374        </listitem>
     
    395385
    396386          <para>
    397             Set to <computeroutput>1</computeroutput> to enable,
    398             <computeroutput>0</computeroutput> to disable. Default is 1.
     387            Set to <literal>1</literal> to enable, <literal>0</literal>
     388            to disable. Default is 1.
    399389          </para>
    400390        </listitem>
     
    416406      <para>
    417407        For Mac OS X hosts, &product-name; ships in a
    418         <computeroutput>dmg</computeroutput> disk image file. Perform
    419         the following steps to install on a Mac OS X host:
     408        <filename>dmg</filename> disk image file. Perform the following
     409        steps to install on a Mac OS X host:
    420410      </para>
    421411
     
    424414        <listitem>
    425415          <para>
    426             Double-click on the <computeroutput>dmg</computeroutput>
    427             file, to mount the contents.
     416            Double-click on the <filename>dmg</filename> file, to mount
     417            the contents.
    428418          </para>
    429419        </listitem>
     
    432422          <para>
    433423            A window opens, prompting you to double-click on the
    434             <computeroutput>VirtualBox.pkg</computeroutput> installer
    435             file displayed in that window.
    436           </para>
    437         </listitem>
    438 
    439         <listitem>
    440           <para>
    441             This will start the installer, which enables you to select
    442             where to install &product-name;.
     424            <filename>VirtualBox.pkg</filename> installer file displayed
     425            in that window.
     426          </para>
     427        </listitem>
     428
     429        <listitem>
     430          <para>
     431            This starts the installer, which enables you to select where
     432            to install &product-name;.
     433          </para>
     434        </listitem>
     435
     436        <listitem>
     437          <para>
     438            An &product-name; icon is added to the
     439            <filename>Applications</filename> folder in the Finder.
    443440          </para>
    444441        </listitem>
     
    446443      </orderedlist>
    447444
    448       <para>
    449         After installation, you can find an &product-name; icon in the
    450         "Applications" folder in the Finder.
    451       </para>
    452 
    453445    </sect2>
    454446
     
    459451      <para>
    460452        To uninstall &product-name;, open the disk image
    461         <computeroutput>dmg</computeroutput> file and double-click on
    462         the uninstall icon shown.
     453        <filename>dmg</filename> file and double-click on the uninstall
     454        icon shown.
    463455      </para>
    464456
     
    475467
    476468      <para>
    477         Mount the <computeroutput>dmg</computeroutput> disk image file,
    478         as described in the installation procedure, or use the following
    479         command line:
     469        Mount the <filename>dmg</filename> disk image file, as described
     470        in the installation procedure, or use the following command
     471        line:
    480472      </para>
    481473
     
    502494      <para>
    503495        For the various versions of Linux that are supported as host
    504         operating systems, see <xref
    505       linkend="hostossupport" />.
    506       </para>
    507 
    508       <para>
    509         You will need to install the following packages on your Linux
     496        operating systems, see <xref linkend="hostossupport" />.
     497      </para>
     498
     499      <para>
     500        You may need to install the following packages on your Linux
    510501        system before starting the installation. Some systems will do
    511502        this for you automatically when you install &product-name;.
     
    523514          <para>
    524515            SDL 1.2.7 or later. This graphics library is typically
    525             called <computeroutput>libsdl</computeroutput> or similar.
     516            called <filename>libsdl</filename> or similar.
    526517          </para>
    527518        </listitem>
     
    533524          These packages are only required if you want to run the
    534525          &product-name; graphical user interfaces. In particular,
    535           <computeroutput>VirtualBox</computeroutput>, the graphical
    536           VirtualBox Manager, requires both Qt and SDL. If you only want
    537           to run <command>VBoxHeadless</command>, neither Qt nor SDL are
     526          <command>VirtualBox</command>, the graphical VirtualBox
     527          Manager, requires both Qt and SDL. If you only want to run
     528          <command>VBoxHeadless</command>, neither Qt nor SDL are
    538529          required.
    539530        </para>
     
    544535    <sect2 id="externalkernelmodules">
    545536
    546       <title>The &product-name; Driver Modules</title>
     537      <title>The &product-name; Kernel Modules</title>
    547538
    548539      <para>
    549540        In order to run other operating systems in virtual machines
    550541        alongside your main operating system, &product-name; needs to
    551         integrate very tightly into the system. To do this it installs a
    552         driver module called <computeroutput>vboxdrv</computeroutput>
    553         which does a lot of that work into the system kernel, which is
    554         the part of the operating system which controls your processor
    555         and physical hardware. Without this kernel module, you can still
    556         use the VirtualBox Manager to configure virtual machines, but
    557         they will not start. It also installs network drivers called
    558         <computeroutput>vboxnetflt</computeroutput> and
    559         <computeroutput>vboxnetadp</computeroutput> which enable virtual
    560         machines to make more use of your computer's network
     542        integrate very tightly with your system. To do this it installs
     543        a driver module called <command>vboxdrv</command> into the
     544        system kernel. The kernel is the part of the operating system
     545        which controls your processor and physical hardware. Without
     546        this kernel module, you can still use the VirtualBox Manager to
     547        configure virtual machines, but they will not start.
     548      </para>
     549
     550      <para>
     551        Network drivers called <command>vboxnetflt</command> and
     552        <command>vboxnetadp</command> are also installed. They enable
     553        virtual machines to make more use of your computer's network
    561554        capabilities and are needed for any virtual machine networking
    562555        beyond the basic NAT mode.
     
    565558      <para>
    566559        Since distributing driver modules separately from the kernel is
    567         not something which Linux supports well, the install process
    568         creates the modules on the system where they will be used. This
    569         usually means first installing software packages from the
    570         distribution which are needed for the build process. Normally,
    571         these will be the GNU compiler (GCC), GNU Make (make) and
    572         packages containing header files for your kernel, as well as
    573         making sure that all system updates are installed and that the
    574         system is running the most up-to-date kernel included in the
    575         distribution. <emphasis>The running kernel and the header files
    576         must be updated to matching versions</emphasis>. The following
    577         list includes some instructions for common distributions. For
    578         most of them you may want to start by finding the version name
     560        not something which Linux supports well, the &product-name;
     561        install process creates the modules on the system where they
     562        will be used. This means that you may need to install some
     563        software packages from the distribution which are needed for the
     564        build process. Required packages may include the following:
     565      </para>
     566
     567      <itemizedlist>
     568
     569        <listitem>
     570          <para>
     571            GNU compiler (GCC)
     572          </para>
     573        </listitem>
     574
     575        <listitem>
     576          <para>
     577            GNU Make (make)
     578          </para>
     579        </listitem>
     580
     581        <listitem>
     582          <para>
     583            Kernel header files
     584          </para>
     585        </listitem>
     586
     587      </itemizedlist>
     588
     589      <para>
     590        Also ensure that all system updates have been installed and that
     591        your system is running the most up-to-date kernel for the
     592        distribution.
     593      </para>
     594
     595      <note>
     596        <para>
     597          The running kernel and the kernel header files must be updated
     598          to matching versions.
     599        </para>
     600      </note>
     601
     602      <para>
     603        The following list includes some details of the required files
     604        for some common distributions. Start by finding the version name
    579605        of your kernel, using the command <command>uname -r</command> in
    580         a terminal. The instructions assume that you have not changed
    581         too much from the original installation, particularly not
    582         installed a different kernel type. If you have, then you will
    583         need to determine yourself what to set up.
     606        a terminal. The list assumes that you have not changed too much
     607        from the original installation, in particular that you have not
     608        installed a different kernel type.
    584609      </para>
    585610
     
    590615            With Debian and Ubuntu-based distributions, you must install
    591616            the correct version of the
    592             <computeroutput>linux-headers</computeroutput>, usually
    593             whichever of
    594             <computeroutput>linux-headers-generic</computeroutput>,
    595             <computeroutput>linux-headers-amd64</computeroutput>,
    596             <computeroutput>linux-headers-i686</computeroutput> or
    597             <computeroutput>linux-headers-i686-pae</computeroutput> best
    598             matches the kernel version name. Also, the
    599             <computeroutput>linux-kbuild</computeroutput> package if it
    600             exists. Basic Ubuntu releases should have the correct
    601             packages installed by default.
    602           </para>
    603         </listitem>
    604 
    605         <listitem>
    606           <para>
    607             On Fedora, Redhat, Oracle Linux and many other RPM-based
     617            <filename>linux-headers</filename>, usually whichever of
     618            <filename>linux-headers-generic</filename>,
     619            <filename>linux-headers-amd64</filename>,
     620            <filename>linux-headers-i686</filename> or
     621            <filename>linux-headers-i686-pae</filename> best matches the
     622            kernel version name. Also, the
     623            <filename>linux-kbuild</filename> package if it exists.
     624            Basic Ubuntu releases should have the correct packages
     625            installed by default.
     626          </para>
     627        </listitem>
     628
     629        <listitem>
     630          <para>
     631            On Fedora, Red Hat, Oracle Linux and many other RPM-based
    608632            systems, the kernel version sometimes has a code of letters
    609633            or a word close to the end of the version name. For example
    610             "uek" for the Oracle Enterprise kernel or "default" or
    611             "desktop" for the standard SUSE kernels. In this case, the
    612             package name is
    613             <computeroutput>kernel-uek-devel</computeroutput> or
    614             equivalent. If there is no such code, it is usually
    615             <computeroutput>kernel-devel</computeroutput>.
    616           </para>
    617         </listitem>
    618 
    619         <listitem>
    620           <para>
    621             On older SUSE and openSUSE Linux, you must install the
    622             <computeroutput>kernel-source</computeroutput> and
    623             <computeroutput>kernel-syms</computeroutput> packages.
     634            "uek" for the Oracle Unbreakable Enterprise Kernel or
     635            "default" or "desktop" for the standard kernels. In this
     636            case, the package name is
     637            <filename>kernel-uek-devel</filename> or equivalent. If
     638            there is no such code, it is usually
     639            <filename>kernel-devel</filename>.
     640          </para>
     641        </listitem>
     642
     643        <listitem>
     644          <para>
     645            On some SUSE and openSUSE Linux versions, you may need to
     646            install the <filename>kernel-source</filename> and
     647            <filename>kernel-syms</filename> packages.
    624648          </para>
    625649        </listitem>
     
    635659<screen>rcvboxdrv setup</screen>
    636660
     661      <sect3 id="kernel-modules-efi-secure-boot">
     662
     663        <title>Kernel Modules and UEFI Secure Boot</title>
     664
     665        <para>
     666          If you are running on a system using UEFI (Unified Extensible
     667          Firmware Interface) Secure Boot, you may need to sign the
     668          following kernel modules before you can load them:
     669        </para>
     670
     671        <itemizedlist>
     672
     673          <listitem>
     674            <para>
     675              <command>vboxdrv</command>
     676            </para>
     677          </listitem>
     678
     679          <listitem>
     680            <para>
     681              <command>vboxnetadp</command>
     682            </para>
     683          </listitem>
     684
     685          <listitem>
     686            <para>
     687              <command>vboxnetflt</command>
     688            </para>
     689          </listitem>
     690
     691          <listitem>
     692            <para>
     693              <command>vboxpci</command>
     694            </para>
     695          </listitem>
     696
     697        </itemizedlist>
     698
     699        <para>
     700          See your system documentation for details of the kernel module
     701          signing process.
     702        </para>
     703
     704      </sect3>
     705
    637706    </sect2>
    638707
     
    645714        native to various common Linux distributions. See
    646715        <xref linkend="hostossupport"/>. In addition, there is an
    647         alternative generic installer (.run) which should work on most
    648         Linux distributions. The generic installer packages are built on
    649         EL5 systems and thus require reasonably old versions of glibc,
    650         such as version 2.5, and other system libraries.
     716        alternative generic installer (.run) which you can use on
     717        supported Linux distributions.
    651718      </para>
    652719
    653720      <sect3 id="install-linux-debian-ubuntu">
    654721
    655         <title>Installing &product-name; from a Debian/Ubuntu Package</title>
     722        <title>Installing &product-name; from a Debian or Ubuntu Package</title>
    656723
    657724        <para>
    658725          Download the appropriate package for your distribution. The
    659           following examples assume that you are installing to a 32-bit
    660           Ubuntu Wily system. Use <computeroutput>dpkg</computeroutput>
    661           to install the Debian package,as follows:
    662         </para>
    663 
    664 <screen>sudo dpkg -i virtualbox-5.0_<replaceable>version-number</replaceable>_Ubuntu_wily_i386.deb</screen>
     726          following example assumes that you are installing to a 64-bit
     727          Ubuntu Xenial system. Use <command>dpkg</command> to install
     728          the Debian package,as follows:
     729        </para>
     730
     731<screen>sudo dpkg -i virtualbox-<replaceable>version-number</replaceable>_Ubuntu_xenial_amd64.deb</screen>
    665732
    666733        <para>
     
    669736          successful you will be shown a warning and the package will be
    670737          left unconfigured. Look at
    671           <computeroutput>/var/log/vbox-install.log</computeroutput> to
    672           find out why the compilation failed. You may have to install
    673           the appropriate Linux kernel headers, see
    674           <xref
    675         linkend="externalkernelmodules" />. After
    676           correcting any problems, run the following command:
     738          <filename>/var/log/vbox-install.log</filename> to find out why
     739          the compilation failed. You may have to install the
     740          appropriate Linux kernel headers, see
     741          <xref linkend="externalkernelmodules" />. After correcting any
     742          problems, run the following command:
    677743        </para>
    678744
     
    687753          module was successfully built, the installation script will
    688754          attempt to load that module. If this fails, please see
    689           <xref
    690         linkend="ts_linux-kernelmodule-fails-to-load" />
    691           for further information.
     755          <xref linkend="ts_linux-kernelmodule-fails-to-load" /> for
     756          further information.
    692757        </para>
    693758
     
    716781            <para>
    717782              Unpacks the application files to the target directory
    718               <computeroutput>/opt/VirtualBox/</computeroutput>, which
    719               cannot be changed.
     783              <filename>/opt/VirtualBox/</filename>, which cannot be
     784              changed.
    720785            </para>
    721786          </listitem>
     
    724789            <para>
    725790              Builds and installs the &product-name; kernel modules:
    726               <computeroutput>vboxdrv</computeroutput>,
    727               <computeroutput>vboxnetflt</computeroutput>, and
    728               <computeroutput>vboxnetadp</computeroutput>.
    729             </para>
    730           </listitem>
    731 
    732           <listitem>
    733             <para>
    734               Creates <computeroutput>/sbin/rcvboxdrv</computeroutput>,
    735               an init script to start the &product-name; kernel module.
     791              <command>vboxdrv</command>, <command>vboxnetflt</command>,
     792              and <command>vboxnetadp</command>.
     793            </para>
     794          </listitem>
     795
     796          <listitem>
     797            <para>
     798              Creates <filename>/sbin/rcvboxdrv</filename>, an init
     799              script to start the &product-name; kernel module.
    736800            </para>
    737801          </listitem>
     
    740804            <para>
    741805              Creates a new system group called
    742               <computeroutput>vboxusers</computeroutput>.
    743             </para>
    744           </listitem>
    745 
    746           <listitem>
    747             <para>
    748               Creates symbolic links in
    749               <computeroutput>/usr/bin</computeroutput> to a shell
    750               script
    751               <computeroutput>/opt/VirtualBox/VBox</computeroutput>
     806              <literal>vboxusers</literal>.
     807            </para>
     808          </listitem>
     809
     810          <listitem>
     811            <para>
     812              Creates symbolic links in <filename>/usr/bin</filename> to
     813              a shell script <filename>/opt/VirtualBox/VBox</filename>
    752814              which does some sanity checks and dispatches to the actual
    753815              executables: <command>VirtualBox</command>,
     
    761823            <para>
    762824              Creates
    763               <computeroutput>/etc/udev/rules.d/60-vboxdrv.rules</computeroutput>,
    764               a description file for udev, if that is present, which
    765               makes the USB devices accessible to all users in the
    766               <computeroutput>vboxusers</computeroutput> group.
     825              <filename>/etc/udev/rules.d/60-vboxdrv.rules</filename>, a
     826              description file for udev, if that is present, which makes
     827              the USB devices accessible to all users in the
     828              <literal>vboxusers</literal> group.
    767829            </para>
    768830          </listitem>
     
    771833            <para>
    772834              Writes the installation directory to
    773               <computeroutput>/etc/vbox/vbox.cfg</computeroutput>.
     835              <filename>/etc/vbox/vbox.cfg</filename>.
    774836            </para>
    775837          </listitem>
     
    779841        <para>
    780842          The installer must be executed as root with either
    781           <computeroutput>install</computeroutput> or
    782           <computeroutput>uninstall</computeroutput> as the first
    783           parameter. For example:
     843          <literal>install</literal> or <literal>uninstall</literal> as
     844          the first parameter. For example:
    784845        </para>
    785846
     
    795856        <para>
    796857          Add every user who needs to access USB devices from a
    797           VirtualBox guests to the group
    798           <computeroutput>vboxusers</computeroutput>. Either use the GUI
    799           user management tools or run the following command as root:
     858          VirtualBox guests to the group <literal>vboxusers</literal>.
     859          Either use the OS user management tools or run the following
     860          command as root:
    800861        </para>
    801862
     
    811872            <command>groups</command> command and add all these groups
    812873            in a comma-separated list to the command line after the
    813             <option>-G</option> option. For example:
    814             <computeroutput>usermod -G group1,group2,vboxusers
    815             username</computeroutput>.
     874            <option>-G</option> option. For example: <command>usermod -G
     875            <replaceable>group1</replaceable>,<replaceable>group2</replaceable>,vboxusers
     876            <replaceable>username</replaceable></command>.
    816877          </para>
    817878        </note>
     
    833894        <para>
    834895          This will unpack all the files needed for installation in the
    835           directory <computeroutput>install</computeroutput> under the
    836           current directory. The &product-name; application files are
    837           contained in
    838           <computeroutput>VirtualBox.tar.bz2</computeroutput> which you
    839           can unpack to any directory on your system. For example:
     896          directory <literal>install</literal> under the current
     897          directory. The &product-name; application files are contained
     898          in <filename>VirtualBox.tar.bz2</filename> which you can
     899          unpack to any directory on your system. For example:
    840900        </para>
    841901
     
    852912        <para>
    853913          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:
     914          the <filename>src</filename> directory. To build the module,
     915          change to the directory and use the following command:
    857916        </para>
    858917
     
    878937          you how to create the device node, depending on your Linux
    879938          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>.
     939          Linux setup with a <filename>/dev</filename> directory, a
     940          system with the now deprecated <command>devfs</command> and a
     941          modern Linux system with <command>udev</command>.
    884942        </para>
    885943
     
    893951
    894952        <para>
    895           Note that the <computeroutput>/dev/vboxdrv</computeroutput>
    896           kernel module device node must be owned by root:root and must
    897           be read/writable only for the user.
     953          Note that the <filename>/dev/vboxdrv</filename> kernel module
     954          device node must be owned by root:root and must be
     955          read/writable only for the user.
    898956        </para>
    899957
     
    908966        <para>
    909967          This example assumes you installed &product-name; to the
    910           <computeroutput>/opt/VirtualBox</computeroutput> directory.
     968          <filename>/opt/VirtualBox</filename> directory.
    911969        </para>
    912970
     
    9711029          perform this task. To prevent any user interaction during
    9721030          installation, default values can be defined. A file
    973           <computeroutput>vboxconf</computeroutput> can contain the
    974           following debconf settings:
     1031          <literal>vboxconf</literal> can contain the following debconf
     1032          settings:
    9751033        </para>
    9761034
     
    10081066          The RPM format does not provide a configuration system
    10091067          comparable to the debconf system. See
    1010           <xref
    1011         linkend="linux_install_opts" /> for how to set
    1012           some common installation options provided by &product-name;.
     1068          <xref linkend="linux_install_opts" /> for how to set some
     1069          common installation options provided by &product-name;.
    10131070        </para>
    10141071
     
    10221079          To configure the installation process for .deb and .rpm
    10231080          packages, you can create a response file named
    1024           <computeroutput>/etc/default/virtualbox</computeroutput>. The
    1025           automatic generation of the udev rule can be prevented with
    1026           the following setting:
     1081          <filename>/etc/default/virtualbox</filename>. The automatic
     1082          generation of the udev rule can be prevented with the
     1083          following setting:
    10271084        </para>
    10281085
     
    10381095        <para>
    10391096          If the following line is specified, the package installer will
    1040           not try to build the <computeroutput>vboxdrv</computeroutput>
    1041           kernel module if no module fitting the current kernel was
    1042           found.
     1097          not try to build the <command>vboxdrv</command> kernel module
     1098          if no module fitting the current kernel was found.
    10431099        </para>
    10441100
     
    10551111      <para>
    10561112        The Linux installers create the system user group
    1057         <computeroutput>vboxusers</computeroutput> during installation.
    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:
     1113        <literal>vboxusers</literal> during installation. Any system
     1114        user who is going to use USB devices from &product-name; guests
     1115        must be a member of that group. A user can be made a member of
     1116        the group <literal>vboxusers</literal> either by using the
     1117        desktop user and group tools, or with the following command:
    10631118      </para>
    10641119
     
    10721127
    10731128      <para>
    1074         The easiest way to start a &product-name; program is by running
     1129        The easiest way to start an &product-name; program is by running
    10751130        the program of your choice (<command>VirtualBox</command>,
    10761131        <command>VBoxManage</command>, or
     
    10841139        if you wish to execute &product-name; without installing it
    10851140        first. You should start by compiling the
    1086         <computeroutput>vboxdrv</computeroutput> kernel module and
    1087         inserting it into the Linux kernel. &product-name; consists of a
    1088         service daemon, <computeroutput>VBoxSVC</computeroutput>, and
    1089         several application programs. The daemon is automatically
    1090         started if necessary. All &product-name; applications will
    1091         communicate with the daemon through UNIX local domain sockets.
    1092         There can be multiple daemon instances under different user
    1093         accounts and applications can only communicate with the daemon
    1094         running under the user account as the application. The local
    1095         domain socket resides in a subdirectory of your system's
    1096         directory for temporary files called
    1097         <computeroutput>.vbox-&lt;username&gt;-ipc</computeroutput>. In
    1098         case of communication problems or server startup problems, you
    1099         may try to remove this directory.
     1141        <command>vboxdrv</command> kernel module and inserting it into
     1142        the Linux kernel. &product-name; consists of a service daemon,
     1143        <command>VBoxSVC</command>, and several application programs.
     1144        The daemon is automatically started if necessary. All
     1145        &product-name; applications will communicate with the daemon
     1146        through UNIX local domain sockets. There can be multiple daemon
     1147        instances under different user accounts and applications can
     1148        only communicate with the daemon running under the user account
     1149        as the application. The local domain socket resides in a
     1150        subdirectory of your system's directory for temporary files
     1151        called <filename>.vbox-&lt;username&gt;-ipc</filename>. In case
     1152        of communication problems or server startup problems, you may
     1153        try to remove this directory.
    11001154      </para>
    11011155
     
    11191173    <para>
    11201174      For the specific versions of Oracle Solaris that are supported as
    1121       host operating systems, see <xref
    1122     linkend="hostossupport" />.
     1175      host operating systems, see <xref linkend="hostossupport" />.
    11231176    </para>
    11241177
     
    11371190      <para>
    11381191        &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
     1192        package. Download the &product-name; SunOS package, which
     1193        includes the 64-bit version of &product-name;. <emphasis>The
    11411194        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:
     1195        zone</emphasis>. This is because the &product-name; installer
     1196        loads kernel drivers, which cannot be done from non-global
     1197        zones. To verify which zone you are currently in, execute the
     1198        <command>zonename</command> command.
     1199      </para>
     1200
     1201      <para>
     1202        To start installation, run the following commands:
    11471203      </para>
    11481204
     
    11501206
    11511207      <para>
    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:
     1208        The &product-name; kernel package is integrated into the main
     1209        package. Install the &product-name; package as follows:
    11551210      </para>
    11561211
     
    11721227        Once the postinstall script has been executed your installation
    11731228        is now complete. You may now safely delete the uncompressed
    1174         package and <computeroutput>autoresponse</computeroutput> files
    1175         from your system. &product-name; is installed in
    1176         <computeroutput>/opt/VirtualBox</computeroutput>.
     1229        package and <filename>autoresponse</filename> files from your
     1230        system. &product-name; is installed in
     1231        <filename>/opt/VirtualBox</filename>.
    11771232      </para>
    11781233
     
    11921247      <para>
    11931248        The installer creates the system user group
    1194         <computeroutput>vboxuser</computeroutput> during installation
    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:
     1249        <literal>vboxuser</literal> during installation for Oracle
     1250        Solaris hosts that support the USB features required by
     1251        &product-name;. Any system user who is going to use USB devices
     1252        from &product-name; guests must be a member of this group. A
     1253        user can be made a member of this group either by using the
     1254        desktop user and group tools or by running the following command
     1255        as root:
    12011256      </para>
    12021257
     
    12041259
    12051260      <para>
    1206         Note that adding an active user to that group will require that
    1207         user to log out and back in again. This should be done manually
    1208         after successful installation of the package.
     1261        Note that adding an active user to the
     1262        <literal>vboxuser</literal> group will require the user to log
     1263        out and then log in again. This should be done manually after
     1264        successful installation of the package.
    12091265      </para>
    12101266
     
    12161272
    12171273      <para>
    1218         The easiest way to start a &product-name; program is by running
     1274        The easiest way to start an &product-name; program is by running
    12191275        the program of your choice (<command>VirtualBox</command>,
    12201276        <command>VBoxManage</command>, or
     
    12261282      <para>
    12271283        Alternatively, you can directly invoke the required programs
    1228         from <computeroutput>/opt/VirtualBox</computeroutput>. Using the
    1229         links provided is easier as you do not have to enter the full
    1230         path.
     1284        from <filename>/opt/VirtualBox</filename>. Using the links
     1285        provided is easier as you do not have to enter the full path.
    12311286      </para>
    12321287
     
    12561311      </para>
    12571312
    1258       <para>
    1259         If you are uninstalling &product-name; version 3.0 or lower, you
    1260         need to remove the &product-name; kernel interface package, as
    1261         follows:
    1262       </para>
    1263 
    1264 <screen>pkgrm SUNWvboxkern</screen>
    1265 
    12661313    </sect2>
    12671314
     
    12731320        To perform a non-interactive installation of &product-name;
    12741321        there is a response file named
    1275         <computeroutput>autoresponse</computeroutput>, that the
    1276         installer will use for responses to inputs rather than ask them
    1277         from you.
    1278       </para>
    1279 
    1280       <para>
    1281         Extract the tar.gz package as described in the normal
    1282         installation instructions. Then open a root terminal session and
    1283         run the following command:
     1322        <filename>autoresponse</filename>. The installer uses this for
     1323        responses to inputs, rather than prompting the user.
     1324      </para>
     1325
     1326      <para>
     1327        Extract the tar.gz package as described in
     1328        <xref linkend="install-solaris-performing"/>. Then open a root
     1329        terminal session and run the following command:
    12841330      </para>
    12851331
     
    13061352      </para>
    13071353
    1308 <screen>zonecfg -z vboxzone</screen>
    1309 
    1310       <para>
    1311         Replace "vboxzone" with the name of the zone where you intend to
    1312         run &product-name;.
    1313       </para>
    1314 
    1315       <para>
    1316         Use<computeroutput>zonecfg</computeroutput> to add the
    1317         <computeroutput>device</computeroutput> resource and
    1318         <computeroutput>match</computeroutput> properties to the zone,
    1319         as follows:
     1354<screen>zonecfg -z <replaceable>vboxzone</replaceable></screen>
     1355
     1356      <para>
     1357        Replace <replaceable>vboxzone</replaceable> with the name of the
     1358        zone where you intend to run &product-name;.
     1359      </para>
     1360
     1361      <para>
     1362        Use <command>zonecfg</command> to add the
     1363        <literal>device</literal> resource and <literal>match</literal>
     1364        properties to the zone, as follows:
    13201365      </para>
    13211366
     
    13291374
    13301375      <para>
    1331         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
    1333         <computeroutput>/dev/vboxusbmon</computeroutput>, similar to
    1334         that shown above. This does not apply to Oracle Solaris 10
    1335         hosts, due to lack of USB support.
     1376        On Oracle Solaris 11 or later, you may also add a device for
     1377        <filename>/dev/vboxusbmon</filename>, similar to that shown
     1378        above.
    13361379      </para>
    13371380
    13381381      <para>
    13391382        If you are not using sparse root zones, you will need to
    1340         loopback mount <computeroutput>/opt/VirtualBox</computeroutput>
    1341         from the global zone into the non-global zone at the same path.
    1342         This is specified below using the
    1343         <computeroutput>dir</computeroutput> attribute and the
    1344         <computeroutput>special</computeroutput> attribute. For example:
     1383        loopback mount <filename>/opt/VirtualBox</filename> from the
     1384        global zone into the non-global zone at the same path. This is
     1385        specified below using the <literal>dir</literal> attribute and
     1386        the <literal>special</literal> attribute. For example:
    13451387      </para>
    13461388
     
    13531395
    13541396      <para>
    1355         Reboot the zone using <computeroutput>zoneadm</computeroutput>
    1356         and you should be able to run &product-name; from within the
    1357         configured zone.
     1397        Reboot the zone using <command>zoneadm</command> and you should
     1398        be able to run &product-name; from within the configured zone.
    13581399      </para>
    13591400
  • trunk/doc/manual/en_US/user_Introduction.xml

    r81940 r82350  
    184184          OS).</emphasis> This is the OS that is running inside the
    185185          virtual machine. Theoretically, &product-name; can run any x86
    186           OS. such as DOS, Windows, OS/2, FreeBSD, and OpenBSD. But to
     186          OS such as DOS, Windows, OS/2, FreeBSD, and OpenBSD. But to
    187187          achieve near-native performance of the guest code on your
    188188          machine, we had to go through a lot of optimizations that are
     
    203203          is the special environment that &product-name; creates for
    204204          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.
    210         </para>
    211 
    212         <para>
    213           In a more abstract way, internally, &product-name; thinks of a
    214           VM as a set of parameters that determine its behavior. They
    215           include hardware settings, such as: how much memory the VM
    216           should have, what hard disks &product-name; should virtualize
    217           through which container files, what CDs are mounted. They also
    218           include state information, such as: whether the VM is
    219           currently running, saved, if the VM has snapshots. These
    220           settings are mirrored in the VirtualBox Manager window, as
    221           well as the <command>VBoxManage</command> command. See
    222           <xref linkend="vboxmanage" />. In other words, a VM is also
    223           what you can see in its
    224           <emphasis role="bold">Settings</emphasis> dialog.
     205          your guest OS <emphasis>in</emphasis> a VM. Normally, a VM is
     206          shown as a window on your computer's desktop. Depending on
     207          which of the various frontends of &product-name; you use, the
     208          VM might be shown in full screen mode or remotely on another
     209          computer.
     210        </para>
     211
     212        <para>
     213          Internally, &product-name; treats a VM as a set of parameters
     214          that specify its behavior. Some parameters describe hardware
     215          settings, such as the amount of memory and number of CPUs
     216          assigned. Other parameters describe the state information,
     217          such as whether the VM is running or saved.
     218        </para>
     219
     220        <para>
     221          You can view these VM settings in the VirtualBox Manager
     222          window, the <emphasis role="bold">Settings</emphasis> dialog,
     223          and by running the <command>VBoxManage</command> command. See
     224          <xref linkend="vboxmanage" />.
    225225        </para>
    226226      </listitem>
     
    287287
    288288        <para>
    289           For users of &oci; the functionality extends to exporting
    290           and importing virtial machines to and from the cloud. This
    291           simplifies development of applications and deployment to
    292           the production environment. See
     289          For users of &oci; the functionality extends to exporting and
     290          importing virtual machines to and from the cloud. This
     291          simplifies development of applications and deployment to the
     292          production environment. See
    293293          <xref linkend="cloud-export-oci"/>.
    294294        </para>
     
    310310
    311311        <para>
    312           In particular, Guest Additions provide for "shared folders",
    313           which let you access files from the host system from within a
    314           guest machine. See <xref linkend="sharedfolders" />.
     312          In particular, Guest Additions provide for <emphasis>shared
     313          folders</emphasis>, which let you access files on the host
     314          system from within a guest machine. See
     315          <xref linkend="sharedfolders" />.
    315316        </para>
    316317      </listitem>
     
    319320        <para>
    320321          <emphasis role="bold">Great hardware support.</emphasis> Among
    321           others, &product-name; supports the following:
     322          other features, &product-name; supports the following:
    322323        </para>
    323324
     
    350351              devices, among them many devices that are typically
    351352              provided by other virtualization platforms. That includes
    352               IDE, SCSI and SATA hard disk controllers, several virtual
     353              IDE, SCSI, and SATA hard disk controllers, several virtual
    353354              network cards and sound cards, virtual serial and parallel
    354355              ports and an Input/Output Advanced Programmable Interrupt
    355               Controller (I/O APIC), which is found in many modern PC
    356               systems. This eases cloning of PC images from real
    357               machines and importing of third-party virtual machines
    358               into &product-name;.
     356              Controller (I/O APIC), which is found in many computer
     357              systems. This enables easy cloning of disk images from
     358              real machines and importing of third-party virtual
     359              machines into &product-name;.
    359360            </para>
    360361          </listitem>
     
    364365              <emphasis role="bold">Full ACPI support.</emphasis> The
    365366              Advanced Configuration and Power Interface (ACPI) is fully
    366               supported by &product-name;. This eases cloning of PC
    367               images from real machines or third-party virtual machines
    368               into &product-name;. With its unique <emphasis>ACPI power
    369               status support</emphasis>, &product-name; can even report
    370               to ACPI-aware guest OSes the power status of the host. For
    371               mobile systems running on battery, the guest can thus
    372               enable energy saving and notify the user of the remaining
    373               power, for example in full screen modes.
     367              supported by &product-name;. This enables easy cloning of
     368              disk images from real machines or third-party virtual
     369              machines into &product-name;. With its unique
     370              <emphasis>ACPI power status support</emphasis>,
     371              &product-name; can even report to ACPI-aware guest OSes
     372              the power status of the host. For mobile systems running
     373              on battery, the guest can thus enable energy saving and
     374              notify the user of the remaining power, for example in
     375              full screen modes.
    374376            </para>
    375377          </listitem>
     
    503505              virtual channel support, &product-name; also enables you
    504506              to connect arbitrary USB devices locally to a virtual
    505               machine which is running remotely on a &product-name; RDP
     507              machine which is running remotely on an &product-name; RDP
    506508              server. See <xref linkend="usb-over-rdp" />.
    507509            </para>
     
    546548          <listitem>
    547549            <para>
    548               Windows 10 Anniversary Update (1607 / 2016 LTSB) build 14393
     550              Windows 10 Anniversary Update (1607 / 2016 LTSB) build
     551              14393
    549552            </para>
    550553          </listitem>
     
    564567          <listitem>
    565568            <para>
    566               Windows 10 October 2018 Update (1809 / 2019 LTSC) build 17763
     569              Windows 10 October 2018 Update (1809 / 2019 LTSC) build
     570              17763
    567571            </para>
    568572          </listitem>
     
    668672          <listitem>
    669673            <para>
    670               Redhat Enterprise Linux 6, 7 and 8
     674              Red Hat Enterprise Linux 6, 7 and 8
    671675            </para>
    672676          </listitem>
     
    740744    </para>
    741745
    742   </sect1>
    743 
    744   <sect1 id="hostcpurequirements">
    745 
    746     <title>Host CPU Requirements</title>
    747 
    748     <para>
    749       SSE2 is required, starting with &product-name; version 5.2.10 and
    750       version 5.1.24.
    751     </para>
     746    <sect2 id="hostcpurequirements">
     747
     748      <title>Host CPU Requirements</title>
     749
     750      <para>
     751        SSE2 (Streaming SIMD Extensions 2) support is required for host
     752        CPUs.
     753      </para>
     754
     755    </sect2>
    752756
    753757  </sect1>
     
    788792          Oracle provides a single extension pack, available from:
    789793          <ulink
    790           url="http://www.virtualbox.org">http://www.virtualbox.org</ulink>.
    791           The extension pack provides the following added functionality:
     794          url="http://www.virtualbox.org" />. The
     795          extension pack provides the following added functionality:
    792796        </para>
    793797
     
    829833          </listitem>
    830834
    831           <listitem>
     835<!--   <listitem>
    832836            <para>
    833837              Experimental support for PCI passthrough on Linux hosts.
    834838              See <xref linkend="pcipassthrough" />.
    835839            </para>
    836           </listitem>
     840          </listitem>-->
    837841
    838842          <listitem>
     
    847851        <para>
    848852          &product-name; extension packages have a
    849           <computeroutput>.vbox-extpack</computeroutput> file name
    850           extension. To install an extension, simply double-click on the
    851           package file and a <emphasis role="bold">Network Operations
     853          <filename>.vbox-extpack</filename> file name extension. To
     854          install an extension, simply double-click on the package file
     855          and a <emphasis role="bold">Network Operations
    852856          Manager</emphasis> window is shown to guide you through the
    853857          required steps.
     
    891895          <emphasis role="bold">Programs</emphasis> menu, click on the
    892896          item in the <emphasis role="bold">VirtualBox</emphasis> group.
    893           On Vista or Windows 7, you can also enter
    894           <computeroutput>VirtualBox</computeroutput> in the search box
    895           of the <emphasis role="bold">Start</emphasis> menu.
     897          On some Windows platforms, you can also enter
     898          <command>VirtualBox</command> in the search box of the
     899          <emphasis role="bold">Start</emphasis> menu.
    896900        </para>
    897901      </listitem>
     
    912916          either the System or System Tools group of your
    913917          <emphasis role="bold">Applications</emphasis> menu.
    914           Alternatively, you can enter
    915           <computeroutput>VirtualBox</computeroutput> in a terminal
    916           window.
     918          Alternatively, you can enter <command>VirtualBox</command> in
     919          a terminal window.
    917920        </para>
    918921      </listitem>
     
    10021005      <listitem>
    10031006        <para>
    1004           The <emphasis role="bold">Name</emphasis> of the VM will later
    1005           be shown in the machine list of the VirtualBox Manager window,
    1006           and it will be used for the VM's files on disk. Even though
    1007           any name can be used, bear in mind that if you create a few
    1008           VMs, you will appreciate if you have given your VMs rather
    1009           informative names."My VM" would thus be less useful than
    1010           "Windows XP SP2 with OpenOffice", for example.
     1007          The <emphasis role="bold">Name</emphasis> of the VM you choose
     1008          is shown in the machine list of the VirtualBox Manager window
     1009          and is also used for the VM's files on disk.
     1010        </para>
     1011
     1012        <para>
     1013          Be sure to assign each VM an informative name that describes
     1014          the OS and software running on the VM. For example,
     1015          <literal>Windows 10 with Visio</literal>.
    10111016        </para>
    10121017      </listitem>
     
    10221027      <listitem>
    10231028        <para>
    1024           For <emphasis role="bold">Operating System Type</emphasis>
    1025           select the OS that you want to install later. The supported
    1026           OSes are grouped. If you want to install something very
    1027           unusual that is not listed, select
    1028           <emphasis role="bold">Other</emphasis>. Depending on your
    1029           selection, &product-name; will enable or disable certain VM
    1030           settings that your guest OS may require. This is particularly
    1031           important for 64-bit guests. See
     1029          For <emphasis role="bold">Operating System Type</emphasis>,
     1030          select the OS that you want to install. The supported OSes are
     1031          grouped. If you want to install something very unusual that is
     1032          not listed, select <emphasis role="bold">Other</emphasis>.
     1033          Depending on your selection, &product-name; will enable or
     1034          disable certain VM settings that your guest OS may require.
     1035          This is particularly important for 64-bit guests. See
    10321036          <xref linkend="intro-64bitguests" />. It is therefore
    10331037          recommended to always set it to the correct value.
     
    10491053            Choose this setting carefully. The memory you give to the VM
    10501054            will not be available to your host OS while the VM is
    1051             running, so do not specify more than you can spare. For
    1052             example, if your host machine has 1 GB of RAM and you enter
    1053             512 MB as the amount of RAM for a particular virtual
    1054             machine, while that VM is running, you will only have 512 MB
    1055             left for all the other software on your host. If you run two
    1056             VMs at the same time, even more memory will be allocated for
    1057             the second VM, which may not even be able to start if that
    1058             memory is not available. On the other hand, you should
    1059             specify as much as your guest OS and your applications will
    1060             require to run properly.
     1055            running, so do not specify more than you can spare.
     1056          </para>
     1057
     1058          <para>
     1059            For example, if your host machine has 4 GB of RAM and you
     1060            enter 2048 MB as the amount of RAM for a particular virtual
     1061            machine, you will only have 2 GB left for all the other
     1062            software on your host while the VM is running. If you run
     1063            two VMs at the same time, even more memory will be allocated
     1064            for the second VM, which may not even be able to start if
     1065            that memory is not available.
     1066          </para>
     1067
     1068          <para>
     1069            On the other hand, you should specify as much as your guest
     1070            OS and your applications will require to run properly. A
     1071            guest OS may require at least 1 or 2 GB of memory to install
     1072            and boot up. For best performance, more memory than that may
     1073            be required.
    10611074          </para>
    10621075        </caution>
    10631076
    10641077        <para>
    1065           A Windows XP guest will require at least a few hundred MB of
    1066           RAM to run properly, and Windows Vista will not install with
    1067           less than 512 MB. If you want to run graphics-intensive
    1068           applications in your VM, you may require even more RAM.
    1069         </para>
    1070 
    1071         <para>
    1072           As a rule of thumb, if you have 1 GB of RAM or more in your
    1073           host computer, it is usually safe to allocate 512 MB to each
    1074           VM. In any case, make sure you always have at least 256 to 512
    1075           MB of RAM left on your host OS. Otherwise you may cause your
    1076           host OS to excessively swap out memory to your hard disk,
    1077           effectively bringing your host system to a standstill.
     1078          Always ensure that the host OS has enough RAM remaining. If
     1079          insufficient RAM remains, the system might excessively swap
     1080          memory to the hard disk, which effectively brings the host
     1081          system to a standstill.
    10781082        </para>
    10791083
     
    10941098          &product-name; can provide hard disk space to a VM, see
    10951099          <xref linkend="storage" />, but the most common way is to use
    1096           a large image file on your "real" hard disk, whose contents
     1100          a large image file on your physical hard disk, whose contents
    10971101          &product-name; presents to your VM as if it were a complete
    1098           hard disk. This file represents an entire hard disk then, so
     1102          hard disk. This file then represents an entire hard disk, so
    10991103          you can even copy it to another host and use it with another
    11001104          &product-name; installation.
     
    11071111        <figure id="fig-new-vm-hard-disk">
    11081112          <title>Creating a New Virtual Machine: Hard Disk</title>
    1109           <mediaobject>
     1113         <mediaobject>
    11101114            <imageobject>
    11111115              <imagedata align="center" fileref="images/create-vm-2.png"
     
    11741178            <para>
    11751179              A <emphasis role="bold">dynamically allocated
    1176               file</emphasis> will only grow in size when the guest
    1177               actually stores data on its virtual hard disk. It will
    1178               therefore initially be small on the host hard drive and
    1179               only later grow to the size specified as it is filled with
    1180               data.
    1181             </para>
    1182           </listitem>
    1183 
    1184           <listitem>
    1185             <para>
    1186               A <emphasis role="bold">fixed-size file</emphasis> will
    1187               immediately occupy the file specified, even if only a
    1188               fraction of the virtual hard disk space is actually in
     1180              file</emphasis> only grows in size when the guest actually
     1181              stores data on its virtual hard disk. Therefore, this file
     1182              is small initially. As the drive is filled with data, the
     1183              file grows to the specified size.
     1184            </para>
     1185          </listitem>
     1186
     1187          <listitem>
     1188            <para>
     1189              A <emphasis role="bold">fixed-size file</emphasis>
     1190              immediately occupies the file specified, even if only a
     1191              fraction of that virtual hard disk space is actually in
    11891192              use. While occupying much more space, a fixed-size file
    11901193              incurs less overhead and is therefore slightly faster than
     
    12011204
    12021205        <para>
    1203           To prevent your physical hard disk from running full,
    1204           &product-name; limits the size of the image file. Still, it
    1205           needs to be large enough to hold the contents of your OS and
    1206           the applications you want to install. For a modern Windows or
    1207           Linux guest, you will probably need several gigabytes for any
    1208           serious use. The limit of the image file size can be changed
    1209           later, see <xref linkend="vboxmanage-modifyvdi"/>.
     1206          To prevent your physical hard disk (host OS) from filling up,
     1207          &product-name; limits the size of the image file. But the
     1208          image file must be large enough to hold the contents of the
     1209          guest OS and the applications you want to install. For a
     1210          Windows or Linux guest, you will probably need several
     1211          gigabytes for any serious use. The limit of the image file
     1212          size can be changed later, see
     1213          <xref linkend="vboxmanage-modifymedium"/>.
    12101214        </para>
    12111215
     
    12751279      <listitem>
    12761280        <para>
    1277           Go to the <computeroutput>VirtualBox VMs</computeroutput>
    1278           folder in your system user's home directory. Find the
    1279           subdirectory of the machine you want to start and double-click
    1280           on the machine settings file. This file has a
    1281           <computeroutput>.vbox</computeroutput> file extension.
     1281          Go to the <filename>VirtualBox VMs</filename> folder in your
     1282          system user's home directory. Find the subdirectory of the
     1283          machine you want to start and double-click on the machine
     1284          settings file. This file has a <filename>.vbox</filename> file
     1285          extension.
    12821286        </para>
    12831287      </listitem>
     
    13861390
    13871391      <para>
    1388         Otherwise, if the virtual machine only sees standard PS/2 mouse
    1389         and keyboard devices, since the OS in the virtual machine does
    1390         not know that it is not running on a real computer, it expects
    1391         to have exclusive control over your keyboard and mouse. But
    1392         unless you are running the VM in full screen mode, your VM needs
    1393         to share keyboard and mouse with other applications and possibly
    1394         other VMs on your host.
     1392        Otherwise, if the virtual machine detects only standard PS/2
     1393        mouse and keyboard devices, since the OS in the virtual machine
     1394        does not know that it is not running on a real computer, it
     1395        expects to have exclusive control over your keyboard and mouse.
     1396        But unless you are running the VM in full screen mode, your VM
     1397        needs to share keyboard and mouse with other applications and
     1398        possibly other VMs on your host.
    13951399      </para>
    13961400
     
    14501454          <para>
    14511455            Note that while the VM owns the keyboard, some key
    1452             sequences, such as Alt-Tab, will no longer be seen by the
     1456            sequences, such as Alt+Tab, will no longer be seen by the
    14531457            host, but will go to the guest instead. After you press the
    14541458            Host key to reenable the host keyboard, all key presses will
    1455             go through the host again, so that sequences such as Alt-Tab
     1459            go through the host again, so that sequences such as Alt+Tab
    14561460            will no longer reach the guest. For technical reasons it may
    14571461            not be possible for the VM to get all keyboard input even
    14581462            when it does own the keyboard. Examples of this are the
    1459             Ctrl-Alt-Del sequence on Windows hosts or single keys
    1460             grabbed by other applications on X11 hosts like the GNOME
    1461             desktop's "Control key highlights mouse pointer"
    1462             functionality.
     1463            Ctrl+Alt+Del sequence on Windows hosts or single keys
     1464            grabbed by other applications on X11 hosts such as the GNOME
     1465            desktop Locate Pointer feature.
    14631466          </para>
    14641467        </listitem>
     
    14881491
    14891492      <para>
    1490         As this behavior can be inconvenient, &product-name; provides a
    1491         set of tools and device drivers for guest systems called the
    1492         &product-name; Guest Additions which make VM keyboard and mouse
    1493         operation a lot more seamless. Most importantly, the Additions
    1494         will get rid of the second "guest" mouse pointer and make your
    1495         host mouse pointer work directly in the guest. See
     1493        As this behavior is inconvenient, &product-name; provides a set
     1494        of tools and device drivers for guest systems called the
     1495        &product-name; Guest Additions. These tools make VM keyboard and
     1496        mouse operations much more seamless. Most importantly, the Guest
     1497        Additions suppress the second "guest" mouse pointer and make
     1498        your host mouse pointer work directly in the guest. See
    14961499        <xref linkend="guestadditions" />.
    14971500      </para>
     
    15041507
    15051508      <para>
    1506         OSes expect certain key combinations to initiate certain
    1507         procedures. Some of these key combinations may be difficult to
    1508         enter into a virtual machine, as there are three candidates as
    1509         to who receives keyboard input: the host OS, &product-name;, or
    1510         the guest OS. Which of these three receives keypresses depends
    1511         on a number of factors, including the key itself.
     1509        Some OSes expect certain key combinations to initiate certain
     1510        procedures. The key combinations that you type into a VM might
     1511        target the host OS, the &product-name; software, or the guest
     1512        OS. The recipient of these keypresses depends on a number of
     1513        factors, including the key combination itself.
    15121514      </para>
    15131515
     
    15171519          <para>
    15181520            Host OSes reserve certain key combinations for themselves.
    1519             For example, it is impossible to enter the
     1521            For example, you cannot use the
    15201522            <emphasis role="bold">Ctrl+Alt+Delete</emphasis> combination
    1521             if you want to reboot the guest OS in your virtual machine,
    1522             because this key combination is usually hard-wired into the
    1523             host OS, both Windows and Linux intercept this, and pressing
    1524             this key combination will therefore reboot your
    1525             <emphasis>host</emphasis>.
     1523            to reboot the guest OS in your VM because this key
     1524            combination is usually hard-wired into the host OS. So, even
     1525            though both the Windows and Linux OSes intercept this key
     1526            combination, only the host OS would be rebooted.
    15261527          </para>
    15271528
     
    15431544            where Fx is one of the function keys from F1 to F12,
    15441545            normally enables you to switch between virtual terminals. As
    1545             with Ctrl+Alt+Delete, these combinations are intercepted by
    1546             the host OS and therefore always switch terminals on the
    1547             <emphasis>host</emphasis>.
     1546            with <emphasis role="bold">Ctrl+Alt+Delete</emphasis>, these
     1547            combinations are intercepted by the host OS and therefore
     1548            always switch terminals on the <emphasis>host</emphasis>.
    15481549          </para>
    15491550
     
    15631564                virtual machine window. This menu includes the settings
    15641565                <emphasis role="bold">Insert Ctrl+Alt+Delete</emphasis>
    1565                 and <emphasis role="bold">Ctrl+Alt+Backspace</emphasis>.
    1566                 The latter will only have an effect with Linux or Oracle
    1567                 Solaris guests, however.
     1566                and <emphasis role="bold">Insert
     1567                Ctrl+Alt+Backspace</emphasis>. However, the latter
     1568                setting affects only Linux guests or Oracle Solaris
     1569                guests.
    15681570              </para>
    15691571
     
    15761578            <listitem>
    15771579              <para>
    1578                 Use special key combinations with the Host key, normally
    1579                 the right Control key. &product-name; will then
    1580                 translate these key combinations for the virtual
    1581                 machine:
     1580                Use special key combinations with the Host key, which is
     1581                normally the right Control key. &product-name; then
     1582                translates the following key combinations for the VM:
    15821583              </para>
    15831584
     
    15861587                <listitem>
    15871588                  <para>
    1588                     <emphasis role="bold">Host key + Del</emphasis> to
    1589                     send Ctrl+Alt+Del to reboot the guest.
     1589                    <emphasis role="bold">Host key + Del</emphasis>
     1590                    sends <emphasis role="bold">Ctrl+Alt+Del</emphasis>
     1591                    to reboot the guest OS.
    15901592                  </para>
    15911593                </listitem>
     
    15941596                  <para>
    15951597                    <emphasis role="bold">Host key +
    1596                     Backspace</emphasis> to send Ctrl+Alt+Backspace to
    1597                     restart the graphical user interface of a Linux or
    1598                     Oracle Solaris guest.
     1598                    Backspace</emphasis> sends
     1599                    <emphasis role="bold">Ctrl+Alt+Backspace</emphasis>
     1600                    to restart the graphical user interface of a Linux
     1601                    or Oracle Solaris guest.
    15991602                  </para>
    16001603                </listitem>
     
    16031606                  <para>
    16041607                    <emphasis role="bold">Host key + Function
    1605                     key</emphasis>. For example, to simulate Ctrl+Alt+Fx
    1606                     to switch between virtual terminals in a Linux
    1607                     guest.
     1608                    key</emphasis>. For example, use this key
     1609                    combination to simulate
     1610                    <emphasis role="bold">Ctrl+Alt+Fx</emphasis> to
     1611                    switch between virtual terminals in a Linux guest.
    16081612                  </para>
    16091613                </listitem>
     
    16181622          <para>
    16191623            For some other keyboard combinations such as
    1620             <emphasis role="bold">Alt-Tab</emphasis> to switch between
     1624            <emphasis role="bold">Alt+Tab</emphasis> to switch between
    16211625            open windows, &product-name; enables you to configure
    16221626            whether these combinations will affect the host or the
     
    16261630            <emphasis role="bold">Preferences</emphasis>,
    16271631            <emphasis role="bold">Input</emphasis>.
     1632          </para>
     1633        </listitem>
     1634
     1635        <listitem>
     1636          <para>
     1637            A soft keyboard can be used to input key combinations in the
     1638            guest. See <xref linkend="soft-keyb"/>.
    16281639          </para>
    16291640        </listitem>
     
    16751686
    16761687      <para>
    1677         You can resize the virtual machine's window when it is running.
    1678         In that case, one of the following things will happen:
     1688        You can resize the VM's window while that VM is running. When
     1689        you do, the window is scaled as follows:
    16791690      </para>
    16801691
     
    17951806            This will send an ACPI shutdown signal to the virtual
    17961807            machine, which has the same effect as if you had pressed the
    1797             power button on a real computer. So long as the VM is
    1798             running a fairly modern OS, this should trigger a proper
    1799             shutdown mechanism from within the VM.
     1808            power button on a real computer. This should trigger a
     1809            proper shutdown mechanism from within the VM.
    18001810          </para>
    18011811        </listitem>
     
    20852095          <figure id="fig-snapshots-list">
    20862096            <title>Snapshots List For a Virtual Machine</title>
    2087             <mediaobject>
     2097           <mediaobject>
    20882098              <imageobject>
    20892099                <imagedata align="center" fileref="images/snapshots-1.png"
     
    22582268          <para>
    22592269            The memory state file can be as large as the memory size of
    2260             the virtual machine and will therefore occupy quite some
    2261             disk space as well.
     2270            the VM and will therefore occupy considerable disk space.
    22622271          </para>
    22632272        </listitem>
     
    25572566        <para>
    25582567          <emphasis role="bold">Cloud service formats.</emphasis> Export
    2559           to cloud services such as &oci; is supported. Import is not
    2560           supported. See <xref linkend="cloud-export-oci"/>.
     2568          to and import from cloud services such as &oci; is supported.
     2569          See the following topics:
     2570        </para>
     2571
     2572        <itemizedlist>
     2573
     2574          <listitem>
     2575            <para>
     2576              <xref linkend="cloud-export-oci"/>
     2577            </para>
     2578          </listitem>
     2579
     2580          <listitem>
     2581            <para>
     2582              <xref linkend="cloud-import-oci"/>
     2583            </para>
     2584          </listitem>
     2585
     2586        </itemizedlist>
     2587
     2588        <para>
     2589          Before using &product-name; with &oci; there are some initial
     2590          configuration steps you need to consider. See
     2591          <xref linkend="cloud-integration-steps"/>.
     2592        </para>
     2593
     2594        <para>
     2595          &product-name; can also be used to create new instances from a
     2596          custom image stored on &oci;. See
     2597          <xref linkend="cloud-new-vm"/>
    25612598        </para>
    25622599      </listitem>
     
    25922629          &product-name; supports all appliances created by other
    25932630          virtualization software. For a list of known limitations, see
    2594           <xref
    2595         linkend="KnownIssues" />.
     2631          <xref linkend="KnownIssues" />.
    25962632        </para>
    25972633      </note>
     
    26092645            <xref linkend="vdidetails" />. They also include a textual
    26102646            description file in an XML dialect with an
    2611             <computeroutput>.ovf</computeroutput> extension. These files
    2612             must then reside in the same directory for &product-name; to
    2613             be able to import them.
     2647            <filename>.ovf</filename> extension. These files must then
     2648            reside in the same directory for &product-name; to be able
     2649            to import them.
    26142650          </para>
    26152651        </listitem>
     
    26192655            Alternatively, the above files can be packed together into a
    26202656            single archive file, typically with an
    2621             <computeroutput>.ova</computeroutput> extension. Such
    2622             archive files use a variant of the TAR archive format and
    2623             can therefore be unpacked outside of &product-name; with any
    2624             utility that can unpack standard TAR files.
     2657            <filename>.ova</filename> extension. Such archive files use
     2658            a variant of the TAR archive format and can therefore be
     2659            unpacked outside of &product-name; with any utility that can
     2660            unpack standard TAR files.
    26252661          </para>
    26262662        </listitem>
     
    26662702          <para>
    26672703            Select <emphasis role="bold">File</emphasis>,
    2668             <emphasis
    2669             role="bold">Import
    2670             Appliance</emphasis> from the VirtualBox Manager window.
     2704            <emphasis role="bold">Import Appliance</emphasis> from the
     2705            VirtualBox Manager window.
    26712706          </para>
    26722707
    26732708          <para>
    26742709            From the file dialog, go to the file with either the
    2675             <computeroutput>.ovf</computeroutput> or the
    2676             <computeroutput>.ova</computeroutput> file extension.
     2710            <filename>.ovf</filename> or the <filename>.ova</filename>
     2711            file extension.
    26772712          </para>
    26782713
     
    27422777                <emphasis role="bold">Import Hard Drives as
    27432778                VDI:</emphasis> Imports hard drives in the VDI format
    2744                 rather that in the defalut VMDK format.
     2779                rather than in the default VMDK format.
    27452780              </para>
    27462781            </listitem>
     
    28282863              <para>
    28292864                The <emphasis role="bold">&oci;</emphasis> value exports
    2830                 export to &oci;. See <xref linkend="cloud-export-oci"/>.
     2865                the appliance to &oci;. See
     2866                <xref linkend="cloud-export-oci"/>.
    28312867              </para>
    28322868            </listitem>
     
    29022938    </sect2>
    29032939
    2904     <sect2 id="cloud-export-oci">
    2905 
    2906       <title>Exporting an Appliance to &oci;</title>
    2907 
    2908       <para>
    2909         &product-name; supports the export of VMs to an &oci; service.
    2910       </para>
    2911 
    2912       <para>
    2913         Before you can export a VM to &oci;, ensure that you perform the
    2914         following configuration steps:
     2940    <sect2 id="cloud-integration-steps">
     2941
     2942      <title>Preparing for &oci; Integration</title>
     2943
     2944      <para>
     2945        There are some common configuration steps you need to take
     2946        before using &product-name; to integrate with your &oci;
     2947        account.
    29152948      </para>
    29162949
     
    29192952        <listitem>
    29202953          <para>
    2921             Generate an API signing key pair that is used for API
    2922             requests to &oci;.
     2954            <emphasis role="bold">Create a key pair.</emphasis> Generate
     2955            an API signing key pair that is used for API requests to
     2956            &oci;.
    29232957          </para>
    29242958
     
    29282962              <para>
    29292963                The key pair is usually installed in the
    2930                 <computeroutput>.oci</computeroutput> folder in your
    2931                 home directory. For example,
    2932                 <computeroutput>~/.oci</computeroutput> on a Linux
     2964                <filename>.oci</filename> folder in your home directory.
     2965                For example, <filename>~/.oci</filename> on a Linux
    29332966                system.
    29342967              </para>
     
    29502983
    29512984          <para>
    2952             <ulink url="https://docs.cloud.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#How">https://docs.cloud.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#How</ulink>
    2953           </para>
    2954         </listitem>
    2955 
    2956         <listitem>
    2957           <para>
    2958             Create a profile for your cloud account.
    2959           </para>
    2960 
    2961           <para>
    2962             The cloud profile contains resource identifiers for your
    2963             cloud account, such as your user OCID, and the fingerprint
    2964             for your public key. You can create a cloud profile in the
     2985            <ulink url="https://docs.cloud.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#How" />
     2986          </para>
     2987        </listitem>
     2988
     2989        <listitem>
     2990          <para>
     2991            <emphasis role="bold">Create a cloud profile.</emphasis> The
     2992            cloud profile contains resource identifiers for your cloud
     2993            account, such as your user OCID, and the fingerprint for
     2994            your public key. You can create a cloud profile in the
    29652995            following ways:
    29662996          </para>
     
    29703000            <listitem>
    29713001              <para>
    2972                 Automatically by using the <emphasis role="bold">Cloud
     3002                Automatically, by using the <emphasis role="bold">Cloud
    29733003                Profile Manager</emphasis>. See
    29743004                <xref linkend="ovf-cloud-profile-manager"/>.
     
    29783008            <listitem>
    29793009              <para>
    2980                 Manually by creating an
    2981                 <computeroutput>oci_config</computeroutput> file in your
    2982                 &product-name; global configuration directory. For
    2983                 example, this is
    2984                 <computeroutput>$HOME/.config/VirtualBox/oci_config</computeroutput>
     3010                Automatically, by using the <command>VBoxManage
     3011                cloudprofile</command> command. See
     3012                <xref linkend="vboxmanage-cloudprofile"/>.
     3013              </para>
     3014            </listitem>
     3015
     3016            <listitem>
     3017              <para>
     3018                Manually, by creating an <filename>oci_config</filename>
     3019                file in your &product-name; global configuration
     3020                directory. For example, this is
     3021                <filename>$HOME/.config/VirtualBox/oci_config</filename>
    29853022                on a Linux host.
    29863023              </para>
     
    29893026            <listitem>
    29903027              <para>
    2991                 Manually by creating a
    2992                 <computeroutput>config</computeroutput> file in your
    2993                 &oci; configuration directory. For example, this is
    2994                 <computeroutput>$HOME/.oci/config</computeroutput> on a
    2995                 Linux host.
     3028                Manually, by creating a <filename>config</filename> file
     3029                in your &oci; configuration directory. For example, this
     3030                is <filename>$HOME/.oci/config</filename> on a Linux
     3031                host.
    29963032              </para>
    29973033
     
    30033039              <para>
    30043040                &product-name; automatically uses the
    3005                 <computeroutput>config</computeroutput> file if no cloud
    3006                 profile file is present in your global configuration
    3007                 directory. Alternatively, you can import this file
    3008                 manually into the Cloud Profile Manager.
     3041                <filename>config</filename> file if no cloud profile
     3042                file is present in your global configuration directory.
     3043                Alternatively, you can import this file manually into
     3044                the Cloud Profile Manager.
    30093045              </para>
    30103046            </listitem>
     
    30183054
    30193055          <para>
    3020             <ulink url="https://docs.cloud.oracle.com/iaas/Content/API/Concepts/sdkconfig.htm">https://docs.cloud.oracle.com/iaas/Content/API/Concepts/sdkconfig.htm</ulink>
    3021           </para>
    3022         </listitem>
    3023 
    3024         <listitem>
    3025           <para>
    3026             Ensure that the subnets that are used by source VMs are
    3027             available in the target compartment on the cloud service.
     3056            <ulink url="https://docs.cloud.oracle.com/iaas/Content/API/Concepts/sdkconfig.htm" />
     3057          </para>
     3058        </listitem>
     3059
     3060        <listitem>
     3061          <para>
     3062            <emphasis role="bold">Custom Linux images.</emphasis> To
     3063            export a custom Linux image, prepare the VM as described
     3064            here:
     3065          </para>
     3066
     3067          <para>
     3068            <ulink url="https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/importingcustomimagelinux.htm" />
     3069          </para>
     3070        </listitem>
     3071
     3072        <listitem>
     3073          <para>
     3074            <emphasis role="bold">Subnets.</emphasis> When exporting a
     3075            VM to cloud, ensure that the subnets that are used by source
     3076            VMs are available in the target compartment on the cloud
     3077            service.
    30283078          </para>
    30293079        </listitem>
    30303080
    30313081      </itemizedlist>
     3082
     3083    </sect2>
     3084
     3085    <sect2 id="cloud-export-oci">
     3086
     3087      <title>Exporting an Appliance to &oci;</title>
     3088
     3089      <para>
     3090        &product-name; supports the export of VMs to an &oci; service.
     3091        The exported VM is stored on &oci; as a custom image. You can
     3092        configure whether a cloud instance is created and started after
     3093        the export process has completed.
     3094      </para>
     3095
     3096      <para>
     3097        Before you can export a VM to &oci; ensure that you have done
     3098        the required preconfiguration tasks, as described in
     3099        <xref linkend="cloud-integration-steps"/>.
     3100      </para>
    30323101
    30333102      <para>
     
    30743143
    30753144          <figure id="fig-export-appliance-oci">
    3076             <title>Appliance Settings Screen, Showing Cloud Profile Settings</title>
     3145            <title>Appliance Settings Screen, Showing Cloud Profile and Machine Creation
     3146              Settings</title>
    30773147            <mediaobject>
    30783148              <imageobject>
     
    30813151              </imageobject>
    30823152            </mediaobject>
     3153
    30833154          </figure>
     3155
     3156          <para>
     3157            In the <emphasis role="bold">Machine Creation</emphasis>
     3158            field, select an option to configure settings for a cloud
     3159            instance created when you export to &oci;. The options
     3160            enable you to do one of the following:
     3161          </para>
     3162
     3163          <itemizedlist>
     3164
     3165            <listitem>
     3166              <para>
     3167                Configure settings for the cloud instance
     3168                <emphasis>after</emphasis> you have finished exporting
     3169                the VM.
     3170              </para>
     3171            </listitem>
     3172
     3173            <listitem>
     3174              <para>
     3175                Configure settings for the cloud instance
     3176                <emphasis>before</emphasis> you start to export the VM.
     3177              </para>
     3178            </listitem>
     3179
     3180            <listitem>
     3181              <para>
     3182                Do not create a cloud instance when you export the VM.
     3183              </para>
     3184            </listitem>
     3185
     3186          </itemizedlist>
    30843187
    30853188          <para>
    30863189            Click <emphasis role="bold">Next</emphasis> to make an API
    30873190            request to the &oci; service and open the
    3088             <emphasis
    3089             role="bold">Virtual System
    3090             Settings</emphasis> screen.
    3091           </para>
    3092         </listitem>
    3093 
    3094         <listitem>
    3095           <para>
    3096             Optionally edit settings used for the virtual machine on
    3097             &oci;.
    3098           </para>
    3099 
    3100           <para>
    3101             For example, you can edit the Disk Size and Shape used for
    3102             the VM instance.
    3103           </para>
     3191            <emphasis role="bold">Virtual System Settings</emphasis>
     3192            screen.
     3193          </para>
     3194        </listitem>
     3195
     3196        <listitem>
     3197          <para>
     3198            Optionally edit storage settings used for the exported
     3199            virtual machine in &oci;. You can change the following
     3200            settings:
     3201          </para>
     3202
     3203          <itemizedlist>
     3204
     3205            <listitem>
     3206              <para>
     3207                The name of the bucket used to store the exported files.
     3208              </para>
     3209            </listitem>
     3210
     3211            <listitem>
     3212              <para>
     3213                Whether to store the custom image in &oci;.
     3214              </para>
     3215            </listitem>
     3216
     3217            <listitem>
     3218              <para>
     3219                The name for the custom image in &oci;.
     3220              </para>
     3221            </listitem>
     3222
     3223            <listitem>
     3224              <para>
     3225                The launch mode for the custom image.
     3226              </para>
     3227
     3228              <para>
     3229                <emphasis role="bold">Paravirtualized</emphasis> mode
     3230                gives improved performance and should be suitable for
     3231                most &product-name; VMs.
     3232              </para>
     3233
     3234              <para>
     3235                <emphasis role="bold">Emulated</emphasis> mode is
     3236                suitable for legacy OS images.
     3237              </para>
     3238            </listitem>
     3239
     3240          </itemizedlist>
    31043241
    31053242          <para>
    31063243            Click <emphasis role="bold">Export</emphasis> to export the
    3107             VMs to the cloud service.
    3108           </para>
    3109 
    3110           <para>
    3111             The VMs are uploaded to &oci;.
    3112           </para>
    3113 
    3114           <para>
    3115             Instances are created for the uploaded VMs.
    3116           </para>
    3117 
    3118           <para>
    3119             By default, the VM instance is started after upload to
    3120             &oci;.
     3244            VM to &oci;.
     3245          </para>
     3246
     3247          <para>
     3248            Depending on the selection in the
     3249            <emphasis role="bold">Machine Creation</emphasis> field, the
     3250            <emphasis role="bold">Cloud Virtual Machine
     3251            Settings</emphasis> screen may be displayed before or after
     3252            export. This screen enables you to configure settings for
     3253            the cloud instance, such as Shape and Disk Size.
     3254          </para>
     3255
     3256          <para>
     3257            Click <emphasis role="bold">Create</emphasis>. The VM is
     3258            exported to &oci;.
     3259          </para>
     3260
     3261          <para>
     3262            Depending on the <emphasis role="bold">Machine
     3263            Creation</emphasis> setting, a cloud instance may be started
     3264            after upload to &oci; is completed.
    31213265          </para>
    31223266        </listitem>
     
    31403284    <sect2 id="cloud-import-oci">
    31413285
    3142       <title>Importing an instance from &oci;</title>
    3143 
    3144       <para>
    3145         &product-name; supports the import of cloud instance from an &oci; service.
    3146       </para>
    3147 
    3148       <para>
    3149         Before you can import an instance from &oci;, ensure that you perform the
    3150         following configuration steps:
    3151       </para>
    3152 
    3153       <itemizedlist>
    3154 
    3155         <listitem>
    3156           <para>
    3157             Generate an API signing key pair that is used for API
    3158             requests to &oci;.
    3159           </para>
    3160 
    3161           <itemizedlist>
    3162 
    3163             <listitem>
    3164               <para>
    3165                 The key pair is usually installed in the
    3166                 <computeroutput>.oci</computeroutput> folder in your
    3167                 home directory. For example,
    3168                 <computeroutput>~/.oci</computeroutput> on a Linux
    3169                 system.
    3170               </para>
    3171             </listitem>
    3172 
    3173             <listitem>
    3174               <para>
    3175                 Upload the public key of the key pair to the cloud
    3176                 service.
    3177               </para>
    3178             </listitem>
    3179 
    3180           </itemizedlist>
    3181 
    3182           <para>
    3183             For step-by-step instructions for creating and uploading an
    3184             API signing key for &oci;, see:
    3185           </para>
    3186 
    3187           <para>
    3188             <ulink url="https://docs.cloud.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#How">https://docs.cloud.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#How</ulink>
    3189           </para>
    3190         </listitem>
    3191 
    3192         <listitem>
    3193           <para>
    3194             Create a profile for your cloud account.
    3195           </para>
    3196 
    3197           <para>
    3198             The cloud profile contains resource identifiers for your
    3199             cloud account, such as your user OCID, and the fingerprint
    3200             for your public key. You can create a cloud profile in the
    3201             following ways:
    3202           </para>
    3203 
    3204           <itemizedlist>
    3205 
    3206             <listitem>
    3207               <para>
    3208                 Automatically by using the <emphasis role="bold">Cloud
    3209                 Profile Manager</emphasis>. See
    3210                 <xref linkend="ovf-cloud-profile-manager"/>.
    3211               </para>
    3212             </listitem>
    3213 
    3214             <listitem>
    3215               <para>
    3216                 Manually by creating an
    3217                 <computeroutput>oci_config</computeroutput> file in your
    3218                 &product-name; global configuration directory. For
    3219                 example, this is
    3220                 <computeroutput>$HOME/.config/VirtualBox/oci_config</computeroutput>
    3221                 on a Linux host.
    3222               </para>
    3223             </listitem>
    3224 
    3225             <listitem>
    3226               <para>
    3227                 Manually by creating a
    3228                 <computeroutput>config</computeroutput> file in your
    3229                 &oci; configuration directory. For example, this is
    3230                 <computeroutput>$HOME/.oci/config</computeroutput> on a
    3231                 Linux host.
    3232               </para>
    3233 
    3234               <para>
    3235                 This is the same file that is used by the &oci; command
    3236                 line interface.
    3237               </para>
    3238 
    3239               <para>
    3240                 &product-name; automatically uses the
    3241                 <computeroutput>config</computeroutput> file if no cloud
    3242                 profile file is present in your global configuration
    3243                 directory. Alternatively, you can import this file
    3244                 manually into the Cloud Profile Manager.
    3245               </para>
    3246             </listitem>
    3247 
    3248           </itemizedlist>
    3249 
    3250           <para>
    3251             For more information about the cloud profile settings used
    3252             by &oci; see:
    3253           </para>
    3254 
    3255           <para>
    3256             <ulink url="https://docs.cloud.oracle.com/iaas/Content/API/Concepts/sdkconfig.htm">https://docs.cloud.oracle.com/iaas/Content/API/Concepts/sdkconfig.htm</ulink>
    3257           </para>
    3258         </listitem>
    3259 
    3260       </itemizedlist>
     3286      <title>Importing an Instance from &oci;</title>
     3287
     3288      <para>
     3289        &product-name; supports the import of cloud instances from an
     3290        &oci; service.
     3291      </para>
     3292
     3293      <para>
     3294        Before you can import an instance from &oci; ensure that you
     3295        have done the required preconfiguration tasks, as described in
     3296        <xref linkend="cloud-integration-steps"/>.
     3297      </para>
    32613298
    32623299      <para>
     
    32703307            Select <emphasis role="bold">File</emphasis>,
    32713308            <emphasis role="bold">Import Appliance</emphasis> to open
    3272             the <emphasis role="bold">Import Virtual Appliance</emphasis> wizard.
     3309            the <emphasis role="bold">Import Virtual
     3310            Appliance</emphasis> wizard.
     3311          </para>
     3312
     3313          <para>
     3314            In the <emphasis role="bold">Source</emphasis> drop-down
     3315            list, select <emphasis role="bold">&oci;</emphasis>.
    32733316          </para>
    32743317
     
    32893332
    32903333          <para>
    3291             Choose the interesting cloud instance from the list <emphasis role="bold">Machines</emphasis>.
    3292           </para>
    3293 
    3294           <para>
    3295             Click <emphasis role="bold">Next</emphasis>
    3296             to make an API request to the &oci; service and open the <emphasis role="bold">Appliance Settings</emphasis> screen.
    3297           </para>
    3298         </listitem>
    3299 
    3300         <listitem>
    3301           <para>
    3302             Optionally edit settings used for new local virtual machine.
    3303           </para>
    3304 
    3305           <para>
    3306             For example, you can edit the VM name, CPUs, RAM memory, OS type, OS version.
    3307           </para>
    3308 
    3309           <para>
    3310             Click <emphasis role="bold">Import</emphasis> to import the instance from the cloud service.
     3334            Choose the required cloud instance from the list in the
     3335            <emphasis role="bold">Machines</emphasis> field.
     3336          </para>
     3337
     3338          <para>
     3339            Click <emphasis role="bold">Next</emphasis> to make an API
     3340            request to the &oci; service and open the
     3341            <emphasis role="bold">Appliance Settings</emphasis> screen.
     3342          </para>
     3343        </listitem>
     3344
     3345        <listitem>
     3346          <para>
     3347            Optionally edit settings for the new local virtual machine.
     3348          </para>
     3349
     3350          <para>
     3351            For example, you can edit the VM name and description.
     3352          </para>
     3353
     3354          <figure id="fig-import-instance-oci">
     3355            <title>Import Cloud Instance Screen, Showing Profile Settings and VM Settings</title>
     3356           <mediaobject>
     3357              <imageobject>
     3358                <imagedata align="center" fileref="images/import-instance.png"
     3359                  width="12cm" />
     3360              </imageobject>
     3361           </mediaobject>
     3362          </figure>
     3363
     3364          <para>
     3365            Click <emphasis role="bold">Import</emphasis> to import the
     3366            instance from the cloud service.
    33113367          </para>
    33123368        </listitem>
     
    33193375
    33203376      </orderedlist>
    3321 
    3322       <para>
    3323         General OCI import logic:
    3324       </para>
    3325       <orderedlist>
    3326         <listitem>
    3327           <para>
    3328             A custom image created from the boot volume of the instance.
    3329           </para>
    3330         </listitem>
    3331         <listitem>
    3332           <para>
    3333             The custom image exported into OCI object and stored in the OCI Object Storage in the bucket pointed by user.
    3334           </para>
    3335         </listitem>
    3336         <listitem>
    3337           <para>
    3338             The OCI object is downloaded to the local host. OCI object is a TAR archive which contains a boot volume of instance
    3339             in QCOW2 format and JSON file with some meta-data related to the instance.
    3340           </para>
    3341         </listitem>
    3342         <listitem>
    3343           <para>
    3344             The boot volume of instance is extracted from the archive and new VMDK image is created by conversion the boot volume
    3345             into the VMDK format. The VMDK image is registered in the VirtualBox.
    3346           </para>
    3347         </listitem>
    3348         <listitem>
    3349           <para>
    3350             New VM is created with the VMDK image created on the previous step.
    3351           </para>
    3352         </listitem>
    3353         <listitem>
    3354           <para>
    3355             The downloaded OCI object (TAR archive) is deleted after successful import.
    3356           </para>
    3357         </listitem>
    3358       </orderedlist>
    3359       <para>
    3360         By default, the VM isn't launched after import from &oci;.
    3361       </para>
    33623377
    33633378      <para>
     
    33663381        <xref linkend="vboxmanage-import-cloud"/>.
    33673382      </para>
     3383
     3384      <simplesect id="import-instance-sequence">
     3385
     3386        <title>Importing an Instance: Overview of Events</title>
     3387
     3388        <para>
     3389          The following describes the sequence of events when you import
     3390          an instance from &oci;.
     3391        </para>
     3392
     3393        <itemizedlist>
     3394
     3395          <listitem>
     3396            <para>
     3397              A custom image is created from the boot volume of the
     3398              instance.
     3399            </para>
     3400          </listitem>
     3401
     3402          <listitem>
     3403            <para>
     3404              The custom image is exported to an &oci; object and is
     3405              stored using Object Storage in the bucket specified by the
     3406              user.
     3407            </para>
     3408          </listitem>
     3409
     3410          <listitem>
     3411            <para>
     3412              The &oci; object is downloaded to the local host. The
     3413              object is a TAR archive which contains a boot volume of
     3414              the instance in QCOW2 format and a JSON file containing
     3415              metadata related to the instance.
     3416            </para>
     3417          </listitem>
     3418
     3419          <listitem>
     3420            <para>
     3421              The boot volume of the instance is extracted from the
     3422              archive and a new VMDK image is created by converting the
     3423              boot volume into the VMDK format. The VMDK image is
     3424              registered with &product-name;.
     3425            </para>
     3426          </listitem>
     3427
     3428          <listitem>
     3429            <para>
     3430              A new VM is created using the VMDK image for the cloud
     3431              instance.
     3432            </para>
     3433
     3434            <para>
     3435              By default, the new VM is not started after import from
     3436              &oci;.
     3437            </para>
     3438          </listitem>
     3439
     3440          <listitem>
     3441            <para>
     3442              The downloaded TAR archive is deleted after a successful
     3443              import.
     3444            </para>
     3445          </listitem>
     3446
     3447        </itemizedlist>
     3448
     3449      </simplesect>
    33683450
    33693451    </sect2>
     
    33973479
    33983480      <para>
    3399         Use the Cloud Profile Manager to create a new cloud profile
    3400         automatically. Or, create a cloud profile by importing settings
    3401         from your &oci; configuration file into the Cloud Profile
    3402         Manager.
    3403       </para>
    3404 
    3405       <para>
    3406         Perform the following steps to create a new cloud profile:
     3481        You can use the Cloud Profile Manager to create a new cloud
     3482        profile automatically or to create a cloud profile by importing
     3483        settings from your &oci; configuration file.
     3484      </para>
     3485
     3486      <para>
     3487        Perform the following steps to create a new cloud profile
     3488        automatically:
    34073489      </para>
    34083490
     
    34843566          <para>
    34853567            The cloud profile settings are saved in the
    3486             <computeroutput>oci_config</computeroutput> file in your
    3487             &product-name; global settings directory.
     3568            <filename>oci_config</filename> file in your &product-name;
     3569            global settings directory.
    34883570          </para>
    34893571        </listitem>
     
    35003582        <listitem>
    35013583          <para>
    3502             Ensure that a <computeroutput>config</computeroutput> file
    3503             is present in your &oci; configuration directory. For
    3504             example, this is
    3505             <computeroutput>$HOME/.oci/config</computeroutput> on a
    3506             Linux host.
     3584            Ensure that a <filename>config</filename> file is present in
     3585            your &oci; configuration directory. For example, this is
     3586            <filename>$HOME/.oci/config</filename> on a Linux host.
    35073587          </para>
    35083588        </listitem>
     
    35303610          <para>
    35313611            Your cloud profile settings are saved to the
    3532             <computeroutput>oci_config</computeroutput> file in your
    3533             &product-name; global settings directory.
     3612            <filename>oci_config</filename> file in your &product-name;
     3613            global settings directory.
    35343614          </para>
    35353615        </listitem>
     
    35543634
    35553635      </orderedlist>
     3636
     3637    </sect2>
     3638
     3639    <sect2 id="cloud-new-vm">
     3640
     3641      <title>Creating New Cloud Instances from a Custom Image</title>
     3642
     3643      <para>
     3644        You can use &product-name; to create new instances from a custom
     3645        image on your cloud service.
     3646      </para>
     3647
     3648      <para>
     3649        <xref linkend="cloud-export-oci"/> describes how to create a
     3650        custom image when you are exporting a VM to &oci;. Using a
     3651        custom image means that you can quickly create cloud instances
     3652        without having to upload your image to the cloud service every
     3653        time.
     3654      </para>
     3655
     3656      <para>
     3657        Before you can create a new cloud instance in &oci; ensure that
     3658        you have done the required preconfiguration tasks, as described
     3659        in <xref linkend="cloud-integration-steps"/>.
     3660      </para>
     3661
     3662      <para>
     3663        Perform the following steps to create a new cloud instance on
     3664        &oci;:
     3665      </para>
     3666
     3667      <orderedlist>
     3668
     3669        <listitem>
     3670          <para>
     3671            Select <emphasis role="bold">File</emphasis>,
     3672            <emphasis role="bold">New Cloud VM</emphasis> to open the
     3673            <emphasis role="bold">Create Cloud Virtual
     3674            Machine</emphasis> wizard.
     3675          </para>
     3676        </listitem>
     3677
     3678        <listitem>
     3679          <para>
     3680            From the <emphasis role="bold">Destination</emphasis>
     3681            drop-down list, select
     3682            <emphasis role="bold">&oci;</emphasis>.
     3683          </para>
     3684
     3685          <para>
     3686            In the <emphasis role="bold">Account</emphasis> drop-down
     3687            list, select your &oci; account.
     3688          </para>
     3689
     3690          <para>
     3691            You can set up &oci; accounts by using the Cloud Profile
     3692            Manager.
     3693          </para>
     3694
     3695          <para>
     3696            The list after the <emphasis role="bold">Account</emphasis>
     3697            field shows the profile settings for your cloud account.
     3698          </para>
     3699
     3700          <para>
     3701            In the <emphasis role="bold">Images</emphasis> list, select
     3702            from the custom images available on &oci;.
     3703          </para>
     3704
     3705          <figure id="fig-newcloudvm">
     3706            <title>New Cloud VM Wizard, Showing List of Custom Images</title>
     3707           <mediaobject>
     3708              <imageobject>
     3709                <imagedata align="center" fileref="images/newcloudvm.png"
     3710                  width="12cm" />
     3711              </imageobject>
     3712            </mediaobject>
     3713          </figure>
     3714
     3715          <para>
     3716            Click <emphasis role="bold">Next</emphasis> to make an API
     3717            request to the &oci; service and open the
     3718            <emphasis role="bold">Cloud Virtual Machine
     3719            Settings</emphasis> screen.
     3720          </para>
     3721        </listitem>
     3722
     3723        <listitem>
     3724          <para>
     3725            Optionally edit settings used for the instance on &oci;.
     3726          </para>
     3727
     3728          <para>
     3729            For example, you can edit the Disk Size and Shape used for
     3730            the VM instance and the networking configuration.
     3731          </para>
     3732
     3733          <para>
     3734            Click <emphasis role="bold">Create</emphasis> to create the
     3735            new cloud instance.
     3736          </para>
     3737        </listitem>
     3738
     3739        <listitem>
     3740          <para>
     3741            Monitor the instance creation process by using the &oci;
     3742            Console.
     3743          </para>
     3744        </listitem>
     3745
     3746      </orderedlist>
     3747
     3748      <para>
     3749        You can also use the <command>VBoxManage cloud
     3750        instance</command> command to create and manage instances on a
     3751        cloud service. See <xref linkend="vboxmanage-cloudinstance"/>.
     3752      </para>
    35563753
    35573754    </sect2>
     
    35823779        <para>
    35833780          <emphasis role="bold">General.</emphasis> Enables the user to
    3584           specify the default folder/directory for VM files, and the
     3781          specify the default folder or directory for VM files, and the
    35853782          VRDP Authentication Library.
    35863783        </para>
     
    35903787        <para>
    35913788          <emphasis role="bold">Input.</emphasis> Enables the user to
    3592           specify the Host key. It identifies the key that toggles
    3593           whether the cursor is in the focus of the VM or the Host OS
    3594           windows, see <xref linkend="keyb_mouse_normal"/>, and which is
    3595           also used to trigger certain VM actions, see
     3789          specify the Host key. This is the key that toggles whether the
     3790          cursor is in the focus of the VM or the Host OS windows, see
     3791          <xref linkend="keyb_mouse_normal"/>. The Host key is also used
     3792          to trigger certain VM actions, see
    35963793          <xref linkend="specialcharacters"/>.
    35973794        </para>
     
    37153912  </sect1>
    37163913
     3914  <sect1 id="soft-keyb">
     3915
     3916    <title>Soft Keyboard</title>
     3917
     3918    <para>
     3919      &product-name; provides a <emphasis>soft keyboard</emphasis> that
     3920      enables you to input keyboard characters on the guest. A soft
     3921      keyboard is an on-screen keyboard that can be used as an
     3922      alternative to a physical keyboard. See
     3923      <xref linkend="soft-keyb-using"/> for details of how to use the
     3924      soft keyboard.
     3925    </para>
     3926
     3927    <caution>
     3928      <para>
     3929        For best results, ensure that the keyboard layout configured on
     3930        the guest OS matches the keyboard layout used by the soft
     3931        keyboard. &product-name; does not do this automatically.
     3932      </para>
     3933    </caution>
     3934
     3935    <figure id="fig-soft-keyb">
     3936      <title>Soft Keyboard in a Guest Virtual Machine</title>
     3937    <mediaobject>
     3938      <imageobject>
     3939        <imagedata align="center" fileref="images/softkeybd.png"
     3940                   width="14cm" />
     3941      </imageobject>
     3942    </mediaobject>
     3943    </figure>
     3944
     3945    <para>
     3946      The soft keyboard can be used in the following scenarios:
     3947    </para>
     3948
     3949    <itemizedlist>
     3950
     3951      <listitem>
     3952        <para>
     3953          When the physical keyboard on the host is not the same as the
     3954          keyboard layout configured on the guest. For example, if the
     3955          guest is configured to use an international keyboard, but the
     3956          host keyboard is US English.
     3957        </para>
     3958      </listitem>
     3959
     3960      <listitem>
     3961        <para>
     3962          To send special key combinations to the guest. Note that some
     3963          common key combinations are also available in the
     3964          <emphasis role="bold">Input</emphasis>,
     3965          <emphasis role="bold">Keyboard</emphasis> menu of the guest VM
     3966          window. See <xref linkend="specialcharacters"/>.
     3967        </para>
     3968      </listitem>
     3969
     3970      <listitem>
     3971        <para>
     3972          For guests in kiosk mode, where a physical keyboard is not
     3973          present.
     3974        </para>
     3975      </listitem>
     3976
     3977      <listitem>
     3978        <para>
     3979          When using nested virtualization, the soft keyboard provides a
     3980          method of sending key presses to a guest.
     3981        </para>
     3982      </listitem>
     3983
     3984    </itemizedlist>
     3985
     3986    <para>
     3987      By default, the soft keyboard includes some common international
     3988      keyboard layouts. You can copy and modify these to meet your own
     3989      requirements. See <xref linkend="soft-keyb-custom"/>.
     3990    </para>
     3991
     3992    <sect2 id="soft-keyb-using">
     3993
     3994      <title>Using the Soft Keyboard</title>
     3995
     3996      <orderedlist>
     3997
     3998        <listitem>
     3999          <para>
     4000            Display the soft keyboard.
     4001          </para>
     4002
     4003          <para>
     4004            In the guest VM window, select
     4005            <emphasis role="bold">Input</emphasis>,
     4006            <emphasis role="bold">Keyboard</emphasis>,
     4007            <emphasis role="bold">Soft Keyboard</emphasis>.
     4008          </para>
     4009        </listitem>
     4010
     4011        <listitem>
     4012          <para>
     4013            Select the required keyboard layout.
     4014          </para>
     4015
     4016          <para>
     4017            The name of the current keyboard layout is displayed in the
     4018            task bar of the soft keyboard window. This is the previous
     4019            keyboard layout that was used.
     4020          </para>
     4021
     4022          <para>
     4023            Click the <emphasis role="bold">Layout List</emphasis> icon
     4024            in the task bar of the soft keyboard window. The
     4025            <emphasis role="bold">Layout List</emphasis> window is
     4026            displayed.
     4027          </para>
     4028
     4029          <para>
     4030            Select the required keyboard layout from the entries in the
     4031            <emphasis role="bold">Layout List</emphasis> window.
     4032          </para>
     4033
     4034          <para>
     4035            The keyboard display graphic is updated to show the
     4036            available input keys.
     4037          </para>
     4038        </listitem>
     4039
     4040        <listitem>
     4041          <para>
     4042            Use the soft keyboard to enter keyboard characters on the
     4043            guest.
     4044          </para>
     4045
     4046          <itemizedlist>
     4047
     4048            <listitem>
     4049              <para>
     4050                Modifier keys such as Shift, Ctrl, and Alt are available
     4051                on the soft keyboard. Click once to select the modifier
     4052                key, click twice to lock the modifier key.
     4053              </para>
     4054
     4055              <para>
     4056                The <emphasis role="bold">Reset the Keyboard and Release
     4057                All Keys</emphasis> icon can be used to release all
     4058                pressed modifier keys, both on the host and the guest.
     4059              </para>
     4060            </listitem>
     4061
     4062            <listitem>
     4063              <para>
     4064                To change the look of the soft keyboard, click the
     4065                <emphasis role="bold">Settings</emphasis> icon in the
     4066                task bar. You can change colors used in the keyboard
     4067                graphic, and can hide or show sections of the keyboard,
     4068                such as the NumPad or multimedia keys.
     4069              </para>
     4070            </listitem>
     4071
     4072          </itemizedlist>
     4073        </listitem>
     4074
     4075      </orderedlist>
     4076
     4077    </sect2>
     4078
     4079    <sect2 id="soft-keyb-custom">
     4080
     4081      <title>Creating a Custom Keyboard Layout</title>
     4082
     4083      <para>
     4084        You can use one of the supplied default keyboard layouts as the
     4085        starting point to create a custom keyboard layout.
     4086      </para>
     4087
     4088      <note>
     4089        <para>
     4090          To permananently save a custom keyboard layout, you must save
     4091          it to file. Otherwise, any changes you make are discarded when
     4092          you close down the <emphasis role="bold">Soft
     4093          Keyboard</emphasis> window.
     4094        </para>
     4095
     4096        <para>
     4097          Custom keyboard layouts that you save are stored as an XML
     4098          file on the host, in the <filename>keyboardLayouts</filename>
     4099          folder in the global configuration data directory. For
     4100          example, in
     4101          <filename>$HOME/.config/VirtualBox/keyboardLayouts</filename>
     4102          on a Linux host.
     4103        </para>
     4104      </note>
     4105
     4106      <orderedlist>
     4107
     4108        <listitem>
     4109          <para>
     4110            Display the <emphasis role="bold">Layout List</emphasis>.
     4111          </para>
     4112
     4113          <para>
     4114            Click the <emphasis role="bold">Layout List</emphasis> icon
     4115            in the task bar of the soft keyboard window.
     4116          </para>
     4117        </listitem>
     4118
     4119        <listitem>
     4120          <para>
     4121            Make a copy of an existing keyboard layout.
     4122          </para>
     4123
     4124          <para>
     4125            Highlight the required layout and click the
     4126            <emphasis role="bold">Copy the Selected Layout</emphasis>
     4127            icon.
     4128          </para>
     4129
     4130          <para>
     4131            A new layout entry with a name suffix of
     4132            <literal>-Copy</literal> is created.
     4133          </para>
     4134        </listitem>
     4135
     4136        <listitem>
     4137          <para>
     4138            Edit the new keyboard layout.
     4139          </para>
     4140
     4141          <para>
     4142            Highlight the new layout in the <emphasis role="bold">Layout
     4143            List</emphasis> and click the <emphasis role="bold">Edit the
     4144            Selected Layout</emphasis> icon.
     4145          </para>
     4146
     4147          <para>
     4148            Enter a new name for the layout.
     4149          </para>
     4150
     4151          <para>
     4152            Edit keys in the new layout. Click on the key that you want
     4153            to edit and enter new key captions in the
     4154            <emphasis role="bold">Captions</emphasis> fields.
     4155          </para>
     4156
     4157          <para>
     4158            The keyboard graphic is updated with the new captions.
     4159          </para>
     4160        </listitem>
     4161
     4162        <listitem>
     4163          <para>
     4164            (Optional) Save the layout to file. This means that your
     4165            custom keyboard layout will be available for future use.
     4166          </para>
     4167
     4168          <para>
     4169            Highlight the new layout in the <emphasis role="bold">Layout
     4170            List</emphasis> and click the <emphasis role="bold">Save the
     4171            Selected Layout into File</emphasis> icon.
     4172          </para>
     4173
     4174          <para>
     4175            Any custom layouts that you create can later be removed from
     4176            the Layout List, by highlighting and clicking the
     4177            <emphasis role="bold">Delete the Selected Layout</emphasis>
     4178            icon.
     4179          </para>
     4180        </listitem>
     4181
     4182      </orderedlist>
     4183
     4184    </sect2>
     4185
     4186  </sect1>
     4187
    37174188</chapter>
  • trunk/doc/manual/en_US/user_KnownIssues.xml

    r76078 r82350  
    3737      </listitem>
    3838
    39       <listitem>
    40         <para>
    41           PCI pass-through (Linux hosts only)
    42         </para>
    43       </listitem>
     39<!--   <listitem>
     40        <para>
     41          PCI passthrough (Linux hosts only)
     42        </para>
     43      </listitem>-->
    4444
    4545      <listitem>
     
    6363      <listitem>
    6464        <para>
    65           Host CD/DVD drive pass-through
     65          Host CD/DVD drive passthrough
    6666        </para>
    6767      </listitem>
     
    108108              32-bit guests on AMD CPUs. This affects mainly Windows and
    109109              Oracle Solaris guests, but possibly also some Linux kernel
    110               revisions. Partially solved in 3.0.6 for 32-bit Windows
    111               NT, 2000, XP, and 2003 guests. Requires Guest Additions
    112               3.0.6 or later to be installed.
     110              revisions. Partially solved for 32-bit Windows NT, 2000,
     111              XP, and 2003 guests. Requires the Guest Additions to be
     112              installed.
    113113            </para>
    114114          </listitem>
     
    121121              affects mainly Windows and Oracle Solaris guests, but
    122122              possibly also some Linux kernel revisions. Partially
    123               solved in 3.0.12 for 32-bit Windows NT, 2000, XP, and 2003
    124               guests. Requires Guest Additions 3.0.12 or later to be
    125               installed.
     123              solved for 32-bit Windows NT, 2000, XP, and 2003 guests.
     124              Requires the Guest Additions to be installed.
    126125            </para>
    127126          </listitem>
     
    134133          <emphasis role="bold">NX (no execute, data execution
    135134          prevention)</emphasis> only works for guests running on 64-bit
    136           hosts or guests running on 32-bit hosts with PAE enabled and
    137           requires that hardware virtualization be enabled.
    138         </para>
    139       </listitem>
    140 
    141       <listitem>
    142         <para>
    143           For <emphasis role="bold">basic Direct3D support in Windows
    144           guests</emphasis> to work, the Guest Additions must be
    145           installed in Windows safe mode. Press F8 when the Windows
    146           guest is booting and select <emphasis role="bold">Safe
    147           Mode</emphasis>, then install the Guest Additions. Otherwise
    148           the Windows file protection mechanism will interfere with the
    149           replacement DLLs installed by &product-name; and keep
    150           restoring the original Windows system DLLs.
    151         </para>
    152 
    153         <note>
    154           <para>
    155             This does <emphasis>not</emphasis> apply to the WDDM
    156             Direct3D video driver available for Vista and Windows 7
    157             guests shipped with &product-name; 4.1.
    158           </para>
    159         </note>
     135          hosts and requires that hardware virtualization be enabled.
     136        </para>
    160137      </listitem>
    161138
     
    173150          guest's group policy must be changed. To do so, open the group
    174151          policy editor on the command line by typing
    175           <command>gpedit.msc</command>, open the key
    176           <computeroutput>Computer Configuration\Windows
    177           Settings\Security Settings\Local Policies\Security
    178           Options</computeroutput> and change the value of
    179           <computeroutput>Accounts: Limit local account use of blank
    180           passwords to console logon only</computeroutput> to Disabled.
     152          <command>gpedit.msc</command>, open the key <literal>Computer
     153          Configuration\Windows Settings\Security Settings\Local
     154          Policies\Security Options</literal> and change the value of
     155          <literal>Accounts: Limit local account use of blank passwords
     156          to console logon only</literal> to Disabled.
    181157        </para>
    182158      </listitem>
     
    186162          <emphasis role="bold">Compacting virtual disk images is
    187163          limited to VDI files.</emphasis> The <command>VBoxManage
    188           modifyhd --compact</command> command is currently only
     164          modifymedium --compact</command> command is currently only
    189165          implemented for VDI files. At the moment the only way to
    190166          optimize the size of a virtual disk images in other formats,
     
    236212        <para>
    237213          Neither <emphasis role="bold">scale mode</emphasis> nor
    238           <emphasis
    239           role="bold">seamless mode</emphasis> work
    240           correctly with guests using OpenGL 3D features, such as with
    241           compiz-enabled window managers.
     214          <emphasis role="bold">seamless mode</emphasis> work correctly
     215          with guests using OpenGL 3D features, such as with
     216          Compiz-enabled window managers.
    242217        </para>
    243218      </listitem>
     
    246221        <para>
    247222          The RDP server in the &product-name; extension pack supports
    248           only audio streams in format 22.05kHz stereo 16 bit. If the
     223          only audio streams in format 22.05kHz stereo 16-bit. If the
    249224          RDP client requests any other audio format there will be no
    250225          audio.
     
    331306              Depending on your system and version of Mac OS X, you
    332307              might experience guest hangs after some time. This can be
    333               fixed by turning off energy saving. Set timeout to "Never"
    334               in the system preferences.
     308              fixed by turning off energy saving. Set the timeout to
     309              "Never" in the system preferences.
    335310            </para>
    336311          </listitem>
     
    346321            </para>
    347322
    348 <screen>VBoxManage setextradata "VM name" "VBoxInternal2/EfiBootArgs" "  "</screen>
     323<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxInternal2/EfiBootArgs" "  "</screen>
    349324
    350325            <para>
     
    353328            </para>
    354329
    355 <screen>VBoxManage setextradata "VM name" "VBoxInternal2/EfiBootArgs" ""</screen>
     330<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxInternal2/EfiBootArgs" ""</screen>
    356331          </listitem>
    357332
     
    359334            <para>
    360335              It is currently not possible to start a Mac OS X guest in
    361               safe mode by specifying "-x" option in
    362               "VBoxInternal2/EfiBootArgs" extradata.
     336              safe mode by specifying the <option>-x</option> option in
     337              <literal>VBoxInternal2/EfiBootArgs</literal> extradata.
    363338            </para>
    364339          </listitem>
     
    373348
    374349        <itemizedlist>
    375 
    376           <listitem>
    377             <para>
    378               There is no support for USB devices connected to Oracle
    379               Solaris 10 hosts.
    380             </para>
    381           </listitem>
    382350
    383351          <listitem>
     
    416384              Crossbow-based bridged networking on Oracle Solaris 11
    417385              hosts does not work directly with aggregate links.
    418               However, you can use
    419               <computeroutput>dladm</computeroutput> to manually create
    420               a VNIC over the aggregate link and use that with a VM.
    421               This limitation does not exist in Oracle Solaris 11u1
    422               build 17 and newer.
     386              However, you can use <command>dladm</command> to manually
     387              create a VNIC over the aggregate link and use that with a
     388              VM. This limitation does not exist in Oracle Solaris 11u1
     389              build 17 and later.
    423390            </para>
    424391          </listitem>
     
    429396      <listitem>
    430397        <para>
    431           <emphasis role="bold">Guest Additions of version 4.1, 4.1.2
    432           and 4.1.4 for Windows.</emphasis> The &product-name; WDDM
    433           Video driver may be installed and remain in the guest system
    434           when Guest additions uninstallation is performed. This is
    435           caused by a bug in Guest Additions uninstaller.
    436         </para>
    437 
    438         <note>
    439           <para>
    440             This does <emphasis>not</emphasis> apply to a Guest
    441             Additions update. Installing one version of Guest Additions
    442             on top of another works correctly.
    443           </para>
    444         </note>
    445 
    446         <para>
    447           To solve this problem, uninstall the &product-name; WDDM Video
    448           driver manually. Open Device Manager, and check whether the
    449           Display Adapter is named "&product-name; Graphics Adapter ..".
    450           If not, there is nothing to be done. If it is, right-click the
    451           &product-name; Graphics Adapter in Device Manager, select
    452           <emphasis role="bold">Uninstall</emphasis>, check
    453           <emphasis role="bold">Delete the Driver Software for this
    454           Device</emphasis> and click
    455           <emphasis role="bold">OK</emphasis>. Once uninstallation is
    456           done, start Device Manager, go to the
    457           <emphasis role="bold">Action</emphasis> menu and select
    458           <emphasis role="bold">Scan for Hardware Change</emphasis>s to
    459           ensure that the correct Windows default driver be picked up
    460           for the Graphics adapter.
    461         </para>
    462       </listitem>
    463 
    464       <listitem>
    465         <para>
    466           Neither <emphasis>virtio</emphasis> nor <emphasis>Intel
    467           PRO/1000 </emphasis> drivers for <emphasis role="bold">Windows
    468           XP guests</emphasis> support segmentation offloading.
    469           Therefore Windows XP guests have slower transmission rates
    470           comparing to other guest types. Refer to MS Knowledge base
    471           article 842264 for additional information.
     398          Neither virtio nor Intel PRO/1000 drivers for
     399          <emphasis role="bold">Windows XP guests</emphasis> support
     400          segmentation offloading. Therefore Windows XP guests have
     401          slower transmission rates comparing to other guest types.
     402          Refer to MS Knowledge base article 842264 for additional
     403          information.
    472404        </para>
    473405      </listitem>
  • trunk/doc/manual/en_US/user_Networking.xml

    r76786 r82350  
    150150        <para>
    151151          <ulink
    152             url="http://www.linux-kvm.org/page/WindowsGuestDrivers">http://www.linux-kvm.org/page/WindowsGuestDrivers</ulink>.
     152            url="http://www.linux-kvm.org/page/WindowsGuestDrivers" />.
    153153        </para>
    154154      </listitem>
     
    189189          present, but that there is no connection. This is as if no
    190190          Ethernet cable was plugged into the card. Using this mode, it
    191           is possible to "pull" the virtual Ethernet cable and disrupt
    192           the connection, which can be useful to inform a guest
    193           operating system that no network connection is available and
    194           enforce a reconfiguration.
     191          is possible to <emphasis>pull</emphasis> the virtual Ethernet
     192          cable and disrupt the connection, which can be useful to
     193          inform a guest operating system that no network connection is
     194          available and enforce a reconfiguration.
    195195        </para>
    196196      </listitem>
     
    534534        ports on the host which are not already in use by a service. For
    535535        example, to set up incoming NAT connections to an
    536         <computeroutput>ssh</computeroutput> server in the guest, use
    537         the following command:
     536        <command>ssh</command> server in the guest, use the following
     537        command:
    538538      </para>
    539539
     
    543543        In the above example, all TCP traffic arriving on port 2222 on
    544544        any host interface will be forwarded to port 22 in the guest.
    545         The protocol name <computeroutput>tcp</computeroutput> is a
    546         mandatory attribute defining which protocol should be used for
    547         forwarding, <computeroutput>udp</computeroutput> could also be
    548         used. The name <computeroutput>guestssh</computeroutput> is
    549         purely descriptive and will be auto-generated if omitted. The
    550         number after <option>--natpf</option> denotes the network card,
    551         as with other <command>VBoxManage</command> commands.
     545        The protocol name <literal>tcp</literal> is a mandatory
     546        attribute defining which protocol should be used for forwarding,
     547        <literal>udp</literal> could also be used. The name
     548        <literal>guestssh</literal> is purely descriptive and will be
     549        auto-generated if omitted. The number after
     550        <option>--natpf</option> denotes the network card, as with other
     551        <command>VBoxManage</command> commands.
    552552      </para>
    553553
     
    601601        PXE booting is now supported in NAT mode. The NAT DHCP server
    602602        provides a boot file name of the form
    603         <computeroutput>vmname.pxe</computeroutput> if the directory
    604         <computeroutput>TFTP</computeroutput> exists in the directory
    605         where the user's <computeroutput>VirtualBox.xml</computeroutput>
    606         file is kept. It is the responsibility of the user to provide
    607         <computeroutput>vmname.pxe</computeroutput>.
     603        <filename><replaceable>vmname</replaceable>.pxe</filename> if
     604        the directory <literal>TFTP</literal> exists in the directory
     605        where the user's <filename>VirtualBox.xml</filename> file is
     606        kept. It is the responsibility of the user to provide
     607        <filename><replaceable>vmname</replaceable>.pxe</filename>.
    608608      </para>
    609609
     
    625625            <emphasis role="bold">ICMP protocol limitations.</emphasis>
    626626            Some frequently used network debugging tools, such as
    627             <computeroutput>ping</computeroutput> or tracerouting, rely
    628             on the ICMP protocol for sending and receiving messages.
    629             While ICMP support has been improved with &product-name;
    630             2.1, meaning <computeroutput>ping</computeroutput> should
    631             now work, some other tools may not work reliably.
     627            <command>ping</command> or <command>traceroute</command>,
     628            rely on the ICMP protocol for sending and receiving
     629            messages. &product-name; ICMP support has some limitations,
     630            meaning <command>ping</command> should work but some other
     631            tools may not work reliably.
    632632          </para>
    633633        </listitem>
     
    643643            WINS always works. As a workaround, you can use the numeric
    644644            IP of the desired server in the
    645             <computeroutput>\\server\share</computeroutput> notation.
     645            <filename>\\<replaceable>server</replaceable>\<replaceable>share</replaceable></filename>
     646            notation.
    646647          </para>
    647648        </listitem>
     
    663664            Solaris, and Mac OS X, it is not possible to bind to ports
    664665            below 1024 from applications that are not run by
    665             <computeroutput>root</computeroutput>. As a result, if you
    666             try to configure such a port forwarding, the VM will refuse
    667             to start.
     666            <literal>root</literal>. As a result, if you try to
     667            configure such a port forwarding, the VM will refuse to
     668            start.
    668669          </para>
    669670        </listitem>
     
    768769    <para>
    769770      Port-forwarding is supported, using the
    770       <computeroutput>--port-forward-4</computeroutput> switch for IPv4
    771       and <computeroutput>--port-forward-6</computeroutput> for IPv6.
    772       For example:
     771      <option>--port-forward-4</option> switch for IPv4 and
     772      <option>--port-forward-6</option> for IPv6. For example:
    773773    </para>
    774774
     
    10021002        <para>
    10031003          If you do not specify a network name, the network card will be
    1004           attached to the network
    1005           <computeroutput>intnet</computeroutput> by default.
     1004          attached to the network <literal>intnet</literal> by default.
    10061005        </para>
    10071006      </listitem>
     
    10321031
    10331032    <para>
    1034       Host-only networking is another networking mode that was added
    1035       with version 2.2 of &product-name;. It can be thought of as a
    1036       hybrid between the bridged and internal networking modes. As with
    1037       bridged networking, the virtual machines can talk to each other
    1038       and the host as if they were connected through a physical Ethernet
    1039       switch. As with internal networking, a physical networking
    1040       interface need not be present, and the virtual machines cannot
    1041       talk to the world outside the host since they are not connected to
    1042       a physical networking interface.
     1033      Host-only networking can be thought of as a hybrid between the
     1034      bridged and internal networking modes. As with bridged networking,
     1035      the virtual machines can talk to each other and the host as if
     1036      they were connected through a physical Ethernet switch. As with
     1037      internal networking, a physical networking interface need not be
     1038      present, and the virtual machines cannot talk to the world outside
     1039      the host since they are not connected to a physical networking
     1040      interface.
    10431041    </para>
    10441042
     
    10851083      <listitem>
    10861084        <para>
    1087           On the command line, enter <computeroutput>VBoxManage modifyvm
    1088           "VM name" --nic&lt;x&gt; hostonly</computeroutput>. See
     1085          On the command line, enter <command>VBoxManage modifyvm
     1086          <replaceable>"vmname</replaceable>
     1087          --nic<replaceable>x</replaceable> hostonly</command>. See
    10891088          <xref
    10901089          linkend="vboxmanage-modifyvm" />.
     
    10961095    <para>
    10971096      Before you can attach a VM to a host-only network you have to
    1098       create at least one host-only interface. You can use the GUI for
    1099       this. Choose <emphasis role="bold">File</emphasis>,
     1097      create at least one host-only interface. You can use the
     1098      VirtualBox Manager for this. Choose
     1099      <emphasis role="bold">File</emphasis>,
    11001100      <emphasis role="bold">Preferences</emphasis>,
    11011101      <emphasis role="bold">Network</emphasis>,
     
    12411241        On UNIX-based hosts, such as Linux, Oracle Solaris, and Mac OS
    12421242        X, it is not possible to bind to ports below 1024 from
    1243         applications that are not run by
    1244         <computeroutput>root</computeroutput>. As a result, if you try
    1245         to configure such a source UDP port, the VM will refuse to
    1246         start.
     1243        applications that are not run by <literal>root</literal>. As a
     1244        result, if you try to configure such a source UDP port, the VM
     1245        will refuse to start.
    12471246      </para>
    12481247    </note>
     
    13531352      documentation accompanying the software. See also
    13541353      <ulink
    1355         url="http://wiki.virtualsquare.org/wiki/index.php/VDE_Basic_Networking">http://wiki.virtualsquare.org/wiki/index.php/VDE_Basic_Networking</ulink>.
     1354        url="http://wiki.virtualsquare.org/wiki/index.php/VDE_Basic_Networking" />.
    13561355    </para>
    13571356
     
    15201519          <listitem>
    15211520            <para>
    1522               <computeroutput>deny</computeroutput>, which hides any
    1523               traffic not intended for the VM's network adaptor. This is
    1524               the default setting.
     1521              <literal>deny</literal>, which hides any traffic not
     1522              intended for the VM's network adaptor. This is the default
     1523              setting.
    15251524            </para>
    15261525          </listitem>
     
    15281527          <listitem>
    15291528            <para>
    1530               <computeroutput>allow-vms</computeroutput>, which hides
    1531               all host traffic from the VM's network adaptor, but allows
    1532               it to see traffic from and to other VMs.
     1529              <literal>allow-vms</literal>, which hides all host traffic
     1530              from the VM's network adaptor, but allows it to see
     1531              traffic from and to other VMs.
    15331532            </para>
    15341533          </listitem>
     
    15361535          <listitem>
    15371536            <para>
    1538               <computeroutput>allow-all</computeroutput>, which removes
    1539               all restrictions. The VM's network adaptor sees all
    1540               traffic.
     1537              <literal>allow-all</literal>, which removes all
     1538              restrictions. The VM's network adaptor sees all traffic.
    15411539            </para>
    15421540          </listitem>
  • trunk/doc/manual/en_US/user_Preface.xml

    r78515 r82350  
    1111
    1212  <para>
    13     The <emphasis>&product-name; User Manual</emphasis> provides an
     13    The <citetitle>&product-name; User Manual</citetitle> provides an
    1414    introduction to using &product-name;. The manual provides
    1515    information on how to install &product-name; and use it to create
     
    3939
    4040    <para>
    41       <ulink url="&otn-doc-tab;" />
     41      <ulink url="&ohc-doc-page;" />
    4242    </para>
    4343
     
    7272      <listitem>
    7373        <para>
    74           <computeroutput>monospace</computeroutput>: Monospace type
    75           indicates commands within a paragraph, URLs, code in examples,
    76           text that appears on the screen, or text that you enter.
     74          <literal>monospace</literal>: Monospace type indicates
     75          commands within a paragraph, URLs, code in examples, text that
     76          appears on the screen, or text that you enter.
    7777        </para>
    7878      </listitem>
     
    8282  </simplesect>
    8383
    84   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../common/oracle-accessibility-en.xml"/>
    85   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../common/oracle-support-en.xml"/>
     84  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
     85    href="../common/oracle-accessibility-en.xml" />
     86
     87  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
     88    href="../common/oracle-support-en.xml" />
    8689
    8790</preface>
  • trunk/doc/manual/en_US/user_PrivacyPolicy.xml

    r77320 r82350  
    1515  <para>
    1616    The Oracle Privacy Policies posted on
    17     <ulink url="https://www.oracle.com/legal/privacy/privacy-policy.html">https://www.oracle.com/legal/privacy/privacy-policy.html</ulink>
     17    <ulink url="https://www.oracle.com/legal/privacy/privacy-policy.html" />
    1818    apply to your personal data collected and used by Oracle. The
    1919    following privacy information describes in more detail which
     
    8484    <emphasis role="bold">§ 6 Updates.</emphasis> Oracle may update the
    8585    privacy policy at any time by posting a new version at
    86     <ulink url="https://www.oracle.com/legal/privacy/privacy-policy.html">https://www.oracle.com/legal/privacy/privacy-policy.html</ulink>
     86    <ulink url="https://www.oracle.com/legal/privacy/privacy-policy.html" />
    8787    and the privacy information will be kept up to date in the
    8888    documentation which comes with the &product-name; application. You
  • trunk/doc/manual/en_US/user_Security.xml

    r81183 r82350  
    9797        The &product-name; base package should be downloaded only from a
    9898        trusted source, for instance the official website
    99         <ulink url="http://www.virtualbox.org">http://www.virtualbox.org</ulink>.
     99        <ulink url="http://www.virtualbox.org" />.
    100100        The integrity of the package should be verified with the
    101101        provided SHA256 checksum which can be found on the official
     
    558558
    559559      <para>
    560         Mitigation options:
     560        The following mitigation options are available.
    561561      </para>
    562562
    563563      <sect3>
    564564
    565         <title>Disable nested paging</title>
     565        <title>Disable Nested Paging</title>
    566566
    567567        <para>
     
    578578          guests may be able to cope with dropping these features after
    579579          installation. Also, for some guests, especially in SMP
    580           configurations, there could be stability issues arrising from
     580          configurations, there could be stability issues arising from
    581581          disabling nested paging. Finally, some workloads may
    582582          experience a performance degradation.
     
    587587      <sect3>
    588588
    589         <title>Flushing the level 1 data cache</title>
     589        <title>Flushing the Level 1 Data Cache</title>
    590590
    591591        <para>
     
    627627        <para>
    628628          A more aggressive flushing option is provided via the
    629           VBoxManage modifyvm option
    630           <computeroutput>--l1d-flush-on-vm-entry</computeroutput>. When
     629          <command>VBoxManage modifyvm</command>
     630          <option>--l1d-flush-on-vm-entry</option> option. When
    631631          enabled the level 1 data cache will be flushed on every VM
    632632          entry. The performance impact is greater than with the default
     
    638638        <para>
    639639          For users not concerned by this security issue, the default
    640           mitigation can be disabled using
    641         </para>
    642 
    643         <para>
    644           <computeroutput>VBoxManage modifyvm name --l1d-flush-on-sched
    645           off</computeroutput>
     640          mitigation can be disabled using the <command>VBoxManage modifyvm
     641          name --l1d-flush-on-sched off</command> command.
    646642        </para>
    647643
     
    656652      <para>
    657653        These security issues affect a range of Intel CPUs starting with
    658         Nehalem.  The CVE-2018-12130 also affects some Atom Silvermont,
    659         Atom Airmont, and Knights family CPUs, however the scope is so limited
    660         that the host OS should deal with it for us and VBox therefore not
    661         be affected (leaks only happens when entering and leaving C states).
    662       </para>
    663 
    664       <para>
    665         Mitigation option:
     654        Nehalem. The CVE-2018-12130 also affects some Atom Silvermont,
     655        Atom Airmont, and Knights family CPUs, however the scope is so
     656        limited that the host OS should deal with it and &product-name;
     657        is therefore not affected. Leaks only happens when entering and
     658        leaving C states.
     659      </para>
     660
     661      <para>
     662        The following mitigation option is available.
    666663      </para>
    667664
    668665      <sect3>
    669666
    670         <title>Buffer overwriting and disabling HT</title>
    671 
    672         <para>
    673           First, up to date CPU microcode is a prerequisite for the buffer
    674           overwriting (clearing) mitigations.  Some host OSes may install
    675           these automatically, though it has traditionally been a task best
    676           performed by the system firmware.  So, please check with your
    677           system / mainboard manufacturer for the latest firmware update.
    678         </para>
    679 
    680         <para>
    681           This mitigation aims at removing potentially sensitive data from
    682           the affected buffers before running guest code.  Since this means
    683           additional work each time the guest is scheduled, there might be
    684           some performance side effects.
    685         </para>
    686 
    687         <para>
    688           We recommend disabling hyper threading on host affected by
    689           CVE-2018-12126 and CVE-2018-12127 because the affected sets of
    690           buffers are normally shared between thread pairs and therefore
    691           cause leaks between the threads. This is traditionally done from
    692           the firmware setup, but some OSes also offers ways disable HT. In
    693           some cases it may be disabled by default, but please verify as the
    694           effectiveness of the mitigation depends on it.
    695         </para>
    696 
    697         <para>
    698           The default action taken by VirtualBox is to clear the affected
    699           buffers when a thread is scheduled to execute guest code, rather
    700           than on each VM entry. This reduces the performance impact, while
    701           making the assumption that the host OS will not handle security
    702           sensitive data from interrupt handlers and similar without taking
    703           precautions.
    704         </para>
    705 
    706         <para>
    707           A more aggressive flushing option is provided via the
    708           VBoxManage modifyvm option
    709           <computeroutput>--mds-clear-on-vm-entry</computeroutput>. When
    710           enabled the affected buffers will be cleared on every VM entry.
    711           The performance impact is greater than with the default option,
    712           though this of course depends on the workload.  Workloads producing
    713           a lot of VM exits (like networking, VGA access, and similiar) will
    714           probably be most impacted.
     667        <title>Buffer Overwriting and Disabling Hyper-Threading</title>
     668
     669        <para>
     670          First, up to date CPU microcode is a prerequisite for the
     671          buffer overwriting (clearing) mitigations. Some host OSes may
     672          install these automatically, though it has traditionally been
     673          a task best performed by the system firmware. Please check
     674          with your system or mainboard manufacturer for the latest
     675          firmware update.
     676        </para>
     677
     678        <para>
     679          This mitigation aims at removing potentially sensitive data
     680          from the affected buffers before running guest code. Since
     681          this means additional work each time the guest is scheduled,
     682          there might be some performance side effects.
     683        </para>
     684
     685        <para>
     686          We recommend disabling hyper-threading (HT) on hosts affected
     687          by CVE-2018-12126 and CVE-2018-12127, because the affected
     688          sets of buffers are normally shared between thread pairs and
     689          therefore cause leaks between the threads. This is
     690          traditionally done from the firmware setup, but some OSes also
     691          offers ways disable HT. In some cases it may be disabled by
     692          default, but please verify as the effectiveness of the
     693          mitigation depends on it.
     694        </para>
     695
     696        <para>
     697          The default action taken by &product-name; is to clear the
     698          affected buffers when a thread is scheduled to execute guest
     699          code, rather than on each VM entry. This reduces the
     700          performance impact, while making the assumption that the host
     701          OS will not handle security sensitive data from interrupt
     702          handlers and similar without taking precautions.
     703        </para>
     704
     705        <para>
     706          The <command>VBoxManage modifyvm</command> command provides a more
     707          aggressive flushing option is provided by means of the
     708          <option>--mds-clear-on-vm-entry</option> option. When
     709          enabled the affected buffers will be cleared on every VM
     710          entry. The performance impact is greater than with the default
     711          option, though this of course depends on the workload.
     712          Workloads producing a lot of VM exits (like networking, VGA
     713          access, and similiar) will probably be most impacted.
    715714        </para>
    716715
    717716        <para>
    718717          For users not concerned by this security issue, the default
    719           mitigation can be disabled using
    720         </para>
    721 
    722         <para>
    723           <computeroutput>VBoxManage modifyvm name --mds-clear-on-sched
    724           off</computeroutput>
     718          mitigation can be disabled using the <command>VBoxManage modifyvm
     719          name --mds-clear-on-sched off</command> command.
    725720        </para>
    726721
  • trunk/doc/manual/en_US/user_Storage.xml

    r82044 r82350  
    5252  <sect1 id="harddiskcontrollers">
    5353
    54     <title>Hard Disk Controllers: IDE, SATA (AHCI), SCSI, SAS, USB MSD, NVMe</title>
    55 
    56     <para>
    57       In a real PC, hard disks and CD/DVD drives are connected to a
    58       device called hard disk controller which drives hard disk
    59       operation and data transfers. &product-name; can emulate the five
    60       most common types of hard disk controllers typically found in
    61       today's PCs: IDE, SATA (AHCI), SCSI, SAS, USB-based, and NVMe mass
     54    <title>Hard Disk Controllers</title>
     55
     56    <para>
     57      In a computing device, hard disks and CD/DVD drives are connected
     58      to a device called hard disk controller which drives hard disk
     59      operation and data transfers. &product-name; can emulate the most
     60      common types of hard disk controllers typically found in computing
     61      devices: IDE, SATA (AHCI), SCSI, SAS, USB-based, and NVMe mass
    6262      storage devices.
    6363    </para>
     
    6868        <para>
    6969          <emphasis role="bold">IDE (ATA)</emphasis> controllers are a
    70           backwards compatible yet very advanced extension of the disk
     70          backwards-compatible yet very advanced extension of the disk
    7171          controller in the IBM PC/AT (1984). Initially, this interface
    7272          worked only with hard disks, but was later extended to also
     
    116116      <listitem>
    117117        <para>
    118           <emphasis role="bold">Serial ATA (SATA)</emphasis> is a newer
    119           standard introduced in 2003. Compared to IDE, it supports both
     118          <emphasis role="bold">Serial ATA (SATA)</emphasis> is a more
     119          recent standard than IDE. Compared to IDE, it supports both
    120120          much higher speeds and more devices per controller. Also, with
    121121          physical hardware, devices can be added and removed while the
     
    147147            seen by OSes that do not have device support for AHCI. In
    148148            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
     149            Windows versions before Windows Vista</emphasis>. Legacy
     150            Windows versions such as Windows XP, even with SP3
     151            installed, will not see such disks unless you install
     152            additional drivers. It is possible to switch from IDE to
     153            SATA after installation by installing the SATA drivers and
     154            changing the controller type in the VM
    154155            <emphasis role="bold">Settings</emphasis> dialog.
    155156          </para>
     
    158159            &product-name; recommends the Intel Matrix Storage drivers,
    159160            which can be downloaded from
    160             <ulink
    161                   url="http://downloadcenter.intel.com/Product_Filter.aspx?ProductID=2101">http://downloadcenter.intel.com/Product_Filter.aspx?ProductID=2101</ulink>.
     161            <ulink url="http://downloadcenter.intel.com/Product_Filter.aspx?ProductID=2101" />.
    162162          </para>
    163163        </warning>
     
    188188          <emphasis role="bold">SCSI</emphasis> is another established
    189189          industry standard, standing for Small Computer System
    190           Interface. SCSI was standardized as early as 1986 as a generic
    191           interface for data transfer between all kinds of devices,
    192           including storage devices. Today SCSI is still used for
    193           connecting hard disks and tape devices, but it has mostly been
    194           displaced in commodity hardware. It is still in common use in
    195           high-performance workstations and servers.
     190          Interface. SCSI is as a generic interface for data transfer
     191          between all kinds of devices, including storage devices. SCSI
     192          is still used for connecting some hard disks and tape devices,
     193          but it has mostly been displaced in commodity hardware. It is
     194          still in common use in high-performance workstations and
     195          servers.
    196196        </para>
    197197
     
    199199          Primarily for compatibility with other virtualization
    200200          software, &product-name; optionally supports LSI Logic and
    201           BusLogic SCSI controllers, to each of which up to 15 virtual
    202           hard disks can be attached.
     201          BusLogic SCSI controllers, to each of which up to fifteen
     202          virtual hard disks can be attached.
    203203        </para>
    204204
     
    229229          <emphasis role="bold">Serial Attached SCSI (SAS)</emphasis> is
    230230          another bus standard which uses the SCSI command set. As
    231           opposed to SCSI, however, with physical devices, serial cables
    232           are used instead of parallel ones, which simplifies physical
    233           device connections. In some ways, therefore, SAS is to SCSI
    234           what SATA is to IDE: it enables more reliable and faster
    235           connections.
     231          opposed to SCSI physical devices, serial cables are used
     232          instead of parallel cables. This simplifies physical device
     233          connections. In some ways, therefore, SAS is to SCSI what SATA
     234          is to IDE: it enables more reliable and faster connections.
    236235        </para>
    237236
     
    260259          class</emphasis> is a standard to connect external storage
    261260          devices like hard disks or flash drives to a host through USB.
    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.
     261          All major OSes support these devices and ship generic drivers
     262          making third-party drivers superfluous. In particular, legacy
     263          OSes without support for SATA controllers may benefit from USB
     264          mass storage devices.
    266265        </para>
    267266
     
    287286        <para>
    288287          <emphasis role="bold">Non volatile memory express
    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
     288          (NVMe)</emphasis> is a standard for connecting non volatile
     289          memory (NVM) directly over PCI Express to lift the bandwidth
     290          limitation of the previously used SATA protocol for
     291          solid-state devices. Unlike other standards the command set is
     292          very simple in order to achieve maximum throughput and is not
    294293          compatible with ATA or SCSI. OSes need to support NVMe devices
    295294          to make use of them. For example, Windows 8.1 added native
     
    391390      to a physical disk however, &product-name; enables you to expand
    392391      an image file after creation, even if it has data already. See
    393       <xref linkend="vboxmanage-modifyvdi" />.
     392      <xref linkend="vboxmanage-modifymedium" />.
    394393    </para>
    395394
     
    503502      <listitem>
    504503        <para>
    505           Registered media, for compatibility with &product-name;
    506           versions older than version 4.0. For details about how media
    507           registration has changed with version 4.0, see
    508           <xref linkend="vboxconfigdata" />.
     504          Registered media, for compatibility with legacy &product-name;
     505          versions.
    509506        </para>
    510507      </listitem>
     
    572569      <listitem>
    573570        <para>
    574           <emphasis role="bold">Add</emphasis> an image to the registry.
    575         </para>
    576       </listitem>
    577 
    578       <listitem>
    579         <para>
    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.
    587         </para>
    588       </listitem>
    589 
    590       <listitem>
    591         <para>
    592           <emphasis role="bold">Move</emphasis> an image that is
    593           currently in the registry to another location.
     571          <emphasis role="bold">Add</emphasis> an image to the known
     572          media.
     573        </para>
     574      </listitem>
     575
     576      <listitem>
     577        <para>
     578          <emphasis role="bold">Create</emphasis> a new disk image.
     579        </para>
     580
     581        <itemizedlist>
     582
     583          <listitem>
     584            <para>
     585              For virtual hard disks, the <emphasis role="bold">Create
     586              Virtual Hard Disk</emphasis> wizard is shown.
     587            </para>
     588          </listitem>
     589
     590          <listitem>
     591            <para>
     592              For optical disks, the <emphasis role="bold">VISO
     593              Creator</emphasis> screen is shown. This enables you to
     594              create a virtual ISO from selected files on the host.
     595            </para>
     596          </listitem>
     597
     598          <listitem>
     599            <para>
     600              For floppy disks, the <emphasis role="bold">Floppy Disk
     601              Creator</emphasis> screen is shown.
     602            </para>
     603          </listitem>
     604
     605        </itemizedlist>
     606      </listitem>
     607
     608      <listitem>
     609        <para>
     610          <emphasis role="bold">Copy</emphasis> an image to create
     611          another one.
     612        </para>
     613
     614        <para>
     615          For virtual hard disks, you can specify one of the following
     616          target types: VDI, VHD, or VMDK.
     617        </para>
     618      </listitem>
     619
     620      <listitem>
     621        <para>
     622          <emphasis role="bold">Move</emphasis> an image to another
     623          location.
    594624        </para>
    595625
     
    625655        <para>
    626656          <emphasis role="bold">Remove</emphasis> an image from the
    627           registry. You can optionally delete the image file when
     657          known media. You can optionally delete the image file when
    628658          removing the image.
    629659        </para>
     
    635665          from a VM. This action only applies if the image is currently
    636666          attached to a VM as a virtual hard disk.
     667        </para>
     668      </listitem>
     669
     670      <listitem>
     671        <para>
     672          <emphasis role="bold">Search</emphasis> for an image by name
     673          or UUID.
    637674        </para>
    638675      </listitem>
     
    729766
    730767    <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.
     768      You can copy hard disk image files to other host systems and then
     769      import them in to VMs from the host system. However, some Windows
     770      guest OSes may require that you configure the new VM in a similar
     771      way to the old one.
    735772    </para>
    736773
     
    765802      By default, images are in <emphasis>normal</emphasis> mode. To
    766803      mark an existing image with one of the non-standard modes listed
    767       below, use <command>VBoxManage modifyhd</command>. See
    768       <xref linkend="vboxmanage-modifyvdi" />. Alternatively, use
    769       <command>VBoxManage</command> to attach the image to a VM and use
    770       the <option>--mtype</option> argument. See
     804      below, use <command>VBoxManage modifymedium</command>. See
     805      <xref linkend="vboxmanage-modifymedium" />. Alternatively, use
     806      <command>VBoxManage storageattach</command> to attach the image to
     807      a VM and specify the <option>--mtype</option> argument. See
    771808      <xref linkend="vboxmanage-storageattach" />.
    772809    </para>
     
    794831        <para>
    795832          The image file itself is not reset. Instead, when a snapshot
    796           is taken, &product-name; "freezes" the image file and no
    797           longer writes to it. For the write operations from the VM, a
    798           second, <emphasis>differencing</emphasis> image file is
    799           created which receives only the changes to the original image.
    800           See <xref linkend="diffimages"/>.
     833          is taken, &product-name; <emphasis>freezes</emphasis> the
     834          image file and no longer writes to it. For the write
     835          operations from the VM, a second,
     836          <emphasis>differencing</emphasis> image file is created which
     837          receives only the changes to the original image. See
     838          <xref linkend="diffimages"/>.
    801839        </para>
    802840
     
    903941          startup does not fit your needs, you can turn it off using the
    904942          <option>autoreset</option> parameter of <command>VBoxManage
    905           modifyhd</command>. See
    906           <xref linkend="vboxmanage-modifyvdi"/>.
     943          modifymedium</command>. See
     944          <xref linkend="vboxmanage-modifymedium"/>.
    907945        </para>
    908946      </listitem>
     
    10621100          <emphasis role="bold">Snapshots.</emphasis> When you create a
    10631101          snapshot, as explained in the previous section, &product-name;
    1064           "freezes" the images attached to the virtual machine and
    1065           creates differencing images for each image that is not in
    1066           "write-through" mode. From the point of view of the virtual
    1067           machine, the virtual disks continue to operate before, but all
    1068           write operations go into the differencing images. Each time
    1069           you create another snapshot, for each hard disk attachment,
    1070           another differencing image is created and attached, forming a
    1071           chain or tree.
     1102          <emphasis>freezes</emphasis> the images attached to the
     1103          virtual machine and creates differencing images for each image
     1104          that is not in <emphasis>write-through</emphasis> mode. From
     1105          the point of view of the virtual machine, the virtual disks
     1106          continue to operate before, but all write operations go into
     1107          the differencing images. Each time you create another
     1108          snapshot, for each hard disk attachment, another differencing
     1109          image is created and attached, forming a chain or tree.
    10721110        </para>
    10731111
     
    11641202      However, you should <emphasis>only</emphasis> make copies of
    11651203      virtual disk images using the utility supplied with
    1166       &product-name;. See <xref linkend="vboxmanage-clonevdi" />. This
    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
     1204      &product-name;. See <xref linkend="vboxmanage-clonemedium" />.
     1205      This is because &product-name; assigns a UUID to each disk image,
     1206      which is also stored inside the image, and &product-name; will
     1207      refuse to work with two images that use the same number. If you do
    11701208      accidentally try to reimport a disk image which you copied
    11711209      normally, you can make a second copy using the <command>VBoxManage
     
    11741212
    11751213    <para>
    1176       Note that newer Linux distributions identify the boot hard disk
    1177       from the ID of the drive. The ID &product-name; reports for a
    1178       drive is determined from the UUID of the virtual disk image. So if
    1179       you clone a disk image and try to boot the copied image the guest
     1214      Note that Linux distributions identify the boot hard disk from the
     1215      ID of the drive. The ID &product-name; reports for a drive is
     1216      determined from the UUID of the virtual disk image. So if you
     1217      clone a disk image and try to boot the copied image the guest
    11801218      might not be able to determine its own boot disk as the UUID
    11811219      changed. In this case you have to adapt the disk ID in your boot
    11821220      loader script, for example
    1183       <computeroutput>/boot/grub/menu.lst</computeroutput>. The disk ID
    1184       looks like the following:
     1221      <filename>/boot/grub/menu.lst</filename>. The disk ID looks like
     1222      the following:
    11851223    </para>
    11861224
     
    13001338
    13011339    <para>
    1302       For the above reasons, &product-name; now uses SATA controllers by
     1340      For the above reasons, &product-name; uses SATA controllers by
    13031341      default for new virtual machines.
    13041342    </para>
     
    13951433      Medium changes can be prevented by the guest, and &product-name;
    13961434      reflects that by locking the host drive if appropriate. You can
    1397       force a medium removal in such situations by using the
    1398       &product-name; GUI or the <command>VBoxManage</command> command
    1399       line tool. Effectively this is the equivalent of the emergency
    1400       eject which many CD/DVD drives provide, with all associated side
    1401       effects. The guest OS can issue error messages, just like on real
    1402       hardware, and guest applications may misbehave. Use this with
    1403       caution.
     1435      force a medium removal in such situations by using the VirtualBox
     1436      Manager or the <command>VBoxManage</command> command line tool.
     1437      Effectively this is the equivalent of the emergency eject which
     1438      many CD/DVD drives provide, with all associated side effects. The
     1439      guest OS can issue error messages, just like on real hardware, and
     1440      guest applications may misbehave. Use this with caution.
    14041441    </para>
    14051442
     
    14481485
    14491486    <para>
    1450       There is a <emphasis role="bold">Passthrough</emphasis> check box
    1451       in the GUI dialog for configuring the media attached to a storage
    1452       controller, or you can use the <option>--passthrough</option>
    1453       option with <command>VBoxManage storageattach</command>. See
     1487      To enable host drive passthrough you can use the
     1488      <option>--passthrough</option> option of the <command>VBoxManage
     1489      storageattach</command> command. See
    14541490      <xref linkend="vboxmanage-storageattach" />.
    14551491    </para>
     
    14751511
    14761512    <para>
    1477       iSCSI stands for "Internet SCSI" and is a standard that supports
    1478       use of the SCSI protocol over Internet (TCP/IP) connections.
    1479       Especially with the advent of Gigabit Ethernet, it has become
    1480       affordable to attach iSCSI storage servers simply as remote hard
    1481       disks to a computer network. In iSCSI terminology, the server
    1482       providing storage resources is called an <emphasis>iSCSI
    1483       target</emphasis>, while the client connecting to the server and
    1484       accessing its resources is called an <emphasis>iSCSI
    1485       initiator</emphasis>.
     1513      iSCSI stands for <emphasis>Internet SCSI</emphasis> and is a
     1514      standard that supports use of the SCSI protocol over Internet
     1515      (TCP/IP) connections. Especially with the advent of Gigabit
     1516      Ethernet, it has become affordable to attach iSCSI storage servers
     1517      simply as remote hard disks to a computer network. In iSCSI
     1518      terminology, the server providing storage resources is called an
     1519      <emphasis>iSCSI target</emphasis>, while the client connecting to
     1520      the server and accessing its resources is called an
     1521      <emphasis>iSCSI initiator</emphasis>.
    14861522    </para>
    14871523
     
    15091545    <para>
    15101546      <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.
     1547      OS and Linux hosts that provides raw access to an &product-name;
     1548      virtual disk image on the host system. Use this utility to mount,
     1549      view, and optionally modify the disk image contents.
    15141550    </para>
    15151551
     
    15601596
    15611597    <para>
     1598      The <command>vboximg-mount </command>command includes experimental
     1599      read-only access to file systems inside a VM disk image. This
     1600      feature enables you to extract some files from the disk image
     1601      without starting the VM and without requiring third-party file
     1602      system drivers on the host system. FAT, NTFS, ext2, ext3, and ext4
     1603      file systems are supported.
     1604    </para>
     1605
     1606    <para>
    15621607      Use the <option>--help</option> option to view information about
    15631608      the <command>vboximg-mount</command> command usage. The complete
    1564       command reference is described in <xref linkend="man_vboximg-mount" />.
     1609      command reference is described in
     1610      <xref linkend="man_vboximg-mount" />.
    15651611    </para>
    15661612
     
    17031749          <para>
    17041750            In this example, partition 2 is mounted on the
    1705             <computeroutput>macos_sysdisk</computeroutput> mount point.
    1706             The mount includes all snapshots for the disk image.
     1751            <filename>macos_sysdisk</filename> mount point. The mount
     1752            includes all snapshots for the disk image.
    17071753          </para>
    17081754        </listitem>
     
    17101756        <listitem>
    17111757          <para>
    1712             Use the host OS to mount the
    1713             <computeroutput>vhdd</computeroutput> device node. The
    1714             FUSE-mounted device node represents the virtual disk image.
     1758            Use the host OS to mount the <literal>vhdd</literal> device
     1759            node. The FUSE-mounted device node represents the virtual
     1760            disk image.
    17151761          </para>
    17161762
  • trunk/doc/manual/en_US/user_Technical.xml

    r81523 r82350  
    2424      In &product-name;, a virtual machine and its settings are
    2525      described in a virtual machine settings file in XML format. In
    26       addition, most virtual machine have one or more virtual hard
    27       disks, which are typically represented by disk images, such as
    28       those in VDI format. Where all these files are stored depends on
    29       which version of &product-name; created the machine.
    30     </para>
    31 
    32     <sect2 id="vboxconfigdata-post-version-four">
    33 
    34       <title>Machines Created by &product-name; Version 4.0 or Later</title>
    35 
    36       <para>
    37         By default, each virtual machine has one directory on your host
     26      addition, most virtual machines have one or more virtual hard
     27      disks. These are typically represented by disk images, such as
     28      those in VDI format. The location of these files may vary,
     29      depending on the host operating system. See
     30      <xref linkend="vboxconfigdata-machine-folder"/>.
     31    </para>
     32
     33    <para>
     34      Global configuration data for &product-name; is maintained in
     35      another location on the host. See
     36      <xref linkend="vboxconfigdata-global"/>.
     37    </para>
     38
     39    <sect2 id="vboxconfigdata-machine-folder">
     40
     41      <title>The Machine Folder</title>
     42
     43      <para>
     44        By default, each virtual machine has a directory on your host
    3845        computer where all the files of that machine are stored: the XML
    39         settings file, with a <computeroutput>.vbox</computeroutput>
    40         file extension, and its disk images.
    41       </para>
    42 
    43       <para>
    44         By default, this <emphasis>machine folder</emphasis> is placed
    45         in a common folder called <computeroutput>VirtualBox
    46         VMs</computeroutput>, which &product-name; creates in the
    47         current system user's home directory. The location of this home
    48         directory depends on the conventions of the host operating
    49         system, as follows:
     46        settings file, with a <filename>.vbox</filename> file extension,
     47        and its disk images. This is called the <emphasis>machine
     48        folder</emphasis>.
     49      </para>
     50
     51      <para>
     52        By default, this machine folder is located in a common folder
     53        called <filename>VirtualBox VMs</filename>, which &product-name;
     54        creates in the current system user's home directory. The
     55        location of this home directory depends on the conventions of
     56        the host operating system, as follows:
    5057      </para>
    5158
     
    5562          <para>
    5663            On Windows, this is the location returned by the
    57             <computeroutput>SHGetFolderPath</computeroutput> function of
    58             the Windows system library Shell32.dll, asking for the user
    59             profile. On very old Windows versions which do not have this
    60             function or where it unexpectedly returns an error, there is
    61             a fallback based on environment variables. First,
    62             <computeroutput>%USERPROFILE%</computeroutput> is checked.
    63             If it does not exist then an attempt with
    64             <computeroutput>%HOMEDRIVE%%HOMEPATH%</computeroutput> is
    65             made. A typical location is
    66             <computeroutput>C:\Users\username</computeroutput>.
     64            <literal>SHGetFolderPath</literal> function of the Windows
     65            system library Shell32.dll, asking for the user profile. A
     66            typical location is
     67            <filename>C:\Users\<replaceable>username</replaceable></filename>.
    6768          </para>
    6869        </listitem>
     
    7273            On Linux, Mac OS X, and Oracle Solaris, this is generally
    7374            taken from the environment variable
    74             <computeroutput>$HOME</computeroutput>, except for the user
    75             <computeroutput>root</computeroutput> where it is taken from
    76             the account database. This is a workaround for the frequent
    77             trouble caused by users using &product-name; in combination
    78             with the tool <computeroutput>sudo</computeroutput> which by
    79             default does not reset the environment variable
    80             <computeroutput>$HOME</computeroutput>. A typical location
    81             on Linux and Oracle Solaris is
    82             <computeroutput>/home/username</computeroutput> and on Mac
    83             OS X <computeroutput>/Users/username</computeroutput>.
     75            <filename>$HOME</filename>, except for the user
     76            <literal>root</literal> where it is taken from the account
     77            database. This is a workaround for the frequent trouble
     78            caused by users using &product-name; in combination with the
     79            tool <command>sudo</command>, which by default does not
     80            reset the environment variable <filename>$HOME</filename>.
     81          </para>
     82
     83          <para>
     84            A typical location on Linux and Oracle Solaris is
     85            <filename>/home/<replaceable>username</replaceable></filename>
     86            and on Mac OS X is
     87            <filename>/Users/<replaceable>username</replaceable></filename>.
    8488          </para>
    8589        </listitem>
     
    8892
    8993      <para>
    90         For simplicity, we will abbreviate the location of the home
    91         directory as <computeroutput>$HOME</computeroutput>. Using that
    92         convention, the common folder for all virtual machines is
    93         <computeroutput>$HOME/VirtualBox VMs</computeroutput>.
     94        For simplicity, we abbreviate the location of the home directory
     95        as <filename>$HOME</filename>. Using that convention, the common
     96        folder for all virtual machines is <filename>$HOME/VirtualBox
     97        VMs</filename>.
    9498      </para>
    9599
     
    103107        <listitem>
    104108          <para>
    105             A machine folder <computeroutput>$HOME/VirtualBox
    106             VMs/Example VM/</computeroutput>
     109            A machine folder: <filename>$HOME/VirtualBox VMs/Example
     110            VM/</filename>
    107111          </para>
    108112        </listitem>
     
    110114        <listitem>
    111115          <para>
    112             In the machine folder, a settings file:
    113             <computeroutput>Example VM.vbox</computeroutput>
     116            In the machine folder, a settings file: <filename>Example
     117            VM.vbox</filename>
    114118          </para>
    115119        </listitem>
     
    118122          <para>
    119123            In the machine folder, a virtual disk image:
    120             <computeroutput>Example VM.vdi</computeroutput>.
     124            <filename>Example VM.vdi</filename>.
    121125          </para>
    122126        </listitem>
     
    129133        wizard described in <xref linkend="gui-createvm" />. Once you
    130134        start working with the VM, additional files are added. Log files
    131         are in a subfolder called <computeroutput>Logs</computeroutput>,
    132         and if you have taken snapshots, they are in a
    133         <computeroutput>Snapshots</computeroutput> subfolder. For each
    134         VM, you can change the location of its snapshots folder in the
    135         VM settings.
     135        are in a subfolder called <filename>Logs</filename>, and if you
     136        have taken snapshots, they are in a
     137        <filename>Snapshots</filename> subfolder. For each VM, you can
     138        change the location of its snapshots folder in the VM settings.
    136139      </para>
    137140
     
    142145        main window. Then, in the displayed window, click on the
    143146        <emphasis role="bold">General</emphasis> tab. Alternatively, use
    144         <command>VBoxManage setproperty machinefolder</command>. See
    145         <xref linkend="vboxmanage-setproperty" />.
     147        the <command>VBoxManage setproperty machinefolder</command>
     148        command. See <xref linkend="vboxmanage-setproperty" />.
    146149      </para>
    147150
    148151    </sect2>
    149152
    150     <sect2 id="vboxconfigdata-pre-version-four">
    151 
    152       <title>Machines Created by &product-name; Versions Before 4.0</title>
    153 
    154       <para>
    155         If you have upgraded to &product-name; 4.0 from an earlier
    156         version of &product-name;, you probably have settings files and
    157         disks in the earlier file system layout.
    158       </para>
    159 
    160       <para>
    161         Before version 4.0, &product-name; separated the machine
    162         settings files from virtual disk images. The machine settings
    163         files had an <computeroutput>.xml</computeroutput> file
    164         extension and resided in a folder called
    165         <computeroutput>Machines</computeroutput> under the global
    166         &product-name; configuration directory. See
    167         <xref linkend="vboxconfigdata-global"/>. On Linux, for example,
    168         this was the hidden directory
    169         <computeroutput>$HOME/.VirtualBox/Machines</computeroutput>. The
    170         default hard disks folder was called
    171         <computeroutput>HardDisks</computeroutput> and was also located
    172         in the <computeroutput>.VirtualBox</computeroutput> folder. Both
    173         locations could be changed by the user in the global
    174         preferences. The concept of a default hard disk folder was
    175         abandoned with &product-name; 4.0, since disk images now reside
    176         in each machine's folder by default.
    177       </para>
    178 
    179       <para>
    180         The old layout had the following severe disadvantages:
    181       </para>
    182 
    183       <itemizedlist>
    184 
    185         <listitem>
    186           <para>
    187             It was very difficult to move a virtual machine from one
    188             host to another because the files involved did not reside in
    189             the same folder. In addition, the virtual media of all
    190             machines were registered with a global registry in the
    191             central &product-name; settings file,
    192             <computeroutput>$HOME/.VirtualBox/VirtualBox.xml</computeroutput>.
    193           </para>
    194 
    195           <para>
    196             To move a machine to another host, it was therefore not
    197             enough to move the XML settings file and the disk images,
    198             which were in different locations, but the hard disk entries
    199             from the global media registry XML had to be meticulously
    200             copied as well. This was close to impossible if the machine
    201             had snapshots and therefore differencing images.
    202           </para>
    203         </listitem>
    204 
    205         <listitem>
    206           <para>
    207             Storing virtual disk images, which can grow very large,
    208             under the hidden
    209             <computeroutput>.VirtualBox</computeroutput> directory, at
    210             least on Linux and Oracle Solaris hosts, made many users
    211             wonder where their disk space had gone.
    212           </para>
    213         </listitem>
    214 
    215       </itemizedlist>
    216 
    217       <para>
    218         Whereas new VMs created with &product-name; 4.0 or later will
    219         conform to the new layout, for maximum compatibility, old VMs
    220         are <emphasis>not</emphasis> converted to the new layout.
    221         Otherwise machine settings would be irrevocably broken if a user
    222         downgraded from 4.0 back to an older version of &product-name;.
    223       </para>
    224 
    225     </sect2>
    226 
    227153    <sect2 id="vboxconfigdata-global">
    228154
    229       <title>Global Configuration Data</title>
    230 
    231       <para>
    232         In addition to the files of the virtual machines, &product-name;
    233         maintains global configuration data in the following directory:
     155      <title>Global Settings</title>
     156
     157      <para>
     158        In addition to the files for the virtual machines,
     159        &product-name; maintains global configuration data in the
     160        following directory:
    234161      </para>
    235162
     
    239166          <para>
    240167            <emphasis role="bold">Linux and Oracle Solaris:</emphasis>
    241             <computeroutput>$HOME/.config/VirtualBox</computeroutput>.
    242           </para>
    243 
    244           <para>
    245             <computeroutput>$HOME/.VirtualBox</computeroutput> is used
    246             if it exists, for compatibility with legacy versions before
    247             &product-name; 4.3.
     168            <filename>$HOME/.config/VirtualBox</filename>.
    248169          </para>
    249170        </listitem>
     
    252173          <para>
    253174            <emphasis role="bold">Windows:</emphasis>
    254             <computeroutput>$HOME/.VirtualBox</computeroutput>.
     175            <filename>$HOME/.VirtualBox</filename>.
    255176          </para>
    256177        </listitem>
     
    259180          <para>
    260181            <emphasis role="bold">Mac OS X:</emphasis>
    261             <computeroutput>$HOME/Library/VirtualBox</computeroutput>.
     182            <filename>$HOME/Library/VirtualBox</filename>.
    262183          </para>
    263184        </listitem>
     
    267188      <para>
    268189        &product-name; creates this configuration directory
    269         automatically, if necessary. Optionally, you can specify an
    270         alternate configuration directory by setting the
    271         <computeroutput>VBOX_USER_HOME</computeroutput> environment
    272         variable, or additionally on Linux or Oracle Solaris by using
    273         the standard <computeroutput>XDG_CONFIG_HOME</computeroutput>
    274         variable. Since the global
    275         <computeroutput>VirtualBox.xml</computeroutput> settings file
    276         points to all other configuration files, this enables switching
    277         between several &product-name; configurations.
    278       </para>
    279 
    280       <para>
    281         Most importantly, in this directory, &product-name; stores its
    282         global settings file, another XML file called
    283         <computeroutput>VirtualBox.xml</computeroutput>. This includes
    284         global configuration options and the list of registered virtual
    285         machines with pointers to their XML settings files. Neither the
    286         location of this file nor its directory has changed with
    287         &product-name; 4.0.
    288       </para>
    289 
    290       <para>
    291         Before &product-name; 4.0, all virtual media, such as disk image
    292         files, were also contained in a global registry in this settings
    293         file. For compatibility, this media registry still exists if you
    294         upgrade &product-name; and there are media from machines which
    295         were created with a version before 4.0. If you have no such
    296         machines, then there will be no global media registry. With
    297         &product-name; 4.0, each machine XML file has its own media
    298         registry.
    299       </para>
    300 
    301       <para>
    302         Also before &product-name; 4.0, the default
    303         <computeroutput>Machines</computeroutput> folder and the default
    304         <computeroutput>HardDisks</computeroutput> folder resided under
    305         the &product-name; configuration directory, such as
    306         <computeroutput>$HOME/.VirtualBox/Machines</computeroutput> on
    307         Linux. If you are upgrading from an &product-name; version
    308         before 4.0, files in these directories are not automatically
    309         moved in order not to break backwards compatibility.
     190        automatically, if necessary. You can specify an alternate
     191        configuration directory by either setting the
     192        <literal>VBOX_USER_HOME</literal> environment variable, or on
     193        Linux or Oracle Solaris by using the standard
     194        <literal>XDG_CONFIG_HOME</literal> variable. Since the global
     195        <filename>VirtualBox.xml</filename> settings file points to all
     196        other configuration files, this enables switching between
     197        several &product-name; configurations.
     198      </para>
     199
     200      <para>
     201        In this configuration directory, &product-name; stores its
     202        global settings file, an XML file called
     203        <filename>VirtualBox.xml</filename>. This file includes global
     204        configuration options and a list of registered virtual machines
     205        with pointers to their XML settings files.
    310206      </para>
    311207
    312208    </sect2>
    313209
    314     <sect2 id="vboxconfigdata-summary-version-four">
    315 
    316       <title>Summary of 4.0 Configuration Changes</title>
     210    <sect2 id="vboxconfigdata-summary-locations">
     211
     212      <title>Summary of Configuration Data Locations</title>
    317213
    318214      <para>
    319215        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">
    324         <title>Configuration Changes in Version 4.0 or Above</title>
    325         <tgroup cols="3">
     216        data locations on an &product-name; host.
     217      </para>
     218
     219      <table id="table-config-summary" tabstyle="oracle-all">
     220        <title>Configuration File Locations</title>
     221        <tgroup cols="2">
    326222          <thead>
    327223            <row>
     
    330226                </para></entry>
    331227              <entry><para>
    332                   <emphasis role="bold">Before 4.0</emphasis>
    333                 </para></entry>
    334               <entry><para>
    335                   <emphasis role="bold">4.0 or above</emphasis>
     228                  <emphasis role="bold">Location</emphasis>
    336229                </para></entry>
    337230            </row>
     
    343236                </para></entry>
    344237              <entry><para>
    345                   <computeroutput>$HOME/.VirtualBox/Machines</computeroutput>
    346                 </para></entry>
    347               <entry><para>
    348                   <computeroutput>$HOME/VirtualBox VMs</computeroutput>
     238                  <filename>$HOME/VirtualBox VMs</filename>
    349239                </para></entry>
    350240            </row>
     
    352242              <entry><para>
    353243                  Default disk image location
    354                 </para></entry>
    355               <entry><para>
    356                   <computeroutput>$HOME/.VirtualBox/HardDisks</computeroutput>
    357244                </para></entry>
    358245              <entry><para>
     
    365252                </para></entry>
    366253              <entry><para>
    367                   <computeroutput>.xml</computeroutput>
    368                 </para></entry>
    369               <entry><para>
    370                   <computeroutput>.vbox</computeroutput>
     254                  <filename>.vbox</filename>
    371255                </para></entry>
    372256            </row>
     
    376260                </para></entry>
    377261              <entry><para>
    378                   Global <computeroutput>VirtualBox.xml</computeroutput>
    379                   file
    380                 </para></entry>
    381               <entry><para>
    382262                  Each machine settings file
    383                 </para></entry>
    384             </row>
    385             <row>
    386               <entry><para>
    387                   Media registration
    388                 </para></entry>
    389               <entry><para>
    390                   Explicit open/close required
    391                 </para></entry>
    392               <entry><para>
    393                   Automatic on attach
     263                </para>
     264
     265
     266
     267                <para>
     268                  Media registration is done automatically when a
     269                  storage medium is attached to a VM
    394270                </para></entry>
    395271            </row>
     
    407283        &product-name; uses XML for both the machine settings files and
    408284        the global configuration file,
    409         <computeroutput>VirtualBox.xml</computeroutput>.
     285        <filename>VirtualBox.xml</filename>.
    410286      </para>
    411287
     
    426302
    427303      <para>
    428         As an example, before &product-name; 3.1, it was only possible
    429         to enable or disable a single DVD drive in a virtual machine. If
    430         it was enabled, then it would always be visible as the secondary
    431         master of the IDE controller. With &product-name; 3.1, DVD
    432         drives can be attached to arbitrary slots of arbitrary
    433         controllers, so they could be the secondary slave of an IDE
    434         controller or in a SATA slot. If you have a machine settings
    435         file from an earlier version and upgrade &product-name; to 3.1
    436         and then move the DVD drive from its default position, this
    437         cannot be expressed in the old settings format; the XML machine
    438         file would get written in the new format, and a backup file of
    439         the old format would be kept.
    440       </para>
    441 
    442       <para>
    443304        In such cases, &product-name; backs up the old settings file in
    444305        the virtual machine's configuration directory. If you need to go
     
    476337      <listitem>
    477338        <para>
    478           <computeroutput>VBoxSVC</computeroutput>, the &product-name;
    479           service process which always runs in the background. This
    480           process is started automatically by the first &product-name;
    481           client process and exits a short time after the last client
    482           exits. The first &product-name; service can be the GUI,
    483           <computeroutput>VBoxManage</computeroutput>,
    484           <computeroutput>VBoxHeadless</computeroutput>, the web service
    485           amongst others. The service is responsible for bookkeeping,
     339          <command>VBoxSVC</command>, the &product-name; service process
     340          which always runs in the background. This process is started
     341          automatically by the first &product-name; client process and
     342          exits a short time after the last client exits. The first
     343          &product-name; service can be the GUI,
     344          <command>VBoxManage</command>,
     345          <command>VBoxHeadless</command>, the web service amongst
     346          others. The service is responsible for bookkeeping,
    486347          maintaining the state of all VMs, and for providing
    487348          communication between &product-name; components. This
     
    492353          <para>
    493354            When we refer to <emphasis>clients</emphasis> here, we mean
    494             the local clients of a particular
    495             <computeroutput>VBoxSVC</computeroutput> server process, not
    496             clients in a network. &product-name; employs its own
    497             client/server design to allow its processes to cooperate,
    498             but all these processes run under the same user account on
    499             the host operating system, and this is totally transparent
    500             to the user.
     355            the local clients of a particular <command>VBoxSVC</command>
     356            server process, not clients in a network. &product-name;
     357            employs its own client/server design to allow its processes
     358            to cooperate, but all these processes run under the same
     359            user account on the host operating system, and this is
     360            totally transparent to the user.
    501361          </para>
    502362        </note>
     
    505365      <listitem>
    506366        <para>
    507           The GUI process,
    508           <computeroutput>VirtualBoxVM</computeroutput>, a client
     367          The GUI process, <command>VirtualBoxVM</command>, a client
    509368          application based on the cross-platform Qt library. When
    510           started without the <computeroutput>--startvm</computeroutput>
    511           option, this application acts as the VirtualBox Manager,
    512           displaying the VMs and their settings. It then communicates
    513           settings and state changes to
    514           <computeroutput>VBoxSVC</computeroutput> and also reflects
     369          started without the <option>--startvm</option> option, this
     370          application acts as the VirtualBox Manager, displaying the VMs
     371          and their settings. It then communicates settings and state
     372          changes to <command>VBoxSVC</command> and also reflects
    515373          changes effected through other means, such as the
    516374          <command>VBoxManage</command> command.
     
    520378      <listitem>
    521379        <para>
    522           If the <computeroutput>VirtualBoxVM</computeroutput> client
    523           application is started with the
    524           <computeroutput>--startvm</computeroutput> argument, it loads
     380          If the <command>VirtualBoxVM</command> client application is
     381          started with the <option>--startvm</option> argument, it loads
    525382          the VMM library which includes the actual hypervisor and then
    526383          runs a virtual machine and provides the input and output for
     
    549406      <listitem>
    550407        <para>
    551           <computeroutput>VirtualBoxVM</computeroutput>: The Qt front
    552           end implementing the VirtualBox Manager and running VMs.
    553         </para>
    554       </listitem>
    555 
    556       <listitem>
    557         <para>
    558           <computeroutput>VBoxManage</computeroutput>: A less
    559           user-friendly but more powerful alternative. See
    560           <xref linkend="vboxmanage" />.
    561         </para>
    562       </listitem>
    563 
    564       <listitem>
    565         <para>
    566           <computeroutput>VBoxHeadless</computeroutput>: A VM front end
    567           which does not directly provide any video output and keyboard
    568           or mouse input, but enables redirection through the VirtualBox
    569           Remote Desktop Extension. See <xref linkend="vboxheadless" />.
    570         </para>
    571       </listitem>
    572 
    573       <listitem>
    574         <para>
    575           <computeroutput>vboxwebsrv</computeroutput>: The
    576           &product-name; web service process which enables control of an
    577           &product-name; host remotely. This is described in detail in
    578           the &product-name; Software Development Kit (SDK) reference.
    579           See <xref linkend="VirtualBoxAPI" />.
     408          <command>VirtualBoxVM</command>: The Qt front end implementing
     409          the VirtualBox Manager and running VMs.
     410        </para>
     411      </listitem>
     412
     413      <listitem>
     414        <para>
     415          <command>VBoxManage</command>: A less user-friendly but more
     416          powerful alternative. See <xref linkend="vboxmanage" />.
     417        </para>
     418      </listitem>
     419
     420      <listitem>
     421        <para>
     422          <command>VBoxHeadless</command>: A VM front end which does not
     423          directly provide any video output and keyboard or mouse input,
     424          but enables redirection through the VirtualBox Remote Desktop
     425          Extension. See <xref linkend="vboxheadless" />.
     426        </para>
     427      </listitem>
     428
     429      <listitem>
     430        <para>
     431          <command>vboxwebsrv</command>: The &product-name; web service
     432          process which enables control of an &product-name; host
     433          remotely. This is described in detail in the &product-name;
     434          Software Development Kit (SDK) reference. See
     435          <xref linkend="VirtualBoxAPI" />.
    580436        </para>
    581437      </listitem>
     
    584440        <para>
    585441          The &product-name; Python shell: A Python alternative to
    586           <computeroutput>VBoxManage</computeroutput>. This is also
    587           described in the SDK reference.
     442          <command>VBoxManage</command>. This is also described in the
     443          SDK reference.
    588444        </para>
    589445      </listitem>
     
    617473        <para>
    618474          EM (Execution Manager): Controls execution of guest code.
    619         </para>
    620       </listitem>
    621 
    622       <listitem>
    623         <para>
    624           REM (Recompiled Execution Monitor): Provides software
    625           emulation of CPU instructions.
    626475        </para>
    627476      </listitem>
     
    662511        <para>
    663512          PGM (Page Manager): A component that controls guest paging.
    664         </para>
    665       </listitem>
    666 
    667       <listitem>
    668         <para>
    669           PATM (Patch Manager): Patches guest code to improve and speed
    670           up software virtualization.
    671513        </para>
    672514      </listitem>
     
    747589  <sect1 id="hwvirt">
    748590
    749     <title>Hardware vs. Software Virtualization</title>
     591    <title>Hardware Virtualization</title>
    750592
    751593    <para>
     
    757599      &product-name; steps in and takes action. In particular, for lots
    758600      of hardware that the guest believes to be accessing,
    759       &product-name; simulates a certain "virtual" environment according
    760       to how you have configured a virtual machine. For example, when
    761       the guest attempts to access a hard disk, &product-name; redirects
    762       these requests to whatever you have configured to be the virtual
    763       machine's virtual hard disk. This is normally an image file on
    764       your host.
     601      &product-name; simulates a certain <emphasis>virtual</emphasis>
     602      environment according to how you have configured a virtual
     603      machine. For example, when the guest attempts to access a hard
     604      disk, &product-name; redirects these requests to whatever you have
     605      configured to be the virtual machine's virtual hard disk. This is
     606      normally an image file on your host.
    765607    </para>
    766608
     
    769611      virtualized. Detecting situations in which &product-name; needs to
    770612      take control over the guest code that is executing, as described
    771       above, is difficult. There are two ways in which to achieve this:
     613      above, is difficult. To achieve this, &product-name; uses
     614      <emphasis>hardware virtualization</emphasis>.
     615    </para>
     616
     617    <para>
     618      Intel and AMD processors have support for hardware virtualization.
     619      This means that these processors can help &product-name; to
     620      intercept potentially dangerous operations that a guest operating
     621      system may be attempting and also makes it easier to present
     622      virtual hardware to a virtual machine.
     623    </para>
     624
     625    <para>
     626      These hardware features differ between Intel and AMD processors.
     627      Intel named its technology VT-x, AMD calls theirs AMD-V. The Intel
     628      and AMD support for virtualization is very different in detail,
     629      but not very different in principle.
     630    </para>
     631
     632    <note>
     633      <para>
     634        On many systems, the hardware virtualization features first need
     635        to be enabled in the BIOS before &product-name; can use them.
     636      </para>
     637    </note>
     638
     639    <para>
     640      Enabling hardware virtualization is <emphasis>required</emphasis>
     641      in the following scenarios:
    772642    </para>
    773643
     
    776646      <listitem>
    777647        <para>
    778           Since 2006, Intel and AMD processors have had support for
    779           so-called <emphasis>hardware virtualization</emphasis>. This
    780           means that these processors can help &product-name; to
    781           intercept potentially dangerous operations that a guest
    782           operating system may be attempting and also makes it easier to
    783           present virtual hardware to a virtual machine.
    784         </para>
    785 
    786         <para>
    787           These hardware features differ between Intel and AMD
    788           processors. Intel named its technology VT-x. AMD calls theirs
    789           AMD-V. The Intel and AMD support for virtualization is very
    790           different in detail, but not very different in principle.
    791         </para>
    792 
    793         <note>
    794           <para>
    795             On many systems, the hardware virtualization features first
    796             need to be enabled in the BIOS before &product-name; can use
    797             them.
    798           </para>
    799         </note>
    800       </listitem>
    801 
    802       <listitem>
    803         <para>
    804           As opposed to other virtualization software, for many usage
    805           scenarios, &product-name; does not
    806           <emphasis>require</emphasis> hardware virtualization features
    807           to be present. Through sophisticated techniques,
    808           &product-name; virtualizes many guest operating systems
    809           entirely in <emphasis>software</emphasis>. This means that you
    810           can run virtual machines even on older processors which do not
    811           support hardware virtualization.
    812         </para>
    813       </listitem>
    814 
    815     </itemizedlist>
    816 
    817     <para>
    818       Even though &product-name; does not always require hardware
    819       virtualization, enabling it is <emphasis>required</emphasis> in
    820       the following scenarios:
    821     </para>
    822 
    823     <itemizedlist>
    824 
    825       <listitem>
    826         <para>
    827648          Certain rare guest operating systems like OS/2 make use of
    828           very esoteric processor instructions that are not supported
    829           with our software virtualization. For virtual machines that
    830           are configured to contain such an operating system, hardware
     649          very esoteric processor instructions. For virtual machines
     650          that are configured to use such an operating system, hardware
    831651          virtualization is enabled automatically.
    832652        </para>
     
    835655      <listitem>
    836656        <para>
    837           &product-name;'s 64-bit guest support, added with version 2.0,
    838           and multiprocessing (SMP), added with version 3.0, both
    839           require hardware virtualization to be enabled. This is not
    840           much of a limitation since the vast majority of today's 64-bit
    841           and multicore CPUs ship with hardware virtualization anyway.
    842           The exceptions to this rule are older Intel Celeron and AMD
    843           Opteron CPUs, for example.
     657          &product-name;'s 64-bit guest and multiprocessing (SMP)
     658          support both require hardware virtualization to be enabled.
     659          This is not much of a limitation since the vast majority of
     660          64-bit and multicore CPUs ship with hardware virtualization.
     661          The exceptions to this rule are some legacy Intel and AMD
     662          CPUs.
    844663        </para>
    845664      </listitem>
     
    858677        host, and especially if several products attempt to use hardware
    859678        virtualization features such as VT-x, this can crash the entire
    860         host. Also, within &product-name;, you can mix software and
    861         hardware virtualization when running multiple VMs. In certain
    862         cases a small performance penalty will be unavoidable when
    863         mixing VT-x and software virtualization VMs. We recommend not
    864         mixing virtualization modes if maximum performance and low
    865         overhead are essential. This does <emphasis>not</emphasis> apply
    866         to AMD-V.
     679        host.
    867680      </para>
    868681    </warning>
    869682
    870   </sect1>
    871 
    872   <sect1 id="gimproviders">
    873 
    874     <title>Paravirtualization Providers</title>
    875 
    876     <para>
    877       &product-name; enables the exposure of a paravirtualization
    878       interface, to facilitate accurate and efficient execution of
    879       software within a virtual machine. These interfaces require the
    880       guest operating system to recognize their presence and make use of
    881       them in order to leverage the benefits of communicating with the
    882       &product-name; hypervisor.
    883     </para>
    884 
    885     <para>
    886       Most modern, mainstream guest operating systems, including Windows
    887       and Linux, ship with support for one or more paravirtualization
    888       interfaces. Hence, there is typically no need to install
    889       additional software in the guest to take advantage of this
    890       feature.
    891     </para>
    892 
    893     <para>
    894       Exposing a paravirtualization provider to the guest operating
    895       system does not rely on the choice of host platforms. For example,
    896       the <emphasis>Hyper-V</emphasis> paravirtualization provider can
    897       be used for VMs to run on any host platform supported by
    898       &product-name; and not just Windows.
    899     </para>
    900 
    901     <para>
    902       &product-name; provides the following interfaces:
    903     </para>
    904 
    905     <itemizedlist>
    906 
    907       <listitem>
    908         <para>
    909           <emphasis role="bold">Minimal</emphasis>: Announces the
    910           presence of a virtualized environment. Additionally, reports
    911           the TSC and APIC frequency to the guest operating system. This
    912           provider is mandatory for running any Mac OS X guests.
    913         </para>
    914       </listitem>
    915 
    916       <listitem>
    917         <para>
    918           <emphasis role="bold">KVM</emphasis>: Presents a Linux KVM
    919           hypervisor interface which is recognized by Linux kernels
    920           version 2.6.25 or later. &product-name;'s implementation
    921           currently supports paravirtualized clocks and SMP spinlocks.
    922           This provider is recommended for Linux guests.
    923         </para>
    924       </listitem>
    925 
    926       <listitem>
    927         <para>
    928           <emphasis role="bold">Hyper-V</emphasis>: Presents a Microsoft
    929           Hyper-V hypervisor interface which is recognized by Windows 7
    930           and newer operating systems. &product-name;'s implementation
    931           currently supports paravirtualized clocks, APIC frequency
    932           reporting, guest debugging, guest crash reporting and relaxed
    933           timer checks. This provider is recommended for Windows guests.
    934         </para>
    935       </listitem>
    936 
    937     </itemizedlist>
    938 
    939   </sect1>
    940 
    941   <sect1 id="swvirt-details">
    942 
    943     <title>Details About Software Virtualization</title>
    944 
    945     <para>
    946       Implementing virtualization on x86 CPUs with no hardware
    947       virtualization support is an extraordinarily complex task because
    948       the CPU architecture was not designed to be virtualized. The
    949       problems can usually be solved, but at the cost of reduced
    950       performance. Thus, there is a constant clash between
    951       virtualization performance and accuracy.
    952     </para>
    953 
    954     <para>
    955       The x86 instruction set was originally designed in the 1970s and
    956       underwent significant changes with the addition of protected mode
    957       in the 1980s with the 286 CPU architecture and then again with the
    958       Intel 386 and its 32-bit architecture. Whereas the 386 did have
    959       limited virtualization support for real mode operation with V86
    960       mode, as used by the "DOS Box" of Windows 3.x and OS/2 2.x, no
    961       support was provided for virtualizing the entire architecture.
    962     </para>
    963 
    964     <para>
    965       In theory, software virtualization is not overly complex. There
    966       are four privilege levels, called <emphasis>rings</emphasis>,
    967       provided by the hardware. Typically only two rings are used: ring
    968       0 for kernel mode and ring 3 for user mode. Additionally, one
    969       needs to differentiate between <emphasis>host context</emphasis>
    970       and <emphasis>guest context</emphasis>.
    971     </para>
    972 
    973     <para>
    974       In host context, everything is as if no hypervisor was active.
    975       This might be the active mode if another application on your host
    976       has been scheduled CPU time. In that case, there is a host ring 3
    977       mode and a host ring 0 mode. The hypervisor is not involved.
    978     </para>
    979 
    980     <para>
    981       In guest context, however, a virtual machine is active. So long as
    982       the guest code is running in ring 3, this is not much of a problem
    983       since a hypervisor can set up the page tables properly and run
    984       that code natively on the processor. The problems mostly lie in
    985       how to intercept what the guest's kernel does.
    986     </para>
    987 
    988     <para>
    989       There are several possible solutions to these problems. One
    990       approach is full software emulation, usually involving
    991       recompilation. That is, all code to be run by the guest is
    992       analyzed, transformed into a form which will not allow the guest
    993       to either modify or see the true state of the CPU, and only then
    994       executed. This process is obviously highly complex and costly in
    995       terms of performance. &product-name; contains a recompiler based
    996       on QEMU which can be used for pure software emulation, but the
    997       recompiler is only activated in special situations, described
    998       below.
    999     </para>
    1000 
    1001     <para>
    1002       Another possible solution is paravirtualization, in which only
    1003       specially modified guest OSes are allowed to run. This way, most
    1004       of the hardware access is abstracted and any functions which would
    1005       normally access the hardware or privileged CPU state are passed on
    1006       to the hypervisor instead. Paravirtualization can achieve good
    1007       functionality and performance on standard x86 CPUs, but it can
    1008       only work if the guest OS can actually be modified, which is
    1009       obviously not always the case.
    1010     </para>
    1011 
    1012     <para>
    1013       &product-name; chooses a different approach. When starting a
    1014       virtual machine, through its ring-0 support kernel driver,
    1015       &product-name; has set up the host system so that it can run most
    1016       of the guest code natively, but it has inserted itself at the
    1017       "bottom" of the picture. It can then assume control when needed.
    1018       If a privileged instruction is executed, the guest traps, in
    1019       particular because an I/O register was accessed and a device needs
    1020       to be virtualized, or external interrupts occur. &product-name;
    1021       may then handle this and either route a request to a virtual
    1022       device or possibly delegate handling such things to the guest or
    1023       host OS. In guest context, &product-name; can therefore be in one
    1024       of three states:
    1025     </para>
    1026 
    1027     <itemizedlist>
    1028 
    1029       <listitem>
    1030         <para>
    1031           Guest ring 3 code is run unmodified, at full speed, as much as
    1032           possible. The number of faults will generally be low, unless
    1033           the guest allows port I/O from ring 3. This is something we
    1034           cannot do as we do not want the guest to be able to access
    1035           real ports. This is also referred to as <emphasis>raw
    1036           mode</emphasis>, as the guest ring-3 code runs unmodified.
    1037         </para>
    1038       </listitem>
    1039 
    1040       <listitem>
    1041         <para>
    1042           For guest code in ring 0, &product-name; employs a clever
    1043           trick. It actually reconfigures the guest so that its ring-0
    1044           code is run in ring 1 instead, which is normally not used in
    1045           x86 operating systems). As a result, when guest ring-0 code,
    1046           actually running n ring 1, such as a guest device driver
    1047           attempts to write to an I/O register or execute a privileged
    1048           instruction, the &product-name; hypervisor in the "real" ring
    1049           0 can take over.
    1050         </para>
    1051       </listitem>
    1052 
    1053       <listitem>
    1054         <para>
    1055           The hypervisor (VMM) can be active. Every time a fault occurs,
    1056           &product-name; looks at the offending instruction and can
    1057           relegate it to a virtual device or the host OS or the guest OS
    1058           or run it in the recompiler.
    1059         </para>
    1060 
    1061         <para>
    1062           In particular, the recompiler is used when guest code disables
    1063           interrupts and &product-name; cannot figure out when they will
    1064           be switched back on. In these situations, &product-name;
    1065           actually analyzes the guest code using its own disassembler.
    1066           Also, certain privileged instructions such as LIDT need to be
    1067           handled specially. Finally, any real-mode or protected-mode
    1068           code, such as BIOS code, a DOS guest, or any operating system
    1069           startup, is run in the recompiler entirely.
    1070         </para>
    1071       </listitem>
    1072 
    1073     </itemizedlist>
    1074 
    1075     <para>
    1076       Unfortunately this only works to a degree. Among others, the
    1077       following situations require special handling:
    1078     </para>
    1079 
    1080     <itemizedlist>
    1081 
    1082       <listitem>
    1083         <para>
    1084           Running ring 0 code in ring 1 causes a lot of additional
    1085           instruction faults, as ring 1 is not allowed to execute any
    1086           privileged instructions, of which guest's ring-0 contains
    1087           plenty. With each of these faults, the VMM must step in and
    1088           emulate the code to achieve the desired behavior. While this
    1089           works, emulating thousands of these faults is very expensive
    1090           and severely hurts the performance of the virtualized guest.
    1091         </para>
    1092       </listitem>
    1093 
    1094       <listitem>
    1095         <para>
    1096           There are certain flaws in the implementation of ring 1 in the
    1097           x86 architecture that were never fixed. Certain instructions
    1098           that <emphasis>should</emphasis> trap in ring 1 do not. This
    1099           affects, for example, the LGDT/SGDT, LIDT/SIDT, or POPF/PUSHF
    1100           instruction pairs. Whereas the "load" operation is privileged
    1101           and can therefore be trapped, the "store" instruction always
    1102           succeed. If the guest is allowed to execute these, it will see
    1103           the true state of the CPU, not the virtualized state. The
    1104           CPUID instruction also has the same problem.
    1105         </para>
    1106       </listitem>
    1107 
    1108       <listitem>
    1109         <para>
    1110           A hypervisor typically needs to reserve some portion of the
    1111           guest's address space, both linear address space and
    1112           selectors, for its own use. This is not entirely transparent
    1113           to the guest OS and may cause clashes.
    1114         </para>
    1115       </listitem>
    1116 
    1117       <listitem>
    1118         <para>
    1119           The SYSENTER instruction, used for system calls, executed by
    1120           an application running in a guest OS always transitions to
    1121           ring 0. But that is where the hypervisor runs, not the guest
    1122           OS. In this case, the hypervisor must trap and emulate the
    1123           instruction even when it is not desirable.
    1124         </para>
    1125       </listitem>
    1126 
    1127       <listitem>
    1128         <para>
    1129           The CPU segment registers contain a "hidden" descriptor cache
    1130           which is not software-accessible. The hypervisor cannot read,
    1131           save, or restore this state, but the guest OS may use it.
    1132         </para>
    1133       </listitem>
    1134 
    1135       <listitem>
    1136         <para>
    1137           Some resources must, and can, be trapped by the hypervisor,
    1138           but the access is so frequent that this creates a significant
    1139           performance overhead. An example is the TPR (Task Priority)
    1140           register in 32-bit mode. Accesses to this register must be
    1141           trapped by the hypervisor. But certain guest operating
    1142           systems, notably Windows and Oracle Solaris, write this
    1143           register very often, which adversely affects virtualization
    1144           performance.
    1145         </para>
    1146       </listitem>
    1147 
    1148     </itemizedlist>
    1149 
    1150     <para>
    1151       To fix these performance and security issues, &product-name;
    1152       contains a Code Scanning and Analysis Manager (CSAM), which
    1153       disassembles guest code, and the Patch Manager (PATM), which can
    1154       replace it at runtime.
    1155     </para>
    1156 
    1157     <para>
    1158       Before executing ring 0 code, CSAM scans it recursively to
    1159       discover problematic instructions. PATM then performs
    1160       <emphasis>in-situ </emphasis>patching. It replaces the instruction
    1161       with a jump to hypervisor memory where an integrated code
    1162       generator has placed a more suitable implementation. In reality,
    1163       this is a very complex task as there are lots of odd situations to
    1164       be discovered and handled correctly. So, with its current
    1165       complexity, one could argue that PATM is an advanced
    1166       <emphasis>in-situ</emphasis> recompiler.
    1167     </para>
    1168 
    1169     <para>
    1170       In addition, every time a fault occurs, &product-name; analyzes
    1171       the offending code to determine if it is possible to patch it in
    1172       order to prevent it from causing more faults in the future. This
    1173       approach works well in practice and dramatically improves software
    1174       virtualization performance.
     683    <para>
     684      See <xref linkend="hwvirt-details"/> for a technical discussion of
     685      hardware virtualization.
    1175686    </para>
    1176687
     
    1270781      software virtualization, the overhead of VM exits is relatively
    1271782      high. This causes problems for devices whose emulation requires
    1272       high number of traps. One example is the VGA device in 16-color
    1273       modes, where not only every I/O port access but also every access
     783      high number of traps. One example is a VGA device in 16-color
     784      mode, where not only every I/O port access but also every access
    1274785      to the framebuffer memory must be trapped.
    1275786    </para>
     787
     788  </sect1>
     789
     790  <sect1 id="gimproviders">
     791
     792    <title>Paravirtualization Providers</title>
     793
     794    <para>
     795      &product-name; enables the exposure of a paravirtualization
     796      interface, to facilitate accurate and efficient execution of
     797      software within a virtual machine. These interfaces require the
     798      guest operating system to recognize their presence and make use of
     799      them in order to leverage the benefits of communicating with the
     800      &product-name; hypervisor.
     801    </para>
     802
     803    <para>
     804      Most modern, mainstream guest operating systems, including Windows
     805      and Linux, ship with support for one or more paravirtualization
     806      interfaces. Hence, there is typically no need to install
     807      additional software in the guest to take advantage of this
     808      feature.
     809    </para>
     810
     811    <para>
     812      Exposing a paravirtualization provider to the guest operating
     813      system does not rely on the choice of host platforms. For example,
     814      the <emphasis>Hyper-V</emphasis> paravirtualization provider can
     815      be used for VMs to run on any host platform supported by
     816      &product-name; and not just Windows.
     817    </para>
     818
     819    <para>
     820      &product-name; provides the following interfaces:
     821    </para>
     822
     823    <itemizedlist>
     824
     825      <listitem>
     826        <para>
     827          <emphasis role="bold">Minimal</emphasis>: Announces the
     828          presence of a virtualized environment. Additionally, reports
     829          the TSC and APIC frequency to the guest operating system. This
     830          provider is mandatory for running any Mac OS X guests.
     831        </para>
     832      </listitem>
     833
     834      <listitem>
     835        <para>
     836          <emphasis role="bold">KVM</emphasis>: Presents a Linux KVM
     837          hypervisor interface which is recognized by Linux kernels
     838          version 2.6.25 or later. &product-name;'s implementation
     839          currently supports paravirtualized clocks and SMP spinlocks.
     840          This provider is recommended for Linux guests.
     841        </para>
     842      </listitem>
     843
     844      <listitem>
     845        <para>
     846          <emphasis role="bold">Hyper-V</emphasis>: Presents a Microsoft
     847          Hyper-V hypervisor interface which is recognized by Windows 7
     848          and newer operating systems. &product-name;'s implementation
     849          currently supports paravirtualized clocks, APIC frequency
     850          reporting, guest debugging, guest crash reporting and relaxed
     851          timer checks. This provider is recommended for Windows guests.
     852        </para>
     853      </listitem>
     854
     855    </itemizedlist>
    1276856
    1277857  </sect1>
     
    1328908          and overhead. This can yield a performance improvement of up
    1329909          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" />.
     910          <command>VBoxManage modifyvm --largepages</command> command.
     911          See <xref linkend="vboxmanage-modifyvm" />.
    1333912        </para>
    1334913
     
    1350929        <para>
    1351930          To enable these features for a VM, you use the
    1352           <computeroutput>VBoxManage modifyvm --vtxvpid</computeroutput>
    1353           and <computeroutput>--largepages</computeroutput> commands.
     931          <command>VBoxManage modifyvm --vtxvpid</command> and
     932          <command>VBoxManage modifyvm --largepages</command> commands.
    1354933          See <xref linkend="vboxmanage-modifyvm" />.
    1355934        </para>
  • trunk/doc/manual/en_US/user_ThirdParty.xml

    r76786 r82350  
    2424    of the &product-name; code which is released as open source are
    2525    available at
    26     <ulink
    27   url="http://www.virtualbox.org">http://www.virtualbox.org</ulink>,
     26    <ulink url="http://www.virtualbox.org" />,
    2827    both as tarballs for particular releases and as a live SVN
    2928    repository.
     
    182181          work does not require the other work to be released under the
    183182          same license (see
    184           <ulink
    185         url="http://etherboot.sourceforge.net/clinks.html">http://etherboot.sourceforge.net/clinks.html</ulink>).
     183          <ulink url="http://etherboot.sourceforge.net/clinks.html" />).
    186184          Etherboot is
    187185        </para>
     
    32913289        except in compliance with the License. You may obtain a copy of
    32923290        the License at
    3293         <ulink
    3294       url="http://www.cs.fsu.edu/~engelen/soaplicense.html">http://www.cs.fsu.edu/~engelen/soaplicense.html</ulink>.
     3291        <ulink url="http://www.cs.fsu.edu/~engelen/soaplicense.html" />.
    32953292        Software distributed under the License is distributed on an "AS
    32963293        IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
  • trunk/doc/manual/en_US/user_Troubleshooting.xml

    r79368 r82350  
    6666            Because of significant differences between VT-x and AMD-V,
    6767            problems may be specific to one or the other technology. The
    68             exact CPU model may also make a difference, even for
    69             software virtualization, because different CPUs support
    70             different features, which may affect certain aspects of
    71             guest CPU operation.
    72           </para>
    73         </listitem>
    74 
    75         <listitem>
    76           <para>
    77             Is the problem specific to a certain virtualization mode?
    78             Some problems may only occur in software virtualization
    79             mode, others may be specific to hardware virtualization.
     68            exact CPU model may also make a difference because different
     69            CPUs support different features, which may affect certain
     70            aspects of guest CPU operation.
    8071          </para>
    8172        </listitem>
     
    139130        <emphasis>release log file</emphasis> is created, containing
    140131        lots of information about the VM configuration and runtime
    141         events. The log file is called
    142         <computeroutput>VBox.log</computeroutput> and resides in the VM
    143         log file folder. Typically this will be a directory as follows:
    144       </para>
    145 
    146 <screen>$HOME/VirtualBox VMs/{machinename}/Logs</screen>
     132        events. The log file is called <filename>VBox.log</filename> and
     133        resides in the VM log file folder, which is
     134        <filename>$HOME/VirtualBox
     135        VMs/<replaceable>VM-name</replaceable>/Logs</filename> by
     136        default.
     137      </para>
    147138
    148139      <para>
    149140        When starting a VM, the configuration file of the last run will
    150         be renamed to <computeroutput>.1</computeroutput>, up to
    151         <computeroutput>.3</computeroutput>. Sometimes when there is a
    152         problem, it is useful to have a look at the logs. Also when
    153         requesting support for &product-name;, supplying the
    154         corresponding log file is mandatory.
     141        be renamed to <filename>.1</filename>, up to
     142        <filename>.3</filename>. Sometimes when there is a problem, it
     143        is useful to have a look at the logs. Also when requesting
     144        support for &product-name;, supplying the corresponding log file
     145        is mandatory.
    155146      </para>
    156147
     
    164155
    165156      <para>
    166         The release log file, VBox.log, contains a wealth of diagnostic
    167         information, such as Host OS type and version, &product-name;
    168         version and build (32-bit or 64-bit). It also includes a
     157        The release log file, <filename>VBox.log</filename>, contains a
     158        wealth of diagnostic information, such as Host OS type and
     159        version, &product-name; version and build. It also includes a
    169160        complete dump of the guest's configuration (CFGM), detailed
    170161        information about the host CPU type and supported features,
     
    180171        <emphasis>crash dumps</emphasis>. This is true for both host and
    181172        guest crashes. For information about enabling core dumps on
    182         Linux, Oracle Solaris, and OS X systems, refer to the following
    183         core dump article on the &product-name; website:
    184       </para>
    185 
    186       <para>
    187         <ulink
    188           url="http://www.virtualbox.org/wiki/Core_dump">http://www.virtualbox.org/wiki/Core_dump</ulink>.
     173        Linux, Oracle Solaris, and Mac OS X systems, refer to the
     174        following core dump article on the &product-name; website:
     175      </para>
     176
     177      <para>
     178        <ulink url="http://www.virtualbox.org/wiki/Core_dump" />.
    189179      </para>
    190180
     
    211201
    212202      <para>
    213         <ulink
    214           url="http://www.virtualbox.org/wiki/Network_tips">http://www.virtualbox.org/wiki/Network_tips</ulink>.
     203        <ulink url="http://www.virtualbox.org/wiki/Network_tips" />.
    215204      </para>
    216205
    217206      <para>
    218207        The trace files created by &product-name; are in
    219         <computeroutput>.pcap</computeroutput> format and can be easily
    220         analyzed with Wireshark.
     208        <filename>.pcap</filename> format and can be easily analyzed
     209        with Wireshark.
     210      </para>
     211
     212    </sect2>
     213
     214    <sect2 id="ts_vboxbugreport">
     215
     216      <title>Using the VBoxBugReport Command to Collect Debug Information
     217        Automatically</title>
     218
     219      <para>
     220        The <command>VBoxBugReport</command> command is used to collect
     221        debug information automatically for an &product-name;
     222        installation. This command can be useful when you need to gather
     223        information to send to Oracle Support.
     224      </para>
     225
     226      <para>
     227        The following examples show how to use
     228        <command>VBoxBugReport</command>.
     229      </para>
     230
     231      <para>
     232        By default, the command collects <command>VBoxSVC</command>
     233        process logs, device settings, and global configuration data for
     234        an &product-name; host.
     235      </para>
     236
     237<screen>$ VBoxBugReport
     238  ...
     239  0% - collecting VBoxSVC.log.10...
     240  7% - collecting VBoxSVC.log.9...
     241  ...
     242 64% - collecting VBoxSVC.log.1...
     243 71% - collecting VBoxSVC.log...
     244 78% - collecting VirtualBox.xml...
     245 85% - collecting HostUsbDevices...
     246 92% - collecting HostUsbFilters...
     247100% - compressing...
     248
     249Report was written to '2019-03-26-13-32-02-bugreport.tgz'</screen>
     250
     251      <para>
     252        The results are saved as a compressed tar file archive in the
     253        same directory where the command is run.
     254      </para>
     255
     256      <para>
     257        To specify a different output file location:
     258      </para>
     259
     260<screen>$ VBoxBugReport --output ~/debug/bug004.tgz</screen>
     261
     262      <para>
     263        To output all debug information to a single text file, rather
     264        than a <filename>tgz</filename> file:
     265      </para>
     266
     267<screen>$ VBoxBugReport --text</screen>
     268
     269      <para>
     270        To collect information for a specific VM, called
     271        <literal>Windows_10</literal>:
     272      </para>
     273
     274<screen>$ VBoxBugReport Windows_10</screen>
     275
     276      <para>
     277        This command collects machine settings, guest properties, and
     278        log files for the specified VM. Global configuration information
     279        for the host is also included.
     280      </para>
     281
     282      <para>
     283        To collect information for several VMs, called
     284        <literal>Windows_7</literal>, <literal>Windows_8</literal>, and
     285        <literal>Windows_10</literal>:
     286      </para>
     287
     288<screen>$ VBoxBugReport Windows_7 Windows_8 Windows_10</screen>
     289
     290      <para>
     291        To collect information for all VMs:
     292      </para>
     293
     294<screen>$ VBoxBugReport --all</screen>
     295
     296      <para>
     297        To show a full list of the available command options, run
     298        <command>VBoxBugReport --help</command>.
    221299      </para>
    222300
     
    262340        <listitem>
    263341          <para>
    264             Using the <computeroutput>telnet</computeroutput> protocol
    265             on port 5000
     342            Using the <command>telnet</command> protocol on port 5000
    266343          </para>
    267344        </listitem>
     
    277354        <listitem>
    278355          <para>
    279             Start the VM directly using <command>VirtualBox
     356            Start the VM directly using <command>VirtualBoxVM
    280357            --startvm</command>, with an additional
    281             <computeroutput>--dbg</computeroutput>,
    282             <computeroutput>--debug</computeroutput>, or
    283             <computeroutput>--debug-command-line</computeroutput>
    284             argument. See the <command>VirtualBox</command> command
    285             usage help for details.
    286           </para>
    287         </listitem>
    288 
    289         <listitem>
    290           <para>
    291             Set the
    292             <computeroutput>VBOX_GUI_DBG_ENABLED</computeroutput> or
    293             <computeroutput>VBOX_GUI_DBG_AUTO_SHOW</computeroutput>
    294             environment variable to
    295             <computeroutput>true</computeroutput> before launching the
     358            <option>--dbg</option>, <option>--debug</option>, or
     359            <option>--debug-command-line</option> argument. See the
     360            <command>VirtualBoxVM --help</command> command usage help
     361            for details.
     362          </para>
     363        </listitem>
     364
     365        <listitem>
     366          <para>
     367            Set the <literal>VBOX_GUI_DBG_ENABLED</literal> or
     368            <literal>VBOX_GUI_DBG_AUTO_SHOW</literal> environment
     369            variable to <literal>true</literal> before launching the
    296370            &product-name; process. Setting these variables, only their
    297371            presence is checked, is effective even when the first
     
    304378        <listitem>
    305379          <para>
    306             Set the <computeroutput>GUI/Dbg/Enabled</computeroutput>
    307             extra data item to <computeroutput>true</computeroutput>
    308             before launching the VM. This can be set globally or on a
    309             per VM basis.
     380            Set the <literal>GUI/Dbg/Enabled</literal> extra data item
     381            to <literal>true</literal> before launching the VM. This can
     382            be set globally or on a per VM basis.
    310383          </para>
    311384        </listitem>
     
    341414        <listitem>
    342415          <para>
    343             <computeroutput>stop</computeroutput>: Stops the VM
    344             execution and enables single stepping
    345           </para>
    346         </listitem>
    347 
    348         <listitem>
    349           <para>
    350             <computeroutput>g</computeroutput>: Continue VM execution
    351           </para>
    352         </listitem>
    353 
    354         <listitem>
    355           <para>
    356             <computeroutput>t</computeroutput>: Single step an
    357             instruction
    358           </para>
    359         </listitem>
    360 
    361         <listitem>
    362           <para>
    363             <computeroutput>rg/rh/r</computeroutput>: Print the
    364             guest/hypervisor/current registers
    365           </para>
    366         </listitem>
    367 
    368         <listitem>
    369           <para>
    370             <computeroutput>kg/kh/k</computeroutput>: Print the
    371             guest/hypervisor/current call stack
    372           </para>
    373         </listitem>
    374 
    375         <listitem>
    376           <para>
    377             <computeroutput>da/db/dw/dd/dq</computeroutput>: Print
    378             memory contents as ASCII/bytes/words/dwords/qwords
    379           </para>
    380         </listitem>
    381 
    382         <listitem>
    383           <para>
    384             <computeroutput>u</computeroutput>: Unassemble memory
    385           </para>
    386         </listitem>
    387 
    388         <listitem>
    389           <para>
    390             <computeroutput>dg</computeroutput>: Print the guest's GDT
    391           </para>
    392         </listitem>
    393 
    394         <listitem>
    395           <para>
    396             <computeroutput>di</computeroutput>: Print the guest's IDT
    397           </para>
    398         </listitem>
    399 
    400         <listitem>
    401           <para>
    402             <computeroutput>dl</computeroutput>: Print the guest's LDT
    403           </para>
    404         </listitem>
    405 
    406         <listitem>
    407           <para>
    408             <computeroutput>dt</computeroutput>: Print the guest's TSS
    409           </para>
    410         </listitem>
    411 
    412         <listitem>
    413           <para>
    414             <computeroutput>dp*</computeroutput>: Print the guest's page
    415             table structures
    416           </para>
    417         </listitem>
    418 
    419         <listitem>
    420           <para>
    421             <computeroutput>bp/br</computeroutput>: Set a
    422             normal/recompiler breakpoint
    423           </para>
    424         </listitem>
    425 
    426         <listitem>
    427           <para>
    428             <computeroutput>bl</computeroutput>: List breakpoints
    429           </para>
    430         </listitem>
    431 
    432         <listitem>
    433           <para>
    434             <computeroutput>bc</computeroutput>: Clear a breakpoint
    435           </para>
    436         </listitem>
    437 
    438         <listitem>
    439           <para>
    440             <computeroutput>writecore</computeroutput>: Write a VM core
    441             file to disk. See <xref linkend="ts_guest-core-format" />
     416            <command>stop</command>: Stops the VM execution and enables
     417            single stepping
     418          </para>
     419        </listitem>
     420
     421        <listitem>
     422          <para>
     423            <command>g</command>: Continue VM execution
     424          </para>
     425        </listitem>
     426
     427        <listitem>
     428          <para>
     429            <command>t</command>: Single step an instruction
     430          </para>
     431        </listitem>
     432
     433        <listitem>
     434          <para>
     435            <command>rg</command>, <command>rh</command>, and
     436            <command>r</command>: Print the guest, hypervisor, and
     437            current registers
     438          </para>
     439        </listitem>
     440
     441        <listitem>
     442          <para>
     443            <command>kg</command>, <command>kh</command>, and
     444            <command>k</command>: Print the guest, hypervisor, and
     445            current call stack
     446          </para>
     447        </listitem>
     448
     449        <listitem>
     450          <para>
     451            <command>da</command>, <command>db</command>,
     452            <command>dw</command>, <command>dd</command>,
     453            <command>dq</command>: Print memory contents as ASCII,
     454            bytes, words, dwords, and qwords
     455          </para>
     456        </listitem>
     457
     458        <listitem>
     459          <para>
     460            <command>u</command>: Unassemble memory
     461          </para>
     462        </listitem>
     463
     464        <listitem>
     465          <para>
     466            <command>dg</command>: Print the guest's GDT
     467          </para>
     468        </listitem>
     469
     470        <listitem>
     471          <para>
     472            <command>di</command>: Print the guest's IDT
     473          </para>
     474        </listitem>
     475
     476        <listitem>
     477          <para>
     478            <command>dl</command>: Print the guest's LDT
     479          </para>
     480        </listitem>
     481
     482        <listitem>
     483          <para>
     484            <command>dt</command>: Print the guest's TSS
     485          </para>
     486        </listitem>
     487
     488        <listitem>
     489          <para>
     490            <command>dp*</command>: Print the guest's page table
     491            structures
     492          </para>
     493        </listitem>
     494
     495        <listitem>
     496          <para>
     497            <command>bp</command> and <command>br</command>: Set a
     498            normal and recompiler breakpoint
     499          </para>
     500        </listitem>
     501
     502        <listitem>
     503          <para>
     504            <command>bl</command>: List breakpoints
     505          </para>
     506        </listitem>
     507
     508        <listitem>
     509          <para>
     510            <command>bc</command>: Clear a breakpoint
     511          </para>
     512        </listitem>
     513
     514        <listitem>
     515          <para>
     516            <command>writecore</command>: Write a VM core file to disk.
     517            See <xref linkend="ts_guest-core-format" />
    442518          </para>
    443519        </listitem>
     
    446522
    447523      <para>
    448         See the built-in <computeroutput>help</computeroutput> for other
    449         available commands.
     524        See the built-in <command>help</command> for other available
     525        commands.
    450526      </para>
    451527
     
    459535        the guest OS version, but there are no symbols in the guest's
    460536        memory. Kernel symbols are available in the file
    461         <computeroutput>/proc/kallsyms</computeroutput> on Linux guests.
    462         This file must be copied to the host, for example using
     537        <filename>/proc/kallsyms</filename> on Linux guests. This file
     538        must be copied to the host, for example using
    463539        <command>scp</command>. The <command>loadmap</command> debugger
    464540        command can be used to make the symbol information available to
    465         the VM debugger. Note that the
    466         <computeroutput>kallsyms</computeroutput> file contains the
    467         symbols for the currently loaded modules. If the guest's
    468         configuration changes, the symbols will change as well and must
    469         be updated.
     541        the VM debugger. Note that the <filename>kallsyms</filename>
     542        file contains the symbols for the currently loaded modules. If
     543        the guest's configuration changes, the symbols will change as
     544        well and must be updated.
    470545      </para>
    471546
     
    494569        <listitem>
    495570          <para>
    496             <computeroutput>cfgm</computeroutput>: Print a branch of the
    497             configuration tree
    498           </para>
    499         </listitem>
    500 
    501         <listitem>
    502           <para>
    503             <computeroutput>cpuid</computeroutput>: Display the guest
    504             CPUID leaves
    505           </para>
    506         </listitem>
    507 
    508         <listitem>
    509           <para>
    510             <computeroutput>ioport</computeroutput>: Print registered
    511             I/O port ranges
    512           </para>
    513         </listitem>
    514 
    515         <listitem>
    516           <para>
    517             <computeroutput>mmio</computeroutput>: Print registered MMIO
    518             ranges
    519           </para>
    520         </listitem>
    521 
    522         <listitem>
    523           <para>
    524             <computeroutput>mode</computeroutput> -- print the current
    525             paging mode
    526           </para>
    527         </listitem>
    528 
    529         <listitem>
    530           <para>
    531             <computeroutput>pit</computeroutput>: Print the i8254 PIT
    532             state
    533           </para>
    534         </listitem>
    535 
    536         <listitem>
    537           <para>
    538             <computeroutput>pic</computeroutput>: Print the i8259A PIC
    539             state
    540           </para>
    541         </listitem>
    542 
    543         <listitem>
    544           <para>
    545             <computeroutput>ohci/ehci/xhci</computeroutput>: Print a
    546             subset of the OHCI/EHCI/xHCI USB controller state
    547           </para>
    548         </listitem>
    549 
    550         <listitem>
    551           <para>
    552             <computeroutput>pcnet0</computeroutput>: Print the PCnet
    553             state
    554           </para>
    555         </listitem>
    556 
    557         <listitem>
    558           <para>
    559             <computeroutput>vgatext</computeroutput>: Print the contents
    560             of the VGA framebuffer formatted as standard text mode
    561           </para>
    562         </listitem>
    563 
    564         <listitem>
    565           <para>
    566             <computeroutput>timers</computeroutput>: Print all VM timers
     571            <command>cfgm</command>: Print a branch of the configuration
     572            tree
     573          </para>
     574        </listitem>
     575
     576        <listitem>
     577          <para>
     578            <command>cpuid</command>: Display the guest CPUID leaves
     579          </para>
     580        </listitem>
     581
     582        <listitem>
     583          <para>
     584            <command>ioport</command>: Print registered I/O port ranges
     585          </para>
     586        </listitem>
     587
     588        <listitem>
     589          <para>
     590            <command>mmio</command>: Print registered MMIO ranges
     591          </para>
     592        </listitem>
     593
     594        <listitem>
     595          <para>
     596            <command>mode</command>: Print the current paging mode
     597          </para>
     598        </listitem>
     599
     600        <listitem>
     601          <para>
     602            <command>pit</command>: Print the i8254 PIT state
     603          </para>
     604        </listitem>
     605
     606        <listitem>
     607          <para>
     608            <command>pic</command>: Print the i8259A PIC state
     609          </para>
     610        </listitem>
     611
     612        <listitem>
     613          <para>
     614            <command>ohci</command>, <command>ehci</command>,
     615            <command>xhci</command>: Print a subset of the OHCI, EHCI,
     616            and xHCI USB controller state
     617          </para>
     618        </listitem>
     619
     620        <listitem>
     621          <para>
     622            <command>pcnet0</command>: Print the PCnet state
     623          </para>
     624        </listitem>
     625
     626        <listitem>
     627          <para>
     628            <command>vgatext</command>: Print the contents of the VGA
     629            framebuffer formatted as standard text mode
     630          </para>
     631        </listitem>
     632
     633        <listitem>
     634          <para>
     635            <command>timers</command>: Print all VM timers
    567636          </para>
    568637        </listitem>
     
    593662
    594663      <para>
    595         <ulink
    596       url="http://downloads.openwatcom.org/ftp/devel/docs/elf-64-gen.pdf">http://downloads.openwatcom.org/ftp/devel/docs/elf-64-gen.pdf</ulink>.
     664        <ulink url="http://downloads.openwatcom.org/ftp/devel/docs/elf-64-gen.pdf" />.
    597665      </para>
    598666
     
    628696        The relevant data structures and definitions can be found in the
    629697        &product-name; sources under the following header files:
    630         <computeroutput>include/VBox/dbgfcorefmt.h</computeroutput>,
    631         <computeroutput>include/iprt/x86.h</computeroutput> and
    632         <computeroutput>src/VBox/Runtime/include/internal/ldrELFCommon.h</computeroutput>.
     698        <filename>include/VBox/dbgfcorefmt.h</filename>,
     699        <filename>include/iprt/x86.h</filename> and
     700        <filename>src/VBox/Runtime/include/internal/ldrELFCommon.h</filename>.
    633701      </para>
    634702
    635703      <para>
    636704        The VM core file can be inspected using
    637         <computeroutput>elfdump</computeroutput> and GNU
    638         <computeroutput>readelf</computeroutput> or other similar
    639         utilities.
     705        <command>elfdump</command> and GNU <command>readelf</command> or
     706        other similar utilities.
    640707      </para>
    641708
     
    684751      </para>
    685752
    686 <screen>VBoxManage setextradata "VM name"
    687 "VBoxInternal/Devices/piix3ide/0/LUN#[x]/Config/FlushInterval" [b]</screen>
     753<screen>VBoxManage setextradata <replaceable>VM-name</replaceable>
     754"VBoxInternal/Devices/piix3ide/0/LUN#[<replaceable>x</replaceable>]/Config/FlushInterval" [<replaceable>b</replaceable>]</screen>
    688755
    689756      <para>
     
    691758      </para>
    692759
    693 <screen>VBoxManage setextradata "VM name"
    694 "VBoxInternal/Devices/ahci/0/LUN#[x]/Config/FlushInterval" [b]</screen>
    695 
    696       <para>
    697         The value [x] that selects the disk for IDE is 0 for the master
    698         device on the first channel, 1 for the slave device on the first
    699         channel, 2 for the master device on the second channel or 3 for
    700         the slave device on the second channel. For SATA use values
    701         between 0 and 29. Only disks support this configuration option;
    702         it must not be set for CD/DVD drives.
    703       </para>
    704 
    705       <para>
    706         The unit of the interval [b] is the number of bytes written
    707         since the last flush. The value for it must be selected so that
    708         the occasional long write delays do not occur. Since the proper
    709         flush interval depends on the performance of the host and the
    710         host filesystem, finding the optimal value that makes the
    711         problem disappear requires some experimentation. Values between
    712         1000000 and 10000000 (1 to 10 megabytes) are a good starting
    713         point. Decreasing the interval both decreases the probability of
    714         the problem and the write performance of the guest. Setting the
    715         value unnecessarily low will cost performance without providing
    716         any benefits. An interval of 1 will cause a flush for each write
    717         operation and should solve the problem in any case, but has a
    718         severe write performance penalty.
    719       </para>
    720 
    721       <para>
    722         Providing a value of 0 for [b] is treated as an infinite flush
    723         interval, effectively disabling this workaround. Removing the
    724         extra data key by specifying no value for [b] has the same
    725         effect.
     760<screen>VBoxManage setextradata <replaceable>VM-name</replaceable>
     761"VBoxInternal/Devices/ahci/0/LUN#[<replaceable>x</replaceable>]/Config/FlushInterval" [<replaceable>b</replaceable>]</screen>
     762
     763      <para>
     764        <literal>[<replaceable>x</replaceable>]</literal> specifies the
     765        disk for IDE. <literal>0</literal> represents the master device
     766        on the first channel, <literal>1</literal> represents the slave
     767        device on the first channel, <literal>2</literal> represents the
     768        master device on the second channel, and <literal>3</literal>
     769        represents the slave device on the second channel. For SATA, use
     770        values between <literal>0</literal> and <literal>29</literal>.
     771        This configuration option applies to disks only. Do not use this
     772        option for CD or DVD drives.
     773      </para>
     774
     775      <para>
     776        The unit of the interval
     777        (<literal>[<replaceable>b</replaceable>]</literal>) is the
     778        number of bytes written since the last flush. The value for it
     779        must be selected so that the occasional long write delays do not
     780        occur. Since the proper flush interval depends on the
     781        performance of the host and the host filesystem, finding the
     782        optimal value that makes the problem disappear requires some
     783        experimentation. Values between 1000000 and 10000000 (1 to 10
     784        megabytes) are a good starting point. Decreasing the interval
     785        both decreases the probability of the problem and the write
     786        performance of the guest. Setting the value unnecessarily low
     787        will cost performance without providing any benefits. An
     788        interval of 1 will cause a flush for each write operation and
     789        should solve the problem in any case, but has a severe write
     790        performance penalty.
     791      </para>
     792
     793      <para>
     794        Providing a value of <literal>0</literal> for
     795        <literal>[<replaceable>b</replaceable>]</literal> is treated as
     796        an infinite flush interval, effectively disabling this
     797        workaround. Removing the extra data key by specifying no value
     798        for <literal>[<replaceable>b</replaceable>]</literal> has the
     799        same effect.
    726800      </para>
    727801
     
    744818      </para>
    745819
    746 <screen>VBoxManage setextradata "VM name" "VBoxInternal/Devices/piix3ide/0/LUN#[x]/Config/IgnoreFlush" 0</screen>
    747 
    748       <para>
    749         The value [x] that selects the disk is 0 for the master device
    750         on the first channel, 1 for the slave device on the first
    751         channel, 2 for the master device on the second channel or 3 for
    752         the master device on the second channel.
     820<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxInternal/Devices/piix3ide/0/LUN#[<replaceable>x</replaceable>]/Config/IgnoreFlush" 0</screen>
     821
     822      <para>
     823        <literal>[<replaceable>x</replaceable>]</literal> specifies the
     824        disk. is 0 for the master device on the first channel, 1 for the
     825        slave device on the first channel, 2 for the master device on
     826        the second channel or 3 for the master device on the second
     827        channel.
    753828      </para>
    754829
     
    757832      </para>
    758833
    759 <screen>VBoxManage setextradata "VM name" "VBoxInternal/Devices/ahci/0/LUN#[x]/Config/IgnoreFlush" 0</screen>
     834<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxInternal/Devices/ahci/0/LUN#[x]/Config/IgnoreFlush" 0</screen>
    760835
    761836      <para>
     
    767842        Note that this does not affect the flushes performed according
    768843        to the configuration described in
    769         <xref linkend="ts_config-periodic-flush"
    770       xrefstyle="template: %n" />.
    771         Restoring the default of ignoring flush commands is possible by
    772         setting the value to 1 or by removing the key.
     844        <xref linkend="ts_config-periodic-flush"/>. Restoring the
     845        default of ignoring flush commands is possible by setting the
     846        value to 1 or by removing the key.
    773847      </para>
    774848
     
    780854
    781855      <para>
    782         Many newer multi-core processors support some form of frequency
     856        Many multicore processors support some form of frequency
    783857        boosting, which means that if only one core is utilized, it can
    784858        run possibly 50% faster or even more than the rated CPU
     
    807881        scaling may cause CPU usage reporting to be highly misleading.
    808882        This happens in situations when the host CPU load is significant
    809         but not heavy, such as 15-30% of the maximum.
     883        but not heavy, such as between 15% to 30% of the maximum.
    810884      </para>
    811885
     
    814888        spent, measuring for example how many nanoseconds the systems or
    815889        a process was active within one second. However, in order to
    816         save energy, modern systems can significantly scale down CPU
    817         speed when the system is not fully loaded. Naturally, when the
    818         CPU is running at for example one half of its maximum speed, the
    819         same number of instructions will take roughly twice as long to
    820         execute compared to running at full speed.
     890        save energy, systems can significantly scale down CPU speed when
     891        the system is not fully loaded. When the CPU is running at for
     892        example one half of its maximum speed, the same number of
     893        instructions will take roughly twice as long to execute compared
     894        to running at full speed.
    821895      </para>
    822896
     
    872946        support in the system's BIOS should be disabled, if such a
    873947        setting is available. Not all systems support the C1E power
    874         state. On Intel systems, the <computeroutput>Intel C
    875         State</computeroutput> setting should be disabled. Disabling
    876         other power management settings may also improve performance.
    877         However, a balance between performance and power consumption
    878         must always be considered.
     948        state. On Intel systems, the <literal>Intel C State</literal>
     949        setting should be disabled. Disabling other power management
     950        settings may also improve performance. However, a balance
     951        between performance and power consumption must always be
     952        considered.
    879953      </para>
    880954
     
    897971      </para>
    898972
    899 <screen>VBoxTestOGL --log "log_file_name" --test 2D</screen>
     973<screen>$ VBoxTestOGL --log "log_file_name" --test 2D</screen>
    900974
    901975      <para>
     
    9791053            Changing the storage controller hardware will cause bootup
    9801054            failures as well. This might also apply to you if you copy a
    981             disk image from an older version of &product-name; to a
    982             virtual machine created with a newer &product-name; version.
    983             The default subtype of IDE controller hardware was changed
    984             from PIIX3 to PIIX4 with &product-name; 2.2. Make sure these
    985             settings are identical.
     1055            disk image from an older version of &product-name; to a new
     1056            virtual machine. The default subtype of IDE controller
     1057            hardware used by &product-name; is PIIX4. Make sure that the
     1058            storage controller settings are identical.
    9861059          </para>
    9871060        </listitem>
     
    10051078      <para>
    10061079        According to Microsoft, this is due to a race condition in
    1007         Windows. A hotfix is available. See
    1008         <ulink
    1009           url="http://support.microsoft.com/kb/955076">http://support.microsoft.com/kb/955076</ulink>.
     1080        Windows. A hotfix is available from Microsoft.
    10101081      </para>
    10111082
     
    10431114          <para>
    10441115            Installation complains about a failure installing
    1045             <computeroutput>msgina.dll</computeroutput>.
     1116            <filename>msgina.dll</filename>.
    10461117          </para>
    10471118        </listitem>
     
    10661137      </para>
    10671138
    1068 <screen>VBoxManage setextradata "VM name" "VBoxInternal/Devices/piix3ide/0/Config/IRQDelay" 1</screen>
     1139<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxInternal/Devices/piix3ide/0/Config/IRQDelay" 1</screen>
    10691140
    10701141      <para>
     
    10831154
    10841155      <para>
    1085         When Windows guests run into a kernel crash, they display the
    1086         infamous bluescreen. Depending on how Windows is configured, the
     1156        When Windows guests run into a kernel crash, they display a
     1157        bluescreen error. Depending on how Windows is configured, the
    10871158        information will remain on the screen until the machine is
    10881159        restarted or it will reboot automatically. During installation,
     
    10981169      </para>
    10991170
    1100 <screen>VBoxManage setextradata "VM name" "VBoxInternal/PDM/HaltOnReset" 1</screen>
    1101 
    1102     </sect2>
    1103 
    1104     <sect2 id="ts_pcnet-driver-win-2003-server-guest">
    1105 
    1106       <title>PCnet Driver Failure in 32-bit Windows Server 2003 Guests</title>
    1107 
    1108       <para>
    1109         Certain editions of Windows 2000 and 2003 servers support more
    1110         than 4 GB RAM on 32-bit systems. The AMD PCnet network driver
    1111         shipped with Windows Server 2003 fails to load if the 32-bit
    1112         guest OS uses paging extensions, which will occur with more than
    1113         approximately 3.5 GB RAM assigned to the VM.
    1114       </para>
    1115 
    1116       <para>
    1117         This problem is known to occur with version 4.38.0.0 of the
    1118         PCnet driver. The issue was fixed in version 4.51.0.0 of the
    1119         driver, which is available as a separate download. An
    1120         alternative solution may be changing the emulated NIC type to
    1121         Intel PRO/1000 MT Desktop (82540EM), or reducing the RAM
    1122         assigned to the VM to approximately 3.5 GB or less.
    1123       </para>
     1171<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxInternal/PDM/HaltOnReset" 1</screen>
    11241172
    11251173    </sect2>
     
    11311179      <para>
    11321180        With Windows Vista, Microsoft dropped support for the AMD PCNet
    1133         card that &product-name; used to provide as the default virtual
    1134         network card before version 1.6.0. For Windows Vista guests,
     1181        card that legacy versions of &product-name; used to provide as
     1182        the default virtual network card. For Windows Vista guests,
    11351183        &product-name; now uses an Intel E1000 card by default.
    11361184      </para>
     
    11521200      <para>
    11531201        Several background applications of Windows guests, especially
    1154         virus scanners, are known to increases the CPU load notably even
     1202        virus scanners, are known to increase the CPU load notably even
    11551203        if the guest appears to be idle. We recommend to deactivate
    11561204        virus scanners within virtualized guests if possible.
     
    11681216        the &product-name; shared folders name service. To fix these
    11691217        delays, add the following entries to the file
    1170         <computeroutput>\windows\system32\drivers\etc\lmhosts</computeroutput>
    1171         of the Windows guest:
     1218        <filename>\windows\system32\drivers\etc\lmhosts</filename> of
     1219        the Windows guest:
    11721220      </para>
    11731221
     
    11941242      <para>
    11951243        The USB HID (Human Interface Device) drivers in Windows 98 are
    1196         very old and do not handle tablets the same way as more recent
    1197         operating systems do. For example, Windows 2000 and later, Mac
    1198         OS X, and Oracle Solaris. To work around the problem, use the
     1244        very old and do not handle tablets in the same way as modern
     1245        operating systems do. To work around the problem, use the
    11991246        following command:
    12001247      </para>
    12011248
    1202 <screen>VBoxManage setextradata "VM name" "VBoxInternal/USB/HidMouse/0/Config/CoordShift" 0</screen>
     1249<screen>$ VBoxManage setextradata <replaceable>VM-name</replaceable> "VBoxInternal/USB/HidMouse/0/Config/CoordShift" 0</screen>
    12031250
    12041251      <para>
     
    12161263      <para>
    12171264        If a Windows guest is a member of an Active Directory domain and
    1218         the snapshot feature of &product-name; is used, it could happen
    1219         it loses this status after you restore an older snapshot.
    1220       </para>
    1221 
    1222       <para>
    1223         The reason is the automatic machine password changing performed
     1265        the snapshot feature of &product-name; is used, it could be
     1266        removed from the Active Direcory domain after you restore an
     1267        older snapshot.
     1268      </para>
     1269
     1270      <para>
     1271        This is caused by automatic machine password changes performed
    12241272        by Windows at regular intervals for security purposes. You can
    1225         disable this feature by following the instruction of the
    1226         following article from Microsoft:
    1227         <ulink
    1228           url="http://support.microsoft.com/kb/154501">http://support.microsoft.com/kb/154501</ulink>
    1229       </para>
    1230 
    1231     </sect2>
    1232 
    1233     <sect2 id="ts_d3d8-d3d9-restore">
    1234 
    1235       <title>Restoring d3d8.dll and d3d9.dll</title>
    1236 
    1237       <para>
    1238         &product-name; Guest Additions for Windows prior to 4.1.8 did
    1239         not properly back up the original d3d8.dll and d3d9.dll system
    1240         files when selecting and installing the experimental Direct3D
    1241         support. This process replaces both system files with files from
    1242         the Guest Additions so that Direct3D calls can be handled
    1243         correctly. Although this issue was fixed with &product-name;
    1244         4.1.8, there is no way the Windows Guest Additions installer can
    1245         repair these files.
    1246       </para>
    1247 
    1248       <para>
    1249         Corruption of these files has no implications if 3D acceleration
    1250         is enabled and basic Direct3D support is installed. That is,
    1251         without WDDM on Windows Vista or later, or on older Windows
    1252         systems like Windows XP. With the basic Direct3D support all
    1253         Direct3D 8.0 and Direct3D 9.0 applications will utilize
    1254         &product-name; Direct3D files directly and thus will run as
    1255         expected.
    1256       </para>
    1257 
    1258       <para>
    1259         For WDDM Direct3D support however, the originally shipped
    1260         d3d8.dll and d3d9.dll files are required in order to run
    1261         Direct3D 8.0 and Direct3D 9.0 applications. As a result of the
    1262         above mentioned system files corruption these applications will
    1263         not work anymore. See below for a step-by-step guide for
    1264         restoring the original d3d8.dll and d3d9.dll system files in
    1265         case the &product-name; Guest Additions installer warned about
    1266         those incorrect files or when having trouble running Direct3D
    1267         applications.
    1268       </para>
    1269 
    1270       <note>
    1271         <para>
    1272           Starting at Windows 7 the 3D desktop, called Aero, uses
    1273           DirectX 10 for rendering so that corrupted d3d8.dll and
    1274           d3d9.dll system files will have no effect on the actual
    1275           rendering.
    1276         </para>
    1277       </note>
    1278 
    1279       <para>
    1280         This is why such a detected file corruption is not considered as
    1281         fatal for the basic Direct3D installation on all supported
    1282         Windows guests, and for WDDM Direct3D installation on Windows 7
    1283         and later guests.
    1284       </para>
    1285 
    1286       <para>
    1287         <emphasis role="bold">Extracting d3d8 and d3d9.dll from a
    1288         Windows XP installation CD:</emphasis>
    1289       </para>
    1290 
    1291       <orderedlist>
    1292 
    1293         <listitem>
    1294           <para>
    1295             Download and install the latest version of 7-Zip File
    1296             Manager.
    1297           </para>
    1298         </listitem>
    1299 
    1300         <listitem>
    1301           <para>
    1302             Browse into the installation CD. For example E:\i386, or
    1303             E:\amd64 for the 64-bit version.
    1304           </para>
    1305         </listitem>
    1306 
    1307         <listitem>
    1308           <para>
    1309             Locate the entries d3d8.dl_ and d3d9.dl_. Double-click on
    1310             the file names and extract d3d8.dll and d3d9.dll.
    1311           </para>
    1312         </listitem>
    1313 
    1314         <listitem>
    1315           <para>
    1316             Reboot Windows in Safe mode.
    1317           </para>
    1318         </listitem>
    1319 
    1320         <listitem>
    1321           <para>
    1322             Copy the extracted d3d8.dll and d3d9.dll files to
    1323             C:\Windows\system32 and C:\Windows\system32\dllcache.
    1324           </para>
    1325         </listitem>
    1326 
    1327         <listitem>
    1328           <para>
    1329             Reboot Windows.
    1330           </para>
    1331         </listitem>
    1332 
    1333       </orderedlist>
    1334 
    1335       <para>
    1336         <emphasis role="bold">Extracting d3d8 and d3d9.dll from a
    1337         Windows XP Service pack:</emphasis>
    1338       </para>
    1339 
    1340       <orderedlist>
    1341 
    1342         <listitem>
    1343           <para>
    1344             Download and install the latest version of 7-Zip File
    1345             Manager.
    1346           </para>
    1347         </listitem>
    1348 
    1349         <listitem>
    1350           <para>
    1351             Choose Open Inside, to open WindowsXP-KB936929-SP3-x86.exe
    1352             as an archive and browse the i386 directory.
    1353           </para>
    1354         </listitem>
    1355 
    1356         <listitem>
    1357           <para>
    1358             Locate the entries d3d8.dl_ and d3d9.dl_. Double-click on
    1359             the file names and extract d3d8.dll and d3d9.dll.
    1360           </para>
    1361         </listitem>
    1362 
    1363         <listitem>
    1364           <para>
    1365             Reboot Windows in Safe mode.
    1366           </para>
    1367         </listitem>
    1368 
    1369         <listitem>
    1370           <para>
    1371             Copy the extracted d3d8.dll and d3d9.dll files to
    1372             C:\Windows\system32 and C:\Windows\system32\dllcache.
    1373           </para>
    1374         </listitem>
    1375 
    1376         <listitem>
    1377           <para>
    1378             Reboot Windows.
    1379           </para>
    1380         </listitem>
    1381 
    1382       </orderedlist>
    1383 
    1384       <para>
    1385         <emphasis role="bold">Extracting d3d8 and d3d9.dll from a
    1386         Vista/Windows7 installation CD or Service Pack ISO:</emphasis>
    1387       </para>
    1388 
    1389       <orderedlist>
    1390 
    1391         <listitem>
    1392           <para>
    1393             Download and install the latest version of 7-Zip File
    1394             Manager.
    1395           </para>
    1396         </listitem>
    1397 
    1398         <listitem>
    1399           <para>
    1400             Browse into the installation CD. For example E:\sources.
    1401           </para>
    1402         </listitem>
    1403 
    1404         <listitem>
    1405           <para>
    1406             Locate file install.wim and double-click the file. After the
    1407             7-Zip utility unzips the file, you will see a few numbered
    1408             folders. Each numeric subfolder represents a different
    1409             version of Windows such as Starter or Home Basic.
    1410           </para>
    1411         </listitem>
    1412 
    1413         <listitem>
    1414           <para>
    1415             Open one of the numeric folders and browse to the
    1416             Windows\System32 directory, or C:\Windows\SysWOW64 for the
    1417             64-bit version. Locate and extract the d3d8.dll and d3d9.dll
    1418             files.
    1419           </para>
    1420         </listitem>
    1421 
    1422         <listitem>
    1423           <para>
    1424             Copy extracted the d3d8.dll and d3d9.dll files to
    1425             C:\Windows\system32 or C:\Windows\SysWOW64. Files from
    1426             system32 should go to system32, from SysWOW64 to SysWOW64.
    1427           </para>
    1428         </listitem>
    1429 
    1430         <listitem>
    1431           <para>
    1432             Reboot Windows.
    1433           </para>
    1434         </listitem>
    1435 
    1436       </orderedlist>
     1273        disable this feature as shown in the following article from
     1274        Microsoft:
     1275        <ulink url="http://support.microsoft.com/kb/154501" />.
     1276      </para>
    14371277
    14381278    </sect2>
     
    14521292
    14531293      <para>
    1454         This is a HIMEM.SYS limitation documented by Microsoft in
    1455         Knowledge base article KB 116256. Windows 3.1 memory limits are
    1456         described in detail in Microsoft Knowledge base article KB
     1294        This is a known HIMEM.SYS limitation. Windows 3.1 memory limits
     1295        are described in detail in Microsoft Knowledge base article KB
    14571296        84388.
    14581297      </para>
     
    14871326
    14881327      <para>
    1489         Linux kernels shipped with Red Hat Enterprise Linux (RHEL) as of
    1490         release 4.7 and 5.1 as well as kernels of related Linux
    1491         distributions, such as CentOS and Oracle Linux, support a kernel
    1492         parameter <emphasis>divider=N</emphasis>. Hence, such kernels
    1493         support a lower timer frequency without recompilation. We
    1494         suggest you add the kernel parameter
    1495         <emphasis>divider=10</emphasis> to select a guest kernel timer
    1496         frequency of 100Hz.
    1497       </para>
    1498 
    1499     </sect2>
    1500 
    1501     <sect2 id="ts_linux-guest-amd-barcelona">
    1502 
    1503       <title>AMD Barcelona CPUs</title>
    1504 
    1505       <para>
    1506         Most Linux-based guests will fail with AMD Phenoms or
    1507         Barcelona-level Opterons due to a bug in the Linux kernel.
    1508         Enable the I/O-APIC to work around the problem. See
    1509         <xref
    1510       linkend="settings-system" />.
     1328        Linux kernels shipped with Red Hat Enterprise Linux, as well as
     1329        kernels of related Linux distributions, such as CentOS and
     1330        Oracle Linux, support a kernel parameter
     1331        <emphasis>divider=N</emphasis>. Hence, such kernels support a
     1332        lower timer frequency without recompilation. We suggest you add
     1333        the kernel parameter <emphasis>divider=10</emphasis> to select a
     1334        guest kernel timer frequency of 100Hz.
    15111335      </para>
    15121336
     
    15451369            If you see this message, either disable hardware
    15461370            virtualization or the I/O APIC as described in
    1547             <xref
    1548             linkend="settings-system" />, or upgrade
    1549             the guest to a newer kernel.
     1371            <xref linkend="settings-system" />, or upgrade the guest to
     1372            a newer kernel.
    15501373          </para>
    15511374
    15521375          <para>
    15531376            See
    1554             <ulink
    1555                 url="http://www.mail-archive.com/[email protected]/msg30813.html">http://www.mail-archive.com/[email protected]/msg30813.html</ulink>
     1377            <ulink url="http://www.mail-archive.com/[email protected]/msg30813.html" />
    15561378            for details about the kernel fix.
    15571379          </para>
     
    15691391        Guest desktop services in guests running the X11 window system
    15701392        such as Oracle Solaris and Linux, are provided by a guest
    1571         service called <computeroutput>VBoxClient</computeroutput>,
    1572         which runs under the ID of the user who started the desktop
    1573         session and is automatically started using the following command
    1574         lines when your X11 user session is started if you are using a
    1575         common desktop environment such as Gnome or KDE.
    1576       </para>
    1577 
    1578 <screen>VBoxClient --clipboard
    1579 VBoxClient --display
    1580 VBoxClient --seamless</screen>
     1393        service called <command>VBoxClient</command>, which runs under
     1394        the ID of the user who started the desktop session and is
     1395        automatically started using the following command lines when
     1396        your X11 user session is started if you are using a common
     1397        desktop environment such as Gnome or KDE.
     1398      </para>
     1399
     1400<screen>$ VBoxClient --clipboard
     1401$ VBoxClient --display
     1402$ VBoxClient --seamless</screen>
    15811403
    15821404      <para>
     
    15871409
    15881410      <para>
    1589         The <computeroutput>VBoxClient</computeroutput> processes create
    1590         files in the user's home directory with names of the form
    1591         <computeroutput>.vboxclient-*.pid</computeroutput> when they are
    1592         running in order to prevent a given service from being started
    1593         twice. It can happen due to misconfiguration that these files
    1594         are created owned by root and not deleted when the services are
    1595         stopped, which will prevent them from being started in future
    1596         sessions. If the services cannot be started, you may wish to
    1597         check whether these files still exist.
     1411        The <command>VBoxClient</command> processes create files in the
     1412        user's home directory with names of the form
     1413        <filename>.vboxclient-*.pid</filename> when they are running in
     1414        order to prevent a given service from being started twice. It
     1415        can happen due to misconfiguration that these files are created
     1416        owned by root and not deleted when the services are stopped,
     1417        which will prevent them from being started in future sessions.
     1418        If the services cannot be started, you may wish to check whether
     1419        these files still exist.
    15981420      </para>
    15991421
     
    16061428    <title>Oracle Solaris Guests</title>
    16071429
    1608     <sect2 id="ts_solaris-10-guest-crash">
    1609 
    1610       <title>Older Oracle Solaris 10 Releases Crash in 64-bit Mode</title>
    1611 
    1612       <para>
    1613         Oracle Solaris 10 releases up to and including Oracle Solaris 10
    1614         8/07 incorrectly detect newer Intel processors produced since
    1615         2007. This problem leads to the 64-bit Oracle Solaris kernel
    1616         crashing, and usually causing a triple fault, almost immediately
    1617         during startup, in both virtualized and physical environments.
    1618       </para>
    1619 
    1620       <para>
    1621         The recommended solution is upgrading to at least Oracle Solaris
    1622         10 5/08. Alternative solutions include forcing Oracle Solaris to
    1623         always boot the 32-bit kernel or applying a patch for bug
    1624         6574102 while Oracle Solaris is using the 32-bit kernel.
    1625       </para>
    1626 
    1627     </sect2>
    1628 
    16291430    <sect2 id="ts_solaris-10-guest-slow-boot-smp">
    16301431
     
    16321433
    16331434      <para>
    1634         When using more than one CPU, Oracle Solaris 10 5/08, Oracle
    1635         Solaris 10 10/08, and Oracle Solaris 10 5/09 may take a long
    1636         time to boot and may print warnings on the system console
    1637         regarding failures to read from disk. This is a bug in Oracle
    1638         Solaris 10 which affects specific physical and virtual
    1639         configurations. It is caused by trying to read microcode updates
    1640         from the boot disk when the disk interrupt is reassigned to a
    1641         not yet fully initialized secondary CPU. Disk reads will time
    1642         out and fail, triggering delays of about 45 seconds and
    1643         warnings.
     1435        When using more than one CPU, Oracle Solaris 10 10/08, and
     1436        Oracle Solaris 10 5/09 may take a long time to boot and may
     1437        print warnings on the system console regarding failures to read
     1438        from disk. This is a bug in Oracle Solaris 10 which affects
     1439        specific physical and virtual configurations. It is caused by
     1440        trying to read microcode updates from the boot disk when the
     1441        disk interrupt is reassigned to a not yet fully initialized
     1442        secondary CPU. Disk reads will time out and fail, triggering
     1443        delays of about 45 seconds and warnings.
    16441444      </para>
    16451445
     
    16491449        solutions include restricting the number of virtual CPUs to one
    16501450        or possibly using a different storage controller.
    1651       </para>
    1652 
    1653     </sect2>
    1654 
    1655     <sect2 id="ts_solaris-8-guest-crash">
    1656 
    1657       <title>Solaris 8 5/01 and Earlier May Crash on Startup</title>
    1658 
    1659       <para>
    1660         Solaris 2.6, 7 and 8 releases up to and including Solaris 8 4/01
    1661         ("S8U4") incorrectly set up Machine Check Exception (MCE) MSRs
    1662         on Pentium 4 and some later Intel CPUs. The problem leads to the
    1663         Solaris kernel crashing, and usually causing a triple fault,
    1664         almost immediately during startup, in both virtualized and
    1665         physical environments. Solaris 9 and later releases are not
    1666         affected by this problem, and neither is Solaris 2.5.1 and
    1667         earlier.
    1668       </para>
    1669 
    1670       <para>
    1671         The recommended solution is upgrading to at least Solaris 8 7/01
    1672         ("S8U5"). Alternative solutions include applying a patch for
    1673         bugs 4408508 and 4414557 on an unaffected system.
    1674       </para>
    1675 
    1676     </sect2>
    1677 
    1678   </sect1>
    1679 
    1680   <sect1 id="ts_fbsd-guests">
    1681 
    1682     <title>FreeBSD Guests</title>
    1683 
    1684     <sect2 id="ts_fbsd-guest-xhci">
    1685 
    1686       <title>FreeBSD 10.0 May Hang with xHCI</title>
    1687 
    1688       <para>
    1689         If xHCI (USB 3.0) emulation is enabled for FreeBSD 10.0 guests,
    1690         the guest OS will hang. This is caused by the guest OS
    1691         incorrectly handling systems where Message Signaled Interrupts
    1692         (MSIs) are not used with the xHCI device.
    1693       </para>
    1694 
    1695       <para>
    1696         The problem does not exist in earlier FreeBSD releases and was
    1697         fixed in FreeBSD 10.1.
    16981451      </para>
    16991452
     
    17171470        interface options based on a common architecture. All global
    17181471        status information and configuration is maintained by the
    1719         process <computeroutput>VBoxSVC.exe</computeroutput>, which is
    1720         an out-of-process COM server. Whenever an &product-name; process
    1721         is started, it requests access to the COM server and Windows
     1472        process <filename>VBoxSVC.exe</filename>, which is an
     1473        out-of-process COM server. Whenever an &product-name; process is
     1474        started, it requests access to the COM server and Windows
    17221475        automatically starts the process. Note that it should never be
    17231476        started by the end user.
     
    17271480        When the last process disconnects from the COM server, it will
    17281481        terminate itself after some seconds. The &product-name;
    1729         configuration (XML files) is maintained and owned by the COM
     1482        configuration XML files are maintained and owned by the COM
    17301483        server and the files are locked whenever the server runs.
    17311484      </para>
     
    17391492        subsequently other processes fail to initialize it. In these
    17401493        situations, it is recommended to use the Windows task manager to
    1741         kill the process <computeroutput>VBoxSVC.exe</computeroutput>.
     1494        kill the process <filename>VBoxSVC.exe</filename>.
    17421495      </para>
    17431496
     
    17461499    <sect2 id="ts_win-host-cd-dvd-changes">
    17471500
    1748       <title>CD/DVD Changes Not Recognized</title>
    1749 
    1750       <para>
    1751         In case you have assigned a physical CD/DVD drive to a guest and
    1752         the guest does not notice when the medium changes, make sure
     1501      <title>CD and DVD Changes Not Recognized</title>
     1502
     1503      <para>
     1504        In case you have assigned a physical CD or DVD drive to a guest
     1505        and the guest does not notice when the medium changes, make sure
    17531506        that the Windows media change notification (MCN) feature is not
    17541507        turned off. This is represented by the following key in the
     
    18191572
    18201573      <para>
    1821         Setting the environment variable
    1822         <computeroutput>VBOX_DISABLE_HOST_DISK_CACHE</computeroutput> to
    1823         1 will enable a workaround for this problem until Microsoft
    1824         addresses the issue. For example, open a command prompt window
    1825         and start &product-name; like this:
     1574        Setting the <literal>VBOX_DISABLE_HOST_DISK_CACHE</literal>
     1575        environment variable to <literal>1</literal> enables a
     1576        workaround for this problem until Microsoft addresses the issue.
     1577        For example, open a command prompt window and start
     1578        &product-name; like this:
    18261579      </para>
    18271580
     
    18551608            The maximum allowed filter count was reached on the host. In
    18561609            this case, the MSI log would mention the
    1857             <computeroutput>0x8004a029</computeroutput> error code
    1858             returned on NetFlt network component install, as follows:
     1610            <literal>0x8004a029</literal> error code returned on NetFlt
     1611            network component install, as follows:
    18591612          </para>
    18601613
     
    18761629        <listitem>
    18771630          <para>
    1878             The INF cache is corrupt. In this case, the install log
    1879             (<computeroutput>%windir%\inf\setupapi.log</computeroutput>
    1880             on XP or
    1881             <computeroutput>%windir%\inf\setupapi.dev.log</computeroutput>
    1882             on Vista or later) would typically mention the failure to
    1883             find a suitable driver package for either the
    1884             <computeroutput>sun_VBoxNetFlt</computeroutput> or
    1885             <computeroutput>sun_VBoxNetFltmp</computeroutput>
    1886             components. The solution then is to uninstall
    1887             &product-name;, remove the INF cache
    1888             (<computeroutput>%windir%\inf\INFCACHE.1</computeroutput>),
    1889             reboot and try to reinstall &product-name;.
     1631            The INF cache is corrupt. In this case, the install log at
     1632            <filename>%windir%\inf\setupapi.dev.log</filename> would
     1633            typically mention the failure to find a suitable driver
     1634            package for either the <command>sun_VBoxNetFlt</command> or
     1635            <command>sun_VBoxNetFltmp</command> components. The solution
     1636            then is to uninstall &product-name;, remove the INF cache
     1637            (<filename>%windir%\inf\INFCACHE.1</filename>), reboot and
     1638            try to reinstall &product-name;.
    18901639          </para>
    18911640        </listitem>
     
    19031652        VirtualBox Manager or the <command>VBoxManage</command> command,
    19041653        then the INF cache is probably corrupt. In this case, the
    1905         install log
    1906         (<computeroutput>%windir%\inf\setupapi.log</computeroutput> on
    1907         Windows XP or
    1908         <computeroutput>%windir%\inf\setupapi.dev.log</computeroutput>
    1909         on Windows Vista or later) would typically mention the failure
    1910         to find a suitable driver package for the
    1911         <computeroutput>sun_VBoxNetAdp</computeroutput> component.
    1912         Again, as with the bridged networking problem described above,
    1913         the solution is to uninstall &product-name;, remove the INF
    1914         cache
    1915         (<computeroutput>%windir%\inf\INFCACHE.1</computeroutput>),
    1916         reboot and try to reinstall &product-name;.
     1654        install log at
     1655        <filename>%windir%\inf\setupapi.dev.log</filename> would
     1656        typically mention the failure to find a suitable driver package
     1657        for the <filename>sun_VBoxNetAdp</filename> component. Again, as
     1658        with the bridged networking problem described above, the
     1659        solution is to uninstall &product-name;, remove the INF cache
     1660        (<filename>%windir%\inf\INFCACHE.1</filename>), reboot and try
     1661        to reinstall &product-name;.
    19171662      </para>
    19181663
     
    19301675
    19311676      <para>
    1932         If the &product-name; kernel module,
    1933         <computeroutput>vboxdrv</computeroutput>, refuses to load you
    1934         may see an "Error inserting vboxdrv: Invalid argument" message.
    1935         As root, check the output of the <command>dmesg</command>
    1936         command to find out why the load failed. Most probably the
    1937         kernel disagrees with the version of <command>gcc</command> used
    1938         to compile the module. Make sure that you use the same compiler
    1939         as used to build the kernel.
     1677        If the &product-name; kernel module, <command>vboxdrv</command>,
     1678        refuses to load you may see an <literal>Error inserting vboxdrv:
     1679        Invalid argument</literal> message. As root, check the output of
     1680        the <command>dmesg</command> command to find out why the load
     1681        failed. Most probably the kernel disagrees with the version of
     1682        <command>gcc</command> used to compile the module. Make sure
     1683        that you use the same compiler that was used to build the
     1684        kernel.
    19401685      </para>
    19411686
     
    19441689    <sect2 id="ts_linux-host-cd-dvd-not-found">
    19451690
    1946       <title>Linux Host CD/DVD Drive Not Found</title>
    1947 
    1948       <para>
    1949         If you have configured a virtual machine to use the host's
    1950         CD/DVD drive, but this does not appear to work, make sure that
    1951         the current user has permission to access the corresponding
    1952         Linux device file. This is
    1953         <computeroutput>/dev/hdc</computeroutput>,
    1954         <computeroutput>/dev/scd0</computeroutput>,
    1955         <computeroutput>/dev/cdrom</computeroutput> or similar. On most
    1956         distributions, the user must be added to a corresponding group,
    1957         usually called <computeroutput>cdrom</computeroutput> or
    1958         <computeroutput>cdrw</computeroutput>.
    1959       </para>
    1960 
    1961     </sect2>
    1962 
    1963     <sect2 id="ts_linux-host-cd-dvd-not-found-legacy">
    1964 
    1965       <title>Linux Host CD/DVD Drive Not Found (Older Distributions)</title>
    1966 
    1967       <para>
    1968         On older Linux distributions, if your CD/DVD device has a
    1969         different name, &product-name; may be unable to find it. On
    1970         older Linux hosts, &product-name; performs the following steps
    1971         to locate your CD/DVD drives:
    1972       </para>
    1973 
    1974       <orderedlist>
    1975 
    1976         <listitem>
    1977           <para>
    1978             &product-name; checks if the environment variable
    1979             <computeroutput>VBOX_CDROM</computeroutput> is defined. If
    1980             so, &product-name; omits all the following checks.
    1981           </para>
    1982         </listitem>
    1983 
    1984         <listitem>
    1985           <para>
    1986             &product-name; tests if
    1987             <computeroutput>/dev/cdrom</computeroutput> works.
    1988           </para>
    1989         </listitem>
    1990 
    1991         <listitem>
    1992           <para>
    1993             &product-name; checks if any CD/DVD drives are currently
    1994             mounted by checking
    1995             <computeroutput>/etc/mtab</computeroutput>.
    1996           </para>
    1997         </listitem>
    1998 
    1999         <listitem>
    2000           <para>
    2001             &product-name; checks if any of the entries in
    2002             <computeroutput>/etc/fstab</computeroutput> point to CD/DVD
    2003             devices.
    2004           </para>
    2005         </listitem>
    2006 
    2007       </orderedlist>
    2008 
    2009       <para>
    2010         You can set the VBOX_CDROM environment variable to contain a
    2011         list of your CD/DVD devices, separated by colons. For example:
    2012       </para>
    2013 
    2014 <screen>export VBOX_CDROM='/dev/cdrom0:/dev/cdrom1'</screen>
    2015 
    2016       <para>
    2017         On modern Linux distributions, &product-name; uses the hardware
    2018         abstraction layer (HAL) to locate CD and DVD hardware.
    2019       </para>
    2020 
    2021     </sect2>
    2022 
    2023     <sect2 id="ts_linux-host-floppy-not-found">
    2024 
    2025       <title>Linux Host Floppy Not Found</title>
    2026 
    2027       <para>
    2028         <xref linkend="ts_linux-host-cd-dvd-not-found-legacy"/> appplies
    2029         also to floppy disks, except that on older distributions
    2030         &product-name; tests for
    2031         <computeroutput>/dev/fd*</computeroutput> devices by default.
    2032         This can be overridden with the
    2033         <computeroutput>VBOX_FLOPPY</computeroutput> environment
    2034         variable.
     1691      <title>Linux Host CD/DVD or Floppy Disk Drive Not Found</title>
     1692
     1693      <para>
     1694        If you have configured a virtual machine to use the host's CD or
     1695        DVD drive or floppy disk drive, but this does not appear to
     1696        work, make sure that the current user has permission to access
     1697        the corresponding Linux device file. For example, for a CD or
     1698        DVD drive this may be <filename>/dev/hdc</filename>,
     1699        <filename>/dev/scd0</filename>, <filename>/dev/cdrom</filename>
     1700        or similar. On most distributions, the user must be added to a
     1701        corresponding group, usually called <command>cdrom</command> or
     1702        <command>cdrw</command> or <command>floppy</command>.
     1703      </para>
     1704
     1705      <para>
     1706        On supported Linux distributions, &product-name; uses
     1707        <command>udev</command> to locate hardware such as CD/DVD drives
     1708        and floppy disk drives.
    20351709      </para>
    20361710
     
    20391713    <sect2 id="ts_linux-host-ide-messages">
    20401714
    2041       <title>Strange Guest IDE Error Messages When Writing to CD/DVD</title>
    2042 
    2043       <para>
    2044         If the experimental CD/DVD writer support is enabled with an
    2045         incorrect &product-name;, host or guest configuration, it is
    2046         possible that any attempt to access the CD/DVD writer fails and
    2047         simply results in guest kernel error messages for Linux guests
    2048         or application error messages for Windows guests. &product-name;
    2049         performs the usual consistency checks when a VM is powered up.
    2050         In particular, it aborts with an error message if the device for
    2051         the CD/DVD writer is not writable by the user starting the VM.
    2052         But &product-name; cannot detect all misconfigurations. The
     1715      <title>Strange Guest IDE Error Messages When Writing to CD or DVD</title>
     1716
     1717      <para>
     1718        If the experimental CD or DVD writer support is enabled with an
     1719        incorrect host or guest configuration, it is possible that any
     1720        attempt to access the CD or DVD writer fails and simply results
     1721        in guest kernel error messages for Linux guests or application
     1722        error messages for Windows guests. &product-name; performs the
     1723        usual consistency checks when a VM is powered up. In particular,
     1724        it aborts with an error message if the device for the CD or DVD
     1725        writer is not writable by the user starting the VM. But
     1726        &product-name; cannot detect all misconfigurations. The
    20531727        necessary host and guest OS configuration is not specific for
    20541728        &product-name;, but a few frequent problems are listed here
     
    20581732      <para>
    20591733        Special care must be taken to use the correct device. The
    2060         configured host CD/DVD device file name, in most cases
    2061         <computeroutput>/dev/cdrom</computeroutput>, must point to the
    2062         device that allows writing to the CD/DVD unit. For CD/DVD writer
    2063         units connected to a SCSI controller or to a IDE controller that
     1734        configured host CD or DVD device file name, in most cases
     1735        <filename>/dev/cdrom</filename>, must point to the device that
     1736        allows writing to the CD or DVD unit. For CD or DVD writer units
     1737        connected to a SCSI controller or to a IDE controller that
    20641738        interfaces to the Linux SCSI subsystem, common for some SATA
    20651739        controllers, this must refer to the SCSI device node, such as
    2066         <computeroutput>/dev/scd0</computeroutput>. Even for IDE CD/DVD
    2067         writer units this must refer to the appropriate SCSI CD-ROM
    2068         device node, such as <computeroutput>/dev/scd0</computeroutput>,
    2069         if the <computeroutput>ide-scsi</computeroutput> kernel module
    2070         is loaded. This module is required for CD/DVD writer support
    2071         with all Linux 2.4 kernels and some early 2.6 kernels. Many
    2072         Linux distributions load this module whenever a CD/DVD writer is
    2073         detected in the system, even if the kernel would support CD/DVD
    2074         writers without the module. &product-name; supports the use of
    2075         IDE device files, such as
    2076         <computeroutput>/dev/hdc</computeroutput>, provided the kernel
    2077         supports this and the <computeroutput>ide-scsi</computeroutput>
    2078         module is not loaded.
    2079       </para>
    2080 
    2081       <para>
    2082         Similar rules, except that within the guest the CD/DVD writer is
    2083         always an IDE device, apply to the guest configuration. Since
     1740        <filename>/dev/scd0</filename>. Even for IDE CD or DVD writer
     1741        units this must refer to the appropriate SCSI CD-ROM device
     1742        node, such as <filename>/dev/scd0</filename>, if the
     1743        <command>ide-scsi</command> kernel module is loaded. This module
     1744        is required for CD or DVD writer support with some early 2.6
     1745        kernels. Many Linux distributions load this module whenever a CD
     1746        or DVD writer is detected in the system, even if the kernel
     1747        would support CD or DVD writers without the module.
     1748        &product-name; supports the use of IDE device files, such as
     1749        <filename>/dev/hdc</filename>, provided the kernel supports this
     1750        and the <command>ide-scsi</command> module is not loaded.
     1751      </para>
     1752
     1753      <para>
     1754        Similar rules, except that within the guest the CD or DVD writer
     1755        is always an IDE device, apply to the guest configuration. Since
    20841756        this setup is very common, it is likely that the default
    20851757        configuration of the guest works as expected.
     
    20961768        Mozilla XPCOM (cross platform component object model) for
    20971769        interprocess and intraprocess communication (IPC). The process
    2098         <computeroutput>VBoxSVC</computeroutput> serves as a
    2099         communication hub between different &product-name; processes and
    2100         maintains the global configuration, such as the XML database.
    2101         When starting an &product-name; component, the processes
    2102         <computeroutput>VBoxSVC</computeroutput> and
    2103         <computeroutput>VBoxXPCOMIPCD</computeroutput> are started
    2104         automatically. They are only accessible from the user account
    2105         they are running under. <computeroutput>VBoxSVC</computeroutput>
     1770        <command>VBoxSVC</command> serves as a communication hub between
     1771        different &product-name; processes and maintains the global
     1772        configuration, such as the XML database. When starting an
     1773        &product-name; component, the processes
     1774        <command>VBoxSVC</command> and <command>VBoxXPCOMIPCD</command>
     1775        are started automatically. They are only accessible from the
     1776        user account they are running under. <command>VBoxSVC</command>
    21061777        owns the &product-name; configuration database which normally
    2107         resides in
    2108         <computeroutput>~/.config/VirtualBox</computeroutput>, or the
     1778        resides in <filename>~/.config/VirtualBox</filename>, or the
    21091779        appropriate configuration directory for your operating system.
    21101780        While it is running, the configuration files are locked.
    21111781        Communication between the various &product-name; components and
    2112         <computeroutput>VBoxSVC</computeroutput> is performed through a
    2113         local domain socket residing in
    2114         <computeroutput>/tmp/.vbox-&lt;username&gt;-ipc</computeroutput>.
     1782        <command>VBoxSVC</command> is performed through a local domain
     1783        socket residing in
     1784        <filename>/tmp/.vbox-<replaceable>username</replaceable>-ipc</filename>.
    21151785        In case there are communication problems, such as an
    21161786        &product-name; application cannot communicate with
    2117         <computeroutput>VBoxSVC</computeroutput>, terminate the daemons
    2118         and remove the local domain socket directory.
     1787        <command>VBoxSVC</command>, terminate the daemons and remove the
     1788        local domain socket directory.
    21191789      </para>
    21201790
     
    21271797      <para>
    21281798        If USB is not working on your Linux host, make sure that the
    2129         current user is a member of the
    2130         <computeroutput>vboxusers</computeroutput> group. Please keep in
    2131         mind that group membership does not take effect immediately but
    2132         rather at the next login. If available, the
    2133         <command>newgrp</command> command may avoid the need for a
     1799        current user is a member of the <literal>vboxusers</literal>
     1800        group. Please keep in mind that group membership does not take
     1801        effect immediately but rather at the next login. If available,
     1802        the <command>newgrp</command> command may avoid the need for a
    21341803        logout and login.
    21351804      </para>
     
    21431812      <para>
    21441813        Linux kernels including the grsec patch, see
    2145         <ulink
    2146       url="http://www.grsecurity.net/">http://www.grsecurity.net/</ulink>,
    2147         and derivates have to disable PAX_MPROTECT for the VBox binaries
    2148         to be able to start a VM. The reason is that VBox has to create
    2149         executable code on anonymous memory.
     1814        <ulink url="http://www.grsecurity.net/" />, and derivates have
     1815        to disable PAX_MPROTECT for the <command>VBox</command> binaries
     1816        to be able to start a VM. The reason is that &product-name; has
     1817        to create executable code on anonymous memory.
    21501818      </para>
    21511819
     
    21611829        fail to start with a kernel error saying that the vmalloc pool
    21621830        is exhausted and should be extended. The error message also
    2163         tells you to specify
    2164         <computeroutput>vmalloc=256MB</computeroutput> in your kernel
    2165         parameter list. If adding this parameter to your GRUB or LILO
    2166         configuration makes the kernel fail to boot, with an error
    2167         message such as "failed to mount the root partition", then you
    2168         have probably run into a memory conflict of your kernel and
    2169         initial RAM disk. This can be solved by adding the following
    2170         parameter to your GRUB configuration:
     1831        tells you to specify <literal>vmalloc=256MB</literal> in your
     1832        kernel parameter list. If adding this parameter to your GRUB or
     1833        LILO configuration makes the kernel fail to boot, with an error
     1834        message such as <literal>failed to mount the root
     1835        partition</literal>, then you have probably run into a memory
     1836        conflict of your kernel and initial RAM disk. This can be solved
     1837        by adding the following parameter to your GRUB configuration:
    21711838      </para>
    21721839
     
    21901857        lead to a heavy fragmentation of the host memory preventing
    21911858        &product-name; VMs from being started. We recommend to limit the
    2192         ZFS cache by adding the following line to /etc/system, where
    2193         <computeroutput>xxxx</computeroutput> bytes is the amount of
    2194         memory usable for the ZFS cache.
     1859        ZFS cache by adding the following line to
     1860        <filename>/etc/system</filename>, where
     1861        <replaceable>xxxx</replaceable> bytes is the amount of memory
     1862        usable for the ZFS cache.
    21951863      </para>
    21961864
     
    21991867    </sect2>
    22001868
    2201     <sect2 id="ts_sol-host-swap-space">
    2202 
    2203       <title>VM Aborts With Out of Memory Errors on Oracle Solaris 10 Hosts</title>
    2204 
    2205       <para>
    2206         32-bit Oracle Solaris 10 hosts (bug 1225025) require swap space
    2207         equal to, or greater than the host's physical memory size. For
    2208         example, 8 GB physical memory would require at least 8 GB swap.
    2209         This can be configured during an Oracle Solaris 10 install by
    2210         choosing a Custom Install and changing the default partitions.
    2211       </para>
    2212 
    2213       <note>
    2214         <para>
    2215           This restriction applies only to 32-bit Oracle Solaris hosts,
    2216           64-bit hosts are not affected.
    2217         </para>
    2218       </note>
    2219 
    2220       <para>
    2221         For existing Oracle Solaris 10 installs, an additional swap
    2222         image needs to be mounted and used as swap. Hence if you have 1
    2223         GB swap and 8 GB of physical memory, you require to add 7 GB
    2224         more swap. This can be done as follows:
    2225       </para>
    2226 
    2227       <para>
    2228         For ZFS, run the following as root user:
    2229       </para>
    2230 
    2231 <screen>zfs create -V 8gb /_&lt;ZFS volume&gt;_/swap
    2232 swap -a /dev/zvol/dsk/_&lt;ZFS volume&gt;_/swap</screen>
    2233 
    2234       <para>
    2235         To mount if after reboot, add the following line to /etc/vfstab:
    2236       </para>
    2237 
    2238 <screen>/dev/zvol/dsk/_&lt;ZFS volume&gt;_/swap - - swap - no -</screen>
    2239 
    2240       <para>
    2241         Alternatively, you could grow the existing swap using:
    2242       </para>
    2243 
    2244 <screen>zfs set volsize=8G rpool/swap</screen>
    2245 
    2246       <para>
    2247         And reboot the system for the changes to take effect.
    2248       </para>
    2249 
    2250       <para>
    2251         For UFS (as root user):
    2252       </para>
    2253 
    2254 <screen>mkfile 7g /path/to/swapfile.img
    2255 swap -a /path/to/swapfile.img</screen>
    2256 
    2257       <para>
    2258         To mount it after reboot, add the following line to /etc/vfstab:
    2259       </para>
    2260 
    2261 <screen>/path/to/swap.img - - swap - no -</screen>
    2262 
    2263     </sect2>
    2264 
    22651869  </sect1>
    22661870
  • trunk/doc/manual/en_US/user_VBoxManage.xml

    r82044 r82350  
    254254      <listitem>
    255255        <para>
    256           <computeroutput>-v|--version</computeroutput>: Show the
    257           version of this tool and exit.
    258         </para>
    259       </listitem>
    260 
    261       <listitem>
    262         <para>
    263           <computeroutput>--nologo</computeroutput>: Suppress the output
    264           of the logo information. This option is useful for scripts.
    265         </para>
    266       </listitem>
    267 
    268       <listitem>
    269         <para>
    270           <computeroutput>--settingspw</computeroutput>: Specifiy a
    271           settings password.
    272         </para>
    273       </listitem>
    274 
    275       <listitem>
    276         <para>
    277           <computeroutput>--settingspwfile</computeroutput>: Specify a
    278           file containing the settings password.
     256          <option>-v|--version</option>: Show the version of this tool
     257          and exit.
     258        </para>
     259      </listitem>
     260
     261      <listitem>
     262        <para>
     263          <option>--nologo</option>: Suppress the output of the logo
     264          information. This option is useful for scripts.
     265        </para>
     266      </listitem>
     267
     268      <listitem>
     269        <para>
     270          <option>--settingspw</option>: Specifiy a settings password.
     271        </para>
     272      </listitem>
     273
     274      <listitem>
     275        <para>
     276          <option>--settingspwfile</option>: Specify a file containing
     277          the settings password.
    279278        </para>
    280279      </listitem>
     
    289288      settings password is specified, this information is stored in
    290289      <emphasis>plain text</emphasis>. After using the
    291       <computeroutput>--settingspw|--settingspwfile</computeroutput>
    292       option once, it must be always used. Otherwise, the encrypted
    293       setting cannot be unencrypted.
     290      <option>--settingspw|--settingspwfile</option> option once, it
     291      must be always used. Otherwise, the encrypted setting cannot be
     292      unencrypted.
    294293    </para>
    295294
     
    318317          registered with &product-name;. By default this displays a
    319318          compact list with each VM's name and UUID. If you also specify
    320           <computeroutput>--long</computeroutput> or
    321           <computeroutput>-l</computeroutput>, this will be a detailed
    322           list as with the <command>showvminfo</command> command, see
    323           <xref linkend="vboxmanage-showvminfo"/>.
     319          <option>--long</option> or <option>-l</option>, this will be a
     320          detailed list as with the <command>showvminfo</command>
     321          command, see <xref linkend="vboxmanage-showvminfo"/>.
    324322        </para>
    325323      </listitem>
     
    527525
    528526    <para>
    529       Use the <computeroutput>--machinereadable</computeroutput> option
    530       to produce the same output, but in machine readable format with a
    531       property=value string on each line. For example:
     527      Use the <option>--machinereadable</option> option to produce the
     528      same output, but in machine readable format with a property=value
     529      string on each line. For example:
    532530    </para>
    533531
     
    623621      <replaceable>name</replaceable></option>. This name is used by
    624622      default as the file name of the settings file that has the
    625       <computeroutput>.xml</computeroutput> extension and the machine
    626       folder, which is a subfolder of the
    627       <computeroutput>.config/VirtualBox/Machines</computeroutput>
    628       folder. Note that the machine folder path name varies based on the
    629       OS type and the &product-name; version.
     623      <filename>.xml</filename> extension and the machine folder, which
     624      is a subfolder of the
     625      <filename>.config/VirtualBox/Machines</filename> folder. Note that
     626      the machine folder path name varies based on the OS type and the
     627      &product-name; version.
    630628    </para>
    631629
     
    808806            PCI bus address]&gt;</computeroutput>: Attaches a specified
    809807            PCI network controller on the host to a specified PCI bus on
    810             the guest. See <xref linkend="pcipassthrough" />.
     808            the guest.
     809
     810<!--See <xref linkend="pcipassthrough" />.-->
    811811          </para>
    812812        </listitem>
     
    817817            address&gt;</computeroutput>: Detaches a specified PCI
    818818            network controller on the host from the attached PCI bus on
    819             the guest. See <xref linkend="pcipassthrough" />.
     819            the guest.
     820
     821<!--See <xref linkend="pcipassthrough" />.-->
    820822          </para>
    821823        </listitem>
     
    11471149          <para>
    11481150            <computeroutput>--biospxedebug on|off</computeroutput>:
    1149             Enables additional debugging output when using the Intel PXE
    1150             boot ROM. The output is written to the release log file. See
    1151             <xref linkend="collect-debug-info" />.
     1151            Enables or disables additional debugging output when using
     1152            the Intel PXE boot ROM. The output is written to the release
     1153            log file. See <xref linkend="collect-debug-info" />.
     1154          </para>
     1155        </listitem>
     1156
     1157        <listitem>
     1158          <para>
     1159            <computeroutput>--system-uuid-le on|off</computeroutput>:
     1160            Enables or disables representing the system UUID in little
     1161            endian form. The default value is <literal>on</literal> for
     1162            new VMs. For old VMs the setting is <literal>off</literal>
     1163            to keep the content of the DMI/SMBIOS table unchanged, which
     1164            can be important for Windows license activation.
    11521165          </para>
    11531166        </listitem>
     
    12241237        <listitem>
    12251238          <para>
    1226             <computeroutput>--vm-process-priority default|flat|low|normal|high
    1227             </computeroutput>: Specifies the priority scheme of the VM process
    1228             to be used when starting this VM and during VM execution. See
     1239            <computeroutput>--vm-process-priority
     1240            default|flat|low|normal|high</computeroutput>: Specifies the
     1241            priority scheme of the VM process to be used when starting
     1242            this VM and during VM execution. See
    12291243            <xref linkend="vboxmanage-startvm" />.
    12301244          </para>
     
    12681282            (<computeroutput>generic</computeroutput>). These options
    12691283            correspond to the modes described in
    1270             <xref
    1271             linkend="networkingmodes" />.
     1284            <xref linkend="networkingmodes" />.
    12721285          </para>
    12731286        </listitem>
     
    12761289          <para>
    12771290            <computeroutput>--nictype&lt;1-N&gt;
    1278             Am79C970A|Am79C973|82540EM|82543GC|82545EM|virtio</computeroutput>:
     1291            Am79C970A|Am79C973|Am79C970|82540EM|82543GC|82545EM|virtio</computeroutput>:
    12791292            Enables you to specify the networking hardware that
    12801293            &product-name; presents to the guest for a specified VM
     
    16701683                connect the virtual serial device to it. Note that
    16711684                Windows requires that the name of a named pipe begins
    1672                 with <computeroutput>\\.\pipe\</computeroutput>.
     1685                with <filename>\\.\pipe\</filename>.
    16731686              </para>
    16741687
     
    17291742                port such as <computeroutput>COM1</computeroutput>. On a
    17301743                Linux host, the device name will be
    1731                 <computeroutput>/dev/ttyS0</computeroutput> or similar.
    1732                 This enables you to wire up a real serial port to a
    1733                 virtual machine.
     1744                <filename>/dev/ttyS0</filename> or similar. This enables
     1745                you to wire up a real serial port to a virtual machine.
    17341746              </para>
    17351747            </listitem>
     
    17411753          <para>
    17421754            <computeroutput>uarttype &lt;1-N&gt;
    1743             16450|16550A|16750</computeroutput>: Confgures the UART
     1755            16450|16550A|16750</computeroutput>: Configures the UART
    17441756            type for a virtual serial port. The default UART type is
    17451757            16550A.
     
    18311843          <para>
    18321844            <computeroutput>--clipboard-file-transfers
    1833             enabled|disabled</computeroutput>:
    1834             Specifies if clipboard file transfers are allowed between host and
    1835             guest OSEs or not.
     1845            enabled|disabled</computeroutput>: Specifies if clipboard
     1846            file transfers are allowed between host and guest OSes or
     1847            not.
    18361848          </para>
    18371849        </listitem>
     
    26522664
    26532665    <para>
    2654       This command import one or more virtual machines to
     2666      This command imports one or more virtual machines into
    26552667      &product-name;. You can import from either of the following:
    26562668    </para>
     
    26662678      <listitem>
    26672679        <para>
    2668           A cloud service, such as &oci;. Only a single cloud instance can be imported.
     2680          A cloud service, such as &oci;. Only a single cloud instance
     2681          can be imported.
    26692682        </para>
    26702683      </listitem>
     
    26732686
    26742687    <para>
    2675       See <xref linkend="ovf" /> for more details on importing VMs from
     2688      See <xref linkend="ovf" /> for more details on importing VMs into
    26762689      &product-name;.
    26772690    </para>
     
    26842697        The <command>import</command> subcommand takes at least the path
    26852698        name of an OVF file as input and expects the disk images, if
    2686         needed, in the same directory as the OVF file. A lot of additional
    2687         command-line options are supported to control in detail what is
    2688         being imported and modify the import parameters, but the details
    2689         depend on the content of the OVF file.
     2699        needed, to be in the same directory as the OVF file. Many
     2700        additional command-line options are supported. These enable you
     2701        to control in detail what is being imported and to modify the
     2702        import parameters, depending on the content of the OVF file.
    26902703      </para>
    26912704
     
    26942707        <command>import</command> subcommand with the
    26952708        <computeroutput>--dry-run</computeroutput> or
    2696         <computeroutput>-n</computeroutput> option. This will then print a
    2697         description of the appliance's contents to the screen how it would
    2698         be imported into &product-name;, together with the optional
    2699         command-line options to influence the import behavior.
     2709        <computeroutput>-n</computeroutput> option. This will then print
     2710        a description of the appliance's contents to the screen how it
     2711        would be imported into &product-name;, together with the
     2712        optional command-line options to influence the import behavior.
    27002713      </para>
    27012714
     
    27032716        Use of the <computeroutput>--options
    27042717        keepallmacs|keepnatmacs|keepdisknames</computeroutput> option
    2705         enables additional fine tuning of the clone operation. The first
    2706         two options enable specification of how the MAC addresses of every
    2707         virtual network card should be handled. They can either be
     2718        enables additional fine tuning of the import operation. The
     2719        first two options enable you to specify how the MAC addresses of
     2720        every virtual network card should be handled. They can either be
    27082721        reinitialized, which is the default setting, left unchanged
    27092722        (<computeroutput>keepallmacs</computeroutput>) or left unchanged
    27102723        when the network type is NAT
    27112724        (<computeroutput>keepnatmacs</computeroutput>). If you add
    2712         <computeroutput>keepdisknames</computeroutput> all new disk images
    2713         are assigned the same names as the originals, otherwise they are
    2714         renamed.
     2725        <computeroutput>keepdisknames</computeroutput> all new disk
     2726        images are assigned the same names as the originals, otherwise
     2727        they are renamed.
    27152728      </para>
    27162729
     
    27202733      </para>
    27212734
    2722       <screen>VBoxManage import WindowsXp.ovf --dry-run
     2735<screen>VBoxManage import WindowsXp.ovf --dry-run
    27232736      Interpreting WindowsXp.ovf...
    27242737      OK.
     
    27582771
    27592772      <para>
    2760         The individual configuration items are numbered, and depending on
    2761         their type support different command-line options. The import
     2773        The individual configuration items are numbered, and depending
     2774        on their type support different command-line options. The import
    27622775        subcommand can be directed to ignore many such items with a
    27632776        <computeroutput>--vsys X --unit Y --ignore</computeroutput>
    2764         option, where X is the number of the virtual system and Y the item
    2765         number, as printed on the screen. X is zero, unless there are
    2766         several virtual system descriptions in the appliance.
     2777        option, where X is the number of the virtual system and Y the
     2778        item number, as printed on the screen. X is zero, unless there
     2779        are several virtual system descriptions in the appliance.
    27672780      </para>
    27682781
    27692782      <para>
    27702783        In the above example, Item #1 specifies the name of the target
    2771         machine in &product-name;. Items #9 and #10 specify hard disk
    2772         controllers, respectively. Item #11 describes a hard disk image.
     2784        machine in &product-name;. Items #12 and #13 specify hard disk
     2785        controllers, respectively. Item #14 describes a hard disk image.
    27732786        In this case, the additional
    27742787        <computeroutput>--controller</computeroutput> option indicates
    2775         which item the disk image should be connected to, with the default
    2776         coming from the OVF file.
     2788        which item the disk image should be connected to, with the
     2789        default coming from the OVF file.
    27772790      </para>
    27782791
    27792792      <para>
    2780         You can combine several items for the same virtual system behind
    2781         the same <computeroutput>--vsys</computeroutput> option. For
    2782         example, to import a machine as described in the OVF, but without
    2783         the sound card and without the USB controller, and with the disk
     2793        You can combine several items for the same virtual system using
     2794        the <computeroutput>--vsys</computeroutput> option. For example,
     2795        to import a machine as described in the OVF, but without the
     2796        sound card and without the USB controller, and with the disk
    27842797        image connected to the IDE controller instead of the SCSI
    27852798        controller, use the following command:
    27862799      </para>
    27872800
    2788       <screen>VBoxManage import WindowsXp.ovf
    2789             --vsys 0 --unit 5 --ignore --unit 6 --ignore --unit 11 --controller 10</screen>
     2801<screen>VBoxManage import WindowsXp.ovf
     2802  --vsys 0 --unit 8 --ignore --unit 9 --ignore --unit 14 --controller 13</screen>
     2803
    27902804    </sect2>
    27912805
    27922806    <sect2 id="vboxmanage-import-cloud">
     2807
    27932808      <title>Import from &oci;</title>
     2809
    27942810      <para>
    2795         As the result of operation a file with the suffix “.oci” will be downloaded on the local host.
    2796         This file is a TAR archive which contains a bootable instance image in QCOW2 format and a JSON file with some metadata
    2797         related to the imported instance. The downloaded file is deleted after successful import. If import fails the VBoxSVC log file
    2798         may hint a name and place where the downloaded file was stored (in case of failure the file may not be deleted).
    2799         During import the bootable image is extracted from the archive and converted into VMDK format. The JSON file is also extracted
    2800         and stored in the VM folder.
     2811        As the result of this operation, a file with the suffix
     2812        <filename>.oci</filename> is downloaded to the local host. This
     2813        file is a TAR archive which contains a bootable instance image
     2814        in QCOW2 format and a JSON file with some metadata related to
     2815        the imported instance.
    28012816      </para>
     2817
    28022818      <para>
    2803         The command syntax begins from the "VBoxManage import OCI:// --cloud".
     2819        The downloaded file is deleted after a successful import. If
     2820        import fails, the downloaded file may not be deleted and the
     2821        VBoxSVC log file may indicate the location where the file was
     2822        stored.
    28042823      </para>
     2824
    28052825      <para>
    2806         List the machines and their ids from Oracle Cloud Infrastructure using the command "VBoxManage cloud --provider=OCI
    2807         --profile="your profile name" list instances".
     2826        During import the bootable image is extracted from the archive
     2827        and converted into VMDK format. The JSON file is also extracted
     2828        and stored in the VM machine folder.
    28082829      </para>
     2830
    28092831      <para>
    2810         To import a VM from a cloud service such as Oracle Cloud Infrastructure, use the <option>--cloud</option> option to specify the
    2811         import from the Cloud. Some of the following options are settings for the VM. Somewhere you must enter an Oracle Cloud Identifier (OCID)
    2812         for a resource. Use the Oracle Cloud Infrastructure Console to view OCIDs.
     2832        The command syntax for importing an &oci; instance begins with
     2833        <command>VBoxManage import OCI:// --cloud</command>.
    28132834      </para>
     2835
    28142836      <para>
    2815         Next parameters must be followed:
    2816         <itemizedlist>
    2817           <listitem>
    2818             <para>
    2819               <option>--vmname</option>: Specifies new name for imported VM. This name is used as the VM name in VirtualBox.
    2820             </para>
    2821           </listitem>
    2822           <listitem>
    2823             <para>
    2824               <option>--cloudinstanceid</option>: Id of existing instance in the Cloud.
    2825             </para>
    2826           </listitem>
    2827           <listitem>
    2828             <para>
    2829               <option>--cloudprofile</option>: Specifies the cloud profile that is used to connect to the cloud service provider.
    2830               The cloud profile contains your Oracle Cloud Infrastructure account details, such as your user OCID and the fingerprint for your public key.
    2831               To use a cloud profile, you must have the required permissions on Oracle Cloud Infrastructure.
    2832             </para>
    2833           </listitem>
    2834           <listitem>
    2835             <para>
    2836               <option>--cloudbucket</option>: Specifies the bucket name in which to store the object created from an instance bootable volume.
    2837               In Oracle Cloud Infrastructure, a bucket is a logical container for storing objects.
    2838             </para>
    2839           </listitem>
    2840         </itemizedlist>
     2837        You can list the available &oci; VM instances and their IDs by
     2838        using the following command:
    28412839      </para>
     2840
     2841<screen>VBoxManage cloud --provider=OCI --profile=<replaceable>cloud-profile-name</replaceable> list instances</screen>
     2842
    28422843      <para>
    2843         Some other import options have the same meaning as for OVF import:
    2844         <itemizedlist>
    2845           <listitem>
    2846             <para>
    2847               <option>--ostype</option>: OS type supported by VirtualBox. Use "VBoxManage list ostypes" to see the whole list of supported OSes.
    2848               If the type wasn't set the "Unknown" type will be used.
    2849             </para>
    2850           </listitem>
    2851           <listitem>
    2852             <para>
    2853               <option>--basefolder</option>: folder where new VM will be placed.
    2854             </para>
    2855           </listitem>
    2856           <listitem>
    2857             <para>
    2858               <option>--description</option>: VM description string.
    2859             </para>
    2860           </listitem>
    2861           <listitem>
    2862             <para>
    2863               <option>--memory</option>: RAM memory assigned for VM in MB.
    2864               If memory wasn't set the possible memory size will be deduced from the default memory size for this OS type or will be taken from the cloud instance.
    2865             </para>
    2866           </listitem>
    2867           <listitem>
    2868             <para>
    2869               <option>--cpus</option>: Number of virtual CPUs assigned for VM.
    2870               If cpus wasn't set the possible number of CPUs will be deduced from the default settings for this OS type or will be taken from the cloud instance.
    2871             </para>
    2872           </listitem>
    2873         </itemizedlist>
     2844        To import a VM from a cloud service such as &oci;, use the
     2845        <option>--cloud</option> option to specify the import from the
     2846        Cloud. Some of the following options are settings for the VM,
     2847        for others you must enter an Oracle Cloud Identifier (OCID) for
     2848        a resource. Use the Oracle Cloud Infrastructure Console to view
     2849        OCIDs.
    28742850      </para>
     2851
    28752852      <para>
    2876         The import options <option>--disk</option>, <option>--controller</option>, <option>--scsitype</option>, <option>--unit</option>,
    2877         <option>--settingsfile</option> are invalid for cloud import.
     2853        The following parameters can be specified:
    28782854      </para>
     2855
     2856      <itemizedlist>
     2857
     2858        <listitem>
     2859          <para>
     2860            <option>--vmname</option>: Specifies a new name for the
     2861            imported VM. This name is used as the VM name by
     2862            &product-name;.
     2863          </para>
     2864        </listitem>
     2865
     2866        <listitem>
     2867          <para>
     2868            <option>--cloudinstanceid</option>: The ID of an existing
     2869            instance in the Cloud.
     2870          </para>
     2871        </listitem>
     2872
     2873        <listitem>
     2874          <para>
     2875            <option>--cloudprofile</option>: Specifies the cloud profile
     2876            that is used to connect to the cloud service provider. The
     2877            cloud profile contains your &oci; account details, such as
     2878            your user OCID and the fingerprint for your public key. To
     2879            use a cloud profile, you must have the required permissions
     2880            on &oci;.
     2881          </para>
     2882        </listitem>
     2883
     2884        <listitem>
     2885          <para>
     2886            <option>--cloudbucket</option>: Specifies the bucket name in
     2887            which to store the object created from an instance bootable
     2888            volume. In &oci;, a bucket is a logical container for
     2889            storing objects.
     2890          </para>
     2891        </listitem>
     2892
     2893      </itemizedlist>
     2894
    28792895      <para>
    2880         The following example shows a typical command line for import an instance from Oracle Cloud Infrastructure:
     2896        The following import options have the same meaning as for OVF
     2897        import:
    28812898      </para>
    2882         <screen>
    2883         # VBoxManage import OCI:// --cloud --vmname import_from_oci --memory 4000
    2884         --cpus 3 --ostype FreeBSD_64 --cloudprofile "standard user" --cloudinstanceid
    2885         ocid1.instance.oc1.iad.abuwc... --cloudbucket myBucket
    2886         </screen>
     2899
     2900      <itemizedlist>
     2901
     2902        <listitem>
     2903          <para>
     2904            <option>--ostype</option>: An OS type supported by
     2905            &product-name;. Use the <command>VBoxManage list
     2906            ostypes</command> command to see the whole list of supported
     2907            OSes. If the type was not set, the
     2908            <literal>Unknown</literal> type is used.
     2909          </para>
     2910        </listitem>
     2911
     2912        <listitem>
     2913          <para>
     2914            <option>--basefolder</option>: The folder where the new VM
     2915            is stored.
     2916          </para>
     2917        </listitem>
     2918
     2919        <listitem>
     2920          <para>
     2921            <option>--description</option>: A string describing the VM.
     2922          </para>
     2923        </listitem>
     2924
     2925        <listitem>
     2926          <para>
     2927            <option>--memory</option>: The amount of RAM memory assigned
     2928            for the VM, in MB. If this option is not set either the
     2929            default memory size for the OS type is used, or the value is
     2930            taken from the &oci; instance.
     2931          </para>
     2932        </listitem>
     2933
     2934        <listitem>
     2935          <para>
     2936            <option>--cpus</option>: the number of virtual CPUs assigned
     2937            for the VM. If this option is not set, either the default
     2938            virtual CPUs setting for the OS type is used, or the value
     2939            is taken from the &oci; instance.
     2940          </para>
     2941        </listitem>
     2942
     2943      </itemizedlist>
     2944
     2945      <para>
     2946        The import options <option>--disk</option>,
     2947        <option>--controller</option>, <option>--scsitype</option>,
     2948        <option>--unit</option>, <option>--settingsfile</option> are not
     2949        valid for cloud import.
     2950      </para>
     2951
     2952      <para>
     2953        The following example shows a typical command line for importing
     2954        an instance from &oci;:
     2955      </para>
     2956
     2957<screen># VBoxManage import OCI:// --cloud --vmname import_from_oci --memory 4000
     2958  --cpus 3 --ostype FreeBSD_64 --cloudprofile "standard user"
     2959  --cloudinstanceid ocid1.instance.oc1.iad.abuwc... --cloudbucket myBucket</screen>
    28872960
    28882961    </sect2>
     
    30513124            permissions on &oci;.
    30523125          </para>
    3053 
    3054           <remark>
    3055             Add xref to information about the required permissions.
    3056           </remark>
    30573126        </listitem>
    30583127
     
    30723141            <replaceable>domain</replaceable>: Specifies the
    30733142            availability domain to use for the VM instance. Enter the
    3074             OCID for the availability domain.
     3143            full name of the availability domain.
    30753144          </para>
    30763145        </listitem>
     
    31423211      </para>
    31433212
    3144       <remark>
    3145         For the next release, describe exactly what this command does in
    3146         terms of the command line options.
    3147       </remark>
    3148 
    3149 <screen># VBoxManage export myVM --output OCI:// --cloud 0 --vmname myVM_Cloud
    3150 --cloudprofile "standard user" --cloudbucket myBucket
    3151 --cloudshape VM.Standard2.1 --clouddomain aaaa:US-ASHBURN-AD-1 --clouddisksize 50
    3152 --cloudocivcn ocid1.vcn.oc1.iad.aaaa... --cloudocisubnet ocid1.subnet.oc1.iad.aaaa...
     3213<screen># VBoxManage export myVM --output OCI:// --cloud 0 --vmname myVM_Cloud \
     3214--cloudprofile "standard user" --cloudbucket myBucket \
     3215--cloudshape VM.Standard2.1 --clouddomain US-ASHBURN-AD-1 --clouddisksize 50  \
     3216--cloudocivcn ocid1.vcn.oc1.iad.aaaa... --cloudocisubnet ocid1.subnet.oc1.iad.aaaa... \
    31533217--cloudkeepobject true --cloudlaunchinstance true --cloudpublicip true</screen>
    31543218
     
    33753439      <listitem>
    33763440        <para>
    3377           <computeroutput>setlinkstate&lt;1-N&gt; on|off</computeroutput>:
    3378           Connects or disconnects virtual network cables from their
    3379           network interfaces.
     3441          <computeroutput>setlinkstate&lt;1-N&gt;
     3442          on|off</computeroutput>: Connects or disconnects virtual
     3443          network cables from their network interfaces.
    33803444        </para>
    33813445      </listitem>
     
    33993463          (<computeroutput>generic</computeroutput>). These options
    34003464          correspond to the modes which are described in detail in
    3401           <xref
    3402         linkend="networkingmodes" />.
     3465          <xref linkend="networkingmodes" />.
    34033466        </para>
    34043467      </listitem>
     
    34203483          trace should be logged. This can be done with the
    34213484          <computeroutput>nictracefile&lt;1-N&gt;
    3422           &lt;filename&gt;</computeroutput> option to <command>VBoxManage
    3423           controlvm</command> at runtime or with the
    3424           <computeroutput>--nictracefile&lt;1-N&gt;
    3425           &lt;filename&gt;</computeroutput> option to <command>VBoxManage
    3426           modifyvm</command> otherwise.
     3485          &lt;filename&gt;</computeroutput> option to
     3486          <command>VBoxManage controlvm</command> at runtime or with the
     3487          <computeroutput>&lt;filename&gt;</computeroutput> option to
     3488          <command>VBoxManage modifyvm</command> otherwise.
    34273489        </para>
    34283490      </listitem>
     
    35413603        <para>
    35423604          <computeroutput>clipboard filetransfers
    3543           enabled|disabled</computeroutput>:
    3544           Specifies if clipboard file transfers are allowed between host and
    3545           guest OSEs or not.
     3605          enabled|disabled</computeroutput>: Specifies if clipboard file
     3606          transfers are allowed between host and guest OSes or not.
    35463607        </para>
    35473608      </listitem>
     
    40534114      <listitem>
    40544115        <para>
    4055           <computeroutput>vm-process-priority default|flat|low|normal|high
    4056           </computeroutput>: Changes the priority scheme of the VM process.
    4057           See <xref linkend="vboxmanage-startvm" />.
     4116          <computeroutput>vm-process-priority
     4117          default|flat|low|normal|high</computeroutput>: Changes the
     4118          priority scheme of the VM process. See
     4119          <xref linkend="vboxmanage-startvm" />.
    40584120        </para>
    40594121      </listitem>
     
    42774339
    42784340    <para>
    4279       If you have a Saved state file
    4280       (<computeroutput>.sav</computeroutput>) that is separate from the
    4281       VM configuration, you can use this command to
     4341      If you have a Saved state file (<filename>.sav</filename>) that is
     4342      separate from the VM configuration, you can use this command to
    42824343      <emphasis>adopt</emphasis> the file. This will change the VM to
    42834344      saved state and when you start it, &product-name; will attempt to
     
    53135374  </sect1>
    53145375
    5315   <sect1 id="vboxmanage-modifyvdi">
     5376  <sect1 id="vboxmanage-modifymedium">
    53165377
    53175378    <title>VBoxManage modifymedium</title>
     
    54695530  </sect1>
    54705531
    5471   <sect1 id="vboxmanage-clonevdi">
     5532  <sect1 id="vboxmanage-clonemedium">
    54725533
    54735534    <title>VBoxManage clonemedium</title>
     
    55565617        <command>clonevdi</command> and <command>clonehd</command>
    55575618        commands are still supported and mapped internally to the
    5558         <command>clonehd disk</command> command.
     5619        <command>clonemedium</command> command.
    55595620      </para>
    55605621    </note>
     
    58115872
    58125873    <para>
    5813       This command converts a raw disk image to a &product-name; Disk
     5874      This command converts a raw disk image to an &product-name; Disk
    58145875      Image (VDI) file. The syntax is as follows:
    58155876    </para>
     
    59095970    <para>
    59105971      These commands enable you to attach and retrieve string data for a
    5911       virtual machine or for a &product-name; configuration, by
     5972      virtual machine or for an &product-name; configuration, by
    59125973      specifying <computeroutput>global</computeroutput> instead of a
    59135974      virtual machine name. You must specify a keyword as a text string
     
    60886149          <para>
    60896150            Configures the VBoxSVC release logging details. See
    6090             <ulink url="http://www.virtualbox.org/wiki/VBoxLogging">http://www.virtualbox.org/wiki/VBoxLogging</ulink>.
     6151            <ulink url="http://www.virtualbox.org/wiki/VBoxLogging" />.
    60916152          </para>
    60926153        </listitem>
     
    63956456          the share will be automatically mounted. On Linux
    63966457          distributions, this will be to either
    6397           <computeroutput>/media/USER/sf_&lt;name&gt;</computeroutput>
    6398           or <computeroutput>/media/sf_&lt;name&gt;</computeroutput>,
    6399           where &lt;name&gt; is the share named. The actual location
    6400           depends on the guest OS. Optional.
     6458          <filename>/media/USER/sf_<replaceable>share-name</replaceable></filename>
     6459          or
     6460          <filename>/media/sf_<replaceable>share-name</replaceable></filename>,
     6461          where <replaceable>share-name</replaceable> is the share
     6462          named. The actual location depends on the guest OS. Optional.
    64016463        </para>
    64026464      </listitem>
     
    67936855                Specifies the absolute path of the executable on the
    67946856                guest OS file system. Mandatory. For example:
    6795                 <computeroutput>C:\Windows\System32\calc.exe</computeroutput>.
     6857                <filename>C:\Windows\System32\calc.exe</filename>.
    67966858              </para>
    67976859            </listitem>
     
    70737135                Specifies the absolute path of the executable on the
    70747136                guest OS file system. Mandatory. For example:
    7075                 <computeroutput>C:\Windows\System32\calc.exe</computeroutput>
     7137                <filename>C:\Windows\System32\calc.exe</filename>
    70767138              </para>
    70777139            </listitem>
     
    73157377                Specifies the absolute path of the host file system
    73167378                destination directory. Mandatory. For example:
    7317                 <computeroutput>C:\Temp</computeroutput>.
     7379                <filename>C:\Temp</filename>.
    73187380              </para>
    73197381            </listitem>
     
    73307392                Specifies the absolute paths of guest file system files
    73317393                to be copied. Mandatory. For example:
    7332                 <computeroutput>C:\Windows\System32\calc.exe</computeroutput>.
     7394                <filename>C:\Windows\System32\calc.exe</filename>.
    73337395                Wildcards can be used in the expressions. For example:
    7334                 <computeroutput>C:\Windows\System*\*.dll</computeroutput>.
     7396                <filename>C:\Windows\System*\*.dll</filename>.
    73357397              </para>
    73367398            </listitem>
     
    74067468                Specifies the absolute path of the guest file system
    74077469                destination directory. Mandatory. For example:
    7408                 <computeroutput>C:\Temp</computeroutput>.
     7470                <filename>C:\Temp</filename>.
    74097471              </para>
    74107472            </listitem>
     
    74217483                Specifies the absolute paths of host file system files
    74227484                to be copied. Mandatory. For example:
    7423                 <computeroutput>C:\Windows\System32\calc.exe</computeroutput>.
     7485                <filename>C:\Windows\System32\calc.exe</filename>.
    74247486                Wildcards can be used in the expressions. For example:
    7425                 <computeroutput>C:\Windows\System*\*.dll</computeroutput>.
     7487                <filename>C:\Windows\System*\*.dll</filename>.
    74267488              </para>
    74277489            </listitem>
     
    74737535              <para>
    74747536                For example: If specified directory is
    7475                 <computeroutput>D:\Foo\Bar</computeroutput> and
    7476                 <computeroutput>D:\Foo</computeroutput> is absent, it
    7477                 will be created. In such a case, had the
     7537                <filename>D:\Foo\Bar</filename> and
     7538                <filename>D:\Foo</filename> is absent, it will be
     7539                created. In such a case, had the
    74787540                <computeroutput>--parents</computeroutput> option not
    74797541                been used, this command would have failed.
     
    75087570                Specifies a list of absolute paths of directories to be
    75097571                created on guest file system. Mandatory. For example:
    7510                 <computeroutput>D:\Foo\Bar</computeroutput>.
     7572                <filename>D:\Foo\Bar</filename>.
    75117573              </para>
    75127574
     
    75157577                switch <computeroutput>--parents</computeroutput> is
    75167578                used. For example, in the above example
    7517                 <computeroutput>D:\Foo</computeroutput>. The specified
    7518                 user must have sufficient rights to create the specified
     7579                <filename>D:\Foo</filename>. The specified user must
     7580                have sufficient rights to create the specified
    75197581                directories, and any parents that need to be created.
    75207582              </para>
     
    75787640                be deleted on guest file system. Mandatory. Wildcards
    75797641                are allowed. For example:
    7580                 <computeroutput>D:\Foo\*Bar</computeroutput>. The
    7581                 specified user must have sufficient rights to delete the
    7582                 specified directories.
     7642                <filename>D:\Foo\*Bar</filename>. The specified user
     7643                must have sufficient rights to delete the specified
     7644                directories.
    75837645              </para>
    75847646            </listitem>
     
    76417703                deleted on guest file system. Mandatory. Wildcards are
    76427704                allowed. For example:
    7643                 <computeroutput>D:\Foo\Bar\text*.txt</computeroutput>.
    7644                 The specified user should have sufficient rights to
    7645                 delete the specified files.
     7705                <filename>D:\Foo\Bar\text*.txt</filename>. The specified
     7706                user should have sufficient rights to delete the
     7707                specified files.
    76467708              </para>
    76477709            </listitem>
     
    78627924                Specifies absolute paths of files or file systems on the
    78637925                guest file system. Mandatory. For example:
    7864                 <computeroutput>/home/foo/a.out</computeroutput>. The
    7865                 specified user should have sufficient rights to access
    7866                 the specified files or file systems.
     7926                <filename>/home/foo/a.out</filename>. The specified user
     7927                should have sufficient rights to access the specified
     7928                files or file systems.
    78677929              </para>
    78687930            </listitem>
     
    90169078  </sect1>
    90179079
    9018   <!-- TODO: Figure out how we can generate a file with the includes... The trouble is
     9080<!-- TODO: Figure out how we can generate a file with the includes... The trouble is
    90199081             that xpointer doesn't seem to allow including multiple elements.
    90209082
     
    90229084             don't forget to add it here too.
    90239085   -->
    9024   <xi:include href="user_man_VBoxManage-unattended.xml"     xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
    9025   <xi:include href="user_man_VBoxManage-snapshot.xml"       xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
     9086
     9087  <xi:include href="user_man_VBoxManage-unattended.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
     9088
     9089  <xi:include href="user_man_VBoxManage-snapshot.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
     9090
    90269091  <xi:include href="user_man_VBoxManage-clonevm.xml"        xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
     9092
    90279093  <xi:include href="user_man_VBoxManage-extpack.xml"        xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
    9028   <xi:include href="user_man_VBoxManage-dhcpserver.xml"     xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
     9094
     9095  <xi:include href="user_man_VBoxManage-dhcpserver.xml"        xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
     9096
    90299097  <xi:include href="user_man_VBoxManage-debugvm.xml"        xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
    9030   <xi:include href="user_man_VBoxManage-cloudprofile.xml"   xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
    9031   <xi:include href="user_man_VBoxManage-cloudlist.xml"      xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
     9098
     9099  <xi:include href="user_man_VBoxManage-cloudprofile.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
     9100
     9101  <xi:include href="user_man_VBoxManage-cloudlist.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
     9102
    90329103  <xi:include href="user_man_VBoxManage-cloudinstance.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
     9104
    90339105  <xi:include href="user_man_VBoxManage-cloudimage.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
    90349106
    9035   <!-- TODO: Figure out how we can handle other manpages. The xml is bolted to
     9107<!-- TODO: Figure out how we can handle other manpages. The xml is bolted to
    90369108             sect1, so it's not possible to have them "in place" -->
     9109
    90379110  <xi:include href="user_man_vboximg-mount.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
     9111
    90389112</chapter>
  • trunk/doc/manual/en_US/user_VirtualBoxAPI.xml

    r76786 r82350  
    2929    Development Kit (SDK)</emphasis>. The SDK is available for download
    3030    from
    31     <ulink url="http://www.virtualbox.org">http://www.virtualbox.org</ulink>.
     31    <ulink url="http://www.virtualbox.org" />.
    3232    In particular, the SDK comes with a Programming Guide and Reference
    3333    manual in PDF format. This manual contains, among other things, the
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