- Timestamp:
- Jul 27, 2016 6:15:01 PM (8 years ago)
- File:
-
- 1 edited
-
trunk/doc/manual/en_US/user_VBoxManage.xml (modified) (4 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/doc/manual/en_US/user_VBoxManage.xml
r62378 r62611 1323 1323 </listitem> 1324 1324 1325 <!-- @todo r=andy Document vrdeproperty --> 1325 <listitem> 1326 <para><computeroutput>--vrdeproperty "TCP/Ports|Address=<value>"</computeroutput> 1327 sets the port number(s) and IP address on the VM that the VRDE server can bind to.</para> 1328 1329 <itemizedlist> 1330 <listitem> 1331 <para>For TCP/Ports, <value> should be a port or a range of ports that the VRDE 1332 server can bind to; "default" or "0" means port 3389, the standard port for RDP. 1333 For details, see the description for the 1334 <computeroutput>--vrdeport</computeroutput> option in <xref 1335 linkend="vboxmanage-modifyvm-vrde" />.</para> 1336 </listitem> 1337 1338 <listitem> 1339 <para>For TCP/Address, <value> should be the IP address of the host network 1340 interface that the VRDE server will bind to. If specified, the server 1341 will accept connections only on the specified host network interface. 1342 For details, see the description for the 1343 <computeroutput>--vrdeaddress</computeroutput> option in <xref 1344 linkend="vboxmanage-modifyvm-vrde" />.</para> 1345 </listitem> 1346 </itemizedlist> 1347 </listitem> 1348 1349 <listitem> 1350 <para><computeroutput>--vrdeproperty "VideoChannel/Enabled|Quality|DownscaleProtection=<value>"</computeroutput> 1351 sets the VRDP video redirection properties.</para> 1352 <itemizedlist> 1353 <listitem> 1354 <para>For VideoChannel/Enabled, <value> can be set to "1" switching the VRDP video channel on. 1355 For details, see <xref linkend="vrde-videochannel" />.</para> 1356 </listitem> 1357 1358 <listitem> 1359 <para>For VideoChannel/Quality, <value> should be set between 10 and 100% inclusive, 1360 representing a JPEG compression level on the VRDE server video channel. Lower values mean lower 1361 quality but higher compression. For details, see <xref linkend="vrde-videochannel" />.</para> 1362 </listitem> 1363 1364 <listitem> 1365 <para>For VideoChannel/DownscaleProtection, <value> can be set to "1" to 1366 enable the videochannel downscale protection feature. When enabled, if a video's size equals the shadow buffer 1367 size, then it is regarded as a full screen video, and is displayed; but if its size is between fullscreen and the downscale 1368 threshold - it is NOT displayed, as it could be an application window, which would be unreadable when downscaled. 1369 When the downscale protection feature is disabled, an attempt is always made to display videos.</para> 1370 </listitem> 1371 </itemizedlist> 1372 </listitem> 1373 1374 <listitem> 1375 <para><computeroutput>--vrdeproperty "Client/DisableDisplay|DisableInput|DisableAudio|DisableUSB=1"</computeroutput></para> 1376 <para>disables one of the VRDE server features: Display, Input, Audio or USB respectively. 1377 To re-enable a feature, use e.g. "Client/DisableDisplay=". 1378 For details, see <xref linkend="vrde-customization" />.</para> 1379 </listitem> 1380 1381 <listitem> 1382 <para><computeroutput>--vrdeproperty "Client/DisableClipboard|DisableUpstreamAudio=1"</computeroutput></para> 1383 <para>disables one of the VRDE server features: Clipboard or UpstreamAudio respectively. 1384 To re-enable a feature, use e.g. "Client/DisableClipboard=". 1385 For details, see <xref linkend="vrde-customization" />.</para> 1386 </listitem> 1387 1388 <listitem> 1389 <para><computeroutput>--vrdeproperty "Client/DisableRDPDR=1"</computeroutput></para> 1390 <para>disables the VRDE server feature: RDP device redirection for smart cards. 1391 To re-enable this feature, use "Client/DisableRDPR=".</para> 1392 </listitem> 1393 1394 <listitem> 1395 <para><computeroutput>--vrdeproperty "H3DRedirect/Enabled=1"</computeroutput></para> 1396 <para>enables the VRDE server feature: 3D redirection. 1397 To re-disable this feature, use "H3DRedirect/Enabled=".</para> 1398 </listitem> 1399 1400 <listitem> 1401 <para><computeroutput>--vrdeproperty "Security/Method|ServerCertificate|ServerPrivateKey|CACertificate=<value>"</computeroutput> 1402 sets the desired security method/Path of server certificate, path of server private key, path of CA certificate, used for a connection. 1403 1404 <itemizedlist> 1405 <listitem> 1406 <para><computeroutput>--vrdeproperty "Security/Method=<value>"</computeroutput> 1407 sets the desired security method, which is used for a connection. Valid values are: 1408 <itemizedlist> 1409 <listitem> 1410 <para> <computeroutput>Negotiate</computeroutput> - both Enhanced (TLS) 1411 and Standard RDP Security connections are allowed. The security 1412 method is negotiated with the client. This is the default setting.</para> 1413 </listitem> 1414 <listitem> 1415 <para> <computeroutput>RDP</computeroutput> - only Standard RDP Security is accepted.</para> 1416 </listitem> 1417 <listitem> 1418 <para> <computeroutput>TLS</computeroutput> - only Enhanced RDP Security is accepted. 1419 The client must support TLS.</para> 1420 </listitem> 1421 </itemizedlist> 1422 For details, see <xref linkend="vrde-crypt" />.</para> 1423 </listitem> 1424 1425 <listitem> 1426 <para><computeroutput>--vrdeproperty "Security/ServerCertificate=<value>"</computeroutput> 1427 where <value> is the absolute path of the server certificate. 1428 For details, see <xref linkend="vrde-crypt" />.</para> 1429 </listitem> 1430 1431 <listitem> 1432 <para><computeroutput>--vrdeproperty "Security/ServerPrivateKey=<value>"</computeroutput> 1433 where <value> is the absolute path of the server private key. 1434 For details, see <xref linkend="vrde-crypt" />.</para> 1435 </listitem> 1436 1437 <listitem> 1438 <para><computeroutput>--vrdeproperty "Security/CACertificate=<value>"</computeroutput> 1439 where <value> is the absolute path of the CA self signed certificate. 1440 For details, see <xref linkend="vrde-crypt" />.</para> 1441 </listitem> 1442 </itemizedlist></para> 1443 </listitem> 1444 1445 <listitem> 1446 <para><computeroutput>--vrdeproperty "Audio/RateCorrectionMode|LogPath=<value>"</computeroutput> 1447 sets the Audio connection mode, or Path of the audio logfile. 1448 1449 <itemizedlist> 1450 <listitem> 1451 <para><computeroutput>--vrdeproperty "Audio/RateCorrectionMode=<value>"</computeroutput> 1452 where <value> is the desired rate correction mode, allowed values are: 1453 <itemizedlist> 1454 <listitem> 1455 <para> <computeroutput>VRDP_AUDIO_MODE_VOID</computeroutput> - no mode specified, use to unset any Audio mode already set.</para> 1456 </listitem> 1457 <listitem> 1458 <para> <computeroutput>VRDP_AUDIO_MODE_RC</computeroutput> - rate correction mode.</para> 1459 </listitem> 1460 <listitem> 1461 <para> <computeroutput>VRDP_AUDIO_MODE_LPF</computeroutput> - low pass filter mode.</para> 1462 </listitem> 1463 <listitem> 1464 <para> <computeroutput>VRDP_AUDIO_MODE_CS</computeroutput> - client sync mode to prevent under/overflow of the client queue.</para> 1465 </listitem> 1466 </itemizedlist></para> 1467 </listitem> 1468 <listitem> 1469 <para><computeroutput>--vrdeproperty "Audio/LogPath=<value>"</computeroutput> 1470 where <value> is the absolute path of the Audio log file.</para> 1471 </listitem> 1472 </itemizedlist></para> 1473 </listitem> 1326 1474 1327 1475 <listitem> … … 2000 2148 details, see the description for the 2001 2149 <computeroutput>--vrdeport</computeroutput> option in <xref 2002 linkend="vboxmanage-modifyvm-other" />.</para> 2003 </listitem> 2004 2150 linkend="vboxmanage-modifyvm-vrde" />.</para> 2151 </listitem> 2152 2153 <listitem> 2154 <para><computeroutput>vrdeproperty "TCP/Ports|Address=<value>"</computeroutput> 2155 sets the port number(s) and IP address on the VM that the VRDE server can bind to.</para> 2156 2157 <itemizedlist> 2158 <listitem> 2159 <para>For TCP/Ports, <value> should be a port or a range of ports that the VRDE 2160 server can bind to; "default" or "0" means port 3389, the standard port for RDP. 2161 For details, see the description for the 2162 <computeroutput>--vrdeport</computeroutput> option in <xref 2163 linkend="vboxmanage-modifyvm-vrde" />.</para> 2164 </listitem> 2165 2166 <listitem> 2167 <para>For TCP/Address, <value> should be the IP address of the host network 2168 interface that the VRDE server will bind to. If specified, the server 2169 will accept connections only on the specified host network interface. 2170 For details, see the description for the 2171 <computeroutput>--vrdeaddress</computeroutput> option in <xref 2172 linkend="vboxmanage-modifyvm-vrde" />.</para> 2173 </listitem> 2174 </itemizedlist> 2175 </listitem> 2176 2177 <listitem> 2178 <para><computeroutput>vrdeproperty "VideoChannel/Enabled|Quality|DownscaleProtection=<value>"</computeroutput> 2179 sets the VRDP video redirection properties.</para> 2180 <itemizedlist> 2181 <listitem> 2182 <para>For VideoChannel/Enabled, <value> can be set to "1" switching the VRDP video channel on. 2183 For details, see <xref linkend="vrde-videochannel" />.</para> 2184 </listitem> 2185 2186 <listitem> 2187 <para>For VideoChannel/Quality, <value> should be set between 10 and 100% inclusive, 2188 representing a JPEG compression level on the VRDE server video channel. Lower values mean lower 2189 quality but higher compression. For details, see <xref linkend="vrde-videochannel" />.</para> 2190 </listitem> 2191 2192 <listitem> 2193 <para>For VideoChannel/DownscaleProtection, <value> can be set to "1" to 2194 enable the videochannel downscale protection feature. When enabled, if a video's size equals the shadow buffer 2195 size, then it is regarded as a full screen video, and is displayed; but if its size is between fullscreen and the downscale 2196 threshold - it is NOT displayed, as it could be an application window, which would be unreadable when downscaled. 2197 When the downscale protection feature is disabled, an attempt is always made to display videos.</para> 2198 </listitem> 2199 </itemizedlist> 2200 </listitem> 2201 2202 <listitem> 2203 <para><computeroutput>vrdeproperty "Client/DisableDisplay|DisableInput|DisableAudio|DisableUSB=1"</computeroutput></para> 2204 <para>disables one of the VRDE server features: Display, Input, Audio or USB respectively. 2205 To re-enable a feature, use e.g. "Client/DisableDisplay=". 2206 For details, see <xref linkend="vrde-customization" />.</para> 2207 </listitem> 2208 2209 <listitem> 2210 <para><computeroutput>vrdeproperty "Client/DisableClipboard|DisableUpstreamAudio=1"</computeroutput></para> 2211 <para>disables one of the VRDE server features: Clipboard or UpstreamAudio respectively. 2212 To re-enable a feature, use e.g. "Client/DisableClipboard=". 2213 For details, see <xref linkend="vrde-customization" />.</para> 2214 </listitem> 2215 2216 <listitem> 2217 <para><computeroutput>vrdeproperty "Client/DisableRDPDR=1"</computeroutput></para> 2218 <para>disables the VRDE server feature: RDP device redirection for smart cards. 2219 To re-enable this feature, use "Client/DisableRDPR=".</para> 2220 </listitem> 2221 2222 <listitem> 2223 <para><computeroutput>vrdeproperty "H3DRedirect/Enabled=1"</computeroutput></para> 2224 <para>enables the VRDE server feature: 3D redirection. 2225 To re-disable this feature, use "H3DRedirect/Enabled=".</para> 2226 </listitem> 2227 2228 <listitem> 2229 <para><computeroutput>vrdeproperty "Security/Method|ServerCertificate|ServerPrivateKey|CACertificate=<value>"</computeroutput> 2230 sets the desired security method/Path of server certificate, path of server private key, path of CA certificate, used for a connection. 2231 2232 <itemizedlist> 2233 <listitem> 2234 <para><computeroutput>vrdeproperty "Security/Method=<value>"</computeroutput> 2235 sets the desired security method, which is used for a connection. Valid values are: 2236 <itemizedlist> 2237 <listitem> 2238 <para> <computeroutput>Negotiate</computeroutput> - both Enhanced (TLS) 2239 and Standard RDP Security connections are allowed. The security 2240 method is negotiated with the client. This is the default setting.</para> 2241 </listitem> 2242 <listitem> 2243 <para> <computeroutput>RDP</computeroutput> - only Standard RDP Security is accepted.</para> 2244 </listitem> 2245 <listitem> 2246 <para> <computeroutput>TLS</computeroutput> - only Enhanced RDP Security is accepted. 2247 The client must support TLS.</para> 2248 </listitem> 2249 </itemizedlist> 2250 For details, see <xref linkend="vrde-crypt" />.</para> 2251 </listitem> 2252 2253 <listitem> 2254 <para><computeroutput>vrdeproperty "Security/ServerCertificate=<value>"</computeroutput> 2255 where <value> is the absolute path of the server certificate. 2256 For details, see <xref linkend="vrde-crypt" />.</para> 2257 </listitem> 2258 2259 <listitem> 2260 <para><computeroutput>vrdeproperty "Security/ServerPrivateKey=<value>"</computeroutput> 2261 where <value> is the absolute path of the server private key. 2262 For details, see <xref linkend="vrde-crypt" />.</para> 2263 </listitem> 2264 2265 <listitem> 2266 <para><computeroutput>vrdeproperty "Security/CACertificate=<value>"</computeroutput> 2267 where <value> is the absolute path of the CA self signed certificate. 2268 For details, see <xref linkend="vrde-crypt" />.</para> 2269 </listitem> 2270 </itemizedlist></para> 2271 </listitem> 2272 2273 <listitem> 2274 <para><computeroutput>vrdeproperty "Audio/RateCorrectionMode|LogPath=<value>"</computeroutput> 2275 sets the Audio connection mode, or Path of the audio logfile. 2276 2277 <itemizedlist> 2278 <listitem> 2279 <para><computeroutput>vrdeproperty "Audio/RateCorrectionMode=<value>"</computeroutput> 2280 where <value> is the desired rate correction mode, allowed values are: 2281 <itemizedlist> 2282 <listitem> 2283 <para> <computeroutput>VRDP_AUDIO_MODE_VOID</computeroutput> - no mode specified, use to unset any Audio mode already set.</para> 2284 </listitem> 2285 <listitem> 2286 <para> <computeroutput>VRDP_AUDIO_MODE_RC</computeroutput> - rate correction mode.</para> 2287 </listitem> 2288 <listitem> 2289 <para> <computeroutput>VRDP_AUDIO_MODE_LPF</computeroutput> - low pass filter mode.</para> 2290 </listitem> 2291 <listitem> 2292 <para> <computeroutput>VRDP_AUDIO_MODE_CS</computeroutput> - client sync mode to prevent under/overflow of the client queue.</para> 2293 </listitem> 2294 </itemizedlist></para> 2295 </listitem> 2296 <listitem> 2297 <para><computeroutput>vrdeproperty "Audio/LogPath=<value>"</computeroutput> 2298 where <value> is the absolute path of the Audio log file.</para> 2299 </listitem> 2300 </itemizedlist></para> 2301 </listitem> 2302 2005 2303 <listitem> 2006 2304 <para><computeroutput>vrdevideochannelquality … … 2157 2455 <para>The following settings are supported:</para> 2158 2456 2159 <para>MaxFramerate (default no maximum limit) - this specifies the highest rate ( Frames/sec) at which2457 <para>MaxFramerate (default no maximum limit) - this specifies the highest rate (frames/sec) at which 2160 2458 video frames are sent to the guest. Higher frame rates increase CPU load, so this setting can be useful 2161 when there is a need to reduce CPU load. Its default 'value' is "no maximum limit", thus enabling the2459 when there is a need to reduce CPU load. Its default 'value' is 'no maximum limit', thus enabling the 2162 2460 guest to use all frame rates supported by the host webcam.</para> 2163 2461 … … 2184 2482 <para>OS X version 10.7 or newer is required.</para> 2185 2483 2186 <para>When the webcam device is detached from the host, the emulated webcam device remains i2484 <para>When the webcam device is detached from the host, the emulated webcam device remains 2187 2485 attached to the guest and must be manually detached using the 2188 2486 VBoxManage controlvm "VM name" webcam detach command.</para>
Note:
See TracChangeset
for help on using the changeset viewer.
