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

ENVIRONMENT VARIABLES

543       wlog environment variable
544           xfreerdp uses wLog as its log facility, you can refer to the
545           corresponding man page (wlog(7)) for more informations. Arguments
546           passed via the /log-level or /log-filters have precedence over the
547           environment variables.
548

EXAMPLES

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

LINKS

606       http://www.freerdp.com/
607

AUTHOR

609       The FreeRDP Team
610
611
612
613
614freerdp                           2022-11-30                       XFREERDP(1)