added autogenerated files for easier development checkout

git-svn-id: https://vsmartcard.svn.sourceforge.net/svnroot/vsmartcard@606 96b47cad-a561-4643-ad3b-153ac7d7599c

ccid/doc/README.rst

@@ -0,0 +1,99 @@
+.. highlight:: sh
+
+.. _OpenSC: http://www.opensc-project.org/opensc
+.. _GadgetFS: http://www.linux-usb.org/gadget/
+.. _libccid: http://pcsclite.alioth.debian.org/ccid.html
+
+
+********************************************************************************
+CCID Emulator
+********************************************************************************
+
+:Author:
+    Frank Morgner <morgner@informatik.hu-berlin.de>
+:License:
+    GPL version 3
+:Tested Platforms:
+    Linux (Debian, Ubuntu, OpenMoko)
+
+Welcome to the CCID Emulator.  The purpose of the CCID Emulator is to forward a PCSC
+smartcard reader as a standard USB CCID reader. If the host system is in USB
+device mode, the CCID Emulator forwards the local reader via USB to another
+device. If in USB host mode, the CCID Emulator virtually plugges in a USB CCID
+reader to the host system.  the CCID Emulator has support for Password
+Authenticated Connection Establishment (PACE) using OpenPACE
+(http://sourceforge.net/projects/openpace/).
+
+The CCID Emulator is implemented using GadgetFS_. Some fragments of the source code
+are based on the GadgetFS example and on the source code of the OpenSC_ tools.
+
+
+.. include:: autotools.rst
+
+The CCID Emulator following dependencies:
+
+- Linux Kernel with GadgetFS_
+- OpenSC_
+- :ref:`npa` (only if support for PACE is enabled)
+
+
+-----------------
+Hints on GadgetFS
+-----------------
+
+To create an USB Gadget in both USB host and USB client mode, you need to load
+the kernel module :program:`gadgetfs`. A guide focused on Debian based systems to run
+and compile :program:`gadgetfs`, you can find `here
+<http://wiki.openmoko.org/wiki/Building_Gadget_USB_Module>`_.
+
+On OpenMoko it is likely that you need to `patch your kernel
+<http://docs.openmoko.org/trac/ticket/2206>`_. If you also want to switch
+multiple times between :program:`gadgetfs` and :program:`g_ether`, `another patch is needed
+<http://docs.openmoko.org/trac/ticket/2240)>`_.
+
+If you are using a more recent version of :program:`dummy_hcd` and get an error
+loading the module, you maybe want to check out `this patch
+<http://comments.gmane.org/gmane.linux.usb.general/47440>`_.
+
+
+---------------
+Hints on OpenSC
+---------------
+
+Without :ref:`npa` the CCID Emulator links against libopensc, which is discouraged and hindered since OpenSC
+version >= 0.12. (We really need to get rid of this dependency or integrate
+better into the OpenSC-framework.) You need the OpenSC components to be
+installed (especially :file:`libopensc.so`). Here is an example of how to get the
+standard installation of OpenSC_::
+
+    PREFIX=/tmp/install
+    OPENSC=opensc
+    svn co http://www.opensc-project.org/svn/opensc/trunk $OPENSC
+    cd $OPENSC
+    autoreconf -i
+    ./configure --prefix=$PREFIX
+    make
+    make install
+
+Now :file:`libopensc.so` should be located in ``$PREFIX/lib``. Here is how to
+configure the CCID Emulator to use it::
+
+    ./configure OPENSC_LIBS="-L$PREFIX/lib -lopensc"
+
+
+=====
+Usage
+=====
+
+The CCID Emulator has various command line options to customize the appearance on
+the USB host. In order to run the CCID Emulator GadgetFS_ must be loaded and
+mounted.  The CCID Emulator is compatible with the unix driver libccid_ and the
+windows smart card driver. To initialize PACE using the PC/SC API you need to
+patch libccid and pcsc-lite (see directory patches).
+
+cats-test can be used to test the PACE capabilities of a smart card reader with
+PACE support (such as the CCID Emulator or any other "Standardleser" CAT-S or
+"Komfortleser" CAT-C) via PC/SC.
+
+
+.. include:: questions.rst

ccid/doc/autotools.rst

@@ -0,0 +1,20 @@
+.. highlight:: sh
+
+=============
+Installation
+=============
+
+The CCID Emulator uses the GNU Build System to compile and install. If you are
+unfamiliar with it, please have a look at :file:`INSTALL`. If you have a look
+around and can not find it, you are probably working bleeding edge in the
+repository.  Run the following command in :file:`ccid-emulator` to
+get the missing standard auxiliary files::
+    
+    autoreconf -i
+
+To configure (:command:`configure --help` lists possible options), build and
+install the CCID Emulator now do the following::
+    
+    ./configure
+    make
+    make install

ccid/doc/questions.rst

@@ -0,0 +1,6 @@
+========
+Question
+========
+
+Do you have questions, suggestions or contributions? Feedback of any kind is
+more than welcome! Please use our `project trackers <http://sourceforge.net/projects/vsmartcard/support>`_.