Add some comments.
authorWerner Koch <wk@gnupg.org>
Sun, 28 Dec 2014 12:36:03 +0000 (13:36 +0100)
committerWerner Koch <wk@gnupg.org>
Sun, 28 Dec 2014 12:36:03 +0000 (13:36 +0100)
* src/ntbtls-cli.c (main): Add option --help.

src/ntbtls-cli.c
src/ntbtls.h.in

index 6baf5af..2187cf1 100644 (file)
@@ -270,6 +270,19 @@ main (int argc, char **argv)
           argc--; argv++;
           break;
         }
+      else if (!strcmp (*argv, "--help"))
+        {
+          fputs ("Usage: " PGMNAME " [OPTIONS] HOST\n"
+                 "Connect via TLS to HOST\n"
+                 "Options:\n"
+                 "  --version       print the library version\n"
+                 "  --verbose       show more diagnostics\n"
+                 "  --debug LEVEL   enable debugging at LEVEL\n"
+                 "  --port N        connect to port N (default is 443)\n"
+                 "  --hostname NAME use NAME for SNI\n"
+                 "\n", stdout);
+          return 0;
+        }
       else if (!strcmp (*argv, "--version"))
         {
           printf ("%s\n", ntbtls_check_version (NULL));
index 9940434..8c14e1c 100644 (file)
@@ -60,18 +60,24 @@ const char *ntbtls_check_version (const char *req_version);
 /* Create a new TLS context.  */
 gpg_error_t ntbtls_new (ntbtls_t *r_tls, unsigned int flags);
 
+/* Destroy an TLS context.  */
 void        ntbtls_release (ntbtls_t tls);
 
+/* Setup the transport streams (usually connected to one socket).  */
 gpg_error_t ntbtls_set_transport (ntbtls_t tls,
                                   gpgrt_stream_t inbound,
                                   gpgrt_stream_t outbound);
 
+/* Get the read and write stream for the plaintext.  */
 gpg_error_t ntbtls_get_stream (ntbtls_t tls,
                                gpgrt_stream_t *r_readfp,
                                gpgrt_stream_t *r_writefp);
 
+/* Set the hostname for SNI.  */
 gpg_error_t ntbtls_set_hostname (ntbtls_t tls, const char *hostname);
 
+/* Perform the handshake with the peer.  The transport streams must be
+   connected before starting this handshake.  */
 gpg_error_t ntbtls_handshake (ntbtls_t tls);