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

FreeBSD Manual Pages

  
 
  

home | help
XFREERDP(1)			   xfreerdp			   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

       /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

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

ENVIRONMENT VARIABLES
       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.

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

freerdp				  2017-07-02			   XFREERDP(1)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | ENVIRONMENT VARIABLES | EXAMPLES | LINKS | AUTHOR

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=xfreerdp&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help