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

NAME

6       xfreerdp - FreeRDP X11 client
7

SYNOPSIS

9       xfreerdp [file] [options] [/v: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       /a:addin[,options], /addin:addin[,options]
18           Addin
19
20       /action-script:file-name
21           Action script (default:~/.config/freerdp/action.sh)
22
23       /admin, /console
24           Admin (or console) session
25
26       +aero
27           desktop composition (default:off)
28
29       /app:path or ||alias
30           Remote application program
31
32       /app-cmd:parameters
33           Remote application command-line parameters
34
35       /app-file:file-name
36           File to open with remote application
37
38       /app-guid:app-guid
39           Remote application GUID
40
41       /app-icon:icon-path
42           Remote application icon for user interface
43
44       /app-name:app-name
45           Remote application name for user interface
46
47       /app-workdir:workspace path
48           Remote application workspace path
49
50       /assistance:password
51           Remote assistance password
52
53       /auto-request-control:
54           Automatically request remote assistance input control
55
56       +async-channels
57           Asynchronous channels (experimental) (default:off)
58
59       +async-input
60           Asynchronous input (default:off)
61
62       +async-update
63           Asynchronous update (default:off)
64
65       /audio-mode:mode
66           Audio output mode
67
68       +auth-only
69           Authenticate only (default:off)
70
71       -authentication
72           Authentication (expermiental) (default:on)
73
74       +auto-reconnect
75           Automatic reconnection (default:off)
76
77       /auto-reconnect-max-retries:retries
78           Automatic reconnection maximum retries, 0 for unlimited [0,1000]
79
80       +bitmap-cache
81           bitmap cache (default:off)
82
83       /bpp:depth
84           Session bpp (color depth) (default:16)
85
86       /buildconfig
87           Print the build configuration
88
89       /cert-deny
90           Automatically abort connection for any certificate that can not be
91           validated.
92
93       /cert-ignore
94           Ignore certificate
95
96       /cert-name:name
97           Certificate name
98
99       /cert-tofu
100           Automatically accept certificate on first connect
101
102       /client-build-number:number
103           Client Build Number sent to server (influences smartcard behaviour,
104           see [MS-RDPESC])
105
106       /client-hostname:name
107           Client Hostname to send to server
108
109       -clipboard
110           Redirect clipboard (default:on)
111
112       /codec-cache:[rfx|nsc|jpeg]
113           Bitmap codec cache
114
115       -compression, -z
116           compression (default:on)
117
118       /compression-level:level
119           Compression level (0,1,2)
120
121       +credentials-delegation
122           credentials delegation (default:off)
123
124       /d:domain
125           Domain
126
127       -decorations
128           Window decorations (default:on)
129
130       /disp
131           Display control
132
133       /drive:name,path
134           Redirect directory <path< as named share <name<. Hotplug support is
135           enabled with /drive:hotplug,*. This argument provides the same
136           function as "Drives that I plug in later" option in MSTSC.
137
138       +drives
139           Redirect all mount points as shares (default:off)
140
141       /dvc:channel[,options]
142           Dynamic virtual channel
143
144       /dynamic-resolution
145           Send resolution updates when the window is resized
146
147       /echo, /echo
148           Echo channel
149
150       -encryption
151           Encryption (experimental) (default:on)
152
153       /encryption-methods:[40,][56,][128,][FIPS]
154           RDP standard security encryption methods
155
156       /f
157           Fullscreen mode (<Ctrl<+<Alt<+<Enter< toggles fullscreen)
158
159       -fast-path
160           fast-path input/output (default:on)
161
162       +fipsmode
163           FIPS mode (default:off)
164
165       /floatbar[:sticky:[on|off],default:[visible|hidden],show:[always|fullscreen||window]]
166           floatbar is disabled by default (when enabled defaults to sticky in
167           fullscreen mode)
168
169       -fonts
170           smooth fonts (ClearType) (default:on)
171
172       /frame-ack:number
173           Number of frame acknowledgement
174
175       /from-stdin[:force]
176           Read credentials from stdin. With <force< the prompt is done before
177           connection, otherwise on server request.
178
179       /g:gateway[:port]
180           Gateway Hostname
181
182       /gateway-usage-method:[direct|detect], /gum:[direct|detect]
183           Gateway usage method
184
185       /gd:domain
186           Gateway domain
187
188       /gdi:sw|hw
189           GDI rendering
190
191       /geometry
192           Geometry tracking channel
193
194       +gestures
195           Consume multitouch input locally (default:off)
196
197       /gfx[:RFX]
198           RDP8 graphics pipeline
199
200       +gfx-progressive
201           RDP8 graphics pipeline using progressive codec (default:off)
202
203       +gfx-small-cache
204           RDP8 graphics pipeline using small cache mode (default:off)
205
206       +gfx-thin-client
207           RDP8 graphics pipeline using thin client mode (default:off)
208
209       +glyph-cache
210           Glyph cache (experimental) (default:off)
211
212       /gp:password
213           Gateway password
214
215       -grab-keyboard
216           Grab keyboard (default:on)
217
218       /gt:[rpc|http|auto]
219           Gateway transport type
220
221       /gu:[[domain\]user|user[@domain]]
222           Gateway username
223
224       /gat:access token
225           Gateway Access Token
226
227       /h:height
228           Height (default:768)
229
230       -heartbeat
231           Support heartbeat PDUs (default:on)
232
233       /help, /?
234           Print help
235
236       +home-drive
237           Redirect user home as share (default:off)
238
239       /ipv6, /6
240           Prefer IPv6 AAA record over IPv4 A record
241
242       /kbd:0xid or name
243           Keyboard layout
244
245       /kbd-fn-key:value
246           Function key value
247
248       /kbd-list
249           List keyboard layouts
250
251       /kbd-subtype:id
252           Keyboard subtype
253
254       /kbd-type:id
255           Keyboard type
256
257       /load-balance-info:info-string
258           Load balance info
259
260       /log-filters:tag:level[,tag:level[,...]]
261           Set logger filters, see wLog(7) for details
262
263       /log-level:[OFF|FATAL|ERROR|WARN|INFO|DEBUG|TRACE]
264           Set the default log level, see wLog(7) for details
265
266       /max-fast-path-size:size
267           Specify maximum fast-path update size
268
269       /max-loop-time:time
270           Specify maximum time in milliseconds spend treating packets
271
272       +menu-anims
273           menu animations (default:off)
274
275       /microphone[:[sys:sys,][dev:dev,][format:format,][rate:rate,][channel:channel]],
276       /mic[:[sys:sys,][dev:dev,][format:format,][rate:rate,][channel:channel]]
277           Audio input (microphone)
278
279       /monitor-list
280           List detected monitors
281
282       /monitors:id[,id[,...]]
283           Select monitors to use
284
285       -mouse-motion
286           Send mouse motion (default:on)
287
288       /multimedia[:[sys:sys,][dev:dev,][decoder:decoder]],
289       /mmr[:[sys:sys,][dev:dev,][decoder:decoder]]
290           Redirect multimedia (video)
291
292       /multimon[:force]
293           Use multiple monitors
294
295       +multitouch
296           Redirect multitouch input (default:off)
297
298       +multitransport
299           Support multitransport protocol (default:off)
300
301       -nego
302           protocol security negotiation (default:on)
303
304       /network:[modem|broadband|broadband-low|broadband-high|wan|lan|auto]
305           Network connection type
306
307       /nsc, /nscodec
308           NSCodec support
309
310       +offscreen-cache
311           offscreen bitmap cache (default:off)
312
313       /orientation:[0|90|180|270]
314           Orientation of display in degrees
315
316       +old-license
317           Use the old license workflow (no CAL and hwId set to 0)
318           (default:off)
319
320       /p:password
321           Password
322
323       /parallel[:name[,path]]
324           Redirect parallel device
325
326       /parent-window:window-id
327           Parent window id
328
329       +password-is-pin
330           Use smart card authentication with password as smart card PIN
331           (default:off)
332
333       /pcb:blob
334           Preconnection Blob
335
336       /pcid:id
337           Preconnection Id
338
339       /pheight:height
340           Physical height of display (in millimeters)
341
342       /play-rfx:pcap-file
343           Replay rfx pcap file
344
345       /port:number
346           Server port
347
348       -suppress-output
349           suppress output when minimized (default:on)
350
351       +print-reconnect-cookie
352           Print base64 reconnect cookie after connecting (default:off)
353
354       /printer[:name[,driver]]
355           Redirect printer device
356
357       /proxy:[proto://][user:password@]host:port
358           Proxy settings: override env. var (see also environment variable
359           below). Protocol "socks5" should be given explicitly where "http"
360           is default.
361
362       /pth:password-hash, /pass-the-hash:password-hash
363           Pass the hash (restricted admin mode)
364
365       /pwidth:width
366           Physical width of display (in millimeters)
367
368       /rdp2tcp:executable path[:arg...]
369           TCP redirection
370
371       /reconnect-cookie:base64-cookie
372           Pass base64 reconnect cookie to the connection
373
374       /redirect-prefer:FQDN|IP|NETBIOS,[...]
375           Override the preferred redirection order
376
377       /relax-order-checks, /relax-order-checks
378           Do not check if a RDP order was announced during capability
379           exchange, only use when connecting to a buggy server
380
381       /restricted-admin, /restrictedAdmin
382           Restricted admin mode
383
384       /rfx
385           RemoteFX
386
387       /rfx-mode:[image|video]
388           RemoteFX mode
389
390       /scale:[100|140|180]
391           Scaling factor of the display (default:100)
392
393       /scale-desktop:percentage
394           Scaling factor for desktop applications (value between 100 and 500)
395           (default:100)
396
397       /scale-device:100|140|180
398           Scaling factor for app store applications (default:100)
399
400       /sec:[rdp|tls|nla|ext]
401           Force specific protocol security
402
403       +sec-ext
404           NLA extended protocol security (default:off)
405
406       -sec-nla
407           NLA protocol security (default:on)
408
409       -sec-rdp
410           RDP protocol security (default:on)
411
412       -sec-tls
413           TLS protocol security (default:on)
414
415       /serial[:name[,path[,driver[,permissive]]]],
416       /tty[:name[,path[,driver[,permissive]]]]
417           Redirect serial device
418
419       /shell:shell
420           Alternate shell
421
422       /shell-dir:dir
423           Shell working directory
424
425       /size:widthxheight or percent%[wh]
426           Screen size (default:1024x768)
427
428       /smart-sizing[:widthxheight]
429           Scale remote desktop to window size
430
431       /smartcard[:str[,str...]]
432           Redirect the smartcard devices containing any of the <str< in their
433           names.
434
435       /smartcard-logon
436           Activates Smartcard Logon authentication. (EXPERIMENTAL: NLA not
437           supported)
438
439       /sound[:[sys:sys,][dev:dev,][format:format,][rate:rate,][channel:channel,][latency:latency,][quality:quality]],
440       /audio[:[sys:sys,][dev:dev,][format:format,][rate:rate,][channel:channel,][latency:latency,][quality:quality]]
441           Audio output (sound)
442
443       /span
444           Span screen over multiple monitors
445
446       /spn-class:service-class
447           SPN authentication service class
448
449       /ssh-agent, /ssh-agent
450           SSH Agent forwarding channel
451
452       /t:title, /title:title
453           Window title
454
455       -themes
456           themes (default:on)
457
458       /tls-ciphers:[netmon|ma|ciphers]
459           Allowed TLS ciphers
460
461       /tls-seclevel:level
462           TLS security level - defaults to 1 (default:1)
463
464       -toggle-fullscreen
465           Alt+Ctrl+Enter to toggle fullscreen (default:on)
466
467       /u:[[domain\]user|user[@domain]]
468           Username
469
470       +unmap-buttons
471           Let server see real physical pointer button (default:off)
472
473       /usb:[dbg,][dev:dev,][id|addr,][auto]
474           Redirect USB device
475
476       /v:server[:port]
477           Server hostname
478
479       /vc:channel[,options]
480           Static virtual channel
481
482       /version
483           Print version
484
485       /video
486           Video optimized remoting channel
487
488       /vmconnect[:vmid]
489           Hyper-V console (use port 2179, disable negotiation)
490
491       /w:width
492           Width (default:1024)
493
494       -wallpaper
495           wallpaper (default:on)
496
497       +window-drag
498           full window drag (default:off)
499
500       /window-position:xposxypos
501           window position
502
503       /wm-class:class-name
504           Set the WM_CLASS hint for the window instance
505
506       /workarea
507           Use available work area
508

ENVIRONMENT VARIABLES

510       wlog environment variable
511           xfreerdp uses wLog as its log facility, you can refer to the
512           corresponding man page (wlog(7)) for more informations. Arguments
513           passed via the /log-level or /log-filters have precedence over the
514           environment variables.
515

EXAMPLES

517       xfreerdp connection.rdp /p:Pwd123! /f
518           Connect in fullscreen mode using a stored configuration
519           connection.rdp and the password Pwd123!
520
521       xfreerdp /u:USER /size:50%h /v:rdp.contoso.com
522           Connect to host rdp.contoso.com with user USER and a size of 50
523           percent of the height. If width (w) is set instead of height (h)
524           like /size:50%w. 50 percent of the width is used.
525
526       xfreerdp /u:CONTOSO\\JohnDoe /p:Pwd123! /v:rdp.contoso.com
527           Connect to host rdp.contoso.com with user CONTOSO\\JohnDoe and
528           password Pwd123!
529
530       xfreerdp /u:JohnDoe /p:Pwd123! /w:1366 /h:768 /v:192.168.1.100:4489
531           Connect to host 192.168.1.100 on port 4489 with user JohnDoe,
532           password Pwd123!. The screen width is set to 1366 and the height to
533           768
534
535       xfreerdp /u:JohnDoe /p:Pwd123!
536       /vmconnect:C824F53E-95D2-46C6-9A18-23A5BB403532 /v:192.168.1.100
537           Establish a connection to host 192.168.1.100 with user JohnDoe,
538           password Pwd123!  and connect to Hyper-V console (use port 2179,
539           disable negotiation) with VMID C824F53E-95D2-46C6-9A18-23A5BB403532
540
541       +clipboard
542           Activate clipboard redirection
543
544       /drive:home,/home/user
545           Activate drive redirection of /home/user as home drive
546
547       /smartcard:<device>
548           Activate smartcard redirection for device device
549
550       /printer:<device>,<driver>
551           Activate printer redirection for printer device using driver driver
552
553       /serial:<device>
554           Activate serial port redirection for port device
555
556       /parallel:<device>
557           Activate parallel port redirection for port device
558
559       /sound:sys:alsa
560           Activate audio output redirection using device sys:alsa
561
562       /microphone:sys:alsa
563           Activate audio input redirection using device sys:alsa
564
565       /multimedia:sys:alsa
566           Activate multimedia redirection using device sys:alsa
567
568       /usb:id,dev:054c:0268
569           Activate USB device redirection for the device identified by
570           054c:0268
571

LINKS

573       http://www.freerdp.com/
574

AUTHOR

576       The FreeRDP Team
577
578
579
580
581freerdp                           2020-02-07                       XFREERDP(1)