1 |
stargo |
828 |
.TH rdesktop 1 "March 2005" |
2 |
astrand |
106 |
.SH NAME |
3 |
|
|
.I rdesktop |
4 |
|
|
\- Remote Desktop Protocol client |
5 |
|
|
.SH SYNOPSIS |
6 |
matthewc |
232 |
.B rdesktop [options] server[:port] |
7 |
astrand |
106 |
.br |
8 |
|
|
.SH DESCRIPTION |
9 |
|
|
.I rdesktop |
10 |
matthewc |
520 |
is a client for Remote Desktop Protocol (RDP), used in a number of Microsoft |
11 |
|
|
products including Windows NT Terminal Server, Windows 2000 Server, Windows XP |
12 |
|
|
and Windows 2003 Server. |
13 |
astrand |
106 |
|
14 |
|
|
.SH OPTIONS |
15 |
|
|
.TP |
16 |
|
|
.BR "-u <username>" |
17 |
matthewc |
520 |
Username for authentication on the server. |
18 |
astrand |
106 |
.TP |
19 |
|
|
.BR "-d <domain>" |
20 |
matthewc |
217 |
Domain for authentication. |
21 |
astrand |
106 |
.TP |
22 |
|
|
.BR "-s <shell>" |
23 |
matthewc |
217 |
Startup shell for the user - starts a specific application instead of Explorer. |
24 |
astrand |
106 |
.TP |
25 |
|
|
.BR "-c <directory>" |
26 |
matthewc |
217 |
The initial working directory for the user. Often used in combination with -s |
27 |
|
|
to set up a fixed login environment. |
28 |
astrand |
106 |
.TP |
29 |
|
|
.BR "-p <password>" |
30 |
matthewc |
217 |
The password to authenticate with. Note that this may have no effect if |
31 |
|
|
"Always prompt for password" is enabled on the server. WARNING: if you specify |
32 |
|
|
a password on the command line it may be visible to other users when they use |
33 |
|
|
tools like ps. Use -p - to make rdesktop request a password at startup (from |
34 |
|
|
standard input). |
35 |
astrand |
106 |
.TP |
36 |
matthewc |
217 |
.BR "-n <hostname>" |
37 |
|
|
Client hostname. Normally rdesktop automatically obtains the hostname of the |
38 |
|
|
client. |
39 |
astrand |
106 |
.TP |
40 |
astrand |
959 |
.BR "-k <keyboard-map>" |
41 |
matthewc |
241 |
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 |
astrand |
962 |
en-us, en-gb, de, fr, sv, etc. |
45 |
astrand |
959 |
|
46 |
astrand |
962 |
The default keyboard map depends on the current locale (LC_* and LANG |
47 |
|
|
environment variables). If no valid locale is specified, the default |
48 |
|
|
keyboard map is en-us (a US keyboard). |
49 |
|
|
|
50 |
astrand |
961 |
The keyboard maps are file names, which means that they are case |
51 |
|
|
sensitive. The standard keymaps are all in lowercase. |
52 |
|
|
|
53 |
astrand |
960 |
The keyboard-maps are searched relative to the directories |
54 |
|
|
$HOME/.rdesktop/keymaps, KEYMAP_PATH (specified at build time), and |
55 |
|
|
$CWD/keymaps, in this order. The keyboard-map argument can also be an |
56 |
|
|
absolute filename. |
57 |
astrand |
106 |
.TP |
58 |
|
|
.BR "-g <geometry>" |
59 |
astrand |
264 |
Desktop geometry (WxH). If geometry is the special word "workarea", the geometry |
60 |
|
|
will be fetched from the extended window manager hints property _NET_WORKAREA, from |
61 |
matthewc |
520 |
the root window. The geometry can also be specified as a percentage of the whole |
62 |
|
|
screen, e.g. "-g 80%". |
63 |
astrand |
106 |
.TP |
64 |
|
|
.BR "-f" |
65 |
matthewc |
217 |
Enable fullscreen mode. This overrides the window manager and causes the |
66 |
|
|
rdesktop window to fully cover the current screen. Fullscreen mode can be |
67 |
matthewc |
245 |
toggled at any time using Ctrl-Alt-Enter. |
68 |
astrand |
106 |
.TP |
69 |
|
|
.BR "-b" |
70 |
matthewc |
217 |
Force the server to send screen updates as bitmaps rather than using |
71 |
|
|
higher-level drawing operations. |
72 |
astrand |
106 |
.TP |
73 |
stargo |
828 |
.BR "-B" |
74 |
|
|
Use the BackingStore of the Xserver instead of the integrated one in |
75 |
|
|
rdesktop. |
76 |
|
|
.TP |
77 |
matthewc |
294 |
.BR "-e" |
78 |
|
|
Disable encryption. This option is only needed (and will only work) if you |
79 |
|
|
have a French version of NT TSE. |
80 |
|
|
.TP |
81 |
stargo |
505 |
.BR "-E" |
82 |
matthewc |
520 |
Disable encryption from client to server. This sends an encrypted login packet, |
83 |
|
|
but everything after this is unencrypted (including interactive logins). |
84 |
stargo |
505 |
.TP |
85 |
astrand |
106 |
.BR "-m" |
86 |
matthewc |
217 |
Do not send mouse motion events. This saves bandwidth, although some Windows |
87 |
|
|
applications may rely on receiving mouse motion. |
88 |
astrand |
106 |
.TP |
89 |
matthewc |
294 |
.BR "-C" |
90 |
|
|
Use private colourmap. This will improve colour accuracy on an 8-bit display, |
91 |
|
|
but rdesktop will appear in false colour when not focused. |
92 |
astrand |
106 |
.TP |
93 |
matthewc |
520 |
.BR "-D" |
94 |
|
|
Hide window manager decorations, by using MWM hints. |
95 |
|
|
.TP |
96 |
astrand |
106 |
.BR "-K" |
97 |
matthewc |
217 |
Do not override window manager key bindings. By default rdesktop attempts |
98 |
|
|
to grab all keyboard input when it is in focus. |
99 |
astrand |
107 |
.TP |
100 |
matthewc |
520 |
.BR "-S <button size>" |
101 |
|
|
Enable single application mode. This option can be used when running a |
102 |
|
|
single, maximized application (via -s). When the minimize button of |
103 |
|
|
the windows application is pressed, the rdesktop window is minimized |
104 |
|
|
instead of the remote application. The maximize/restore button is |
105 |
|
|
disabled. For this to work, you must specify the correct button |
106 |
|
|
size, in pixels. The special word "standard" means 18 pixels. |
107 |
|
|
.TP |
108 |
matthewc |
232 |
.BR "-T <title>" |
109 |
matthewc |
520 |
Sets the window title. |
110 |
astrand |
264 |
.TP |
111 |
astrand |
552 |
.BR "-N" |
112 |
|
|
Enable numlock syncronization between the Xserver and the remote RDP |
113 |
|
|
session. This is useful with applications that looks at the numlock |
114 |
|
|
state, but might cause problems with some Xservers like Xvnc. |
115 |
|
|
.TP |
116 |
stargo |
636 |
.BR "-X <windowid>" |
117 |
|
|
Embed rdesktop-window in another window. The windowid is expected to |
118 |
stargo |
871 |
be decimal or hexadecimal (prefixed by 0x). |
119 |
stargo |
636 |
.TP |
120 |
stargo |
505 |
.BR "-a <bpp>" |
121 |
matthewc |
520 |
Sets the colour depth for the connection (8, 15, 16 or 24). |
122 |
|
|
More than 8 bpp are only supported when connecting to Windows XP |
123 |
|
|
(up to 16 bpp) or newer. Note that the colour depth may also be |
124 |
|
|
limited by the server configuration. |
125 |
stargo |
505 |
.TP |
126 |
stargo |
828 |
.BR "-z" |
127 |
stargo |
936 |
Enable compression of the RDP datastream. |
128 |
stargo |
828 |
.TP |
129 |
stargo |
637 |
.BR "-x <experience>" |
130 |
jsorg71 |
725 |
Changes default bandwidth performance behaviour for RDP5. By default only |
131 |
stargo |
637 |
theming is enabled, and all other options are disabled (corresponding |
132 |
|
|
to modem (56 Kbps)). Setting experience to b[roadband] enables menu |
133 |
|
|
animations and full window dragging. Setting experience to l[an] will |
134 |
|
|
also enable the desktop wallpaper. Setting experience to m[odem] |
135 |
jsorg71 |
725 |
disables all (including themes). Experience can also be a hexidecimal |
136 |
stargo |
637 |
number containing the flags. |
137 |
|
|
.TP |
138 |
jsorg71 |
725 |
.BR "-P" |
139 |
|
|
Enable caching of bitmaps to disk (persistent bitmap caching). This generally |
140 |
|
|
improves performance (especially on low bandwidth connections) and reduces |
141 |
|
|
network traffic at the cost of slightly longer startup and some disk space. |
142 |
|
|
(10MB for 8-bit colour, 20MB for 15/16-bit colour and 30MB for 24-bit colour |
143 |
|
|
sessions) |
144 |
|
|
.TP |
145 |
matthewc |
520 |
.BR "-r <device>" |
146 |
|
|
Enable redirection of the specified device on the client, such |
147 |
n-ki |
581 |
that it appears on the server. Note that the allowed |
148 |
matthewc |
520 |
redirections may be restricted by the server configuration. |
149 |
n-ki |
581 |
|
150 |
|
|
Following devices are currently supported: |
151 |
matthewc |
520 |
.TP |
152 |
n-ki |
581 |
.BR "-r comport:<comport>=<device>,..." |
153 |
|
|
Redirects serial devices on your client to the |
154 |
|
|
server. Note that if you need to change any settings on the serial device(s), |
155 |
|
|
do so with an appropriate tool before starting rdesktop. In most |
156 |
n-ki |
591 |
OSes you would use stty. Bidirectional/Read support requires Windows XP or newer. |
157 |
|
|
In Windows 2000 it will create a port, but it's not seamless, most |
158 |
|
|
shell programs will not work with it. |
159 |
n-ki |
581 |
.TP |
160 |
astrand |
747 |
.BR "-r disk:<sharename>=<path>,..." |
161 |
|
|
Redirects a path to the share \\\\tsclient\\<sharename> on the server |
162 |
|
|
(requires Windows XP or newer). The share name is limited to 8 |
163 |
|
|
characters. |
164 |
n-ki |
581 |
.TP |
165 |
|
|
.BR "-r lptport:<lptport>=<device>,..." |
166 |
|
|
Redirects parallel devices on your client to the server. |
167 |
n-ki |
591 |
Bidirectional/Read support requires Windows XP or newer. In Windows 2000 |
168 |
|
|
it will create a port, but it's not seamless, most shell programs will not work with |
169 |
|
|
it. |
170 |
n-ki |
581 |
.TP |
171 |
|
|
.BR "-r printer:<printername>[=<driver>],..." |
172 |
|
|
Redirects a printer queue on the client to the server. The <printername> |
173 |
|
|
is the name of the queue in your local system. <driver> defaults to a |
174 |
|
|
simple PS-driver unless you specify one. Keep in mind that you need a |
175 |
|
|
100% match in the server environment, or the driver will fail. The first |
176 |
|
|
printer on the command line will be set as your default printer. |
177 |
|
|
.TP |
178 |
n-ki |
635 |
.BR "-r sound:[local|off|remote]" |
179 |
|
|
Redirects sound generated on the server to the client. "remote" only has |
180 |
|
|
any effect when you connect to the console with the -0 option. (Requires |
181 |
n-ki |
581 |
Windows XP or newer). |
182 |
|
|
.TP |
183 |
stargo |
505 |
.BR "-0" |
184 |
matthewc |
520 |
Attach to the console of the server (requires Windows Server 2003 |
185 |
|
|
or newer). |
186 |
stargo |
505 |
.TP |
187 |
|
|
.BR "-4" |
188 |
|
|
Use RDP version 4. |
189 |
|
|
.TP |
190 |
|
|
.BR "-5" |
191 |
|
|
Use RDP version 5 (default). |
192 |
astrand |
106 |
.PP |
193 |
|
|
.SH LINKS |
194 |
|
|
Main website of rdesktop |
195 |
|
|
.br |
196 |
matthewc |
217 |
\fIhttp://www.rdesktop.org/ |
197 |
astrand |
106 |
.LP |
198 |
|
|
.PP |