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       -grab-mouse
234           Grab mouse (default:on)
235
236       /gt:[rpc|http[,no-websockets]|auto[,no-websockets]]
237           Gateway transport type
238
239       /gu:[[domain\]user|user[@domain]]
240           Gateway username
241
242       /gat:access token
243           Gateway Access Token
244
245       /h:height
246           Height (default:768)
247
248       -heartbeat
249           Support heartbeat PDUs (default:on)
250
251       /help, /?
252           Print help
253
254       +home-drive
255           Redirect user home as share (default:off)
256
257       /ipv6, /6
258           Prefer IPv6 AAA record over IPv4 A record
259
260       /kbd:0xid or name
261           Keyboard layout
262
263       /kbd-lang:0xid
264           Keyboard active language identifier
265
266       /kbd-fn-key:value
267           Function key value
268
269       /kbd-list
270           List keyboard layouts
271
272       /kbd-lang-list
273           List keyboard languages
274
275       /kbd-remap:List of key=value,... pairs to remap scancodes
276           Keyboard scancode remapping
277
278       /kbd-subtype:id
279           Keyboard subtype
280
281       /kbd-type:id
282           Keyboard type
283
284       /load-balance-info:info-string
285           Load balance info
286
287       /log-filters:tag:level[,tag:level[,...]]
288           Set logger filters, see wLog(7) for details
289
290       /log-level:[OFF|FATAL|ERROR|WARN|INFO|DEBUG|TRACE]
291           Set the default log level, see wLog(7) for details
292
293       /max-fast-path-size:size
294           Specify maximum fast-path update size
295
296       /max-loop-time:time
297           Specify maximum time in milliseconds spend treating packets
298
299       +menu-anims
300           menu animations (default:off)
301
302       /microphone[:[sys:sys,][dev:dev,][format:format,][rate:rate,][channel:channel]],
303       /mic[:[sys:sys,][dev:dev,][format:format,][rate:rate,][channel:channel]]
304           Audio input (microphone)
305
306       /monitor-list
307           List detected monitors
308
309       /monitors:id[,id[,...]]
310           Select monitors to use
311
312       -mouse-motion
313           Send mouse motion (default:on)
314
315       /multimon[:force]
316           Use multiple monitors
317
318       +multitouch
319           Redirect multitouch input (default:off)
320
321       +multitransport
322           Support multitransport protocol (default:off)
323
324       -nego
325           protocol security negotiation (default:on)
326
327       /network:[modem|broadband|broadband-low|broadband-high|wan|lan|auto]
328           Network connection type
329
330       /nsc, /nscodec
331           NSCodec support
332
333       +offscreen-cache
334           offscreen bitmap cache (default:off)
335
336       /orientation:[0|90|180|270]
337           Orientation of display in degrees
338
339       +old-license
340           Use the old license workflow (no CAL and hwId set to 0)
341           (default:off)
342
343       /p:password
344           Password
345
346       /parallel[:name[,path]]
347           Redirect parallel device
348
349       /parent-window:window-id
350           Parent window id
351
352       +password-is-pin
353           Use smart card authentication with password as smart card PIN
354           (default:off)
355
356       /pcb:blob
357           Preconnection Blob
358
359       /pcid:id
360           Preconnection Id
361
362       /pheight:height
363           Physical height of display (in millimeters)
364
365       /play-rfx:pcap-file
366           Replay rfx pcap file
367
368       /port:number
369           Server port
370
371       -suppress-output
372           suppress output when minimized (default:on)
373
374       +print-reconnect-cookie
375           Print base64 reconnect cookie after connecting (default:off)
376
377       /printer[:name[,driver]]
378           Redirect printer device
379
380       /proxy:[proto://][user:password@]host:port
381           Proxy settings: override env. var (see also environment variable
382           below). Protocol "socks5" should be given explicitly where "http"
383           is default.
384
385       /pth:password-hash, /pass-the-hash:password-hash
386           Pass the hash (restricted admin mode)
387
388       /pwidth:width
389           Physical width of display (in millimeters)
390
391       /rdp2tcp:executable path[:arg...]
392           TCP redirection
393
394       /reconnect-cookie:base64-cookie
395           Pass base64 reconnect cookie to the connection
396
397       /redirect-prefer:FQDN|IP|NETBIOS,[...]
398           Override the preferred redirection order
399
400       /relax-order-checks, /relax-order-checks
401           Do not check if a RDP order was announced during capability
402           exchange, only use when connecting to a buggy server
403
404       /restricted-admin, /restrictedAdmin
405           Restricted admin mode
406
407       /rfx
408           RemoteFX
409
410       /rfx-mode:[image|video]
411           RemoteFX mode
412
413       /scale:[100|140|180]
414           Scaling factor of the display (default:100)
415
416       /scale-desktop:percentage
417           Scaling factor for desktop applications (value between 100 and 500)
418           (default:100)
419
420       /scale-device:100|140|180
421           Scaling factor for app store applications (default:100)
422
423       /sec:[rdp|tls|nla|ext]
424           Force specific protocol security
425
426       +sec-ext
427           NLA extended protocol security (default:off)
428
429       -sec-nla
430           NLA protocol security (default:on)
431
432       -sec-rdp
433           RDP protocol security (default:on)
434
435       -sec-tls
436           TLS protocol security (default:on)
437
438       /serial[:name[,path[,driver[,permissive]]]],
439       /tty[:name[,path[,driver[,permissive]]]]
440           Redirect serial device
441
442       /shell:shell
443           Alternate shell
444
445       /shell-dir:dir
446           Shell working directory
447
448       /size:widthxheight or percent%[wh]
449           Screen size (default:1024x768)
450
451       /smart-sizing[:widthxheight]
452           Scale remote desktop to window size
453
454       /smartcard[:str[,str...]]
455           Redirect the smartcard devices containing any of the <str> in their
456           names.
457
458       /smartcard-logon
459           Activates Smartcard Logon authentication. (EXPERIMENTAL: NLA not
460           supported)
461
462       /sound[:[sys:sys,][dev:dev,][format:format,][rate:rate,][channel:channel,][latency:latency,][quality:quality]],
463       /audio[:[sys:sys,][dev:dev,][format:format,][rate:rate,][channel:channel,][latency:latency,][quality:quality]]
464           Audio output (sound)
465
466       /span
467           Span screen over multiple monitors
468
469       /spn-class:service-class
470           SPN authentication service class
471
472       /ssh-agent, /ssh-agent
473           SSH Agent forwarding channel
474
475       /t:title, /title:title
476           Window title
477
478       -themes
479           themes (default:on)
480
481       /timeout:time in ms, /timeout:time in ms
482           Advanced setting for high latency links: Adjust connection timeout,
483           use if you encounter timeout failures with your connection
484           (default:9000)
485
486       /tls-ciphers:[netmon|ma|ciphers]
487           Allowed TLS ciphers
488
489       /tls-seclevel:level
490           TLS security level - defaults to 1 (default:1)
491
492       +enforce-tlsv1_2
493           Force use of TLS1.2 for connection. Some servers have a buggy TLS
494           version negotiation and might fail without this (default:off)
495
496       -toggle-fullscreen
497           Alt+Ctrl+Enter to toggle fullscreen (default:on)
498
499       /tune:setting:value,setting:value
500           [experimental] directly manipulate freerdp settings, use with
501           extreme caution! (default:)
502
503       /tune-list
504           Print options allowed for /tune
505
506       /u:[[domain\]user|user[@domain]]
507           Username
508
509       +unmap-buttons
510           Let server see real physical pointer button (default:off)
511
512       /v:server[:port]
513           Server hostname
514
515       /vc:channel[,options]
516           Static virtual channel
517
518       /version
519           Print version
520
521       /video
522           Video optimized remoting channel
523
524       /vmconnect[:vmid]
525           Hyper-V console (use port 2179, disable negotiation)
526
527       /w:width
528           Width (default:1024)
529
530       -wallpaper
531           wallpaper (default:on)
532
533       +window-drag
534           full window drag (default:off)
535
536       /window-position:xposxypos
537           window position
538
539       /wm-class:class-name
540           Set the WM_CLASS hint for the window instance
541
542       /workarea
543           Use available work area
544

ENVIRONMENT VARIABLES

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

EXAMPLES

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

LINKS

609       http://www.freerdp.com/
610

AUTHOR

612       The FreeRDP Team
613
614
615
616
617freerdp                           2023-10-25                       XFREERDP(1)