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

ENVIRONMENT VARIABLES

497       wlog environment variable
498           xfreerdp uses wLog as its log facility, you can refer to the
499           corresponding man page (wlog(7)) for more informations. Arguments
500           passed via the /log-level or /log-filters have precedence over the
501           environment variables.
502

EXAMPLES

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

LINKS

560       http://www.freerdp.com/
561

AUTHOR

563       The FreeRDP Team
564
565
566
567
568freerdp                           2019-05-18                       XFREERDP(1)