1XFREERDP(1)                        xfreerdp                        XFREERDP(1)
2
3
4

NAME

6       xfreerdp - FreeRDP X11 client
7

SYNOPSIS

9       xfreerdp [options] server[:port]
10

DESCRIPTION

12       xfreerdp is an X11 Remote Desktop Protocol (RDP) client which is part
13       of the FreeRDP project. An RDP server is built-in to many editions of
14       Windows. Alternative servers included xrdp and VRDP (VirtualBox).
15

OPTIONS

17       -0
18           Attach to the admin console of the server.
19
20       -a bpp
21           Sets the color depth for the connection to bpp bits per pixel.
22           Valid values are 8, 15, 16, 24 and 32. The default value is the
23           color depth of the FreeRDP-window.
24
25       -c dir
26           Sets the working-dir to dir. This parameter is only used when an
27           AlternateShell (-s shell) is requested.  dir should contain the
28           executable file specified in the AlternateShell.
29
30       -D
31           Removes the windows decorations.
32
33       -d domain
34           Set the domain used in authentication to domain.
35
36       -f
37           start in full screen mode. This mode can always be en- and disabled
38           using Ctrl-Alt-Enter.
39
40       -T text
41           Sets the window title to text.
42
43       -g geometry
44           Sets the size of the FreeRDP window (and of the remote desktop,
45           when establishing a new connection).  geometry can have one of the
46           following forms:
47
48           WxH
49               in this case the resulting window will be of WxH pixels.
50
51           P%
52               in this case the resulting window will be P% of your screen.
53
54           The special keyword workarea
55               in this case the resulting window will be of the same size as
56               your workarea.
57
58
59       -h
60           Print help.
61
62       -k id
63           Sets the keyboard-layout-id to id.
64
65       -K
66           Do not interfere with window manager bindings (don't grab
67           keyboard).
68
69       -n hostname
70           Set the reported client hostname to hostname. Default is to
71           automatically detect the hostname.
72
73       -o
74           Play audio on the console instead of redirecting to the client.
75
76       -p password
77           Password used in authentication.
78
79       -s shell
80           Sets the startup-shell to shell. This parameter should contain a
81           complete path to the alternate shell. If the alternete shell
82           requires a different working directory use -c dir.
83
84       -t port
85           Connect to port, instead of the default 3389.
86
87       -u username
88           Username used in authentication.
89
90       -x flag
91           Set the experience performance flags.  flag can be one of:
92
93           m - (modem)
94               Equivalent to 15.
95
96           b - (broadband)
97               Equivalent to 1.
98
99           l - (lan)
100               Equivalent to 0.
101
102           num
103               A hexadecimal number that represents a bit-mask, were numbers
104               mean the following [1]:
105
106               1
107                   Disable desktop wallpaper.
108
109               2
110                   Disable full-window drag (only the window outline is
111                   displayed when the window is moved).
112
113               4
114                   Disable menu animations.
115
116               8
117                   Disable user interface themes.
118
119               20
120                   Disable mouse cursor shadows.
121
122               40
123                   Disable cursor blinking.
124
125               80
126                   Enable font smoothing.
127
128               100
129                   Enable Desktop Composition.
130
131
132
133       -X xid
134           embed xfreerdp into window with xid.
135
136       -z
137           Enable compression.
138
139       --app
140           initialize a RemoteApp connection. This implies -g workarea.
141
142       --no-auth
143           Skips authentication. This is useful e.g. for the current FreeRDP
144           server that doesn't yet support server-side authentication.
145
146       --authonly
147           Only authenticates. This is useful to test your credentials
148           (username and password). Returns status code 0 if the client can
149           connect. Requires a username, password and connection host at the
150           command line.
151
152       --no-bmp-cache
153           Disable bitmap cache.
154
155       --certificate-name name
156           use name for the logon certificate, instead of the server name
157
158       --composition
159           Enable composition (RDVH only, not to be confused with remote
160           composition).
161
162       --ext extname
163           load extension extname
164
165       --no-fastpath
166           Disables fast-path. Use slow-path packets instead, which have
167           larger headers. It might be good for debugging certain issues when
168           you suspect it might be linked to the parsing of one of the two
169           header types.
170
171       --from-stdin
172           Prompts for unspecified arguments -u username, -p password, -d
173           domain and connection host. This is useful to hide arguments from
174           ps. Also useful for scripts that will feed these arguments to the
175           client via (what else?) stdin.
176
177       --disable-full-window-drag
178           Disable full window drag.
179
180       --gdi backend
181           GDI (Graphics Device Interface) rendering backend.  backend can be
182           either sw (software) or hw (hardware).
183
184       --help
185           Print help.
186
187       --ignore-certificate
188           ignore verification of logon certificate.
189
190       --kbd-list
191           list all keyboard layout ids used by -k
192
193       --disable-menu-animations
194           Disable menu animations.
195
196       --no-motion
197           Don't send mouse motion events.
198
199       --no-nla
200           Disable network level authentication.
201
202       --nsc
203           Enable NSCodec.
204
205       --no-osb
206           Disable off screen bitmaps.
207
208       --plugin plugin [--data data --]
209           Load one of the following plugin:
210
211           cliprdr
212               Synchronize client and server clipboard data.
213
214           drdynvc --data subplugin [subplugin ...] --
215               Enable multimedia redirection. The subplugin must be one of the
216               following:
217
218               audin
219                   Redirect audio recording device to the server.
220
221               tsmf
222                   Enable video redirection. The --plugin rdpsnd needs to be
223                   enabled as well.
224
225           rdpsnd [--data [subplugin] [latency:latency] --]
226               Enable audio output using one of the following subplugin and
227               with a given latency in ms:
228
229               pulse
230                   Use PulseAudio mixer.
231
232           rail --data executable[:workingdir[:arguments]] --
233               Launch one executable in a workingdir with given arguments. You
234               must use --app before you can use rail.
235
236           rdpdbg
237               Enable debugging virtual channel.
238
239           rdpdr --data subplugin [subplugin ...] --
240               Redirect filesystem devices on your client to the server. If
241               you want any redirection to work with Windows Server 2012 and
242               newer you must use --plugin rdpsnd before you use any rdpdr
243               options. The subplugin must be one of the following:
244
245               drive:name:path
246                   Redirect system path as disk with name.
247
248               scard[:name]
249                   Redirect smartcard with name.
250
251               serial:port:device
252                   Redirect serial device (e.g. /dev/ttyS0) to port (e.g.
253                   COM0).
254
255               parallel:port:device
256                   Redirect parallel device (e.g. /dev/lp0) to port (e.g.
257                   LPT0).
258
259               printer:cupsname:drivername
260                   Redirect printer with cupsname and drivername.
261
262
263       --no-rdp
264           Disable Standard RDP encryption.
265
266       --rfx
267           Enable RemoteFX.
268
269       --rfx-mode
270           RemoteFX operational flags.  flags can be either v[ideo], i[mage]),
271           default is video.
272
273       --ntlm version
274           force NTLM protocol version to be version, which can be one of 1 or
275           2.
276
277       --sec proto
278           force protocol security.  proto can be one of rdp, tls or nla.
279
280       --secure-checksum
281           Use salted checksums with Standard RDP encryption.
282
283       --disable-theming
284           Disable theming.
285
286       --no-tls
287           Disable TLS encryption.
288
289       --version
290           Print version information.
291
292       --disable-wallpaper
293           Disable wallpaper.
294

LINKS

296       http://www.freerdp.com/
297

AUTHOR

299       The FreeRDP Team
300

NOTES

302        1. Taken from MS-RDPBCGR Section 2.2.1.11.1.1.1 - Extended Info Packet
303
304        2. MS-RDPBCGR Section 2.2.1.11.1.1.1 - Extended Info Packet
305           http://msdn.microsoft.com/en-us/library/cc240476%28v=prot.10%29.aspx
306
307
308
309freerdp                           2011-08-27                       XFREERDP(1)