VirtualBox

Changeset 34690 in vbox for trunk/doc


Ignore:
Timestamp:
Dec 3, 2010 12:36:01 PM (14 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
68492
Message:

Manual: fixes

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

Legend:

Unmodified
Added
Removed
  • trunk/doc/manual/en_US/user_Frontends.xml

    r34680 r34690  
    66
    77  <sect1>
    8     <title id="vrdp">The VirtualBox Remote Desktop Extension (VRDE)</title>
    9 
    10     <para>VirtualBox, the graphical user interface, has a built-in server for
    11     the Microsoft Remote Desktop Protocol (RDP). This allows you to see the
    12     output of a virtual machine's window remotely on any other computer and
    13     control the virtual machine from there, as if the virtual machine was
    14     running locally.<note>
    15         <para>The VRDE is shipped as a VirtualBox extension package, which
    16         must be installed separately. See <xref linkend="intro-installing" />
    17         for more installation.</para>
     8    <title id="vrdp">Remote display (VRDP support)</title>
     9
     10    <para>VirtualBox has a built-in server for the VirtualBox Remote Desktop
     11    Protocol (VRDP). This allows you to see the output of a virtual machine's
     12    window remotely on any other computer and control the virtual machine from
     13    there, as if the virtual machine was running locally.</para>
     14
     15    <para>VRDP is a backwards-compatible extension to Microsoft's Remote
     16    Desktop Protocol (RDP). Typically graphics updates and audio are sent from
     17    the remote machine to the client, while keyboard and mouse events are sent
     18    back. As a result, you can use any standard RDP client to control the
     19    remote VM.<note>
     20        <para>VRDP support is shipped as as a VirtualBox extension package,
     21        the VirtualBox Remote Desktop Extension (VRDE), which must be
     22        installed separately. See <xref linkend="intro-installing" /> for more
     23        installation.</para>
    1824      </note></para>
    1925
    20     <para>The VirtualBox Remote Desktop Extension (VRDE) is a
    21     backwards-compatible extension to Microsoft's Remote Desktop Protocol
    22     (RDP). Typically graphics updates and audio are sent from the remote
    23     machine to the client, while keyboard and mouse events are sent back. As a
    24     result, you can use any standard RDP client to control the remote
    25     VM.</para>
    26 
    27     <para>The RDP server is disabled by default. If the VRDE is installed, it
    28     can easily be enabled on a per-VM basis either in the VirtualBox Manager
    29     in the "Display" settings (see <xref linkend="settings-display" />) or
    30     with <computeroutput>VBoxManage</computeroutput>:<screen>VBoxManage modifyvm "VM name" --vrde on</screen></para>
     26    <para>The VRDP server is disabled by default. If the extension pack is
     27    installed, it can easily be enabled on a per-VM basis either in the
     28    VirtualBox Manager in the "Display" settings (see <xref
     29    linkend="settings-display" />) or with
     30    <computeroutput>VBoxManage</computeroutput>:<screen>VBoxManage modifyvm "VM name" --vrde on</screen></para>
    3131
    3232    <para>If you use <computeroutput>VBoxHeadless</computeroutput> (described
    33     further below), RDP support will be automatically enabled since
     33    further below), VRDP support will be automatically enabled since
    3434    VBoxHeadless has no other means of output.</para>
    3535
     
    3737      <title>Common third-party RDP viewers</title>
    3838
    39       <para>You can use any standard RDP viewer to connect to such a remote
    40       virtual machine (examples follow below). For this to work, you must
    41       specify the <emphasis role="bold">IP address</emphasis> of your
     39      <para>Since VRDP is backwards-compatible to RDP, you can use any
     40      standard RDP viewer to connect to such a remote virtual machine
     41      (examples follow below). For this to work, you must specify the
     42      <emphasis role="bold">IP address</emphasis> of your
    4243      <emphasis>host</emphasis> system (not of the virtual machine!) as the
    4344      server address to connect to, as well as the <emphasis role="bold">port
    4445      number</emphasis> that the RDP server is using.</para>
    4546
    46       <para>By default, the VRDE uses the standard RDP TCP port
     47      <para>By default, VRDP uses TCP port
    4748      <computeroutput>3389</computeroutput>. You will need to change the
    48       default port if you run more than one RDP server, since the port can
     49      default port if you run more than one VRDP server, since the port can
    4950      only be used by one server at a time; you might also need to change it
    5051      on Windows hosts since the default port might already be used by the RDP
     
    5758      <computeroutput>VBoxManage modifyvm</computeroutput> command. You can
    5859      specify a comma-separated list of ports or ranges of ports. Use a dash
    59       between two port numbers to specify a range. The VRDE will bind to
    60       <emphasis role="bold">one</emphasis> of available ports from the
     60      between two port numbers to specify a range. The VRDP server will bind
     61      to <emphasis role="bold">one</emphasis> of available ports from the
    6162      specified list. For example, <computeroutput>VBoxManage modifyvm "VM
    6263      name" --vrdeport 5000,5010-5012</computeroutput> will configure the
     
    6667      <para>The actual port used by a running VM can be either queried with
    6768      <computeroutput>VBoxManage showvminfo</computeroutput> command or seen
    68       in the GUI on the <computeroutput>Runtime</computeroutput> tab of the
    69       <computeroutput>Session Information Dialog</computeroutput>, which is
    70       accessible via the <computeroutput>Machine</computeroutput> menu of the
    71       VM window.</para>
     69      in the GUI on the "Runtime" tab of the "Session Information Dialog",
     70      which is accessible via the "Machine" menu of the VM window.</para>
    7271
    7372      <para>Here follow examples for the most common RDP viewers:<itemizedlist>
     
    128127
    129128    <sect2 id="vboxheadless">
    130       <title>VBoxHeadless, the RDP-only server</title>
     129      <title>VBoxHeadless, the VRDP-only server</title>
    131130
    132131      <para>While any VM started from the VirtualBox Manager is capable of
     
    135134      the first place. In particular, if you are running servers whose only
    136135      purpose is to host VMs, and all your VMs are supposed to run remotely
    137       over RDP, then it is pointless to have a graphical user interface on the
    138       server at all -- especially since, on a Linux or Solaris host,
    139       <computeroutput>VirtualBox</computeroutput> comes with dependencies on
    140       the Qt and SDL libraries, which is inconvenient if you would rather not
    141       have the X Window system on your server at all.</para>
     136      over VRDP, then it is pointless to have a graphical user interface on
     137      the server at all -- especially since, on a Linux or Solaris host, the
     138      VirtualBox manager comes with dependencies on the Qt and SDL libraries,
     139      which is inconvenient if you would rather not have the X Window system
     140      on your server at all.</para>
    142141
    143142      <para>VirtualBox therefore comes with yet another front-end called
    144143      <computeroutput>VBoxHeadless</computeroutput>, which produces no visible
    145       output on the host at all, but instead only delivers RDP data.<footnote>
     144      output on the host at all, but instead only delivers VRDP data.<footnote>
    146145          <para>Before VirtualBox 1.6, the headless server was called
    147146          <computeroutput>VBoxVRDP</computeroutput>. For the sake of backwards
     
    182181      undesirable (for example because you want to access the VM via
    183182      <computeroutput>ssh</computeroutput> only), start the VM like
    184       this:<screen>VBoxHeadless --startvm &lt;uuid|name&gt; --vrde=off</screen>To
     183      this:<screen>VBoxHeadless --startvm &lt;uuid|name&gt; --vrdp=off</screen>To
    185184      have the VRDP server use the setting from the VM configuration, as the
    186       other front-ends would, use this:<screen>VBoxHeadless --startvm &lt;uuid|name&gt; --vrde=config</screen></para>
     185      other front-ends would, use this:<screen>VBoxHeadless --startvm &lt;uuid|name&gt; --vrdp=config</screen></para>
    187186    </sect2>
    188187
     
    293292      <title>Remote USB</title>
    294293
    295       <para>As a special feature on top of the Remote Desktop Extension,
    296       VirtualBox supports remote USB devices over the wire as well. That is,
    297       the VirtualBox guest that runs on one computer can access the USB
    298       devices of the remote computer on which the RDP data is being displayed
    299       the same way as USB devices that are connected to the actual host. This
    300       allows for running virtual machines on a VirtualBox host that acts as a
    301       server, where a client can connect from elsewhere that needs only a
    302       network adapter and a display capable of running an RDP viewer. When USB
    303       devices are plugged into the client, the remote VirtualBox server can
    304       access them.</para>
     294      <para>As a special feature on top of the VRDP support, VirtualBox
     295      supports remote USB devices over the wire as well. That is, the
     296      VirtualBox guest that runs on one computer can access the USB devices of
     297      the remote computer on which the VRDP data is being displayed the same
     298      way as USB devices that are connected to the actual host. This allows
     299      for running virtual machines on a VirtualBox host that acts as a server,
     300      where a client can connect from elsewhere that needs only a network
     301      adapter and a display capable of running an RDP viewer. When USB devices
     302      are plugged into the client, the remote VirtualBox server can access
     303      them.</para>
    305304
    306305      <para>For these remote USB devices, the same filter rules apply as for
     
    311310      <para>Accessing remote USB devices is only possible if the RDP client
    312311      supports this extension. On Linux and Solaris hosts, the VirtualBox
    313       installation provides a suitable RDP client called
     312      installation provides a suitable VRDP client called
    314313      <computeroutput>rdesktop-vrdp</computeroutput>. RDP clients for other
    315314      platforms will be provided in future VirtualBox versions.</para>
    316315
    317       <para>To make a remote USB device available to a VM, rdesktop-vrdp
    318       should be started as follows:<screen>rdesktop-vrdp -r usb -a 16 -N my.host.address</screen>Note
     316      <para>To make a remote USB device available to a VM,
     317      <computeroutput>rdesktop-vrdp</computeroutput> should be started as
     318      follows:<screen>rdesktop-vrdp -r usb -a 16 -N my.host.address</screen>Note
    319319      that <computeroutput>rdesktop-vrdp</computeroutput> can access USB
    320320      devices only through <computeroutput>/proc/bus/usb</computeroutput>.
     
    463463
    464464    <sect2 id="vrdp-multiconnection">
    465       <title>Multiple RDP connections</title>
     465      <title>Multiple VRDP connections</title>
    466466
    467467      <para>The built-in RDP server of VirtualBox supports simultaneous
     
    525525
    526526    <sect2 id="vrdp-customization">
    527       <title>VRDE customization</title>
     527      <title>VRDP customization</title>
    528528
    529529      <para>Starting with VirtualBox 3.2.10, it is possible to disable display
    530530      output, mouse and keyboard input, audio, remote USB or clipboard in the
    531       RDP server.</para>
     531      VRDP server.</para>
    532532
    533533      <para>The following commands change corresponding server
  • trunk/doc/manual/en_US/user_Introduction.xml

    r34689 r34690  
    514514
    515515    <para>Starting with version 4.0, VirtualBox is split into several
    516     components for licensing reasons.<orderedlist>
    517         <listitem>
    518           <para>The base package consists of all open source compenents and is
    519           entirely licensed under the GNU General Public License V2.</para>
     516    components.<orderedlist>
     517        <listitem>
     518          <para>The base package consists of all open source components and is
     519          licensed under the GNU General Public License V2.</para>
    520520        </listitem>
    521521
Note: See TracChangeset for help on using the changeset viewer.

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