rdesktop/doc/rdesktop.1

.TH rdesktop 1 "November 2005"
.SH NAME
.I rdesktop
\- Remote Desktop Protocol client
.SH SYNOPSIS
.B rdesktop [options] server[:port]
.br
.SH DESCRIPTION
.I rdesktop
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.

.SH OPTIONS
.TP
.BR "-u <username>"
Username for authentication on the server.
.TP
.BR "-d <domain>"
Domain for authentication.
.TP
.BR "-s <shell>"
Startup shell for the user - starts a specific application instead of Explorer.
.TP
.BR "-c <directory>"
The initial working directory for the user.  Often used in combination with -s
to set up a fixed login environment.
.TP
.BR "-p <password>"
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).
.TP
.BR "-n <hostname>"
Client hostname.  Normally rdesktop automatically obtains the hostname of the
client.
.TP
.BR "-k <keyboard-map>"
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 keyboard map depends on the current locale (LC_* and LANG
environment variables). If the current locale is unknown, the default
keyboard map is en-us (a US English keyboard).

The keyboard maps are file names, which means that they are case
sensitive. The standard keymaps are all in lowercase.

The keyboard maps are searched relative to the directories
$HOME/.rdesktop/keymaps, KEYMAP_PATH (specified at build time), and
$CWD/keymaps, in this order. The keyboard-map argument can also be an
absolute filename.

The special value `none' can be used instead of a keyboard map.
In this case, rdesktop will guess the scancodes from the X11 event key
codes using an internal mapping method. This method only supports the
basic alphanumeric keys and may not work properly on all platforms
so its use is discouraged.
.TP
.BR "-g <geometry>"
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
the root window. The geometry can also be specified as a percentage of the whole
screen, e.g. "-g 80%". 
.TP
.BR "-f"
Enable fullscreen mode.  This overrides the window manager and causes the
rdesktop window to fully cover the current screen.  Fullscreen mode can be
toggled at any time using Ctrl-Alt-Enter.
.TP
.BR "-b"
Force the server to send screen updates as bitmaps rather than using
higher-level drawing operations.
.TP
.BR "-A"
Enable SeamlessRDP. In this mode, rdesktop creates a X11 window for
each window on the server side. This mode requires the SeamlessRDP
server side component. When using this option, you should specify a
startup shell which launches the desired application through
SeamlessRDP. Example: rdesktop -A -s 'seamlessrdpshell notepad'.
.TP
.BR "-B"
Use the BackingStore of the Xserver instead of the integrated one in
rdesktop.
.TP
.BR "-e"
Disable encryption.  This option is only needed (and will only work) if you
have a French version of NT TSE.
.TP
.BR "-E"
Disable encryption from client to server.  This sends an encrypted login packet,
but everything after this is unencrypted (including interactive logins).
.TP
.BR "-m"
Do not send mouse motion events.  This saves bandwidth, although some Windows
applications may rely on receiving mouse motion.
.TP
.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.
.TP
.BR "-D"
Hide window manager decorations, by using MWM hints. 
.TP
.BR "-K"
Do not override window manager key bindings.  By default rdesktop attempts
to grab all keyboard input when it is in focus.
.TP
.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. 
.TP
.BR "-T <title>"
Sets the window title.
.TP
.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
.BR "-X <windowid>"
Embed rdesktop-window in another window. The windowid is expected to
be decimal or hexadecimal (prefixed by 0x).
.TP
.BR "-a <bpp>"
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
.BR "-z"
Enable compression of the RDP datastream.
.TP
.BR "-x <experience>"
Changes default bandwidth performance behaviour for RDP5. By default only
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]
disables all (including themes). Experience can also be a hexidecimal
number containing the flags.
.TP
.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
.BR "-r <device>"
Enable redirection of the specified device on the client, such
that it appears on the server. Note that the allowed
redirections may be restricted by the server configuration.

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
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.
.TP
.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. 
.TP
.BR "-r lptport:<lptport>=<device>,..."
Redirects parallel devices on your client to the server.
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.
.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
.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
Windows XP or newer).
.TP
.BR "-r lspci"
Activates the lspci channel, which allows the server to enumerate the
clients PCI devices. See the file lspci-channel.txt in the
documentation for more information.
.TP
.BR "-0"
Attach to the console of the server (requires Windows Server 2003
or newer).
.TP
.BR "-4"
Use RDP version 4.
.TP
.BR "-5"
Use RDP version 5 (default).
.PP
.SH LINKS
Main website of rdesktop
.br
\fIhttp://www.rdesktop.org/
.LP
.PP
1	.TH rdesktop 1 "November 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.
45
46	The default keyboard map depends on the current locale (LC_* and LANG
47	environment variables). If the current locale is unknown, the default
48	keyboard map is en-us (a US English keyboard).
49
50	The keyboard maps are file names, which means that they are case
51	sensitive. The standard keymaps are all in lowercase.
52
53	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
58	The special value `none' can be used instead of a keyboard map.
59	In this case, rdesktop will guess the scancodes from the X11 event key
60	codes using an internal mapping method. This method only supports the
61	basic alphanumeric keys and may not work properly on all platforms
62	so its use is discouraged.
63	.TP
64	.BR "-g <geometry>"
65	Desktop geometry (WxH). If geometry is the special word "workarea", the geometry
66	will be fetched from the extended window manager hints property _NET_WORKAREA, from
67	the root window. The geometry can also be specified as a percentage of the whole
68	screen, e.g. "-g 80%".
69	.TP
70	.BR "-f"
71	Enable fullscreen mode. This overrides the window manager and causes the
72	rdesktop window to fully cover the current screen. Fullscreen mode can be
73	toggled at any time using Ctrl-Alt-Enter.
74	.TP
75	.BR "-b"
76	Force the server to send screen updates as bitmaps rather than using
77	higher-level drawing operations.
78	.TP
79	.BR "-A"
80	Enable SeamlessRDP. In this mode, rdesktop creates a X11 window for
81	each window on the server side. This mode requires the SeamlessRDP
82	server side component. When using this option, you should specify a
83	startup shell which launches the desired application through
84	SeamlessRDP. Example: rdesktop -A -s 'seamlessrdpshell notepad'.
85	.TP
86	.BR "-B"
87	Use the BackingStore of the Xserver instead of the integrated one in
88	rdesktop.
89	.TP
90	.BR "-e"
91	Disable encryption. This option is only needed (and will only work) if you
92	have a French version of NT TSE.
93	.TP
94	.BR "-E"
95	Disable encryption from client to server. This sends an encrypted login packet,
96	but everything after this is unencrypted (including interactive logins).
97	.TP
98	.BR "-m"
99	Do not send mouse motion events. This saves bandwidth, although some Windows
100	applications may rely on receiving mouse motion.
101	.TP
102	.BR "-C"
103	Use private colourmap. This will improve colour accuracy on an 8-bit display,
104	but rdesktop will appear in false colour when not focused.
105	.TP
106	.BR "-D"
107	Hide window manager decorations, by using MWM hints.
108	.TP
109	.BR "-K"
110	Do not override window manager key bindings. By default rdesktop attempts
111	to grab all keyboard input when it is in focus.
112	.TP
113	.BR "-S <button size>"
114	Enable single application mode. This option can be used when running a
115	single, maximized application (via -s). When the minimize button of
116	the windows application is pressed, the rdesktop window is minimized
117	instead of the remote application. The maximize/restore button is
118	disabled. For this to work, you must specify the correct button
119	size, in pixels. The special word "standard" means 18 pixels.
120	.TP
121	.BR "-T <title>"
122	Sets the window title.
123	.TP
124	.BR "-N"
125	Enable numlock syncronization between the Xserver and the remote RDP
126	session. This is useful with applications that looks at the numlock
127	state, but might cause problems with some Xservers like Xvnc.
128	.TP
129	.BR "-X <windowid>"
130	Embed rdesktop-window in another window. The windowid is expected to
131	be decimal or hexadecimal (prefixed by 0x).
132	.TP
133	.BR "-a <bpp>"
134	Sets the colour depth for the connection (8, 15, 16 or 24).
135	More than 8 bpp are only supported when connecting to Windows XP
136	(up to 16 bpp) or newer. Note that the colour depth may also be
137	limited by the server configuration.
138	.TP
139	.BR "-z"
140	Enable compression of the RDP datastream.
141	.TP
142	.BR "-x <experience>"
143	Changes default bandwidth performance behaviour for RDP5. By default only
144	theming is enabled, and all other options are disabled (corresponding
145	to modem (56 Kbps)). Setting experience to b[roadband] enables menu
146	animations and full window dragging. Setting experience to l[an] will
147	also enable the desktop wallpaper. Setting experience to m[odem]
148	disables all (including themes). Experience can also be a hexidecimal
149	number containing the flags.
150	.TP
151	.BR "-P"
152	Enable caching of bitmaps to disk (persistent bitmap caching). This generally
153	improves performance (especially on low bandwidth connections) and reduces
154	network traffic at the cost of slightly longer startup and some disk space.
155	(10MB for 8-bit colour, 20MB for 15/16-bit colour and 30MB for 24-bit colour
156	sessions)
157	.TP
158	.BR "-r <device>"
159	Enable redirection of the specified device on the client, such
160	that it appears on the server. Note that the allowed
161	redirections may be restricted by the server configuration.
162
163	Following devices are currently supported:
164	.TP
165	.BR "-r comport:<comport>=<device>,..."
166	Redirects serial devices on your client to the
167	server. Note that if you need to change any settings on the serial device(s),
168	do so with an appropriate tool before starting rdesktop. In most
169	OSes you would use stty. Bidirectional/Read support requires Windows XP or newer.
170	In Windows 2000 it will create a port, but it's not seamless, most
171	shell programs will not work with it.
172	.TP
173	.BR "-r disk:<sharename>=<path>,..."
174	Redirects a path to the share \\\\tsclient\\<sharename> on the server
175	(requires Windows XP or newer). The share name is limited to 8
176	characters.
177	.TP
178	.BR "-r lptport:<lptport>=<device>,..."
179	Redirects parallel devices on your client to the server.
180	Bidirectional/Read support requires Windows XP or newer. In Windows 2000
181	it will create a port, but it's not seamless, most shell programs will not work with
182	it.
183	.TP
184	.BR "-r printer:<printername>[=<driver>],..."
185	Redirects a printer queue on the client to the server. The <printername>
186	is the name of the queue in your local system. <driver> defaults to a
187	simple PS-driver unless you specify one. Keep in mind that you need a
188	100% match in the server environment, or the driver will fail. The first
189	printer on the command line will be set as your default printer.
190	.TP
191	.BR "-r sound:[local\|off\|remote]"
192	Redirects sound generated on the server to the client. "remote" only has
193	any effect when you connect to the console with the -0 option. (Requires
194	Windows XP or newer).
195	.TP
196	.BR "-r lspci"
197	Activates the lspci channel, which allows the server to enumerate the
198	clients PCI devices. See the file lspci-channel.txt in the
199	documentation for more information.
200	.TP
201	.BR "-0"
202	Attach to the console of the server (requires Windows Server 2003
203	or newer).
204	.TP
205	.BR "-4"
206	Use RDP version 4.
207	.TP
208	.BR "-5"
209	Use RDP version 5 (default).
210	.PP
211	.SH LINKS
212	Main website of rdesktop
213	.br
214	\fIhttp://www.rdesktop.org/
215	.LP
216	.PP