manuals: initial commit

.gitignore

@@ -0,0 +1,4 @@
+
+*~
+.DS_Store
+

User/FreeRDP-User-Manual.markdown

@@ -0,0 +1,187 @@
+% FreeRDP User Manual
+% Marc-André Moreau
+
+# Introduction
+
+## Help
+
+FreeRDP - A Free Remote Desktop Protocol Implementation
+
+See www.freerdp.com for more information
+
+	Usage: ./client/X11/xfreerdp [file] [options] [/v:<server>[:port]]
+
+Syntax:
+
+    /flag (enables flag)
+    /option:<value> (specifies option with value)
+    +toggle -toggle (enables or disables toggle, where '/' is a synonym of '+')
+
+    /v:<server>[:port]   	Server hostname
+    /port:<number>       	Server port
+    /w:<width>           	Width
+    /h:<height>          	Height
+    /size:<width>x<height>	Screen size
+    /f                   	Fullscreen mode
+    /bpp:<depth>         	Session bpp (color depth)
+    /kbd:0x<layout id> or <layout name>	Keyboard layout
+    /kbd-list            	List keyboard layouts
+    /kbd-type:<type id>  	Keyboard type
+    /kbd-subtype:<subtype id>	Keyboard subtype
+    /kbd-fn-key:<function key count>	Keyboard function key count
+    /admin               	Admin (or console) session
+    /multimon            	Multi-monitor
+    /workarea            	Work area
+    /t:<title>           	Window title
+    +decorations (default:off)	Window decorations
+    /a                   	Addin
+    /vc                  	Static virtual channel
+    /dvc                 	Dynamic virtual channel
+    /u:[<domain>\\]<user> or <user>[@<domain>]	Username
+    /p:<password>        	Password
+    /d:<domain>          	Domain
+    /g:<gateway>[:port]  	Gateway Hostname
+    /gu:[<domain>\\]<user> or <user>[@<domain>]	Gateway username
+    /gp:<password>       	Gateway password
+    /gd:<domain>         	Gateway domain
+    /app:||<alias> or <executable path>	Remote application program
+    /app-name:<app name> 	Remote application name for user interface
+    /app-icon:<icon path>	Remote application icon for user interface
+    /app-cmd:<parameters>	Remote application command-line parameters
+    /app-file:<file name>	File to open with remote application
+    /app-guid:<app guid> 	Remote application GUID
+    +compression (default:off)	Compression
+    /shell               	Alternate shell
+    /shell-dir           	Shell working directory
+    /audio-mode          	Audio output mode
+    /mic                 	Audio input (microphone)
+    /network             	Network connection type
+    +clipboard (default:off)	Redirect clipboard
+    +fonts (default:off) 	Smooth fonts (cleartype)
+    +aero (default:off)  	Desktop composition
+    +window-drag (default:off)	Full window drag
+    +menu-anims (default:off)	Menu animations
+    -themes (default:on) 	Themes
+    -wallpaper (default:on)	Wallpaper
+    /gdi:<sw|hw>         	GDI rendering
+    /rfx                 	RemoteFX
+    /rfx-mode:<image|video>	RemoteFX mode
+    /frame-ack:<number>  	Frame acknowledgement
+    /nsc                 	NSCodec
+    /jpeg                	JPEG codec
+    /jpeg-quality:<percentage>	JPEG quality
+    -nego (default:on)   	protocol security negotiation
+    /sec:<rdp|tls|nla|ext>	force specific protocol security
+    -sec-rdp (default:on)	rdp protocol security
+    -sec-tls (default:on)	tls protocol security
+    -sec-nla (default:on)	nla protocol security
+    +sec-ext (default:off)	nla extended protocol security
+    /cert-name:<name>    	certificate name
+    /cert-ignore         	ignore certificate
+    /pcb:<blob>          	Preconnection Blob
+    /pcid:<id>           	Preconnection Id
+    /vmconnect:<vmid>    	Hyper-V console (use port 2179, disable negotiation)
+    -authentication (default:on)	authentication (hack!)
+    -encryption (default:on)	encryption (hack!)
+    -grab-keyboard (default:on)	grab keyboard
+    -mouse-motion (default:on)	mouse-motion
+    /parent-window:<window id>	Parent window id
+    -bitmap-cache (default:on)	bitmap cache
+    -offscreen-cache (default:on)	offscreen bitmap cache
+    -glyph-cache (default:on)	glyph cache
+    /codec-cache:<rfx|nsc|jpeg>	bitmap codec cache
+    -fast-path (default:on)	fast-path input/output
+    +async-input (default:off)	asynchronous input
+    +async-update (default:off)	asynchronous update
+    /version             	print version
+    /help                	print help
+
+Examples:
+
+    xfreerdp connection.rdp /p:Pwd123! /f
+    xfreerdp /u:CONTOSO\\JohnDoe /p:Pwd123! /v:rdp.contoso.com
+    xfreerdp /u:JohnDoe /p:Pwd123! /w:1366 /h:768 /v:192.168.1.100:4489
+    xfreerdp /u:JohnDoe /p:Pwd123! /vmconnect:C824F53E-95D2-46C6-9A18-23A5BB403532 /v:192.168.1.100
+
+	Clipboard Redirection: +clipboard
+
+	Drive Redirection: /a:drive,home,/home
+	Smartcard Redirection: /a:smartcard,<device>
+	Printer Redirection: /a:printer,<device>,<driver>
+	Serial Port Redirection: /a:serial,<device>
+	Parallel Port Redirection: /a:parallel,<device>
+	Printer Redirection: /a:printer,<device>,<driver>
+
+	Audio Input Redirection: /dvc:audin,sys:alsa
+	Audio Output Redirection: /vc:rdpsnd,sys:alsa
+
+	Multimedia Redirection: /dvc:tsmf,sys:alsa
+	USB Device Redirection: /dvc:urbdrc,id,dev:054c:0268
+
+## Authentication
+
+Sample Values:
+
+* User: JohnDoe
+* Domain: CONTOSO
+* Password: Password123!
+* Server: rdp.contoso.com
+
+There simplest, unambiguous way of passing credentials at the command-line is with /u, /d and /p. The domain name is only needed if you connect using domain credentials:
+
+	xfreerdp /u:JohnDoe /d:CONTOSO /p:Password123! /v:rdp.contoso.com
+
+The domain name can also be passed in the username using the same notation accepted by mstsc:
+
+	xfreerdp /u:CONTOSO\JohnDoe /p:Password123! /v:rdp.contoso.com
+
+While the above notation is shorter, it has an unpractical side effect: the backslash is often, but not always, interpreted as an escape character. To avoid the problem, make sure the shell does not interpret the backslash as an escape character:
+
+	xfreerdp /u:CONTOSO\\JohnDoe /p:Password123! /v:rdp.contoso.com
+	xfreerdp "/u:CONTOSO\JohnDoe" /p:Password123! /v:rdp.contoso.com
+
+From experience, most Linux shells will require such handling of the backslash character. However, there are certain cases like the Eclipse launcher which do not require it.
+
+Alternatively, the User Principal Name (UPN) notation can be used:
+
+	xfreerdp /u:JohnDoe@CONTOSO /p:Password123! /v:rdp.contoso.com
+
+This notation does not have the drawbacks of the backslash character, but introduces a potential conflict with usernames containing the '@' symbol and no domain name. This is frequently the case with the new Windows 8 Microsoft Accounts (a.k.a. Windows Live Accounts) which correspond to an email address. To work work around the ambiguity, precede the user name "john.doe@live.com" with a backslash:
+
+	xfreerdp /u:\john.doe@live.com /p:Password123! /v:rdp.contoso.com
+
+Be careful to properly handle the backslash character as previously instructed.
+
+Passwords entered as command-line arguments could potentially be seen by other users on the same system, so they are automatically hidden:
+
+	awake@workstation:~$ ps aux | grep freerdp
+	awake           22506   0.0  0.1  2502620  10236 s002  S+   11:10pm   0:01.00 xfreerdp /u:JohnDoe /p:************ /d:CONTOSO /v:rdp.contoso.com
+
+### Credentials Prompt
+
+If you omit entering credentials at the command-line, FreeRDP may prompt you for credentials depending on the negotiated protocol security level.
+
+#### Protocol Security
+
+RDP protocol security is confusing for many users because it strongly affects the way credentials can be prompted. There are three main security levels that can be negotiated:
+
+* RDP Security (old encryption, old authentication)
+* TLS Security (TLS encryption, old authentication)
+* NLA Security (TLS encryption, NLA authentication)
+
+##### Old Authentication
+
+The old RDP authentication mechanism is very simple: the server presents the client with the Winlogon GUI, and the user can either automatically or manually enter the credentials. If you enter credentials prior to connecting to a server with the old authentication, they will be automatically on connection, saving you the trouble of typing them manually.
+
+Old RDP authentication may be practical in the sense that you can get a remote Winlogon GUI without being authenticated on the server. This is however a design flaw which makes the RDP server vulnerable to a DDOS attack: since significant resources need to be allocated for the Winlogon GUI without being authenticated, a distributed denial of service attack could be performed by simply launching multiple unauthenticated connections. This is exactly why it is no longer possible to obtain such a GUI prior to authentication with newer security levels.
+
+##### Network Level Authentication (NLA)
+
+Network Level Authentication (NLA) is required by default with servers starting with Windows Vista. With NLA, authentication is the very first thing that occurs over the wire, such that the server will only allocate resources and present a graphical interface to authenticated clients. It is also much more secure and provides strong defense mechanisms against Man-in-the-Middle (MITM) attacks.
+
+When NLA is negotiated, the complete credentials are needed at connection time, which is why FreeRDP will prompt for the missing information:
+
+	xfreerdp /u:JohnDoe /d:CONTOSO /v:rdp.contoso.com
+	connected to rdp.contoso.com
+	Password:
+

gen.pl

@@ -0,0 +1,45 @@
+#!/usr/bin/perl
+
+sub pandoc_generate_pdf
+{
+	($DOC) = @_;
+
+	print "Generating $DOC PDF...\n";
+
+	my $CMD = "pandoc $DOC.markdown " .
+        	"--smart --normalize --number-sections --section-divs --toc " .
+        	"--variable=links-as-notes:true --variable=documentclass:report --to=latex " .
+        	"--variable=lang:english --variable=urlcolor:black --variable=linkcolor:black " .
+		" --variable=verbatim-in-note:true " .
+        	"--output=$DOC.pdf";
+
+	print "$CMD\n";
+
+	system($CMD);
+
+	print "Done!\n";
+}
+
+$USR_DOC = "User/FreeRDP-User-Manual";
+$DEV_DOC = "Developer/FreeRDP-Developer-Manual";
+$CFG_DOC = "Configuration/FreeRDP-Configuration-Manual";
+
+@DOCS = ();
+
+foreach $i (0 .. $#ARGV) {
+	if ($ARGV[$i] =~ m/^usr$/) {
+		push(@DOCS, $USR_DOC);
+	} elsif ($ARGV[$i] =~ m/^dev$/) {
+		push(@DOCS, $DEV_DOC);
+	} elsif ($ARGV[$i] =~ m/^cfg$/) {
+		push(@DOCS, $CFG_DOC);
+	}
+}
+
+if ($#ARGV eq -1) {
+	@DOCS = ($USR_DOC, $DEV_DOC, $CFG_DOC);
+}
+
+foreach (@DOCS) {
+	pandoc_generate_pdf($_);
+}