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