'\" t
.\"     Title: sdl-freerdp3
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 2024-04-24
.\"    Manual: sdl-freerdp3
.\"    Source: freerdp
.\"  Language: English
.\"
.TH "SDL\-FREERDP3" "1" "2024\-04\-24" "freerdp" "sdl\-freerdp3"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
sdl-freerdp3 \- FreeRDP SDL client
.SH "SYNOPSIS"
.PP
\fBsdl\-freerdp3\fR
[file] [options] [/v:server[:port]]
.SH "DESCRIPTION"
.PP
\fBsdl\-freerdp3\fR
is an SDL 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 ogon, gnome\-remote\-desktop, xrdp and VRDP (VirtualBox)\&.
.SH "OPTIONS"
.PP
\fB/a\fR:\fIaddin\fR[,\fIoptions\fR], \fB/addin\fR:\fIaddin\fR[,\fIoptions\fR]
.RS 4
Addin
.RE
.PP
\fB/action\-script\fR:\fIfile\-name\fR
.RS 4
Action script (default:~/\&.config/freerdp/action\&.sh)
.RE
.PP
\fB/admin\fR, \fB/console\fR
.RS 4
Admin (or console) session
.RE
.PP
\fB+aero\fR
.RS 4
desktop composition (default:off)
.RE
.PP
\fB/app\fR:program:[\fIpath\fR|\fI||alias\fR],cmd:\fIcommand\fR,file:\fIfilename\fR,guid:\fIguid\fR,icon:\fIfilename\fR,name:\fIname\fR,workdir:\fIdirectory\fR,hidef:[on|off]
.RS 4
Remote application program
.RE
.PP
\fB/assistance\fR:\fIpassword\fR
.RS 4
Remote assistance password
.RE
.PP
\fB/auto\-request\-control\fR:
.RS 4
Automatically request remote assistance input control
.RE
.PP
\fB+async\-channels\fR
.RS 4
Asynchronous channels (experimental) (default:off)
.RE
.PP
\fB+async\-update\fR
.RS 4
Asynchronous update (default:off)
.RE
.PP
\fB/audio\-mode\fR:\fImode\fR
.RS 4
Audio output mode
.RE
.PP
\fB+auth\-only\fR
.RS 4
Authenticate only (default:off)
.RE
.PP
\fB/auth\-pkg\-list\fR:\fI!ntlm,kerberos\fR
.RS 4
Authentication package filter (comma\-separated list, use \*(Aq!\*(Aq to exclude)
.RE
.PP
\fB\-authentication\fR
.RS 4
Authentication (experimental) (default:on)
.RE
.PP
\fB+auto\-reconnect\fR
.RS 4
Automatic reconnection (default:off)
.RE
.PP
\fB/auto\-reconnect\-max\-retries\fR:\fIretries\fR
.RS 4
Automatic reconnection maximum retries, 0 for unlimited [0,1000]
.RE
.PP
\fB/bpp\fR:\fIdepth\fR
.RS 4
Session bpp (color depth) (default:16)
.RE
.PP
\fB/buildconfig\fR
.RS 4
Print the build configuration
.RE
.PP
\fB/cache\fR:[bitmap[:on|off],codec[:rfx|nsc],glyph[:on|off],offscreen[:on|off],persist,persist\-file:\fIfilename\fR]
.RS 4
.RE
.PP
\fB/cert\fR:[deny,ignore,name:\fIname\fR,tofu,fingerprint:\fIhash\fR:\fIhash as hex\fR[,fingerprint:\fIhash\fR:\fIanother hash\fR]]
.RS 4
Certificate accept options\&. Use with care!
.br

* deny \&.\&.\&. Automatically abort connection if the certificate does not match, no user interaction\&.
.br

* ignore \&.\&.\&. Ignore the certificate checks altogether (overrules all other options)
.br

* name \&.\&.\&. Use the alternate <name> instead of the certificate subject to match locally stored certificates
.br

* tofu \&.\&.\&. Accept certificate unconditionally on first connect and deny on subsequent connections if the certificate does not match
.br

* fingerprints \&.\&.\&. A list of certificate hashes that are accepted unconditionally for a connection
.RE
.PP
\fB/client\-build\-number\fR:\fInumber\fR
.RS 4
Client Build Number sent to server (influences smartcard behaviour, see [MS\-RDPESC])
.RE
.PP
\fB/client\-hostname\fR:\fIname\fR
.RS 4
Client Hostname to send to server
.RE
.PP
\fB/clipboard\fR:[[use\-selection:\fIatom\fR],[direction\-to:[all|local|remote|off]],[files\-to[:all|local|remote|off]]]
.RS 4
Redirect clipboard:
.br

* use\-selection:<atom> \&.\&.\&. (X11) Specify which X selection to access\&. Default is CLIPBOARD\&. PRIMARY is the X\-style middle\-click selection\&.
.br

* direction\-to:[all|local|remote|off] control enabled clipboard direction
.br

* files\-to:[all|local|remote|off] control enabled file clipboard directiont (default:on)
.RE
.PP
\fB\-compression\fR, \fB\-z\fR
.RS 4
compression (default:on)
.RE
.PP
\fB/compression\-level\fR:\fIlevel\fR
.RS 4
Compression level (0,1,2)
.RE
.PP
\fB+credentials\-delegation\fR
.RS 4
credentials delegation (default:off)
.RE
.PP
\fB/d\fR:\fIdomain\fR
.RS 4
Domain
.RE
.PP
\fB\-decorations\fR
.RS 4
Window decorations (default:on)
.RE
.PP
\fB/disp\fR
.RS 4
Display control
.RE
.PP
\fB/drive\fR:\fIname\fR,\fIpath\fR
.RS 4
Redirect directory <path> as named share <name>\&. Hotplug support is enabled with /drive:hotplug,*\&. This argument provides the same function as "Drives that I plug in later" option in MSTSC\&.
.RE
.PP
\fB+drives\fR
.RS 4
Redirect all mount points as shares (default:off)
.RE
.PP
\fB/dump\fR:\fIrecord|replay\fR,\fIfile\fR
.RS 4
record or replay dump
.RE
.PP
\fB/dvc\fR:\fIchannel\fR[,\fIoptions\fR]
.RS 4
Dynamic virtual channel
.RE
.PP
\fB/dynamic\-resolution\fR
.RS 4
Send resolution updates when the window is resized
.RE
.PP
\fB/echo\fR, \fB/echo\fR
.RS 4
Echo channel
.RE
.PP
\fB\-encryption\fR
.RS 4
Encryption (experimental) (default:on)
.RE
.PP
\fB/encryption\-methods\fR:[40,][56,][128,][FIPS]
.RS 4
RDP standard security encryption methods
.RE
.PP
\fB/f\fR
.RS 4
Fullscreen mode (<Ctrl>+<Alt>+<Enter> toggles fullscreen)
.RE
.PP
\fB+fipsmode\fR
.RS 4
FIPS mode (default:off)
.RE
.PP
\fB/floatbar\fR[:sticky:[on|off],default:[visible|hidden],show:[always|fullscreen|window]]
.RS 4
floatbar is disabled by default (when enabled defaults to sticky in fullscreen mode)
.RE
.PP
\fB\-fonts\fR
.RS 4
smooth fonts (ClearType) (default:on)
.RE
.PP
\fB+force\-console\-callbacks\fR
.RS 4
Use default callbacks (console) for certificate/credential/\&.\&.\&. (default:off)
.RE
.PP
\fB/frame\-ack\fR:\fInumber\fR
.RS 4
Number of frame acknowledgement
.RE
.PP
\fB/args\-from\fR:\fIfile\fR|stdin|fd:\fInumber\fR|env:\fIname\fR
.RS 4
Read command line from a file, stdin or file descriptor\&. This argument can not be combined with any other\&. Provide one argument per line\&.
.RE
.PP
\fB/from\-stdin\fR[:force]
.RS 4
Read credentials from stdin\&. With <force> the prompt is done before connection, otherwise on server request\&.
.RE
.PP
\fB/gateway\fR:g:\fIgateway\fR[:\fIport\fR],u:\fIuser\fR,d:\fIdomain\fR,p:\fIpassword\fR,usage\-method:[direct|detect],access\-token:\fItoken\fR,type:[rpc|http[,no\-websockets][,extauth\-sspi\-ntlm]|auto[,no\-websockets][,extauth\-sspi\-ntlm]]|arm,url:\fIwss://url\fR,bearer:\fIoauth2\-bearer\-token\fR, \fB/gw\fR:g:\fIgateway\fR[:\fIport\fR],u:\fIuser\fR,d:\fIdomain\fR,p:\fIpassword\fR,usage\-method:[direct|detect],access\-token:\fItoken\fR,type:[rpc|http[,no\-websockets][,extauth\-sspi\-ntlm]|auto[,no\-websockets][,extauth\-sspi\-ntlm]]|arm,url:\fIwss://url\fR,bearer:\fIoauth2\-bearer\-token\fR
.RS 4
Gateway Hostname
.RE
.PP
\fB/gdi\fR:sw|hw
.RS 4
GDI rendering
.RE
.PP
\fB/geometry\fR
.RS 4
Geometry tracking channel
.RE
.PP
\fB+gestures\fR
.RS 4
Consume multitouch input locally (default:off)
.RE
.PP
\fB/gfx\fR[:[[progressive[:on|off]|RFX[:on|off]|AVC420[:on|off]AVC444[:on|off]],mask:\fIvalue\fR,small\-cache[:on|off],thin\-client[:on|off],progressive[:on|off]]]
.RS 4
RDP8 graphics pipeline
.RE
.PP
\fB\-grab\-keyboard\fR
.RS 4
Grab keyboard (default:on)
.RE
.PP
\fB\-grab\-mouse\fR
.RS 4
Grab mouse (default:on)
.RE
.PP
\fB/h\fR:\fIheight\fR
.RS 4
Height (default:768)
.RE
.PP
\fB\-heartbeat\fR
.RS 4
Support heartbeat PDUs (default:on)
.RE
.PP
\fB/help\fR, \fB/?\fR
.RS 4
Print help
.RE
.PP
\fB+home\-drive\fR
.RS 4
Redirect user home as share (default:off)
.RE
.PP
\fB/ipv6\fR, \fB/6\fR
.RS 4
Prefer IPv6 AAA record over IPv4 A record
.RE
.PP
\fB/jpeg\fR
.RS 4
JPEG codec support
.RE
.PP
\fB/jpeg\-quality\fR:\fIpercentage\fR
.RS 4
JPEG quality
.RE
.PP
\fB/kbd\fR:[layout:[0x\fIid\fR|\fIname\fR],lang:\fI0x\fR\fI\fIid\fR\fR,fn\-key:\fIvalue\fR,type:\fIvalue\fR,subtype:\fIvalue\fR,unicode[:on|off],remap:\fIkey1\fR=\fIvalue1\fR,remap:\fIkey2\fR=\fIvalue2\fR,pipe:\fIfilename\fR]
.RS 4
Keyboard related options:
.br

* layout: set the keybouard layout announced to the server
.br

* lang: set the keyboard language identifier sent to the server
.br

* fn\-key: Function key value
.br

* pipe: Name of a named pipe that can be used to type text into the RDP session
.br

.RE
.PP
\fB/kerberos\fR:[kdc\-url:\fIurl\fR,lifetime:\fItime\fR,start\-time:\fItime\fR,renewable\-lifetime:\fItime\fR,cache:\fIpath\fR,armor:\fIpath\fR,pkinit\-anchors:\fIpath\fR,pkcs11\-module:\fIname\fR]
.RS 4
Kerberos options
.RE
.PP
\fB/load\-balance\-info\fR:\fIinfo\-string\fR
.RS 4
Load balance info
.RE
.PP
\fB/list\fR:[kbd|kbd\-scancode|kbd\-lang[:\fIvalue\fR]|smartcard[:[pkinit\-anchors:\fIpath\fR][,pkcs11\-module:\fIname\fR]]|monitor|tune]
.RS 4
List available options for subcommand (default:List available options for subcommand)
.RE
.PP
\fB/log\-filters\fR:\fItag\fR:\fIlevel\fR[,\fItag\fR:\fIlevel\fR[,\&.\&.\&.]]
.RS 4
Set logger filters, see wLog(7) for details
.RE
.PP
\fB/log\-level\fR:[OFF|FATAL|ERROR|WARN|INFO|DEBUG|TRACE]
.RS 4
Set the default log level, see wLog(7) for details
.RE
.PP
\fB/max\-fast\-path\-size\fR:\fIsize\fR
.RS 4
Specify maximum fast\-path update size
.RE
.PP
\fB/max\-loop\-time\fR:\fItime\fR
.RS 4
Specify maximum time in milliseconds spend treating packets
.RE
.PP
\fB+menu\-anims\fR
.RS 4
menu animations (default:off)
.RE
.PP
\fB/microphone\fR[:[sys:\fIsys\fR,][dev:\fIdev\fR,][format:\fIformat\fR,][rate:\fIrate\fR,][channel:\fIchannel\fR]], \fB/mic\fR[:[sys:\fIsys\fR,][dev:\fIdev\fR,][format:\fIformat\fR,][rate:\fIrate\fR,][channel:\fIchannel\fR]]
.RS 4
Audio input (microphone)
.RE
.PP
\fB/monitors\fR:\fIid\fR[,\fIid\fR[,\&.\&.\&.]]
.RS 4
Select monitors to use
.RE
.PP
\fB\-mouse\-motion\fR
.RS 4
Send mouse motion (default:on)
.RE
.PP
\fB+mouse\-relative\fR
.RS 4
Send mouse motion with relative addressing (default:off)
.RE
.PP
\fB/mouse\fR:[relative:[on|off],grab:[on|off]]
.RS 4
Mouse related options:
.br

* relative: send relative mouse movements if supported by server
.br

* grab: grab the mouse if within the window
.RE
.PP
\fB/multimon\fR[:force]
.RS 4
Use multiple monitors
.RE
.PP
\fB+multitouch\fR
.RS 4
Redirect multitouch input (default:off)
.RE
.PP
\fB\-multitransport\fR
.RS 4
Support multitransport protocol (default:on)
.RE
.PP
\fB\-nego\fR
.RS 4
protocol security negotiation (default:on)
.RE
.PP
\fB/network\fR:[modem|broadband|broadband\-low|broadband\-high|wan|lan|auto]
.RS 4
Network connection type
.RE
.PP
\fB/nsc\fR, \fB/nscodec\fR
.RS 4
NSCodec support
.RE
.PP
\fB/orientation\fR:[0|90|180|270]
.RS 4
Orientation of display in degrees
.RE
.PP
\fB+old\-license\fR
.RS 4
Use the old license workflow (no CAL and hwId set to 0) (default:off)
.RE
.PP
\fB/p\fR:\fIpassword\fR
.RS 4
Password
.RE
.PP
\fB/parallel\fR[:\fIname\fR[,\fIpath\fR]]
.RS 4
Redirect parallel device
.RE
.PP
\fB/parent\-window\fR:\fIwindow\-id\fR
.RS 4
Parent window id
.RE
.PP
\fB/pcb\fR:\fIblob\fR
.RS 4
Preconnection Blob
.RE
.PP
\fB/pcid\fR:\fIid\fR
.RS 4
Preconnection Id
.RE
.PP
\fB/pheight\fR:\fIheight\fR
.RS 4
Physical height of display (in millimeters)
.RE
.PP
\fB/play\-rfx\fR:\fIpcap\-file\fR
.RS 4
Replay rfx pcap file
.RE
.PP
\fB/port\fR:\fInumber\fR
.RS 4
Server port
.RE
.PP
\fB\-suppress\-output\fR
.RS 4
suppress output when minimized (default:on)
.RE
.PP
\fB+print\-reconnect\-cookie\fR
.RS 4
Print base64 reconnect cookie after connecting (default:off)
.RE
.PP
\fB/printer\fR[:\fIname\fR[,\fIdriver\fR]]
.RS 4
Redirect printer device
.RE
.PP
\fB/proxy\fR:[\fIproto\fR://][\fIuser\fR:\fIpassword\fR@]\fIhost\fR[:\fIport\fR]
.RS 4
Proxy settings: override env\&. var (see also environment variable below)\&. Protocol "socks5" should be given explicitly where "http" is default\&.
.RE
.PP
\fB/pth\fR:\fIpassword\-hash\fR, \fB/pass\-the\-hash\fR:\fIpassword\-hash\fR
.RS 4
Pass the hash (restricted admin mode)
.RE
.PP
\fB/pwidth\fR:\fIwidth\fR
.RS 4
Physical width of display (in millimeters)
.RE
.PP
\fB/rdp2tcp\fR:\fIexecutable path[:arg\&.\&.\&.]\fR
.RS 4
TCP redirection
.RE
.PP
\fB/reconnect\-cookie\fR:\fIbase64\-cookie\fR
.RS 4
Pass base64 reconnect cookie to the connection
.RE
.PP
\fB/redirect\-prefer\fR:\fIFQDN|IP|NETBIOS\fR,[\&.\&.\&.]
.RS 4
Override the preferred redirection order
.RE
.PP
\fB/relax\-order\-checks\fR, \fB/relax\-order\-checks\fR
.RS 4
Do not check if a RDP order was announced during capability exchange, only use when connecting to a buggy server
.RE
.PP
\fB/restricted\-admin\fR, \fB/restrictedAdmin\fR
.RS 4
Restricted admin mode
.RE
.PP
\fB/rfx\fR
.RS 4
RemoteFX
.RE
.PP
\fB/rfx\-mode\fR:[image|video]
.RS 4
RemoteFX mode
.RE
.PP
\fB/scale\fR:[100|140|180]
.RS 4
Scaling factor of the display (default:100)
.RE
.PP
\fB/scale\-desktop\fR:\fIpercentage\fR
.RS 4
Scaling factor for desktop applications (value between 100 and 500) (default:100)
.RE
.PP
\fB/scale\-device\fR:100|140|180
.RS 4
Scaling factor for app store applications (default:100)
.RE
.PP
\fB/sec\fR:[rdp[:[on|off]]|tls[:[on|off]]|nla[:[on|off]]|ext[:[on|off]]|aad[:[on|off]]]
.RS 4
Force specific protocol security\&. e\&.g\&. /sec:nla enables NLA and disables all others, while /sec:nla:[on|off] just toggles NLA
.RE
.PP
\fB/serial\fR[:\fIname\fR[,\fIpath\fR[,\fIdriver\fR[,permissive]]]], \fB/tty\fR[:\fIname\fR[,\fIpath\fR[,\fIdriver\fR[,permissive]]]]
.RS 4
Redirect serial device
.RE
.PP
\fB/server\-name\fR:\fIname\fR
.RS 4
User\-specified server name to use for validation (TLS, Kerberos)
.RE
.PP
\fB/shell\fR:\fIshell\fR
.RS 4
Alternate shell
.RE
.PP
\fB/shell\-dir\fR:\fIdir\fR
.RS 4
Shell working directory
.RE
.PP
\fB/size\fR:\fIwidth\fRx\fIheight\fR or \fIpercent\fR%[wh]
.RS 4
Screen size (default:1024x768)
.RE
.PP
\fB/smart\-sizing\fR[:\fIwidth\fRx\fIheight\fR]
.RS 4
Scale remote desktop to window size
.RE
.PP
\fB/smartcard\fR[:\fIstr\fR[,\fIstr\fR\&.\&.\&.]]
.RS 4
Redirect the smartcard devices containing any of the <str> in their names\&.
.RE
.PP
\fB/smartcard\-logon\fR[:[cert:\fIpath\fR,key:\fIkey\fR,pin:\fIpin\fR,csp:\fIcsp name\fR,reader:\fIreader\fR,card:\fIcard\fR]]
.RS 4
Activates Smartcard (optional certificate) Logon authentication\&.
.RE
.PP
\fB/sound\fR[:[sys:\fIsys\fR,][dev:\fIdev\fR,][format:\fIformat\fR,][rate:\fIrate\fR,][channel:\fIchannel\fR,][latency:\fIlatency\fR,][quality:\fIquality\fR]], \fB/audio\fR[:[sys:\fIsys\fR,][dev:\fIdev\fR,][format:\fIformat\fR,][rate:\fIrate\fR,][channel:\fIchannel\fR,][latency:\fIlatency\fR,][quality:\fIquality\fR]]
.RS 4
Audio output (sound)
.RE
.PP
\fB/span\fR
.RS 4
Span screen over multiple monitors
.RE
.PP
\fB/spn\-class\fR:\fIservice\-class\fR
.RS 4
SPN authentication service class
.RE
.PP
\fB/ssh\-agent\fR, \fB/ssh\-agent\fR
.RS 4
SSH Agent forwarding channel
.RE
.PP
\fB/sspi\-module\fR:\fISSPI module path\fR
.RS 4
SSPI shared library module file path
.RE
.PP
\fB/winscard\-module\fR:\fIWinSCard module path\fR
.RS 4
WinSCard shared library module file path
.RE
.PP
\fB/disable\-output\fR
.RS 4
Deactivate all graphics decoding in the client session\&. Useful for load tests with many simultaneous connections
.RE
.PP
\fB/t\fR:\fItitle\fR, \fB/title\fR:\fItitle\fR
.RS 4
Window title
.RE
.PP
\fB\-themes\fR
.RS 4
themes (default:on)
.RE
.PP
\fB/timeout\fR:\fItime in ms\fR, \fB/timeout\fR:\fItime in ms\fR
.RS 4
Advanced setting for high latency links: Adjust connection timeout, use if you encounter timeout failures with your connection (default:9000)
.RE
.PP
\fB/tls\fR:[ciphers|seclevel|secrets\-file|enforce]
.RS 4
TLS configuration options: * ciphers:[netmon|ma|<cipher names>]
.br

* seclevel:<level>, default: 1, range: [0\-5] Override the default TLS security level, might be required for older target servers
.br

* secrets\-file:<filename>
.br

* enforce[:[ssl3|1\&.0|1\&.1|1\&.2|1\&.3]] Force use of SSL/TLS version for a connection\&. Some servers have a buggy TLS version negotiation and might fail without this\&. Defaults to TLS 1\&.2 if no argument is supplied\&. Use 1\&.0 for windows 7
.RE
.PP
\fB\-toggle\-fullscreen\fR
.RS 4
Alt+Ctrl+Enter to toggle fullscreen (default:on)
.RE
.PP
\fB/tune\fR:\fIsetting:value\fR,\fIsetting:value\fR
.RS 4
[experimental] directly manipulate freerdp settings, use with extreme caution! (default:)
.RE
.PP
\fB/u\fR:[[\fIdomain\fR\e]\fIuser\fR|\fIuser\fR[@\fIdomain\fR]]
.RS 4
Username
.RE
.PP
\fB+unmap\-buttons\fR
.RS 4
Let server see real physical pointer button (default:off)
.RE
.PP
\fB/usb\fR:[dbg,][id:\fIvid\fR:\fIpid\fR#\&.\&.\&.,][addr:\fIbus\fR:\fIaddr\fR#\&.\&.\&.,][auto]
.RS 4
Redirect USB device
.RE
.PP
\fB/v\fR:\fIserver\fR[:port]
.RS 4
Server hostname
.RE
.PP
\fB/vc\fR:\fIchannel\fR[,\fIoptions\fR]
.RS 4
Static virtual channel
.RE
.PP
\fB/version\fR
.RS 4
Print version
.RE
.PP
\fB/video\fR
.RS 4
Video optimized remoting channel
.RE
.PP
\fB/prevent\-session\-lock\fR[:\fItime in sec\fR]
.RS 4
Prevent session locking by injecting fake mouse motion events to the server when the connection is idle (default interval: 180 seconds)
.RE
.PP
\fB/vmconnect\fR[:\fIvmid\fR]
.RS 4
Hyper\-V console (use port 2179, disable negotiation)
.RE
.PP
\fB/w\fR:\fIwidth\fR
.RS 4
Width (default:1024)
.RE
.PP
\fB\-wallpaper\fR
.RS 4
wallpaper (default:on)
.RE
.PP
\fB+window\-drag\fR
.RS 4
full window drag (default:off)
.RE
.PP
\fB/window\-position\fR:\fIxpos\fRx\fIypos\fR
.RS 4
window position
.RE
.PP
\fB/wm\-class\fR:\fIclass\-name\fR
.RS 4
Set the WM_CLASS hint for the window instance
.RE
.PP
\fB/workarea\fR
.RS 4
Use available work area
.RE
.SH "CONFIGURATION FILE"
.PP
Format and Location:
.RS 4
The configuration file is stored per user\&.
.br

The
\fIXDG_CONFIG_HOME\fR
environment variable can be used to override the base directory\&.
.br

This defaults to
\fI~/\&.config\fR
The location relative to
\fIXDG_CONFIG_HOME\fR
is
\fI$XDG_CONFIG_HOME/FreeRDP/FreeRDP/sdl\-freerdp\&.json\fR
.br

The configuration is stored in JSON format
.RE
.PP
Supported options:
.RS 4
.PP
\fISDL_KeyModMask\fR
.RS 4
.PP
.RS 4
Defines the key combination required for SDL client shortcuts\&.
.br

Default
\fIKMOD_RSHIFT\fR
.br

An array of
\fISDL_Keymod\fR
strings as defined at
\fIhttps://wiki\&.libsdl\&.org/SDL2/SDL_Keymod\fR
.RE
.RE
.PP
\fISDL_Fullscreen\fR
.RS 4
.PP
.RS 4
Toggles client fullscreen state\&.
.br

Default
\fISDL_SCANCODE_RETURN\fR\&.
.br

A string as defined at
\fIhttps://wiki\&.libsdl\&.org/SDL2/SDLScancodeLookup\fR
.RE
.RE
.PP
\fISDL_Resizeable\fR
.RS 4
.PP
.RS 4
Toggles local window resizeable state\&.
.br

Default
\fISDL_SCANCODE_R\fR\&.
.br

A string as defined at
\fIhttps://wiki\&.libsdl\&.org/SDL2/SDLScancodeLookup\fR
.RE
.RE
.PP
\fISDL_Grab\fR
.RS 4
.PP
.RS 4
Toggles keyboard and mouse grab state\&.
.br

Default
\fISDL_SCANCODE_G\fR\&.
.br

A string as defined at
\fIhttps://wiki\&.libsdl\&.org/SDL2/SDLScancodeLookup\fR
.RE
.RE
.PP
\fISDL_Disconnect\fR
.RS 4
.PP
.RS 4
Disconnects from the RDP session\&.
.br

Default
\fISDL_SCANCODE_D\fR\&.
.br

A string as defined at
\fIhttps://wiki\&.libsdl\&.org/SDL2/SDLScancodeLookup\fR
.RE
.RE
.RE
.SH "ENVIRONMENT VARIABLES"
.PP
wlog environment variable
.RS 4
sdl\-freerdp uses wLog as its log facility, you can refer to the corresponding man page (wlog(7)) for more informations\&. Arguments passed via the
\fI/log\-level\fR
or
\fI/log\-filters\fR
have precedence over the environment variables\&.
.RE
.SH "EXAMPLES"
.PP
\fBsdl\-freerdp connection\&.rdp /p:Pwd123! /f\fR
.RS 4
Connect in fullscreen mode using a stored configuration
\fIconnection\&.rdp\fR
and the password
\fIPwd123!\fR
.RE
.PP
\fBsdl\-freerdp /u:USER /size:50%h /v:rdp\&.contoso\&.com\fR
.RS 4
Connect to host
\fIrdp\&.contoso\&.com\fR
with user
\fIUSER\fR
and a size of
\fI50 percent of the height\fR\&. If width (w) is set instead of height (h) like /size:50%w\&. 50 percent of the width is used\&.
.RE
.PP
\fBsdl\-freerdp /u:CONTOSO\e\eJohnDoe /p:Pwd123! /v:rdp\&.contoso\&.com\fR
.RS 4
Connect to host
\fIrdp\&.contoso\&.com\fR
with user
\fICONTOSO\e\eJohnDoe\fR
and password
\fIPwd123!\fR
.RE
.PP
\fBsdl\-freerdp /u:JohnDoe /p:Pwd123! /w:1366 /h:768 /v:192\&.168\&.1\&.100:4489\fR
.RS 4
Connect to host
\fI192\&.168\&.1\&.100\fR
on port
\fI4489\fR
with user
\fIJohnDoe\fR, password
\fIPwd123!\fR\&. The screen width is set to
\fI1366\fR
and the height to
\fI768\fR
.RE
.PP
\fBsdl\-freerdp /u:JohnDoe /p:Pwd123! /vmconnect:C824F53E\-95D2\-46C6\-9A18\-23A5BB403532 /v:192\&.168\&.1\&.100\fR
.RS 4
Establish a connection to host
\fI192\&.168\&.1\&.100\fR
with user
\fIJohnDoe\fR, password
\fIPwd123!\fR
and connect to Hyper\-V console (use port 2179, disable negotiation) with VMID
\fIC824F53E\-95D2\-46C6\-9A18\-23A5BB403532\fR
.RE
.PP
\fB+clipboard\fR
.RS 4
Activate clipboard redirection
.RE
.PP
\fB/drive:home,/home/user\fR
.RS 4
Activate drive redirection of
\fI/home/user\fR
as home drive
.RE
.PP
\fB/smartcard:<device>\fR
.RS 4
Activate smartcard redirection for device
\fIdevice\fR
.RE
.PP
\fB/printer:<device>,<driver>\fR
.RS 4
Activate printer redirection for printer
\fIdevice\fR
using driver
\fIdriver\fR
.RE
.PP
\fB/serial:<device>\fR
.RS 4
Activate serial port redirection for port
\fIdevice\fR
.RE
.PP
\fB/parallel:<device>\fR
.RS 4
Activate parallel port redirection for port
\fIdevice\fR
.RE
.PP
\fB/sound:sys:alsa\fR
.RS 4
Activate audio output redirection using device
\fIsys:alsa\fR
.RE
.PP
\fB/microphone:sys:alsa\fR
.RS 4
Activate audio input redirection using device
\fIsys:alsa\fR
.RE
.PP
\fB/multimedia:sys:alsa\fR
.RS 4
Activate multimedia redirection using device
\fIsys:alsa\fR
.RE
.PP
\fB/usb:id,dev:054c:0268\fR
.RS 4
Activate USB device redirection for the device identified by
\fI054c:0268\fR
.RE
.SH "LINKS"
.PP
\m[blue]\fBhttp://www\&.freerdp\&.com/\fR\m[]
.SH "AUTHOR"
.br
.PP
The FreeRDP Team