From 8fd63744e80ab1b7b3738561cee58a3332d82071 Mon Sep 17 00:00:00 2001 From: Frank Morgner Date: Wed, 26 Mar 2014 00:58:17 +0100 Subject: [PATCH] updated documentation --- npa/doc/README.txt | 10 +++++----- npa/doc/README.txt.in | 10 +++++----- virtualsmartcard/doc/README.txt | 6 +++++- virtualsmartcard/doc/README.txt.in | 6 +++++- virtualsmartcard/doc/api.txt | 4 ++-- 5 files changed, 22 insertions(+), 14 deletions(-) diff --git a/npa/doc/README.txt b/npa/doc/README.txt index e54852b..23021d7 100644 --- a/npa/doc/README.txt +++ b/npa/doc/README.txt @@ -131,9 +131,9 @@ To complete this step-by-step guide, here is how to install nPA Smart Card Libra .. _npa-usage: -===== -Usage -===== +******************************************************************************** +Using the nPA Smart Card Library +******************************************************************************** The API to libnpa is documented in :ref:`npa-api`. It includes a simple programming example. Here we will focus on the command line interface to the @@ -158,9 +158,9 @@ the bytes. Example APDUs can be found in :file:`apdus`. .. program-output:: npa-tool --help ----------------------- +====================== Linking against libnpa ----------------------- +====================== Following the section Installation_ above, you have installed OpenSSL, OpenPACE, OpenSC and the nPA Smart Card Library to `$PREFIX` which points to diff --git a/npa/doc/README.txt.in b/npa/doc/README.txt.in index ea0b003..3931c6e 100644 --- a/npa/doc/README.txt.in +++ b/npa/doc/README.txt.in @@ -131,9 +131,9 @@ To complete this step-by-step guide, here is how to install @PACKAGE_NAME@:: .. _npa-usage: -===== -Usage -===== +******************************************************************************** +Using the @PACKAGE_NAME@ +******************************************************************************** The API to libnpa is documented in :ref:`npa-api`. It includes a simple programming example. Here we will focus on the command line interface to the @@ -158,9 +158,9 @@ the bytes. Example APDUs can be found in :file:`apdus`. .. program-output:: npa-tool --help ----------------------- +====================== Linking against libnpa ----------------------- +====================== Following the section Installation_ above, you have installed OpenSSL, OpenPACE, OpenSC and the @PACKAGE_NAME@ to `$PREFIX` which points to diff --git a/virtualsmartcard/doc/README.txt b/virtualsmartcard/doc/README.txt index 59c7711..68f5806 100644 --- a/virtualsmartcard/doc/README.txt +++ b/virtualsmartcard/doc/README.txt @@ -159,9 +159,13 @@ Reader`_ for details. ******************************************************************************** -Running the Virtual Smart Card +Using the Virtual Smart Card ******************************************************************************** +The protocol between |vpcd| and |vpicc| as well as details on extending |vpicc| +with a different card emulator are covered in :ref:`virtualsmartcard-api`. Here +we will focus on configuring and running the provided modules. + ================================================================================ Configuring |vpcd| on Unix ================================================================================ diff --git a/virtualsmartcard/doc/README.txt.in b/virtualsmartcard/doc/README.txt.in index cfc37e0..6d6c6d2 100644 --- a/virtualsmartcard/doc/README.txt.in +++ b/virtualsmartcard/doc/README.txt.in @@ -159,9 +159,13 @@ Reader`_ for details. ******************************************************************************** -Running the @PACKAGE_NAME@ +Using the @PACKAGE_NAME@ ******************************************************************************** +The protocol between |vpcd| and |vpicc| as well as details on extending |vpicc| +with a different card emulator are covered in :ref:`virtualsmartcard-api`. Here +we will focus on configuring and running the provided modules. + ================================================================================ Configuring |vpcd| on Unix ================================================================================ diff --git a/virtualsmartcard/doc/api.txt b/virtualsmartcard/doc/api.txt index ba44ef1..288f7d2 100644 --- a/virtualsmartcard/doc/api.txt +++ b/virtualsmartcard/doc/api.txt @@ -4,6 +4,8 @@ .. |SWs| replace:: :abbr:`SWs (status bytes SW 1 and SW 2)` .. |SAM| replace:: :abbr:`SAM (Secure Access Module)` +.. _virtualsmartcard-api: + ***************************** Creating a Virtual Smart Card ***************************** @@ -13,8 +15,6 @@ Creating a Virtual Smart Card virtually any program to the virtual smart card reader, as long as you respect the following protocol: -.. _vpcd-commands: - ============= ==================== ============= ============= |vpcd| |vpicc| ---------------------------------- ---------------------------