[pkg-opensc-commit] [pkcs11-helper] 06/253: Documentation updates

[Eric Dorland]

This is an automated email from the git hooks/post-receive script.

eric pushed a commit to branch master
in repository pkcs11-helper.

commit 4271445a2d03fc38a4af53b9501421a5f76b99e2
Author: Alon Bar-Lev <alon.barlev at gmail.com>
Date:   Sun Nov 26 18:00:33 2006 +0000

    Documentation updates
---
 CREDITS                                  | 25 ++++++++++++++++++++++++
 README                                   | 28 +++++++++++++++++----------
 include/pkcs11-helper-1.0/pkcs11h-core.h | 33 ++++++++++++++++----------------
 3 files changed, 60 insertions(+), 26 deletions(-)

diff --git a/CREDITS b/CREDITS
new file mode 100644
index 0000000..a7e1a27
--- /dev/null
+++ b/CREDITS
@@ -0,0 +1,25 @@
+
+James Yonan
+ - Supported the initial development of pkcs11-helper as
+   part of OpenVPN.
+ - Provided the user base to work with.
+
+Brad Hards
+ - For his help in getting pkcs11-helper into QCA.
+
+Justin Karneges
+ - For integrating qca-pkcs11 into QCA.
+ - For a lot of patience for my crazy requirements from QCA.
+
+Zeljko Vrba
+ - pkcs11-helper was improved as a result of our work on
+   gnupg-pkcs11-scd project.
+ - Some bug fixes.
+
+Andreas Jellinghaus
+ - For setting up the infrastructure required in OpenSC project.
+
+Apologies to anyone I have missed.
+
+Alon Bar-Lev <alon.barlev at gmail.com>
+
diff --git a/README b/README
index 65fb470..c732b08 100644
--- a/README
+++ b/README
@@ -3,24 +3,32 @@ pkcs11-helper -- PKCS#11 simplification.
 Copyright (c) 2005-2006 Alon Bar-Lev <alon.barlev at gmail.com>
 
 ABOUT
-	PKCS#11 is RSA Security published standard. PKCS#11 is the de-facto standard to access
-	cryptographic devices.
+	PKCS#11 is published standard. PKCS#11 is the de-facto standard to access cryptographic
+	devices.
 
-	pkcs11-helper is a library that provides simplified interaction with PKCS#11
-	providers for user applications.
+	pkcs11-helper is a library that simplifies the interaction with PKCS#11
+	providers for end-user applications.
 
-	pkcs11-helper allows using multiple PKCS#11 providers at the same time, selecting 
-	keys by id, label or certificate subject, handling card removal and card insert
-	events, handling card re-insert to a different slot, supporting session expiration
-	serialization and much more, all using a simple API.
+FEATURES
+	pkcs11-helper allows using multiple PKCS#11 providers at the same time, enumerating 
+	available token certificates, or selecting a certificate directly by id, label or
+	subject, handling card removal and card insert events, handling card re-insert
+	to a different slot, supporting session expiration, serialization and much more
+	all using a simple API.
 
 	pkcs11-helper is not designed to manage card content, since object attributes
 	are usually vendor specific, and 99% of application need to access
 	existing objects in order to perform signature and decryption.
 
-AUTHORS
-	Alon Bar-Lev <alon.barlev at gmail.com>
+COMPATIBILITY
+	- The pkcs11-helper library is available in POSIX and WIN32 compliant systems.
+
+	- The pkcs11-helper library should work with almost any PKCS#11 provider, since it
+	  uses the minimum required features of the PKCS#11 standard.
 
 SUPPORT
 	http://www.opensc-project.org
 
+AUTHORS
+	Alon Bar-Lev <alon.barlev at gmail.com>
+
diff --git a/include/pkcs11-helper-1.0/pkcs11h-core.h b/include/pkcs11-helper-1.0/pkcs11h-core.h
index 10da08e..7f1a28f 100644
--- a/include/pkcs11-helper-1.0/pkcs11h-core.h
+++ b/include/pkcs11-helper-1.0/pkcs11h-core.h
@@ -62,18 +62,28 @@
  * published standard. PKCS#11 is the de-facto standard to access cryptographic
  * devices.
  * @par
- * pkcs11-helper is a library that provides simplified interaction with PKCS#11
- * providers for user applications.
+ * pkcs11-helper is a library that simplifies the interaction with PKCS#11
+ * providers for end-user applications.
  * @par Features
- * pkcs11-helper allows using multiple PKCS#11 providers at the same time, selecting 
- * keys by id, label or certificate subject, handling card removal and card insert
- * events, handling card re-insert to a different slot, supporting session expiration
- * serialization and much more, all using a simple API.
+ * pkcs11-helper allows using multiple PKCS#11 providers at the same time, enumerating 
+ * available token certificates, or selecting a certificate directly by id, label or
+ * subject, handling card removal and card insert events, handling card re-insert
+ * to a different slot, supporting session expiration, serialization and much more
+ * all using a simple API.
  * @par
  * pkcs11-helper is not designed to manage card content, since object attributes
  * are usually vendor specific, and 99% of application need to access
  * existing objects in order to perform signature and decryption.
- * @par Modules:
+ * @par Compatibility
+ * - The pkcs11-helper library is available in POSIX and WIN32 compliant systems.
+ * - The pkcs11-helper library should work with almost any PKCS#11 provider, since it
+ *   uses the minimum required features of the PKCS#11 standard.
+ * @par Support
+ * pkcs11-helper support is available via the
+ * <a href="http://www.opensc-project.org">OpenSC Project</a>.
+ * @par License
+ * @ref License is dual BSD or GPL.
+ * @par Modules
  * - @ref pkcs11h-core.h "Core" - Initialize library, adding providers, hooks.
  * - @ref pkcs11h-token.h "Token" - Handle tokens.
  * - @ref pkcs11h-certificate.h "Certificate" - Handle certificate objects.
@@ -81,15 +91,6 @@
  * - @ref pkcs11h-locate.h "Locate" - Simplified object locate interface.
  * - @ref pkcs11h-openssl.h "OpenSSL" - OpenSSL engine support.
  * - @ref pkcs11h-standalone.h "Standalone Debugging" - Token structure debugging interface.
- * @par Compatability
- * - The pkcs11-helper is available in POSIX complient systems and WIN32.
- * - pkcs11-helper should work with almost every PKCS#11 provider, since it
- *   uses the minimum features of the provider.
- * @par Support
- * pkcs11-helper support is available via the
- * <a href="http://www.opensc-project.org">OpenSC Project</a>.
- * @par License
- * @ref License is dual BSD or GPL.
  */
 
 /**

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-opensc/pkcs11-helper.git