doc/invoke-psktool.texi

   1 @node psktool Invocation
   2 @subsection Invoking psktool
   3 @pindex psktool
   4 @ignore
   5 #  -*- buffer-read-only: t -*- vi: set ro:
   6 #
   7 # DO NOT EDIT THIS FILE   (invoke-psktool.texi)
   8 #
   9 # It has been AutoGen-ed  November  8, 2012 at 11:40:18 PM by AutoGen 5.16
  10 # From the definitions    ../src/psk-args.def
  11 # and the template file   agtexi-cmd.tpl
  12 @end ignore
  13
  14
  15 Program  that generates random keys for use with TLS-PSK. The
  16 keys are stored in hexadecimal format in a key file.
  17
  18 This section was generated by @strong{AutoGen},
  19 using the @code{agtexi-cmd} template and the option descriptions for the @code{psktool} program.
  20 This software is released under the GNU General Public License, version 3 or later.
  21
  22
  23 @anchor{psktool usage}
  24 @subsubheading psktool help/usage (-h)
  25 @cindex psktool help
  26
  27 This is the automatically generated usage text for psktool.
  28 The text printed is the same whether for the @code{help} option (-h) or the @code{more-help} option (-!).  @code{more-help} will print
  29 the usage text by passing it through a pager program.
  30 @code{more-help} is disabled on platforms without a working
  31 @code{fork(2)} function.  The @code{PAGER} environment variable is
  32 used to select the program, defaulting to @file{more}.  Both will exit
  33 with a status code of 0.
  34
  35 @exampleindent 0
  36 @example
  37 psktool - GnuTLS PSK tool - Ver. @@VERSION@@
  38 USAGE:  psktool [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]...
  39
  40    -d, --debug=num            Enable debugging.
  41                                 - It must be in the range:
  42                                   0 to 9999
  43    -s, --keysize=num          specify the key size in bytes
  44                                 - It must be in the range:
  45                                   0 to 512
  46    -u, --username=str         specify a username
  47    -p, --passwd=str           specify a password file.
  48    -v, --version[=arg]        Output version information and exit
  49    -h, --help                 Display extended usage information and exit
  50    -!, --more-help            Extended usage information passed thru pager
  51
  52 Options are specified by doubled hyphens and their name or by a single
  53 hyphen and the flag character.
  54
  55
  56
  57 Program that generates random keys for use with TLS-PSK.  The keys are
  58 stored in hexadecimal format in a key file.
  59
  60 please send bug reports to:  bug-gnutls@@gnu.org
  61 @end example
  62 @exampleindent 4
  63
  64 @anchor{psktool debug}
  65 @subsubheading debug option (-d)
  66
  67 This is the ``enable debugging.'' option.
  68 This option takes an argument number.
  69 Specifies the debug level.
  70 @anchor{psktool exit status}
  71 @subsubheading psktool exit status
  72
  73 One of the following exit values will be returned:
  74 @table @samp
  75 @item 0 (EXIT_SUCCESS)
  76 Successful program execution.
  77 @item 1 (EXIT_FAILURE)
  78 The operation failed or the command syntax was not valid.
  79 @end table
  80 @anchor{psktool See Also}
  81 @subsubheading psktool See Also
  82     gnutls-cli-debug (1), gnutls-serv (1), srptool (1), certtool (1)
  83
  84 @anchor{psktool Examples}
  85 @subsubheading psktool Examples
  86 To add a user 'psk_identity' in @file{passwd.psk} for use with GnuTLS run:
  87 @example
  88 $ ./psktool -u psk_identity -p passwd.psk
  89 Generating a random key for user 'psk_identity'
  90 Key stored to passwd.psk
  91 $ cat psks.txt
  92 psk_identity:88f3824b3e5659f52d00e959bacab954b6540344
  93 $
  94 @end example
  95
  96 This command will create @file{passwd.psk} if it does not exist
  97 and will add user 'psk_identity' (you will also be prompted for a password).
  98