XFREERDP(1)

NAME
xfreerdp - FreeRDP X11 client

SYNOPSIS

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

DESCRIPTION

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

OPTIONS

/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

/f
    Fullscreen mode

/bpp <depth>
    <depth> - Session bpp (color depth)

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

/kbd-list
    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
    Admin (or console) session

/restricted-admin
    Restricted admin mode

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

/client-hostname <name>
    <name> - Client Hostname to send to server

/multimon
    Use multiple monitors

/span
    Span screen over multiple monitors

/workarea
    Use available work area

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

/monitor-list
    List detected monitors

/t <title>
    <title> - Window title

/decorations
    Window decorations

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

/a
    Addin

/vc
    Static virtual channel

/dvc
    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

/compression
    Enable compression

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

/shell
    Alternate shell

/shell-dir
    Shell working directory

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

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

/audio-mode
    Audio output mode

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

/network
    Network connection type

/drive
    Redirect drive

/drives
    Redirect all drives

/home-drive
    Redirect home drive

/clipboard
    Redirect clipboard

/serial
    Redirect serial device

/parallel
    Redirect parallel device

/smartcard
    Redirect smartcard device

/printer
    Redirect printer device

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

/multitouch
    Redirect multitouch input

/gestures
    Consume multitouch input locally

/unmap-buttons
    Let server see real physical pointer button

/echo
    Echo channel

/disp
    Display control

/fonts
    Enable smooth fonts (ClearType)

/aero
    Enable desktop composition

/window-drag
    Enable full window drag

/menu-anims
    Enable menu animations

/themes
    Enable themes

/wallpaper
    Enable wallpaper

/gdi <sw|hw>
    <sw|hw> - GDI rendering

/gfx
    <RFX|AVC420|AVC444> - RDP8 graphics pipeline (experimental)

/gfx-thin-client
    RDP8 graphics pipeline using thin client mode

/gfx-small-cache
    RDP8 graphics pipeline using small cache mode

/gfx-progressive
    RDP8 graphics pipeline using progressive codec

/gfx-h264
    <AVC420|AVC444> - RDP8.1 graphics pipeline using H264 codec

/rfx
    RemoteFX

/rfx-mode <image|video>
    <image|video> - RemoteFX mode

/frame-ack <number>
    <number> - Number of frame acknowledgement

/nsc
    Enable NSCodec

/jpeg
    Enable JPEG codec

/jpeg-quality <percentage>
    <percentage> - JPEG quality

/nego
    Enable protocol security negotiation

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

/sec-rdp
    rdp protocol security

/sec-tls
    tls protocol security

/sec-nla
    nla protocol security

/sec-ext
    nla extended protocol security

/tls-ciphers <netmon|ma|ciphers>
    <netmon|ma|ciphers> - Allowed TLS ciphers

/cert-name <name>
    <name> - certificate name

/cert-ignore
    ignore certificate

/cert-tofu
    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

/credentials-delegation
    Disable credentials delegation

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

/authentication
    authentication (hack!)

/encryption
    encryption (hack!)

/grab-keyboard
    grab keyboard

/toggle-fullscreen
    Alt+Ctrl+Enter toggles fullscreen

/mouse-motion
    mouse-motion

/parent-window <window id>
    <window id> - Parent window id

/bitmap-cache
    Enable bitmap cache

/offscreen-cache
    Enable offscreen bitmap cache

/glyph-cache
    Glyph cache (EXPERIMENTAL)

/codec-cache <rfx|nsc|jpeg>
    <rfx|nsc|jpeg> - bitmap codec cache

/fast-path
    Enable fast-path input/output

/max-fast-path-size
    <size> - specify maximum fast-path update size

/max-loop-time <time>
    <time> - specify maximum time in milliseconds spend treating packets

/async-input
    asynchronous input

/async-update
    asynchronous update

/async-transport
    asynchronous transport (unstable)

/async-channels
    asynchronous channels (unstable)

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

/version
    print version

/help
    print help

/play-rfx <pcap file>
    <pcap file> - Replay rfx pcap file

/auth-only
    Authenticate only.

/auto-reconnect
    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-reconnect-cookie
    Print base64 reconnect cookie after connecting

/heartbeat
    Support heartbeat PDUs

/multitransport
    Support multitransport protocol

/assistance <password>
    <password> - Remote assistance password

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

/from-stdin
    Read credentials from stdin, do not use defaults.

/buildconfig
    print the build configuration

/log-level [OFF|FATAL|ERROR|WARN|INFO|DEBUG|TRACE]
    [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.

EXAMPLES

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:192.168.1.100:4489
    Connect to host 192.168.1.100 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:192.168.1.100
    Establish a connection to host 192.168.1.100 with user JohnDoe, password Pwd123! and connect to Hyper-V console (use port 2179, disable negotiation) with VMID C824F53E-95D2-46C6-9A18-23A5BB403532

+clipboard
    Activate clipboard redirection

/drive:home,/home/user
    Activate drive redirection of /home/user as home drive

/smartcard:<device>
    Activate smartcard redirection for device device

/printer:<device>,<driver>
    Activate printer redirection for printer device using driver driver

/serial:<device>
    Activate serial port redirection for port device

/parallel:<device>
    Activate parallel port redirection for port device

/sound:sys:alsa
    Activate audio output redirection using device sys:alsa

/microphone:sys:alsa
    Activate audio input redirection using device sys:alsa

/multimedia:sys:alsa
    Activate multimedia redirection using device sys:alsa

/usb:id,dev:054c:0268
    Activate USB device redirection for the device identified by 054c:0268

LINKS

http://www.freerdp.com/

AUTHOR

The FreeRDP Team