'\" t
.\"     Title: xfreerdp
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 2019-02-10
.\"    Manual: xfreerdp
.\"    Source: freerdp
.\"  Language: English
.\"
.TH "XFREERDP" "1" "2019\-02\-10" "freerdp" "xfreerdp"
.\" -----------------------------------------------------------------
.\" * 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"
xfreerdp \- FreeRDP X11 client
.SH "SYNOPSIS"
.PP
\fBxfreerdp\fR
[file] [options] [/v:server[:port]]
.SH "DESCRIPTION"
.PP
\fBxfreerdp\fR
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)\&.
.SH "OPTIONS"
.PP
\fB/v\fR \fI<server>[:port]\fR
.RS 4
Server hostname
.RE
.PP
\fB/port\fR \fI<number>\fR
.RS 4
Server port
.RE
.PP
\fB/w\fR \fI<width>\fR
.RS 4
Width
.RE
.PP
\fB/h\fR \fI<height>\fR
.RS 4
Height
.RE
.PP
\fB/size\fR \fI<width>x<height>\fR
.RS 4
Screen size
.RE
.PP
\fB/f\fR
.RS 4
Fullscreen mode
.RE
.PP
\fB/bpp\fR \fI<depth>\fR
.RS 4
Session bpp (color depth)
.RE
.PP
\fB/kbd\fR \fI0x<layout id> or <layout name>\fR
.RS 4
Keyboard layout
.RE
.PP
\fB/kbd\-list\fR
.RS 4
List keyboard layouts
.RE
.PP
\fB/kbd\-type\fR \fI<type id>\fR
.RS 4
Keyboard type
.RE
.PP
\fB/kbd\-subtype\fR \fI<subtype id>\fR
.RS 4
Keyboard subtype
.RE
.PP
\fB/kbd\-fn\-key\fR \fI<function key count>\fR
.RS 4
Keyboard function key count
.RE
.PP
\fB/admin\fR
.RS 4
Admin (or console) session
.RE
.PP
\fB/multimon\fR
.RS 4
Use multiple monitors
.RE
.PP
\fB/workarea\fR
.RS 4
Use available work area
.RE
.PP
\fB/monitors\fR \fI<0,1,2\&.\&.\&.>\fR
.RS 4
Select monitors to use
.RE
.PP
\fB/monitor\-list\fR
.RS 4
List detected monitors
.RE
.PP
\fB/t\fR \fI<title>\fR
.RS 4
Window title
.RE
.PP
\fB/decorations\fR
.RS 4
Window decorations
.RE
.PP
\fB/smart\-sizing\fR
.RS 4
Scale remote desktop to window size
.RE
.PP
\fB/a\fR \fI(null)\fR
.RS 4
Addin
.RE
.PP
\fB/vc\fR \fI(null)\fR
.RS 4
Static virtual channel
.RE
.PP
\fB/dvc\fR \fI(null)\fR
.RS 4
Dynamic virtual channel
.RE
.PP
\fB/u\fR \fI[<domain>\e]<user> or <user>[@<domain>]\fR
.RS 4
Username
.RE
.PP
\fB/p\fR \fI<password>\fR
.RS 4
Password
.RE
.PP
\fB/d\fR \fI<domain>\fR
.RS 4
Domain
.RE
.PP
\fB/g\fR
.RS 4
Gateway Hostname
.RE
.PP
\fB/gu\fR \fI[<domain>\e]<user> or <user>[@<domain>]\fR
.RS 4
Gateway username
.RE
.PP
\fB/gp\fR \fI<password>\fR
.RS 4
Gateway password
.RE
.PP
\fB/gd\fR \fI<domain>\fR
.RS 4
Gateway domain
.RE
.PP
\fB/load\-balance\-info\fR \fI<info string>\fR
.RS 4
Load balance info
.RE
.PP
\fB/app\fR \fI||<alias> or <executable path>\fR
.RS 4
Remote application program
.RE
.PP
\fB/app\-name\fR \fI<app name>\fR
.RS 4
Remote application name for user interface
.RE
.PP
\fB/app\-icon\fR \fI<icon path>\fR
.RS 4
Remote application icon for user interface
.RE
.PP
\fB/app\-cmd\fR \fI<parameters>\fR
.RS 4
Remote application command\-line parameters
.RE
.PP
\fB/app\-file\fR \fI<file name>\fR
.RS 4
File to open with remote application
.RE
.PP
\fB/app\-guid\fR \fI<app guid>\fR
.RS 4
Remote application GUID
.RE
.PP
\fB/compression\fR
.RS 4
Compression
.RE
.PP
\fB/shell\fR \fI(null)\fR
.RS 4
Alternate shell
.RE
.PP
\fB/shell\-dir\fR \fI(null)\fR
.RS 4
Shell working directory
.RE
.PP
\fB/sound\fR
.RS 4
Audio output (sound)
.RE
.PP
\fB/microphone\fR
.RS 4
Audio input (microphone)
.RE
.PP
\fB/audio\-mode\fR \fI(null)\fR
.RS 4
Audio output mode
.RE
.PP
\fB/multimedia\fR
.RS 4
Redirect multimedia (video)
.RE
.PP
\fB/network\fR \fI(null)\fR
.RS 4
Network connection type
.RE
.PP
\fB/drive\fR \fI(null)\fR
.RS 4
Redirect drive
.RE
.PP
\fB/drives\fR
.RS 4
Redirect all drives
.RE
.PP
\fB/home\-drive\fR
.RS 4
Redirect home drive
.RE
.PP
\fB/clipboard\fR
.RS 4
Redirect clipboard
.RE
.PP
\fB/serial\fR \fI(null)\fR
.RS 4
Redirect serial device
.RE
.PP
\fB/parallel\fR \fI(null)\fR
.RS 4
Redirect parallel device
.RE
.PP
\fB/smartcard\fR \fI(null)\fR
.RS 4
Redirect smartcard device
.RE
.PP
\fB/printer\fR
.RS 4
Redirect printer device
.RE
.PP
\fB/usb\fR \fI(null)\fR
.RS 4
Redirect USB device
.RE
.PP
\fB/multitouch\fR
.RS 4
Redirect multitouch input
.RE
.PP
\fB/echo\fR
.RS 4
Echo channel
.RE
.PP
\fB/fonts\fR
.RS 4
Smooth fonts (ClearType)
.RE
.PP
\fB/aero\fR
.RS 4
Desktop composition
.RE
.PP
\fB/window\-drag\fR
.RS 4
Full window drag
.RE
.PP
\fB/menu\-anims\fR
.RS 4
Menu animations
.RE
.PP
\fB/themes\fR
.RS 4
Themes
.RE
.PP
\fB/wallpaper\fR
.RS 4
Wallpaper
.RE
.PP
\fB/gdi\fR \fI<sw|hw>\fR
.RS 4
GDI rendering
.RE
.PP
\fB/rfx\fR
.RS 4
RemoteFX
.RE
.PP
\fB/rfx\-mode\fR \fI<image|video>\fR
.RS 4
RemoteFX mode
.RE
.PP
\fB/frame\-ack\fR \fI<number>\fR
.RS 4
Frame acknowledgement
.RE
.PP
\fB/nsc\fR
.RS 4
NSCodec
.RE
.PP
\fB/jpeg\fR
.RS 4
JPEG codec
.RE
.PP
\fB/jpeg\-quality\fR \fI<percentage>\fR
.RS 4
JPEG quality
.RE
.PP
\fB/nego\fR
.RS 4
protocol security negotiation
.RE
.PP
\fB/sec\fR \fI<rdp|tls|nla|ext>\fR
.RS 4
force specific protocol security
.RE
.PP
\fB/sec\-rdp\fR
.RS 4
rdp protocol security
.RE
.PP
\fB/sec\-tls\fR
.RS 4
tls protocol security
.RE
.PP
\fB/sec\-nla\fR
.RS 4
nla protocol security
.RE
.PP
\fB/sec\-ext\fR
.RS 4
nla extended protocol security
.RE
.PP
\fB/cert\-name\fR \fI<name>\fR
.RS 4
certificate name
.RE
.PP
\fB/cert\-ignore\fR
.RS 4
ignore certificate
.RE
.PP
\fB/pcb\fR \fI<blob>\fR
.RS 4
Preconnection Blob
.RE
.PP
\fB/pcid\fR \fI<id>\fR
.RS 4
Preconnection Id
.RE
.PP
\fB/vmconnect\fR
.RS 4
Hyper\-V console (use port 2179, disable negotiation)
.RE
.PP
\fB/authentication\fR
.RS 4
authentication (hack!)
.RE
.PP
\fB/encryption\fR
.RS 4
encryption (hack!)
.RE
.PP
\fB/grab\-keyboard\fR
.RS 4
grab keyboard
.RE
.PP
\fB/toggle\-fullscreen\fR
.RS 4
Alt+Ctrl+Enter toggles fullscreen
.RE
.PP
\fB/mouse\-motion\fR
.RS 4
mouse\-motion
.RE
.PP
\fB/parent\-window\fR \fI<window id>\fR
.RS 4
Parent window id
.RE
.PP
\fB/bitmap\-cache\fR
.RS 4
bitmap cache
.RE
.PP
\fB/offscreen\-cache\fR
.RS 4
offscreen bitmap cache
.RE
.PP
\fB/glyph\-cache\fR
.RS 4
glyph cache
.RE
.PP
\fB/codec\-cache\fR \fI<rfx|nsc|jpeg>\fR
.RS 4
bitmap codec cache
.RE
.PP
\fB/fast\-path\fR
.RS 4
fast\-path input/output
.RE
.PP
\fB/max\-fast\-path\-size\fR
.RS 4
maximum fast\-path update size
.RE
.PP
\fB/async\-input\fR
.RS 4
asynchronous input
.RE
.PP
\fB/async\-update\fR
.RS 4
asynchronous update
.RE
.PP
\fB/async\-transport\fR
.RS 4
asynchronous transport (unstable)
.RE
.PP
\fB/async\-channels\fR
.RS 4
asynchronous channels (unstable)
.RE
.PP
\fB/wm\-class\fR \fI<class name>\fR
.RS 4
set the WM_CLASS hint for the window instance
.RE
.PP
\fB/version\fR
.RS 4
print version
.RE
.PP
\fB/help\fR
.RS 4
print help
.RE
.PP
\fB/play\-rfx\fR \fI<pcap file>\fR
.RS 4
Replay rfx pcap file
.RE
.PP
\fB/auth\-only\fR
.RS 4
Authenticate only\&.
.RE
.SH "EXAMPLES"
.PP
\fBxfreerdp 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
\fBxfreerdp /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
\fBxfreerdp /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
\fBxfreerdp /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