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

ENVIRONMENT VARIABLES

534       wlog environment variable
535           xfreerdp uses wLog as its log facility, you can refer to the
536           corresponding man page (wlog(7)) for more informations. Arguments
537           passed via the /log-level or /log-filters have precedence over the
538           environment variables.
539

EXAMPLES

541       xfreerdp connection.rdp /p:Pwd123! /f
542           Connect in fullscreen mode using a stored configuration
543           connection.rdp and the password Pwd123!
544
545       xfreerdp /u:USER /size:50%h /v:rdp.contoso.com
546           Connect to host rdp.contoso.com with user USER and a size of 50
547           percent of the height. If width (w) is set instead of height (h)
548           like /size:50%w. 50 percent of the width is used.
549
550       xfreerdp /u:CONTOSO\\JohnDoe /p:Pwd123! /v:rdp.contoso.com
551           Connect to host rdp.contoso.com with user CONTOSO\\JohnDoe and
552           password Pwd123!
553
554       xfreerdp /u:JohnDoe /p:Pwd123! /w:1366 /h:768 /v:192.168.1.100:4489
555           Connect to host 192.168.1.100 on port 4489 with user JohnDoe,
556           password Pwd123!. The screen width is set to 1366 and the height to
557           768
558
559       xfreerdp /u:JohnDoe /p:Pwd123!
560       /vmconnect:C824F53E-95D2-46C6-9A18-23A5BB403532 /v:192.168.1.100
561           Establish a connection to host 192.168.1.100 with user JohnDoe,
562           password Pwd123!  and connect to Hyper-V console (use port 2179,
563           disable negotiation) with VMID C824F53E-95D2-46C6-9A18-23A5BB403532
564
565       +clipboard
566           Activate clipboard redirection
567
568       /drive:home,/home/user
569           Activate drive redirection of /home/user as home drive
570
571       /smartcard:<device>
572           Activate smartcard redirection for device device
573
574       /printer:<device>,<driver>
575           Activate printer redirection for printer device using driver driver
576
577       /serial:<device>
578           Activate serial port redirection for port device
579
580       /parallel:<device>
581           Activate parallel port redirection for port device
582
583       /sound:sys:alsa
584           Activate audio output redirection using device sys:alsa
585
586       /microphone:sys:alsa
587           Activate audio input redirection using device sys:alsa
588
589       /multimedia:sys:alsa
590           Activate multimedia redirection using device sys:alsa
591
592       /usb:id,dev:054c:0268
593           Activate USB device redirection for the device identified by
594           054c:0268
595

LINKS

597       http://www.freerdp.com/
598

AUTHOR

600       The FreeRDP Team
601
602
603
604
605freerdp                           2021-03-23                       XFREERDP(1)