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