include a summary in documentation and tools

2013-06-16 09:58:07 +02:00
parent 7619b71b12
commit 59eaa16c45
25 changed files with 119 additions and 76 deletions
--- 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])

--- 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' \
--- a/ccid/doc/README.txt
+++ b/ccid/doc/README.txt
@@ -9,11 +9,15 @@
 USB CCID Emulator
 ################################################################################

-:Author:
+.. sidebar:: Summary
+
+    Emulate a USB CCID compliant smart card reader
+
+    :Author:
        `Frank Morgner <morgner@informatik.hu-berlin.de>`_
-:License:
+    :License:
        GPL version 3
-:Tested Platforms:
+    :Tested Platforms:
        Linux (Debian, Ubuntu, OpenMoko)

 The USB CCID Emulator forwards a locally present PC/SC smart card reader as a
--- a/ccid/doc/README.txt.in
+++ b/ccid/doc/README.txt.in
@@ -9,11 +9,15 @@
@PACKAGE_NAME@
 ################################################################################

-:Author:
+.. sidebar:: Summary
+
+    @PACKAGE_SUMMARY@
+
+    :Author:
        `Frank Morgner <morgner@informatik.hu-berlin.de>`_
-:License:
+    :License:
        GPL version 3
-:Tested Platforms:
+    :Tested Platforms:
        Linux (Debian, Ubuntu, OpenMoko)

 The @PACKAGE_NAME@ forwards a locally present PC/SC smart card reader as a
--- 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
--- 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."
--- 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.
--- 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' \
--- a/npa/doc/README.txt
+++ b/npa/doc/README.txt
@@ -13,15 +13,17 @@
 nPA Smart Card Library
 ################################################################################

-:Author:
+.. sidebar:: Summary
+
+    Access the German electronic identity card (neuer Personalausweis/nPA)
+
+    :Author:
        `Frank Morgner <morgner@informatik.hu-berlin.de>`_
-:License:
+    :License:
        GPL version 3
-:Tested Platforms:
+    :Tested Platforms:
        - Windows
        - Linux (Debian, Ubuntu, OpenMoko)
-:Potential Platforms:
-    Unix-like operating systems (Mac OS, Solaris, BSD, ...)

 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,
--- a/npa/doc/README.txt.in
+++ b/npa/doc/README.txt.in
@@ -13,15 +13,17 @@
@PACKAGE_NAME@
 ################################################################################

-:Author:
+.. sidebar:: Summary
+
+    @PACKAGE_SUMMARY@
+
+    :Author:
        `Frank Morgner <morgner@informatik.hu-berlin.de>`_
-:License:
+    :License:
        GPL version 3
-:Tested Platforms:
+    :Tested Platforms:
        - Windows
        - Linux (Debian, Ubuntu, OpenMoko)
-:Potential Platforms:
-    Unix-like operating systems (Mac OS, Solaris, BSD, ...)

 The @PACKAGE_NAME@ offers an easy to use API for the new German identity card
 (neuer Personalausweis, nPA). The library also implements secure messaging,
--- 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.


 ==============================================================
--- 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
--- 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."
--- 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])

--- 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' \
--- a/pcsc-relay/doc/README.txt
+++ b/pcsc-relay/doc/README.txt
@@ -6,16 +6,18 @@
 PC/SC Relay
 ################################################################################

-:Authors:
+.. sidebar:: Summary
+
+  Relay a smart card to a contactless interface
+
+  :Authors:
      - `Frank Morgner <morgner@informatik.hu-berlin.de>`_
      - `Dominik Oepen <oepen@informatik.hu-berlin.de>`_
-:License:
+  :License:
      GPL version 3
-:Tested Platforms:
+  :Tested Platforms:
      - Windows
      - Linux (Debian, Ubuntu, OpenMoko)
-:Potential Platforms:
-    Unix-like operating systems (Mac OS, Solaris, BSD, ...)

 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
--- a/pcsc-relay/doc/README.txt.in
+++ b/pcsc-relay/doc/README.txt.in
@@ -6,16 +6,18 @@
@PACKAGE_NAME@
 ################################################################################

-:Authors:
+.. sidebar:: Summary
+
+  @PACKAGE_SUMMARY@
+
+  :Authors:
      - `Frank Morgner <morgner@informatik.hu-berlin.de>`_
      - `Dominik Oepen <oepen@informatik.hu-berlin.de>`_
-:License:
+  :License:
      GPL version 3
-:Tested Platforms:
+  :Tested Platforms:
      - Windows
      - Linux (Debian, Ubuntu, OpenMoko)
-:Potential Platforms:
-    Unix-like operating systems (Mac OS, Solaris, BSD, ...)

 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
--- 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
--- 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
--- 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])

--- 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' \
--- a/virtualsmartcard/doc/README.txt
+++ b/virtualsmartcard/doc/README.txt
@@ -14,16 +14,18 @@
 Virtual Smart Card
 ################################################################################

-:Authors:
+.. sidebar:: Summary
+
+    Smart card emulator written in Python
+
+  :Authors:
      - `Frank Morgner <morgner@informatik.hu-berlin.de>`_
      - `Dominik Oepen <oepen@informatik.hu-berlin.de>`_
-:License:
+  :License:
      GPL version 3
-:Tested Platforms:
+  :Tested Platforms:
      - Linux (Debian, Ubuntu, OpenMoko)
      - Windows (|vpicc| natively, |vpcd| only via Cygwin)
-:Potential Platforms:
-    Unix-like operating systems (Mac OS, Solaris, BSD, ...)

 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:
--- a/virtualsmartcard/doc/README.txt.in
+++ b/virtualsmartcard/doc/README.txt.in
@@ -14,16 +14,18 @@
@PACKAGE_NAME@
 ################################################################################

-:Authors:
+.. sidebar:: Summary
+
+    @PACKAGE_SUMMARY@
+
+  :Authors:
      - `Frank Morgner <morgner@informatik.hu-berlin.de>`_
      - `Dominik Oepen <oepen@informatik.hu-berlin.de>`_
-:License:
+  :License:
      GPL version 3
-:Tested Platforms:
+  :Tested Platforms:
      - Linux (Debian, Ubuntu, OpenMoko)
      - Windows (|vpicc| natively, |vpcd| only via Cygwin)
-:Potential Platforms:
-    Unix-like operating systems (Mac OS, Solaris, BSD, ...)

@PACKAGE_NAME@ emulates a smart card and makes it accessible through PC/SC.
 Currently the @PACKAGE_NAME@ supports the following types of smart cards:
--- 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
--- 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.