vbox的更動 35193 路徑 trunk/doc

時間撮記:

2010-12-16 下午03:31:49 (14 年 以前)

作者:

vboxsync

訊息:

UserManual: VRDE updates.

位置:

trunk/doc/manual/en_US

檔案:

• user_AdvancedTopics.xml (修改) (1 筆差異)
• user_BasicConcepts.xml (修改) (2 筆差異)
• user_Frontends.xml (修改) (15 筆差異)
• user_Glossary.xml (修改) (2 筆差異)
• user_Introduction.xml (修改) (3 筆差異)
• user_Technical.xml (修改) (1 筆差異)
• user_Troubleshooting.xml (修改) (1 筆差異)
• user_VBoxManage.xml (修改) (9 筆差異)

trunk/doc/manual/en_US/user_AdvancedTopics.xml

@@ -482 +482 @@
     </sect2>
 
-    <sect2 id="vbox-authenticate-sdk">
-      <title>Custom external authentication modules</title>
-
-      <para>As described in <xref linkend="vbox-auth" />, VirtualBox supports
-      arbitrary external modules to perform authentication. When the
-      authentication method is set to "external" for a particular VM,
-      VirtualBox calls the library that was specified with
-      <computeroutput>VBoxManage setproperty vrdeauthlibrary</computeroutput>.
-      This library will be loaded by the VM process on demand, i.e. when the
-      first RDP connection is made by an external client.</para>
-
-      <para>External authentication is the most flexible as the external
-      handler can both choose to grant access to everyone (like the "null"
-      authentication method would) and delegate the request to the guest
-      authentication component. When delegating the request to the guest
-      component, it will still be called afterwards with the option to
-      override the result.</para>
-
-      <para>An authentication library is required to implement exactly one
-      entry point:</para>
-
-      <screen>#include "VBoxAuth.h"
-
-/**
- * Authentication library entry point. Decides whether to allow
- * a client connection.
- *
- * Parameters:
- *
- *   pUuid            Pointer to the UUID of the virtual machine
- *                    which the client connected to.
- *   guestJudgement   Result of the guest authentication.
- *   szUser           User name passed in by the client (UTF8).
- *   szPassword       Password passed in by the client (UTF8).
- *   szDomain         Domain passed in by the client (UTF8).
- *   fLogon           Boolean flag. Indicates whether the entry point is called
- *                    for a client logon or the client disconnect.
- *   clientId         Server side unique identifier of the client.
- *
- * Return code:
- *
- *   AuthResultAccessDenied    Client access has been denied.
- *   AuthResultAccessGranted   Client has the right to use the
- *                             virtual machine.
- *   AuthResultDelegateToGuest Guest operating system must
- *                             authenticate the client and the
- *                             library must be called again with
- *                             the result of the guest
- *                             authentication.
- */
-AuthResult AUTHCALL AuthEntry(
-    const char *szCaller,
-    PVRDPAUTHUUID pUuid,
-    VRDPAuthGuestJudgement guestJudgement,
-    const char *szUser,
-    const char *szPassword
-    const char *szDomain
-    int fLogon,
-    unsigned clientId)
-{
-    /* process request against your authentication source of choice */
-    return AuthResultAccessGranted;
-}</screen>
-
-      <para>A note regarding the UUID implementation of the first argument:
-      VirtualBox uses a consistent binary representation of UUIDs on all
-      platforms. For this reason the integer fields comprising the UUID are
-      stored as little endian values. If you want to pass such UUIDs to code
-      which assumes that the integer fields are big endian (often also called
-      network byte order), you need to adjust the contents of the UUID to e.g.
-      achieve the same string representation. The required changes
-      are:<itemizedlist>
-          <listitem>
-            <para>reverse the order of byte 0, 1, 2 and 3</para>
-          </listitem>
-
-          <listitem>
-            <para>reverse the order of byte 4 and 5</para>
-          </listitem>
-
-          <listitem>
-            <para>reverse the order of byte 6 and 7.</para>
-          </listitem>
-        </itemizedlist>Using this conversion you will get identical results
-      when converting the binary UUID to the string representation.</para>
-
-      <para>The second arguments contains information about the guest
-      authentication status. For the first call, it is always set to
-      <computeroutput>AuthGuestNotAsked</computeroutput>. In case the function
-      returns <computeroutput>AuthResultDelegateToGuest</computeroutput>, a
-      guest authentication will be attempted and another call to the method is
-      made with its result. This can be either granted / denied or no
-      judgement (the guest component chose for whatever reason to not make a
-      decision). In case there is a problem with the guest authentication
-      module (e.g. the Additions are not installed or not running or the guest
-      did not respond within a timeout), the "not reacted" status will be
-      returned.</para>
-    </sect2>
   </sect1>
 

trunk/doc/manual/en_US/user_BasicConcepts.xml

@@ -735 +735 @@
         <glossdef>
           <para>Under the "Remote display" tab, if the VirtualBox Remote
-          Display Extension (VRDE) is installed, you can enable the RDP server
+          Display Extension (VRDE) is installed, you can enable the VRDP server
           that is built into VirtualBox. This allows you to connect to the
           virtual machine remotely with any standard RDP viewer, such as
@@ -741 +741 @@
           Windows or, on Linux systems, the standard open-source
           <computeroutput>rdesktop</computeroutput> program. These features
-          are described in detail in <xref linkend="vrdp" />.</para>
+          are described in detail in <xref linkend="vrde" />.</para>
         </glossdef>
       </glossentry>

trunk/doc/manual/en_US/user_Frontends.xml

@@ -6 +6 @@
 
   <sect1>
-    <title id="vrdp">Remote display (VRDP support)</title>
+    <title id="vrde">VirtualBox Remote Desktop Extension (VRDE)</title>
 
     <para>VirtualBox can display virtual machines remotely. This allows you to
@@ -63 +63 @@
       <para>The port can be changed either in the "Display" settings of the
       graphical user interface or with
-      <computeroutput>--vrdpport</computeroutput> option of the
+      <computeroutput>--vrdeport</computeroutput> option of the
       <computeroutput>VBoxManage modifyvm</computeroutput> command. You can
       specify a comma-separated list of ports or ranges of ports. Use a dash
@@ -135 +135 @@
 
     <sect2 id="vboxheadless">
-      <title>VBoxHeadless, the VRDP-only server</title>
+      <title>VBoxHeadless, the remote desktop server</title>
 
       <para>While any VM started from the VirtualBox Manager is capable of
@@ -142 +142 @@
       the first place. In particular, if you are running servers whose only
       purpose is to host VMs, and all your VMs are supposed to run remotely
-      over VRDP, then it is pointless to have a graphical user interface on
+      over VRDE, then it is pointless to have a graphical user interface on
       the server at all -- especially since, on a Linux or Solaris host, the
       VirtualBox manager comes with dependencies on the Qt and SDL libraries,
@@ -150 +150 @@
       <para>VirtualBox therefore comes with yet another front-end called
       <computeroutput>VBoxHeadless</computeroutput>, which produces no visible
-      output on the host at all, but instead only delivers VRDP data.<footnote>
+      output on the host at all, but instead only delivers VRDE data.<footnote>
           <para>Before VirtualBox 1.6, the headless server was called
           <computeroutput>VBoxVRDP</computeroutput>. For the sake of backwards
@@ -184 +184 @@
       <para>Note that when you use
       <computeroutput>VBoxHeadless</computeroutput> to start a VM, since the
-      headless server has no other means of output, the built-in RDP server
+      headless server has no other means of output, the VRDE server
       will <emphasis>always</emphasis> be enabled, regardless of whether you
-      have enabled the VRDP server in the VM's settings. If this is
+      have enabled the VRDE server in the VM's settings. If this is
       undesirable (for example because you want to access the VM via
       <computeroutput>ssh</computeroutput> only), start the VM like
-      this:<screen>VBoxHeadless --startvm &lt;uuid|name&gt; --vrdp=off</screen>To
-      have the VRDP server use the setting from the VM configuration, as the
-      other front-ends would, use this:<screen>VBoxHeadless --startvm &lt;uuid|name&gt; --vrdp=config</screen></para>
+      this:<screen>VBoxHeadless --startvm &lt;uuid|name&gt; --vrde=off</screen>
+      To use the setting from the VM configuration, as the
+      other front-ends would, use this:<screen>VBoxHeadless --startvm &lt;uuid|name&gt; --vrde=config</screen></para>
     </sect2>
 
@@ -202 +202 @@
       create a virtual machine, establish an RDP connection and install a
       guest operating system -- all without having to touch the headless
-      server. All you need is the following:</para>
+      server. VirtualBox extension packages with the VRDP server must be
+      installed. All you need is the following:</para>
 
       <para><orderedlist>
@@ -336 +337 @@
 
     <sect2 id="vbox-auth">
-      <title>RDP authentication</title>
-
-      <para>For each virtual machine that is remotely accessible via RDP, you
-      can individually determine if and how RDP connections are
+      <title>VRDE authentication</title>
+
+      <para>For each virtual machine that is remotely accessible via VRDE, you
+      can individually determine if and how client connections are
       authenticated.</para>
 
@@ -348 +349 @@
           <listitem>
             <para>The "null" method means that there is no authentication at
-            all; any client can connect to the VRDP server and thus the
+            all; any client can connect to the VRDE server and thus the
             virtual machine. This is, of course, very insecure and only to be
             recommended for private networks.</para>
@@ -422 +423 @@
       default "external authentication module with any other module. For this,
       VirtualBox provides a well-defined interface that allows you to write
-      your own authentication module; see <xref
-      linkend="vbox-authenticate-sdk" /> for details.</para>
-    </sect2>
-
-    <sect2 id="vrdp-crypt">
+      your own authentication module. This is described in detail in the
+      VirtualBox Software Development Kit (SDK) reference; please see <xref
+      linkend="VirtualBoxAPI" /> for details.</para>
+    </sect2>
+
+    <sect2 id="vrde-crypt">
       <title>RDP encryption</title>
 
@@ -470 +472 @@
     </sect2>
 
-    <sect2 id="vrdp-multiconnection">
-      <title>Multiple VRDP connections</title>
-
-      <para>The built-in RDP server of VirtualBox supports simultaneous
+    <sect2 id="vrde-multiconnection">
+      <title>Multiple connections to the VRDP server</title>
+
+      <para>The VRDP server of VirtualBox supports simultaneous
       connections to the same running VM from different clients. All connected
       clients see the same screen output and share a mouse pointer and
@@ -482 +484 @@
     </sect2>
 
-    <sect2 id="vrdp-multimonitor">
+    <sect2 id="vrde-multimonitor">
       <title>Multiple remote monitors</title>
 
       <para>To access two or more remote VM displays you have to enable the
-      RDP multiconnection mode (see <xref
-      linkend="vrdp-multiconnection" />).</para>
+      VRDP multiconnection mode (see <xref
+      linkend="vrde-multiconnection" />).</para>
 
       <para>The RDP client can select the virtual monitor number to connect to
       using the <computeroutput>domain</computeroutput> logon parameter
       (<computeroutput>-d</computeroutput>). If the parameter ends with
-      <computeroutput>@</computeroutput> followed by a number, the VirtualBox
-      RDP server interprets this number as the screen index. The primary guest
+      <computeroutput>@</computeroutput> followed by a number, VirtualBox
+      interprets this number as the screen index. The primary guest
       screen is selected with <computeroutput>@1</computeroutput>, the first
       secondary screen is <computeroutput>@2</computeroutput>, etc.</para>
@@ -506 +508 @@
     </sect2>
 
-    <sect2 id="vrdp-videochannel">
+    <sect2 id="vrde-videochannel">
       <title>VRDP video redirection</title>
 
-      <para>Starting with VirtualBox 3.2, the RDP server can redirect video
+      <para>Starting with VirtualBox 3.2, the VRDP server can redirect video
       streams from the guest to the RDP client. Video frames are compressed
       using the JPEG algorithm allowing a higher compression ratio than
@@ -515 +517 @@
       compression ratio by lowering the video quality.</para>
 
-      <para>Video streams in a guest are detected by the RDP server
+      <para>Video streams in a guest are detected by the server
       automatically as frequently updated rectangular areas. Therefore, this
       method works with any guest operating system without having to install
@@ -529 +531 @@
       <para>The quality of the video is defined as a value from 10 to 100
       percent, as is common with JPEG compression. The quality can be changed
-      using the following command: <screen>VBoxManage modifyvm "VM name" --vrdpvideochannelquality 75</screen></para>
-    </sect2>
-
-    <sect2 id="vrdp-customization">
+      using the following command: <screen>VBoxManage modifyvm "VM name" --vrdevideochannelquality 75</screen></para>
+    </sect2>
+
+    <sect2 id="vrde-customization">
       <title>VRDP customization</title>
 
-      <para>Starting with VirtualBox 3.2.10, it is possible to disable display
+      <para>Starting with VirtualBox 4.0, it is possible to disable display
       output, mouse and keyboard input, audio, remote USB or clipboard in the
       VRDP server.</para>
 
-      <para>The following commands change corresponding server
-      settings:</para>
+      <para>The following commands change corresponding server settings:</para>
+
+      <screen>VBoxManage modifyvm "VM name" --vrdeproperty Client/DisableDisplay=1
+VBoxManage modifyvm "VM name" --vrdeproperty Client/DisableInput=1
+VBoxManage modifyvm "VM name" --vrdeproperty Client/DisableUSB=1
+VBoxManage modifyvm "VM name" --vrdeproperty Client/DisableAudio=1
+VBoxManage modifyvm "VM name" --vrdeproperty Client/DisableClipboard=1
+VBoxManage modifyvm "VM name" --vrdeproperty Client/DisableUpstreamAudio=1</screen>
+
+      <para>To reenable a feature use a similar command without the trailing
+      1. For example: <screen>VBoxManage modifyvm "VM name" --vrdeproperty Client/DisableDisplay=</screen></para>
+
+      <para>Note that with earlier releases of VirtualBox (3.2.10 or more recent 3.2 versions),
+      the following commands change corresponding server settings:</para>
 
       <screen>VBoxManage setextradata "VM name" "VRDP/Feature/Client/DisableDisplay" 1

trunk/doc/manual/en_US/user_Glossary.xml

@@ -319 +319 @@
         and keyboard and mouse input events are sent from the client.
         VirtualBox contains an enhanced implementation of the relevant
-        standards called "VirtualBox RDP" (VRDP), which is largely compatible
-        with Microsoft's RDP implementation. See <xref linkend="vrdp" /> for
-        details.</para>
+        standards implemented as a VirtualBox Remote Desktop Extension (VRDE),
+        which is largely compatible with Microsoft's RDP implementation.
+        See <xref linkend="vrde" /> for details.</para>
       </glossdef>
     </glossentry>
@@ -427 +427 @@
 
     <glossentry>
+      <glossterm>VRDE</glossterm>
+
+      <glossdef>
+        <para>VirtualBox Remote Desktop Extension -- allows remot eaccess to
+        virtual machines. VirtualBox provides a VRDE, which implements Remote
+        Desktop Protocol (see RDP).</para>
+      </glossdef>
+    </glossentry>
+
+    <glossentry>
       <glossterm>VRDP</glossterm>
 

trunk/doc/manual/en_US/user_Introduction.xml

@@ -353 +353 @@
         systems other than Windows (even in text mode) and does not require
         application support in the virtual machine either. The VRDE is
-        described in detail in <xref linkend="vrdp" />.</para>
+        described in detail in <xref linkend="vrde" />.</para>
 
         <para>On top of this special capacity, VirtualBox offers you more
@@ -363 +363 @@
               it includes an easy-to-use SDK which allows you to create
               arbitrary interfaces for other methods of authentication; see
-              <xref linkend="vbox-authenticate-sdk" /> for details.</para>
+              <xref linkend="vbox-auth" /> for details.</para>
             </listitem>
 
@@ -533 +533 @@
               <listitem>
                 <para>VirtualBox Remote Desktop Protocol (VRDP) support; see
-                <xref linkend="vrdp" />.</para>
+                <xref linkend="vrde" />.</para>
               </listitem>
 

trunk/doc/manual/en_US/user_Technical.xml

@@ -369 +369 @@
           <para><computeroutput>VBoxHeadless</computeroutput>, a VM front end
           which does not directly provide any video output and keyboard/mouse
-          input, but allows redirection via VRDP; see <xref
-          linkend="vboxheadless" />.</para>
+          input, but allows redirection via VirtualBox Remote Desktop Extension;
+          see <xref linkend="vboxheadless" />.</para>
         </listitem>
 

trunk/doc/manual/en_US/user_Troubleshooting.xml

@@ -879 +879 @@
       input (moving the mouse over a menu is the most obvious situation) and
       output. This is because this RDP client collects input for a certain
-      time before sending it to the VRDP server built into VirtualBox.</para>
+      time before sending it to the RDP server.</para>
 
       <para>The interval can be decreased by setting a Windows registry key to

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -311 +311 @@
 Audio:           disabled (Driver: Unknown)
 Clipboard Mode:  Bidirectional
-VRDP:            disabled
+VRDE:            disabled
 USB:             disabled
 
@@ -833 +833 @@
 
     <sect2 id="vboxmanage-modifyvm-other">
-      <title>Serial port, audio, clipboard, VRDP and USB settings</title>
+      <title>Serial port, audio, clipboard, remote desktop and USB settings</title>
 
       <para>The following other hardware settings are available through
@@ -936 +936 @@
       modifyvm</computeroutput>:<itemizedlist>
           <listitem>
-            <para><computeroutput>--vrdp on|off</computeroutput>: With the
+            <para><computeroutput>--vrde on|off</computeroutput>: With the
             VirtualBox graphical user interface, this enables or disables the
-            built-in VRDP server. Note that if you are using
+            VirtualBox remote desktop extension (VRDE) server. Note that if you are using
             <computeroutput>VBoxHeadless</computeroutput> (see <xref
-            linkend="vboxheadless" />), VRDP output is always enabled.</para>
-          </listitem>
-
-          <listitem>
-            <para><computeroutput>--vrdpport
+            linkend="vboxheadless" />), VRDE is enabled by default.</para>
+          </listitem>
+
+          <listitem>
+            <para><computeroutput>--vrdeport
             default|&lt;ports&gt;</computeroutput>: A port or a range of ports
-            the VRDP server can bind to; "default" or "0" means port 3389, the
+            the VRDE server can bind to; "default" or "0" means port 3389, the
             standard port for RDP. You can specify a comma-separated list of
             ports or ranges of ports. Use a dash between two port numbers to
-            specify a range. The VRDP server will bind to <emphasis
+            specify a range. The VRDE server will bind to <emphasis
             role="bold">one</emphasis> of available ports from the specified
             list. Only one machine can use a given port at a time. For
-            example, the option <computeroutput> --vrdpport
+            example, the option <computeroutput> --vrdeport
             5000,5010-5012</computeroutput> will tell the server to bind to
             one of following ports: 5000, 5010, 5011 or 5012.</para>
@@ -958 +958 @@
 
           <listitem>
-            <para><computeroutput>--vrdpaddress &lt;IP
+            <para><computeroutput>--vrdeaddress &lt;IP
             address&gt;</computeroutput>: The IP address of the host network
-            interface the VRDP server will bind to. If specified, the VRDP
+            interface the VRDE server will bind to. If specified, the
             server will accept connections only on the specified host network
             interface.</para>
@@ -973 +973 @@
 
           <listitem>
-            <para><computeroutput>--vrdpmulticon on|off</computeroutput>: This
-            enables multiple VRDP connections to the same VRDP server; see
-            <xref lang="" linkend="vrdp-multiconnection" />.</para>
-          </listitem>
-
-          <listitem>
-            <para><computeroutput>--vrdpreusecon on|off</computeroutput>: This
-            specifies the VRDP server behavior when multiple connections are
-            disabled. When this option is enabled, the VRDP server will allow
-            a new client to connect and drop the existing connection. When
+            <para><computeroutput>--vrdemulticon on|off</computeroutput>: This
+            enables multiple connections to the same VRDE server, if the server
+            supports this feature; see
+            <xref lang="" linkend="vrde-multiconnection" />.</para>
+          </listitem>
+
+          <listitem>
+            <para><computeroutput>--vrdereusecon on|off</computeroutput>: This
+            specifies the VRDE server behavior when multiple connections are
+            disabled. When this option is enabled, the server will allow
+            a new client to connect and will drop the existing connection. When
             this option is disabled (this is the default setting), a new
             connection will not be accepted if there is already a client
@@ -989 +990 @@
 
           <listitem>
-            <para><computeroutput>--vrdpvideochannel on|off</computeroutput>:
-            This enables VRDP video acceleration; see <xref lang=""
-            linkend="vrdp-videochannel" />.</para>
-          </listitem>
-
-          <listitem>
-            <para><computeroutput>--vrdpvideochannelquality
-            &lt;percent&gt;</computeroutput>: Sets the image quality for VRDP
-            video acceleration; see <xref lang=""
-            linkend="vrdp-videochannel" />.</para>
+            <para><computeroutput>--vrdevideochannel on|off</computeroutput>:
+            This enables video redirection, if it is supported by the VRDE server;
+            see <xref lang="" linkend="vrde-videochannel" />.</para>
+          </listitem>
+
+          <listitem>
+            <para><computeroutput>--vrdevideochannelquality
+            &lt;percent&gt;</computeroutput>: Sets the image quality for
+            video redirection; see <xref lang=""
+            linkend="vrde-videochannel" />.</para>
           </listitem>
         </itemizedlist></para>
@@ -1188 +1189 @@
     determines whether the machine will be started in a window (GUI mode,
     which is the default) or whether the output should go through
-    <computeroutput>VBoxHeadless</computeroutput>, with VRDP enabled or not;
+    <computeroutput>VBoxHeadless</computeroutput>, with VRDE enabled or not;
     see <xref linkend="vboxheadless" /> for more information. The list of
     types is subject to change, and it's not guaranteed that all types are
@@ -1205 +1206 @@
 
       <glossentry>
-        <glossterm>vrdp</glossterm>
+        <glossterm>headless</glossterm>
 
         <glossdef>
-          <para>Starts a VM showing a GUI window, with its graphics card
-          output accessible by an RDP client.</para>
-        </glossdef>
-      </glossentry>
-
-      <glossentry>
-        <glossterm>headless</glossterm>
-
-        <glossdef>
-          <para>Starts a VM without a window for remote RDP display
+          <para>Starts a VM without a window for remote display
           only.</para>
         </glossdef>
@@ -1336 +1328 @@
 
       <listitem>
-        <para><computeroutput>vrdp on|off</computeroutput> lets you enable or
-        disable the built-in VRDP server.</para>
+        <para><computeroutput>vrde on|off</computeroutput> lets you enable or
+        disable the VRDE server, if it is installed.</para>
       </listitem>
 
       <listitem>
-        <para><computeroutput>vrdpport default|&lt;ports&gt;</computeroutput>
-        changes the port or a range of ports that the VRDP server can bind to;
+        <para><computeroutput>vrdeport default|&lt;ports&gt;</computeroutput>
+        changes the port or a range of ports that the VRDE server can bind to;
         "default" or "0" means port 3389, the standard port for RDP. For
         details, see the description for the
-        <computeroutput>--vrdpport</computeroutput> option in <xref
+        <computeroutput>--vrdeport</computeroutput> option in <xref
         linkend="vboxmanage-modifyvm-other" />.</para>
       </listitem>