rdesktop/doc/rdesktop.1

.TH rdesktop 1 "January 2004"
.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 <layout>"
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).
.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 "-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 "-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 "-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:<driveletter>=<path>,..."
Redirects a path to the drive letter of your choice on the server.
(requires Windows XP or newer).
.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:[on|off|remote]"
Redirects sound generated on the server to the client ( Requires
Windows XP or newer).
.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 "January 2004"
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 <layout>"
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	.TP
46	.BR "-g <geometry>"
47	Desktop geometry (WxH). If geometry is the special word "workarea", the geometry
48	will be fetched from the extended window manager hints property _NET_WORKAREA, from
49	the root window. The geometry can also be specified as a percentage of the whole
50	screen, e.g. "-g 80%".
51	.TP
52	.BR "-f"
53	Enable fullscreen mode. This overrides the window manager and causes the
54	rdesktop window to fully cover the current screen. Fullscreen mode can be
55	toggled at any time using Ctrl-Alt-Enter.
56	.TP
57	.BR "-b"
58	Force the server to send screen updates as bitmaps rather than using
59	higher-level drawing operations.
60	.TP
61	.BR "-e"
62	Disable encryption. This option is only needed (and will only work) if you
63	have a French version of NT TSE.
64	.TP
65	.BR "-E"
66	Disable encryption from client to server. This sends an encrypted login packet,
67	but everything after this is unencrypted (including interactive logins).
68	.TP
69	.BR "-m"
70	Do not send mouse motion events. This saves bandwidth, although some Windows
71	applications may rely on receiving mouse motion.
72	.TP
73	.BR "-C"
74	Use private colourmap. This will improve colour accuracy on an 8-bit display,
75	but rdesktop will appear in false colour when not focused.
76	.TP
77	.BR "-D"
78	Hide window manager decorations, by using MWM hints.
79	.TP
80	.BR "-K"
81	Do not override window manager key bindings. By default rdesktop attempts
82	to grab all keyboard input when it is in focus.
83	.TP
84	.BR "-S <button size>"
85	Enable single application mode. This option can be used when running a
86	single, maximized application (via -s). When the minimize button of
87	the windows application is pressed, the rdesktop window is minimized
88	instead of the remote application. The maximize/restore button is
89	disabled. For this to work, you must specify the correct button
90	size, in pixels. The special word "standard" means 18 pixels.
91	.TP
92	.BR "-T <title>"
93	Sets the window title.
94	.TP
95	.BR "-N"
96	Enable numlock syncronization between the Xserver and the remote RDP
97	session. This is useful with applications that looks at the numlock
98	state, but might cause problems with some Xservers like Xvnc.
99	.TP
100	.BR "-a <bpp>"
101	Sets the colour depth for the connection (8, 15, 16 or 24).
102	More than 8 bpp are only supported when connecting to Windows XP
103	(up to 16 bpp) or newer. Note that the colour depth may also be
104	limited by the server configuration.
105	.TP
106	.BR "-r <device>"
107	Enable redirection of the specified device on the client, such
108	that it appears on the server. Note that the allowed
109	redirections may be restricted by the server configuration.
110
111	Following devices are currently supported:
112	.TP
113	.BR "-r comport:<comport>=<device>,..."
114	Redirects serial devices on your client to the
115	server. Note that if you need to change any settings on the serial device(s),
116	do so with an appropriate tool before starting rdesktop. In most
117	OSes you would use stty. Bidirectional/Read support requires Windows XP or newer.
118	In Windows 2000 it will create a port, but it's not seamless, most
119	shell programs will not work with it.
120	.TP
121	.BR "-r disk:<driveletter>=<path>,..."
122	Redirects a path to the drive letter of your choice on the server.
123	(requires Windows XP or newer).
124	.TP
125	.BR "-r lptport:<lptport>=<device>,..."
126	Redirects parallel devices on your client to the server.
127	Bidirectional/Read support requires Windows XP or newer. In Windows 2000
128	it will create a port, but it's not seamless, most shell programs will not work with
129	it.
130	.TP
131	.BR "-r printer:<printername>[=<driver>],..."
132	Redirects a printer queue on the client to the server. The <printername>
133	is the name of the queue in your local system. <driver> defaults to a
134	simple PS-driver unless you specify one. Keep in mind that you need a
135	100% match in the server environment, or the driver will fail. The first
136	printer on the command line will be set as your default printer.
137	.TP
138	.BR "-r sound:[on\|off\|remote]"
139	Redirects sound generated on the server to the client ( Requires
140	Windows XP or newer).
141	.TP
142	.BR "-0"
143	Attach to the console of the server (requires Windows Server 2003
144	or newer).
145	.TP
146	.BR "-4"
147	Use RDP version 4.
148	.TP
149	.BR "-5"
150	Use RDP version 5 (default).
151	.PP
152	.SH LINKS
153	Main website of rdesktop
154	.br
155	\fIhttp://www.rdesktop.org/
156	.LP
157	.PP