MAN page from openSUSE Leap 42 freerdp-2.0.0~rc1-86.1.x86_64.rpm


Section: xfreerdp (1)
Updated: 2018-01-11


xfreerdp - FreeRDP X11 client 


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


xfreerdpis 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). 


/a:addin[,options], /addin:addin[,options]



Action script (default:~/.config/freerdp/

/admin, /console

Admin (or console) session


Enable desktop composition (default:off)

/app:path or ||alias

Remote application program


Remote application command-line parameters


File to open with remote application


Remote application GUID


Remote application icon for user interface


Remote application name for user interface


Remote assistance password


Asynchronous channels (experimental) (default:off)


Asynchronous input (default:off)


Asynchronous transport (experimental) (default:off)


Asynchronous update (default:off)


Audio output mode


Authenticate only (default:off)


Authentication (expermiental) (default:on)


Automatic reconnection (default:off)


Automatic reconnection maximum retries, 0 for unlimited [0,1000]


Enable bitmap cache (default:on)


Session bpp (color depth) (default:16)


Print the build configuration


Ignore certificate


Certificate name


Automatically accept certificate on first connect


Client Hostname to send to server


Redirect clipboard (default:on)


Bitmap codec cache

-compression, -z

Enable compression (default:on)


Compression level (0,1,2)


Disable credentials delegation (default:off)




Window decorations (default:on)


Display control


Redirect directory <path< as named share <name<


Redirect all mount points as shares (default:off)


Dynamic virtual channel

/echo, /echo

Echo channel


Encryption (experimental) (default:on)


RDP standard security encryption methods


Fullscreen mode (<Ctrl<+<Alt<+<Enter< toggles fullscreen)


Enable fast-path input/output (default:on)


Enable FIPS mode (default:off)


Enable smooth fonts (ClearType) (default:off)


Number of frame acknowledgement


Read credentials from stdin. With <force< the prompt is done before connection, otherwise on server request.


Gateway Hostname

/gateway-usage-method:direct|detect, /gum:direct|detect

Gateway usage method


Gateway domain


GDI rendering


Consume multitouch input locally (default:off)


RDP8 graphics pipeline (experimental)


RDP8 graphics pipeline using progressive codec (default:off)


RDP8 graphics pipeline using small cache mode (default:off)


RDP8 graphics pipeline using thin client mode (default:off)


Glyph cache (experimental) (default:off)


Gateway password


Grab keyboard (default:on)


Gateway transport type

/gu:[domain\]user or user[@domain]

Gateway username


Height (default:768)


Support heartbeat PDUs (default:off)

/help, /?

Print help


Redirect user home as share (default:off)

/ipv6, /6

Prefer IPv6 AAA record over IPv4 A record


Enable JPEG codec


JPEG quality

/kbd:0xid or name

Keyboard layout


Function key value


List keyboard layouts


Keyboard subtype


Keyboard type


Load balance info


Set logger filters, see wLog(7) for details


Set the default log level, see wLog(7) for details


Specify maximum fast-path update size


Specify maximum time in milliseconds spend treating packets


Enable menu animations (default:off)

/microphone[:[sys:sys,][dev:dev,][format:format,][rate:rate,][channel:channel]], /mic[:[sys:sys,][dev:dev,][format:format,][rate:rate,][channel:channel]]

Audio input (microphone)


List detected monitors


Select monitors to use


Send mouse motion (default:on)

/multimedia[:[sys:sys,][dev:dev,][decoder:decoder]], /mmr[:[sys:sys,][dev:dev,][decoder:decoder]]

Redirect multimedia (video)


Use multiple monitors


Redirect multitouch input (default:off)


Support multitransport protocol (default:off)


Enable protocol security negotiation (default:on)


Network connection type

/nsc, /nscodec

Enable NSCodec


Enable offscreen bitmap cache (default:on)


Orientation of display in degrees




Redirect parallel device


Parent window id


Use smart card authentication with password as smart card PIN (default:off)


Preconnection Blob


Preconnection Id


Physical height of display (in millimeters)


Replay rfx pcap file


Server port


Print base64 reconnect cookie after connecting (default:off)


Redirect printer device


Proxy (see also environment variable below)

/pth:password-hash, /pass-the-hash:password-hash

Pass the hash (restricted admin mode)


Physical width of display (in millimeters)


Pass base64 reconnect cookie to the connection

/restricted-admin, /restrictedAdmin

Restricted admin mode




RemoteFX mode


Scaling factor of the display (default:100)


Scaling factor for desktop applications (value between 100 and 500) (default:100)


Scaling factor for app store applications (default:100)


Force specific protocol security


NLA extended protocol security (default:off)


NLA protocol security (default:on)


RDP protocol security (default:on)


TLS protocol security (default:on)

/serial[:name[,path[,driver[,permissive]]]], /tty[:name[,path[,driver[,permissive]]]]

Redirect serial device


Alternate shell


Shell working directory

/size:widthxheight or percent%[wh]

Screen size (default:1024x768)


Scale remote desktop to window size


Redirect smartcard device

/sound[:[sys:sys,][dev:dev,][format:format,][rate:rate,][channel:channel,][latency:latency,][quality:quality]], /audio[:[sys:sys,][dev:dev,][format:format,][rate:rate,][channel:channel,][latency:latency,][quality:quality]]

Audio output (sound)


Span screen over multiple monitors


SPN authentication service class

/ssh-agent, /ssh-agent

SSH Agent forwarding channel

/t:title, /title:title

Window title


Enable themes (default:on)


Allowed TLS ciphers


Alt+Ctrl+Enter toggles fullscreen (default:on)

/u:[domain\]user or user[@domain]



Let server see real physical pointer button (default:off)


Redirect USB device


Server hostname


Static virtual channel


Print version


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


Width (default:1024)


Enable wallpaper (default:on)


Enable full window drag (default:off)


Set the WM_CLASS hint for the window instance


Use available work area


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-levelor/log-filtershave precedence over the environment variables.


xfreerdp connection.rdp /p:Pwd123! /f

Connect in fullscreen mode using a stored configurationconnection.rdpand the passwordPwd123!

xfreerdp /u:USER /size:50%h /

Connect to hostrdp.contoso.comwith userUSERand a size of50 percent of the height. If width (w) is set instead of height (h) like /size:50%w. 50 percent of the width is used.

xfreerdp /u:CONTOSO\\JohnDoe /p:Pwd123! /

Connect to hostrdp.contoso.comwith userCONTOSO\\JohnDoeand passwordPwd123!

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

Connect to host192.168.1.100on port4489with userJohnDoe, passwordPwd123!. The screen width is set to1366and the height to768

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

Establish a connection to host192.168.1.100with userJohnDoe, passwordPwd123!and connect to Hyper-V console (use port 2179, disable negotiation) with VMIDC824F53E-95D2-46C6-9A18-23A5BB403532


Activate clipboard redirection


Activate drive redirection of/home/useras home drive


Activate smartcard redirection for devicedevice


Activate printer redirection for printerdeviceusing driverdriver


Activate serial port redirection for portdevice


Activate parallel port redirection for portdevice


Activate audio output redirection using devicesys:alsa


Activate audio input redirection using devicesys:alsa


Activate multimedia redirection using devicesys:alsa


Activate USB device redirection for the device identified by054c:0268




The FreeRDP Team




This document was created byman2html,using the manual pages.