From daf8dded635ae9a5e2f5afa9815e05c1ab56f7fb Mon Sep 17 00:00:00 2001 From: oepen Date: Wed, 12 Oct 2011 12:30:40 +0000 Subject: [PATCH] Converted ccid documentation to reStructuredText git-svn-id: https://vsmartcard.svn.sourceforge.net/svnroot/vsmartcard@544 96b47cad-a561-4643-ad3b-153ac7d7599c --- ccid/README.dox | 34 ++++++++++++++++++++-------------- doc/ccid.rst | 1 + doc/index.rst | 1 + 3 files changed, 22 insertions(+), 14 deletions(-) create mode 120000 doc/ccid.rst diff --git a/ccid/README.dox b/ccid/README.dox index b49d1e0..e140f82 100644 --- a/ccid/README.dox +++ b/ccid/README.dox @@ -1,4 +1,6 @@ -/** @mainpage +************* +ccid-emulator +************* Welcome to ccid-emulator. The purpose of ccid-emulator is to forward a PCSC smartcard reader as a standard USB CCID reader. If the host system is in USB @@ -12,13 +14,15 @@ ccid-emulator is implemented using GadgetFS. Some fragments of the source code are based on the GadgetFS example at http://www.linux-usb.org/gadget/ and on the source code of the OpenSC tools. - -@section i INSTALLATION +============= +Installation +============= See file INSTALL. - -@subsection g HINTS ON GADGETFS +------------------ +Hints of GadgetFS +------------------ To create an USB Gadget in both USB host and USB client mode, you need to load the kernel module gadgetfs. A guide focused on Debian based systems to run and @@ -34,18 +38,19 @@ If you are using a more recent version of dummy_hcd, you maybe want to check out this patch: http://comments.gmane.org/gmane.linux.usb.general/47440 - -@subsection o HINTS ON OPENSC +--------------- +Hints on OpenSC +--------------- Without libnpa ccid-emulator links against libopensc, which is discouraged and hindered since opensc>=0.12. We really need to get rid of this dependency. You need the opensc components to be installed (especially libopensc.so). But you might need to adjust the opensc library flags: -./configure \ - OPENSC_LIBS="-L/path/to/opensc/libdir -lopensc" +``./configure OPENSC_LIBS="-L/path/to/opensc/libdir -lopensc"`` - -@section u USAGE +===== +Usage +===== ccid-emulator has various command line options to customize the appearance on the USB host. In order to run ccid-emulator GadgetFS must be loaded and mounted. @@ -57,9 +62,10 @@ cats-test can be used to test the PACE capabilities of a smart card reader with PACE support (such as ccid-emulator or any other "Standardleser" CAT-S or "Komfortleser" CAT-C) via PC/SC. +========= +Questions +========= -@section q QUESTIONS For questions, please use http://sourceforge.net/projects/vsmartcard/support -@author Frank Morgner -*/ +.. @author Frank Morgner diff --git a/doc/ccid.rst b/doc/ccid.rst new file mode 120000 index 0000000..a8f0870 --- /dev/null +++ b/doc/ccid.rst @@ -0,0 +1 @@ +../ccid/README \ No newline at end of file diff --git a/doc/index.rst b/doc/index.rst index 82884de..ff49683 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -11,6 +11,7 @@ Contents: .. toctree:: :maxdepth: 2 + ccid Lorem ipsum