src/psktool-args.def

   1 AutoGen Definitions options;
   2 prog-name     = psktool;
   3 prog-title    = "GnuTLS PSK tool";
   4 prog-desc     = "Program to create PSK parameters.\n";
   5 detail    = "Program  that generates random keys for use with TLS-PSK. The
   6 keys are stored in hexadecimal format in a key file.";
   7 short-usage   = "psktool [options]\npsktool --help for usage instructions.\n";
   8 explain       = "";
   9
  10 #include args-std.def
  11
  12 flag = {
  13     name      = keysize;
  14     value     = s;
  15     arg-type  = number;
  16     arg-range = "0 -> 512";
  17     descrip   = "specify the key size in bytes";
  18     doc = "";
  19 };
  20
  21 flag = {
  22     name      = username;
  23     value     = u;
  24     arg-type  = string;
  25     descrip   = "specify a username";
  26     doc = "";
  27 };
  28
  29 flag = {
  30     name      = passwd;
  31     value     = p;
  32     arg-type  = string;
  33     descrip   = "specify a password file";
  34     doc       = "";
  35 };
  36
  37 doc-section = {
  38   ds-type = 'SEE ALSO';
  39   ds-format = 'texi';
  40   ds-text   = <<-_EOT_
  41     gnutls-cli-debug (1), gnutls-serv (1), srptool (1), certtool (1)
  42 _EOT_;
  43 };
  44
  45 doc-section = {
  46   ds-type = 'EXAMPLES';
  47   ds-format = 'texi';
  48   ds-text   = <<-_EOT_
  49 To add a user 'psk_identity' in @file{passwd.psk} for use with GnuTLS run:
  50 @example
  51 $ ./psktool -u psk_identity -p passwd.psk
  52 Generating a random key for user 'psk_identity'
  53 Key stored to passwd.psk
  54 $ cat psks.txt
  55 psk_identity:88f3824b3e5659f52d00e959bacab954b6540344
  56 $
  57 @end example
  58
  59 This command will create @file{passwd.psk} if it does not exist
  60 and will add user 'psk_identity' (you will also be prompted for a password).
  61 _EOT_;
  62 };
  63