| 1 |
.TH RDESKTOP 1 "September 2002" "Manual page for rdesktop" |
.TH rdesktop 1 "March 2005" |
|
.\" |
|
|
.\" Man page author: |
|
|
.\" Hugo Trippaers <spark@ision.nl> |
|
|
.\" Peter Åstrand <peter@cendio.se> |
|
| 2 |
.SH NAME |
.SH NAME |
| 3 |
.I rdesktop |
.I rdesktop |
| 4 |
\- Remote Desktop Protocol client |
\- Remote Desktop Protocol client |
| 5 |
.SH SYNOPSIS |
.SH SYNOPSIS |
| 6 |
.B rdesktop [options] server |
.B rdesktop [options] server[:port] |
| 7 |
.br |
.br |
| 8 |
.SH DESCRIPTION |
.SH DESCRIPTION |
| 9 |
.I rdesktop |
.I rdesktop |
| 10 |
is a client for Windows NT4 Terminal Server and Windows 2000 Terminal |
is a client for Remote Desktop Protocol (RDP), used in a number of Microsoft |
| 11 |
Services. rdesktop implements the RDP version 4 protocol, which used |
products including Windows NT Terminal Server, Windows 2000 Server, Windows XP |
| 12 |
by Windows NT4 Terminal Server, and parts of RDP version 5, which is |
and Windows 2003 Server. |
|
used by Windows 2000 Terminal Services. |
|
| 13 |
|
|
| 14 |
.SH OPTIONS |
.SH OPTIONS |
| 15 |
.TP |
.TP |
| 16 |
.BR "-u <username>" |
.BR "-u <username>" |
| 17 |
The username for authentication on the terminal server, together with -p |
Username for authentication on the server. |
|
this can be used for autologon. |
|
| 18 |
.TP |
.TP |
| 19 |
.BR "-d <domain>" |
.BR "-d <domain>" |
| 20 |
The domain to to which the user belongs. |
Domain for authentication. |
| 21 |
.TP |
.TP |
| 22 |
.BR "-s <shell>" |
.BR "-s <shell>" |
| 23 |
The startup shell for the user. Use this to start a specific application, |
Startup shell for the user - starts a specific application instead of Explorer. |
|
instead of a regular desktop. |
|
| 24 |
.TP |
.TP |
| 25 |
.BR "-c <directory>" |
.BR "-c <directory>" |
| 26 |
The current working directory for the user. Often used in combination with -s |
The initial working directory for the user. Often used in combination with -s |
| 27 |
to setup a fixed environment for the user after logon. |
to set up a fixed login environment. |
| 28 |
.TP |
.TP |
| 29 |
.BR "-p <password>" |
.BR "-p <password>" |
| 30 |
The password to authenticate with. Use -p - to make rdesktop request a |
The password to authenticate with. Note that this may have no effect if |
| 31 |
password at startup (from standard input). |
"Always prompt for password" is enabled on the server. WARNING: if you specify |
| 32 |
WARNING: if you specify a password on the command line it may be visible |
a password on the command line it may be visible to other users when they use |
| 33 |
to other users when they use tools like ps. |
tools like ps. Use -p - to make rdesktop request a password at startup (from |
| 34 |
.TP |
standard input). |
| 35 |
.BR "-n <name>" |
.TP |
| 36 |
Client name. The default is the hostname. |
.BR "-n <hostname>" |
| 37 |
|
Client hostname. Normally rdesktop automatically obtains the hostname of the |
| 38 |
|
client. |
| 39 |
.TP |
.TP |
| 40 |
.BR "-k <layout>" |
.BR "-k <layout>" |
| 41 |
keyboard layout on terminal server (us,sv,gr etc.) |
Keyboard layout to emulate. This requires a corresponding keymap file to be |
| 42 |
|
installed. The standard keymaps provided with rdesktop follow the RFC1766 |
| 43 |
|
naming scheme: a language code followed by a country code if necessary - e.g. |
| 44 |
|
en-us, en-gb, de, fr, sv, etc. The default is en-us (a US keyboard). |
| 45 |
.TP |
.TP |
| 46 |
.BR "-g <geometry>" |
.BR "-g <geometry>" |
| 47 |
Desktop geometry (WxH). |
Desktop geometry (WxH). If geometry is the special word "workarea", the geometry |
| 48 |
|
will be fetched from the extended window manager hints property _NET_WORKAREA, from |
| 49 |
|
the root window. The geometry can also be specified as a percentage of the whole |
| 50 |
|
screen, e.g. "-g 80%". |
| 51 |
.TP |
.TP |
| 52 |
.BR "-f" |
.BR "-f" |
| 53 |
Enable fullscreen mode. The -g option will be ignored when using -f, |
Enable fullscreen mode. This overrides the window manager and causes the |
| 54 |
rdesktop will get the current height and width from the current |
rdesktop window to fully cover the current screen. Fullscreen mode can be |
| 55 |
desktop. |
toggled at any time using Ctrl-Alt-Enter. |
| 56 |
.TP |
.TP |
| 57 |
.BR "-b" |
.BR "-b" |
| 58 |
Force bitmap updates. |
Force the server to send screen updates as bitmaps rather than using |
| 59 |
|
higher-level drawing operations. |
| 60 |
|
.TP |
| 61 |
|
.BR "-B" |
| 62 |
|
Use the BackingStore of the Xserver instead of the integrated one in |
| 63 |
|
rdesktop. |
| 64 |
.TP |
.TP |
| 65 |
.BR "-e" |
.BR "-e" |
| 66 |
Do not use encryption, this is only for people who are not allowed to |
Disable encryption. This option is only needed (and will only work) if you |
| 67 |
use encryption in Windows products. If you live in France you |
have a French version of NT TSE. |
| 68 |
probably need this switch. |
.TP |
| 69 |
|
.BR "-E" |
| 70 |
|
Disable encryption from client to server. This sends an encrypted login packet, |
| 71 |
|
but everything after this is unencrypted (including interactive logins). |
| 72 |
.TP |
.TP |
| 73 |
.BR "-m" |
.BR "-m" |
| 74 |
Do not send motion events. |
Do not send mouse motion events. This saves bandwidth, although some Windows |
| 75 |
|
applications may rely on receiving mouse motion. |
| 76 |
.TP |
.TP |
| 77 |
.BR "-l" |
.BR "-C" |
| 78 |
Do not request licence. |
Use private colourmap. This will improve colour accuracy on an 8-bit display, |
| 79 |
|
but rdesktop will appear in false colour when not focused. |
| 80 |
.TP |
.TP |
| 81 |
.BR "-t <port>" |
.BR "-D" |
| 82 |
Connect to this TCP port. The default is 3389. |
Hide window manager decorations, by using MWM hints. |
| 83 |
.TP |
.TP |
| 84 |
.BR "-K" |
.BR "-K" |
| 85 |
Keep window manager key bindings. |
Do not override window manager key bindings. By default rdesktop attempts |
| 86 |
|
to grab all keyboard input when it is in focus. |
| 87 |
.TP |
.TP |
| 88 |
.BR "-w <title>" |
.BR "-S <button size>" |
| 89 |
Set window title to <title>. |
Enable single application mode. This option can be used when running a |
| 90 |
|
single, maximized application (via -s). When the minimize button of |
| 91 |
|
the windows application is pressed, the rdesktop window is minimized |
| 92 |
|
instead of the remote application. The maximize/restore button is |
| 93 |
|
disabled. For this to work, you must specify the correct button |
| 94 |
|
size, in pixels. The special word "standard" means 18 pixels. |
| 95 |
|
.TP |
| 96 |
|
.BR "-T <title>" |
| 97 |
|
Sets the window title. |
| 98 |
|
.TP |
| 99 |
|
.BR "-N" |
| 100 |
|
Enable numlock syncronization between the Xserver and the remote RDP |
| 101 |
|
session. This is useful with applications that looks at the numlock |
| 102 |
|
state, but might cause problems with some Xservers like Xvnc. |
| 103 |
|
.TP |
| 104 |
|
.BR "-X <windowid>" |
| 105 |
|
Embed rdesktop-window in another window. The windowid is expected to |
| 106 |
|
be decimal or hexadecimal (prefixed by 0x). |
| 107 |
|
.TP |
| 108 |
|
.BR "-a <bpp>" |
| 109 |
|
Sets the colour depth for the connection (8, 15, 16 or 24). |
| 110 |
|
More than 8 bpp are only supported when connecting to Windows XP |
| 111 |
|
(up to 16 bpp) or newer. Note that the colour depth may also be |
| 112 |
|
limited by the server configuration. |
| 113 |
|
.TP |
| 114 |
|
.BR "-z" |
| 115 |
|
Enable compression of the RDP datastream. This currently only works |
| 116 |
|
for a colour depth of 8bpp. |
| 117 |
|
.TP |
| 118 |
|
.BR "-x <experience>" |
| 119 |
|
Changes default bandwidth performance behaviour for RDP5. By default only |
| 120 |
|
theming is enabled, and all other options are disabled (corresponding |
| 121 |
|
to modem (56 Kbps)). Setting experience to b[roadband] enables menu |
| 122 |
|
animations and full window dragging. Setting experience to l[an] will |
| 123 |
|
also enable the desktop wallpaper. Setting experience to m[odem] |
| 124 |
|
disables all (including themes). Experience can also be a hexidecimal |
| 125 |
|
number containing the flags. |
| 126 |
|
.TP |
| 127 |
|
.BR "-P" |
| 128 |
|
Enable caching of bitmaps to disk (persistent bitmap caching). This generally |
| 129 |
|
improves performance (especially on low bandwidth connections) and reduces |
| 130 |
|
network traffic at the cost of slightly longer startup and some disk space. |
| 131 |
|
(10MB for 8-bit colour, 20MB for 15/16-bit colour and 30MB for 24-bit colour |
| 132 |
|
sessions) |
| 133 |
|
.TP |
| 134 |
|
.BR "-r <device>" |
| 135 |
|
Enable redirection of the specified device on the client, such |
| 136 |
|
that it appears on the server. Note that the allowed |
| 137 |
|
redirections may be restricted by the server configuration. |
| 138 |
|
|
| 139 |
|
Following devices are currently supported: |
| 140 |
|
.TP |
| 141 |
|
.BR "-r comport:<comport>=<device>,..." |
| 142 |
|
Redirects serial devices on your client to the |
| 143 |
|
server. Note that if you need to change any settings on the serial device(s), |
| 144 |
|
do so with an appropriate tool before starting rdesktop. In most |
| 145 |
|
OSes you would use stty. Bidirectional/Read support requires Windows XP or newer. |
| 146 |
|
In Windows 2000 it will create a port, but it's not seamless, most |
| 147 |
|
shell programs will not work with it. |
| 148 |
|
.TP |
| 149 |
|
.BR "-r disk:<sharename>=<path>,..." |
| 150 |
|
Redirects a path to the share \\\\tsclient\\<sharename> on the server |
| 151 |
|
(requires Windows XP or newer). The share name is limited to 8 |
| 152 |
|
characters. |
| 153 |
|
.TP |
| 154 |
|
.BR "-r lptport:<lptport>=<device>,..." |
| 155 |
|
Redirects parallel devices on your client to the server. |
| 156 |
|
Bidirectional/Read support requires Windows XP or newer. In Windows 2000 |
| 157 |
|
it will create a port, but it's not seamless, most shell programs will not work with |
| 158 |
|
it. |
| 159 |
|
.TP |
| 160 |
|
.BR "-r printer:<printername>[=<driver>],..." |
| 161 |
|
Redirects a printer queue on the client to the server. The <printername> |
| 162 |
|
is the name of the queue in your local system. <driver> defaults to a |
| 163 |
|
simple PS-driver unless you specify one. Keep in mind that you need a |
| 164 |
|
100% match in the server environment, or the driver will fail. The first |
| 165 |
|
printer on the command line will be set as your default printer. |
| 166 |
|
.TP |
| 167 |
|
.BR "-r sound:[local|off|remote]" |
| 168 |
|
Redirects sound generated on the server to the client. "remote" only has |
| 169 |
|
any effect when you connect to the console with the -0 option. (Requires |
| 170 |
|
Windows XP or newer). |
| 171 |
|
.TP |
| 172 |
|
.BR "-0" |
| 173 |
|
Attach to the console of the server (requires Windows Server 2003 |
| 174 |
|
or newer). |
| 175 |
|
.TP |
| 176 |
|
.BR "-4" |
| 177 |
|
Use RDP version 4. |
| 178 |
|
.TP |
| 179 |
|
.BR "-5" |
| 180 |
|
Use RDP version 5 (default). |
| 181 |
.PP |
.PP |
|
.SH "RETURN VALUES" |
|
|
None are defined (yet). |
|
| 182 |
.SH LINKS |
.SH LINKS |
| 183 |
Main website of rdesktop |
Main website of rdesktop |
| 184 |
.br |
.br |
| 185 |
\fIhttp://www.rdesktop.org |
\fIhttp://www.rdesktop.org/ |
| 186 |
.LP |
.LP |
|
.SH BUGS |
|
|
We suggest you visit the website at http://www.rdesktop.org and follow |
|
|
the links to the Bug Tracker. |
|
|
.SH VERSION |
|
|
This manual page documents version 1.2. |
|
|
.SH AUTHOR |
|
|
rdesktop is written by Matt Chapman <matthewc@cse.unsw.edu.au> |
|
|
.LP |
|
|
The following persons have contributed to the project: |
|
|
.LP |
|
|
Peter Bystrom <peter.bystrom@ub.oru.se> |
|
|
.br |
|
|
Hugo Trippaers <spark@ision.nl> |
|
|
.br |
|
|
Jay Sorg |
|
|
.br |
|
|
Peter Åstrand |
|
|
.SH THANKS |
|
|
Thanks to all the mailinglist members for their contributions to rdesktop. |
|
| 187 |
.PP |
.PP |
Parent Directory
| 
Revision Log
| 
Patch