Milestone 5: deliver embedded RDP sessions and lifecycle hardening

third_party/FreeRDP/client/X11/man/xfreerdp-examples.1.in

@@ -0,0 +1,181 @@
+.SH "EXAMPLES"
+.PP
+.RS 4
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+#!/bin/bash
+
+# we got a key combination
+if [ "$1" = "key" ];
+then
+	# we only got one argument \*(Aqkey\*(Aq
+	# list all supported combinations with echo
+	if [ $# \-eq 1 ];
+	then
+		echo "ctrl+alt+f1"
+		echo "ctrl+alt+f2"
+	else
+		# We want the action for a single combination
+		# use \*(Aqkey\-local\*(Aq to not forward to RDP session
+		if [ "$2" = "ctrl+alt+f1" ];
+		then
+			echo "key\-local"
+		fi
+		if [ "$2" = "ctrl+alt+f2" ];
+		then
+				echo "/usr/local/bin/somescript\&.sh"
+		fi
+	fi
+fi
+if [ "$1" = "xevent" ];
+	then
+		if [ $# \-eq 1 ];
+		then
+			echo "FocusIn"
+			echo "SelectionClear"
+		else
+			if [ "$2" = "SelectionNotify" ];
+			then
+				echo "/usr/local/bin/someprogram"
+			fi
+		fi
+	fi
+.fi
+.if n \{\
+.RE
+.\}
+Example action script for key events, listing
+\fIctrl+alt+f1\fR
+to be handled by local window manager and
+\fIctrl+alt+f2\fR
+executing a script
+.sp
+The return value of the program determines if the key is handled locally or remotely (0 for local, > 0 for remote, < 0 for errors)
+.RE
+.PP
+\fB@MANPAGE_NAME@ 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
+\fB@MANPAGE_NAME@ /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
+\fB@MANPAGE_NAME@ /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
+\fB@MANPAGE_NAME@ /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
+\fB@MANPAGE_NAME@ /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
+.PP
+\fB/kbd:remap:29=58,remap:58=29\fR
+.RS 4
+Swap left Control (\
+\fI29\fR\
+) and Caps Lock (\
+\fI58\fR\
+).
+.RE