2008-11-22 Moritz <moritz@gnu.org>
authorMoritz Schulte <mo@g10code.com>
Sat, 22 Nov 2008 16:56:00 +0000 (16:56 +0000)
committerMoritz Schulte <mo@g10code.com>
Sat, 22 Nov 2008 16:56:00 +0000 (16:56 +0000)
* README: Improved.

tests/ChangeLog
tests/README

index b073791..47294a8 100644 (file)
@@ -1,3 +1,7 @@
+2008-11-22  Moritz  <moritz@gnu.org>
+
+       * README: Improved.
+
 2008-07-20  Moritz  <moritz@gnu.org>
 
        * parse-test.c: Adjusted to new simpleparse API.
index e4f9b23..f9260cf 100644 (file)
@@ -1 +1,35 @@
-FIXME: document pam-test.
+README for pam-test
+===================
+
+  Usage: pam-test [options] <service name>
+  Test PAM authentication.
+  
+  Options:
+   -h, --help      print help information
+   -v, --version   print version information
+   -u, --username  specify username for authentication
+  
+  Report bugs to <moritz@gnu.org>.
+
+pam-test is a small utility suitable for testing authentication
+through PAM. PAM authentication methods are identified by a "service
+name" (e.g. "su", "login", "gdm"). Testing authentication is thus only
+a matter of typing:
+
+  $ ./pam-test SERVICENAME
+
+Testing Poldi authentication can be achieved by defining a new service
+name "poldi" using pam_poldi.so and then typing:
+
+  $ ./pam-test poldi
+
+This is how a successful run looks like:
+
+  $ ./pam-test poldi
+  Waiting for card...
+  Trying authentication as user `moritz'...
+  Authentication succeeded
+  Authenticated as user `moritz'
+  $ 
+
+Have fun.