 *
============================================================================
 *
 * Copyright  2003-2010 by WIBU-SYSTEMS AG
 *            Rueppurrer Strasse 52-54, 76137 Karlsruhe, Germany
 *            WebSite: http://www.wibu.com, eMail: info@wibu.com
 *            Phone: +49-721-93172-0, Fax: +49-721-93172-22
 *            All rights reserved.
 *
 * Version .. 4.30
 * Project .. CodeMeter (CodeMeter Runtime-kit for Linux)
 * System ... Linux
 * Tools .... GNU/Linux


General Information
===================

This is CodeMeter version 4.30.  Some advantages of CodeMeter are:
*  Buying current software versions at a reduced rate
*  Up to 100 licenses in a CmStick
*  License is not bound single system like PC/Mac/laptop
*  Problem-free return of licenses
*  Guarantees privacy by anonymous registering of the CmStick
*  Secure storage of passwords, PINs and TANs
*  additional system bounded license called CodeMeterAct are possible since version 4.01
*  since version 4.01 addional license borring are possible 
*  since version 4.20 additonal SD/CF-CodeMeter token are supported


The official web site is:
  http://www.codemeter.com

                                                                                
Distributions
=============

At this time CodeMeter will support RPM and DEB based linux distributions.
The installation package only support the i386 architecture. If you
required support for PowerPC or ARM architecture, please contact our
support team.

CodeMeter is tested on follow linux distributions but works on many other:
- SuSE Linux 10.x/11.x
- SLES 10
- Fedora Linux Core 14
- RHEL 5, CentOS 5
- Ubuntu 8.04, 9.10, 10.04
- Debian 5.0

The CodeMeter installation package is splitted in two parts, 
i.e. for RPM-based linux distributions
- the RunTime-Kit (CodeMeter-4.30-504.i386.rpm) and a 

or for DEB-based linux distributions
- the RunTime-Kit (codemeter_4.30.504_i386.deb) and a 



The RunTime-Kit include also mechanism for USB-Hotplugging.
The Development-Kit include all neccessary headers and also
a API documentation.


If you use a other not tested linux distribution please remark
that you can have some problems with the usb hotplugging. I.e.
every linux distribution can have a different art to detect a
hotplug usb device.


The official web site is:
  http://www.codemeter.com



Installation
============

On RPM based Linux Distributions, you can installed the CodeMeter RunTimeKit
by using the follow command:

Install with:

RPM:   rpm -ihv CodeMeter-4.30-504.i368.rpm
DEB:   dpkg -i  codemeter_4.30.504_i368.deb


If you wish, you can uninstall the CodeMeter RunTimeKit by using:

RPM:   rpm -ev CodeMeter
DEB:   dpkg -r  codemeter
DEB:   dpkg --purge  codemeter


Changes
=======

Latest release note you can receive from:

http://www.wibu.de/download_user.php#cm_lin


Configuration
=============

For configuration, please use the file 'Server.ini' at /etc/wibu/CodeMeter.
The configuration file can only be change if CodeMeterLin is not running.

CodeMeter versions 4.20 and earlier store private data at:
- /etc/wibu/CodeMeter/Server.ini   (configuration)
- /usr/share/CodeMeter/CmFirm.wbc  (specific license data)
- /var/log/CodeMeter               (event log contents)
- /var/backups/CodeMeter           (license backup for CmSticks)
- /var/backups/CmAct               (CodeMeterAct based license files)

CodeMeter version 4.30 and later store private data at:
- /etc/wibu/CodeMeter/Server.ini   (configuration)
- /etc/wibu/CodeMeter/CmFirm.wbc   (specific license data)
- /var/log/CodeMeter               (event log contents)
- /var/lib/CodeMeter/Backup        (license backup for CmSticks)
- /var/lib/CodeMeter/CmAct         (CodeMeterAct based license files)


Problems
========

CodeMeter required for the detection of the CodeMeter-Stick a working 
USB-hotplugging infrastructure. Please ensure that you not have installed
some other software, like special automount daemons, that can make trouble.

For SuSE Linux 9.3 we support a patch for the distribution that hotplugging
will work correctly to fix a bug inside the SuSE hotplugging scripts. The 
bug is commited to SuSE.

For communication between CodeMeterLin and the CmStick, CodeMeterLin
required a linux kernel (kernel 2.4.x or kernel 2.6.x) with support for
usb-mass-storage devices and scsi-generic devices. If you use a self 
compiled linux kernel and some errors will be occured, please check if 
you have activated usb-storage and sg-device support. 

Example for your kernel-config: 
  CONFIG_BLK_DEV_SD=m
  CONFIG_CHR_DEV_SG=m
  CONFIG_SCSI_MULTI_LUN=y

If you use a linux kernel shipped with your linux distribution, then this 
will work fine. 

If you plan to support a CmCard/CF connected on a IDE-Port directly please
note that the linux kernel must support libata2 for this interface, i.e.
the device node should be i.e /dev/sda1. For this your linux kernel 
configuration should include:
  
  CONFIG_IDE=n
  CONFIG_ATA=y


If you want to support access to SD/CF-CodeMeter tokens, you need to install
version 4.10 or higher. Additional read access to /dev/sd* and the corresponding 
/dev/sg* is required. To the /dev/sg* device read and write permissions are 
required. It is recommented to add a section the the /etc/udev/rules to 
setup the permissions to this /dev/sg* or run CodeMeterLin with root permissions.
To run CodeMeterLin with well define permissions, see /etc/init.d/codemeter 
and the definition for "USER=...".


Communication
=============

You CmStick will contains a File with the name "CM-Stick/codemtr.io". This 
file is reserved for the CodeMeter. On Windows based operating systems this
file must exists allways and the partition format must be FAT or NTFS. 
On Linux or MacOS based systems this file can be deleted but it is recommented, 
that the file exists. For the devices CmCard/SD, CmCard/CF and CmCard/uSD the
file codemtr.io must exists on all operation systems, special if you use an
USB card reader.

On Linux or MacOS the CmStick/M can be formated as ext2, ext3, ext4, FAT, NTFS, 
reiserfs, xfs or hfs. 

To repair a missing codemtr.io file for a CmStick/M only replug the device 
on a running Windows OS with installer CodeMeter driver. For CmCard/SD and 
CmCard/CF you can recreate the missing codemtr.io file with your favorit 
text editor. The content of the file is not importand, only that the file exists.


How to report bugs
==================

To report a bug, please send a email to support@wibu.com

Please make sure to include:

* The version of CodeMeter

* Information about your system. For instance:

   - What operating system and version of the kernel you use.
   - What version of the C/C++ library you have installed.
   - What kind of device you use (refer the article number on the case of 
     the CmStick or CmCard/SD i.e. 1001-02 or 1042-04).
   - The type of your USB-subsustem, i.e. USB 1.1 versus USB 2.0.
   - Do you use a USB hub?

  And anything else you think is relevant.

* Since version 4.10 it is recommented to append the output from 
  the command line tool cmu. I.e. call:
  cmu --cmdust --file my_report_output.txt

* Further information such as stack traces may be useful, but
  is not necessary.
