updated docs

diff --git a/src/Makefile.am b/src/Makefile.am
index 748468ce050f2c7f216c38ac8e34c1568f7e44fe..7586d11472a1b6a801c5fd261e3a6151f829ee84 100644 (file)
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -163,15 +163,15 @@ p11tool-gaa.c: $(srcdir)/p11tool.gaa
 endif
 certtool-gaa.c: $(srcdir)/certtool.gaa
        -$(GAA) $< -o certtool-gaa.c -i certtool-gaa.h
-psk-args.c psk-args.h: $(srcdir)/psk-args.def
+psk-args.c: $(srcdir)/psk-args.def
        -autogen $<
-cli-debug-args.c cli-debug-args.h: $(srcdir)/cli-debug-args.def
+cli-debug-args.c: $(srcdir)/cli-debug-args.def
        -autogen $<
-cli-args.c cli-args.h: $(srcdir)/cli-args.def
+cli-args.c: $(srcdir)/cli-args.def
        -autogen $<
-serv-args.c serv-args.h: $(srcdir)/serv-args.def
+serv-args.c: $(srcdir)/serv-args.def
        -autogen $<
-srptool-args.c srptool-args.h: $(srcdir)/srptool-args.def
+srptool-args.c: $(srcdir)/srptool-args.def
        -autogen $<
-p11tool-args.c p11tool-args.h: $(srcdir)/p11tool-args.def
+p11tool-args.c: $(srcdir)/p11tool-args.def
        -autogen $<

diff --git a/src/cli-args.def.in b/src/cli-args.def.in
index 8f73cd33ae71f2b9270e6a087c2fca7ad51d83a3..83d65dbed8471394c9f6869bdab74dfe717e4ee3 100644 (file)
--- a/src/cli-args.def.in
+++ b/src/cli-args.def.in
@@ -4,6 +4,7 @@ prog-title    = "GnuTLS client";
 prog-desc     = "Simple client program to set up a TLS connection.";
 short-usage   = "Usage: gnutls-cli [options] hostname\ngnutls-cli --help for usage instructions.\n";
 prog-group    = "GnuTLS";
+explain       = "";
 detail        = "Simple client program to set up a TLS connection to some other computer. 
 It sets up a TLS connection and forwards data from the standard input to the secured socket and vice versa.";
 gnu-usage;
@@ -266,8 +267,46 @@ flag = {
 
 doc-section = {
   ds-type   = 'SEE ALSO'; // or anything else
-  ds-format = 'man';      // or texi or mdoc format
-  ds-text   = <<-_EOText_
+  ds-format = 'texi';      // or texi or mdoc format
+  ds-text   = <<-_EOF_
 gnutls-cli-debug(1), gnutls-serv(1)
-_EOText_;
+_EOF_;
 };
+
+doc-section = {
+  ds-type = 'EXAMPLES';
+  ds-format = 'texi';
+  ds-text   = <<-_EOF_
+To connect to a server using PSK authentication, you need to enable the choice of PSK by using a cipher priority parameter such as in the example below. 
+@example
+$ ./gnutls-cli -p 5556 localhost --pskusername psk_identity \
+    --pskkey 88f3824b3e5659f52d00e959bacab954b6540344 \
+    --priority NORMAL:-KX-ALL:+ECDHE-PSK:+DHE-PSK:+PSK
+Resolving 'localhost'...
+Connecting to '127.0.0.1:5556'...
+- PSK authentication.
+- Version: TLS1.1
+- Key Exchange: PSK
+- Cipher: AES-128-CBC
+- MAC: SHA1
+- Compression: NULL
+- Handshake was completed
+    
+- Simple Client Mode:
+@end example
+By keeping the --pskusername parameter and removing the --pskkey parameter, it will query only for the password during the handshake. 
+
+To list the ciphersuites in a priority string:
+@example
+$ ./gnutls-cli --priority SECURE192 -l
+Cipher suites for SECURE192
+TLS_ECDHE_ECDSA_AES_256_CBC_SHA384                0xc0, 0x24   TLS1.2
+TLS_ECDHE_ECDSA_AES_256_GCM_SHA384                0xc0, 0x2e   TLS1.2
+TLS_ECDHE_RSA_AES_256_GCM_SHA384                  0xc0, 0x30   TLS1.2
+TLS_DHE_RSA_AES_256_CBC_SHA256                    0x00, 0x6b   TLS1.2
+TLS_DHE_DSS_AES_256_CBC_SHA256                    0x00, 0x6a   TLS1.2
+TLS_RSA_AES_256_CBC_SHA256                        0x00, 0x3d   TLS1.2
+@end example
+_EOF_;
+};
+

diff --git a/src/cli-debug-args.def.in b/src/cli-debug-args.def.in
index d058c6971915e46683357b6b4f14cf5969a8b277..9a1e2d83051daf6cd96200512d1fa0dd03c5084b 100644 (file)
--- a/src/cli-debug-args.def.in
+++ b/src/cli-debug-args.def.in
@@ -4,6 +4,7 @@ prog-title    = "GnuTLS debug client";
 prog-desc     = "Simple client program to check TLS server capabilities.";
 short-usage   = "Usage: gnutls-cli-debug [options] hostname\ngnutls-cli --help for usage instructions.\n";
 prog-group    = "GnuTLS";
+explain       = "";
 detail        = "TLS debug client. It sets up multiple TLS connections to 
 a server and queries its capabilities. Can be used to check for servers with
 special needs or bugs.";
@@ -54,8 +55,9 @@ flag = {
 
 doc-section = {
   ds-type   = 'SEE ALSO'; // or anything else
-  ds-format = 'man';      // or texi or mdoc format
+  ds-format = 'texi';      // or texi or mdoc format
   ds-text   = <<-_EOText_
 gnutls-cli(1), gnutls-serv(1)
 _EOText_;
 };
+

diff --git a/src/p11tool-args.def.in b/src/p11tool-args.def.in
index 41adc0e557caa3a6ff629a852a23edbf7ff643de..b1cbabeebb924486d7b43035d08bd25cbeea4320 100644 (file)
--- a/src/p11tool-args.def.in
+++ b/src/p11tool-args.def.in
@@ -11,6 +11,7 @@ To use PKCS #11 tokens with gnutls the configuration file
 
 short-usage   = "p11tool [options] [url]\np11tool --help for usage instructions.\n";
 prog-group    = "GnuTLS";
+explain       = "";
 gnu-usage;
 reorder-args;
 no-xlate = opt;

diff --git a/src/psk-args.def.in b/src/psk-args.def.in
index 96fb92b75da507a4e3a8a96c964d91a93fb2e84d..dd6e77fd954aa72c70afb10023cf3b3ef9eed08a 100644 (file)
--- a/src/psk-args.def.in
+++ b/src/psk-args.def.in
@@ -6,6 +6,7 @@ detail    = "Program  that generates random keys for use with TLS-PSK. The
 keys are stored in hexadecimal format in a key file.";
 short-usage   = "psktool [options]\npsktool --help for usage instructions.\n";
 prog-group    = "GnuTLS";
+explain       = "";
 gnu-usage;
 no-xlate = opt;
 no-misuse-usage;

diff --git a/src/serv-args.def.in b/src/serv-args.def.in
index 1a5d4712a295aee29ae321f5020bc6c4cf681403..9167eaf97106be0e32b4392d14a1182e5f52da23 100644 (file)
--- a/src/serv-args.def.in
+++ b/src/serv-args.def.in
@@ -4,6 +4,7 @@ prog-title    = "GnuTLS server";
 prog-desc     = "Simple server program to act as an HTTPS or TLS echo service.";
 short-usage   = "Usage: gnutls-serv [options]\ngnutls-serv --help for usage instructions.\n";
 prog-group    = "GnuTLS";
+explain       = "";
 detail        = "Server program that listens to incoming TLS connections.";
 gnu-usage;
 no-xlate = opt;

diff --git a/src/srptool-args.def.in b/src/srptool-args.def.in
index 7d7fc6c88f1c82d2aa8607f903b257f0e20ae7c5..bfa8fe0f5ae775f472bb8a60549cd875f7c13b1b 100644 (file)
--- a/src/srptool-args.def.in
+++ b/src/srptool-args.def.in
@@ -2,6 +2,7 @@ AutoGen Definitions options;
 prog-name     = srptool;
 prog-title    = "GnuTLS SRP tool";
 prog-desc     = "Simple program to create SRP parameters.\n";
+explain       = "";
 detail    = "Simple program that emulates the programs in the Stanford SRP (Secure
 Remote Password) libraries using GnuTLS.  It is intended for use in  places
 where you don't expect SRP authentication to be the used for system users.