339 lines
12 KiB
Groff
339 lines
12 KiB
Groff
.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 Explore.
|
|
If SeamlessRDP is enabled this is the application which i started in seamless mode.
|
|
.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%", "-g 80%x70%".
|
|
|
|
If the specified geometry depends on the screen size, and the screen
|
|
size is changed, rdesktop will automatically reconnect using the new
|
|
screen size. This requires that rdesktop has been compiled with RandR
|
|
support.
|
|
.TP
|
|
.BR "-i"
|
|
Use password as smartcard pin. If a valid user certificate is matched in smart card
|
|
reader the password passed with \f-p\fR argument is used as pin for the smart card.
|
|
This feature also requires that smart card redirection is used using \f-r scard\fR argument.
|
|
.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 "-t"
|
|
Disable use of remote control. This will disable features like seamless connection
|
|
sharing.
|
|
.TP
|
|
.BR "-A <seamlessrdpshell>"
|
|
Enable SeamlessRDP by specifying the path to seamless rdp shell.
|
|
In this mode, rdesktop creates a X11 window for each window on the server side.
|
|
This mode requires the SeamlessRDP server side component, which is available from
|
|
\fIhttp://www.cendio.com/seamlessrdp/\fR.
|
|
|
|
When using this option, you should normally specify a startup shell which
|
|
launches the desired application through SeamlessRDP.
|
|
|
|
Example: rdesktop -A 'c:\\seamlessrdp\\seamlessrdpshell.exe' -s 'notepad' mywts.domain.com
|
|
|
|
Any subsequential call to the above commandline example will make use of the seamless
|
|
connection sharing feature which spawns another notepad in the current connection to the
|
|
specified server and then exit.
|
|
|
|
.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. The title must be specified using an UTF-8 string.
|
|
.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, 24 or 32).
|
|
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. The default value is the depth
|
|
of the root window.
|
|
.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, 30MB for 24-bit colour
|
|
and 40MB for 32-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 "-r scard[:<Scard Name>=<Alias Name>[;<Vendor Name>][,...]]"
|
|
Enables redirection of one or more smart-cards. You can provide
|
|
static name binding between linux and windows. To do this you
|
|
can use optional parameters as described: <Scard Name> - device name in
|
|
Linux/Unix enviroment, <Alias Name> - device name shown in Windows enviroment
|
|
<Vendor Name> - optional device vendor name. For list of examples run
|
|
rdesktop without parameters.
|
|
.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 "CredSSP Smartcard options"
|
|
.TP
|
|
.BR "--sc-csp-name <name>"
|
|
Specify the CSP (Crypto Service Provider) to use on the windows side for the smartcard
|
|
authentication. CSP is the driver for your smartcard and it seems like this is required
|
|
to be specified for CredSSP authentication. For swedish NetID the following CSP name is
|
|
used; "Net iD - CSP".
|
|
.TP
|
|
.BR "--sc-container-name <name>"
|
|
Specify the container name, usally this is the username for default container and it seems
|
|
like this is required to be specified for CredSSP authentication.
|
|
.TP
|
|
.BR "--sc-reader-name <name>"
|
|
Specify the reader name to be used to prevent the pin code being sent to wrong card if there
|
|
are several readers.
|
|
.TP
|
|
.BR "--sc-card-name <name>"
|
|
Specify the card name for example; "Telia EID IP5a".
|
|
.PP
|
|
|
|
.SH "EXIT VALUES"
|
|
.PP
|
|
.IP "\fB0\fP"
|
|
RDP session terminated normally
|
|
.IP "\fB1\fP"
|
|
Server initiated disconnect (also returned for logoff by XP joined to a domain)
|
|
.IP "\fB2\fP"
|
|
Server initiated logoff
|
|
.IP "\fB3\fP"
|
|
Server idle timeout reached
|
|
.IP "\fB4\fP"
|
|
Server logon timeout reached
|
|
.IP "\fB5\fP"
|
|
The session was replaced
|
|
.IP "\fB6\fP"
|
|
The server is out of memory
|
|
.IP "\fB7\fP"
|
|
The server denied the connection
|
|
.IP "\fB8\fP"
|
|
The server denied the connection for security reason
|
|
.IP "\fB9\fP"
|
|
The user cannot connect to the server due to insufficient access
|
|
privileges
|
|
.IP "\fB10\fP"
|
|
The server does not accept saved user credentials and requires that
|
|
the user enter their credentials for each connection
|
|
.IP "\fB11\fP"
|
|
Disconnect initiated by administration tool
|
|
.IP "\fB12\fP"
|
|
Disconnect initiated by user
|
|
.IP "\fB16\fP"
|
|
Internal licensing error
|
|
.IP "\fB17\fP"
|
|
No license server available
|
|
.IP "\fB18\fP"
|
|
No valid license available
|
|
.IP "\fB19\fP"
|
|
Invalid licensing message
|
|
.IP "\fB20\fP"
|
|
Hardware id doesn't match software license
|
|
.IP "\fB21\fP"
|
|
Client license error
|
|
.IP "\fB22\fP"
|
|
Network error during licensing protocol
|
|
.IP "\fB23\fP"
|
|
Licensing protocol was not completed
|
|
.IP "\fB24\fP"
|
|
Incorrect client license enryption
|
|
.IP "\fB25\fP"
|
|
Can't upgrade license
|
|
.IP "\fB26\fP"
|
|
The server is not licensed to accept remote connections
|
|
.IP "\fB62\fP"
|
|
The local client window was closed
|
|
.IP "\fB63\fP"
|
|
Some other, unknown error occured
|
|
.IP "\fB64\fP"
|
|
Command line usage error
|
|
.IP "\fB69\fP"
|
|
A service or resource (such as memory) is unavailable
|
|
.IP "\fB70\fP"
|
|
An internal software error has been detected
|
|
.IP "\fB71\fP"
|
|
Operating system error
|
|
.IP "\fB76\fP"
|
|
Protocol error or unable to connect to remote host.
|
|
|
|
.PP
|
|
.SH LINKS
|
|
Main website of rdesktop
|
|
.br
|
|
\fIhttp://www.rdesktop.org/
|
|
.LP
|
|
.PP
|