From fc80b5042fa1f3147786c86d3507a87913b2c75a Mon Sep 17 00:00:00 2001 From: frankmorgner Date: Sat, 29 Oct 2011 22:44:51 +0000 Subject: [PATCH] more autotool magic git-svn-id: https://vsmartcard.svn.sourceforge.net/svnroot/vsmartcard@599 96b47cad-a561-4643-ad3b-153ac7d7599c --- ccid/doc/Makefile.am | 3 +- ccid/doc/{README.rst => README.rst.in} | 30 +++++++++---------- npa/doc/Makefile.am | 3 +- npa/doc/{README.rst => README.rst.in} | 20 ++++++------- pcsc-relay/doc/Makefile.am | 3 +- pcsc-relay/doc/{README.rst => README.rst.in} | 6 ++-- virtualsmartcard/doc/Makefile.am | 3 +- .../doc/{README.rst => README.rst.in} | 14 ++++----- 8 files changed, 43 insertions(+), 39 deletions(-) rename ccid/doc/{README.rst => README.rst.in} (69%) rename npa/doc/{README.rst => README.rst.in} (84%) rename pcsc-relay/doc/{README.rst => README.rst.in} (91%) rename virtualsmartcard/doc/{README.rst => README.rst.in} (82%) diff --git a/ccid/doc/Makefile.am b/ccid/doc/Makefile.am index c63bb07..210db12 100644 --- a/ccid/doc/Makefile.am +++ b/ccid/doc/Makefile.am @@ -13,9 +13,10 @@ do_subst = sed \ -e 's,[@]OPENSC_LIBS[@],$(OPENSC_LIBS),g' \ -e 's,[@]top_srcdir[@],$(top_srcdir),g' -EXTRA_DIST = README.rst autotools.rst autotools.rst.in questions.rst questions.rst.in +EXTRA_DIST = README.rst.in README.rst autotools.rst autotools.rst.in questions.rst questions.rst.in .PHONY: doc doc: $(do_subst) < autotools.rst.in > autotools.rst $(do_subst) < questions.rst.in > questions.rst + $(do_subst) < README.rst.in > README.rst diff --git a/ccid/doc/README.rst b/ccid/doc/README.rst.in similarity index 69% rename from ccid/doc/README.rst rename to ccid/doc/README.rst.in index 2b5532e..028373f 100644 --- a/ccid/doc/README.rst +++ b/ccid/doc/README.rst.in @@ -5,9 +5,9 @@ .. _libccid: http://pcsclite.alioth.debian.org/ccid.html -************* -ccid-emulator -************* +******************************************************************************** +@PACKAGE_NAME@ +******************************************************************************** :Author: Frank Morgner @@ -16,21 +16,21 @@ ccid-emulator :Tested Platforms: Linux (Debian, Ubuntu, OpenMoko) -Welcome to ccid-emulator. The purpose of ccid-emulator is to forward a PCSC +Welcome to the @PACKAGE_NAME@. The purpose of the @PACKAGE_NAME@ is to forward a PCSC smartcard reader as a standard USB CCID reader. If the host system is in USB -device mode, ccid-emulator forwards the local reader via USB to another -device. If in USB host mode, ccid-emulator virtually plugges in a USB CCID -reader to the host system. ccid-emulator has support for Password +device mode, the @PACKAGE_NAME@ forwards the local reader via USB to another +device. If in USB host mode, the @PACKAGE_NAME@ virtually plugges in a USB CCID +reader to the host system. the @PACKAGE_NAME@ has support for Password Authenticated Connection Establishment (PACE) using OpenPACE (http://sourceforge.net/projects/openpace/). -ccid-emulator is implemented using GadgetFS_. Some fragments of the source code +The @PACKAGE_NAME@ 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 -ccid as the following dependencies: +The @PACKAGE_NAME@ following dependencies: - Linux Kernel with GadgetFS_ - OpenSC_ @@ -60,7 +60,7 @@ loading the module, you maybe want to check out `this patch Hints on OpenSC --------------- -Without libnpa ccid-emulator links against libopensc, which is discouraged and hindered since OpenSC +Without :ref:`npa` the @PACKAGE_NAME@ 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 @@ -76,7 +76,7 @@ standard installation of OpenSC_:: make install Now :file:`libopensc.so` should be located in ``$PREFIX/lib``. Here is how to -configure ccid-emulator to use it:: +configure the @PACKAGE_NAME@ to use it:: ./configure OPENSC_LIBS="-L$PREFIX/lib -lopensc" @@ -85,14 +85,14 @@ configure ccid-emulator to use it:: 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. ccid-emulator is compatible with the unix driver libccid_ and the +The @PACKAGE_NAME@ has various command line options to customize the appearance on +the USB host. In order to run the @PACKAGE_NAME@ GadgetFS_ must be loaded and +mounted. The @PACKAGE_NAME@ 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 ccid-emulator or any other "Standardleser" CAT-S or +PACE support (such as the @PACKAGE_NAME@ or any other "Standardleser" CAT-S or "Komfortleser" CAT-C) via PC/SC. diff --git a/npa/doc/Makefile.am b/npa/doc/Makefile.am index 15d4641..12a05a5 100644 --- a/npa/doc/Makefile.am +++ b/npa/doc/Makefile.am @@ -13,7 +13,7 @@ do_subst = sed \ -e 's,[@]OPENSC_LIBS[@],$(OPENSC_LIBS),g' \ -e 's,[@]top_srcdir[@],$(top_srcdir),g' -EXTRA_DIST = README.rst Doxyfile.in example.c autotools.rst autotools.rst.in questions.rst questions.rst.in +EXTRA_DIST = README.rst.in README.rst Doxyfile.in example.c autotools.rst autotools.rst.in questions.rst questions.rst.in .PHONY: doc doc: @@ -22,3 +22,4 @@ doc: touch api.rst $(do_subst) < autotools.rst.in > autotools.rst $(do_subst) < questions.rst.in > questions.rst + $(do_subst) < README.rst.in > README.rst diff --git a/npa/doc/README.rst b/npa/doc/README.rst.in similarity index 84% rename from npa/doc/README.rst rename to npa/doc/README.rst.in index d0b5374..d95ae44 100644 --- a/npa/doc/README.rst +++ b/npa/doc/README.rst.in @@ -6,9 +6,9 @@ .. _npa: -*** -npa -*** +******************************************************************************** +@PACKAGE_NAME@ +******************************************************************************** :Author: Frank Morgner @@ -17,11 +17,11 @@ npa :Tested Platforms: Linux (Debian, Ubuntu, OpenMoko) -Welcome to npa. The purpose of npa is to offer an easy to use API for the new +Welcome to the @PACKAGE_NAME@. The purpose of the @PACKAGE_NAME@ is to offer an easy to use API for the new German identity card (neuer Personalausweis, nPA). The library also implements secure messaging, which could also be used for other cards. -npa is implemented using OpenPACE_. +The @PACKAGE_NAME@ is implemented using OpenPACE_. Some fragments of the source code are based on the source code of the OpenSC tools. The included npa-tool has support for Password Authenticated Connection @@ -33,7 +33,7 @@ APDUs inside a secure messaging channel established with PACE. .. include:: autotools.rst -npa has the following dependencies: +The @PACKAGE_NAME@ has the following dependencies: - OpenSC_ - OpenSSL with OpenPACE_ @@ -57,9 +57,9 @@ an example of how to get the standard installation of OpenSSL with OpenPACE_:: make make install -Building npa with OpenPACE_ is done best using :command:`pkg-config`. The file +Building the @PACKAGE_NAME@ with OpenPACE_ is done best using :command:`pkg-config`. The file :file:`libcrypto.pc` should be located in ``$INSTALL/lib/pkgconfig``. Here is how -to configure npa to use it:: +to configure the @PACKAGE_NAME@ to use it:: ./configure PKG_CONFIG_PATH=$PREFIX/lib/pkgconfig @@ -85,7 +85,7 @@ standard installation of OpenSC_:: make install Now :file:`libopensc.so` should be located in ``$PREFIX/lib``. Here is how to -configure npa to use it:: +configure the @PACKAGE_NAME@ to use it:: ./configure OPENSC_LIBS="-L$PREFIX/lib -lopensc" @@ -111,7 +111,7 @@ Linking against libnpa ---------------------- Following the section `Installation`_ above, you have installed OpenSC_, -OpenPACE_ and npa to :file:`/tmp/install`. To compile a program using libnpa you +OpenPACE_ and the @PACKAGE_NAME@ to :file:`/tmp/install`. To compile a program using libnpa you need to get the header files from OpenSC_ as well. Here is how to compile an external program with these libraries:: diff --git a/pcsc-relay/doc/Makefile.am b/pcsc-relay/doc/Makefile.am index 34da66b..8752989 100644 --- a/pcsc-relay/doc/Makefile.am +++ b/pcsc-relay/doc/Makefile.am @@ -13,9 +13,10 @@ do_subst = sed \ -e 's,[@]OPENSC_LIBS[@],$(OPENSC_LIBS),g' \ -e 's,[@]top_srcdir[@],$(top_srcdir),g' -EXTRA_DIST = README.rst autotools.rst.in questions.rst.in autotools.rst questions.rst +EXTRA_DIST = README.rst.in README.rst autotools.rst.in questions.rst.in autotools.rst questions.rst .PHONY: doc doc: $(do_subst) < autotools.rst.in > autotools.rst $(do_subst) < questions.rst.in > questions.rst + $(do_subst) < README.rst.in > README.rst diff --git a/pcsc-relay/doc/README.rst b/pcsc-relay/doc/README.rst.in similarity index 91% rename from pcsc-relay/doc/README.rst rename to pcsc-relay/doc/README.rst.in index 79a0a24..72e9562 100644 --- a/pcsc-relay/doc/README.rst +++ b/pcsc-relay/doc/README.rst.in @@ -4,9 +4,9 @@ .. _PCSC-lite: http://pcsclite.alioth.debian.org/ -********** -pcsc-relay -********** +******************************************************************************** +@PACKAGE_NAME@ +******************************************************************************** :Authors: - Dominik Oepen diff --git a/virtualsmartcard/doc/Makefile.am b/virtualsmartcard/doc/Makefile.am index 218edd7..10e8311 100644 --- a/virtualsmartcard/doc/Makefile.am +++ b/virtualsmartcard/doc/Makefile.am @@ -15,7 +15,7 @@ do_subst = sed \ -e 's,[@]OPENSC_LIBS[@],$(OPENSC_LIBS),g' \ -e 's,[@]top_srcdir[@],$(top_srcdir),g' -EXTRA_DIST = README.rst autotools.rst.in questions.rst.in autotools.rst questions.rst +EXTRA_DIST = README.rst.in README.rst autotools.rst.in questions.rst.in autotools.rst questions.rst dist_noinst_SCRIPTS = generate_modules.py @@ -23,4 +23,5 @@ dist_noinst_SCRIPTS = generate_modules.py doc: $(do_subst) < autotools.rst.in > autotools.rst $(do_subst) < questions.rst.in > questions.rst + $(do_subst) < README.rst.in > README.rst ./generate_modules.py $(top_srcdir)/src/vpicc --dest-dir=api --suffix=rst --no-toc -1 diff --git a/virtualsmartcard/doc/README.rst b/virtualsmartcard/doc/README.rst.in similarity index 82% rename from virtualsmartcard/doc/README.rst rename to virtualsmartcard/doc/README.rst.in index d6f0850..6bf81ef 100644 --- a/virtualsmartcard/doc/README.rst +++ b/virtualsmartcard/doc/README.rst.in @@ -13,9 +13,9 @@ .. |vpcd| replace:: :abbr:`vpcd (virtual smart card reader)` -****************** -Virtual Smart Card -****************** +******************************************************************************** +@PACKAGE_NAME@ +******************************************************************************** :Authors: - Frank Morgner @@ -26,7 +26,7 @@ Virtual Smart Card - Linux (Debian, Ubuntu, OpenMoko) - Windows (only |vpicc|, not |vpcd|) -Welcome to virtualsmartcard. The purpose of virtualsmartcard is to emulate a +Welcome to the @PACKAGE_NAME@. The purpose of the @PACKAGE_NAME@ is to emulate a smart card and make it accessible through PCSC. Currently the virtual smart card supports almost all commands of ISO-7816 including secure messaging. Besides a plain ISO-7816 smart card it is also possible to emulate a German @@ -55,9 +55,9 @@ The |vpcd| has the following dependencies: - PCSC-Lite_ -======================== -Running virtualsmartcard -======================== +================================================================================ +Running the @PACKAGE_NAME@ +================================================================================ First you need to make sure that pcscd loads the |vpcd|. You might need to run :command:`update-reader.conf` to update pcscd's configuration file. Then