xfreerdp man page

xfreerdp ā€” FreeRDP X11 client


xfreerdp [file] [options] [/v:server[:port]]


xfreerdp is an X11 Remote Desktop Protocol (RDP) client which is part of the FreeRDP project. An RDP server is built-in to many editions of Windows. Alternative servers included xrdp and VRDP (VirtualBox).


/v <server>[:port]

<server>[:port] - Server hostname

/port <number>

<number> - Server port

/w <width>

<width> - Width

/h <height>

<height> - Height

/size <width>x<height> or <percent>%

<width>x<height> or <percent>% - Screen size


Fullscreen mode

/bpp <depth>

<depth> - Session bpp (color depth)

/kbd 0x<layout id> or <layout name>

0x<layout id> or <layout name> - Keyboard layout


List keyboard layouts

/kbd-type <type id>

<type id> - Keyboard type

/kbd-subtype <subtype id>

<subtype id> - Keyboard subtype

/kbd-fn-key <function key count>

<function key count> - Keyboard function key count


Admin (or console) session


Restricted admin mode

/pth <password hash>

<password hash> - Pass the hash (restricted admin mode)

/client-hostname <name>

<name> - Client Hostname to send to server


Use multiple monitors


Span screen over multiple monitors


Use available work area

/monitors <0,1,2...>

<0,1,2...> - Select monitors to use


List detected monitors

/t <title>

<title> - Window title


Window decorations


<width>x<height> - Scale remote desktop to window size




Static virtual channel


Dynamic virtual channel

/u [<domain>\]<user> or <user>[@<domain>]

[<domain>\]<user> or <user>[@<domain>] - Username

/p <password>

<password> - Password

/d <domain>

<domain> - Domain

/g <gateway>[:port]

<gateway>[:port] - Gateway Hostname

/gu [<domain>\]<user> or <user>[@<domain>]

[<domain>\]<user> or <user>[@<domain>] - Gateway username

/gp <password>

<password> - Gateway password

/gd <domain>

<domain> - Gateway domain

/gt <rpc|http|auto>

<rpc|http|auto> - Gateway transport type

/gateway-usage-method <direct|detect>

<direct|detect> - Gateway usage method

/proxy [<protocol>://]<host>:<port>

[<protocol>://]<host>:<port> - Proxy (see also environment variable below)

/load-balance-info <info string>

<info string> - Load balance info

/app <executable path> or <||alias>

<executable path> or <||alias> - Remote application program

/app-name <app name>

<app name> - Remote application name for user interface

/app-icon <icon path>

<icon path> - Remote application icon for user interface

/app-cmd <parameters>

<parameters> - Remote application command-line parameters

/app-file <file name>

<file name> - File to open with remote application

/app-guid <app guid>

<app guid> - Remote application GUID


Enable compression

/compression-level <level>

<level> - Compression level (0,1,2)


Alternate shell


Shell working directory


[sys][dev][format][rate][channel][latency][quality] - Audio output (sound)


[sys][dev][format][rate][channel] - Audio input (microphone)


Audio output mode


[sys][dev][decoder] - Redirect multimedia (video)


Network connection type


Redirect drive


Redirect all drives


Redirect home drive


Redirect clipboard


Redirect serial device


Redirect parallel device


Redirect smartcard device


Redirect printer device

/usb [dbg][dev][id|addr][auto]

[dbg][dev][id|addr][auto] - Redirect USB device


Redirect multitouch input


Consume multitouch input locally


Let server see real physical pointer button


Echo channel


Display control


Enable smooth fonts (ClearType)


Enable desktop composition


Enable full window drag


Enable menu animations


Enable themes


Enable wallpaper

/gdi <sw|hw>

<sw|hw> - GDI rendering


<RFX> - RDP8 graphics pipeline (experimental)


RDP8 graphics pipeline using thin client mode


RDP8 graphics pipeline using small cache mode


RDP8 graphics pipeline using progressive codec



/rfx-mode <image|video>

<image|video> - RemoteFX mode

/frame-ack <number>

<number> - Number of frame acknowledgement


Enable NSCodec


Enable JPEG codec

/jpeg-quality <percentage>

<percentage> - JPEG quality


Enable protocol security negotiation

/sec <rdp|tls|nla|ext>

<rdp|tls|nla|ext> - force specific protocol security


rdp protocol security


tls protocol security


nla protocol security


nla extended protocol security

/tls-ciphers <netmon|ma|ciphers>

<netmon|ma|ciphers> - Allowed TLS ciphers

/cert-name <name>

<name> - certificate name


ignore certificate


Automatically accept certificate on first connect

/pcb <blob>

<blob> - Preconnection Blob

/pcid <id>

<id> - Preconnection Id

/spn-class <service class>

<service class> - SPN authentication service class


Disable credentials delegation


<vmid> - Hyper-V console (use port 2179, disable negotiation)


authentication (hack!)


encryption (hack!)


grab keyboard


Alt+Ctrl+Enter toggles fullscreen



/parent-window <window id>

<window id> - Parent window id


Enable bitmap cache


Enable offscreen bitmap cache


Glyph cache (EXPERIMENTAL)

/codec-cache <rfx|nsc|jpeg>

<rfx|nsc|jpeg> - bitmap codec cache


Enable fast-path input/output


<size> - specify maximum fast-path update size

/max-loop-time <time>

<time> - specify maximum time in milliseconds spend treating packets


asynchronous input


asynchronous update


asynchronous transport (unstable)


asynchronous channels (unstable)

/wm-class <class name>

<class name> - set the WM_CLASS hint for the window instance


print version


print help

/play-rfx <pcap file>

<pcap file> - Replay rfx pcap file


Authenticate only.


Automatic reconnection

/auto-reconnect-max-retries <retries>

<retries> - Automatic reconnection maximum retries, 0 for unlimited [0,1000]

/reconnect-cookie <base64 cookie>

<base64 cookie> - Pass base64 reconnect cookie to the connection


Print base64 reconnect cookie after connecting


Support heartbeat PDUs


Support multitransport protocol

/assistance <password>

<password> - Remote assistance password

/encryption-methods <40,56,128,FIPS>

<40,56,128,FIPS> - RDP standard security encryption methods


Read credentials from stdin, do not use defaults.


print the build configuration


[OFF|FATAL|ERROR|WARN|INFO|DEBUG|TRACE] - Set the default log level, see wLog(7) for details

/log-filters <logger tag>:<log level>[, <logger tag>:<log level>][, ...]]

<logger tag>:<log level>[, <logger tag>:<log level>][, ...]] - Set logger filters, see wLog(7) for details

/pwidth <physical width (mm)>

<physical width (mm)> - Physical width of display (in millimeters)

/pheight <physical height (mm)>

<physical height (mm)> - Physical height of display (in millimeters)

/orientation <orientation>

<orientation> - Orientation of display in degrees (0, 90, 180, 270)

/scale <scale amount (%%)>

<scale amount (%%)> - Scaling factor of the display (value of 100, 140, or 180)

/scale-desktop <scale amount (%%)>

<scale amount (%%)> - Scaling factor for desktop applications (value between 100 and 500)

/scale-device <scale amount (%%)>

<scale amount (%%)> - Scaling factor for app store applications (100, 140, or 180)

/action-script <file name>

<file name> - Action script

Environment Variables

wlog environment variable

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


xfreerdp connection.rdp /p:Pwd123! /f

Connect in fullscreen mode using a stored configuration connection.rdp and the password Pwd123!

xfreerdp /u:CONTOSO\\JohnDoe /p:Pwd123! /v:rdp.contoso.com

Connect to host rdp.contoso.com with user CONTOSO\\JohnDoe and password Pwd123!

xfreerdp /u:JohnDoe /p:Pwd123! /w:1366 /h:768 /v:

Connect to host on port 4489 with user JohnDoe, password Pwd123!. The screen width is set to 1366 and the height to 768

xfreerdp /u:JohnDoe /p:Pwd123! /vmconnect:C824F53E-95D2-46C6-9A18-23A5BB403532 /v:

Establish a connection to host with user JohnDoe, password Pwd123! and connect to Hyper-V console (use port 2179, disable negotiation) with VMID C824F53E-95D2-46C6-9A18-23A5BB403532


Activate clipboard redirection


Activate drive redirection of /home/user as home drive


Activate smartcard redirection for device device


Activate printer redirection for printer device using driver driver


Activate serial port redirection for port device


Activate parallel port redirection for port device


Activate audio output redirection using device sys:alsa


Activate audio input redirection using device sys:alsa


Activate multimedia redirection using device sys:alsa


Activate USB device redirection for the device identified by 054c:0268


The FreeRDP Team

Referenced By


2017-09-11 xfreerdp