| 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, which is available from |
| 83 |
\fIhttp://www.cendio.com/seamlessrdp/\fR. |
| 84 |
When using this option, you should specify a startup shell which |
| 85 |
launches the desired application through SeamlessRDP. |
| 86 |
|
| 87 |
Example: rdesktop -A -s 'seamlessrdpshell notepad'. |
| 88 |
.TP |
| 89 |
.BR "-B" |
| 90 |
Use the BackingStore of the Xserver instead of the integrated one in |
| 91 |
rdesktop. |
| 92 |
.TP |
| 93 |
.BR "-e" |
| 94 |
Disable encryption. This option is only needed (and will only work) if you |
| 95 |
have a French version of NT TSE. |
| 96 |
.TP |
| 97 |
.BR "-E" |
| 98 |
Disable encryption from client to server. This sends an encrypted login packet, |
| 99 |
but everything after this is unencrypted (including interactive logins). |
| 100 |
.TP |
| 101 |
.BR "-m" |
| 102 |
Do not send mouse motion events. This saves bandwidth, although some Windows |
| 103 |
applications may rely on receiving mouse motion. |
| 104 |
.TP |
| 105 |
.BR "-C" |
| 106 |
Use private colourmap. This will improve colour accuracy on an 8-bit display, |
| 107 |
but rdesktop will appear in false colour when not focused. |
| 108 |
.TP |
| 109 |
.BR "-D" |
| 110 |
Hide window manager decorations, by using MWM hints. |
| 111 |
.TP |
| 112 |
.BR "-K" |
| 113 |
Do not override window manager key bindings. By default rdesktop attempts |
| 114 |
to grab all keyboard input when it is in focus. |
| 115 |
.TP |
| 116 |
.BR "-S <button size>" |
| 117 |
Enable single application mode. This option can be used when running a |
| 118 |
single, maximized application (via -s). When the minimize button of |
| 119 |
the windows application is pressed, the rdesktop window is minimized |
| 120 |
instead of the remote application. The maximize/restore button is |
| 121 |
disabled. For this to work, you must specify the correct button |
| 122 |
size, in pixels. The special word "standard" means 18 pixels. |
| 123 |
.TP |
| 124 |
.BR "-T <title>" |
| 125 |
Sets the window title. The title must be specified using an UTF-8 string. |
| 126 |
.TP |
| 127 |
.BR "-N" |
| 128 |
Enable numlock syncronization between the Xserver and the remote RDP |
| 129 |
session. This is useful with applications that looks at the numlock |
| 130 |
state, but might cause problems with some Xservers like Xvnc. |
| 131 |
.TP |
| 132 |
.BR "-X <windowid>" |
| 133 |
Embed rdesktop-window in another window. The windowid is expected to |
| 134 |
be decimal or hexadecimal (prefixed by 0x). |
| 135 |
.TP |
| 136 |
.BR "-a <bpp>" |
| 137 |
Sets the colour depth for the connection (8, 15, 16 or 24). |
| 138 |
More than 8 bpp are only supported when connecting to Windows XP |
| 139 |
(up to 16 bpp) or newer. Note that the colour depth may also be |
| 140 |
limited by the server configuration. The default value is the depth |
| 141 |
of the root window. |
| 142 |
.TP |
| 143 |
.BR "-z" |
| 144 |
Enable compression of the RDP datastream. |
| 145 |
.TP |
| 146 |
.BR "-x <experience>" |
| 147 |
Changes default bandwidth performance behaviour for RDP5. By default only |
| 148 |
theming is enabled, and all other options are disabled (corresponding |
| 149 |
to modem (56 Kbps)). Setting experience to b[roadband] enables menu |
| 150 |
animations and full window dragging. Setting experience to l[an] will |
| 151 |
also enable the desktop wallpaper. Setting experience to m[odem] |
| 152 |
disables all (including themes). Experience can also be a hexidecimal |
| 153 |
number containing the flags. |
| 154 |
.TP |
| 155 |
.BR "-P" |
| 156 |
Enable caching of bitmaps to disk (persistent bitmap caching). This generally |
| 157 |
improves performance (especially on low bandwidth connections) and reduces |
| 158 |
network traffic at the cost of slightly longer startup and some disk space. |
| 159 |
(10MB for 8-bit colour, 20MB for 15/16-bit colour and 30MB for 24-bit colour |
| 160 |
sessions) |
| 161 |
.TP |
| 162 |
.BR "-r <device>" |
| 163 |
Enable redirection of the specified device on the client, such |
| 164 |
that it appears on the server. Note that the allowed |
| 165 |
redirections may be restricted by the server configuration. |
| 166 |
|
| 167 |
Following devices are currently supported: |
| 168 |
.TP |
| 169 |
.BR "-r comport:<comport>=<device>,..." |
| 170 |
Redirects serial devices on your client to the |
| 171 |
server. Note that if you need to change any settings on the serial device(s), |
| 172 |
do so with an appropriate tool before starting rdesktop. In most |
| 173 |
OSes you would use stty. Bidirectional/Read support requires Windows XP or newer. |
| 174 |
In Windows 2000 it will create a port, but it's not seamless, most |
| 175 |
shell programs will not work with it. |
| 176 |
.TP |
| 177 |
.BR "-r disk:<sharename>=<path>,..." |
| 178 |
Redirects a path to the share \\\\tsclient\\<sharename> on the server |
| 179 |
(requires Windows XP or newer). The share name is limited to 8 |
| 180 |
characters. |
| 181 |
.TP |
| 182 |
.BR "-r lptport:<lptport>=<device>,..." |
| 183 |
Redirects parallel devices on your client to the server. |
| 184 |
Bidirectional/Read support requires Windows XP or newer. In Windows 2000 |
| 185 |
it will create a port, but it's not seamless, most shell programs will not work with |
| 186 |
it. |
| 187 |
.TP |
| 188 |
.BR "-r printer:<printername>[=<driver>],..." |
| 189 |
Redirects a printer queue on the client to the server. The <printername> |
| 190 |
is the name of the queue in your local system. <driver> defaults to a |
| 191 |
simple PS-driver unless you specify one. Keep in mind that you need a |
| 192 |
100% match in the server environment, or the driver will fail. The first |
| 193 |
printer on the command line will be set as your default printer. |
| 194 |
.TP |
| 195 |
.BR "-r sound:[local|off|remote]" |
| 196 |
Redirects sound generated on the server to the client. "remote" only has |
| 197 |
any effect when you connect to the console with the -0 option. (Requires |
| 198 |
Windows XP or newer). |
| 199 |
.TP |
| 200 |
.BR "-r lspci" |
| 201 |
Activates the lspci channel, which allows the server to enumerate the |
| 202 |
clients PCI devices. See the file lspci-channel.txt in the |
| 203 |
documentation for more information. |
| 204 |
.TP |
| 205 |
.BR "-r scard[:<Scard Name>=<Alias Name>[;<Vendor Name>][,...]]" |
| 206 |
Enables redirection of one or more smart-cards. You can provide |
| 207 |
static name binding between linux and windows. To do this you |
| 208 |
can use optional parameters as described: <Scard Name> - device name in |
| 209 |
Linux/Unix enviroment, <Alias Name> - device name shown in Windows enviroment |
| 210 |
<Vendor Name> - optional device vendor name. For list of examples run |
| 211 |
rdesktop without parameters. |
| 212 |
.TP |
| 213 |
.BR "-0" |
| 214 |
Attach to the console of the server (requires Windows Server 2003 |
| 215 |
or newer). |
| 216 |
.TP |
| 217 |
.BR "-4" |
| 218 |
Use RDP version 4. |
| 219 |
.TP |
| 220 |
.BR "-5" |
| 221 |
Use RDP version 5 (default). |
| 222 |
.PP |
| 223 |
.SH LINKS |
| 224 |
Main website of rdesktop |
| 225 |
.br |
| 226 |
\fIhttp://www.rdesktop.org/ |
| 227 |
.LP |
| 228 |
.PP |
Parent Directory
| 
Revision Log