1xfreerdp(1) General Commands Manual xfreerdp(1)
2
6 xfreerdp - X11 front-end for FreeRDP
7
9 xfreerdp [options] server[:port] [[options] server[:port] ...]
10
12 xfreerdp is a front-end for various FreeRDP components, which implement
13 a client of the Remote Desktop Protocol (RDP), used in a number of Mi‐
14 crosoft products including Windows NT Terminal Server, Windows 2000
15 Server, Windows XP, Windows 2003 Server, Windows Vista, Windows 2008
16 Server and Windows 7, but also implemented by xrdp and VirtualBox.
17 xfreerdp can connect to multiple servers if more than one server
19 addresses are specified, and each session runs in a separate window.
20
22 -u <username>
23 Username for authentication on the server.
24 -d <domain>
26 Domain for authentication.
27 -p <password>
29 The password to authenticate with. Note that this may have no
30 effect if "Always prompt for password" is enabled on the server.
31 WARNING: if you specify a password on the command line it may be
32 visible to other users when they use tools like ps.
33 -s <shell>
35 Startup shell for the session - starts a specific application
36 instead of Explorer.
37 -c <directory>
39 The initial working directory for the session. Often used in
40 combination with -s to set up a fixed login environment.
41 -n <hostname>
43 Client hostname reported to the server. Normally xfreerdp auto‐
44 matically obtains the hostname of the client.
45 -t <port>
47 Server port number. Default is the standard RDP port 3389. Can
48 also be specified as ":<port>" after the server hostname.
49 -g <geometry>
51 Desktop geometry (WxH).
52 -a <bpp>
54 Sets the color depth for the connection (8, 15, 16, 24 or 32).
55 More than 8 bpp are only supported when connecting to Windows XP
56 (up to 24 bpp) or newer. Note that the color depth may also be
57 limited by the server configuration. The default value is the
58 depth of the root window.
59 -z Enable compression inside the encrypted RDP datastream.
61 -f Full screen mode. Causes the window to fully cover the current
63 screen. This mode can be toggled at any time using Ctrl-Alt-
64 Enter
65 -x <experience>
67 Changes default bandwidth performance behaviour for RDP5. By
68 default only theming is enabled, and all other options are dis‐
69 abled (corresponding to modem (56 Kbps)). Setting experience to
70 b[roadband] enables menu animations and full window dragging.
71 Setting experience to l[an] will also enable the desktop wallpa‐
72 per. Setting experience to m[odem] disables all (including
73 themes). Experience can also be a hexidecimal number containing
74 the flags.
75 -0 Attach to the admin console of the server. This is the default
77 if no server license is available.
78 -o Play audio on the server side.
80 -k Force particular keyboard layout ID.
82 --kbd-list
84 List all available keyboard layout IDs and exit.
85 --no-tls
87 Disable TLS encryption.
88 --no-osb
90 Disable off screen bitmaps.
91 -h Print help message.
93 --version
95 Print version information.
96 --plugin <pluginname> [--data <plugindata> --]
98 Load a Virtual Channel plugin module, and optionally pass ini‐
99 tial parameters to it. <pluginname> can be the virtual channel
100 name, or a path specifying the plugin module. If the virtual
101 channel name was passed, xfreerdp will try to locate the plugin
102 module in its plugin path ${prefix}/lib/freerdp.
103 Some plugins support retrieving initial parameters. Add --data
105 argument after the <pluginname> in order to pass such parame‐
106 ters, and end it with --.
107 The --plugin argument can be repeated more than once if there
109 are multiple plugins to load.
110 Following plugins are currently supported:
112 --plugin cliprdr
114 Synchronize client and server clipboard data. Plain text, Uni‐
115 code text, HTML content and images are supported.
116 --plugin rdpsnd
118 Redirects sound generated on the server to the client.
119 --plugin rdpdr --data <subplugin> [<subplugin> ...] --
121 Redirects file system devices on your client to the server.
122 <subplugin> can be one of more of the following:
123 disk:<sharename>:<path> Redirect <path> to the server as shared
125 folder \\tsclient\<sharename>.
126 printer[:<printername>[:<driver>]] Redirect printers to the
128 server. If both <printername> and <driver> are omitted, the
129 printer sub-plugin will automatically redirect all CUPS printers
130 using the default PostScript driver "MS Publisher Imagesetter".
131 serial:<sharename>:<device> Redirect serial <device> to the
133 server. It will be referenced by <sharedname>.
134 parallel:<sharedname>:<lptdevice> Redirects parallel device
136 <lptdevice> on your client to the server, where it will be ref‐
137 erenced by <sharedname>. Bidirectional/Read support requires
138 Windows XP or newer.
139 --plugin drdynvc --data <subplugin> [<subplugin> ...] --
142 Load the Dynamic Virtual Channel. <subplugin> can be the DVC
143 sub-plugin name, or a path specifying the sub-plugin module. If
144 the DVC sub-plugin name was passed, xfreerdp will try to locate
145 the sub-plugin in its plugin path ${prefix}/lib/freerdp.
146 Following DVC sub-plugins are currently supported:
148 audin Redirect audio recording device to the server. This is an
150 RDP 7.0 feature available in Windows 7, Windows 2008 and Windows
151 2008 R2. Note that Windows 7 Enterprise edition and Windows 2008
152 Server has audio redirection disable by default.
153
156 Main website of FreeRDP
157 http://www.freerdp.com/
158 May 2010 xfreerdp(1)