1rdesktop(1) General Commands Manual rdesktop(1)
2
6 rdesktop - Remote Desktop Protocol client
7
9 rdesktop [options] server[:port]
10
12 rdesktop is a client for Remote Desktop Protocol (RDP), used in a num‐
13 ber of Microsoft products. It is known to work with Microsoft Windows
14 server versions ranging from NT 4 terminal server to Windows Server
15 2012 R2.
16
19 -u <username>
20 Username for authentication on the server.
21 -d <domain>
23 Domain for authentication.
24 -s <shell>
26 Startup shell for the user - starts a specific application
27 instead of Explore. If SeamlessRDP is enabled this is the
28 application which is started in seamless mode.
29 -c <directory>
31 The initial working directory for the user. Often used in com‐
32 bination with -s to set up a fixed login environment.
33 -p <password>
35 The password to authenticate with. Note that this may have no
36 effect if "Always prompt for password" is enabled on the server.
37 WARNING: if you specify a password on the command line it may be
38 visible to other users when they use tools like ps. Use -p - to
39 make rdesktop request a password at startup (from standard
40 input).
41 -n <hostname>
43 Client hostname. Normally rdesktop automatically obtains the
44 hostname of the client.
45 -k <keyboard-map>
47 Keyboard layout to emulate. This requires a corresponding
48 keymap file to be installed. The standard keymaps provided with
49 rdesktop follow the RFC1766 naming scheme: a language code fol‐
50 lowed by a country code if necessary - e.g. en-us, en-gb, de,
51 fr, sv, etc.
52 The default keyboard map depends on the current locale (LC_* and
54 LANG environment variables). If the current locale is unknown,
55 the default keyboard map is en-us (a US English keyboard).
56 The keyboard maps are file names, which means that they are case
58 sensitive. The standard keymaps are all in lowercase.
59 The keyboard maps are searched relative to the directories
61 $HOME/.rdesktop/keymaps, KEYMAP_PATH (specified at build time),
62 and $CWD/keymaps, in this order. The keyboard-map argument can
63 also be an absolute filename.
64 The special value `none' can be used instead of a keyboard map.
66 In this case, rdesktop will guess the scancodes from the X11
67 event key codes using an internal mapping method. This method
68 only supports the basic alphanumeric keys and may not work prop‐
69 erly on all platforms so its use is discouraged.
70 -g <geometry>
72 Desktop geometry (WxH[@DPI][+X[+Y]]). If geometry is the special
73 word "workarea", the geometry will be fetched from the extended
74 window manager hints property _NET_WORKAREA, from the root win‐
75 dow. The geometry can also be specified as a percentage of the
76 whole screen, e.g. "-g 80%", "-g 80%x70%".
77 If the specified geometry depends on the screen size, and the
79 screen size is changed, rdesktop will automatically reconnect
80 using the new screen size. This requires that rdesktop has been
81 compiled with RandR support.
82 The optional DPI parameter should be specified if the screen
84 rdesktop is being displayed on is too far from 96 DPI for
85 unscaled Windows to be readable. Windows currently accepts val‐
86 ues from 96 to 480.
87 Offset placement of window is optional. Starting point is upper
89 left corner of screen. Window manager might push into visible
90 area, if a panel would be covered. The schema is "-g
91 <value>+<xoff>+<yoff>, f.e. "-g 30%+200+600".
92 -i Use password as smartcard pin. If a valid user certificate is
94 matched in smart card reader the password passed with p argument
95 is used as pin for the smart card. This feature also requires
96 that smart card redirection is used using r scard argument.
97 -f Enable fullscreen mode. This overrides the window manager and
99 causes the rdesktop window to fully cover the current screen.
100 Fullscreen mode can be toggled at any time using Ctrl-Alt-Enter.
101 -b Force the server to send screen updates as bitmaps rather than
103 using higher-level drawing operations.
104 -t Disable use of remote control. This will disable features like
106 seamless connection sharing.
107 -A <seamlessrdpshell>
109 Enable SeamlessRDP by specifying the path to seamless rdp shell.
110 In this mode, rdesktop creates a X11 window for each window on
111 the server side. This mode requires the SeamlessRDP server side
112 component, which is available from http://www.cendio.com/seam‐
113 lessrdp/.
114 When using this option, you should normally specify a startup
116 shell which launches the desired application through Seamless‐
117 RDP.
118 Example: rdesktop -A 'c:\seamlessrdp\seamlessrdpshell.exe' -s
120 'notepad' mywts.domain.com
121 Any subsequential call to the above command line example will
123 make use of the seamless connection sharing feature which spawns
124 another notepad in the current connection to the specified
125 server and then exit.
126 -V <tls version>
129 Set the Transport Level Security (also known as SSL) Version
130 used. Should be one of the following values: 1.0, 1.1, 1.2. By
131 default all versions are supported.
132 -B Use the BackingStore of the Xserver instead of the integrated
134 one in rdesktop.
135 -e Disable encryption. This option is only needed (and will only
137 work) if you have a French version of NT TSE.
138 -E Disable encryption from client to server. This sends an
140 encrypted login packet, but everything after this is unencrypted
141 (including interactive logins).
142 -m Do not send mouse motion events. This saves bandwidth, although
144 some Windows applications may rely on receiving mouse motion.
145 -M Use local X cursor inherited from window manager instead of
147 server cursor. This is mostly useful with -m, but is also useful
148 if the server is sending bogus mouse cursors.
149 -C Use private colourmap. This will improve colour accuracy on an
151 8-bit display, but rdesktop will appear in false colour when not
152 focused.
153 -D Hide window manager decorations, by using MWM hints.
155 -K Do not override window manager key bindings. By default rdesk‐
157 top attempts to grab all keyboard input when it is in focus.
158 -S <button size>
160 Enable single application mode. This option can be used when
161 running a single, maximized application (via -s). When the mini‐
162 mize button of the windows application is pressed, the rdesktop
163 window is minimized instead of the remote application. The maxi‐
164 mize/restore button is disabled. For this to work, you must
165 specify the correct button size, in pixels. The special word
166 "standard" means 18 pixels.
167 -T <title>
169 Sets the window title. The title must be specified using an
170 UTF-8 string.
171 -N Enable numlock synchronization between the Xserver and the
173 remote RDP session. This is useful with applications that looks
174 at the numlock state, but might cause problems with some
175 Xservers like Xvnc.
176 -X <windowid>
178 Embed rdesktop-window in another window. The windowid is
179 expected to be decimal or hexadecimal (prefixed by 0x).
180 -a <bpp>
182 Sets the colour depth for the connection (8, 15, 16, 24 or 32).
183 More than 8 bpp are only supported when connecting to Windows XP
184 (up to 16 bpp) or newer. Note that the colour depth may also be
185 limited by the server configuration. The default value is the
186 depth of the root window.
187 -z Enable compression of the RDP datastream.
189 -x <experience>
191 Changes default bandwidth performance behaviour for RDP5. By
192 default only theming is enabled, and all other options are dis‐
193 abled (corresponding to modem (56 Kbps)). Setting experience to
194 b[roadband] enables menu animations and full window dragging.
195 Setting experience to l[an] will also enable the desktop wallpa‐
196 per. Setting experience to m[odem] disables all (including
197 themes). Experience can also be a hexadecimal number containing
198 the flags.
199 -P Enable caching of bitmaps to disk (persistent bitmap caching).
201 This generally improves performance (especially on low bandwidth
202 connections) and reduces network traffic at the cost of slightly
203 longer startup and some disk space. (10MB for 8-bit colour,
204 20MB for 15/16-bit colour, 30MB for 24-bit colour and 40MB for
205 32-bit colour sessions)
206 -r <device>
208 Enable redirection of the specified device on the client, such
209 that it appears on the server. Note that the allowed redirec‐
210 tions may be restricted by the server configuration.
211 Following devices are currently supported:
213 -r comport:<comport>=<device>,...
215 Redirects serial devices on your client to the server. Note that
216 if you need to change any settings on the serial device(s), do
217 so with an appropriate tool before starting rdesktop. In most
218 OSes you would use stty. Bidirectional/Read support requires
219 Windows XP or newer. In Windows 2000 it will create a port, but
220 it's not seamless, most shell programs will not work with it.
221 -r disk:<sharename>=<path>,...
223 Redirects a path to the share \\tsclient\<sharename> on the
224 server (requires Windows XP or newer). The share name is limited
225 to 8 characters.
226 -r lptport:<lptport>=<device>,...
228 Redirects parallel devices on your client to the server. Bidi‐
229 rectional/Read support requires Windows XP or newer. In Windows
230 2000 it will create a port, but it's not seamless, most shell
231 programs will not work with it.
232 -r printer:<printername>[=<driver>],...
234 Redirects a printer queue on the client to the server. The
235 <printername> is the name of the queue in your local system.
236 <driver> defaults to a simple PS-driver unless you specify one.
237 Keep in mind that you need a 100% match in the server environ‐
238 ment, or the driver will fail. The first printer on the command
239 line will be set as your default printer.
240 -r sound:[local|off|remote]
242 Redirects sound generated on the server to the client. "remote"
243 only has any effect when you connect to the console with the -0
244 option. (Requires Windows XP or newer).
245 -r lspci
247 Activates the lspci channel, which allows the server to enumer‐
248 ate the clients PCI devices. See the file lspci-channel.txt in
249 the documentation for more information.
250 -r scard[:<Scard Name>=<Alias Name>[;<Vendor Name>][,...]]
252 Enables redirection of one or more smart-cards. You can provide
253 static name binding between GNU/Linux and Windows. To do this
254 you can use optional parameters as described: <Scard Name> -
255 device name in GNU/Linux and UNIX environment, <Alias Name> -
256 device name shown in Windows environment <Vendor Name> -
257 optional device vendor name. For list of examples run rdesktop
258 without parameters.
259 -r clipboard:[off|PRIMARYCLIPBOARD|CLIPBOARD]
261 Enable clipboard redirection. 'PRIMARYCLIPBOARD' looks at both
262 PRIMARY and CLIPBOARD when sending data to server. 'CLIPBOARD'
263 looks at only 'CLIPBOARD'.
264 -0 Attach to the console of the server (requires Windows Server
266 2003 or newer).
267 -4 Use RDP version 4.
269 -5 Use RDP version 5 (default).
271 -v Enable verbose output
273
275 --sc-csp-name <name>
276 Specify the CSP (Crypto Service Provider) to use on the windows
277 side for the smartcard authentication. CSP is the driver for
278 your smartcard and it seems like this is required to be speci‐
279 fied for CredSSP authentication. For Swedish NetID the following
280 CSP name is used; "Net iD - CSP".
281 --sc-container-name <name>
283 Specify the container name, usually this is the username for
284 default container and it seems like this is required to be spec‐
285 ified for CredSSP authentication.
286 --sc-reader-name <name>
288 Specify the reader name to be used to prevent the pin code being
289 sent to wrong card if there are several readers.
290 --sc-card-name <name>
292 Specify the card name for example; "Telia EID IP5a".
293
295 0 RDP session terminated normally
296 1 Administrator initiated disconnect (also returned for logoff by
298 Windows XP joined to a domain)
299 2 Administrator initiated logout
301 3 Server idle session time limit reached
303 4 Server active session time limit reached
305 5 The session was replaced
307 6 The server is out of memory
309 7 The server denied the connection
311 8 The server denied the connection for security reasons
313 9 The user cannot connect to the server due to insufficient access
315 privileges
316 10 The server does not accept saved user credentials and requires
318 that the user enter their credentials for each connection
319 11 Disconnect initiated by user
321 12 Logout initiated by user
323 16 Internal licensing error
325 17 No license server available
327 18 No valid license available
329 19 Invalid licensing message from client
331 20 The client license has been modified and does no longer match
333 the hardware ID
334 21 The client license is in an invalid format
336 22 Network error during licensing protocol
338 23 Licensing protocol was not completed
340 24 Incorrect client license encryption
342 25 Can't upgrade or renew license
344 26 The server is not licensed to accept remote connections
346 30 The target endpoint chosen by the broker could not be found
348 32 The target endpoint is disconnecting from the broker
350 34 Error occurred while being redirected by broker
352 35 Error while the endpoint VM was being awakened by the broker
354 36 Error while the endpoint VM was being started by the broker
356 37 The IP address of the endpoint VM could not be determined by the
358 broker
359 38 No available endpoints in the connection broker pool
361 39 Connection processing cancelled by the broker
363 40 The connection settings could not be validated by the broker
365 41 Timeout while the endpoint VM was being started by the broker
367 42 Session monitoring error while the endpoint VM was being started
369 by the broker
370 50 The server can only host Remote Applications
372 51 Update of session keys failed
374 52 Decryption or session key creation failed
376 53 Encryption failed
378 62 The local client window was closed
380 63 Some other, unknown error occurred
382 64 Command line usage error
384 69 A service or resource (such as memory) is unavailable
386 70 An internal software error has been detected
388 71 Operating system error
390 76 Protocol error or unable to connect to remote host.
392
395 Main website of rdesktop
396 http://www.rdesktop.org/
397 2017-10-28 rdesktop(1)