diff --git a/README b/README,md similarity index 68% rename from README rename to README,md index 26b0627..1f1ae63 100644 --- a/README +++ b/README,md @@ -1,14 +1,13 @@ -========================================== -rdesktop: A Remote Desktop Protocol client -========================================== +# rdesktop - A Remote Desktop Protocol client rdesktop is an open source client for Microsoft's RDP protocol. It is known to work with Windows versions ranging from NT 4 Terminal Server to Windows 2012r2 RDS. rdesktop currently implements the RDP version 4 and 5 protocols. -Installation ------------- + +## Installation + rdesktop uses a GNU-style build procedure. Typically all that is necessary to install rdesktop is the following:: @@ -19,15 +18,21 @@ to install rdesktop is the following:: The default is to install under /usr/local. This can be changed by adding --prefix=directory to the configure line. -Note for users building from source ------------------------------------ +The smart-card support module uses PCSC-lite. You should use PCSC-lite 1.2.9 or +later. To enable smart-card support in the rdesktop just run `./configure` with the +`--enable-smartcard` option. + + +## Note for users building from source + If you have retreived a snapshot of rdesktop source, you will first -need to run ./bootstrap in order to generate the build infrastructure. +need to run `./bootstrap` in order to generate the build infrastructure. This is not necessary for release versions of rdesktop. -Invocation ----------- -Simply run:: + +## Usage + +Conenct to a RDP server like: % rdesktop server @@ -37,12 +42,3 @@ Terminal Services enabled, or there is a firewall blocking access.) You can also specify a number of options on the command line. These are listed in the rdesktop manual page (run "man rdesktop"). - -Smart-card support notes ------------------------- -The smart-card support module uses PCSC-lite. You should use PCSC-lite 1.2.9 or -later. - -To enable smart-card support in the rdesktop just run "./configure" with the -"--enable-smartcard" option. -