***************************************************************

 Installation instructions for 
 the OMNIKEY CardMan RFID Smartcard reader series.
	    
 Version 2.6.0
 OMNIKEY GmbH
 http://www.omnikey.com/
 
***************************************************************

------------------------------
 Products supported
------------------------------
OMNIKEY CardMan 5x21
OMNIKEY CardMan 5x25

------------------------------
 What you need
------------------------------

[1] Kernel with USB support either compiled in or as modules

[2] Mounted /usbfs (/usbdevfs)
    For more detailed informations see http://www.linux-usb.org/

[3] libusb >= Version 0.1.12 available at
    http://libusb.sourceforge.net/

[4] PCSCLite > Version 1.3.2 available at 
        http://alioth.debian.org/projects/pcsclite/

[5] This driver supports our CT-API and our Synchronous API.
    So, if you like to use one of them, you must download
    the API in question from www.omnikey.com.

------------------------------
 Features
------------------------------

[1] This driver generates 2 slots. The even number is always the contact slot the odd number the contactless slot.

[2] Secure Transmission of Keys is not supported till now.

[3] Supports Extended APDUs

[4] Supports many non ISO compliant cards.

[5] Supports 13,56 MHz and 125 KHz cards.

[6] Serial number support through SCardGetAttrib().

------------------------------
 Driver Installation
------------------------------

After you have downloaded the tarball extract it in any directory
 
  # tar -xzvf ifd<driver-package-name>.tar.gz

change to this directory  and run as root user
  
  # ./install

This script checks if PCSCLite is installed and then copies 
the CCID driver bundle to /usr/local/pcsc/drivers directory,
 which is the default PCSCLite USB driver dropdir. 
You can change the dropdir by providing another install path 
to the install script using the option '-d':

  # ./install -d /path/to/my/dropdir

------------------------------
 Note
------------------------------

1. Ensure that PCSC-Lite is configured with the options
   --enable-libusb and --enable-extendedapdu.
   Moreover it is also necessary to install libusb
   AND its corresponding development sources package that
   is e.g. for DEBIAN libusb-dev or for MANDRIVA libusb-devel

2. PCSCLite with ADD_SERIAL_NUMBER support contains a bug which prevents
   PCSCLite from dedecting a reader removal. 
   Workaround:
   * undefine ADD_SERIAL_NUMBER in hotplug_libusb.c and
     recompile PCSC.

3. PCSCLite with ADD_SERIAL_NUMBER support contains a bug causes PCSCLite to crash
   if more than 1 reader is used.
   Workaround:
   * undefine ADD_SERIAL_NUMBER in hotplug_libusb.c and
     recompile PCSC.
   
-----------------------------
 Support
-----------------------------

Q: What driver version am I using at the moment?

A: You can determine the driver version number by having a look at the PCSCLite
   bundle directory (usually /usr/local/pcsc/drivers): The bundle name of our 
   devices drivers contain the driver version number. 
   The driver is also printing a version string every time a reader is activated 
   by PCSCLite: This string can be found either in the system log
   or on the console you started PCSCLite daemon from.


Q: I am experiencing problems using smartcard XYZ !

A: Please send an email to our support address support@omnikey.com containing
   a description of the chain of events which lead to the misbehavior (reader plug-in/-off, 
   SC insertion/removal, commands sent to the SC or at least the program used to talk to the SC), 
   also include the name and ATR of the smartcard, and add the PCSCLite log events (should be written to
   your system log /var/log/messages or similar). Your systems kernel version and kind of distribution
   may also be helpful.
