Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages


home | help
XFREERDP(1)			   xfreerdp			   XFREERDP(1)

       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

       /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

	   [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|AVC420|AVC444> - RDP8 graphics pipeline	(experimental)

	   RDP8	graphics pipeline using	thin client mode

	   RDP8	graphics pipeline using	small cache mode

	   RDP8	graphics pipeline using	progressive codec

	   <AVC420|AVC444> - RDP8.1 graphics pipeline using H264 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

	   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

       /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(1) 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(1) 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

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

       wlog environment	variable
	   xfreerdp uses wLog as its log facility, you can refer to the
	   corresponding man page (wlog(1)) 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! /
	   Connect to host 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

       xfreerdp	/u:JohnDoe /p:Pwd123!
       /vmconnect:C824F53E-95D2-46C6-9A18-23A5BB403532 /v:192.168. 1.100
	   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


       The FreeRDP Team

freerdp				  2017-07-02			   XFREERDP(1)


Want to link to this manual page? Use this URL:

home | help