2005-03-06 22:11:18 +01:00
|
|
|
.TH rdesktop 1 "March 2005"
|
2002-09-01 13:15:42 +02:00
|
|
|
.SH NAME
|
|
|
|
.I rdesktop
|
|
|
|
\- Remote Desktop Protocol client
|
|
|
|
.SH SYNOPSIS
|
2002-10-14 08:13:20 +02:00
|
|
|
.B rdesktop [options] server[:port]
|
2002-09-01 13:15:42 +02:00
|
|
|
.br
|
|
|
|
.SH DESCRIPTION
|
|
|
|
.I rdesktop
|
2003-10-28 06:07:00 +01:00
|
|
|
is a client for Remote Desktop Protocol (RDP), used in a number of Microsoft
|
|
|
|
products including Windows NT Terminal Server, Windows 2000 Server, Windows XP
|
|
|
|
and Windows 2003 Server.
|
2002-09-01 13:15:42 +02:00
|
|
|
|
|
|
|
.SH OPTIONS
|
|
|
|
.TP
|
|
|
|
.BR "-u <username>"
|
2003-10-28 06:07:00 +01:00
|
|
|
Username for authentication on the server.
|
2002-09-01 13:15:42 +02:00
|
|
|
.TP
|
|
|
|
.BR "-d <domain>"
|
2002-10-09 16:13:46 +02:00
|
|
|
Domain for authentication.
|
2002-09-01 13:15:42 +02:00
|
|
|
.TP
|
|
|
|
.BR "-s <shell>"
|
2002-10-09 16:13:46 +02:00
|
|
|
Startup shell for the user - starts a specific application instead of Explorer.
|
2002-09-01 13:15:42 +02:00
|
|
|
.TP
|
|
|
|
.BR "-c <directory>"
|
2002-10-09 16:13:46 +02:00
|
|
|
The initial working directory for the user. Often used in combination with -s
|
|
|
|
to set up a fixed login environment.
|
2002-09-01 13:15:42 +02:00
|
|
|
.TP
|
|
|
|
.BR "-p <password>"
|
2002-10-09 16:13:46 +02:00
|
|
|
The password to authenticate with. Note that this may have no effect if
|
|
|
|
"Always prompt for password" is enabled on the server. WARNING: if you specify
|
|
|
|
a password on the command line it may be visible to other users when they use
|
|
|
|
tools like ps. Use -p - to make rdesktop request a password at startup (from
|
|
|
|
standard input).
|
2002-09-01 13:15:42 +02:00
|
|
|
.TP
|
2002-10-09 16:13:46 +02:00
|
|
|
.BR "-n <hostname>"
|
|
|
|
Client hostname. Normally rdesktop automatically obtains the hostname of the
|
|
|
|
client.
|
2002-09-01 13:15:42 +02:00
|
|
|
.TP
|
|
|
|
.BR "-k <layout>"
|
2002-10-24 10:35:28 +02:00
|
|
|
Keyboard layout to emulate. This requires a corresponding keymap file to be
|
|
|
|
installed. The standard keymaps provided with rdesktop follow the RFC1766
|
|
|
|
naming scheme: a language code followed by a country code if necessary - e.g.
|
|
|
|
en-us, en-gb, de, fr, sv, etc. The default is en-us (a US keyboard).
|
2002-09-01 13:15:42 +02:00
|
|
|
.TP
|
|
|
|
.BR "-g <geometry>"
|
2002-11-19 10:17:12 +01:00
|
|
|
Desktop geometry (WxH). If geometry is the special word "workarea", the geometry
|
|
|
|
will be fetched from the extended window manager hints property _NET_WORKAREA, from
|
2003-10-28 06:07:00 +01:00
|
|
|
the root window. The geometry can also be specified as a percentage of the whole
|
|
|
|
screen, e.g. "-g 80%".
|
2002-09-01 13:15:42 +02:00
|
|
|
.TP
|
|
|
|
.BR "-f"
|
2002-10-09 16:13:46 +02:00
|
|
|
Enable fullscreen mode. This overrides the window manager and causes the
|
|
|
|
rdesktop window to fully cover the current screen. Fullscreen mode can be
|
2002-10-24 10:49:20 +02:00
|
|
|
toggled at any time using Ctrl-Alt-Enter.
|
2002-09-01 13:15:42 +02:00
|
|
|
.TP
|
|
|
|
.BR "-b"
|
2002-10-09 16:13:46 +02:00
|
|
|
Force the server to send screen updates as bitmaps rather than using
|
|
|
|
higher-level drawing operations.
|
2002-09-01 13:15:42 +02:00
|
|
|
.TP
|
2005-03-06 22:11:18 +01:00
|
|
|
.BR "-B"
|
|
|
|
Use the BackingStore of the Xserver instead of the integrated one in
|
|
|
|
rdesktop.
|
|
|
|
.TP
|
2003-01-22 09:10:11 +01:00
|
|
|
.BR "-e"
|
|
|
|
Disable encryption. This option is only needed (and will only work) if you
|
|
|
|
have a French version of NT TSE.
|
|
|
|
.TP
|
2003-10-19 14:05:23 +02:00
|
|
|
.BR "-E"
|
2003-10-28 06:07:00 +01:00
|
|
|
Disable encryption from client to server. This sends an encrypted login packet,
|
|
|
|
but everything after this is unencrypted (including interactive logins).
|
2003-10-19 14:05:23 +02:00
|
|
|
.TP
|
2002-09-01 13:15:42 +02:00
|
|
|
.BR "-m"
|
2002-10-09 16:13:46 +02:00
|
|
|
Do not send mouse motion events. This saves bandwidth, although some Windows
|
|
|
|
applications may rely on receiving mouse motion.
|
2002-09-01 13:15:42 +02:00
|
|
|
.TP
|
2003-01-22 09:10:11 +01:00
|
|
|
.BR "-C"
|
|
|
|
Use private colourmap. This will improve colour accuracy on an 8-bit display,
|
|
|
|
but rdesktop will appear in false colour when not focused.
|
2002-09-01 13:15:42 +02:00
|
|
|
.TP
|
2003-10-28 06:07:00 +01:00
|
|
|
.BR "-D"
|
|
|
|
Hide window manager decorations, by using MWM hints.
|
|
|
|
.TP
|
2002-09-01 13:15:42 +02:00
|
|
|
.BR "-K"
|
2002-10-09 16:13:46 +02:00
|
|
|
Do not override window manager key bindings. By default rdesktop attempts
|
|
|
|
to grab all keyboard input when it is in focus.
|
2002-09-01 13:27:58 +02:00
|
|
|
.TP
|
2003-10-28 06:07:00 +01:00
|
|
|
.BR "-S <button size>"
|
|
|
|
Enable single application mode. This option can be used when running a
|
|
|
|
single, maximized application (via -s). When the minimize button of
|
|
|
|
the windows application is pressed, the rdesktop window is minimized
|
|
|
|
instead of the remote application. The maximize/restore button is
|
|
|
|
disabled. For this to work, you must specify the correct button
|
|
|
|
size, in pixels. The special word "standard" means 18 pixels.
|
2002-11-19 10:17:12 +01:00
|
|
|
.TP
|
2003-10-28 06:07:00 +01:00
|
|
|
.BR "-T <title>"
|
|
|
|
Sets the window title.
|
2003-10-19 14:05:23 +02:00
|
|
|
.TP
|
2003-12-08 13:01:25 +01:00
|
|
|
.BR "-N"
|
|
|
|
Enable numlock syncronization between the Xserver and the remote RDP
|
|
|
|
session. This is useful with applications that looks at the numlock
|
|
|
|
state, but might cause problems with some Xservers like Xvnc.
|
|
|
|
.TP
|
2004-03-13 13:08:18 +01:00
|
|
|
.BR "-X <windowid>"
|
|
|
|
Embed rdesktop-window in another window. The windowid is expected to
|
|
|
|
be decimal.
|
|
|
|
.TP
|
2003-10-19 14:05:23 +02:00
|
|
|
.BR "-a <bpp>"
|
2003-10-28 06:07:00 +01:00
|
|
|
Sets the colour depth for the connection (8, 15, 16 or 24).
|
|
|
|
More than 8 bpp are only supported when connecting to Windows XP
|
|
|
|
(up to 16 bpp) or newer. Note that the colour depth may also be
|
|
|
|
limited by the server configuration.
|
|
|
|
.TP
|
2005-03-06 22:11:18 +01:00
|
|
|
.BR "-z"
|
|
|
|
Enable compression of the RDP datastream. This currently only works
|
|
|
|
for a colour depth of 8bpp.
|
|
|
|
.TP
|
2004-03-15 15:49:12 +01:00
|
|
|
.BR "-x <experience>"
|
2004-06-27 19:51:54 +02:00
|
|
|
Changes default bandwidth performance behaviour for RDP5. By default only
|
2004-03-15 15:49:12 +01:00
|
|
|
theming is enabled, and all other options are disabled (corresponding
|
|
|
|
to modem (56 Kbps)). Setting experience to b[roadband] enables menu
|
|
|
|
animations and full window dragging. Setting experience to l[an] will
|
|
|
|
also enable the desktop wallpaper. Setting experience to m[odem]
|
2004-06-27 19:51:54 +02:00
|
|
|
disables all (including themes). Experience can also be a hexidecimal
|
2004-03-15 15:49:12 +01:00
|
|
|
number containing the flags.
|
|
|
|
.TP
|
2004-06-27 19:51:54 +02:00
|
|
|
.BR "-P"
|
|
|
|
Enable caching of bitmaps to disk (persistent bitmap caching). This generally
|
|
|
|
improves performance (especially on low bandwidth connections) and reduces
|
|
|
|
network traffic at the cost of slightly longer startup and some disk space.
|
|
|
|
(10MB for 8-bit colour, 20MB for 15/16-bit colour and 30MB for 24-bit colour
|
|
|
|
sessions)
|
|
|
|
.TP
|
2003-10-28 06:07:00 +01:00
|
|
|
.BR "-r <device>"
|
|
|
|
Enable redirection of the specified device on the client, such
|
2004-01-23 15:34:47 +01:00
|
|
|
that it appears on the server. Note that the allowed
|
2003-10-28 06:07:00 +01:00
|
|
|
redirections may be restricted by the server configuration.
|
2004-01-23 15:34:47 +01:00
|
|
|
|
|
|
|
Following devices are currently supported:
|
|
|
|
.TP
|
|
|
|
.BR "-r comport:<comport>=<device>,..."
|
|
|
|
Redirects serial devices on your client to the
|
|
|
|
server. Note that if you need to change any settings on the serial device(s),
|
|
|
|
do so with an appropriate tool before starting rdesktop. In most
|
2004-01-29 13:37:12 +01:00
|
|
|
OSes you would use stty. Bidirectional/Read support requires Windows XP or newer.
|
|
|
|
In Windows 2000 it will create a port, but it's not seamless, most
|
|
|
|
shell programs will not work with it.
|
2004-01-23 15:34:47 +01:00
|
|
|
.TP
|
2004-08-09 15:50:41 +02:00
|
|
|
.BR "-r disk:<sharename>=<path>,..."
|
|
|
|
Redirects a path to the share \\\\tsclient\\<sharename> on the server
|
|
|
|
(requires Windows XP or newer). The share name is limited to 8
|
|
|
|
characters.
|
2004-01-23 15:34:47 +01:00
|
|
|
.TP
|
|
|
|
.BR "-r lptport:<lptport>=<device>,..."
|
|
|
|
Redirects parallel devices on your client to the server.
|
2004-01-29 13:37:12 +01:00
|
|
|
Bidirectional/Read support requires Windows XP or newer. In Windows 2000
|
|
|
|
it will create a port, but it's not seamless, most shell programs will not work with
|
|
|
|
it.
|
2004-01-23 15:34:47 +01:00
|
|
|
.TP
|
|
|
|
.BR "-r printer:<printername>[=<driver>],..."
|
|
|
|
Redirects a printer queue on the client to the server. The <printername>
|
|
|
|
is the name of the queue in your local system. <driver> defaults to a
|
|
|
|
simple PS-driver unless you specify one. Keep in mind that you need a
|
|
|
|
100% match in the server environment, or the driver will fail. The first
|
|
|
|
printer on the command line will be set as your default printer.
|
|
|
|
.TP
|
2004-03-10 08:39:49 +01:00
|
|
|
.BR "-r sound:[local|off|remote]"
|
|
|
|
Redirects sound generated on the server to the client. "remote" only has
|
|
|
|
any effect when you connect to the console with the -0 option. (Requires
|
2004-01-23 15:34:47 +01:00
|
|
|
Windows XP or newer).
|
2003-10-19 14:05:23 +02:00
|
|
|
.TP
|
|
|
|
.BR "-0"
|
2003-10-28 06:07:00 +01:00
|
|
|
Attach to the console of the server (requires Windows Server 2003
|
|
|
|
or newer).
|
2003-10-19 14:05:23 +02:00
|
|
|
.TP
|
|
|
|
.BR "-4"
|
|
|
|
Use RDP version 4.
|
|
|
|
.TP
|
|
|
|
.BR "-5"
|
|
|
|
Use RDP version 5 (default).
|
2002-09-01 13:15:42 +02:00
|
|
|
.PP
|
|
|
|
.SH LINKS
|
|
|
|
Main website of rdesktop
|
|
|
|
.br
|
2002-10-09 16:13:46 +02:00
|
|
|
\fIhttp://www.rdesktop.org/
|
2002-09-01 13:15:42 +02:00
|
|
|
.LP
|
|
|
|
.PP
|