From ee0d5d07c24914d11950b6766db4baf6d250248f Mon Sep 17 00:00:00 2001 From: frankmorgner Date: Sat, 5 Nov 2011 21:50:36 +0000 Subject: [PATCH] included help output from programs in documentation git-svn-id: https://vsmartcard.svn.sourceforge.net/svnroot/vsmartcard@627 96b47cad-a561-4643-ad3b-153ac7d7599c --- ccid/doc/Makefile.am | 1 + ccid/doc/README.rst | 4 ++++ ccid/doc/README.rst.in | 4 ++++ doc/conf.py | 2 +- npa/configure.ac | 14 ++++++++++++-- npa/doc/Makefile.am | 1 + npa/doc/README.rst | 2 ++ npa/doc/README.rst.in | 2 ++ pcsc-relay/doc/Makefile.am | 1 + pcsc-relay/doc/README.rst | 2 ++ pcsc-relay/doc/README.rst.in | 2 ++ virtualsmartcard/doc/Makefile.am | 1 + virtualsmartcard/doc/README.rst | 2 ++ virtualsmartcard/doc/README.rst.in | 2 ++ 14 files changed, 37 insertions(+), 3 deletions(-) diff --git a/ccid/doc/Makefile.am b/ccid/doc/Makefile.am index f68c59d..99f10ad 100644 --- a/ccid/doc/Makefile.am +++ b/ccid/doc/Makefile.am @@ -11,6 +11,7 @@ do_subst = sed \ -e 's,[@]includedir[@],$(includedir),g' \ -e 's,[@]VERSION[@],$(VERSION),g' \ -e 's,[@]OPENSC_LIBS[@],$(OPENSC_LIBS),g' \ + -e 's,[@]abs_top_srcdir[@],$(abs_top_srcdir),g' \ -e 's,[@]top_srcdir[@],$(top_srcdir),g' EXTRA_DIST = README.rst.in README.rst autotools.rst autotools.rst.in questions.rst questions.rst.in diff --git a/ccid/doc/README.rst b/ccid/doc/README.rst index 0b32545..c0bd129 100644 --- a/ccid/doc/README.rst +++ b/ccid/doc/README.rst @@ -109,9 +109,13 @@ 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). +.. program-output:: sh -c 'cd /home/fm/work/vsmartcard/ccid/src && ./ccid-emulator --help' + 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. +.. program-output:: sh -c 'cd /home/fm/work/vsmartcard/ccid/src && ./cats-test' + .. include:: questions.rst diff --git a/ccid/doc/README.rst.in b/ccid/doc/README.rst.in index 02e9e2e..e88b8cf 100644 --- a/ccid/doc/README.rst.in +++ b/ccid/doc/README.rst.in @@ -109,9 +109,13 @@ 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). +.. program-output:: sh -c 'cd @abs_top_srcdir@/src && ./ccid-emulator --help' + cats-test can be used to test the PACE capabilities of a smart card reader with PACE support (such as the @PACKAGE_NAME@ or any other "Standardleser" CAT-S or "Komfortleser" CAT-C) via PC/SC. +.. program-output:: sh -c 'cd @abs_top_srcdir@/src && ./cats-test' + .. include:: questions.rst diff --git a/doc/conf.py b/doc/conf.py index 633f1b0..d3dd27c 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -31,7 +31,7 @@ needs_sphinx = '1.1' # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ["breathe", "sphinxcontrib.doxylink", "sphinx.ext.autosummary"] +extensions = ["breathe", "sphinxcontrib.doxylink", "sphinx.ext.autosummary", "sphinxcontrib.programoutput"] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/npa/configure.ac b/npa/configure.ac index 7a8b32b..cbd145e 100644 --- a/npa/configure.ac +++ b/npa/configure.ac @@ -8,13 +8,23 @@ AC_CONFIG_HEADERS([config.h]) AC_CONFIG_MACRO_DIR([m4]) AM_INIT_AUTOMAKE +dnl Add libtool support. +ifdef( + [LT_INIT], + [ + LT_INIT([win32-dll]) + ], + [ + AC_LIBTOOL_WIN32_DLL + AC_PROG_LIBTOOL + ] +) + # Checks for programs. AC_PROG_CXX AC_PROG_CC AC_PROG_INSTALL AC_PROG_LN_S -AC_PROG_LIBTOOL -LT_INIT AM_PROG_CC_C_O PKG_PROG_PKG_CONFIG diff --git a/npa/doc/Makefile.am b/npa/doc/Makefile.am index 43d8fcc..8d3d9a5 100644 --- a/npa/doc/Makefile.am +++ b/npa/doc/Makefile.am @@ -13,6 +13,7 @@ do_subst = sed \ -e 's,[@]includedir[@],$(includedir),g' \ -e 's,[@]VERSION[@],$(VERSION),g' \ -e 's,[@]OPENSC_LIBS[@],$(OPENSC_LIBS),g' \ + -e 's,[@]abs_top_srcdir[@],$(abs_top_srcdir),g' \ -e 's,[@]top_srcdir[@],$(top_srcdir),g' EXTRA_DIST = README.rst.in README.rst Doxyfile.in example.c autotools.rst autotools.rst.in questions.rst questions.rst.in diff --git a/npa/doc/README.rst b/npa/doc/README.rst index 4e6a0ff..e5ba8a1 100644 --- a/npa/doc/README.rst +++ b/npa/doc/README.rst @@ -109,6 +109,8 @@ To pass a secret to npa-tool, the command line parameters or the environment variables PIN/CAN/MRZ/PUK/NEWPIN can be used. If none of these options is used, npa-tool will show a password prompt. +.. program-output:: sh -c 'cd /home/fm/work/vsmartcard/npa/src && ./npa-tool --help' + ---------------------- Linking against libnpa ---------------------- diff --git a/npa/doc/README.rst.in b/npa/doc/README.rst.in index dc4328f..7998bd7 100644 --- a/npa/doc/README.rst.in +++ b/npa/doc/README.rst.in @@ -109,6 +109,8 @@ To pass a secret to npa-tool, the command line parameters or the environment variables PIN/CAN/MRZ/PUK/NEWPIN can be used. If none of these options is used, npa-tool will show a password prompt. +.. program-output:: sh -c 'cd @abs_top_srcdir@/src && ./npa-tool --help' + ---------------------- Linking against libnpa ---------------------- diff --git a/pcsc-relay/doc/Makefile.am b/pcsc-relay/doc/Makefile.am index 7e0ef8a..ad0a7db 100644 --- a/pcsc-relay/doc/Makefile.am +++ b/pcsc-relay/doc/Makefile.am @@ -11,6 +11,7 @@ do_subst = sed \ -e 's,[@]includedir[@],$(includedir),g' \ -e 's,[@]VERSION[@],$(VERSION),g' \ -e 's,[@]OPENSC_LIBS[@],$(OPENSC_LIBS),g' \ + -e 's,[@]abs_top_srcdir[@],$(abs_top_srcdir),g' \ -e 's,[@]top_srcdir[@],$(top_srcdir),g' EXTRA_DIST = README.rst.in README.rst autotools.rst.in questions.rst.in autotools.rst questions.rst diff --git a/pcsc-relay/doc/README.rst b/pcsc-relay/doc/README.rst index 35a2b53..45a66ff 100644 --- a/pcsc-relay/doc/README.rst +++ b/pcsc-relay/doc/README.rst @@ -32,6 +32,8 @@ pcsc-relay has the following dependencies: - PC/SC middleware - libnfc_ +.. program-output:: sh -c 'cd /home/fm/work/vsmartcard/pcsc-relay/src && ./pcsc-relay --help' + --------------- Hints on libnfc diff --git a/pcsc-relay/doc/README.rst.in b/pcsc-relay/doc/README.rst.in index 6dd8afd..bfb0328 100644 --- a/pcsc-relay/doc/README.rst.in +++ b/pcsc-relay/doc/README.rst.in @@ -32,6 +32,8 @@ pcsc-relay has the following dependencies: - PC/SC middleware - libnfc_ +.. program-output:: sh -c 'cd @abs_top_srcdir@/src && ./pcsc-relay --help' + --------------- Hints on libnfc diff --git a/virtualsmartcard/doc/Makefile.am b/virtualsmartcard/doc/Makefile.am index 0fde5df..89d2b80 100644 --- a/virtualsmartcard/doc/Makefile.am +++ b/virtualsmartcard/doc/Makefile.am @@ -13,6 +13,7 @@ do_subst = sed \ -e 's,[@]includedir[@],$(includedir),g' \ -e 's,[@]VERSION[@],$(VERSION),g' \ -e 's,[@]OPENSC_LIBS[@],$(OPENSC_LIBS),g' \ + -e 's,[@]abs_top_srcdir[@],$(abs_top_srcdir),g' \ -e 's,[@]top_srcdir[@],$(top_srcdir),g' EXTRA_DIST = README.rst.in README.rst autotools.rst.in questions.rst.in autotools.rst questions.rst diff --git a/virtualsmartcard/doc/README.rst b/virtualsmartcard/doc/README.rst index 4dbc2aa..6119258 100644 --- a/virtualsmartcard/doc/README.rst +++ b/virtualsmartcard/doc/README.rst @@ -73,5 +73,7 @@ You should now be able to access the |vpicc| through the system's PC/SC API via |vpcd|/pcscd. You can use the opensc-explorer or pcsc_scan to test that. +.. program-output:: /home/fm/work/vsmartcard/virtualsmartcard/src/vpicc/vicc --help + .. include:: questions.rst diff --git a/virtualsmartcard/doc/README.rst.in b/virtualsmartcard/doc/README.rst.in index 9ba3143..2fb94a5 100644 --- a/virtualsmartcard/doc/README.rst.in +++ b/virtualsmartcard/doc/README.rst.in @@ -73,5 +73,7 @@ You should now be able to access the |vpicc| through the system's PC/SC API via |vpcd|/pcscd. You can use the opensc-explorer or pcsc_scan to test that. +.. program-output:: @abs_top_srcdir@/src/vpicc/vicc --help + .. include:: questions.rst