summaryrefslogtreecommitdiff
path: root/doc/invoke-psktool.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/invoke-psktool.texi')
-rw-r--r--doc/invoke-psktool.texi56
1 files changed, 28 insertions, 28 deletions
diff --git a/doc/invoke-psktool.texi b/doc/invoke-psktool.texi
index 77d5c8f198..0f3c26819c 100644
--- a/doc/invoke-psktool.texi
+++ b/doc/invoke-psktool.texi
@@ -6,24 +6,31 @@
#
# DO NOT EDIT THIS FILE (invoke-psktool.texi)
#
-# It has been AutoGen-ed December 29, 2012 at 01:07:10 PM by AutoGen 5.12
+# It has been AutoGen-ed January 1, 2013 at 09:07:58 PM by AutoGen 5.16
# From the definitions ../src/psk-args.def
# and the template file agtexi-cmd.tpl
@end ignore
+
Program that generates random keys for use with TLS-PSK. The
keys are stored in hexadecimal format in a key file.
This section was generated by @strong{AutoGen},
using the @code{agtexi-cmd} template and the option descriptions for the @code{psktool} program.
-
-This software is released under the GNU General Public License.
+This software is released under the GNU General Public License, version 3 or later.
@anchor{psktool usage}
-@subsubheading psktool usage help (-?)
+@subsubheading psktool help/usage (-h)
+@cindex psktool help
-This is the automatically generated usage text for psktool:
+This is the automatically generated usage text for psktool.
+The text printed is the same whether for the @code{help} option (-h) or the @code{more-help} option (-!). @code{more-help} will print
+the usage text by passing it through a pager program.
+@code{more-help} is disabled on platforms without a working
+@code{fork(2)} function. The @code{PAGER} environment variable is
+used to select the program, defaulting to @file{more}. Both will exit
+with a status code of 0.
@exampleindent 0
@example
@@ -58,41 +65,34 @@ please send bug reports to: bug-gnutls@@gnu.org
@subsubheading debug option (-d)
This is the ``enable debugging.'' option.
+This option takes an argument number.
Specifies the debug level.
-
-@anchor{psktool keysize}
-@subsubheading keysize option (-s)
-
-This is the ``specify the key size in bytes'' option.
-
-
-@anchor{psktool passwd}
-@subsubheading passwd option (-p)
-
-This is the ``specify a password file.'' option.
-
-
-@anchor{psktool username}
-@subsubheading username option (-u)
-
-This is the ``specify a username'' option.
-
@anchor{psktool exit status}
@subsubheading psktool exit status
One of the following exit values will be returned:
@table @samp
-@item 0
+@item 0 (EXIT_SUCCESS)
Successful program execution.
-@item 1
+@item 1 (EXIT_FAILURE)
The operation failed or the command syntax was not valid.
@end table
-
-
@anchor{psktool See Also}
@subsubheading psktool See Also
-
+ gnutls-cli-debug (1), gnutls-serv (1), srptool (1), certtool (1)
@anchor{psktool Examples}
@subsubheading psktool Examples
+To add a user 'psk_identity' in @file{passwd.psk} for use with GnuTLS run:
+@example
+$ ./psktool -u psk_identity -p passwd.psk
+Generating a random key for user 'psk_identity'
+Key stored to passwd.psk
+$ cat psks.txt
+psk_identity:88f3824b3e5659f52d00e959bacab954b6540344
+$
+@end example
+
+This command will create @file{passwd.psk} if it does not exist
+and will add user 'psk_identity' (you will also be prompted for a password).