README

==========================================
FreeRDP: A Remote Desktop Protocol client.
==========================================

FreeRDP is a free remote desktop protocol client that implements RDP following
the documentation released under the Microsoft Open Specification Promise.

Support
--------------------------------------------------
* Homepage: http://freerdp.com/
* Wiki: http://www.freerdp.com/wiki/

Libraries used (Ubuntu package names - may not apply to all environments)
--------------------------------------------------
* Xorg-dev
* libssl-dev (OpenSSL)
* libcups2-dev (CUPS 1.3/1.4)
* libasound2-dev (ALSA)

Using git-master source
--------------------------------------------------
1. Install autogen, automake, and gettext.
2. "git clone git://github.com/FreeRDP/FreeRDP.git"
3. "cd freerdp"
4. "sh autogen.sh"

Compiling & installing (git-master or release)
--------------------------------------------------
1. As a root-capable user, install what libraries you require.
2a. Stable users: download the latest release archive.
2b. Edge users: follow the git-master source procedure.
3. "./configure"
4. "make"
5. As a root-capable user, "make install"

The default is to install under /usr/local.  This can be changed by adding
--prefix=directory to the configure line.

Using FreeRDP
--------------------------------------------------
* Running xfreerdp (or relative binary) by itself will display help.
* Note that the server name must be the last option
* xfreerdp plugins expand features available by the software. They are
  installed in (install)/lib/freerdp/ .

Examples of using xfreerdp
--------------------------------------------------
* Remote clipboard access
  xfreerdp --plugin cliprdr -g 900x600 (server)
* Comport redirection & clipboard access
  xfreerdp --plugin cliprdr --plugin rdpdr --data serial:COM1:/dev/ttyUSB0 -- -g 900x600 (server)