From 59eaa16c45746fac1875db8c874c5517f9785b34 Mon Sep 17 00:00:00 2001 From: Frank Morgner Date: Sun, 16 Jun 2013 09:58:07 +0200 Subject: [PATCH] include a summary in documentation and tools --- ccid/configure.ac | 4 ++++ ccid/doc/Makefile.am | 1 + ccid/doc/README.txt | 16 ++++++++++------ ccid/doc/README.txt.in | 16 ++++++++++------ ccid/src/Makefile.am | 1 + ccid/src/ccid-emulator.ggo.in | 2 +- npa/configure.ac | 2 ++ npa/doc/Makefile.am | 1 + npa/doc/README.txt | 20 +++++++++++--------- npa/doc/README.txt.in | 20 +++++++++++--------- npa/doc/api.txt | 2 +- npa/src/Makefile.am | 3 ++- npa/src/npa-tool.ggo.in | 2 +- pcsc-relay/configure.ac | 5 +++++ pcsc-relay/doc/Makefile.am | 1 + pcsc-relay/doc/README.txt | 22 ++++++++++++---------- pcsc-relay/doc/README.txt.in | 22 ++++++++++++---------- pcsc-relay/src/Makefile.am | 1 + pcsc-relay/src/pcsc-relay.ggo.in | 2 +- virtualsmartcard/configure.ac | 4 ++++ virtualsmartcard/doc/Makefile.am | 1 + virtualsmartcard/doc/README.txt | 22 ++++++++++++---------- virtualsmartcard/doc/README.txt.in | 22 ++++++++++++---------- virtualsmartcard/src/vpicc/Makefile.am | 1 + virtualsmartcard/src/vpicc/vicc.in | 2 +- 25 files changed, 119 insertions(+), 76 deletions(-) diff --git a/ccid/configure.ac b/ccid/configure.ac index 13df1f2..0bfd8ee 100644 --- a/ccid/configure.ac +++ b/ccid/configure.ac @@ -113,6 +113,10 @@ AM_CONDITIONAL(WITH_PACE, test "${WITH_PACE}" = "yes") AM_COND_IF(WITH_PACE, [AC_DEFINE(WITH_PACE, 1, [enable PACE support])]) +PACKAGE_SUMMARY="Emulate a USB CCID compliant smart card reader" +AC_SUBST(PACKAGE_SUMMARY) + + # Checks for header files. AC_CHECK_HEADERS([arpa/inet.h fcntl.h memory.h stdint.h stdlib.h string.h sys/ioctl.h unistd.h]) diff --git a/ccid/doc/Makefile.am b/ccid/doc/Makefile.am index d31d6bf..3f9918e 100644 --- a/ccid/doc/Makefile.am +++ b/ccid/doc/Makefile.am @@ -4,6 +4,7 @@ do_subst = $(SED) \ -e 's,[@]PACKAGE_TARNAME[@],$(PACKAGE_TARNAME),g' \ -e 's,[@]PACKAGE_BUGREPORT[@],$(PACKAGE_BUGREPORT),g' \ -e 's,[@]PACKAGE_URL[@],$(PACKAGE_URL),g' \ + -e 's,[@]PACKAGE_SUMMARY[@],$(PACKAGE_SUMMARY),g' \ -e 's,[@]PACKAGE_VERSION[@],$(PACKAGE_VERSION),g' \ -e 's,[@]RECOMMENDED_CONF_OPTS[@],,g' \ -e 's,[@]builddir[@],$(builddir),g' \ diff --git a/ccid/doc/README.txt b/ccid/doc/README.txt index 5f1e35a..ce64179 100644 --- a/ccid/doc/README.txt +++ b/ccid/doc/README.txt @@ -9,12 +9,16 @@ USB CCID Emulator ################################################################################ -:Author: - `Frank Morgner `_ -:License: - GPL version 3 -:Tested Platforms: - Linux (Debian, Ubuntu, OpenMoko) +.. sidebar:: Summary + + Emulate a USB CCID compliant smart card reader + + :Author: + `Frank Morgner `_ + :License: + GPL version 3 + :Tested Platforms: + Linux (Debian, Ubuntu, OpenMoko) The USB CCID Emulator forwards a locally present PC/SC smart card reader as a standard USB CCID reader. USB CCID Emulator can be used as trusted intermediary diff --git a/ccid/doc/README.txt.in b/ccid/doc/README.txt.in index 3a9a1f2..f640533 100644 --- a/ccid/doc/README.txt.in +++ b/ccid/doc/README.txt.in @@ -9,12 +9,16 @@ @PACKAGE_NAME@ ################################################################################ -:Author: - `Frank Morgner `_ -:License: - GPL version 3 -:Tested Platforms: - Linux (Debian, Ubuntu, OpenMoko) +.. sidebar:: Summary + + @PACKAGE_SUMMARY@ + + :Author: + `Frank Morgner `_ + :License: + GPL version 3 + :Tested Platforms: + Linux (Debian, Ubuntu, OpenMoko) The @PACKAGE_NAME@ forwards a locally present PC/SC smart card reader as a standard USB CCID reader. @PACKAGE_NAME@ can be used as trusted intermediary diff --git a/ccid/src/Makefile.am b/ccid/src/Makefile.am index 0c8d369..8b76652 100644 --- a/ccid/src/Makefile.am +++ b/ccid/src/Makefile.am @@ -4,6 +4,7 @@ do_subst = $(SED) \ -e 's,[@]PACKAGE_TARNAME[@],$(PACKAGE_TARNAME),g' \ -e 's,[@]PACKAGE_BUGREPORT[@],$(PACKAGE_BUGREPORT),g' \ -e 's,[@]PACKAGE_URL[@],$(PACKAGE_URL),g' \ + -e 's,[@]PACKAGE_SUMMARY[@],$(PACKAGE_SUMMARY),g' \ -e 's,[@]PACKAGE_VERSION[@],$(PACKAGE_VERSION),g' BUILT_SOURCES = cmdline.h cmdline.c diff --git a/ccid/src/ccid-emulator.ggo.in b/ccid/src/ccid-emulator.ggo.in index caaf383..d0ffbe1 100644 --- a/ccid/src/ccid-emulator.ggo.in +++ b/ccid/src/ccid-emulator.ggo.in @@ -1,4 +1,4 @@ -purpose "Access the German electronic identity card (neuer Personalausweis, nPA)" +purpose "@PACKAGE_SUMMARY@" option "info" i "Print available readers and drivers." diff --git a/npa/configure.ac b/npa/configure.ac index 46799b1..f97c781 100644 --- a/npa/configure.ac +++ b/npa/configure.ac @@ -140,6 +140,8 @@ X509DIR="${x509dir}" AC_SUBST(X509DIR) +PACKAGE_SUMMARY="Access the German electronic identity card (neuer Personalausweis/nPA)" +AC_SUBST(PACKAGE_SUMMARY) # Checks for header files. diff --git a/npa/doc/Makefile.am b/npa/doc/Makefile.am index d7c97dc..bf5942d 100644 --- a/npa/doc/Makefile.am +++ b/npa/doc/Makefile.am @@ -4,6 +4,7 @@ do_subst = $(SED) \ -e 's,[@]PACKAGE_TARNAME[@],$(PACKAGE_TARNAME),g' \ -e 's,[@]PACKAGE_BUGREPORT[@],$(PACKAGE_BUGREPORT),g' \ -e 's,[@]PACKAGE_URL[@],$(PACKAGE_URL),g' \ + -e 's,[@]PACKAGE_SUMMARY[@],$(PACKAGE_SUMMARY),g' \ -e 's,[@]PACKAGE_VERSION[@],$(PACKAGE_VERSION),g' \ -e 's,[@]RECOMMENDED_CONF_OPTS[@],,g' \ -e 's,[@]builddir[@],$(builddir),g' \ diff --git a/npa/doc/README.txt b/npa/doc/README.txt index 4fe8eda..b6a475e 100644 --- a/npa/doc/README.txt +++ b/npa/doc/README.txt @@ -13,15 +13,17 @@ nPA Smart Card Library ################################################################################ -:Author: - `Frank Morgner `_ -:License: - GPL version 3 -:Tested Platforms: - - Windows - - Linux (Debian, Ubuntu, OpenMoko) -:Potential Platforms: - Unix-like operating systems (Mac OS, Solaris, BSD, ...) +.. sidebar:: Summary + + Access the German electronic identity card (neuer Personalausweis/nPA) + + :Author: + `Frank Morgner `_ + :License: + GPL version 3 + :Tested Platforms: + - Windows + - Linux (Debian, Ubuntu, OpenMoko) The nPA Smart Card Library offers an easy to use API for the new German identity card (neuer Personalausweis, nPA). The library also implements secure messaging, diff --git a/npa/doc/README.txt.in b/npa/doc/README.txt.in index 97cf71d..db553d4 100644 --- a/npa/doc/README.txt.in +++ b/npa/doc/README.txt.in @@ -13,15 +13,17 @@ @PACKAGE_NAME@ ################################################################################ -:Author: - `Frank Morgner `_ -:License: - GPL version 3 -:Tested Platforms: - - Windows - - Linux (Debian, Ubuntu, OpenMoko) -:Potential Platforms: - Unix-like operating systems (Mac OS, Solaris, BSD, ...) +.. sidebar:: Summary + + @PACKAGE_SUMMARY@ + + :Author: + `Frank Morgner `_ + :License: + GPL version 3 + :Tested Platforms: + - Windows + - Linux (Debian, Ubuntu, OpenMoko) The @PACKAGE_NAME@ offers an easy to use API for the new German identity card (neuer Personalausweis, nPA). The library also implements secure messaging, diff --git a/npa/doc/api.txt b/npa/doc/api.txt index 3c21fd2..c58b4d0 100644 --- a/npa/doc/api.txt +++ b/npa/doc/api.txt @@ -29,7 +29,7 @@ used to read identity attributes, for example. .. note:: Please consider the following overview to the API as incomplete. The `Doxygen documentation <../_static/doxygen-npa/modules.html>`_ should be - used as programmer's. + used as programmer's reference. ============================================================== diff --git a/npa/src/Makefile.am b/npa/src/Makefile.am index 4679bc2..2fe8dbb 100644 --- a/npa/src/Makefile.am +++ b/npa/src/Makefile.am @@ -5,7 +5,8 @@ do_subst = $(SED) \ -e 's,[@]PACKAGE_NAME[@],$(PACKAGE_NAME),g' \ -e 's,[@]PACKAGE_TARNAME[@],$(PACKAGE_TARNAME),g' \ -e 's,[@]PACKAGE_URL[@],$(PACKAGE_URL),g' \ - -e 's,[@]PACKAGE_VERSION[@],$(PACKAGE_VERSION),g' \ + -e 's,[@]PACKAGE_SUMMARY[@],$(PACKAGE_SUMMARY),g' \ + -e 's,[@]PACKAGE_VERSION[@],"$(PACKAGE_VERSION)",g' \ -e 's,[@]X509DIR[@],$(X509DIR),g' BUILT_SOURCES = cmdline.h cmdline.c diff --git a/npa/src/npa-tool.ggo.in b/npa/src/npa-tool.ggo.in index 6883877..243c0c1 100644 --- a/npa/src/npa-tool.ggo.in +++ b/npa/src/npa-tool.ggo.in @@ -1,5 +1,5 @@ package "npa-tool" -purpose "Access the German electronic identity card (neuer Personalausweis, nPA)" +purpose "@PACKAGE_SUMMARY@" option "info" i "Print available readers and drivers." diff --git a/pcsc-relay/configure.ac b/pcsc-relay/configure.ac index 49c386d..21275fe 100644 --- a/pcsc-relay/configure.ac +++ b/pcsc-relay/configure.ac @@ -78,6 +78,11 @@ AC_ARG_ENABLE(piccdev, [piccdev="${enableval}"], [piccdev="/dev/ttyACM0"]) AC_DEFINE_UNQUOTED(PICCDEV, "${piccdev}", [OpenPICC character device]) + +PACKAGE_SUMMARY="Relay a smart card to a contactless interface" +AC_SUBST(PACKAGE_SUMMARY) + + # Checks for header files. AC_CHECK_HEADERS([fcntl.h stdint.h stdlib.h string.h unistd.h termios.h]) diff --git a/pcsc-relay/doc/Makefile.am b/pcsc-relay/doc/Makefile.am index 9763cc4..ca597a2 100644 --- a/pcsc-relay/doc/Makefile.am +++ b/pcsc-relay/doc/Makefile.am @@ -4,6 +4,7 @@ do_subst = $(SED) \ -e 's,[@]PACKAGE_TARNAME[@],$(PACKAGE_TARNAME),g' \ -e 's,[@]PACKAGE_BUGREPORT[@],$(PACKAGE_BUGREPORT),g' \ -e 's,[@]PACKAGE_URL[@],$(PACKAGE_URL),g' \ + -e 's,[@]PACKAGE_SUMMARY[@],$(PACKAGE_SUMMARY),g' \ -e 's,[@]PACKAGE_VERSION[@],$(PACKAGE_VERSION),g' \ -e 's,[@]RECOMMENDED_CONF_OPTS[@],,g' \ -e 's,[@]builddir[@],$(builddir),g' \ diff --git a/pcsc-relay/doc/README.txt b/pcsc-relay/doc/README.txt index 2e1e1a5..0179aa4 100644 --- a/pcsc-relay/doc/README.txt +++ b/pcsc-relay/doc/README.txt @@ -6,16 +6,18 @@ PC/SC Relay ################################################################################ -:Authors: - - `Frank Morgner `_ - - `Dominik Oepen `_ -:License: - GPL version 3 -:Tested Platforms: - - Windows - - Linux (Debian, Ubuntu, OpenMoko) -:Potential Platforms: - Unix-like operating systems (Mac OS, Solaris, BSD, ...) +.. sidebar:: Summary + + Relay a smart card to a contactless interface + + :Authors: + - `Frank Morgner `_ + - `Dominik Oepen `_ + :License: + GPL version 3 + :Tested Platforms: + - Windows + - Linux (Debian, Ubuntu, OpenMoko) Welcome to PC/SC Relay. The purpose of PC/SC Relay is to relay a smart card using an contact-less interface. Currently the following contact-less diff --git a/pcsc-relay/doc/README.txt.in b/pcsc-relay/doc/README.txt.in index 6d8cec8..196d268 100644 --- a/pcsc-relay/doc/README.txt.in +++ b/pcsc-relay/doc/README.txt.in @@ -6,16 +6,18 @@ @PACKAGE_NAME@ ################################################################################ -:Authors: - - `Frank Morgner `_ - - `Dominik Oepen `_ -:License: - GPL version 3 -:Tested Platforms: - - Windows - - Linux (Debian, Ubuntu, OpenMoko) -:Potential Platforms: - Unix-like operating systems (Mac OS, Solaris, BSD, ...) +.. sidebar:: Summary + + @PACKAGE_SUMMARY@ + + :Authors: + - `Frank Morgner `_ + - `Dominik Oepen `_ + :License: + GPL version 3 + :Tested Platforms: + - Windows + - Linux (Debian, Ubuntu, OpenMoko) Welcome to @PACKAGE_NAME@. The purpose of @PACKAGE_NAME@ is to relay a smart card using an contact-less interface. Currently the following contact-less diff --git a/pcsc-relay/src/Makefile.am b/pcsc-relay/src/Makefile.am index 66dde64..6a83ce3 100644 --- a/pcsc-relay/src/Makefile.am +++ b/pcsc-relay/src/Makefile.am @@ -4,6 +4,7 @@ do_subst = $(SED) \ -e 's,[@]PACKAGE_TARNAME[@],$(PACKAGE_TARNAME),g' \ -e 's,[@]PACKAGE_BUGREPORT[@],$(PACKAGE_BUGREPORT),g' \ -e 's,[@]PACKAGE_URL[@],$(PACKAGE_URL),g' \ + -e 's,[@]PACKAGE_SUMMARY[@],$(PACKAGE_SUMMARY),g' \ -e 's,[@]PACKAGE_VERSION[@],$(PACKAGE_VERSION),g' BUILT_SOURCES = cmdline.h cmdline.c diff --git a/pcsc-relay/src/pcsc-relay.ggo.in b/pcsc-relay/src/pcsc-relay.ggo.in index 464edb0..169ecb5 100644 --- a/pcsc-relay/src/pcsc-relay.ggo.in +++ b/pcsc-relay/src/pcsc-relay.ggo.in @@ -1,4 +1,4 @@ -purpose "Emulate a contact-less smart card" +purpose "@PACKAGE_SUMMARY@" description "Using an contact-less interface (currently OpenPICC or libnfc) @PACKAGE@ receives command APDUs which are forwared to an existing smart card via PC/SC. @PACKAGE@ sends the response APDU back to the contact-less interface." option "emulator" e diff --git a/virtualsmartcard/configure.ac b/virtualsmartcard/configure.ac index fd9d2ce..ccfa68e 100644 --- a/virtualsmartcard/configure.ac +++ b/virtualsmartcard/configure.ac @@ -81,6 +81,10 @@ AC_ARG_ENABLE(confdir, [confdir="${enableval}"], [confdir=/etc/reader.conf.d]) +PACKAGE_SUMMARY="Smart card emulator written in Python" +AC_SUBST(PACKAGE_SUMMARY) + + # Checks for header files. AC_CHECK_HEADERS([arpa/inet.h stdint.h stdlib.h string.h sys/socket.h sys/time.h unistd.h]) diff --git a/virtualsmartcard/doc/Makefile.am b/virtualsmartcard/doc/Makefile.am index 44326d3..d138143 100644 --- a/virtualsmartcard/doc/Makefile.am +++ b/virtualsmartcard/doc/Makefile.am @@ -5,6 +5,7 @@ do_subst = $(SED) \ -e 's,[@]PACKAGE_TARNAME[@],$(PACKAGE_TARNAME),g' \ -e 's,[@]PACKAGE_BUGREPORT[@],$(PACKAGE_BUGREPORT),g' \ -e 's,[@]PACKAGE_URL[@],$(PACKAGE_URL),g' \ + -e 's,[@]PACKAGE_SUMMARY[@],$(PACKAGE_SUMMARY),g' \ -e 's,[@]PACKAGE_VERSION[@],$(PACKAGE_VERSION),g' \ -e 's,[@]RECOMMENDED_CONF_OPTS[@], --sysconfdir=/etc,g' \ -e 's,[@]builddir[@],$(builddir),g' \ diff --git a/virtualsmartcard/doc/README.txt b/virtualsmartcard/doc/README.txt index d701b28..d22aa37 100644 --- a/virtualsmartcard/doc/README.txt +++ b/virtualsmartcard/doc/README.txt @@ -14,16 +14,18 @@ Virtual Smart Card ################################################################################ -:Authors: - - `Frank Morgner `_ - - `Dominik Oepen `_ -:License: - GPL version 3 -:Tested Platforms: - - Linux (Debian, Ubuntu, OpenMoko) - - Windows (|vpicc| natively, |vpcd| only via Cygwin) -:Potential Platforms: - Unix-like operating systems (Mac OS, Solaris, BSD, ...) +.. sidebar:: Summary + + Smart card emulator written in Python + + :Authors: + - `Frank Morgner `_ + - `Dominik Oepen `_ + :License: + GPL version 3 + :Tested Platforms: + - Linux (Debian, Ubuntu, OpenMoko) + - Windows (|vpicc| natively, |vpcd| only via Cygwin) Virtual Smart Card emulates a smart card and makes it accessible through PC/SC. Currently the Virtual Smart Card supports the following types of smart cards: diff --git a/virtualsmartcard/doc/README.txt.in b/virtualsmartcard/doc/README.txt.in index 003926e..4acacfd 100644 --- a/virtualsmartcard/doc/README.txt.in +++ b/virtualsmartcard/doc/README.txt.in @@ -14,16 +14,18 @@ @PACKAGE_NAME@ ################################################################################ -:Authors: - - `Frank Morgner `_ - - `Dominik Oepen `_ -:License: - GPL version 3 -:Tested Platforms: - - Linux (Debian, Ubuntu, OpenMoko) - - Windows (|vpicc| natively, |vpcd| only via Cygwin) -:Potential Platforms: - Unix-like operating systems (Mac OS, Solaris, BSD, ...) +.. sidebar:: Summary + + @PACKAGE_SUMMARY@ + + :Authors: + - `Frank Morgner `_ + - `Dominik Oepen `_ + :License: + GPL version 3 + :Tested Platforms: + - Linux (Debian, Ubuntu, OpenMoko) + - Windows (|vpicc| natively, |vpcd| only via Cygwin) @PACKAGE_NAME@ emulates a smart card and makes it accessible through PC/SC. Currently the @PACKAGE_NAME@ supports the following types of smart cards: diff --git a/virtualsmartcard/src/vpicc/Makefile.am b/virtualsmartcard/src/vpicc/Makefile.am index cb351d9..de648a0 100644 --- a/virtualsmartcard/src/vpicc/Makefile.am +++ b/virtualsmartcard/src/vpicc/Makefile.am @@ -29,6 +29,7 @@ do_subst = $(SED) \ -e 's,[@]PYTHON[@],$(PYTHON),g' \ -e 's,[@]PACKAGE_VERSION[@],$(PACKAGE_VERSION),g' \ -e 's,[@]PACKAGE_BUGREPORT[@],$(PACKAGE_BUGREPORT),g' \ + -e 's,[@]PACKAGE_SUMMARY[@],$(PACKAGE_SUMMARY),g' \ -e 's,[@]PACKAGE_NAME[@],$(PACKAGE_NAME),g' $(builddir)/vicc: vicc.in Makefile diff --git a/virtualsmartcard/src/vpicc/vicc.in b/virtualsmartcard/src/vpicc/vicc.in index e3f4ddd..8a09354 100644 --- a/virtualsmartcard/src/vpicc/vicc.in +++ b/virtualsmartcard/src/vpicc/vicc.in @@ -24,7 +24,7 @@ import argparse parser = argparse.ArgumentParser( description=''' -The @PACKAGE_NAME@ emulates different types of smart cards. +@PACKAGE_SUMMARY@ The emulator connects to the virtual smart card reader reader (vpcd). Smart card applications can access the @PACKAGE_NAME@ through the vpcd via PC/SC.