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

ENVIRONMENT VARIABLES

503       wlog environment variable
504           xfreerdp uses wLog as its log facility, you can refer to the
505           corresponding man page (wlog(7)) for more informations. Arguments
506           passed via the /log-level or /log-filters have precedence over the
507           environment variables.
508

EXAMPLES

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

LINKS

566       http://www.freerdp.com/
567

AUTHOR

569       The FreeRDP Team
570
571
572
573
574freerdp                           2019-08-20                       XFREERDP(1)