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

ENVIRONMENT VARIABLES

487       wlog environment variable
488           xfreerdp uses wLog as its log facility, you can refer to the
489           corresponding man page (wlog(7)) for more informations. Arguments
490           passed via the /log-level or /log-filters have precedence over the
491           environment variables.
492

EXAMPLES

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

LINKS

550       http://www.freerdp.com/
551

AUTHOR

553       The FreeRDP Team
554
555
556
557
558freerdp                           2019-05-13                       XFREERDP(1)